mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
3bac7165bd
Moves the Studio TanStack Start build off the hand-rolled Vercel setup (an `api/server.js` function shim, rewrites in `vercel.ts`, a custom `?dpl=` skew-protection Vite plugin, and `scripts/serve.js` for self-hosted) and onto Nitro, which TanStack Start documents as its deployment path. Documents are served from the static SPA shell on the CDN; only `/api/*` and `/_serverFn/*` invoke the function. **Removed:** - `api/server.js`, `scripts/serve.js`, `scripts/smoke-server.mjs` - The `skewProtectionDpl` Vite plugin, `renderBuiltUrl`, and the `vite:preloadError` reload backstop in `router.tsx` (TanStack Router already reloads once on a failed lazy import) - Rewrites, `functions`, `outputDirectory`, and `cleanUrls` from `vercel.ts` (redirects and headers stay) - `magic-string` and `@jridgewell/remapping` devDependencies, the `preview` script **Added:** - `nitro` plugin in `vite.config.ts`. Preset is auto-detected: `.vercel/output` on Vercel, a self-contained node server in `.output` everywhere else. `vercel.immutableStaticFiles` puts hashed chunks under `/_vercel/immutable/` so tabs opened before a redeploy keep loading their chunks; `functions.maxDuration: 300` carries over the old function timeout - `scripts/vercel-spa-routes.ts`: Nitro module that rewrites the generated Build Output routes (documents -> `_shell.html`, allow-list -> `__server`, missing chunk -> 404, base-path prefixes), with a unit test - `server.ts`: TanStack Start server entry that initializes Sentry before the route tree loads and wraps the handler with `wrapFetchWithSentry` **Changed:** - `start:tanstack` runs `.output/server/index.mjs` directly with Node's `--env-file-if-exists` for the `.env` cascade. Node doesn't expand `$VAR` references, so `scripts/generateLocalEnv.js` now writes literal values into `.env.test` - Dockerfile's TanStack stage copies `.output` instead of running `pnpm deploy`; the `server.js` shim loads `.env` and imports the Nitro server - `NEXT_PUBLIC_BASE_PATH` (the platform's `/dashboard`) only sets the router basepath; Vite's `base` stays at the root so chunks can use the immutable store. The routes module emits prefixed rules for `/dashboard/api/*` and `/dashboard/_serverFn/*` and rewrites `public/` files requested under the prefix back to the root - Self-hosted security headers come from a Nitro `routeRules` entry; on Vercel they stay in `vercel.ts` - `tslib` is inlined for the build only: Nitro's dev runner has no interop for its CJS wrapper - Monaco's worker chunks follow the client assets dir so they land in the immutable store too Verified on the `studio-staging` preview (`STUDIO_FRAMEWORK=tanstack` is scoped to this branch there): documents come back as the static shell, `/dashboard/api/*` hits the function, `public/` files resolve under the prefix, a missing immutable chunk 404s. Across two deployments of this branch, the older deployment's chunks still load from the immutable store and requests carrying its `__vdpl` cookie are answered by that deployment. Self-hosted path covered by the TanStack E2E job and the Docker build job. ## To test - On the `studio-staging` preview: `/dashboard/project/<ref>` should show `content-disposition: inline; filename="_shell.html"` and a single-region `x-vercel-id`; `/dashboard/api/get-utc-time` a two-region id - Sign in and click through a few pages, including one that opens Monaco (SQL editor) so the worker chunks load - After the next deploy, a tab left open on the previous one should still navigate (lazy chunks) and call the API without errors - Self-hosted: `STUDIO_FRAMEWORK=tanstack pnpm --filter studio build && pnpm --filter studio start`, then check `/api/platform/profile` and that responses carry the security headers <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Production TanStack deployments now run on Nitro’s self-contained server output. * Vercel routing serves static pages first while directing API and server-function requests appropriately. * Server-function requests can include deployment identification for consistent handling. * Local environment generation now writes resolved configuration values. * **Bug Fixes** * Improved handling of missing static assets and SPA fallback routing. * Server-side error monitoring now captures request errors in the new runtime. * **Refactor** * Replaced the legacy production server and smoke-test workflow with Nitro-based startup. * Removed automatic reload handling for stale client assets. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
98 lines
4.7 KiB
JSON
98 lines
4.7 KiB
JSON
{
|
|
"$schema": "https://unpkg.com/knip@6/schema-jsonc.json",
|
|
// Only files + dependencies are gated in CI for now; the export/type surface
|
|
// has too much noise to enforce yet.
|
|
"exclude": ["types", "exports"],
|
|
"ignore": [
|
|
"examples/**",
|
|
"**/*.mdx",
|
|
// skip supabase functions
|
|
"supabase/functions/**",
|
|
"**/*.test.ts",
|
|
// ignore registry blocks in ui-library
|
|
"apps/ui-library/registry/default/**",
|
|
"apps/ui-library/contentlayer.config.js",
|
|
],
|
|
"workspaces": {
|
|
"apps/studio": {
|
|
// Framework-convention files: nothing in source imports these, the
|
|
// framework/host discovers them by path. They are `entry` rather than
|
|
// `ignore` so knip still traces what they import — an ignored file's
|
|
// imports are invisible, which makes everything only it pulls in look
|
|
// dead.
|
|
"entry": [
|
|
// TanStack Start. knip's tanstack-router plugin only looks under
|
|
// `src/`, but vite.config.ts sets `srcDirectory: './'`, so the
|
|
// conventional files sit at the workspace root and have to be listed.
|
|
// routeTree.gen.ts is deliberately absent: router.tsx imports it, so
|
|
// it is traced already.
|
|
"router.tsx",
|
|
"start.ts",
|
|
// Route modules are real entry points. Keeping them as entries (not
|
|
// ignores) means components reachable only from the TanStack tree stay
|
|
// traced as the Next `pages/**` tree is dismantled.
|
|
"routes/**/*.{ts,tsx}",
|
|
// Next.js compat shims. Reached only through the `nextShims` aliases in
|
|
// vite.config.ts (`next/link` -> compat/next/link.tsx), which knip
|
|
// cannot resolve, so they need to be entries in their own right.
|
|
"compat/**/*.{ts,tsx}",
|
|
],
|
|
"ignore": [
|
|
"public/**",
|
|
// one-off build/codegen scripts, run by hand or from package.json
|
|
"scripts/**",
|
|
// dynamically imported
|
|
"components/interfaces/ConnectSheet/content/**",
|
|
"components/interfaces/ConnectSheet/DirectConnectionExamples.tsx",
|
|
// data layer templates, copied when adding a new query/mutation
|
|
"data/__templates/**",
|
|
// evals are run from a GitHub action, not from the app
|
|
"evals/**",
|
|
],
|
|
// Narrowly scoped suppressions: one issue type, one path. Preferred over
|
|
// `ignore` (which drops the file from the project entirely, hiding the
|
|
// imports and dependencies it legitimately uses) and over
|
|
// `ignoreMembers` (which matches member names across the whole
|
|
// workspace).
|
|
"ignoreIssues": {
|
|
// graphql-codegen `client` preset output (scripts/codegen.ts,
|
|
// regenerated by `pnpm build:graphql-types`). The preset always emits
|
|
// the full set, so some of it is unreferenced by design. execute.ts in
|
|
// the same directory is hand-written and is NOT listed here.
|
|
"data/graphql/{fragment-masking,gql,graphql}.ts": ["files"],
|
|
// CONSTRAINT_TYPE mirrors the complete closed set of Postgres
|
|
// `pg_constraint.contype` values (c/f/p/u/t/x). The members we don't
|
|
// read are documentation of the valid values, not dead code. Scoped to
|
|
// this file so `enumMembers` keeps working everywhere else.
|
|
"data/database/constraints-query.ts": ["enumMembers"],
|
|
"hooks/misc/useTrackExperimentExposure.ts": ["files"],
|
|
// Staging-only pinned Postgres image + FDW request payload for creating
|
|
// Warehouse test projects by hand. Nothing imports it yet — it's kept
|
|
// alongside the rest of the Warehouse work so the values stay in one
|
|
// place until the project-creation surface that consumes them lands.
|
|
"components/interfaces/ProjectCreation/WarehouseFdwCustomImage.constants.ts": ["files"],
|
|
},
|
|
// `vercel` is a globally installed CLI used by the `deploy:staging` script
|
|
"ignoreBinaries": ["vercel"],
|
|
// Dependencies that are required implicitly — nothing imports them by a
|
|
// specifier knip can follow, but removing them breaks the build or the
|
|
// runtime.
|
|
"ignoreDependencies": [
|
|
// vite.config.ts resolves 'lodash-es/package.json' by string via
|
|
// createRequire to build the SSR lodash -> lodash-es alias
|
|
"lodash-es",
|
|
// named as a webpack/turbopack loader string in next.config.ts
|
|
// (`loaders: ['raw-loader']`)
|
|
"raw-loader",
|
|
// runtime hooks for @sentry/nextjs / OpenTelemetry Node
|
|
// instrumentation. Must be direct deps under pnpm's strict isolation
|
|
// (#35030).
|
|
"import-in-the-middle",
|
|
"require-in-the-middle",
|
|
// deliberate dependency-resolution pin (#45876), never imported
|
|
"@babel/core",
|
|
],
|
|
},
|
|
},
|
|
}
|