Skip to content

fix(cloudflare): Capture errors that fail a workflow run outside a step callback - #26316

Open
JPeer264 wants to merge 1 commit into
developfrom
jp/cloudflare-workflow-capture-run-errors
Open

JPeer264 wants to merge 1 commit into
developfrom
jp/cloudflare-workflow-capture-run-errors

Conversation

@JPeer264

Copy link
Copy Markdown
Member

closes #26286
closes JS-4097

Description

This fixes instrumentWorkflowWithSentry so that each error that fails run() is sent to Sentry: an error thrown in run() itself, a step.do or step.waitForEvent timeout, and a step failure in the engine. Before, only errors thrown inside a step.do callback were captured.

Mechanism decisions

Errors captured in run() have handled: false, because they fail the instance. Errors captured in the step callback keep handled: true. The alternative is handled: false for a failed final step attempt too.

Event count decisions

A failed step that fails the instance gives one event. But when run() catches a step error and throws a new error, Sentry now gets two events: the step error and the new error. They are two different errors, and there is a test for this. The alternative is to capture only in run(), but then a step error that run() catches and survives gives no event.

Sentry events / traces

Error thrown in run() before a step: https://sentry-sdks.sentry.io/issues/7844396928/events/7e1ad493e0ac44f8b23f2f6e534cd693/
step.do timeout: https://sentry-sdks.sentry.io/issues/7844396929/events/cdfb9eef82cb41d6a5b2072d6aa7c62f/
Error thrown inside a step callback (one event): https://sentry-sdks.sentry.io/issues/7844396894/events/8cc4126912f640ee8d9be04d243b6e0b/
Trace with two errors, run() replaces a failed step error: https://sentry-sdks.sentry.io/explore/traces/trace/c1b52ecbf72646e38638479f80b9740d/?project=4510555608449024

…ep callback

`instrumentWorkflowWithSentry` only captured errors thrown inside a
`step.do` callback. An error thrown in `run()` itself, a step timeout,
a `step.waitForEvent` timeout or an engine-side step failure failed the
instance without a Sentry event.

`run()` now captures the error that fails it, as unhandled. The engine
rejects `step.do` with a copy of the error the callback threw, so the
copy is marked as captured when the callback already reported it. This
keeps a failed step at one event.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@linear-code

linear-code Bot commented Nov 12, 2026

Copy link
Copy Markdown

JS-4097

@JPeer264 JPeer264 self-assigned this Nov 12, 2026
@JPeer264
JPeer264 marked this pull request as ready for review November 12, 2026 11:11
@JPeer264
JPeer264 requested a review from a team November 12, 2026 11:11
@JPeer264
JPeer264 requested a review from a team as a code owner November 12, 2026 11:11
@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Compared: 1350e03 (PR test merge using develop at 6bee2f2)

Against: 6bee2f2 (develop) · base run #65818

✅ Baseline matches: this diff contains only this PR's changes.

Path Size % Change Change
@sentry/browser 30.04 kB - -
@sentry/browser - with treeshaking flags 28.23 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 28.12 kB - -
@sentry/browser (incl. Tracing) 52.2 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 52.2 kB - -
@sentry/browser (incl. Tracing, Profiling) 55.17 kB - -
@sentry/browser (incl. Tracing, Replay) 92.73 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 81.52 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 97.08 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 110.51 kB - -
@sentry/browser (incl. Feedback) 47.66 kB - -
@sentry/browser (incl. sendFeedback) 30.62 kB - -
@sentry/browser (incl. FeedbackAsync) 35.62 kB - -
@sentry/browser (incl. Metrics) 31.36 kB - -
@sentry/browser (incl. Logs) 31.64 kB - -
@sentry/browser (incl. Metrics & Logs) 32.3 kB - -
@sentry/react 32.04 kB - -
@sentry/react (incl. Tracing) 54.86 kB - -
@sentry/vue 38.21 kB - -
@sentry/vue (incl. Tracing) 55.14 kB - -
@sentry/svelte 30.05 kB - -
@sentry/remix (Remix 3 client bundle) 57.96 kB - -
CDN Bundle 31.79 kB - -
CDN Bundle (incl. Tracing) 52.58 kB - -
CDN Bundle (incl. Logs, Metrics) 34.58 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 55.14 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 75.61 kB - -
CDN Bundle (incl. Tracing, Replay) 90.63 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 93.25 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 96 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 98.6 kB - -
CDN Bundle - uncompressed 92.69 kB - -
CDN Bundle (incl. Tracing) - uncompressed 155.13 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 101.03 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 162.76 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 231.11 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 275.27 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 282.9 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 287.07 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 294.69 kB - -
@sentry/nextjs (client) 58.23 kB - -
@sentry/sveltekit (client) 53.26 kB - -
@sentry/core/server 44.53 kB - -
@sentry/core/browser 13.99 kB - -
@sentry/node 149.48 kB -0.01% -3 B 🔽
@sentry/node/import (ESM hook with diagnostics-channel injection) 83.3 kB - -
@sentry/node - without tracing 88.38 kB -0.01% -5 B 🔽
@sentry/node - without channel injection 138.45 kB -0.01% -2 B 🔽
@sentry/aws-serverless 97.29 kB -0.01% -4 B 🔽
@sentry/cloudflare (withSentry) - minified 204.49 kB +0.07% +136 B 🔺
@sentry/cloudflare (withSentry) 474.82 kB +0.11% +502 B 🔺
@sentry/nextjs/cloudflare (withSentry) - minified 229.66 kB - -

View base workflow run

@JPeer264
JPeer264 removed the request for review from HazAT November 12, 2026 11:12
@github-actions

Copy link
Copy Markdown
Contributor

Optional E2E tests

Some optional checks were not successful. They do not block the merge. 2 not successful, 33 successful. See the run.

Check Status
❌ CI: Optional E2E Tests / E2E nextjs-16-cacheComponents (cloudflare) Test (optional) Failing after 10m Details
❌ CI: Optional E2E Tests / E2E nestjs-12 (bun) Test (optional) Failing after 59s Details
Successful checks
Check Status
✅ CI: Optional E2E Tests / E2E cloudflare-flue-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (cloudflare) Test (optional) Successful in 34s Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (latest) Test (optional) Successful in 46s Details
✅ CI: Optional E2E Tests / E2E nextjs-orpc Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps Test (optional) Successful in 41s Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (turbo) Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-cloudflare Test (optional) Successful in 33s Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable (latest) Test (optional) Successful in 50s Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (client source maps kept) Test (optional) Successful in 35s Details
✅ CI: Optional E2E Tests / E2E nuxt-5 Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (latest) Test (optional) Successful in 50s Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (latest) Test (optional) Successful in 4m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think (ai v6) Test (optional) Successful in 55s Details
✅ CI: Optional E2E Tests / E2E cloudflare-agent Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries Test (optional) Successful in 48s Details
✅ CI: Optional E2E Tests / E2E cloudflare-workers-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-mastra Test (optional) Successful in 52s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext, bun) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E astro-7 Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E supabase-nextjs Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E astro-7-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (cloudflare) Test (optional) Successful in 39s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (deno) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nextjs-14 (latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (deno) Test (optional) Successful in 56s Details
✅ CI: Optional E2E Tests / E2E nextjs-16-tunnel (cloudflare) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-cloudflare Test (optional) Successful in 31s Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable Test (optional) Successful in 58s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (cloudflare, latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nuxt-5 (tunnel-dev) Test (optional) Successful in 55s Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (static / nuxt generate) Test (optional) Successful in 32s Details

return stepResult.catch(error => {
// The engine rejects with a copy of the error the callback threw, so the copy has to be marked
// as captured too. Otherwise `run` would report the same failure a second time.
if (capturedByCallback) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

do we need this capturedByCallback thing if we pass it through checkOrSetAlreadyCaught anyhow...?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ah wait, I think I am confused by the code. we ignore the return value here and just use this to mark this as captured, right? maybe worth it to adjust the comment a bit, e.g. "we use checkOrSetAlreadyCaught to ensure the error is marked as already sent" or something like this

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Cloudflare] instrumentWorkflowWithSentry does not capture errors thrown in run() outside a step

2 participants