Skip to content

Fix step stack trace propogation and refactor e2e error tests #720

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.

Sign up for GitHub

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
pranaygp merged 16 commits into from
Jan 5, 2026
Merged

Fix step stack trace propogation and refactor e2e error tests #720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
578de8d
Refactor e2e tests for errors
pranaygp Jan 3, 2026
1543a92
Improve step error tests to check workflow return value
pranaygp Jan 3, 2026
2572175
Add assertion for stack trace in caught step error
pranaygp Jan 3, 2026
700c1ed
logging
pranaygp Jan 3, 2026
c97fb5e
Fix: When a step handler is re-invoked after max retries are exhauste…
vercel[bot] Jan 3, 2026
0473eb7
add withData
pranaygp Jan 3, 2026
7e30ddb
Enable source maps for step bundles and validate in e2e tests
pranaygp Jan 3, 2026
faf6c5c
Add changeset for step bundle source maps
pranaygp Jan 3, 2026
0d37dfc
Add changeset for core package e2e test improvements
pranaygp Jan 3, 2026
3a8f4e0
Enable source maps in CI e2e tests
pranaygp Jan 3, 2026
dcc659d
Fix step error source map checks for local prod builds
pranaygp Jan 3, 2026
2b970d1
Add hasWorkflowSourceMaps() utility for vite-based framework exception
pranaygp Jan 3, 2026
ed6a9a3
prevent sourcemap checks in nextjs and sveltekit (known offenders)
pranaygp Jan 3, 2026
7a2f074
improve source maps matrix check
pranaygp Jan 3, 2026
9166ccb
fix matrix again
pranaygp Jan 3, 2026
14b0723
ugh more matrix ignoring
pranaygp Jan 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fancy-apples-tell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@workflow/builders": patch
---

Enable source maps for step bundles to preserve original file paths in error stack traces
5 changes: 5 additions & 0 deletions .changeset/true-kings-exist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@workflow/core": patch
---

Correctly propagate stack traces for step errors
1 change: 1 addition & 0 deletions .github/workflows/e2e-community-world.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ jobs:
sleep 10
pnpm vitest run packages/core/e2e/e2e.test.ts --reporter=default --reporter=json --outputFile=e2e-community-${{ inputs.world-id }}.json || true
env:
NODE_OPTIONS: "--enable-source-maps"
APP_NAME: ${{ inputs.app-name }}
DEPLOYMENT_URL: "http://localhost:3000"
DEV_TEST_CONFIG: '{"name":"${{ inputs.app-name }}","project":"workbench-${{ inputs.app-name }}-workflow","generatedStepPath":"app/.well-known/workflow/v1/step/route.js","generatedWorkflowPath":"app/.well-known/workflow/v1/flow/route.js","apiFilePath":"app/api/chat/route.ts","apiFileImportPath":"../../.."}'
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@ jobs:
- name: Run E2E Tests
run: pnpm run test:e2e --reporter=default --reporter=json --outputFile=e2e-vercel-prod-${{ matrix.app.name }}.json
env:
NODE_OPTIONS: "--enable-source-maps"
DEPLOYMENT_URL: ${{ steps.waitForDeployment.outputs.deployment-url }}
APP_NAME: ${{ matrix.app.name }}
WORKFLOW_VERCEL_SKIP_PROXY: 'true'
Expand Down Expand Up @@ -330,6 +331,7 @@ jobs:
pnpm vitest run packages/core/e2e/dev.test.ts; sleep 10
pnpm run test:e2e --reporter=default --reporter=json --outputFile=e2e-local-dev-${{ matrix.app.name }}-${{ matrix.app.canary && 'canary' || 'stable' }}.json
env:
NODE_OPTIONS: "--enable-source-maps"
APP_NAME: ${{ matrix.app.name }}
DEPLOYMENT_URL: "http://localhost:${{ matrix.app.name == 'sveltekit' && '5173' || (matrix.app.name == 'astro' && '4321' || '3000') }}"
DEV_TEST_CONFIG: ${{ toJSON(matrix.app) }}
Expand Down Expand Up @@ -396,6 +398,7 @@ jobs:
echo "starting tests in 10 seconds" && sleep 10
pnpm run test:e2e --reporter=default --reporter=json --outputFile=e2e-local-prod-${{ matrix.app.name }}-${{ matrix.app.canary && 'canary' || 'stable' }}.json
env:
NODE_OPTIONS: "--enable-source-maps"
APP_NAME: ${{ matrix.app.name }}
DEPLOYMENT_URL: "http://localhost:${{ matrix.app.name == 'sveltekit' && '4173' || (matrix.app.name == 'astro' && '4321' || '3000') }}"

Expand Down Expand Up @@ -481,6 +484,7 @@ jobs:
echo "starting tests in 10 seconds" && sleep 10
pnpm run test:e2e --reporter=default --reporter=json --outputFile=e2e-local-postgres-${{ matrix.app.name }}-${{ matrix.app.canary && 'canary' || 'stable' }}.json
env:
NODE_OPTIONS: "--enable-source-maps"
APP_NAME: ${{ matrix.app.name }}
DEPLOYMENT_URL: "http://localhost:${{ matrix.app.name == 'sveltekit' && '4173' || (matrix.app.name == 'astro' && '4321' || '3000') }}"

Expand Down Expand Up @@ -542,6 +546,7 @@ jobs:
Stop-Job $job
shell: powershell
env:
NODE_OPTIONS: "--enable-source-maps"
APP_NAME: "nextjs-turbopack"
DEPLOYMENT_URL: "http://localhost:3000"
DEV_TEST_CONFIG: '{"generatedStepPath":"app/.well-known/workflow/v1/step/route.js","generatedWorkflowPath":"app/.well-known/workflow/v1/flow/route.js","apiFilePath":"app/api/chat/route.ts","apiFileImportPath":"../../..","port":3000}'
Expand Down
11 changes: 7 additions & 4 deletions packages/builders/src/base-builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ export abstract class BaseBuilder {
write: false,
outdir,
bundle: true,
sourcemap: EMIT_SOURCEMAPS_FOR_DEBUGGING,
sourcemap: false,
absWorkingDir: this.config.workingDir,
logLevel: 'silent',
});
Expand Down Expand Up @@ -339,8 +339,11 @@ export abstract class BaseBuilder {
'.mjs',
'.cjs',
],
// TODO: investigate proper source map support
sourcemap: EMIT_SOURCEMAPS_FOR_DEBUGGING,
// Inline source maps for better stack traces in step execution.
// Steps execute in Node.js context and inline sourcemaps ensure we get
// meaningful stack traces with proper file names and line numbers when errors
// occur in deeply nested function calls across multiple files.
sourcemap: 'inline',
Copy link
Member

@VaguelySerious VaguelySerious Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only change that gives me a tiny bit of pause - does this affect performance? It'd be nice to take a quick look at bundle times and see if it's relevant, given we already have complaints about bundling/discovery time, and the caching PR from JJ was reverted recently

Copy link
Collaborator Author

@pranaygp pranaygp Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the perf issues were primarily happening in the "discovering workflows/steps" bit - which is not the same as this esbuild.

This shouldn't meaningfully affect benchmarking yet, but we probably should start benchmarking build times soon too @ijjk as you dig deeper into that

plugins: [
createSwcPlugin({
mode: 'step',
Expand Down Expand Up @@ -747,7 +750,7 @@ export const OPTIONS = handler;`;
'.mjs',
'.cjs',
],
sourcemap: false,
sourcemap: EMIT_SOURCEMAPS_FOR_DEBUGGING,
mainFields: ['module', 'main'],
// Don't externalize anything - bundle everything including workflow packages
external: [],
Expand Down
Loading
Loading