mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Post-merge fixes for the TanStack Start migration (#46424) — things that broke on the TanStack build as master evolved under the migration branches. Kept on their own branch off master rather than piling onto the E2E-matrix PR (#47119); all land on master and cascade up to S6 + the big PR. Common theme: a master PR changed something the Next pipeline handles via `next/font` / `pages/_app.tsx` / `next.config.ts`, but the hand-rolled TanStack equivalent (`routes/__root.tsx`, `styles/fonts.css`, `vercel.ts`) wasn't updated to match — invisible on the Next deploy, broken only on TanStack. --- ## 1. Monaco loader path (#47182) #47182 re-nested the served Monaco assets from a flat `public/monaco-editor/` layout into `public/monaco-editor/vs/` and updated `pages/_app.tsx`, but `routes/__root.tsx` still pointed `loader.config` at the old path, so `loader.js` 404'd and **no Monaco editor mounted anywhere in the TanStack build**. Now mirrors the Next config (`${origin}${BASE_PATH}/monaco-editor/vs`, window-guarded for SSR). Was failing the whole `tanstack` E2E shard on #47119. ## 2. Inter + Manrope fonts (#47306) #47306 renamed Tailwind's sans var `--font-custom` → `--font-sans` and added `--font-heading` (Manrope), set via `next/font` on Next. `fonts.css` still only set the now-ignored `--font-custom`, so the body fell back to the theme's system chain (`Circular, custom-font, Helvetica…`) at weight 450 — that's the "Inter weights look wrong". Manrope was missing entirely. - Wire `--font-sans` (Inter) + `--font-heading` (Manrope) to match `next/font`. - **Vendor all three families** (Inter, Manrope, Source Code Pro) via `@font-face` so nothing depends on the Google Fonts CDN — matches `next/font` self-hosting, and (see below) `font-src` doesn't allow `fonts.gstatic.com` anyway. Verified in-browser: computed `body` → `Inter`, headings → `Manrope`, all loading from local `/assets/*.woff2`. ## 3. Security headers / CSP (next.config.ts `headers()`) The Next build sets X-Frame-Options / X-Content-Type-Options / HSTS / **Content-Security-Policy** / Referrer-Policy via `next.config.ts`. The TanStack build never carried these over — `vercel.ts` only set cache-control, so **the deployed TanStack dashboard shipped with no CSP at all**. The TanStack deploy serves a static shell (no server to attach headers), so they go in the Vercel config: - `security-headers.ts` — shared source of truth, reuses `getCSP()`, env-gated exactly like next.config. - `vercel.ts` — apply to every response (all base-path prefixes): full `getCSP()` + HSTS on platform. - `scripts/serve.js` — the non-platform set (`frame-ancestors 'none'`) for the self-hosted server. **Tested the policy in a real browser** (temporarily enforced it on the TanStack build via /test-supabase-local): everything passed except one real gap — `font-src` was missing `data:`, so GraphiQL's bundled Monaco codicon font and Stripe's payment-element fonts (both data: URIs) were blocked (37 violations on a cold load). Added `data:` to `font-src` in `csp.ts` → violations drop to zero, SQL editor Monaco renders clean. That gap affects the Next build too. --- ## 4. `node:path` import crashing `/project/[ref]/merge` Found by a full-site click-through of the TanStack build (all product areas, ongoing — see below). `useEdgeFunctionsDiff.ts` + `EdgeFunctionsDiffPanel.tsx` did `import { basename } from 'path'` in client code. Webpack (Next) polyfills `path` in the browser; Vite externalizes it, so the whole `/merge` route crashed with "Module \"path\" has been externalized for browser compatibility". Replaced the two `basename` call sites with a string helper. Verified in-browser: `/merge` renders. ## 5. URL shape — Next-style search-param semantics + shim fixes The dashboard produced malformed URLs vs the Next build (strange query params, trailing slashes, `##` hashes). Root cause + audit verified empirically against `@tanstack/react-router@1.170.10`; all fixed with unit tests and browser-verified: - **`createRouter` used TanStack's default JSON search codec** — `?flag=true` became `?flag=%22true%22` via links, repeated `?filter=…&filter=…` collapsed into a JSON array (breaking multi-filter/sort table-editor URLs and the account-page round-trip, which double-encoded), and search values arrived as numbers/booleans where the app expects strings. New `lib/router-search-params.ts` (Next-style: strings in, strings out, repeated keys → string[]) wired into the router. - **Link shim** (`compat/next/link.tsx`): `URL.hash` includes the leading `#` while TanStack's `hash` prop adds its own → every `href="…#section"` navigated to `##section` (hash-scroll broke); `Object.fromEntries(searchParams)` dropped repeated query params. Both fixed. - **Trailing slash injected before the query** on every `?`-only relative navigation (`/auth/providers/?provider=…`): fixed in the compat router (prefix current pathname) and via a custom nuqs adapter (`lib/nuqs-tanstack-adapter.tsx`) replacing the stock tanstack-router adapter, whose `navigate({ to: '?…' })` writes hit the same TanStack behavior (123 files use nuqs). - **Pathname-less `router.push({ query })` leaked path params** — Next re-consumes `ref`/`id` from `query` into the path pattern; the shim didn't, yielding `/editor/17597?schema=public&ref=<ref>&id=17597&filter=…` from table-editor filter/sort, linter panels, and advisor shortcuts. The shim now defaults the pathname to the current route pattern and backfills omitted params. - **Redirects dropped query + hash** (Next's `redirects()` preserves them): `__root.tsx` `matchRedirect` and `routes/index.tsx` now carry incoming params/hash through (consumed rule params excluded, destination's own params win). `/?next=new-project&projectName=zzz` → `/new/new-project?projectName=zzz`; `/sql/quickstarts?template=x#frag` → `/sql/examples?template=x#frag`. Browser-verified post-fix: advisors `?preset=WARN`, providers `?provider=Google`, `?schema=auth` — all clean (no `/?`, no leaks); repeated `filter` params survive hydration; `=true` unquoted; single `#`. ## 6. TanStack `navigate` corrupting query values (Logs Explorer SQL newline loss) TanStack router-core treats a query string embedded in `navigate({ to })` as part of the *path*: `decodePath` percent-decodes it and `sanitizePathSegment` strips control characters, silently deleting every `%0A`. Logs Explorer's SQL (`s` param) lost its newlines on Run/reload — `order by timestamp desc` / `limit 5` glued into `desclimit 5`, which then failed the LIMIT lint. Pre-existing on the TanStack build (the stock nuqs adapter had the same shape); Next unaffected. Fixed by never embedding query strings in `to`: the nuqs adapter and the compat `router.push`/`replace`/`prefetch` (plus the `next/navigation` shim) now pass search as an object through the app codec (`splitInternalUrl` hoisted to `lib/internal-url.ts`). Guard test drives a real `createRouter` with multi-line SQL through both producers. Browser-verified: newlines survive the full Run → reload → re-Run cycle. ## 7. Integration overview markdown never loaded (all integrations) `MarkdownContent` used a template-literal dynamic import (``import(`@/static-data/integrations/${id}/overview.md`)``) — webpack builds a context module for that, Vite can't analyze it, so every integration detail page threw `Failed to resolve module specifier` and rendered no overview text. Fixed with an explicit lazy registry of literal imports (`static-data/integrations/overviews.ts`, drift-guarded by a test) plus an `mdRawLoader()` Vite plugin mirroring next.config's turbopack raw-loader rule. Both runtimes keep working; md stays out of the main bundle. ## 8. GraphiQL editor never mounted (`exports is not defined`) Our `umdAmdShortCircuit()` Vite plugin (which disarms Monaco's global AMD loader for deps like papaparse) rewrote `typeof define === 'function' && define.amd` to `false` inside `monaco-editor`'s bundled copy of marked — whose UMD relies on its own *local* `define` shim — so the whole optimized monaco chunk failed to evaluate and GraphiQL's editor pane stayed blank. The check now only short-circuits when `define` is the global AMD loader. Browser-verified: all four GraphiQL Monaco panes mount, queries execute. (Known follow-up: GraphiQL's Monaco workers fall back to the main thread under Vite — functional, worker wiring is Next-specific `setup-workers/webpack`.) ## 9. `@sentry/nextjs` bundling Next internals — built TanStack bundle crashed (caught by E2E) The E2E suite against the **built** TanStack bundle (not the dev server) found lazy chunks like `table-editor-*.js` dead on arrival: `@sentry/nextjs` (imported by ~25 client files) drags in `next/dist/shared/lib/constants`, whose module scope evaluates `process?.features?.typescript` — optional chaining doesn't guard an undeclared `process` in the browser, so the whole chunk failed at load with `ReferenceError: process is not defined`. Dev shims `process`, which is why weeks of dev-server testing never saw it. Fixed by aliasing `@sentry/nextjs` → `compat/sentry-nextjs.ts` (re-exports `@sentry/react`, same deduped 10.59.0, plus explicit stand-ins for the three Next-only APIs) in the Vite build only. Verified: fresh build has zero Next-internals markers in any chunk; table editor loads clean; full E2E suite run against the built bundle. Note for the stack: `alaister/tanstack-start` / the E2E-matrix branch already carried a different fix for the same crash (a `next/constants` shim) that never made it to master — the cherry-pick onto those branches keeps **both** (the shim covers any other transitive importer; the alias keeps Next internals out of the client bundle entirely). **Follow-up found while fixing:** Sentry is never *initialized* in the TanStack runtime — `instrumentation-client.ts` / `sentry.server.config.ts` are Next-convention files nothing imports under TanStack, so `captureException` calls are silent no-ops. Needs an `@sentry/react` init (+ `tanstackRouterBrowserTracingIntegration`) wired into the TanStack client entry as its own PR. ## 10. GraphiQL Monaco workers + edge-function Deno typings (Vite-only gaps) - **GraphiQL's Monaco workers ran on the main thread** under Vite ("Could not create web worker(s)…" — `setup-workers/webpack`'s `new URL(...)` form isn't rewritten by Vite). A `graphiqlViteWorkers()` plugin resolves the import to graphiql's own `setup-workers/vite` variant for client builds (SSR untouched, Next untouched); the setup-workers chain is `optimizeDeps.exclude`d because the Rolldown optimizer can't load `?worker` ids. - **Edge-function editors silently lost their Deno typings** — `AIEditor` loaded `public/deno/*.d.ts` via `/* @vite-ignore */` imports that always failed at runtime under Vite. The `.md` raw loader is generalized into `rawTextLoader` (exact-path allowlist for the two typings files, served as virtual string modules so the dep scanner never parses `.d.ts` syntax), and the imports are now static-analyzable literals that both bundlers handle (turbopack's raw-loader rules match them on the Next side). ## Split out for reviewability App-level fixes that reproduce on the Next build too (DOM-nesting hydration errors, the ghost deleted-snippet nav, the recurring pg-meta `migrations` 400) moved to their own PR: #47667. Sentry initialization for the TanStack runtime (captures were silent no-ops) is #47666, stacked on this PR. ## Full-site test campaign Drove every dashboard product area on the local TanStack build (Playwright, human-style) hunting migration regressions: redirects/404/catch-alls, org, account, project home/branches/merge, table editor CRUD, SQL editor (Monaco/run/save/templates/AI), all database pages, all auth pages, storage CRUD, edge functions + realtime, logs/observability, advisors, settings, integrations hub incl. nested routes, global UI (palette/connect/switchers/theme/fonts), and a cross-cutting sweep (document titles, back/forward chain, hard-refresh hydration on deep URLs, trailing-slash active state). Every failure found is fixed above and re-verified in-browser; remaining console quirks were cross-checked against the deployed Next build and are pre-existing (tracked separately). ## To test Most fixes are already browser-verified + covered by unit tests and the self-hosted E2E suite; the last two landed after the final browser pass and still need an in-browser check: 1. **GraphiQL Monaco workers** — restart the dev server (clear `apps/studio/node_modules/.vite` once first — the optimizer cache may hold a stale prebundle of the worker chain). Open `/project/<ref>/integrations/graphiql/graphiql` with the console open: the `Could not create web worker(s). Falling back to loading web worker code in main thread` warning must be gone, and DevTools → Sources → Threads shows the three workers (json, editor, graphql). Autocomplete in the query editor stays responsive. 2. **Edge-function Deno typings** — `/project/<ref>/functions/new`: no "Failed to load … typings" console error, and typing `Deno.` in the editor offers typed completions (e.g. `Deno.env`). Spot-checks for the rest (all previously verified): - `/project/<ref>/merge` renders (no "Module path" crash). - Multi-line SQL in Logs Explorer survives Run → reload (no `desclimit` gluing, no LIMIT-lint false failure); `s` param keeps `%0A`. - `/auth/providers` → open a provider → `?provider=…` with no trailing slash before `?`; table-editor filter/sort URLs carry no leaked `ref`/`id` params; `/?next=new-project&projectName=x` lands on `/new/new-project?projectName=x`. - Integration detail pages (cron/queues/vault/data_api) show their overview prose; GraphiQL query editor mounts. - Built bundle (`MODE=test vite build` + `start:tanstack`): table editor loads with no `process is not defined`. - `curl -sI` any page on a platform deploy: `X-Content-Type-Options: nosniff` (was the invalid `no-sniff`). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Centralized integration overview markdown loading with registry-based lookup. * Improved Monaco loading/asset path handling for smoother editor startup. * **Bug Fixes** * Next-style navigation/search handling now preserves pathname, hash, repeated query keys, and special characters (including newlines). * Redirects now reliably carry over query and hash with correct precedence. * **Security/Configuration** * Updated CSP font sourcing and unified security headers delivery across environments; conditional HSTS behavior. * Refreshed font CSS variables and font-face definitions to match the theme. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- ### Review feedback: non-prod favicon (Joshen) The TanStack `__root.tsx` hardcoded the prod favicon; local + hosted staging now use the white staging favicon (`/favicon/staging`), matching what `pages/_app.tsx` passes to `MetaFaviconsPagesRouter` for non-prod. Rather than pull the pages-router component into the TanStack head, it reuses the same synchronous `NEXT_PUBLIC_ENVIRONMENT` signal the file already uses for `IS_DEV_TOOLBAR_ENABLED` (the `head()` route option isn't a React component, so it can't run `_app`'s async CLI check — but the env signal covers the reported local/staging case). --------- Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com> Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
197 lines
7.3 KiB
JavaScript
197 lines
7.3 KiB
JavaScript
#!/usr/bin/env node
|
|
// Standalone Node HTTP server that hosts the production studio build.
|
|
//
|
|
// We export the fetch-handler shape from `dist/server/server.js` because
|
|
// Vercel consumes it directly (see `apps/studio/api/server.js`). For
|
|
// self-hosted / e2e, we need an HTTP listener of our own — this is that
|
|
// listener.
|
|
//
|
|
// Responsibilities:
|
|
// - Load env files in vite preview's order so non-NEXT_PUBLIC_* values
|
|
// (POSTGRES_PASSWORD, PG_META_CRYPTO_KEY, etc.) are in process.env
|
|
// at request time. NEXT_PUBLIC_* are already inlined into the bundle
|
|
// at build time and don't need to be re-loaded.
|
|
// - Serve static client assets from `dist/client/` directly with the
|
|
// right MIME types and cache headers.
|
|
// - Forward everything else to the TanStack Start handler exported
|
|
// from `dist/server/server.js`.
|
|
import { createReadStream } from 'node:fs'
|
|
import { stat } from 'node:fs/promises'
|
|
import { createServer } from 'node:http'
|
|
import path from 'node:path'
|
|
import { Readable } from 'node:stream'
|
|
import { fileURLToPath } from 'node:url'
|
|
|
|
import { readEnvFiles } from './lib/env.js'
|
|
|
|
const studioRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..')
|
|
const clientDir = path.join(studioRoot, 'dist/client')
|
|
const mode = process.env.MODE || 'production'
|
|
|
|
const envFiles = ['.env', '.env.local', `.env.${mode}`, `.env.${mode}.local`]
|
|
const parsed = readEnvFiles(studioRoot, envFiles)
|
|
// Don't clobber values the shell already provides — match `vite preview`.
|
|
for (const [k, v] of Object.entries(parsed)) {
|
|
if (process.env[k] !== undefined) continue
|
|
process.env[k] = v.replace(
|
|
/\$\{?([A-Za-z_][A-Za-z0-9_]*)\}?/g,
|
|
(_, name) => process.env[name] ?? parsed[name] ?? ''
|
|
)
|
|
}
|
|
|
|
const { default: handler } = await import(path.join(studioRoot, 'dist/server/server.js'))
|
|
|
|
const mimeByExt = new Map([
|
|
['.js', 'application/javascript; charset=utf-8'],
|
|
['.mjs', 'application/javascript; charset=utf-8'],
|
|
['.css', 'text/css; charset=utf-8'],
|
|
['.html', 'text/html; charset=utf-8'],
|
|
['.json', 'application/json; charset=utf-8'],
|
|
['.map', 'application/json; charset=utf-8'],
|
|
['.png', 'image/png'],
|
|
['.jpg', 'image/jpeg'],
|
|
['.jpeg', 'image/jpeg'],
|
|
['.gif', 'image/gif'],
|
|
['.svg', 'image/svg+xml'],
|
|
['.ico', 'image/x-icon'],
|
|
['.woff', 'font/woff'],
|
|
['.woff2', 'font/woff2'],
|
|
['.txt', 'text/plain; charset=utf-8'],
|
|
['.webmanifest', 'application/manifest+json'],
|
|
])
|
|
|
|
// Vite emits hashed filenames (e.g. `index-DB4J79t9.js`) for everything
|
|
// it bundles. Those are content-addressed so we serve them immutable.
|
|
const HASHED_RE = /-[A-Za-z0-9_-]{6,}\.[a-z0-9]+$/
|
|
|
|
async function serveStatic(req, res) {
|
|
let pathname
|
|
try {
|
|
pathname = new URL(req.url, 'http://localhost').pathname
|
|
} catch {
|
|
return false
|
|
}
|
|
if (pathname === '/' || pathname.endsWith('/')) return false
|
|
if (pathname.includes('..') || pathname.includes('\\')) return false
|
|
const filePath = path.join(clientDir, pathname)
|
|
if (!filePath.startsWith(clientDir + path.sep)) return false
|
|
|
|
let st
|
|
try {
|
|
st = await stat(filePath)
|
|
} catch {
|
|
return false
|
|
}
|
|
if (!st.isFile()) return false
|
|
|
|
res.statusCode = 200
|
|
res.setHeader(
|
|
'content-type',
|
|
mimeByExt.get(path.extname(filePath).toLowerCase()) ?? 'application/octet-stream'
|
|
)
|
|
res.setHeader('content-length', String(st.size))
|
|
res.setHeader(
|
|
'cache-control',
|
|
HASHED_RE.test(pathname) ? 'public, max-age=31536000, immutable' : 'no-cache'
|
|
)
|
|
await new Promise((resolve, reject) => {
|
|
const stream = createReadStream(filePath)
|
|
stream.on('error', reject)
|
|
stream.on('end', resolve)
|
|
stream.pipe(res)
|
|
})
|
|
return true
|
|
}
|
|
|
|
function toWebRequest(req) {
|
|
const protocol = req.socket.encrypted ? 'https' : 'http'
|
|
const url = `${protocol}://${req.headers.host ?? 'localhost'}${req.url}`
|
|
const headers = new Headers()
|
|
for (const [k, v] of Object.entries(req.headers)) {
|
|
if (k.startsWith(':')) continue
|
|
if (Array.isArray(v)) for (const vv of v) headers.append(k, vv)
|
|
else if (v !== undefined) headers.set(k, v)
|
|
}
|
|
const init = { method: req.method, headers }
|
|
// Only attach a body for methods that can carry one AND that actually
|
|
// have body bytes coming. Wrapping `req` in `Readable.toWeb(req)` for
|
|
// requests where Node has nothing to deliver leaves undici's
|
|
// `extractBody` looking at an already-consumed stream and throwing
|
|
// `TypeError: Response body object should not be disturbed or locked`
|
|
// at the `new Request(...)` call below.
|
|
const contentLength = Number(req.headers['content-length'] ?? '0')
|
|
const hasBody =
|
|
req.method !== 'GET' &&
|
|
req.method !== 'HEAD' &&
|
|
(contentLength > 0 || req.headers['transfer-encoding'] === 'chunked')
|
|
if (hasBody) {
|
|
init.body = Readable.toWeb(req)
|
|
init.duplex = 'half'
|
|
}
|
|
return new Request(url, init)
|
|
}
|
|
|
|
async function pipeWebResponse(response, res) {
|
|
res.statusCode = response.status
|
|
// The Headers iterator collapses duplicate keys, and for `set-cookie` it joins
|
|
// every cookie into one comma-separated value — which corrupts auth/session
|
|
// cookies. Pull the cookies out separately via getSetCookie() and set them as
|
|
// an array so each one becomes its own header.
|
|
const setCookies =
|
|
typeof response.headers.getSetCookie === 'function' ? response.headers.getSetCookie() : []
|
|
for (const [k, v] of response.headers) {
|
|
if (k.toLowerCase() === 'set-cookie') continue
|
|
res.setHeader(k, v)
|
|
}
|
|
if (setCookies.length > 0) res.setHeader('set-cookie', setCookies)
|
|
if (!response.body) {
|
|
res.end()
|
|
return
|
|
}
|
|
// Pipe via Readable.fromWeb so the underlying stream gets proper backpressure
|
|
// and gets released cleanly. `for await (chunk of response.body)` works in
|
|
// simple cases but can leave the body in a "disturbed / locked" state when
|
|
// the handler internally peeks at it — surfacing as
|
|
// `TypeError: Response body object should not be disturbed or locked` on a
|
|
// subsequent request.
|
|
await new Promise((resolve, reject) => {
|
|
const readable = Readable.fromWeb(response.body)
|
|
readable.on('error', reject)
|
|
res.on('error', reject)
|
|
res.on('close', resolve)
|
|
res.on('finish', resolve)
|
|
readable.pipe(res)
|
|
})
|
|
}
|
|
|
|
// Security headers for the self-hosted server. Mirrors the non-platform branch
|
|
// of next.config.ts `headers()` (self-hosted is always IS_PLATFORM=false, so the
|
|
// CSP is just `frame-ancestors 'none'` and there's no HSTS). The platform CSP is
|
|
// applied at the edge via vercel.ts instead; see security-headers.ts. Set before
|
|
// any response is written so both the static and handler paths inherit them.
|
|
const SECURITY_HEADERS = [
|
|
['X-Frame-Options', 'DENY'],
|
|
['X-Content-Type-Options', 'nosniff'],
|
|
['Content-Security-Policy', "frame-ancestors 'none';"],
|
|
['Referrer-Policy', 'strict-origin-when-cross-origin'],
|
|
]
|
|
|
|
const port = Number(process.env.PORT || 8082)
|
|
createServer(async (req, res) => {
|
|
try {
|
|
for (const [key, value] of SECURITY_HEADERS) res.setHeader(key, value)
|
|
if (await serveStatic(req, res)) return
|
|
const response = await handler.fetch(toWebRequest(req))
|
|
await pipeWebResponse(response, res)
|
|
} catch (err) {
|
|
console.error('[serve] request failed:', err)
|
|
if (!res.headersSent) {
|
|
res.statusCode = 500
|
|
res.setHeader('content-type', 'text/plain; charset=utf-8')
|
|
}
|
|
res.end('Internal Server Error')
|
|
}
|
|
}).listen(port, () => {
|
|
console.log(`Studio listening on http://localhost:${port} (mode=${mode})`)
|
|
})
|