Uh oh!
There was an error while loading. Please reload this page.
[nest] Add NestJS support on Vercel - #1472
Closed
VaguelySerious wants to merge 95 commits into
Closed
Conversation
🦋 Changeset detectedLatest commit: 5d7ef34 The changes in this PR will be included in the next version bump. This PR includes changesets to release 16 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests▲ Vercel Production (3 failed)hono (2 failed):
nuxt (1 failed):
🌍 Community Worlds (56 failed)mongodb (3 failed):
redis (2 failed):
turso (51 failed):
Details by Category❌ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 🌍 Community Worlds
✅ 📋 Other
❌ Some E2E test jobs failed:
Check the workflow run for details. |
Contributor
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 1 step💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 25 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 50 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro Promise.all with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro Promise.race with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 10 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 25 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 50 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 10 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 25 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro workflow with 50 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro Stream Benchmarks(includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro stream pipeline with 5 transform steps (1MB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro 10 parallel streams (1MB each)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro fan-out fan-in 10 streams (1MB each)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
❌ Some benchmark jobs failed:
Check the workflow run for details. |
Uh oh!
There was an error while loading. Please reload this page.
NestLocalBuilder.build() only generates runtime .mjs bundles for the WorkflowController — no Vercel Build Output API functions are created. VQS discovers consumers via experimentalTriggers in .vc-config.json, so NestJS deployments silently fail with "no v2beta consumer". Add buildVercelOutput() which generates: - .well-known/workflow/v1/step.func with STEP_QUEUE_TRIGGER - .well-known/workflow/v1/flow.func with WORKFLOW_QUEUE_TRIGGER - .well-known/workflow/v1/webhook/[token].func - api/index.js.func (esbuild-bundled NestJS app) - config.json with routing rules Also update NestJS getting-started docs and README with Vercel deployment instructions. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
VaguelySeriousforce-pushed
the
peter/nest-fix-mar-20
branch
from
March 20, 2026 23:16
880e1af to
565712cCompareAdd nest to the e2e-vercel-prod matrix in tests.yml with the correct project ID (prj_G3RlX1TsB5V2hcqTNvuVoJXdfE1o) and slug (workbench-nestjs-workflow). Set up the workbench for Vercel Build Output API deployment: - Add api/index.js entry point for the NestJS serverless function - Add scripts/build-vercel.ts postbuild step calling buildVercelOutput() - Update vercel.json with buildCommand - Fix project slug in create-test-matrix.mjs - Clear framework preset from "NestJS" to "Other" on Vercel project Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add a `build` subcommand to the workflow-nest CLI that builds workflow bundles and, when VERCEL env is detected, automatically generates the Build Output API with experimentalTriggers. The entry point is auto- detected from api/index.js (or can be specified via --entry). This replaces the need for a custom scripts/build-vercel.ts file — users just add `"postbuild": "workflow-nest build"` to package.json. Also document the Vercel project requirement: framework preset must be set to "Other" (not "NestJS") to avoid conflicting with Build Output API. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The workflow-nest build CLI copies manifest.json to dist/ during postbuild. The app.module.ts reads it at module load time using join(process.cwd(), 'dist', 'workflow-manifest.json'). On Vercel's Lambda, CWD is the project root and dist/ is always NFT-included. The globalThis.__workflowManifestJson value is read by the WorkflowController as a fallback when readFileSync fails. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
NFT can't trace readFileSync with computed paths. But it DOES trace
dynamic import() with string literals. Generate a JS module
(dist/workflow-manifest.js) and use await import('./workflow-manifest.js')
in app.module.ts. NFT sees the static string and includes the file.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>The env var may not be reaching the Lambda runtime. Force-set it in app.module.ts at import time when VERCEL env is detected. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Top-level await may crash in the Vercel Lambda context. Use createRequire(import.meta.url) for synchronous require() of the manifest module. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
SWC compiles app.module.ts to CJS. The createRequire require() can't load ESM modules. Write the manifest module as CJS (module.exports) instead of ESM (export default). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
With package.json type=module, .js files are ESM. CJS module.exports in a .js file is misinterpreted. Use .cjs extension to force CJS. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ively .cjs files may not be included by the NestJS Vercel preset. Use .json which require() auto-parses and is universally included in dist/. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
In ESM modules, bare require() isn't available. createRequire creates a require function that resolves relative to the file. The .json file in dist/ IS copied to the Lambda by the NestJS Vercel preset (it copies all of dist/). This approach works both locally and on Vercel. Verified locally: globalThis.__workflowManifestJson is set correctly. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The fix: 1. prebuild: workflow-nest build generates .nestjs/workflow/manifest.json 2. nest-cli.json assets: copies manifest to dist/workflow/manifest.json 3. nest build: produces dist/ with the manifest included 4. app.module.ts: createRequire loads dist/workflow/manifest.json 5. NestJS Vercel preset includes ALL nest build output in Lambda Key insight: nest build's assets copy runs during compilation, so the manifest is part of the official dist/ output that the NestJS Vercel preset deploys. No NFT tracing needed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add configureManifest(json) to WorkflowController which sets the manifest as a string constant. The controller checks this before falling back to readFileSync. WorkflowModule.forRoot() accepts a manifestJson option that calls configureManifest during setup. In the workbench: - prebuild generates manifest via workflow-nest build - nest-cli.json assets copies it to dist/workflow/manifest.json - app.module.ts loads it via createRequire and passes to forRoot() - On Vercel, the controller serves the pre-loaded manifest directly Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The definitive fix for the manifest on Vercel:
1. prebuild: workflow-nest build generates src/_manifest-data.ts
containing the manifest as an exported string constant
2. nest build: SWC compiles it to dist/_manifest-data.js
3. app.module.ts: imports _manifest-data.js via standard ESM import
4. NFT traces the standard import and includes the compiled module
5. WorkflowModule.forRoot({ manifestJson }) passes it to the controller
This avoids ALL the previous issues:
- No readFileSync with untraceable paths
- No createRequire that NFT can't follow
- No .cjs/.json files that Vercel doesn't include
- The manifest is part of the standard compiled output
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>The WorkflowController imports steps.mjs/workflows.mjs from outDir. On Vercel, these need to be in the Lambda. NestJS CLI assets copies them from .nestjs/workflow/ to dist/workflow/ during nest build. Set outDir to dist/workflow/ on Vercel so the controller finds them. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…I for workflows Use framework=null. Generate Build Output API for step/flow/webhook with experimentalTriggers. Use api/index.js with @vercel/node and includeFiles for the NestJS handler with the workflow bundles. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
… functions Go back to framework=nestjs. The NestJS preset + Build Output API should coexist — the preset handles the NestJS handler, and the Build Output API provides step/flow/webhook functions with experimentalTriggers for VQS. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
On Vercel, the .mjs bundle files aren't in the Lambda (NFT can't trace dynamic import(pathToFileURL(...))). Fix by: 1. CLI build generates _steps-bundle.ts, _workflows-bundle.ts, _webhook-bundle.ts with base64-encoded bundle content 2. nest build compiles them → NFT traces standard imports 3. app.module.ts loads base64 data into globalThis 4. WorkflowController.loadBundle() tries filesystem first, then decodes base64, writes to /tmp/, and imports from there This makes workflow execution work on Vercel: - VQS delivers to the NestJS handler (merged lambda) - The handler's WorkflowController loads bundles from /tmp/ - Workflows execute successfully Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Dynamic await import() is NOT traced by @vercel/nft. Static import
statements ARE traced. Change from:
const { data } = await import('./_steps-bundle.js') // NOT traced
to:
import { data } from './_steps-bundle.js' // TRACED by NFT
SWC preserves static import statements as-is in the compiled output.
This ensures dist/_steps-bundle.js is included in the Vercel Lambda.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>The .mjs bundles import 'workflow' and other packages that resolve from node_modules/. Writing to /tmp/ breaks package resolution. Use process.cwd()/.wf_bundles so node_modules is in the parent chain. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The Lambda is read-only except /tmp/. Write bundles to /tmp/ and symlink node_modules from the project root so the bundles can resolve packages like 'workflow'. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Two fixes: 1. Generate Build Output API FIRST, then create TS bundle wrappers from the self-contained CJS bundles (not the local .mjs ones) 2. Use .cjs extension when writing bundles to /tmp/ so Node.js treats them as CJS regardless of package.json type The BOA bundles have ALL dependencies inlined — no external package resolution needed. This fixes 'Cannot find package workflow' error. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Static imports crash if the files don't exist during nest start (local dev). Check in empty placeholders so they always exist. The workflow-nest build CLI overwrites them with actual data. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…a outputs With framework=nestjs, all functions merge into 1 lambda, losing experimentalTriggers. With framework=null, Build Output API creates separate lambda outputs for step, flow, webhook (with triggers) and __nestjs (esbuild-bundled NestJS handler). The esbuild step only runs in postbuild (when dist/ exists from nest build). In prebuild, only workflow bundles and TS files are generated. Config.json: webhook → handle:filesystem → handle:miss → catch-all with check:true. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Peter Wielander <mittgfu@gmail.com>
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
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Extends builder to bundle separate functions for app/flow/step routes with experimentalTriggers enabled, allowing queue callbacks when deployed to Vercel, and adds e2e tests for the Vercel environment.
Related: