@ngrok/app-server 0.3.1 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -27
- package/dist/{build-id-C6sYO9Yp.js → build-id-B0448vZH.js} +27 -2
- package/dist/build-id-B0448vZH.js.map +1 -0
- package/dist/{build-manifest-UDNk81Ce.js → build-manifest-DBMWe3Lx.js} +12 -2
- package/dist/build-manifest-DBMWe3Lx.js.map +1 -0
- package/dist/cli.js +2 -2
- package/dist/client-browser.js +1 -1
- package/dist/client.js +1 -1
- package/dist/{entry-CM6Ma-Tv.d.ts → create-server-D4-nVOVJ.d.ts} +56 -70
- package/dist/{create-server-DkTeIJ8L.js → create-server-jMl2ltHD.js} +454 -394
- package/dist/create-server-jMl2ltHD.js.map +1 -0
- package/dist/entry-BPrgE_6K.d.ts +94 -0
- package/dist/entry-D9H4LA9c.js +351 -0
- package/dist/entry-D9H4LA9c.js.map +1 -0
- package/dist/{index-Bo5G9LuQ.d.ts → index-Db7dspq6.d.ts} +6 -1
- package/dist/index.d.ts +5 -14
- package/dist/index.js +3 -3
- package/dist/{load-entry-CmkdlmDX.js → load-entry-D7r0mjEp.js} +4 -4
- package/dist/{load-entry-CmkdlmDX.js.map → load-entry-D7r0mjEp.js.map} +1 -1
- package/dist/{node-BFH82eeL.js → node-C1qudLs_.js} +2 -2
- package/dist/{node-BFH82eeL.js.map → node-C1qudLs_.js.map} +1 -1
- package/dist/node-vite.d.ts +1 -1
- package/dist/node.d.ts +1 -1
- package/dist/node.js +1 -1
- package/dist/react-router-vite.d.ts +1 -1
- package/dist/react-router.d.ts +3 -2
- package/dist/react-router.js +31 -2
- package/dist/react-router.js.map +1 -1
- package/dist/request-context-BtQ87VYb.js.map +1 -1
- package/dist/{script-hashes-hqUk6kG7.js → script-hashes-C6hQ5XnP.js} +22 -4
- package/dist/script-hashes-C6hQ5XnP.js.map +1 -0
- package/dist/{serve-Cc-ADdhZ.js → serve-E0hSGe6_.js} +2 -2
- package/dist/{serve-Cc-ADdhZ.js.map → serve-E0hSGe6_.js.map} +1 -1
- package/dist/{stale-build-navigation-PnMLtTF8.js → stale-build-navigation-rg5xxmTr.js} +2 -2
- package/dist/{stale-build-navigation-PnMLtTF8.js.map → stale-build-navigation-rg5xxmTr.js.map} +1 -1
- package/dist/{start-Cb3kknlF.js → start-CifYPRq1.js} +34 -6
- package/dist/start-CifYPRq1.js.map +1 -0
- package/dist/tanstack-start-vite.d.ts +1 -1
- package/dist/tanstack-start.d.ts +2 -2
- package/dist/testing.d.ts +56 -0
- package/dist/testing.js +114 -0
- package/dist/testing.js.map +1 -0
- package/dist/{trailing-slash-DX7NB88H.d.ts → trailing-slash-CFSv_Gzx.d.ts} +2 -2
- package/dist/{types-DLYxYS6M.d.ts → types-j29vspx_.d.ts} +16 -2
- package/dist/vercel-pages.d.ts +32 -0
- package/dist/vercel-pages.js +54 -0
- package/dist/vercel-pages.js.map +1 -0
- package/dist/vercel-vite.d.ts +30 -9
- package/dist/vercel-vite.js +160 -17
- package/dist/vercel-vite.js.map +1 -1
- package/dist/vercel.d.ts +2 -2
- package/dist/vercel.js +2 -2
- package/dist/{vite-iioAoxSt.js → vite-BDREIgiH.js} +45 -33
- package/dist/vite-BDREIgiH.js.map +1 -0
- package/dist/vite.d.ts +1 -1
- package/dist/vite.js +1 -1
- package/package.json +5 -1
- package/dist/build-id-C6sYO9Yp.js.map +0 -1
- package/dist/build-manifest-UDNk81Ce.js.map +0 -1
- package/dist/create-server-DkTeIJ8L.js.map +0 -1
- package/dist/entry-CenmvESk.js +0 -116
- package/dist/entry-CenmvESk.js.map +0 -1
- package/dist/script-hashes-hqUk6kG7.js.map +0 -1
- package/dist/start-Cb3kknlF.js.map +0 -1
- package/dist/vite-iioAoxSt.js.map +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"start-CifYPRq1.js","names":["createServer","createHttpServer"],"sources":["../src/cli/served-apps.ts","../src/cli/start-port.ts","../src/cli/start.ts"],"sourcesContent":["import type { AppServerEntry } from \"../core/entry.js\";\n\ntype ServedApp = { entry: AppServerEntry; pending: number; replaced: boolean };\n\n/** What {@link servedApps} returns. */\ntype ServedApps = {\n\t/** Runs `handle` for a request that `entry` serves. */\n\tserve: <Result>(\n\t\tentry: AppServerEntry,\n\t\thandle: (entry: AppServerEntry) => Promise<Result>,\n\t) => Promise<Result>;\n\t/**\n\t * At exit: aborts `shutdownSignal()` and runs the `onShutdown` hooks of each\n\t * app still held. Resolves when the hooks finish or pass the deadline.\n\t */\n\tstopAll: () => Promise<void>;\n};\n\n/**\n * Tracks the apps that `app-server start` serves. An edit to `server.ts` makes a\n * new app, and the old app's plugins still hold what their `setup` opened.\n * When the last request that the old app took returns, its `onShutdown` hooks\n * run, and the tracker lets go of it. A route edit makes a new entry with the\n * same app, which keeps its plugins.\n */\nexport function servedApps(): ServedApps {\n\tlet current: ServedApp | undefined;\n\tconst served = new Set<ServedApp>();\n\t// Why keep the app until its hooks settle: `stopAll` must wait for hooks that already run.\n\t// `stopPlugins` runs the hooks once, so a second call only waits.\n\tconst retire = async (app: ServedApp) => {\n\t\ttry {\n\t\t\tawait app.entry.stopPlugins();\n\t\t} finally {\n\t\t\tserved.delete(app);\n\t\t}\n\t};\n\treturn {\n\t\tserve: async (entry, handle) => {\n\t\t\tif (current?.entry.app === entry.app) {\n\t\t\t\tcurrent.entry = entry;\n\t\t\t} else {\n\t\t\t\tif (current != null) {\n\t\t\t\t\tcurrent.replaced = true;\n\t\t\t\t\tif (current.pending === 0) {\n\t\t\t\t\t\tvoid retire(current);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tcurrent = { entry, pending: 0, replaced: false };\n\t\t\t\tserved.add(current);\n\t\t\t}\n\t\t\tconst app = current;\n\t\t\tapp.pending += 1;\n\t\t\ttry {\n\t\t\t\treturn await handle(entry);\n\t\t\t} finally {\n\t\t\t\tapp.pending -= 1;\n\t\t\t\tif (app.replaced && app.pending === 0) {\n\t\t\t\t\tvoid retire(app);\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\tstopAll: async () => {\n\t\t\tawait Promise.all(\n\t\t\t\tArray.from(served, async (app) => {\n\t\t\t\t\tapp.entry.abortShutdownSignal();\n\t\t\t\t\tawait retire(app);\n\t\t\t\t}),\n\t\t\t);\n\t\t},\n\t};\n}\n","import { createServer } from \"node:net\";\nimport type { Server } from \"node:net\";\n\nconst MAX_PORT = 65_535;\n\n/** Options for {@link listenFromPort}. */\nexport type ListenFromPortOptions = {\n\t/** The first port to try. 0 lets the OS pick one. */\n\tport: number;\n\t/** @default every interface */\n\thostname?: string | undefined;\n\t/** When true, a port in use throws and no other port is tried. */\n\tstrictPort: boolean;\n\t/** Runs for each port in use before the next port is tried. */\n\tonPortInUse?: (port: number) => void;\n\t/**\n\t * Runs when `strictPort` is true and the server listens on `hostname`, but\n\t * another server holds the port on a wildcard address.\n\t */\n\tonWildcardInUse?: (port: number) => void;\n};\n\n/**\n * Starts `server` on `port`. When the port is in use, it tries each next port\n * up to 65535, like Vite and `react-router-serve` do in development.\n *\n * @returns the port that the server listens on\n */\nexport async function listenFromPort(\n\tserver: Server,\n\t{ port, hostname, strictPort, onPortInUse, onWildcardInUse }: ListenFromPortOptions,\n): Promise<number> {\n\tif (port === 0) {\n\t\tawait bind(server, port, hostname);\n\t\treturn boundPort(server, port);\n\t}\n\tif (strictPort) {\n\t\t// Why a warning and not an error: a server on one other address also fails the wildcard\n\t\t// check, and that server does not share `hostname`. Vite warns for the same reason.\n\t\tconst freeOnWildcard = hostname == null || (await isFreeOnWildcard(port));\n\t\tawait bind(server, port, hostname);\n\t\tif (!freeOnWildcard) {\n\t\t\tonWildcardInUse?.(port);\n\t\t}\n\t\treturn port;\n\t}\n\tfor (let candidate = port; candidate <= MAX_PORT; candidate++) {\n\t\t// Why the wildcard check: a server on `::` and a server on `localhost` can share a port, and\n\t\t// then the browser can reach the other server.\n\t\tif (hostname == null || (await isFreeOnWildcard(candidate))) {\n\t\t\ttry {\n\t\t\t\tawait bind(server, candidate, hostname);\n\t\t\t\treturn candidate;\n\t\t\t} catch (error) {\n\t\t\t\tif (!isAddressInUse(error)) {\n\t\t\t\t\tthrow error;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tonPortInUse?.(candidate);\n\t}\n\tthrow new Error(`No open port from ${port} to ${MAX_PORT}.`);\n}\n\nasync function bind(server: Server, port: number, hostname: string | undefined): Promise<void> {\n\treturn new Promise<void>((resolve, reject) => {\n\t\tfunction onError(error: Error) {\n\t\t\tserver.off(\"listening\", onListening);\n\t\t\treject(error);\n\t\t}\n\t\tfunction onListening() {\n\t\t\tserver.off(\"error\", onError);\n\t\t\tresolve();\n\t\t}\n\t\tserver.once(\"error\", onError);\n\t\tserver.once(\"listening\", onListening);\n\t\tserver.listen(port, hostname);\n\t});\n}\n\nasync function isFreeOnWildcard(port: number): Promise<boolean> {\n\tconst probe = createServer();\n\ttry {\n\t\tawait bind(probe, port, undefined);\n\t} catch (error) {\n\t\tif (isAddressInUse(error)) {\n\t\t\treturn false;\n\t\t}\n\t\tthrow error;\n\t}\n\tawait new Promise<void>((resolve) => {\n\t\tprobe.close(() => {\n\t\t\tresolve();\n\t\t});\n\t});\n\treturn true;\n}\n\nfunction boundPort(server: Server, fallback: number): number {\n\tconst address = server.address();\n\treturn typeof address === \"object\" && address != null ? address.port : fallback;\n}\n\nfunction isAddressInUse(error: unknown): boolean {\n\treturn error instanceof Error && \"code\" in error && error.code === \"EADDRINUSE\";\n}\n","import { createServer as createHttpServer } from \"node:http\";\nimport type { Server } from \"node:http\";\nimport type { Plugin } from \"vite\";\nimport { errorAttributes, jsonSink } from \"../core/log.js\";\nimport { devServerStage } from \"../node/dev-server.js\";\nimport { exitAfterFlush } from \"../node/exit.js\";\nimport { listenerUrl } from \"../node/runtimes/listen-options.js\";\nimport { requestListener } from \"../node/response-writer.js\";\nimport { parsePort } from \"../node/tcp.js\";\nimport { SERVER_ENTRY_ID } from \"../vite/index.js\";\nimport { loadEntry } from \"./load-entry.js\";\nimport { servedApps } from \"./served-apps.js\";\nimport { listenFromPort } from \"./start-port.js\";\n\n/**\n * Runs the app in development: the same pipeline as production, with Vite in\n * middleware mode inside it. Each request loads the server entry through\n * Vite's SSR runner, so an edit to a route or to the app's `server.ts` applies\n * at once. HMR shares the port. Vite's plugins get the CLI's HTTP server as\n * `server.httpServer`.\n *\n * The port is `--port`, else `PORT`, else Vite's `server.port`. When that port is in use, the\n * server tries each next port, unless Vite's `server.strictPort` is true. The\n * host is `HOST`, else Vite's `server.host`.\n */\nexport async function start(): Promise<void> {\n\tconst vite = await import(\"vite\");\n\tconst httpServer = createHttpServer();\n\tconst viteServer = await vite.createServer({\n\t\t// Why `true`, not `{ server }`: Vite then adds a proxy `upgrade` listener to the server, and a\n\t\t// restart does not remove it.\n\t\tserver: { middlewareMode: true, ws: { server: httpServer } },\n\t\tappType: \"custom\",\n\t\tplugins: [shareHttpServer(httpServer)],\n\t});\n\t// Why read it for each request: a Vite restart, such as after a config edit, replaces the environments.\n\tconst ssrRunner = () => {\n\t\tconst { ssr } = viteServer.environments;\n\t\tif (ssr == null || !vite.isRunnableDevEnvironment(ssr)) {\n\t\t\tthrow new Error(\"Vite's SSR environment cannot run modules.\");\n\t\t}\n\t\treturn ssr.runner;\n\t};\n\tssrRunner();\n\tif (!viteServer.config.plugins.some((plugin) => plugin.name === \"@ngrok/app-server\")) {\n\t\tawait viteServer.close();\n\t\tthrow new Error(\n\t\t\t\"`app-server start` needs the `appServer` plugin from @ngrok/app-server/vite in the Vite config.\",\n\t\t);\n\t}\n\tconst devServer = devServerStage(viteServer.middlewares, {\n\t\tpublicFiles: () => ({ directory: viteServer.config.publicDir, base: viteServer.config.base }),\n\t});\n\tconst sink = jsonSink();\n\tconst apps = servedApps();\n\n\tconst listener = requestListener(async (request, bindings) => {\n\t\ttry {\n\t\t\treturn await apps.serve(\n\t\t\t\tawait loadEntry(await ssrRunner().import(SERVER_ENTRY_ID)),\n\t\t\t\tasync (entry) => entry.fetchDev(request, bindings, devServer),\n\t\t\t);\n\t\t} catch (error) {\n\t\t\tif (error instanceof Error) {\n\t\t\t\tviteServer.ssrFixStacktrace(error);\n\t\t\t}\n\t\t\tsink.log(\"error\", \"dev request failed\", errorAttributes(error));\n\t\t\treturn new Response(error instanceof Error ? (error.stack ?? error.message) : String(error), {\n\t\t\t\tstatus: 500,\n\t\t\t\theaders: { \"Content-Type\": \"text/plain; charset=utf-8\" },\n\t\t\t});\n\t\t}\n\t});\n\thttpServer.on(\"request\", (request, response) => {\n\t\tvoid listener(request, response);\n\t});\n\n\tconst port =\n\t\tprocess.env.PORT == null ? viteServer.config.server.port : parsePort(process.env.PORT);\n\tconst hostname = process.env.HOST || viteHostname(viteServer.config.server.host);\n\tconst boundPort = await listenFromPort(httpServer, {\n\t\tport,\n\t\thostname,\n\t\tstrictPort: viteServer.config.server.strictPort,\n\t\tonPortInUse: (inUse) => {\n\t\t\tsink.log(\"info\", \"port in use, trying the next port\", { \"server.port\": inUse });\n\t\t},\n\t\tonWildcardInUse: (inUse) => {\n\t\t\tsink.log(\"warn\", \"port in use on a wildcard address\", {\n\t\t\t\t\"server.port\": inUse,\n\t\t\t\t\"server.address\": hostname,\n\t\t\t});\n\t\t},\n\t});\n\tsink.log(\"info\", \"listening\", { \"app_server.urls\": [listenerUrl(hostname, boundPort)] });\n\n\tfor (const signal of [\"SIGTERM\", \"SIGINT\"] as const) {\n\t\tprocess.once(signal, () => {\n\t\t\tconst pluginsStopped = apps.stopAll();\n\t\t\thttpServer.closeAllConnections();\n\t\t\tconst httpClosed = new Promise<void>((resolve) => {\n\t\t\t\thttpServer.close(() => {\n\t\t\t\t\tresolve();\n\t\t\t\t});\n\t\t\t});\n\t\t\tconst viteClosed = viteServer.close().catch((error: unknown) => {\n\t\t\t\tsink.log(\"error\", \"Vite close failed\", errorAttributes(error));\n\t\t\t\tprocess.exitCode = 1;\n\t\t\t});\n\t\t\tvoid Promise.all([pluginsStopped, httpClosed, viteClosed]).finally(exitAfterFlush);\n\t\t});\n\t}\n}\n\n/**\n * A Vite plugin that sets `server.httpServer` to the CLI's HTTP server before\n * the `configureServer` hooks of the app's plugins run. Why: in middleware\n * mode, Vite sets it to `null`. Then a plugin that waits for `listening` or\n * `close` on it does nothing, with no error.\n *\n * @example\n * vite.createServer({ plugins: [shareHttpServer(httpServer)] });\n */\nfunction shareHttpServer(httpServer: Server): Plugin {\n\tconst plugin: Plugin = {\n\t\tname: \"@ngrok/app-server:http-server\",\n\t\t// Why first: Vite puts an inline plugin after the config file's plugins, so an app plugin with\n\t\t// `enforce: \"pre\"` and `order: \"pre\"` runs its `configureServer` before this one.\n\t\tconfigResolved: (config) => {\n\t\t\t// oxlint-disable-next-line typescript/no-unsafe-type-assertion -- Vite sorts each hook from this array later.\n\t\t\tconst plugins = config.plugins as Plugin[];\n\t\t\tplugins.splice(plugins.indexOf(plugin), 1);\n\t\t\tplugins.unshift(plugin);\n\t\t},\n\t\tconfigureServer: {\n\t\t\torder: \"pre\",\n\t\t\thandler: (server) => {\n\t\t\t\tserver.httpServer = httpServer;\n\t\t\t},\n\t\t},\n\t};\n\treturn plugin;\n}\n\n/** The hostname for Vite's `server.host`: `true` is every interface, and no value is `localhost`. */\nfunction viteHostname(host: string | boolean | undefined): string | undefined {\n\tif (host === true) {\n\t\treturn undefined;\n\t}\n\treturn typeof host === \"string\" && host !== \"\" ? host : \"localhost\";\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAyBA,SAAgB,aAAyB;CACxC,IAAI;CACJ,MAAM,yBAAS,IAAI,IAAe;CAGlC,MAAM,SAAS,OAAO,QAAmB;EACxC,IAAI;GACH,MAAM,IAAI,MAAM,YAAY;EAC7B,UAAU;GACT,OAAO,OAAO,GAAG;EAClB;CACD;CACA,OAAO;EACN,OAAO,OAAO,OAAO,WAAW;GAC/B,IAAI,SAAS,MAAM,QAAQ,MAAM,KAChC,QAAQ,QAAQ;QACV;IACN,IAAI,WAAW,MAAM;KACpB,QAAQ,WAAW;KACnB,IAAI,QAAQ,YAAY,GACvB,AAAK,OAAO,OAAO;IAErB;IACA,UAAU;KAAE;KAAO,SAAS;KAAG,UAAU;IAAM;IAC/C,OAAO,IAAI,OAAO;GACnB;GACA,MAAM,MAAM;GACZ,IAAI,WAAW;GACf,IAAI;IACH,OAAO,MAAM,OAAO,KAAK;GAC1B,UAAU;IACT,IAAI,WAAW;IACf,IAAI,IAAI,YAAY,IAAI,YAAY,GACnC,AAAK,OAAO,GAAG;GAEjB;EACD;EACA,SAAS,YAAY;GACpB,MAAM,QAAQ,IACb,MAAM,KAAK,QAAQ,OAAO,QAAQ;IACjC,IAAI,MAAM,oBAAoB;IAC9B,MAAM,OAAO,GAAG;GACjB,CAAC,CACF;EACD;CACD;AACD;;;ACpEA,MAAM,WAAW;;;;;;;AAyBjB,eAAsB,eACrB,QACA,EAAE,MAAM,UAAU,YAAY,aAAa,mBACzB;CAClB,IAAI,SAAS,GAAG;EACf,MAAM,KAAK,QAAQ,MAAM,QAAQ;EACjC,OAAO,UAAU,QAAQ,IAAI;CAC9B;CACA,IAAI,YAAY;EAGf,MAAM,iBAAiB,YAAY,QAAS,MAAM,iBAAiB,IAAI;EACvE,MAAM,KAAK,QAAQ,MAAM,QAAQ;EACjC,IAAI,CAAC,gBACJ,kBAAkB,IAAI;EAEvB,OAAO;CACR;CACA,KAAK,IAAI,YAAY,MAAM,aAAa,UAAU,aAAa;EAG9D,IAAI,YAAY,QAAS,MAAM,iBAAiB,SAAS,GACxD,IAAI;GACH,MAAM,KAAK,QAAQ,WAAW,QAAQ;GACtC,OAAO;EACR,SAAS,OAAO;GACf,IAAI,CAAC,eAAe,KAAK,GACxB,MAAM;EAER;EAED,cAAc,SAAS;CACxB;CACA,MAAM,IAAI,MAAM,qBAAqB,KAAK,MAAM,SAAS,EAAE;AAC5D;AAEA,eAAe,KAAK,QAAgB,MAAc,UAA6C;CAC9F,OAAO,IAAI,SAAe,SAAS,WAAW;EAC7C,SAAS,QAAQ,OAAc;GAC9B,OAAO,IAAI,aAAa,WAAW;GACnC,OAAO,KAAK;EACb;EACA,SAAS,cAAc;GACtB,OAAO,IAAI,SAAS,OAAO;GAC3B,QAAQ;EACT;EACA,OAAO,KAAK,SAAS,OAAO;EAC5B,OAAO,KAAK,aAAa,WAAW;EACpC,OAAO,OAAO,MAAM,QAAQ;CAC7B,CAAC;AACF;AAEA,eAAe,iBAAiB,MAAgC;CAC/D,MAAM,QAAQA,eAAa;CAC3B,IAAI;EACH,MAAM,KAAK,OAAO,MAAM,MAAS;CAClC,SAAS,OAAO;EACf,IAAI,eAAe,KAAK,GACvB,OAAO;EAER,MAAM;CACP;CACA,MAAM,IAAI,SAAe,YAAY;EACpC,MAAM,YAAY;GACjB,QAAQ;EACT,CAAC;CACF,CAAC;CACD,OAAO;AACR;AAEA,SAAS,UAAU,QAAgB,UAA0B;CAC5D,MAAM,UAAU,OAAO,QAAQ;CAC/B,OAAO,OAAO,YAAY,YAAY,WAAW,OAAO,QAAQ,OAAO;AACxE;AAEA,SAAS,eAAe,OAAyB;CAChD,OAAO,iBAAiB,SAAS,UAAU,SAAS,MAAM,SAAS;AACpE;;;;;;;;;;;;;;AChFA,eAAsB,QAAuB;CAC5C,MAAM,OAAO,MAAM,OAAO;CAC1B,MAAM,aAAaC,aAAiB;CACpC,MAAM,aAAa,MAAM,KAAK,aAAa;EAG1C,QAAQ;GAAE,gBAAgB;GAAM,IAAI,EAAE,QAAQ,WAAW;EAAE;EAC3D,SAAS;EACT,SAAS,CAAC,gBAAgB,UAAU,CAAC;CACtC,CAAC;CAED,MAAM,kBAAkB;EACvB,MAAM,EAAE,QAAQ,WAAW;EAC3B,IAAI,OAAO,QAAQ,CAAC,KAAK,yBAAyB,GAAG,GACpD,MAAM,IAAI,MAAM,4CAA4C;EAE7D,OAAO,IAAI;CACZ;CACA,UAAU;CACV,IAAI,CAAC,WAAW,OAAO,QAAQ,MAAM,WAAW,OAAO,SAAS,mBAAmB,GAAG;EACrF,MAAM,WAAW,MAAM;EACvB,MAAM,IAAI,MACT,iGACD;CACD;CACA,MAAM,YAAY,eAAe,WAAW,aAAa,EACxD,oBAAoB;EAAE,WAAW,WAAW,OAAO;EAAW,MAAM,WAAW,OAAO;CAAK,GAC5F,CAAC;CACD,MAAM,OAAO,SAAS;CACtB,MAAM,OAAO,WAAW;CAExB,MAAM,WAAW,gBAAgB,OAAO,SAAS,aAAa;EAC7D,IAAI;GACH,OAAO,MAAM,KAAK,MACjB,MAAM,UAAU,MAAM,UAAU,CAAC,CAAC,OAAO,eAAe,CAAC,GACzD,OAAO,UAAU,MAAM,SAAS,SAAS,UAAU,SAAS,CAC7D;EACD,SAAS,OAAO;GACf,IAAI,iBAAiB,OACpB,WAAW,iBAAiB,KAAK;GAElC,KAAK,IAAI,SAAS,sBAAsB,gBAAgB,KAAK,CAAC;GAC9D,OAAO,IAAI,SAAS,iBAAiB,QAAS,MAAM,SAAS,MAAM,UAAW,OAAO,KAAK,GAAG;IAC5F,QAAQ;IACR,SAAS,EAAE,gBAAgB,4BAA4B;GACxD,CAAC;EACF;CACD,CAAC;CACD,WAAW,GAAG,YAAY,SAAS,aAAa;EAC/C,AAAK,SAAS,SAAS,QAAQ;CAChC,CAAC;CAED,MAAM,OACL,QAAQ,IAAI,QAAQ,OAAO,WAAW,OAAO,OAAO,OAAO,UAAU,QAAQ,IAAI,IAAI;CACtF,MAAM,WAAW,QAAQ,IAAI,QAAQ,aAAa,WAAW,OAAO,OAAO,IAAI;CAC/E,MAAM,YAAY,MAAM,eAAe,YAAY;EAClD;EACA;EACA,YAAY,WAAW,OAAO,OAAO;EACrC,cAAc,UAAU;GACvB,KAAK,IAAI,QAAQ,qCAAqC,EAAE,eAAe,MAAM,CAAC;EAC/E;EACA,kBAAkB,UAAU;GAC3B,KAAK,IAAI,QAAQ,qCAAqC;IACrD,eAAe;IACf,kBAAkB;GACnB,CAAC;EACF;CACD,CAAC;CACD,KAAK,IAAI,QAAQ,aAAa,EAAE,mBAAmB,CAAC,YAAY,UAAU,SAAS,CAAC,EAAE,CAAC;CAEvF,KAAK,MAAM,UAAU,CAAC,WAAW,QAAQ,GACxC,QAAQ,KAAK,cAAc;EAC1B,MAAM,iBAAiB,KAAK,QAAQ;EACpC,WAAW,oBAAoB;EAC/B,MAAM,aAAa,IAAI,SAAe,YAAY;GACjD,WAAW,YAAY;IACtB,QAAQ;GACT,CAAC;EACF,CAAC;EACD,MAAM,aAAa,WAAW,MAAM,CAAC,CAAC,OAAO,UAAmB;GAC/D,KAAK,IAAI,SAAS,qBAAqB,gBAAgB,KAAK,CAAC;GAC7D,QAAQ,WAAW;EACpB,CAAC;EACD,AAAK,QAAQ,IAAI;GAAC;GAAgB;GAAY;EAAU,CAAC,CAAC,CAAC,QAAQ,cAAc;CAClF,CAAC;AAEH;;;;;;;;;;AAWA,SAAS,gBAAgB,YAA4B;CACpD,MAAM,SAAiB;EACtB,MAAM;EAGN,iBAAiB,WAAW;GAE3B,MAAM,UAAU,OAAO;GACvB,QAAQ,OAAO,QAAQ,QAAQ,MAAM,GAAG,CAAC;GACzC,QAAQ,QAAQ,MAAM;EACvB;EACA,iBAAiB;GAChB,OAAO;GACP,UAAU,WAAW;IACpB,OAAO,aAAa;GACrB;EACD;CACD;CACA,OAAO;AACR;;AAGA,SAAS,aAAa,MAAwD;CAC7E,IAAI,SAAS,MACZ;CAED,OAAO,OAAO,SAAS,YAAY,SAAS,KAAK,OAAO;AACzD"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { n as FrameworkBuild } from "./index-
|
|
1
|
+
import { n as FrameworkBuild } from "./index-Db7dspq6.js";
|
|
2
2
|
/**
|
|
3
3
|
* The build side of the TanStack Start adapter. `appServer` uses it when the
|
|
4
4
|
* Vite config has the TanStack Start plugin, so pass it only to override that.
|
package/dist/tanstack-start.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { a as FrameworkRuntime, h as Mode } from "./types-
|
|
2
|
-
import { t as TrailingSlash } from "./trailing-slash-
|
|
1
|
+
import { a as FrameworkRuntime, h as Mode } from "./types-j29vspx_.js";
|
|
2
|
+
import { t as TrailingSlash } from "./trailing-slash-CFSv_Gzx.js";
|
|
3
3
|
import { AnyRouter, RegisteredRouter } from "@tanstack/react-router";
|
|
4
4
|
/**
|
|
5
5
|
* The `trailingSlash` mode of a TanStack router: the app's registered router
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { _ as RequestContext, a as FrameworkRuntime } from "./types-j29vspx_.js";
|
|
2
|
+
import { t as AppServer } from "./create-server-D4-nVOVJ.js";
|
|
3
|
+
/** Options for {@link createTestServer}. */
|
|
4
|
+
export type TestServerOptions = {
|
|
5
|
+
/**
|
|
6
|
+
* The app from `createServer`. Give each test server a new app, because an
|
|
7
|
+
* app runs the `setup` of its plugins one time.
|
|
8
|
+
*/
|
|
9
|
+
app: AppServer;
|
|
10
|
+
/**
|
|
11
|
+
* The files of the client build, by their path in it, such as
|
|
12
|
+
* `providers/index.html`.
|
|
13
|
+
*/
|
|
14
|
+
files?: Readonly<Record<string, string | Uint8Array>>;
|
|
15
|
+
/**
|
|
16
|
+
* The framework's answer to a request that no stage answers.
|
|
17
|
+
* @default a 404
|
|
18
|
+
*/
|
|
19
|
+
framework?: FrameworkRuntime["fetch"];
|
|
20
|
+
};
|
|
21
|
+
/** What {@link createTestServer} gives. */
|
|
22
|
+
export type TestServer = {
|
|
23
|
+
/** Sends a request for `path`, such as `/providers?q=h100`, through the app. */
|
|
24
|
+
request: (path: string, init?: RequestInit) => Promise<Response>;
|
|
25
|
+
/**
|
|
26
|
+
* Cancels each body that the test did not read, runs each plugin's
|
|
27
|
+
* `onShutdown`, and removes the client build.
|
|
28
|
+
*/
|
|
29
|
+
close: () => Promise<void>;
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Starts an app in production mode over a client build of `files`, with no
|
|
33
|
+
* listener. It records the hashes of the inline scripts of each HTML file, as
|
|
34
|
+
* the build does, so `contentSecurityPolicy()` gives a prerendered page its
|
|
35
|
+
* CSP. `requestContext()` and `cspNonce()` work in the framework's answer.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* const server = await createTestServer({
|
|
39
|
+
* app: createServer({ plugins: defaultPlugins() }),
|
|
40
|
+
* files: { "providers/index.html": "<!doctype html><script>go()</script>" },
|
|
41
|
+
* framework: async () => new Response("rendered"),
|
|
42
|
+
* });
|
|
43
|
+
* const response = await server.request("/providers");
|
|
44
|
+
* await server.close();
|
|
45
|
+
*/
|
|
46
|
+
export declare function createTestServer({ app, files, framework }: TestServerOptions): Promise<TestServer>;
|
|
47
|
+
/**
|
|
48
|
+
* Runs `work` as if in a server request, so `requestContext()` and
|
|
49
|
+
* `cspNonce()` give `values`. Use it to test a render. With no `logger`, the
|
|
50
|
+
* log lines go nowhere.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* const html = await withRequestContext({ cspNonce: "test-nonce" }, () => renderToString(<App />));
|
|
54
|
+
*/
|
|
55
|
+
export declare function withRequestContext<Result>(values: Partial<RequestContext>, work: () => Result | Promise<Result>): Promise<Result>;
|
|
56
|
+
//# sourceMappingURL=testing.d.ts.map
|
package/dist/testing.js
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { r as withRequestContext$1 } from "./request-context-BtQ87VYb.js";
|
|
2
|
+
import { i as requestLogger } from "./log-BP6xXXZl.js";
|
|
3
|
+
import { t as BUILD_MANIFEST_FILE } from "./build-manifest-DBMWe3Lx.js";
|
|
4
|
+
import { t as createEntry } from "./entry-D9H4LA9c.js";
|
|
5
|
+
import { t as host } from "./node-C1qudLs_.js";
|
|
6
|
+
import { n as scriptHashesOf } from "./script-hashes-C6hQ5XnP.js";
|
|
7
|
+
import { Context } from "hono";
|
|
8
|
+
import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
|
|
9
|
+
import { dirname, isAbsolute, join, normalize, sep } from "node:path";
|
|
10
|
+
import { tmpdir } from "node:os";
|
|
11
|
+
|
|
12
|
+
// src/testing/index.ts
|
|
13
|
+
/** Why: an app runs the `setup` of its plugins one time, so a second test server would get the files of the first. */
|
|
14
|
+
const usedApps = /* @__PURE__ */ new WeakSet();
|
|
15
|
+
async function notFound() {
|
|
16
|
+
return new Response("Not Found", { status: 404 });
|
|
17
|
+
}
|
|
18
|
+
/** Writes `files` and the build manifest into `clientDirectory`, and gives the app's entry over them. */
|
|
19
|
+
async function startEntry(clientDirectory, { app, files, framework }) {
|
|
20
|
+
for (const [path, content] of Object.entries(files)) {
|
|
21
|
+
const file = join(clientDirectory, path);
|
|
22
|
+
await mkdir(dirname(file), { recursive: true });
|
|
23
|
+
await writeFile(file, content);
|
|
24
|
+
}
|
|
25
|
+
const manifest = {
|
|
26
|
+
prerendered: [],
|
|
27
|
+
headers: {},
|
|
28
|
+
scriptHashes: scriptHashesOf(clientDirectory)
|
|
29
|
+
};
|
|
30
|
+
await writeFile(join(clientDirectory, BUILD_MANIFEST_FILE), JSON.stringify(manifest));
|
|
31
|
+
return createEntry({
|
|
32
|
+
app,
|
|
33
|
+
host,
|
|
34
|
+
clientDirectory,
|
|
35
|
+
framework: () => ({
|
|
36
|
+
name: "test",
|
|
37
|
+
fetch: framework
|
|
38
|
+
})
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Starts an app in production mode over a client build of `files`, with no
|
|
43
|
+
* listener. It records the hashes of the inline scripts of each HTML file, as
|
|
44
|
+
* the build does, so `contentSecurityPolicy()` gives a prerendered page its
|
|
45
|
+
* CSP. `requestContext()` and `cspNonce()` work in the framework's answer.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* const server = await createTestServer({
|
|
49
|
+
* app: createServer({ plugins: defaultPlugins() }),
|
|
50
|
+
* files: { "providers/index.html": "<!doctype html><script>go()<\/script>" },
|
|
51
|
+
* framework: async () => new Response("rendered"),
|
|
52
|
+
* });
|
|
53
|
+
* const response = await server.request("/providers");
|
|
54
|
+
* await server.close();
|
|
55
|
+
*/
|
|
56
|
+
async function createTestServer({ app, files = {}, framework = notFound }) {
|
|
57
|
+
if (usedApps.has(app)) throw new Error("This app runs in another test server. Give each test server a new app from `createServer()`.");
|
|
58
|
+
for (const path of Object.keys(files)) if (isAbsolute(path) || normalize(path).split(sep)[0] === "..") throw new Error(`The file "${path}" is outside the client build. Give a relative path in it.`);
|
|
59
|
+
usedApps.add(app);
|
|
60
|
+
const clientDirectory = await mkdtemp(join(tmpdir(), "app-server-test-"));
|
|
61
|
+
let entry;
|
|
62
|
+
try {
|
|
63
|
+
entry = await startEntry(clientDirectory, {
|
|
64
|
+
app,
|
|
65
|
+
files,
|
|
66
|
+
framework
|
|
67
|
+
});
|
|
68
|
+
} catch (error) {
|
|
69
|
+
usedApps.delete(app);
|
|
70
|
+
await rm(clientDirectory, {
|
|
71
|
+
recursive: true,
|
|
72
|
+
force: true
|
|
73
|
+
});
|
|
74
|
+
throw error;
|
|
75
|
+
}
|
|
76
|
+
const responses = [];
|
|
77
|
+
return {
|
|
78
|
+
request: async (path, init) => {
|
|
79
|
+
const response = await entry.fetch(new Request(new URL(path, "http://localhost"), init));
|
|
80
|
+
responses.push(response);
|
|
81
|
+
return response;
|
|
82
|
+
},
|
|
83
|
+
close: async () => {
|
|
84
|
+
await Promise.allSettled(responses.map(async ({ body }) => body?.locked === false ? body.cancel() : void 0));
|
|
85
|
+
try {
|
|
86
|
+
await entry.stopPlugins();
|
|
87
|
+
} finally {
|
|
88
|
+
await rm(clientDirectory, {
|
|
89
|
+
recursive: true,
|
|
90
|
+
force: true
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Runs `work` as if in a server request, so `requestContext()` and
|
|
98
|
+
* `cspNonce()` give `values`. Use it to test a render. With no `logger`, the
|
|
99
|
+
* log lines go nowhere.
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* const html = await withRequestContext({ cspNonce: "test-nonce" }, () => renderToString(<App />));
|
|
103
|
+
*/
|
|
104
|
+
async function withRequestContext(values, work) {
|
|
105
|
+
const context = new Context(new Request("http://localhost/"));
|
|
106
|
+
context.set("logger", values.logger ?? requestLogger({ log: () => {} }, context));
|
|
107
|
+
if (values.requestId != null) context.set("requestId", values.requestId);
|
|
108
|
+
if (values.cspNonce != null) context.set("cspNonce", values.cspNonce);
|
|
109
|
+
context.set("clientAddress", values.clientAddress);
|
|
110
|
+
return withRequestContext$1(host.storage, context, async () => work());
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
export { createTestServer, withRequestContext };
|
|
114
|
+
//# sourceMappingURL=testing.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testing.js","names":["runInRequestContext"],"sources":["../src/testing/index.ts"],"sourcesContent":["import { mkdir, mkdtemp, rm, writeFile } from \"node:fs/promises\";\nimport { tmpdir } from \"node:os\";\nimport { dirname, isAbsolute, join, normalize, sep } from \"node:path\";\nimport { Context } from \"hono\";\nimport { BUILD_MANIFEST_FILE } from \"../core/build-manifest.js\";\nimport type { BuildManifest } from \"../core/build-manifest.js\";\nimport type { AppServer } from \"../core/create-server.js\";\nimport { createEntry } from \"../core/entry.js\";\nimport type { AppServerEntry } from \"../core/entry.js\";\nimport { requestLogger } from \"../core/log.js\";\nimport { withRequestContext as runInRequestContext } from \"../core/request-context.js\";\nimport type { AppServerEnv, FrameworkRuntime, RequestContext } from \"../core/types.js\";\nimport { host } from \"../node/index.js\";\nimport { scriptHashesOf } from \"../node/script-hashes.js\";\n\n/** Options for {@link createTestServer}. */\nexport type TestServerOptions = {\n\t/**\n\t * The app from `createServer`. Give each test server a new app, because an\n\t * app runs the `setup` of its plugins one time.\n\t */\n\tapp: AppServer;\n\t/**\n\t * The files of the client build, by their path in it, such as\n\t * `providers/index.html`.\n\t */\n\tfiles?: Readonly<Record<string, string | Uint8Array>>;\n\t/**\n\t * The framework's answer to a request that no stage answers.\n\t * @default a 404\n\t */\n\tframework?: FrameworkRuntime[\"fetch\"];\n};\n\n/** What {@link createTestServer} gives. */\nexport type TestServer = {\n\t/** Sends a request for `path`, such as `/providers?q=h100`, through the app. */\n\trequest: (path: string, init?: RequestInit) => Promise<Response>;\n\t/**\n\t * Cancels each body that the test did not read, runs each plugin's\n\t * `onShutdown`, and removes the client build.\n\t */\n\tclose: () => Promise<void>;\n};\n\n/** Why: an app runs the `setup` of its plugins one time, so a second test server would get the files of the first. */\nconst usedApps = new WeakSet<AppServer>();\n\nasync function notFound(): Promise<Response> {\n\treturn new Response(\"Not Found\", { status: 404 });\n}\n\n/** Writes `files` and the build manifest into `clientDirectory`, and gives the app's entry over them. */\nasync function startEntry(\n\tclientDirectory: string,\n\t{ app, files, framework }: Required<TestServerOptions>,\n): Promise<AppServerEntry> {\n\tfor (const [path, content] of Object.entries(files)) {\n\t\tconst file = join(clientDirectory, path);\n\t\tawait mkdir(dirname(file), { recursive: true });\n\t\tawait writeFile(file, content);\n\t}\n\tconst manifest: BuildManifest = {\n\t\tprerendered: [],\n\t\theaders: {},\n\t\tscriptHashes: scriptHashesOf(clientDirectory),\n\t};\n\tawait writeFile(join(clientDirectory, BUILD_MANIFEST_FILE), JSON.stringify(manifest));\n\treturn createEntry({\n\t\tapp,\n\t\thost,\n\t\tclientDirectory,\n\t\tframework: () => ({ name: \"test\", fetch: framework }),\n\t});\n}\n\n/**\n * Starts an app in production mode over a client build of `files`, with no\n * listener. It records the hashes of the inline scripts of each HTML file, as\n * the build does, so `contentSecurityPolicy()` gives a prerendered page its\n * CSP. `requestContext()` and `cspNonce()` work in the framework's answer.\n *\n * @example\n * const server = await createTestServer({\n * \tapp: createServer({ plugins: defaultPlugins() }),\n * \tfiles: { \"providers/index.html\": \"<!doctype html><script>go()</script>\" },\n * \tframework: async () => new Response(\"rendered\"),\n * });\n * const response = await server.request(\"/providers\");\n * await server.close();\n */\nexport async function createTestServer({\n\tapp,\n\tfiles = {},\n\tframework = notFound,\n}: TestServerOptions): Promise<TestServer> {\n\tif (usedApps.has(app)) {\n\t\tthrow new Error(\n\t\t\t\"This app runs in another test server. Give each test server a new app from `createServer()`.\",\n\t\t);\n\t}\n\tfor (const path of Object.keys(files)) {\n\t\tif (isAbsolute(path) || normalize(path).split(sep)[0] === \"..\") {\n\t\t\tthrow new Error(\n\t\t\t\t`The file \"${path}\" is outside the client build. Give a relative path in it.`,\n\t\t\t);\n\t\t}\n\t}\n\tusedApps.add(app);\n\tconst clientDirectory = await mkdtemp(join(tmpdir(), \"app-server-test-\"));\n\tlet entry: AppServerEntry;\n\ttry {\n\t\tentry = await startEntry(clientDirectory, { app, files, framework });\n\t} catch (error) {\n\t\tusedApps.delete(app);\n\t\tawait rm(clientDirectory, { recursive: true, force: true });\n\t\tthrow error;\n\t}\n\tconst responses: Response[] = [];\n\treturn {\n\t\trequest: async (path, init) => {\n\t\t\tconst response = await entry.fetch(new Request(new URL(path, \"http://localhost\"), init));\n\t\t\tresponses.push(response);\n\t\t\treturn response;\n\t\t},\n\t\tclose: async () => {\n\t\t\t// Why cancel an unread body: it can hold an open file, and Node.js 26 throws when garbage\n\t\t\t// collection closes a `FileHandle`. Why `allSettled`: the cancel of a body that failed\n\t\t\t// rejects, and the test sees that error when it reads the body.\n\t\t\tawait Promise.allSettled(\n\t\t\t\tresponses.map(async ({ body }) => (body?.locked === false ? body.cancel() : undefined)),\n\t\t\t);\n\t\t\ttry {\n\t\t\t\tawait entry.stopPlugins();\n\t\t\t} finally {\n\t\t\t\tawait rm(clientDirectory, { recursive: true, force: true });\n\t\t\t}\n\t\t},\n\t};\n}\n\n/**\n * Runs `work` as if in a server request, so `requestContext()` and\n * `cspNonce()` give `values`. Use it to test a render. With no `logger`, the\n * log lines go nowhere.\n *\n * @example\n * const html = await withRequestContext({ cspNonce: \"test-nonce\" }, () => renderToString(<App />));\n */\nexport async function withRequestContext<Result>(\n\tvalues: Partial<RequestContext>,\n\twork: () => Result | Promise<Result>,\n): Promise<Result> {\n\tconst context = new Context<AppServerEnv>(new Request(\"http://localhost/\"));\n\tcontext.set(\"logger\", values.logger ?? requestLogger({ log: () => {} }, context));\n\tif (values.requestId != null) {\n\t\tcontext.set(\"requestId\", values.requestId);\n\t}\n\tif (values.cspNonce != null) {\n\t\tcontext.set(\"cspNonce\", values.cspNonce);\n\t}\n\tcontext.set(\"clientAddress\", values.clientAddress);\n\treturn runInRequestContext(host.storage, context, async () => work());\n}\n"],"mappings":";;;;;;;;;;;;;AA8CA,MAAM,2BAAW,IAAI,QAAmB;AAExC,eAAe,WAA8B;CAC5C,OAAO,IAAI,SAAS,aAAa,EAAE,QAAQ,IAAI,CAAC;AACjD;;AAGA,eAAe,WACd,iBACA,EAAE,KAAK,OAAO,aACY;CAC1B,KAAK,MAAM,CAAC,MAAM,YAAY,OAAO,QAAQ,KAAK,GAAG;EACpD,MAAM,OAAO,KAAK,iBAAiB,IAAI;EACvC,MAAM,MAAM,QAAQ,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;EAC9C,MAAM,UAAU,MAAM,OAAO;CAC9B;CACA,MAAM,WAA0B;EAC/B,aAAa,CAAC;EACd,SAAS,CAAC;EACV,cAAc,eAAe,eAAe;CAC7C;CACA,MAAM,UAAU,KAAK,iBAAiB,mBAAmB,GAAG,KAAK,UAAU,QAAQ,CAAC;CACpF,OAAO,YAAY;EAClB;EACA;EACA;EACA,kBAAkB;GAAE,MAAM;GAAQ,OAAO;EAAU;CACpD,CAAC;AACF;;;;;;;;;;;;;;;;AAiBA,eAAsB,iBAAiB,EACtC,KACA,QAAQ,CAAC,GACT,YAAY,YAC8B;CAC1C,IAAI,SAAS,IAAI,GAAG,GACnB,MAAM,IAAI,MACT,8FACD;CAED,KAAK,MAAM,QAAQ,OAAO,KAAK,KAAK,GACnC,IAAI,WAAW,IAAI,KAAK,UAAU,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,OAAO,MACzD,MAAM,IAAI,MACT,aAAa,KAAK,2DACnB;CAGF,SAAS,IAAI,GAAG;CAChB,MAAM,kBAAkB,MAAM,QAAQ,KAAK,OAAO,GAAG,kBAAkB,CAAC;CACxE,IAAI;CACJ,IAAI;EACH,QAAQ,MAAM,WAAW,iBAAiB;GAAE;GAAK;GAAO;EAAU,CAAC;CACpE,SAAS,OAAO;EACf,SAAS,OAAO,GAAG;EACnB,MAAM,GAAG,iBAAiB;GAAE,WAAW;GAAM,OAAO;EAAK,CAAC;EAC1D,MAAM;CACP;CACA,MAAM,YAAwB,CAAC;CAC/B,OAAO;EACN,SAAS,OAAO,MAAM,SAAS;GAC9B,MAAM,WAAW,MAAM,MAAM,MAAM,IAAI,QAAQ,IAAI,IAAI,MAAM,kBAAkB,GAAG,IAAI,CAAC;GACvF,UAAU,KAAK,QAAQ;GACvB,OAAO;EACR;EACA,OAAO,YAAY;GAIlB,MAAM,QAAQ,WACb,UAAU,IAAI,OAAO,EAAE,WAAY,MAAM,WAAW,QAAQ,KAAK,OAAO,IAAI,MAAU,CACvF;GACA,IAAI;IACH,MAAM,MAAM,YAAY;GACzB,UAAU;IACT,MAAM,GAAG,iBAAiB;KAAE,WAAW;KAAM,OAAO;IAAK,CAAC;GAC3D;EACD;CACD;AACD;;;;;;;;;AAUA,eAAsB,mBACrB,QACA,MACkB;CAClB,MAAM,UAAU,IAAI,QAAsB,IAAI,QAAQ,mBAAmB,CAAC;CAC1E,QAAQ,IAAI,UAAU,OAAO,UAAU,cAAc,EAAE,WAAW,CAAC,EAAE,GAAG,OAAO,CAAC;CAChF,IAAI,OAAO,aAAa,MACvB,QAAQ,IAAI,aAAa,OAAO,SAAS;CAE1C,IAAI,OAAO,YAAY,MACtB,QAAQ,IAAI,YAAY,OAAO,QAAQ;CAExC,QAAQ,IAAI,iBAAiB,OAAO,aAAa;CACjD,OAAOA,qBAAoB,KAAK,SAAS,SAAS,YAAY,KAAK,CAAC;AACrE"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { g as Plugin } from "./types-
|
|
1
|
+
import { g as Plugin } from "./types-j29vspx_.js";
|
|
2
2
|
/**
|
|
3
3
|
* How a page URL ends:
|
|
4
4
|
*
|
|
@@ -33,4 +33,4 @@ type TrailingSlashOptions = {
|
|
|
33
33
|
*/
|
|
34
34
|
declare function trailingSlash({ mode }: TrailingSlashOptions): Plugin;
|
|
35
35
|
export { TrailingSlashOptions as n, trailingSlash as r, TrailingSlash as t };
|
|
36
|
-
//# sourceMappingURL=trailing-slash-
|
|
36
|
+
//# sourceMappingURL=trailing-slash-CFSv_Gzx.d.ts.map
|
|
@@ -217,6 +217,12 @@ type ListenerBindings = {
|
|
|
217
217
|
/** The Hono bindings of an app server: the listener's values and the framework. */
|
|
218
218
|
type ServerBindings = ListenerBindings & {
|
|
219
219
|
framework: FrameworkRuntime;
|
|
220
|
+
/**
|
|
221
|
+
* Gets the URL path of the client build's file that `prerendered()` sends,
|
|
222
|
+
* such as `/about/index.html`. Only the build's check of the CDN pages
|
|
223
|
+
* gives it. Why a binding: each other request then pays one property read.
|
|
224
|
+
*/
|
|
225
|
+
onServedFile?: (path: string) => void;
|
|
220
226
|
};
|
|
221
227
|
/** The Hono environment of an app server. */
|
|
222
228
|
type AppServerEnv = {
|
|
@@ -238,6 +244,12 @@ type AppServerEnv = {
|
|
|
238
244
|
* dev server stage sets it, for a 304 too.
|
|
239
245
|
*/
|
|
240
246
|
documentScriptHashes?: readonly string[];
|
|
247
|
+
/**
|
|
248
|
+
* The route pattern that the framework matched, such as
|
|
249
|
+
* `/domains/:domainId`. The framework adapter sets it, and the access log
|
|
250
|
+
* writes it as `http.route`.
|
|
251
|
+
*/
|
|
252
|
+
routePattern?: string;
|
|
241
253
|
/** The client's IP address. See `trustedProxyHops` on `createServer`. */
|
|
242
254
|
clientAddress?: string | undefined;
|
|
243
255
|
/** Attributes that each log line of the request carries, such as the trace IDs from the `requestId` plugin. */
|
|
@@ -285,7 +297,7 @@ type ResponseHeaders = {
|
|
|
285
297
|
*/
|
|
286
298
|
type HeaderHook = (headers: ResponseHeaders) => undefined;
|
|
287
299
|
/** The request handler that a listener calls. */
|
|
288
|
-
type FetchHandler = (request: Request, bindings
|
|
300
|
+
type FetchHandler = (request: Request, bindings?: ListenerBindings) => Response | Promise<Response>;
|
|
289
301
|
/** What a plugin learns at startup, before the first request. */
|
|
290
302
|
type SetupInfo = {
|
|
291
303
|
/** The files of the client build. */
|
|
@@ -313,6 +325,8 @@ type SetupInfo = {
|
|
|
313
325
|
mode: "production";
|
|
314
326
|
/** The URL paths that the build prerendered. */
|
|
315
327
|
prerenderedPaths: readonly string[];
|
|
328
|
+
/** The URL path of the hashed files of the client build, such as `/assets/`. */
|
|
329
|
+
assetsPath: string;
|
|
316
330
|
} | {
|
|
317
331
|
mode: "development";
|
|
318
332
|
/** The dev server as a pipeline stage. It serves source modules, HMR, and CSS. */
|
|
@@ -389,4 +403,4 @@ type ListenerStartOptions = {
|
|
|
389
403
|
trustForwardedProto?: boolean;
|
|
390
404
|
};
|
|
391
405
|
export { SetupInfo as C, ResponseEdge as E, ServerBindings as S, StaticFiles as T, RequestContext as _, FrameworkRuntime as a, ResponseHeaders as b, HostRuntime as c, ListenerBindings as d, ListenerStartOptions as f, Plugin as g, Mode as h, FileInfo as i, Lifecycle as l, LogSink as m, ByteRange as n, FrameworkRuntimeFactory as o, LogLevel as p, FetchHandler as r, HeaderHook as s, AppServerEnv as t, Listener as u, RequestLogger as v, StartedListener as w, SentResponse as x, RequestStore as y };
|
|
392
|
-
//# sourceMappingURL=types-
|
|
406
|
+
//# sourceMappingURL=types-j29vspx_.d.ts.map
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/** A prerendered path that the CDN serves, as `vercel()` writes it. */
|
|
2
|
+
export type CdnPageReport = {
|
|
3
|
+
path: string;
|
|
4
|
+
/**
|
|
5
|
+
* The URL path of the page's body under the static directory, such as
|
|
6
|
+
* `/0/index.html`. Why not the page's file: two paths can have one file,
|
|
7
|
+
* such as with `prerendered({ rewrite })`, and different bodies.
|
|
8
|
+
*/
|
|
9
|
+
file: string;
|
|
10
|
+
answers: {
|
|
11
|
+
present: readonly string[];
|
|
12
|
+
headers: Readonly<Record<string, string>>;
|
|
13
|
+
}[];
|
|
14
|
+
twin?: string;
|
|
15
|
+
};
|
|
16
|
+
/** What the step found: the paths that the CDN serves, and why the function serves each other path. */
|
|
17
|
+
export type PagesReport = {
|
|
18
|
+
cdn: CdnPageReport[];
|
|
19
|
+
server: {
|
|
20
|
+
path: string;
|
|
21
|
+
reason: string;
|
|
22
|
+
}[];
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Writes the body of each page that the CDN can serve to `staticDirectory`,
|
|
26
|
+
* at the path of its file, and the {@link PagesReport} to `reportFile`.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* await writePages("build/server/app-server.js", ".vercel/output/static/_app-server/pages", "pages.json");
|
|
30
|
+
*/
|
|
31
|
+
export declare function writePages(entryFile: string, staticDirectory: string, reportFile: string): Promise<void>;
|
|
32
|
+
//# sourceMappingURL=vercel-pages.d.ts.map
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { mkdirSync, writeFileSync } from "node:fs";
|
|
2
|
+
import { basename, dirname, join } from "node:path";
|
|
3
|
+
import { pathToFileURL } from "node:url";
|
|
4
|
+
|
|
5
|
+
// src/vercel/pages.ts
|
|
6
|
+
function isEntry(value) {
|
|
7
|
+
return typeof value === "object" && value != null && "staticPages" in value && typeof value.staticPages === "function" && "stopPlugins" in value && typeof value.stopPlugins === "function";
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Writes the body of each page that the CDN can serve to `staticDirectory`,
|
|
11
|
+
* at the path of its file, and the {@link PagesReport} to `reportFile`.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* await writePages("build/server/app-server.js", ".vercel/output/static/_app-server/pages", "pages.json");
|
|
15
|
+
*/
|
|
16
|
+
async function writePages(entryFile, staticDirectory, reportFile) {
|
|
17
|
+
const module = await import(pathToFileURL(entryFile).href);
|
|
18
|
+
const entry = typeof module === "object" && module != null && "appServer" in module ? module.appServer : void 0;
|
|
19
|
+
if (!isEntry(entry)) throw new Error(`${entryFile} exports no appServer of this version of @ngrok/app-server.`);
|
|
20
|
+
const report = {
|
|
21
|
+
cdn: [],
|
|
22
|
+
server: []
|
|
23
|
+
};
|
|
24
|
+
try {
|
|
25
|
+
for await (const page of entry.staticPages()) if ("cdn" in page) {
|
|
26
|
+
const { body, answers, twin } = page.cdn;
|
|
27
|
+
const file = `/${report.cdn.length}/${basename(page.cdn.file)}`;
|
|
28
|
+
const target = join(staticDirectory, file);
|
|
29
|
+
mkdirSync(dirname(target), { recursive: true });
|
|
30
|
+
writeFileSync(target, body);
|
|
31
|
+
report.cdn.push({
|
|
32
|
+
path: page.path,
|
|
33
|
+
file,
|
|
34
|
+
answers,
|
|
35
|
+
...twin == null ? {} : { twin }
|
|
36
|
+
});
|
|
37
|
+
} else report.server.push({
|
|
38
|
+
path: page.path,
|
|
39
|
+
reason: page.reason
|
|
40
|
+
});
|
|
41
|
+
} finally {
|
|
42
|
+
await entry.stopPlugins();
|
|
43
|
+
}
|
|
44
|
+
mkdirSync(dirname(reportFile), { recursive: true });
|
|
45
|
+
writeFileSync(reportFile, JSON.stringify(report));
|
|
46
|
+
}
|
|
47
|
+
if (import.meta.main) {
|
|
48
|
+
const [entryFile = "", staticDirectory = "", reportFile = ""] = process.argv.slice(2);
|
|
49
|
+
await writePages(entryFile, staticDirectory, reportFile);
|
|
50
|
+
process.exit(0);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export { writePages };
|
|
54
|
+
//# sourceMappingURL=vercel-pages.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"vercel-pages.js","names":[],"sources":["../src/vercel/pages.ts"],"sourcesContent":["// The step of `vercel()` that finds the prerendered pages that Vercel's content delivery network\n// (CDN) can serve with no function. `vercel()` runs it in a child process after the build:\n//\n// node vercel-pages.js <server entry> <static directory> <report file>\n//\n// Why a child process: the step starts the built server, and the build output must stay sync. A\n// plugin's `setup` can also leave a socket or a timer, so the process exits when the step ends.\n// Why no relative import: the build runs this file from `src` in the tests of this package.\nimport { mkdirSync, writeFileSync } from \"node:fs\";\nimport { basename, dirname, join } from \"node:path\";\nimport { pathToFileURL } from \"node:url\";\n\n/** A prerendered path that the CDN serves, as `vercel()` writes it. */\nexport type CdnPageReport = {\n\tpath: string;\n\t/**\n\t * The URL path of the page's body under the static directory, such as\n\t * `/0/index.html`. Why not the page's file: two paths can have one file,\n\t * such as with `prerendered({ rewrite })`, and different bodies.\n\t */\n\tfile: string;\n\tanswers: { present: readonly string[]; headers: Readonly<Record<string, string>> }[];\n\ttwin?: string;\n};\n\n/** What the step found: the paths that the CDN serves, and why the function serves each other path. */\nexport type PagesReport = {\n\tcdn: CdnPageReport[];\n\tserver: { path: string; reason: string }[];\n};\n\n/** The part of the server entry that this step calls. */\ntype Entry = {\n\tstaticPages: () => AsyncIterable<\n\t\t{ path: string } & (\n\t\t\t| {\n\t\t\t\t\tcdn: { file: string; body: Uint8Array; answers: CdnPageReport[\"answers\"]; twin?: string };\n\t\t\t }\n\t\t\t| { reason: string }\n\t\t)\n\t>;\n\tstopPlugins: () => Promise<void>;\n};\n\nfunction isEntry(value: unknown): value is Entry {\n\treturn (\n\t\ttypeof value === \"object\" &&\n\t\tvalue != null &&\n\t\t\"staticPages\" in value &&\n\t\ttypeof value.staticPages === \"function\" &&\n\t\t\"stopPlugins\" in value &&\n\t\ttypeof value.stopPlugins === \"function\"\n\t);\n}\n\n/**\n * Writes the body of each page that the CDN can serve to `staticDirectory`,\n * at the path of its file, and the {@link PagesReport} to `reportFile`.\n *\n * @example\n * await writePages(\"build/server/app-server.js\", \".vercel/output/static/_app-server/pages\", \"pages.json\");\n */\nexport async function writePages(\n\tentryFile: string,\n\tstaticDirectory: string,\n\treportFile: string,\n): Promise<void> {\n\tconst module: unknown = await import(pathToFileURL(entryFile).href);\n\tconst entry =\n\t\ttypeof module === \"object\" && module != null && \"appServer\" in module\n\t\t\t? module.appServer\n\t\t\t: undefined;\n\tif (!isEntry(entry)) {\n\t\tthrow new Error(`${entryFile} exports no appServer of this version of @ngrok/app-server.`);\n\t}\n\tconst report: PagesReport = { cdn: [], server: [] };\n\ttry {\n\t\tfor await (const page of entry.staticPages()) {\n\t\t\tif (\"cdn\" in page) {\n\t\t\t\tconst { body, answers, twin } = page.cdn;\n\t\t\t\tconst file = `/${report.cdn.length}/${basename(page.cdn.file)}`;\n\t\t\t\tconst target = join(staticDirectory, file);\n\t\t\t\tmkdirSync(dirname(target), { recursive: true });\n\t\t\t\twriteFileSync(target, body);\n\t\t\t\treport.cdn.push({ path: page.path, file, answers, ...(twin == null ? {} : { twin }) });\n\t\t\t} else {\n\t\t\t\treport.server.push({ path: page.path, reason: page.reason });\n\t\t\t}\n\t\t}\n\t} finally {\n\t\tawait entry.stopPlugins();\n\t}\n\tmkdirSync(dirname(reportFile), { recursive: true });\n\twriteFileSync(reportFile, JSON.stringify(report));\n}\n\nif (import.meta.main) {\n\tconst [entryFile = \"\", staticDirectory = \"\", reportFile = \"\"] = process.argv.slice(2);\n\tawait writePages(entryFile, staticDirectory, reportFile);\n\t// oxlint-disable-next-line unicorn/no-process-exit -- a plugin's `setup` can leave a socket or a timer that keeps the process alive.\n\tprocess.exit(0);\n}\n"],"mappings":";;;;;AA4CA,SAAS,QAAQ,OAAgC;CAChD,OACC,OAAO,UAAU,YACjB,SAAS,QACT,iBAAiB,SACjB,OAAO,MAAM,gBAAgB,cAC7B,iBAAiB,SACjB,OAAO,MAAM,gBAAgB;AAE/B;;;;;;;;AASA,eAAsB,WACrB,WACA,iBACA,YACgB;CAChB,MAAM,SAAkB,MAAM,OAAO,cAAc,SAAS,CAAC,CAAC;CAC9D,MAAM,QACL,OAAO,WAAW,YAAY,UAAU,QAAQ,eAAe,SAC5D,OAAO,YACP;CACJ,IAAI,CAAC,QAAQ,KAAK,GACjB,MAAM,IAAI,MAAM,GAAG,UAAU,4DAA4D;CAE1F,MAAM,SAAsB;EAAE,KAAK,CAAC;EAAG,QAAQ,CAAC;CAAE;CAClD,IAAI;EACH,WAAW,MAAM,QAAQ,MAAM,YAAY,GAC1C,IAAI,SAAS,MAAM;GAClB,MAAM,EAAE,MAAM,SAAS,SAAS,KAAK;GACrC,MAAM,OAAO,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,KAAK,IAAI,IAAI;GAC5D,MAAM,SAAS,KAAK,iBAAiB,IAAI;GACzC,UAAU,QAAQ,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;GAC9C,cAAc,QAAQ,IAAI;GAC1B,OAAO,IAAI,KAAK;IAAE,MAAM,KAAK;IAAM;IAAM;IAAS,GAAI,QAAQ,OAAO,CAAC,IAAI,EAAE,KAAK;GAAG,CAAC;EACtF,OACC,OAAO,OAAO,KAAK;GAAE,MAAM,KAAK;GAAM,QAAQ,KAAK;EAAO,CAAC;CAG9D,UAAU;EACT,MAAM,MAAM,YAAY;CACzB;CACA,UAAU,QAAQ,UAAU,GAAG,EAAE,WAAW,KAAK,CAAC;CAClD,cAAc,YAAY,KAAK,UAAU,MAAM,CAAC;AACjD;AAEA,IAAI,YAAY,MAAM;CACrB,MAAM,CAAC,YAAY,IAAI,kBAAkB,IAAI,aAAa,MAAM,QAAQ,KAAK,MAAM,CAAC;CACpF,MAAM,WAAW,WAAW,iBAAiB,UAAU;CAEvD,QAAQ,KAAK,CAAC;AACf"}
|
package/dist/vercel-vite.d.ts
CHANGED
|
@@ -1,29 +1,50 @@
|
|
|
1
|
-
import { r as HostBuild } from "./index-
|
|
1
|
+
import { r as HostBuild } from "./index-Db7dspq6.js";
|
|
2
2
|
/** Options for {@link vercel}. */
|
|
3
3
|
export type VercelOptions = {
|
|
4
4
|
/**
|
|
5
5
|
* More URL path prefixes of the client build that Vercel's CDN serves,
|
|
6
|
-
* such as `["/blog-assets/"]`. Each starts and ends with `/`.
|
|
7
|
-
*
|
|
8
|
-
* carry them.
|
|
6
|
+
* such as `["/blog-assets/"]`. Each starts and ends with `/`. The URL path
|
|
7
|
+
* of Vite's `build.assetsDir`, `/assets/` by default, is always one. Their
|
|
8
|
+
* files skip the pipeline, and the function does not carry them.
|
|
9
9
|
*/
|
|
10
10
|
cdnPaths?: readonly string[];
|
|
11
|
-
/** Headers for each file
|
|
11
|
+
/** Headers for each file under `cdnPaths` and Vite's `build.assetsDir`, such as CORS headers. */
|
|
12
12
|
cdnHeaders?: Readonly<Record<string, string>>;
|
|
13
|
+
/**
|
|
14
|
+
* Which prerendered pages the CDN serves, with no function. With `true`,
|
|
15
|
+
* `vercel()` starts the server build once after the build and sends each
|
|
16
|
+
* prerendered path through the pipeline as an anonymous client. The CDN
|
|
17
|
+
* serves a page when its answer is a public 200 from its file, and the
|
|
18
|
+
* same for a second client with another host, address, query, cookie,
|
|
19
|
+
* `Authorization`, language, and country. The CDN then sends the
|
|
20
|
+
* pipeline's body and headers. The function serves each other page, and
|
|
21
|
+
* the CDN never keeps its answer. A function keeps each path that it
|
|
22
|
+
* refuses in either trailing-slash form in the function, such as a page
|
|
23
|
+
* whose answer depends on one query key. Why off by default: the build
|
|
24
|
+
* runs each plugin's `setup`, and a check that the build cannot see can
|
|
25
|
+
* then reach the CDN.
|
|
26
|
+
* @default false
|
|
27
|
+
*/
|
|
28
|
+
cdnPages?: boolean | ((path: string) => boolean);
|
|
13
29
|
/** The Vercel regions of the function, such as `["iad1"]`. @default the project's */
|
|
14
30
|
regions?: readonly string[];
|
|
15
31
|
/** The memory of the function, in MB. @default the project's */
|
|
16
32
|
memory?: number;
|
|
17
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* The longest time that a request runs, in seconds. It applies to each
|
|
35
|
+
* request, because one function serves each route. A route module's
|
|
36
|
+
* `config` export does nothing. @default the project's
|
|
37
|
+
*/
|
|
18
38
|
maxDuration?: number;
|
|
19
39
|
};
|
|
20
40
|
/**
|
|
21
41
|
* The build side of the vercel host. After the build, it writes
|
|
22
42
|
* `.vercel/output` in the Vite root, for `vercel deploy --prebuilt`:
|
|
23
43
|
*
|
|
24
|
-
* - `static/`: the files
|
|
25
|
-
* serves them, and each file
|
|
26
|
-
* cache.
|
|
44
|
+
* - `static/`: the files of Vite's `build.assetsDir` (`/assets/` by default)
|
|
45
|
+
* and the other `cdnPaths`. The CDN serves them, and each file of
|
|
46
|
+
* `build.assetsDir` gets a one-year immutable cache. It also holds the
|
|
47
|
+
* prerendered pages that the CDN serves, with `cdnPages`.
|
|
27
48
|
* - `functions/index.func/`: one Node.js function that runs the pipeline for
|
|
28
49
|
* each other request, with the whole server build and the rest of the
|
|
29
50
|
* client build.
|