bjornbergenheim
43a71aec3c
* fix(supabase): stop server clients leaking a 30s refresh ticker per request
`autoRefreshToken` defaults to true in supabase-js, and off-browser
@supabase/auth-js starts the refresh ticker unconditionally:
// in non-browser environments the refresh token ticker runs always
this.startAutoRefresh()
That is a setInterval firing every 30 s. It calls unref(), so the process
still exits, tests pass, and Vercel never notices because the process is
torn down long before the tickers accumulate. But unref() does not make a
timer collectable: it stays registered in the event loop and remains a GC
root for its callback, which closes over the GoTrueClient, the
SupabaseClient, and the whole request scope around it.
A long-running self-hosted instance therefore leaks one timer plus one
entire request graph (socket, IncomingMessage, ServerResponse, headers,
route context: ~100 kB) per client constructed. One died of "JavaScript
heap out of memory" after 42 h, the last 24 of them completely idle. The
heap snapshot showed 445 retained request graphs and ~1050 Timeouts in
the 30 000 ms bucket, retained via `autoRefreshTicker`, and the rate
matched the traffic exactly: the Docker healthcheck polls /api/health
every 30 s and the webhook dispatch cron runs every minute, so
3 clients/min x 148 min = 444.
- new lib/supabase/service-client.ts: createServiceRoleClient() applies
SERVER_AUTH_OPTIONS, spread LAST so a caller passing its own auth block
cannot re-enable the ticker
- 22 call sites migrated; only booking-templates/sync/cron had ever
passed the options itself
- guard 9 in no-new-antipatterns.mjs fails CI on any new value import of
supabase-js's createClient outside the wrapper; type-only imports are
fine. Verified to fail on a deliberate regression and pass once fixed
- browser clients untouched: a signed-in tab genuinely needs the refresh,
and lib/supabase/client.ts is built on createBrowserClient anyway
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
* fix(checks): catch namespace imports in the leaky-supabase-client guard
The guard only matched named imports, so
import * as sb from '@supabase/supabase-js'
sb.createClient(url, key)
reached createClient through member access without ever naming it, and
passed. Verified against the real script before and after: the shape is
flagged now, and `import type * as sb` still passes.
Namespace value imports are treated as leaky outright rather than tracking
member access, which keeps the check a regex over source text with no new
dependency.
Review also suggested excluding *.test.tsx alongside *.test.ts. Skipped: the
repo has no .test.tsx files, and all four sibling checks in this file use
`.test.ts`. Diverging in one of them would read as an accident; if such files
appear, all four should change together.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
64 lines
2.8 KiB
TypeScript
64 lines
2.8 KiB
TypeScript
import { createClient, type SupabaseClient, type SupabaseClientOptions } from '@supabase/supabase-js'
|
|
|
|
/**
|
|
* Auth options every server-side Supabase client MUST use.
|
|
*
|
|
* `autoRefreshToken` defaults to TRUE in supabase-js, and in a non-browser
|
|
* environment @supabase/auth-js starts the refresh ticker unconditionally:
|
|
*
|
|
* // in non-browser environments the refresh token ticker runs always
|
|
* this.startAutoRefresh()
|
|
*
|
|
* That is a `setInterval` firing every 30 s, stored on the client as
|
|
* `autoRefreshTicker`. It calls `.unref()`, so the process can still exit and
|
|
* nothing looks wrong in tests or on Vercel, where the process is short-lived
|
|
* and torn down before the tickers accumulate. But `unref()` does NOT make a
|
|
* timer collectable: it stays registered in the event loop's timer list and
|
|
* remains a GC root for its callback, which closes over the GoTrueClient, the
|
|
* SupabaseClient, and everything the surrounding request scope captured.
|
|
*
|
|
* A long-running self-hosted process therefore leaks one timer plus one entire
|
|
* request graph (socket, IncomingMessage, ServerResponse, headers, cookies,
|
|
* route context: roughly 100 kB) per client constructed. Observed in the wild
|
|
* on 2026-08-13: a self-hosted instance died of "JavaScript heap out of memory"
|
|
* after 42 h, the last 24 of them completely idle. A heap snapshot showed 445
|
|
* retained request graphs and ~1050 Timeouts in the 30 000 ms bucket, retained
|
|
* via `autoRefreshTicker`. The rate matched the traffic exactly: the Docker
|
|
* healthcheck polls /api/health every 30 s (2 clients/min) and the webhook
|
|
* dispatch cron runs every minute (1 client/min), so 3/min x 148 min = 444.
|
|
*
|
|
* `persistSession` is disabled for the same reason it always is on the server:
|
|
* there is no browser storage to persist into, and a service-role client has no
|
|
* user session to keep.
|
|
*/
|
|
export const SERVER_AUTH_OPTIONS = {
|
|
persistSession: false,
|
|
autoRefreshToken: false,
|
|
} as const
|
|
|
|
/**
|
|
* Construct a server-side Supabase client that cannot leak a refresh ticker.
|
|
*
|
|
* Use this instead of importing `createClient` from '@supabase/supabase-js'
|
|
* directly in any code that runs on the server (API routes, crons, extension
|
|
* handlers, service-role helpers). `scripts/checks/no-new-antipatterns.mjs`
|
|
* enforces it.
|
|
*
|
|
* The auth options are spread LAST, so a caller passing its own `auth` block
|
|
* cannot accidentally re-enable the ticker.
|
|
*
|
|
* Browser clients are a different case and must keep the ticker: a signed-in
|
|
* tab genuinely needs its access token refreshed. Those go through
|
|
* `lib/supabase/client.ts`, which is unaffected.
|
|
*/
|
|
export function createServiceRoleClient(
|
|
url: string,
|
|
key: string,
|
|
options?: SupabaseClientOptions<'public'>,
|
|
): SupabaseClient {
|
|
return createClient(url, key, {
|
|
...options,
|
|
auth: { ...options?.auth, ...SERVER_AUTH_OPTIONS },
|
|
})
|
|
}
|