Uh oh!
There was an error while loading. Please reload this page.
Add optional reason to run cancellation - #2840
Merged
Merged
Conversation
Adds an optional, max-512-char cancelReason to the run_cancelled event: a `reason` parameter on cancelRun / getRun().cancel(), routed through the v4 wire format, and surfaced read-only in the run detail view (web / web-shared). Includes schema, wire, docs, and a changeset. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 3fdb06a The changes in this PR will be included in the next version bump. This PR includes changesets to release 20 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✅ All tests passed Summary
Details by Category✅ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
✅ 📋 Other
❌ Some E2E test jobs failed:
Check the workflow run for details. |
Contributor
📊 Workflow Benchmarkscommit Backend:
Metrics — TTFS: time to first step body execution · STSO: step-to-step overhead (gap between consecutive step bodies) · WO: workflow overhead (time outside step bodies, client start → last step body exit) · SL: stream latency (first chunk write → visible to the reader) Scenarios — stream: one step that streams chunks back to the client; no hooks, so the run stays in turbo mode · hook + stream: registers a hook before the same streaming step, which exits turbo mode · 1020 steps: 1020 trivial sequential steps; STSO is measured between consecutive steps in the given step ranges 🟢/🔴 mark percentiles within/above target. Targets (p75/p90/p99, ms) — TTFS 200/300/600 · SL 50/60/125 · STSO (1-20) 20/30/60 · STSO (101-120) 30/45/90 · STSO (1001-1020) 40/60/120 TTFS/WO compare client vs deployment clocks and SL compares the step runner’s clock vs the client’s (NTP-synced in CI). WO ends at the last step body exit, the closest observable proxy for the final step-completion request. |
VaguelySerious
marked this pull request as ready for review
July 8, 2026 22:58
| * chars), recorded on the run_cancelled event. | ||
| */ | ||
| async cancel(): Promise<void> { | ||
| async cancel(reason?: string): Promise<void> { |
MemberAuthor
There was a problem hiding this comment.
Suggested change
| asynccancel(reason?: string): Promise<void>{ | |
| asynccancel({cancelReason}: {cancelReason?: string}): Promise<void>{ |
Change `getRun().cancel()` and the `cancelRun` helper to take an optional
`{ cancelReason }` options object instead of a positional reason string, for
forward-compatibility (matches the wakeUp/StopSleepOptions convention). Adds
and exports a `CancelRunOptions` type.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
VaguelySerious
enabled auto-merge (squash)
July 8, 2026 23:23
VaguelySerious
disabled auto-merge
July 8, 2026 23:39
Uh oh!
There was an error while loading. Please reload this page.
github-actionsBot
added a commit
that referenced
this pull request
Jul 8, 2026
Signed-off-by: Peter Wielander <mittgfu@gmail.com>
Contributor
Backport PR opened against |
This was referenced Jul 8, 2026
pranaygp added a commit
that referenced
this pull request
Jul 22, 2026
…de-noise, docs mechanism reword - Use main's run_cancelled eventData.cancelReason (#2840) instead of the branch's top-level reason field; update cancelActiveRuns and tests - Drop e2e-restart-recovery from the E2E Summary has_failures computation and failure-notice list (consistent with the soak de-gate) - Move recovering-in-flight-runs docs into the worlds section (deploying/ was flattened on main) and reword the multi-instance exactly-once mechanism: queue job-key lock covers the mid-step window, terminal-state guard covers after-completion, sleeping runs have no concurrency; note the contract implication for custom Worlds - Make the shared nitro start-pg-world plugin injection-only (start goes through @workflow/nitro's ensureWorldStarted plugin with the dev flag) - Give the world.test.ts stub a specVersion (getWorld now asserts it) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
pranaygp added a commit
that referenced
this pull request
Jul 22, 2026
…de-noise, docs mechanism reword - Use main's run_cancelled eventData.cancelReason (#2840) instead of the branch's top-level reason field; update cancelActiveRuns and tests - Drop e2e-restart-recovery from the E2E Summary has_failures computation and failure-notice list (consistent with the soak de-gate) - Move recovering-in-flight-runs docs into the worlds section (deploying/ was flattened on main) and reword the multi-instance exactly-once mechanism: queue job-key lock covers the mid-step window, terminal-state guard covers after-completion, sleeping runs have no concurrency; note the contract implication for custom Worlds - Make the shared nitro start-pg-world plugin injection-only (start goes through @workflow/nitro's ensureWorldStarted plugin with the dev flag) - Give the world.test.ts stub a specVersion (getWorld now asserts it) Co-Authored-By: Claude Fable 5 <noreply@anthropic.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
2 participants
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.
What
Adds an optional, free-text cancel reason (max 512 characters) to run cancellation.
run_cancelledevents now carry an optionaleventData.cancelReason(@workflow/worldschema).cancelRun(world, runId, reason?)andgetRun(runId).cancel(reason?)accept an optional reason.errorCode.web/web-shared) surfaces the reason read-only on therun_cancelledevent in the timeline.Notes
run.cancel()with no argument is unchanged.Tests
@workflow/world: schema accepts with/without reason, rejects >512 chars, and retains it on read.@workflow/world-vercel:splitEventDataForV4routescancelReasoninto the frame meta.🤖 Generated with Claude Code