mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
Alaister Young
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>
68 lines
2.3 KiB
JavaScript
68 lines
2.3 KiB
JavaScript
const fs = require('fs')
|
|
const generatedEnv = require('../keys.json')
|
|
|
|
/**
|
|
* This script takes the API keys from the local environment, merges them with some predefined variables and saves them
|
|
* to a env.test file in the studio app. This is needed to prepare the studio so that it can be run with the local
|
|
* environment as the backend.
|
|
*/
|
|
|
|
const defaultEnv = {
|
|
// NEXT_ANALYTICS_BACKEND_PROVIDER: 'postgres',
|
|
// SUPABASE_REST_URL: 'http://127.0.0.1:54321/rest/v1/',
|
|
// NEXT_PUBLIC_ENABLE_LOGS: 'false',
|
|
// E2E tests target self-hosted studio (no auth). Explicitly written so that
|
|
// .env.test overrides any IS_PLATFORM=true that a developer's .env.local
|
|
// might set for their own platform-mode work.
|
|
NEXT_PUBLIC_IS_PLATFORM: 'false',
|
|
PG_META_CRYPTO_KEY: 'SAMPLE_KEY',
|
|
POSTGRES_PASSWORD: 'postgres',
|
|
POSTGRES_HOST: 'db',
|
|
POSTGRES_DB: 'postgres',
|
|
POSTGRES_PORT: '5432',
|
|
// Literal values, not `$API_URL` references: the TanStack server is started
|
|
// with Node's --env-file, which does not expand variables.
|
|
SUPABASE_ANON_KEY: generatedEnv.ANON_KEY,
|
|
SUPABASE_SERVICE_KEY: generatedEnv.SERVICE_ROLE_KEY,
|
|
SUPABASE_URL: generatedEnv.API_URL,
|
|
STUDIO_PG_META_URL: `${generatedEnv.API_URL}/pg`,
|
|
SUPABASE_PUBLIC_URL: generatedEnv.API_URL,
|
|
SENTRY_IGNORE_API_RESOLUTION_ERROR: '1',
|
|
LOGFLARE_URL: 'http://127.0.0.1:54327',
|
|
LOGFLARE_PRIVATE_ACCESS_TOKEN: 'api-key',
|
|
LOGFLARE_API_KEY: 'api-key',
|
|
NEXT_PUBLIC_SITE_URL: 'http://localhost:8082',
|
|
NEXT_PUBLIC_GOTRUE_URL: `${generatedEnv.API_URL}/auth/v1`,
|
|
NEXT_PUBLIC_HCAPTCHA_SITE_KEY: '10000000-ffff-ffff-ffff-000000000001',
|
|
NEXT_PUBLIC_NODE_ENV: 'test',
|
|
SNIPPETS_MANAGEMENT_FOLDER: '../../supabase/snippets',
|
|
EDGE_FUNCTIONS_MANAGEMENT_FOLDER: '../../supabase/functions', // path relative to studio project
|
|
}
|
|
|
|
const environment = { ...generatedEnv, ...defaultEnv }
|
|
|
|
fs.writeFileSync(
|
|
'./apps/studio/.env.test',
|
|
Object.keys(environment)
|
|
.map((key) => `${key}=${environment[key]}`)
|
|
.join('\n')
|
|
)
|
|
|
|
const STUDIO_URL = environment.NEXT_PUBLIC_SITE_URL
|
|
const WEB_SERVER_PORT = new URL(STUDIO_URL).port ?? undefined
|
|
const API_URL = environment.API_URL
|
|
|
|
const e2eTestEnv = {
|
|
STUDIO_URL,
|
|
API_URL,
|
|
WEB_SERVER_PORT,
|
|
IS_PLATFORM: 'false',
|
|
}
|
|
|
|
fs.writeFileSync(
|
|
'./e2e/studio/.env.local',
|
|
Object.keys(e2eTestEnv)
|
|
.map((key) => `${key}=${e2eTestEnv[key]}`)
|
|
.join('\n')
|
|
)
|