Repository navigation
perf(web): load sign-in and email code only when a developer API request needs it #4229
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
046ff76
perf(web): load sign-in and email code only when a request needs it
d20b20c
test(web): keep sign-in and email code out of the developer API start…
4001d57
chore(web): declare esbuild for the developer API cold path test
ddba7b3
Merge remote-tracking branch 'origin/main' into perf/infra-api-cold-path
510eaa4
Merge remote-tracking branch 'origin/main' into perf/infra-api-cold-path
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import { fileURLToPath } from "node:url"; | ||
| import { build, type Metafile } from "esbuild"; | ||
| import { describe, expect, it } from "vitest"; | ||
|
|
||
| // A cold start of a developer API function evaluates every module the route | ||
| // imports statically. Sign-in (next-auth, SSO) and email rendering are only | ||
| // needed by cookie-authenticated requests and by billing emails, so they must | ||
| // stay behind dynamic imports and out of these routes' startup graph. | ||
| const webRoot = fileURLToPath(new URL("../../", import.meta.url)); | ||
|
|
||
| const ROUTES = [ | ||
| "app/api/developer/v1/[...route]/route.ts", | ||
| "app/api/developer/mcp/route.ts", | ||
| ]; | ||
|
|
||
| const NOT_AT_STARTUP = [ | ||
| "packages/database/auth/auth-options", | ||
| "packages/database/auth/session", | ||
| "packages/database/emails/", | ||
| "node_modules/next-auth/", | ||
| "node_modules/nodemailer/", | ||
| "node_modules/@workos-inc/", | ||
| "node_modules/@react-email/", | ||
| "node_modules/resend/", | ||
| ]; | ||
|
|
||
| async function staticGraph(route: string) { | ||
| const result = await build({ | ||
| entryPoints: [route], | ||
| absWorkingDir: webRoot, | ||
| bundle: true, | ||
| write: false, | ||
| metafile: true, | ||
| platform: "node", | ||
| format: "esm", | ||
| logLevel: "silent", | ||
| tsconfig: "tsconfig.json", | ||
| conditions: ["react-server", "node"], | ||
| external: ["next", "next/*", "@vercel/*"], | ||
| loader: { | ||
| ".node": "empty", | ||
| ".wasm": "empty", | ||
| ".svg": "empty", | ||
| ".png": "empty", | ||
| ".css": "empty", | ||
| }, | ||
| }); | ||
| const inputs: Metafile["inputs"] = result.metafile.inputs; | ||
| const entry = Object.keys(inputs).find((path) => path.endsWith(route)); | ||
| if (!entry) throw new Error(`entry not found for ${route}`); | ||
| const parent = new Map<string, string | null>([[entry, null]]); | ||
| const queue = [entry]; | ||
| while (queue.length > 0) { | ||
| const current = queue.shift() as string; | ||
| for (const imported of inputs[current]?.imports ?? []) { | ||
| if (imported.kind === "dynamic-import") continue; | ||
| if (parent.has(imported.path) || !inputs[imported.path]) continue; | ||
| parent.set(imported.path, current); | ||
| queue.push(imported.path); | ||
| } | ||
| } | ||
| return parent; | ||
| } | ||
|
|
||
| function chainTo(parent: Map<string, string | null>, path: string) { | ||
| const chain: string[] = []; | ||
| for (let at: string | null | undefined = path; at; at = parent.get(at)) { | ||
| chain.unshift(at.replace(/^.*node_modules\//, "")); | ||
| } | ||
| return chain.join(" -> "); | ||
| } | ||
|
|
||
| describe("developer API cold path", () => { | ||
| it.each(ROUTES)( | ||
| "%s does not load sign-in or email code at startup", | ||
| async (route) => { | ||
| const parent = await staticGraph(route); | ||
| const offenders = [...parent.keys()] | ||
| .filter((path) => NOT_AT_STARTUP.some((part) => path.includes(part))) | ||
| .map((path) => chainTo(parent, path)); | ||
| expect(offenders.slice(0, 3)).toEqual([]); | ||
| }, | ||
| 60_000, | ||
| ); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.