Skip to content

Backport #2840: Add optional reason to run cancellation#2843

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

Closed
github-actions wants to merge 1 commit into from
Closed

Backport #2840: Add optional reason to run cancellation #2843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions .changeset/run-cancel-reason.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@workflow/core': patch
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/web-shared': patch
---

Add an optional reason to run cancellation (`run.cancel({ cancelReason })`), recorded on the cancellation event and shown in the run detail view.
19 changes: 19 additions & 0 deletions docs/content/docs/api-reference/workflow-api/get-run.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,25 @@ const { stoppedCount } = await run.wakeUp({
});
```

### Cancel a Run

Cancel a workflow run. You can pass an optional free-text `cancelReason` (up to 512 characters) that is recorded on the run's cancellation event and shown in the run detail view:

```typescript lineNumbers
import { getRun } from "workflow/api";

export async function POST(req: Request) {
const { runId } = await req.json();
const run = getRun(runId);

await run.cancel({ cancelReason: "Superseded by a newer submission" }); // [!code highlight]

return Response.json({ cancelled: true });
}
```

The options object is optional — `await run.cancel()` cancels the run without recording a reason.

## Related Functions

- [`start()`](/docs/api-reference/workflow-api/start) - Start a new workflow and get its run ID.
1 change: 1 addition & 0 deletions packages/core/src/runtime.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
type WorkflowReadableStreamOptions,
} from './runtime/run.js';
export {
type CancelRunOptions,
cancelRun,
listStreams,
type ReadStreamOptions,
Expand Down
10 changes: 9 additions & 1 deletion packages/core/src/runtime/run.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
} from '../serialization.js';
import { getWorkflowRunStreamId } from '../util.js';
import {
type CancelRunOptions,
type StopSleepOptions,
type StopSleepResult,
wakeUpRun,
Expand DownExpand Up@@ -142,11 +143,18 @@ export class Run<TResult> {

/**
* Cancels the workflow run.
*
* @param options - Optional cancellation settings. `cancelReason` records a
* free-text reason (max 512 chars) on the run_cancelled event, surfaced in
* the run detail view.
*/
async cancel(): Promise<void> {
async cancel(options?: CancelRunOptions): Promise<void> {
await this.world.events.create(this.runId, {
eventType: 'run_cancelled',
specVersion: SPEC_VERSION_CURRENT,
...(options?.cancelReason !== undefined
? { eventData: { cancelReason: options.cancelReason } }
: {}),
});
}

Expand Down
24 changes: 21 additions & 3 deletions packages/core/src/runtime/runs.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,14 @@ export interface StopSleepOptions {
correlationIds?: string[];
}

export interface CancelRunOptions {
/**
* Optional free-text reason for the cancellation (max 512 chars), recorded
* on the run_cancelled event and surfaced in the run detail view.
*/
cancelReason?: string;
}

const normalizeWorkflowArgs = (args: unknown): unknown[] => {
return Array.isArray(args) ? args : [args];
};
Expand DownExpand Up@@ -85,17 +93,27 @@ export async function recreateRunFromExisting(

/**
* Cancel a workflow run.
*
* @param options - Optional cancellation settings. `cancelReason` records a
* free-text reason (max 512 chars) on the run_cancelled event.
*/
export async function cancelRun(world: World, runId: string): Promise<void> {
export async function cancelRun(
world: World,
runId: string,
options?: CancelRunOptions
): Promise<void> {
try {
const run = await world.runs.get(runId, { resolveData: 'none' });
const specVersion = run.specVersion ?? SPEC_VERSION_LEGACY;
const compatMode = isLegacySpecVersion(specVersion);
const eventData = {
const eventRequest = {
eventType: 'run_cancelled' as const,
specVersion,
...(options?.cancelReason !== undefined
? { eventData: { cancelReason: options.cancelReason } }
: {}),
};
await world.events.create(runId, eventData, { v1Compat: compatMode });
await world.events.create(runId, eventRequest, { v1Compat: compatMode });
} catch (err) {
throw new Error(
`Failed to cancel run ${runId}: ${err instanceof Error ? err.message : String(err)}`,
Expand Down
21 changes: 21 additions & 0 deletions packages/web-shared/src/components/event-list-view.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -595,6 +595,27 @@ function PayloadBlock({
);
}

// Cancellation reason — render the free-text reason as a readable line
// instead of a raw JSON payload (the only field run_cancelled carries).
if (eventType === 'run_cancelled') {
const cancelReason =
cleaned != null &&
typeof cleaned === 'object' &&
typeof (cleaned as Record<string, unknown>).cancelReason === 'string'
? ((cleaned as Record<string, unknown>).cancelReason as string)
: null;
if (cancelReason) {
return (
<div className="p-2 text-xs" style={{ color: 'var(--ds-gray-1000)' }}>
<span style={{ color: 'var(--ds-gray-900)' }}>Reason: </span>
<span className="whitespace-pre-wrap break-words">
{cancelReason}
</span>
</div>
);
}
}

return (
<div className="relative group/payload">
<div
Expand Down
1 change: 1 addition & 0 deletions packages/workflow/src/api-workflow.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export type {
CancelRunOptions,
Event,
StartOptions,
StopSleepOptions,
Expand Down
1 change: 1 addition & 0 deletions packages/workflow/src/api.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export {
type CancelRunOptions,
type Event,
getHookByToken,
getRun,
Expand Down
4 changes: 4 additions & 0 deletions packages/world-vercel/src/events-v4.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,9 @@ export interface CreateEventV4Input {
error?: unknown;
/** Companion stack string for step_failed / step_retrying. */
stack?: string;
/** run_cancelled's optional free-text cancellation reason. Small plaintext
* metadata, capped at 512 chars by the @workflow/world schema. */
cancelReason?: string;
/** Arbitrary structured map; rides as a native CBOR object in the
* frame meta. Bounded by the server at 2 KB encoded. */
executionContext?: Record<string, unknown>;
Expand DownExpand Up@@ -138,6 +141,7 @@ function buildPostFrameMeta(
if (input.errorCode !== undefined) meta.errorCode = input.errorCode;
if (input.error !== undefined) meta.error = input.error;
if (input.stack !== undefined) meta.stack = input.stack;
if (input.cancelReason !== undefined) meta.cancelReason = input.cancelReason;
if (input.executionContext !== undefined) {
meta.executionContext = input.executionContext;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/world-vercel/src/events.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,27 @@ describe('splitEventDataForV4 structured errors', () => {
expect(meta.stack).toBeUndefined();
});

it('carries the run_cancelled cancelReason in the frame meta, not the payload', () => {
const { payload, meta } = splitEventDataForV4({
eventType: 'run_cancelled',
specVersion: 4,
eventData: { cancelReason: 'superseded by newer run' },
} as AnyEventRequest);

expect(payload).toBeUndefined();
expect(meta.cancelReason).toBe('superseded by newer run');
});

it('omits cancelReason from meta when run_cancelled carries no reason', () => {
const { payload, meta } = splitEventDataForV4({
eventType: 'run_cancelled',
specVersion: 4,
} as AnyEventRequest);

expect(payload).toBeUndefined();
expect(meta.cancelReason).toBeUndefined();
});

it('keeps an already-dehydrated (Uint8Array) error on the body path', () => {
// A runtime that DOES dehydrate errors hands the split a Uint8Array;
// it must stream as the opaque frame body, untouched, with no meta.error.
Expand Down
7 changes: 7 additions & 0 deletions packages/world-vercel/src/events.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,7 @@ interface SplitEventData {
* object instead.
*/
stack?: string;
cancelReason?: string;
/** Structured executionContext, included verbatim in frame meta. */
executionContext?: Record<string, unknown>;
};
Expand All@@ -223,6 +224,7 @@ type MetaSourceField =
// hook_created webhook flag (renamed to hookIsWebhook on the wire)
| 'isWebhook'
| 'errorCode'
| 'cancelReason'
// step_failed / step_retrying error stack (sibling of the message string)
| 'stack'
| 'executionContext';
Expand DownExpand Up@@ -324,6 +326,11 @@ export function splitEventDataForV4(data: AnyEventRequest): SplitEventData {
if (typeof eventData.stack === 'string') {
meta.stack = eventData.stack;
}
// run_cancelled optionally carries a free-text cancellation reason. Small
// plaintext metadata, so it rides in the frame meta like errorCode.
if (typeof eventData.cancelReason === 'string') {
meta.cancelReason = eventData.cancelReason;
}
if (
eventData.executionContext !== undefined &&
eventData.executionContext !== null &&
Expand Down
50 changes: 50 additions & 0 deletions packages/world/src/events.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
import { describe, expect, it } from 'vitest';
import { CreateEventSchema, EventSchema } from './events';

describe('run_cancelled cancelReason', () => {
it('accepts a run_cancelled create request with no eventData', () => {
const parsed = CreateEventSchema.parse({
eventType: 'run_cancelled',
specVersion: 4,
});
expect(parsed.eventType).toBe('run_cancelled');
});

it('accepts an optional cancelReason on the create request', () => {
const parsed = CreateEventSchema.parse({
eventType: 'run_cancelled',
specVersion: 4,
eventData: { cancelReason: 'superseded by newer run' },
});
expect(parsed.eventType).toBe('run_cancelled');
// eventData is only present on the run_cancelled branch of the union.
expect(
(parsed as { eventData?: { cancelReason?: string } }).eventData
?.cancelReason
).toBe('superseded by newer run');
});

it('rejects a cancelReason longer than 512 chars', () => {
const result = CreateEventSchema.safeParse({
eventType: 'run_cancelled',
specVersion: 4,
eventData: { cancelReason: 'x'.repeat(513) },
});
expect(result.success).toBe(false);
});

it('retains cancelReason when reading back a stored run_cancelled event (not stripped)', () => {
const parsed = EventSchema.parse({
eventType: 'run_cancelled',
runId: 'wrun_00000000000000000000000000',
eventId: 'evnt_00000000000000000000000000',
createdAt: new Date().toISOString(),
specVersion: 4,
eventData: { cancelReason: 'operator cancelled' },
});
expect(
(parsed as { eventData?: { cancelReason?: string } }).eventData
?.cancelReason
).toBe('operator cancelled');
});
});
8 changes: 8 additions & 0 deletions packages/world/src/events.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,14 @@ const RunFailedEventSchema = BaseEventSchema.extend({
*/
const RunCancelledEventSchema = BaseEventSchema.extend({
eventType: z.literal('run_cancelled'),
eventData: z
.object({
// Optional free-text reason for the cancellation. Kept as small
// plaintext metadata (like run_failed's errorCode) so it survives
// resolveData: 'none' and can be displayed without decryption.
cancelReason: z.string().max(512).optional(),
})
.optional(),
});

// Discriminated union for user-creatable events (requests to world.events.create)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Backport #2840: Add optional reason to run cancellation by github-actions[bot] · Pull Request #2843 · vercel/workflow · GitHub
Skip to content
Backport #2840: Add optional reason to run cancellation#2843

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

 Closed

github-actions
wants to merge
1
commit into

from

 Closed


Backport #2840: Add optional reason to run cancellation
#2843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/run-cancel-reason.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@workflow/core': patch
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/web-shared': patch
---

Add an optional reason to run cancellation (`run.cancel({ cancelReason })`), recorded on the cancellation event and shown in the run detail view.

19 changes: 19 additions & 0 deletions
docs/content/docs/api-reference/workflow-api/get-run.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,25 @@ const { stoppedCount } = await run.wakeUp({
});
```

### Cancel a Run

Cancel a workflow run. You can pass an optional free-text `cancelReason` (up to 512 characters) that is recorded on the run's cancellation event and shown in the run detail view:

```typescript lineNumbers
import { getRun } from "workflow/api";

export async function POST(req: Request) {
 const { runId } = await req.json();
 const run = getRun(runId);

 await run.cancel({ cancelReason: "Superseded by a newer submission" }); // [!code highlight]

 return Response.json({ cancelled: true });
}
```

The options object is optional — `await run.cancel()` cancels the run without recording a reason.

## Related Functions

- [`start()`](/docs/api-reference/workflow-api/start) - Start a new workflow and get its run ID.

1 change: 1 addition & 0 deletions
packages/core/src/runtime.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 type WorkflowReadableStreamOptions,
} from './runtime/run.js';
export {
 type CancelRunOptions,
 cancelRun,
 listStreams,
 type ReadStreamOptions,
Expand Down

10 changes: 9 additions & 1 deletion
packages/core/src/runtime/run.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
} from '../serialization.js';
import { getWorkflowRunStreamId } from '../util.js';
import {
 type CancelRunOptions,
 type StopSleepOptions,
 type StopSleepResult,
 wakeUpRun,
Expand DownExpand Up@@ -142,11 +143,18 @@ export class Run<TResult> {

 /**
 * Cancels the workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event, surfaced in
 * the run detail view.
 */
 async cancel(): Promise<void> {
 async cancel(options?: CancelRunOptions): Promise<void> {
 await this.world.events.create(this.runId, {
 eventType: 'run_cancelled',
 specVersion: SPEC_VERSION_CURRENT,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 });
 }

Expand Down

24 changes: 21 additions & 3 deletions
packages/core/src/runtime/runs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,14 @@ export interface StopSleepOptions {
 correlationIds?: string[];
}

export interface CancelRunOptions {
 /**
 * Optional free-text reason for the cancellation (max 512 chars), recorded
 * on the run_cancelled event and surfaced in the run detail view.
 */
 cancelReason?: string;
}

const normalizeWorkflowArgs = (args: unknown): unknown[] => {
 return Array.isArray(args) ? args : [args];
};
Expand DownExpand Up@@ -85,17 +93,27 @@ export async function recreateRunFromExisting(

/**
 * Cancel a workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event.
 */
export async function cancelRun(world: World, runId: string): Promise<void> {
export async function cancelRun(
 world: World,
 runId: string,
 options?: CancelRunOptions
): Promise<void> {
 try {
 const run = await world.runs.get(runId, { resolveData: 'none' });
 const specVersion = run.specVersion ?? SPEC_VERSION_LEGACY;
 const compatMode = isLegacySpecVersion(specVersion);
 const eventData = {
 const eventRequest = {
 eventType: 'run_cancelled' as const,
 specVersion,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 };
 await world.events.create(runId, eventData, { v1Compat: compatMode });
 await world.events.create(runId, eventRequest, { v1Compat: compatMode });
 } catch (err) {
 throw new Error(
 `Failed to cancel run ${runId}: ${err instanceof Error ? err.message : String(err)}`,
Expand Down

21 changes: 21 additions & 0 deletions
packages/web-shared/src/components/event-list-view.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -595,6 +595,27 @@ function PayloadBlock({
 );
 }

 // Cancellation reason — render the free-text reason as a readable line
 // instead of a raw JSON payload (the only field run_cancelled carries).
 if (eventType === 'run_cancelled') {
 const cancelReason =
 cleaned != null &&
 typeof cleaned === 'object' &&
 typeof (cleaned as Record<string, unknown>).cancelReason === 'string'
 ? ((cleaned as Record<string, unknown>).cancelReason as string)
 : null;
 if (cancelReason) {
 return (
 <div className="p-2 text-xs" style={{ color: 'var(--ds-gray-1000)' }}>
 <span style={{ color: 'var(--ds-gray-900)' }}>Reason: </span>
 <span className="whitespace-pre-wrap break-words">
 {cancelReason}
 </span>
 </div>
 );
 }
 }

 return (
 <div className="relative group/payload">
 <div
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api-workflow.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export type {
 CancelRunOptions,
 Event,
 StartOptions,
 StopSleepOptions,
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export {
 type CancelRunOptions,
 type Event,
 getHookByToken,
 getRun,
Expand Down

4 changes: 4 additions & 0 deletions
packages/world-vercel/src/events-v4.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,9 @@ export interface CreateEventV4Input {
 error?: unknown;
 /** Companion stack string for step_failed / step_retrying. */
 stack?: string;
 /** run_cancelled's optional free-text cancellation reason. Small plaintext
 * metadata, capped at 512 chars by the @workflow/world schema. */
 cancelReason?: string;
 /** Arbitrary structured map; rides as a native CBOR object in the
 * frame meta. Bounded by the server at 2 KB encoded. */
 executionContext?: Record<string, unknown>;
Expand DownExpand Up@@ -138,6 +141,7 @@ function buildPostFrameMeta(
 if (input.errorCode !== undefined) meta.errorCode = input.errorCode;
 if (input.error !== undefined) meta.error = input.error;
 if (input.stack !== undefined) meta.stack = input.stack;
 if (input.cancelReason !== undefined) meta.cancelReason = input.cancelReason;
 if (input.executionContext !== undefined) {
 meta.executionContext = input.executionContext;
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,27 @@ describe('splitEventDataForV4 structured errors', () => {
 expect(meta.stack).toBeUndefined();
 });

 it('carries the run_cancelled cancelReason in the frame meta, not the payload', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBe('superseded by newer run');
 });

 it('omits cancelReason from meta when run_cancelled carries no reason', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBeUndefined();
 });

 it('keeps an already-dehydrated (Uint8Array) error on the body path', () => {
 // A runtime that DOES dehydrate errors hands the split a Uint8Array;
 // it must stream as the opaque frame body, untouched, with no meta.error.
Expand Down

7 changes: 7 additions & 0 deletions
packages/world-vercel/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,7 @@ interface SplitEventData {
 * object instead.
 */
 stack?: string;
 cancelReason?: string;
 /** Structured executionContext, included verbatim in frame meta. */
 executionContext?: Record<string, unknown>;
 };
Expand All@@ -223,6 +224,7 @@ type MetaSourceField =
 // hook_created webhook flag (renamed to hookIsWebhook on the wire)
 | 'isWebhook'
 | 'errorCode'
 | 'cancelReason'
 // step_failed / step_retrying error stack (sibling of the message string)
 | 'stack'
 | 'executionContext';
Expand DownExpand Up@@ -324,6 +326,11 @@ export function splitEventDataForV4(data: AnyEventRequest): SplitEventData {
 if (typeof eventData.stack === 'string') {
 meta.stack = eventData.stack;
 }
 // run_cancelled optionally carries a free-text cancellation reason. Small
 // plaintext metadata, so it rides in the frame meta like errorCode.
 if (typeof eventData.cancelReason === 'string') {
 meta.cancelReason = eventData.cancelReason;
 }
 if (
 eventData.executionContext !== undefined &&
 eventData.executionContext !== null &&
Expand Down

50 changes: 50 additions & 0 deletions
packages/world/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
import { describe, expect, it } from 'vitest';
import { CreateEventSchema, EventSchema } from './events';

describe('run_cancelled cancelReason', () => {
 it('accepts a run_cancelled create request with no eventData', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 });
 expect(parsed.eventType).toBe('run_cancelled');
 });

 it('accepts an optional cancelReason on the create request', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 });
 expect(parsed.eventType).toBe('run_cancelled');
 // eventData is only present on the run_cancelled branch of the union.
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('superseded by newer run');
 });

 it('rejects a cancelReason longer than 512 chars', () => {
 const result = CreateEventSchema.safeParse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'x'.repeat(513) },
 });
 expect(result.success).toBe(false);
 });

 it('retains cancelReason when reading back a stored run_cancelled event (not stripped)', () => {
 const parsed = EventSchema.parse({
 eventType: 'run_cancelled',
 runId: 'wrun_00000000000000000000000000',
 eventId: 'evnt_00000000000000000000000000',
 createdAt: new Date().toISOString(),
 specVersion: 4,
 eventData: { cancelReason: 'operator cancelled' },
 });
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('operator cancelled');
 });
});

8 changes: 8 additions & 0 deletions
packages/world/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,14 @@ const RunFailedEventSchema = BaseEventSchema.extend({
 */
const RunCancelledEventSchema = BaseEventSchema.extend({
 eventType: z.literal('run_cancelled'),
 eventData: z
 .object({
 // Optional free-text reason for the cancellation. Kept as small
 // plaintext metadata (like run_failed's errorCode) so it survives
 // resolveData: 'none' and can be displayed without decryption.
 cancelReason: z.string().max(512).optional(),
 })
 .optional(),
});

// Discriminated union for user-creatable events (requests to world.events.create)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Backport #2840: Add optional reason to run cancellation by github-actions[bot] · Pull Request #2843 · vercel/workflow · GitHub
Skip to content
Backport #2840: Add optional reason to run cancellation#2843

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

 Closed

github-actions
wants to merge
1
commit into

from

 Closed


Backport #2840: Add optional reason to run cancellation
#2843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/run-cancel-reason.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@workflow/core': patch
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/web-shared': patch
---

Add an optional reason to run cancellation (`run.cancel({ cancelReason })`), recorded on the cancellation event and shown in the run detail view.

19 changes: 19 additions & 0 deletions
docs/content/docs/api-reference/workflow-api/get-run.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,25 @@ const { stoppedCount } = await run.wakeUp({
});
```

### Cancel a Run

Cancel a workflow run. You can pass an optional free-text `cancelReason` (up to 512 characters) that is recorded on the run's cancellation event and shown in the run detail view:

```typescript lineNumbers
import { getRun } from "workflow/api";

export async function POST(req: Request) {
 const { runId } = await req.json();
 const run = getRun(runId);

 await run.cancel({ cancelReason: "Superseded by a newer submission" }); // [!code highlight]

 return Response.json({ cancelled: true });
}
```

The options object is optional — `await run.cancel()` cancels the run without recording a reason.

## Related Functions

- [`start()`](/docs/api-reference/workflow-api/start) - Start a new workflow and get its run ID.

1 change: 1 addition & 0 deletions
packages/core/src/runtime.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 type WorkflowReadableStreamOptions,
} from './runtime/run.js';
export {
 type CancelRunOptions,
 cancelRun,
 listStreams,
 type ReadStreamOptions,
Expand Down

10 changes: 9 additions & 1 deletion
packages/core/src/runtime/run.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
} from '../serialization.js';
import { getWorkflowRunStreamId } from '../util.js';
import {
 type CancelRunOptions,
 type StopSleepOptions,
 type StopSleepResult,
 wakeUpRun,
Expand DownExpand Up@@ -142,11 +143,18 @@ export class Run<TResult> {

 /**
 * Cancels the workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event, surfaced in
 * the run detail view.
 */
 async cancel(): Promise<void> {
 async cancel(options?: CancelRunOptions): Promise<void> {
 await this.world.events.create(this.runId, {
 eventType: 'run_cancelled',
 specVersion: SPEC_VERSION_CURRENT,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 });
 }

Expand Down

24 changes: 21 additions & 3 deletions
packages/core/src/runtime/runs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,14 @@ export interface StopSleepOptions {
 correlationIds?: string[];
}

export interface CancelRunOptions {
 /**
 * Optional free-text reason for the cancellation (max 512 chars), recorded
 * on the run_cancelled event and surfaced in the run detail view.
 */
 cancelReason?: string;
}

const normalizeWorkflowArgs = (args: unknown): unknown[] => {
 return Array.isArray(args) ? args : [args];
};
Expand DownExpand Up@@ -85,17 +93,27 @@ export async function recreateRunFromExisting(

/**
 * Cancel a workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event.
 */
export async function cancelRun(world: World, runId: string): Promise<void> {
export async function cancelRun(
 world: World,
 runId: string,
 options?: CancelRunOptions
): Promise<void> {
 try {
 const run = await world.runs.get(runId, { resolveData: 'none' });
 const specVersion = run.specVersion ?? SPEC_VERSION_LEGACY;
 const compatMode = isLegacySpecVersion(specVersion);
 const eventData = {
 const eventRequest = {
 eventType: 'run_cancelled' as const,
 specVersion,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 };
 await world.events.create(runId, eventData, { v1Compat: compatMode });
 await world.events.create(runId, eventRequest, { v1Compat: compatMode });
 } catch (err) {
 throw new Error(
 `Failed to cancel run ${runId}: ${err instanceof Error ? err.message : String(err)}`,
Expand Down

21 changes: 21 additions & 0 deletions
packages/web-shared/src/components/event-list-view.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -595,6 +595,27 @@ function PayloadBlock({
 );
 }

 // Cancellation reason — render the free-text reason as a readable line
 // instead of a raw JSON payload (the only field run_cancelled carries).
 if (eventType === 'run_cancelled') {
 const cancelReason =
 cleaned != null &&
 typeof cleaned === 'object' &&
 typeof (cleaned as Record<string, unknown>).cancelReason === 'string'
 ? ((cleaned as Record<string, unknown>).cancelReason as string)
 : null;
 if (cancelReason) {
 return (
 <div className="p-2 text-xs" style={{ color: 'var(--ds-gray-1000)' }}>
 <span style={{ color: 'var(--ds-gray-900)' }}>Reason: </span>
 <span className="whitespace-pre-wrap break-words">
 {cancelReason}
 </span>
 </div>
 );
 }
 }

 return (
 <div className="relative group/payload">
 <div
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api-workflow.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export type {
 CancelRunOptions,
 Event,
 StartOptions,
 StopSleepOptions,
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export {
 type CancelRunOptions,
 type Event,
 getHookByToken,
 getRun,
Expand Down

4 changes: 4 additions & 0 deletions
packages/world-vercel/src/events-v4.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,9 @@ export interface CreateEventV4Input {
 error?: unknown;
 /** Companion stack string for step_failed / step_retrying. */
 stack?: string;
 /** run_cancelled's optional free-text cancellation reason. Small plaintext
 * metadata, capped at 512 chars by the @workflow/world schema. */
 cancelReason?: string;
 /** Arbitrary structured map; rides as a native CBOR object in the
 * frame meta. Bounded by the server at 2 KB encoded. */
 executionContext?: Record<string, unknown>;
Expand DownExpand Up@@ -138,6 +141,7 @@ function buildPostFrameMeta(
 if (input.errorCode !== undefined) meta.errorCode = input.errorCode;
 if (input.error !== undefined) meta.error = input.error;
 if (input.stack !== undefined) meta.stack = input.stack;
 if (input.cancelReason !== undefined) meta.cancelReason = input.cancelReason;
 if (input.executionContext !== undefined) {
 meta.executionContext = input.executionContext;
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,27 @@ describe('splitEventDataForV4 structured errors', () => {
 expect(meta.stack).toBeUndefined();
 });

 it('carries the run_cancelled cancelReason in the frame meta, not the payload', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBe('superseded by newer run');
 });

 it('omits cancelReason from meta when run_cancelled carries no reason', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBeUndefined();
 });

 it('keeps an already-dehydrated (Uint8Array) error on the body path', () => {
 // A runtime that DOES dehydrate errors hands the split a Uint8Array;
 // it must stream as the opaque frame body, untouched, with no meta.error.
Expand Down

7 changes: 7 additions & 0 deletions
packages/world-vercel/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,7 @@ interface SplitEventData {
 * object instead.
 */
 stack?: string;
 cancelReason?: string;
 /** Structured executionContext, included verbatim in frame meta. */
 executionContext?: Record<string, unknown>;
 };
Expand All@@ -223,6 +224,7 @@ type MetaSourceField =
 // hook_created webhook flag (renamed to hookIsWebhook on the wire)
 | 'isWebhook'
 | 'errorCode'
 | 'cancelReason'
 // step_failed / step_retrying error stack (sibling of the message string)
 | 'stack'
 | 'executionContext';
Expand DownExpand Up@@ -324,6 +326,11 @@ export function splitEventDataForV4(data: AnyEventRequest): SplitEventData {
 if (typeof eventData.stack === 'string') {
 meta.stack = eventData.stack;
 }
 // run_cancelled optionally carries a free-text cancellation reason. Small
 // plaintext metadata, so it rides in the frame meta like errorCode.
 if (typeof eventData.cancelReason === 'string') {
 meta.cancelReason = eventData.cancelReason;
 }
 if (
 eventData.executionContext !== undefined &&
 eventData.executionContext !== null &&
Expand Down

50 changes: 50 additions & 0 deletions
packages/world/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
import { describe, expect, it } from 'vitest';
import { CreateEventSchema, EventSchema } from './events';

describe('run_cancelled cancelReason', () => {
 it('accepts a run_cancelled create request with no eventData', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 });
 expect(parsed.eventType).toBe('run_cancelled');
 });

 it('accepts an optional cancelReason on the create request', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 });
 expect(parsed.eventType).toBe('run_cancelled');
 // eventData is only present on the run_cancelled branch of the union.
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('superseded by newer run');
 });

 it('rejects a cancelReason longer than 512 chars', () => {
 const result = CreateEventSchema.safeParse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'x'.repeat(513) },
 });
 expect(result.success).toBe(false);
 });

 it('retains cancelReason when reading back a stored run_cancelled event (not stripped)', () => {
 const parsed = EventSchema.parse({
 eventType: 'run_cancelled',
 runId: 'wrun_00000000000000000000000000',
 eventId: 'evnt_00000000000000000000000000',
 createdAt: new Date().toISOString(),
 specVersion: 4,
 eventData: { cancelReason: 'operator cancelled' },
 });
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('operator cancelled');
 });
});

8 changes: 8 additions & 0 deletions
packages/world/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,14 @@ const RunFailedEventSchema = BaseEventSchema.extend({
 */
const RunCancelledEventSchema = BaseEventSchema.extend({
 eventType: z.literal('run_cancelled'),
 eventData: z
 .object({
 // Optional free-text reason for the cancellation. Kept as small
 // plaintext metadata (like run_failed's errorCode) so it survives
 // resolveData: 'none' and can be displayed without decryption.
 cancelReason: z.string().max(512).optional(),
 })
 .optional(),
});

// Discriminated union for user-creatable events (requests to world.events.create)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Backport #2840: Add optional reason to run cancellation by github-actions[bot] · Pull Request #2843 · vercel/workflow · GitHub
Skip to content
Backport #2840: Add optional reason to run cancellation#2843

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

 Closed

github-actions
wants to merge
1
commit into

from

 Closed


Backport #2840: Add optional reason to run cancellation
#2843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/run-cancel-reason.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@workflow/core': patch
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/web-shared': patch
---

Add an optional reason to run cancellation (`run.cancel({ cancelReason })`), recorded on the cancellation event and shown in the run detail view.

19 changes: 19 additions & 0 deletions
docs/content/docs/api-reference/workflow-api/get-run.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,25 @@ const { stoppedCount } = await run.wakeUp({
});
```

### Cancel a Run

Cancel a workflow run. You can pass an optional free-text `cancelReason` (up to 512 characters) that is recorded on the run's cancellation event and shown in the run detail view:

```typescript lineNumbers
import { getRun } from "workflow/api";

export async function POST(req: Request) {
 const { runId } = await req.json();
 const run = getRun(runId);

 await run.cancel({ cancelReason: "Superseded by a newer submission" }); // [!code highlight]

 return Response.json({ cancelled: true });
}
```

The options object is optional — `await run.cancel()` cancels the run without recording a reason.

## Related Functions

- [`start()`](/docs/api-reference/workflow-api/start) - Start a new workflow and get its run ID.

1 change: 1 addition & 0 deletions
packages/core/src/runtime.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 type WorkflowReadableStreamOptions,
} from './runtime/run.js';
export {
 type CancelRunOptions,
 cancelRun,
 listStreams,
 type ReadStreamOptions,
Expand Down

10 changes: 9 additions & 1 deletion
packages/core/src/runtime/run.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
} from '../serialization.js';
import { getWorkflowRunStreamId } from '../util.js';
import {
 type CancelRunOptions,
 type StopSleepOptions,
 type StopSleepResult,
 wakeUpRun,
Expand DownExpand Up@@ -142,11 +143,18 @@ export class Run<TResult> {

 /**
 * Cancels the workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event, surfaced in
 * the run detail view.
 */
 async cancel(): Promise<void> {
 async cancel(options?: CancelRunOptions): Promise<void> {
 await this.world.events.create(this.runId, {
 eventType: 'run_cancelled',
 specVersion: SPEC_VERSION_CURRENT,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 });
 }

Expand Down

24 changes: 21 additions & 3 deletions
packages/core/src/runtime/runs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,14 @@ export interface StopSleepOptions {
 correlationIds?: string[];
}

export interface CancelRunOptions {
 /**
 * Optional free-text reason for the cancellation (max 512 chars), recorded
 * on the run_cancelled event and surfaced in the run detail view.
 */
 cancelReason?: string;
}

const normalizeWorkflowArgs = (args: unknown): unknown[] => {
 return Array.isArray(args) ? args : [args];
};
Expand DownExpand Up@@ -85,17 +93,27 @@ export async function recreateRunFromExisting(

/**
 * Cancel a workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event.
 */
export async function cancelRun(world: World, runId: string): Promise<void> {
export async function cancelRun(
 world: World,
 runId: string,
 options?: CancelRunOptions
): Promise<void> {
 try {
 const run = await world.runs.get(runId, { resolveData: 'none' });
 const specVersion = run.specVersion ?? SPEC_VERSION_LEGACY;
 const compatMode = isLegacySpecVersion(specVersion);
 const eventData = {
 const eventRequest = {
 eventType: 'run_cancelled' as const,
 specVersion,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 };
 await world.events.create(runId, eventData, { v1Compat: compatMode });
 await world.events.create(runId, eventRequest, { v1Compat: compatMode });
 } catch (err) {
 throw new Error(
 `Failed to cancel run ${runId}: ${err instanceof Error ? err.message : String(err)}`,
Expand Down

21 changes: 21 additions & 0 deletions
packages/web-shared/src/components/event-list-view.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -595,6 +595,27 @@ function PayloadBlock({
 );
 }

 // Cancellation reason — render the free-text reason as a readable line
 // instead of a raw JSON payload (the only field run_cancelled carries).
 if (eventType === 'run_cancelled') {
 const cancelReason =
 cleaned != null &&
 typeof cleaned === 'object' &&
 typeof (cleaned as Record<string, unknown>).cancelReason === 'string'
 ? ((cleaned as Record<string, unknown>).cancelReason as string)
 : null;
 if (cancelReason) {
 return (
 <div className="p-2 text-xs" style={{ color: 'var(--ds-gray-1000)' }}>
 <span style={{ color: 'var(--ds-gray-900)' }}>Reason: </span>
 <span className="whitespace-pre-wrap break-words">
 {cancelReason}
 </span>
 </div>
 );
 }
 }

 return (
 <div className="relative group/payload">
 <div
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api-workflow.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export type {
 CancelRunOptions,
 Event,
 StartOptions,
 StopSleepOptions,
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export {
 type CancelRunOptions,
 type Event,
 getHookByToken,
 getRun,
Expand Down

4 changes: 4 additions & 0 deletions
packages/world-vercel/src/events-v4.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,9 @@ export interface CreateEventV4Input {
 error?: unknown;
 /** Companion stack string for step_failed / step_retrying. */
 stack?: string;
 /** run_cancelled's optional free-text cancellation reason. Small plaintext
 * metadata, capped at 512 chars by the @workflow/world schema. */
 cancelReason?: string;
 /** Arbitrary structured map; rides as a native CBOR object in the
 * frame meta. Bounded by the server at 2 KB encoded. */
 executionContext?: Record<string, unknown>;
Expand DownExpand Up@@ -138,6 +141,7 @@ function buildPostFrameMeta(
 if (input.errorCode !== undefined) meta.errorCode = input.errorCode;
 if (input.error !== undefined) meta.error = input.error;
 if (input.stack !== undefined) meta.stack = input.stack;
 if (input.cancelReason !== undefined) meta.cancelReason = input.cancelReason;
 if (input.executionContext !== undefined) {
 meta.executionContext = input.executionContext;
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,27 @@ describe('splitEventDataForV4 structured errors', () => {
 expect(meta.stack).toBeUndefined();
 });

 it('carries the run_cancelled cancelReason in the frame meta, not the payload', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBe('superseded by newer run');
 });

 it('omits cancelReason from meta when run_cancelled carries no reason', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBeUndefined();
 });

 it('keeps an already-dehydrated (Uint8Array) error on the body path', () => {
 // A runtime that DOES dehydrate errors hands the split a Uint8Array;
 // it must stream as the opaque frame body, untouched, with no meta.error.
Expand Down

7 changes: 7 additions & 0 deletions
packages/world-vercel/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,7 @@ interface SplitEventData {
 * object instead.
 */
 stack?: string;
 cancelReason?: string;
 /** Structured executionContext, included verbatim in frame meta. */
 executionContext?: Record<string, unknown>;
 };
Expand All@@ -223,6 +224,7 @@ type MetaSourceField =
 // hook_created webhook flag (renamed to hookIsWebhook on the wire)
 | 'isWebhook'
 | 'errorCode'
 | 'cancelReason'
 // step_failed / step_retrying error stack (sibling of the message string)
 | 'stack'
 | 'executionContext';
Expand DownExpand Up@@ -324,6 +326,11 @@ export function splitEventDataForV4(data: AnyEventRequest): SplitEventData {
 if (typeof eventData.stack === 'string') {
 meta.stack = eventData.stack;
 }
 // run_cancelled optionally carries a free-text cancellation reason. Small
 // plaintext metadata, so it rides in the frame meta like errorCode.
 if (typeof eventData.cancelReason === 'string') {
 meta.cancelReason = eventData.cancelReason;
 }
 if (
 eventData.executionContext !== undefined &&
 eventData.executionContext !== null &&
Expand Down

50 changes: 50 additions & 0 deletions
packages/world/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
import { describe, expect, it } from 'vitest';
import { CreateEventSchema, EventSchema } from './events';

describe('run_cancelled cancelReason', () => {
 it('accepts a run_cancelled create request with no eventData', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 });
 expect(parsed.eventType).toBe('run_cancelled');
 });

 it('accepts an optional cancelReason on the create request', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 });
 expect(parsed.eventType).toBe('run_cancelled');
 // eventData is only present on the run_cancelled branch of the union.
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('superseded by newer run');
 });

 it('rejects a cancelReason longer than 512 chars', () => {
 const result = CreateEventSchema.safeParse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'x'.repeat(513) },
 });
 expect(result.success).toBe(false);
 });

 it('retains cancelReason when reading back a stored run_cancelled event (not stripped)', () => {
 const parsed = EventSchema.parse({
 eventType: 'run_cancelled',
 runId: 'wrun_00000000000000000000000000',
 eventId: 'evnt_00000000000000000000000000',
 createdAt: new Date().toISOString(),
 specVersion: 4,
 eventData: { cancelReason: 'operator cancelled' },
 });
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('operator cancelled');
 });
});

8 changes: 8 additions & 0 deletions
packages/world/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,14 @@ const RunFailedEventSchema = BaseEventSchema.extend({
 */
const RunCancelledEventSchema = BaseEventSchema.extend({
 eventType: z.literal('run_cancelled'),
 eventData: z
 .object({
 // Optional free-text reason for the cancellation. Kept as small
 // plaintext metadata (like run_failed's errorCode) so it survives
 // resolveData: 'none' and can be displayed without decryption.
 cancelReason: z.string().max(512).optional(),
 })
 .optional(),
});

// Discriminated union for user-creatable events (requests to world.events.create)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Backport #2840: Add optional reason to run cancellation by github-actions[bot] · Pull Request #2843 · vercel/workflow · GitHub
Skip to content
Backport #2840: Add optional reason to run cancellation#2843

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

 Closed

github-actions
wants to merge
1
commit into

from

 Closed


Backport #2840: Add optional reason to run cancellation
#2843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/run-cancel-reason.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@workflow/core': patch
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/web-shared': patch
---

Add an optional reason to run cancellation (`run.cancel({ cancelReason })`), recorded on the cancellation event and shown in the run detail view.

19 changes: 19 additions & 0 deletions
docs/content/docs/api-reference/workflow-api/get-run.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,25 @@ const { stoppedCount } = await run.wakeUp({
});
```

### Cancel a Run

Cancel a workflow run. You can pass an optional free-text `cancelReason` (up to 512 characters) that is recorded on the run's cancellation event and shown in the run detail view:

```typescript lineNumbers
import { getRun } from "workflow/api";

export async function POST(req: Request) {
 const { runId } = await req.json();
 const run = getRun(runId);

 await run.cancel({ cancelReason: "Superseded by a newer submission" }); // [!code highlight]

 return Response.json({ cancelled: true });
}
```

The options object is optional — `await run.cancel()` cancels the run without recording a reason.

## Related Functions

- [`start()`](/docs/api-reference/workflow-api/start) - Start a new workflow and get its run ID.

1 change: 1 addition & 0 deletions
packages/core/src/runtime.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 type WorkflowReadableStreamOptions,
} from './runtime/run.js';
export {
 type CancelRunOptions,
 cancelRun,
 listStreams,
 type ReadStreamOptions,
Expand Down

10 changes: 9 additions & 1 deletion
packages/core/src/runtime/run.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
} from '../serialization.js';
import { getWorkflowRunStreamId } from '../util.js';
import {
 type CancelRunOptions,
 type StopSleepOptions,
 type StopSleepResult,
 wakeUpRun,
Expand DownExpand Up@@ -142,11 +143,18 @@ export class Run<TResult> {

 /**
 * Cancels the workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event, surfaced in
 * the run detail view.
 */
 async cancel(): Promise<void> {
 async cancel(options?: CancelRunOptions): Promise<void> {
 await this.world.events.create(this.runId, {
 eventType: 'run_cancelled',
 specVersion: SPEC_VERSION_CURRENT,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 });
 }

Expand Down

24 changes: 21 additions & 3 deletions
packages/core/src/runtime/runs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,14 @@ export interface StopSleepOptions {
 correlationIds?: string[];
}

export interface CancelRunOptions {
 /**
 * Optional free-text reason for the cancellation (max 512 chars), recorded
 * on the run_cancelled event and surfaced in the run detail view.
 */
 cancelReason?: string;
}

const normalizeWorkflowArgs = (args: unknown): unknown[] => {
 return Array.isArray(args) ? args : [args];
};
Expand DownExpand Up@@ -85,17 +93,27 @@ export async function recreateRunFromExisting(

/**
 * Cancel a workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event.
 */
export async function cancelRun(world: World, runId: string): Promise<void> {
export async function cancelRun(
 world: World,
 runId: string,
 options?: CancelRunOptions
): Promise<void> {
 try {
 const run = await world.runs.get(runId, { resolveData: 'none' });
 const specVersion = run.specVersion ?? SPEC_VERSION_LEGACY;
 const compatMode = isLegacySpecVersion(specVersion);
 const eventData = {
 const eventRequest = {
 eventType: 'run_cancelled' as const,
 specVersion,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 };
 await world.events.create(runId, eventData, { v1Compat: compatMode });
 await world.events.create(runId, eventRequest, { v1Compat: compatMode });
 } catch (err) {
 throw new Error(
 `Failed to cancel run ${runId}: ${err instanceof Error ? err.message : String(err)}`,
Expand Down

21 changes: 21 additions & 0 deletions
packages/web-shared/src/components/event-list-view.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -595,6 +595,27 @@ function PayloadBlock({
 );
 }

 // Cancellation reason — render the free-text reason as a readable line
 // instead of a raw JSON payload (the only field run_cancelled carries).
 if (eventType === 'run_cancelled') {
 const cancelReason =
 cleaned != null &&
 typeof cleaned === 'object' &&
 typeof (cleaned as Record<string, unknown>).cancelReason === 'string'
 ? ((cleaned as Record<string, unknown>).cancelReason as string)
 : null;
 if (cancelReason) {
 return (
 <div className="p-2 text-xs" style={{ color: 'var(--ds-gray-1000)' }}>
 <span style={{ color: 'var(--ds-gray-900)' }}>Reason: </span>
 <span className="whitespace-pre-wrap break-words">
 {cancelReason}
 </span>
 </div>
 );
 }
 }

 return (
 <div className="relative group/payload">
 <div
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api-workflow.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export type {
 CancelRunOptions,
 Event,
 StartOptions,
 StopSleepOptions,
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export {
 type CancelRunOptions,
 type Event,
 getHookByToken,
 getRun,
Expand Down

4 changes: 4 additions & 0 deletions
packages/world-vercel/src/events-v4.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,9 @@ export interface CreateEventV4Input {
 error?: unknown;
 /** Companion stack string for step_failed / step_retrying. */
 stack?: string;
 /** run_cancelled's optional free-text cancellation reason. Small plaintext
 * metadata, capped at 512 chars by the @workflow/world schema. */
 cancelReason?: string;
 /** Arbitrary structured map; rides as a native CBOR object in the
 * frame meta. Bounded by the server at 2 KB encoded. */
 executionContext?: Record<string, unknown>;
Expand DownExpand Up@@ -138,6 +141,7 @@ function buildPostFrameMeta(
 if (input.errorCode !== undefined) meta.errorCode = input.errorCode;
 if (input.error !== undefined) meta.error = input.error;
 if (input.stack !== undefined) meta.stack = input.stack;
 if (input.cancelReason !== undefined) meta.cancelReason = input.cancelReason;
 if (input.executionContext !== undefined) {
 meta.executionContext = input.executionContext;
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,27 @@ describe('splitEventDataForV4 structured errors', () => {
 expect(meta.stack).toBeUndefined();
 });

 it('carries the run_cancelled cancelReason in the frame meta, not the payload', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBe('superseded by newer run');
 });

 it('omits cancelReason from meta when run_cancelled carries no reason', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBeUndefined();
 });

 it('keeps an already-dehydrated (Uint8Array) error on the body path', () => {
 // A runtime that DOES dehydrate errors hands the split a Uint8Array;
 // it must stream as the opaque frame body, untouched, with no meta.error.
Expand Down

7 changes: 7 additions & 0 deletions
packages/world-vercel/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,7 @@ interface SplitEventData {
 * object instead.
 */
 stack?: string;
 cancelReason?: string;
 /** Structured executionContext, included verbatim in frame meta. */
 executionContext?: Record<string, unknown>;
 };
Expand All@@ -223,6 +224,7 @@ type MetaSourceField =
 // hook_created webhook flag (renamed to hookIsWebhook on the wire)
 | 'isWebhook'
 | 'errorCode'
 | 'cancelReason'
 // step_failed / step_retrying error stack (sibling of the message string)
 | 'stack'
 | 'executionContext';
Expand DownExpand Up@@ -324,6 +326,11 @@ export function splitEventDataForV4(data: AnyEventRequest): SplitEventData {
 if (typeof eventData.stack === 'string') {
 meta.stack = eventData.stack;
 }
 // run_cancelled optionally carries a free-text cancellation reason. Small
 // plaintext metadata, so it rides in the frame meta like errorCode.
 if (typeof eventData.cancelReason === 'string') {
 meta.cancelReason = eventData.cancelReason;
 }
 if (
 eventData.executionContext !== undefined &&
 eventData.executionContext !== null &&
Expand Down

50 changes: 50 additions & 0 deletions
packages/world/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
import { describe, expect, it } from 'vitest';
import { CreateEventSchema, EventSchema } from './events';

describe('run_cancelled cancelReason', () => {
 it('accepts a run_cancelled create request with no eventData', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 });
 expect(parsed.eventType).toBe('run_cancelled');
 });

 it('accepts an optional cancelReason on the create request', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 });
 expect(parsed.eventType).toBe('run_cancelled');
 // eventData is only present on the run_cancelled branch of the union.
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('superseded by newer run');
 });

 it('rejects a cancelReason longer than 512 chars', () => {
 const result = CreateEventSchema.safeParse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'x'.repeat(513) },
 });
 expect(result.success).toBe(false);
 });

 it('retains cancelReason when reading back a stored run_cancelled event (not stripped)', () => {
 const parsed = EventSchema.parse({
 eventType: 'run_cancelled',
 runId: 'wrun_00000000000000000000000000',
 eventId: 'evnt_00000000000000000000000000',
 createdAt: new Date().toISOString(),
 specVersion: 4,
 eventData: { cancelReason: 'operator cancelled' },
 });
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('operator cancelled');
 });
});

8 changes: 8 additions & 0 deletions
packages/world/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,14 @@ const RunFailedEventSchema = BaseEventSchema.extend({
 */
const RunCancelledEventSchema = BaseEventSchema.extend({
 eventType: z.literal('run_cancelled'),
 eventData: z
 .object({
 // Optional free-text reason for the cancellation. Kept as small
 // plaintext metadata (like run_failed's errorCode) so it survives
 // resolveData: 'none' and can be displayed without decryption.
 cancelReason: z.string().max(512).optional(),
 })
 .optional(),
});

// Discriminated union for user-creatable events (requests to world.events.create)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Backport #2840: Add optional reason to run cancellation by github-actions[bot] · Pull Request #2843 · vercel/workflow · GitHub
Skip to content
Backport #2840: Add optional reason to run cancellation#2843

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

 Closed

github-actions
wants to merge
1
commit into

from

 Closed


Backport #2840: Add optional reason to run cancellation
#2843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/run-cancel-reason.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@workflow/core': patch
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/web-shared': patch
---

Add an optional reason to run cancellation (`run.cancel({ cancelReason })`), recorded on the cancellation event and shown in the run detail view.

19 changes: 19 additions & 0 deletions
docs/content/docs/api-reference/workflow-api/get-run.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,25 @@ const { stoppedCount } = await run.wakeUp({
});
```

### Cancel a Run

Cancel a workflow run. You can pass an optional free-text `cancelReason` (up to 512 characters) that is recorded on the run's cancellation event and shown in the run detail view:

```typescript lineNumbers
import { getRun } from "workflow/api";

export async function POST(req: Request) {
 const { runId } = await req.json();
 const run = getRun(runId);

 await run.cancel({ cancelReason: "Superseded by a newer submission" }); // [!code highlight]

 return Response.json({ cancelled: true });
}
```

The options object is optional — `await run.cancel()` cancels the run without recording a reason.

## Related Functions

- [`start()`](/docs/api-reference/workflow-api/start) - Start a new workflow and get its run ID.

1 change: 1 addition & 0 deletions
packages/core/src/runtime.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 type WorkflowReadableStreamOptions,
} from './runtime/run.js';
export {
 type CancelRunOptions,
 cancelRun,
 listStreams,
 type ReadStreamOptions,
Expand Down

10 changes: 9 additions & 1 deletion
packages/core/src/runtime/run.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
} from '../serialization.js';
import { getWorkflowRunStreamId } from '../util.js';
import {
 type CancelRunOptions,
 type StopSleepOptions,
 type StopSleepResult,
 wakeUpRun,
Expand DownExpand Up@@ -142,11 +143,18 @@ export class Run<TResult> {

 /**
 * Cancels the workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event, surfaced in
 * the run detail view.
 */
 async cancel(): Promise<void> {
 async cancel(options?: CancelRunOptions): Promise<void> {
 await this.world.events.create(this.runId, {
 eventType: 'run_cancelled',
 specVersion: SPEC_VERSION_CURRENT,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 });
 }

Expand Down

24 changes: 21 additions & 3 deletions
packages/core/src/runtime/runs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,14 @@ export interface StopSleepOptions {
 correlationIds?: string[];
}

export interface CancelRunOptions {
 /**
 * Optional free-text reason for the cancellation (max 512 chars), recorded
 * on the run_cancelled event and surfaced in the run detail view.
 */
 cancelReason?: string;
}

const normalizeWorkflowArgs = (args: unknown): unknown[] => {
 return Array.isArray(args) ? args : [args];
};
Expand DownExpand Up@@ -85,17 +93,27 @@ export async function recreateRunFromExisting(

/**
 * Cancel a workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event.
 */
export async function cancelRun(world: World, runId: string): Promise<void> {
export async function cancelRun(
 world: World,
 runId: string,
 options?: CancelRunOptions
): Promise<void> {
 try {
 const run = await world.runs.get(runId, { resolveData: 'none' });
 const specVersion = run.specVersion ?? SPEC_VERSION_LEGACY;
 const compatMode = isLegacySpecVersion(specVersion);
 const eventData = {
 const eventRequest = {
 eventType: 'run_cancelled' as const,
 specVersion,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 };
 await world.events.create(runId, eventData, { v1Compat: compatMode });
 await world.events.create(runId, eventRequest, { v1Compat: compatMode });
 } catch (err) {
 throw new Error(
 `Failed to cancel run ${runId}: ${err instanceof Error ? err.message : String(err)}`,
Expand Down

21 changes: 21 additions & 0 deletions
packages/web-shared/src/components/event-list-view.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -595,6 +595,27 @@ function PayloadBlock({
 );
 }

 // Cancellation reason — render the free-text reason as a readable line
 // instead of a raw JSON payload (the only field run_cancelled carries).
 if (eventType === 'run_cancelled') {
 const cancelReason =
 cleaned != null &&
 typeof cleaned === 'object' &&
 typeof (cleaned as Record<string, unknown>).cancelReason === 'string'
 ? ((cleaned as Record<string, unknown>).cancelReason as string)
 : null;
 if (cancelReason) {
 return (
 <div className="p-2 text-xs" style={{ color: 'var(--ds-gray-1000)' }}>
 <span style={{ color: 'var(--ds-gray-900)' }}>Reason: </span>
 <span className="whitespace-pre-wrap break-words">
 {cancelReason}
 </span>
 </div>
 );
 }
 }

 return (
 <div className="relative group/payload">
 <div
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api-workflow.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export type {
 CancelRunOptions,
 Event,
 StartOptions,
 StopSleepOptions,
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export {
 type CancelRunOptions,
 type Event,
 getHookByToken,
 getRun,
Expand Down

4 changes: 4 additions & 0 deletions
packages/world-vercel/src/events-v4.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,9 @@ export interface CreateEventV4Input {
 error?: unknown;
 /** Companion stack string for step_failed / step_retrying. */
 stack?: string;
 /** run_cancelled's optional free-text cancellation reason. Small plaintext
 * metadata, capped at 512 chars by the @workflow/world schema. */
 cancelReason?: string;
 /** Arbitrary structured map; rides as a native CBOR object in the
 * frame meta. Bounded by the server at 2 KB encoded. */
 executionContext?: Record<string, unknown>;
Expand DownExpand Up@@ -138,6 +141,7 @@ function buildPostFrameMeta(
 if (input.errorCode !== undefined) meta.errorCode = input.errorCode;
 if (input.error !== undefined) meta.error = input.error;
 if (input.stack !== undefined) meta.stack = input.stack;
 if (input.cancelReason !== undefined) meta.cancelReason = input.cancelReason;
 if (input.executionContext !== undefined) {
 meta.executionContext = input.executionContext;
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,27 @@ describe('splitEventDataForV4 structured errors', () => {
 expect(meta.stack).toBeUndefined();
 });

 it('carries the run_cancelled cancelReason in the frame meta, not the payload', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBe('superseded by newer run');
 });

 it('omits cancelReason from meta when run_cancelled carries no reason', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBeUndefined();
 });

 it('keeps an already-dehydrated (Uint8Array) error on the body path', () => {
 // A runtime that DOES dehydrate errors hands the split a Uint8Array;
 // it must stream as the opaque frame body, untouched, with no meta.error.
Expand Down

7 changes: 7 additions & 0 deletions
packages/world-vercel/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,7 @@ interface SplitEventData {
 * object instead.
 */
 stack?: string;
 cancelReason?: string;
 /** Structured executionContext, included verbatim in frame meta. */
 executionContext?: Record<string, unknown>;
 };
Expand All@@ -223,6 +224,7 @@ type MetaSourceField =
 // hook_created webhook flag (renamed to hookIsWebhook on the wire)
 | 'isWebhook'
 | 'errorCode'
 | 'cancelReason'
 // step_failed / step_retrying error stack (sibling of the message string)
 | 'stack'
 | 'executionContext';
Expand DownExpand Up@@ -324,6 +326,11 @@ export function splitEventDataForV4(data: AnyEventRequest): SplitEventData {
 if (typeof eventData.stack === 'string') {
 meta.stack = eventData.stack;
 }
 // run_cancelled optionally carries a free-text cancellation reason. Small
 // plaintext metadata, so it rides in the frame meta like errorCode.
 if (typeof eventData.cancelReason === 'string') {
 meta.cancelReason = eventData.cancelReason;
 }
 if (
 eventData.executionContext !== undefined &&
 eventData.executionContext !== null &&
Expand Down

50 changes: 50 additions & 0 deletions
packages/world/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
import { describe, expect, it } from 'vitest';
import { CreateEventSchema, EventSchema } from './events';

describe('run_cancelled cancelReason', () => {
 it('accepts a run_cancelled create request with no eventData', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 });
 expect(parsed.eventType).toBe('run_cancelled');
 });

 it('accepts an optional cancelReason on the create request', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 });
 expect(parsed.eventType).toBe('run_cancelled');
 // eventData is only present on the run_cancelled branch of the union.
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('superseded by newer run');
 });

 it('rejects a cancelReason longer than 512 chars', () => {
 const result = CreateEventSchema.safeParse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'x'.repeat(513) },
 });
 expect(result.success).toBe(false);
 });

 it('retains cancelReason when reading back a stored run_cancelled event (not stripped)', () => {
 const parsed = EventSchema.parse({
 eventType: 'run_cancelled',
 runId: 'wrun_00000000000000000000000000',
 eventId: 'evnt_00000000000000000000000000',
 createdAt: new Date().toISOString(),
 specVersion: 4,
 eventData: { cancelReason: 'operator cancelled' },
 });
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('operator cancelled');
 });
});

8 changes: 8 additions & 0 deletions
packages/world/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,14 @@ const RunFailedEventSchema = BaseEventSchema.extend({
 */
const RunCancelledEventSchema = BaseEventSchema.extend({
 eventType: z.literal('run_cancelled'),
 eventData: z
 .object({
 // Optional free-text reason for the cancellation. Kept as small
 // plaintext metadata (like run_failed's errorCode) so it survives
 // resolveData: 'none' and can be displayed without decryption.
 cancelReason: z.string().max(512).optional(),
 })
 .optional(),
});

// Discriminated union for user-creatable events (requests to world.events.create)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Backport #2840: Add optional reason to run cancellation by github-actions[bot] · Pull Request #2843 · vercel/workflow · GitHub
Skip to content
Backport #2840: Add optional reason to run cancellation#2843

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

 Closed

github-actions
wants to merge
1
commit into

from

 Closed


Backport #2840: Add optional reason to run cancellation
#2843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/run-cancel-reason.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@workflow/core': patch
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/web-shared': patch
---

Add an optional reason to run cancellation (`run.cancel({ cancelReason })`), recorded on the cancellation event and shown in the run detail view.

19 changes: 19 additions & 0 deletions
docs/content/docs/api-reference/workflow-api/get-run.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,25 @@ const { stoppedCount } = await run.wakeUp({
});
```

### Cancel a Run

Cancel a workflow run. You can pass an optional free-text `cancelReason` (up to 512 characters) that is recorded on the run's cancellation event and shown in the run detail view:

```typescript lineNumbers
import { getRun } from "workflow/api";

export async function POST(req: Request) {
 const { runId } = await req.json();
 const run = getRun(runId);

 await run.cancel({ cancelReason: "Superseded by a newer submission" }); // [!code highlight]

 return Response.json({ cancelled: true });
}
```

The options object is optional — `await run.cancel()` cancels the run without recording a reason.

## Related Functions

- [`start()`](/docs/api-reference/workflow-api/start) - Start a new workflow and get its run ID.

1 change: 1 addition & 0 deletions
packages/core/src/runtime.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 type WorkflowReadableStreamOptions,
} from './runtime/run.js';
export {
 type CancelRunOptions,
 cancelRun,
 listStreams,
 type ReadStreamOptions,
Expand Down

10 changes: 9 additions & 1 deletion
packages/core/src/runtime/run.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
} from '../serialization.js';
import { getWorkflowRunStreamId } from '../util.js';
import {
 type CancelRunOptions,
 type StopSleepOptions,
 type StopSleepResult,
 wakeUpRun,
Expand DownExpand Up@@ -142,11 +143,18 @@ export class Run<TResult> {

 /**
 * Cancels the workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event, surfaced in
 * the run detail view.
 */
 async cancel(): Promise<void> {
 async cancel(options?: CancelRunOptions): Promise<void> {
 await this.world.events.create(this.runId, {
 eventType: 'run_cancelled',
 specVersion: SPEC_VERSION_CURRENT,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 });
 }

Expand Down

24 changes: 21 additions & 3 deletions
packages/core/src/runtime/runs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,14 @@ export interface StopSleepOptions {
 correlationIds?: string[];
}

export interface CancelRunOptions {
 /**
 * Optional free-text reason for the cancellation (max 512 chars), recorded
 * on the run_cancelled event and surfaced in the run detail view.
 */
 cancelReason?: string;
}

const normalizeWorkflowArgs = (args: unknown): unknown[] => {
 return Array.isArray(args) ? args : [args];
};
Expand DownExpand Up@@ -85,17 +93,27 @@ export async function recreateRunFromExisting(

/**
 * Cancel a workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event.
 */
export async function cancelRun(world: World, runId: string): Promise<void> {
export async function cancelRun(
 world: World,
 runId: string,
 options?: CancelRunOptions
): Promise<void> {
 try {
 const run = await world.runs.get(runId, { resolveData: 'none' });
 const specVersion = run.specVersion ?? SPEC_VERSION_LEGACY;
 const compatMode = isLegacySpecVersion(specVersion);
 const eventData = {
 const eventRequest = {
 eventType: 'run_cancelled' as const,
 specVersion,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 };
 await world.events.create(runId, eventData, { v1Compat: compatMode });
 await world.events.create(runId, eventRequest, { v1Compat: compatMode });
 } catch (err) {
 throw new Error(
 `Failed to cancel run ${runId}: ${err instanceof Error ? err.message : String(err)}`,
Expand Down

21 changes: 21 additions & 0 deletions
packages/web-shared/src/components/event-list-view.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -595,6 +595,27 @@ function PayloadBlock({
 );
 }

 // Cancellation reason — render the free-text reason as a readable line
 // instead of a raw JSON payload (the only field run_cancelled carries).
 if (eventType === 'run_cancelled') {
 const cancelReason =
 cleaned != null &&
 typeof cleaned === 'object' &&
 typeof (cleaned as Record<string, unknown>).cancelReason === 'string'
 ? ((cleaned as Record<string, unknown>).cancelReason as string)
 : null;
 if (cancelReason) {
 return (
 <div className="p-2 text-xs" style={{ color: 'var(--ds-gray-1000)' }}>
 <span style={{ color: 'var(--ds-gray-900)' }}>Reason: </span>
 <span className="whitespace-pre-wrap break-words">
 {cancelReason}
 </span>
 </div>
 );
 }
 }

 return (
 <div className="relative group/payload">
 <div
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api-workflow.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export type {
 CancelRunOptions,
 Event,
 StartOptions,
 StopSleepOptions,
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export {
 type CancelRunOptions,
 type Event,
 getHookByToken,
 getRun,
Expand Down

4 changes: 4 additions & 0 deletions
packages/world-vercel/src/events-v4.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,9 @@ export interface CreateEventV4Input {
 error?: unknown;
 /** Companion stack string for step_failed / step_retrying. */
 stack?: string;
 /** run_cancelled's optional free-text cancellation reason. Small plaintext
 * metadata, capped at 512 chars by the @workflow/world schema. */
 cancelReason?: string;
 /** Arbitrary structured map; rides as a native CBOR object in the
 * frame meta. Bounded by the server at 2 KB encoded. */
 executionContext?: Record<string, unknown>;
Expand DownExpand Up@@ -138,6 +141,7 @@ function buildPostFrameMeta(
 if (input.errorCode !== undefined) meta.errorCode = input.errorCode;
 if (input.error !== undefined) meta.error = input.error;
 if (input.stack !== undefined) meta.stack = input.stack;
 if (input.cancelReason !== undefined) meta.cancelReason = input.cancelReason;
 if (input.executionContext !== undefined) {
 meta.executionContext = input.executionContext;
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,27 @@ describe('splitEventDataForV4 structured errors', () => {
 expect(meta.stack).toBeUndefined();
 });

 it('carries the run_cancelled cancelReason in the frame meta, not the payload', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBe('superseded by newer run');
 });

 it('omits cancelReason from meta when run_cancelled carries no reason', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBeUndefined();
 });

 it('keeps an already-dehydrated (Uint8Array) error on the body path', () => {
 // A runtime that DOES dehydrate errors hands the split a Uint8Array;
 // it must stream as the opaque frame body, untouched, with no meta.error.
Expand Down

7 changes: 7 additions & 0 deletions
packages/world-vercel/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,7 @@ interface SplitEventData {
 * object instead.
 */
 stack?: string;
 cancelReason?: string;
 /** Structured executionContext, included verbatim in frame meta. */
 executionContext?: Record<string, unknown>;
 };
Expand All@@ -223,6 +224,7 @@ type MetaSourceField =
 // hook_created webhook flag (renamed to hookIsWebhook on the wire)
 | 'isWebhook'
 | 'errorCode'
 | 'cancelReason'
 // step_failed / step_retrying error stack (sibling of the message string)
 | 'stack'
 | 'executionContext';
Expand DownExpand Up@@ -324,6 +326,11 @@ export function splitEventDataForV4(data: AnyEventRequest): SplitEventData {
 if (typeof eventData.stack === 'string') {
 meta.stack = eventData.stack;
 }
 // run_cancelled optionally carries a free-text cancellation reason. Small
 // plaintext metadata, so it rides in the frame meta like errorCode.
 if (typeof eventData.cancelReason === 'string') {
 meta.cancelReason = eventData.cancelReason;
 }
 if (
 eventData.executionContext !== undefined &&
 eventData.executionContext !== null &&
Expand Down

50 changes: 50 additions & 0 deletions
packages/world/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
import { describe, expect, it } from 'vitest';
import { CreateEventSchema, EventSchema } from './events';

describe('run_cancelled cancelReason', () => {
 it('accepts a run_cancelled create request with no eventData', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 });
 expect(parsed.eventType).toBe('run_cancelled');
 });

 it('accepts an optional cancelReason on the create request', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 });
 expect(parsed.eventType).toBe('run_cancelled');
 // eventData is only present on the run_cancelled branch of the union.
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('superseded by newer run');
 });

 it('rejects a cancelReason longer than 512 chars', () => {
 const result = CreateEventSchema.safeParse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'x'.repeat(513) },
 });
 expect(result.success).toBe(false);
 });

 it('retains cancelReason when reading back a stored run_cancelled event (not stripped)', () => {
 const parsed = EventSchema.parse({
 eventType: 'run_cancelled',
 runId: 'wrun_00000000000000000000000000',
 eventId: 'evnt_00000000000000000000000000',
 createdAt: new Date().toISOString(),
 specVersion: 4,
 eventData: { cancelReason: 'operator cancelled' },
 });
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('operator cancelled');
 });
});

8 changes: 8 additions & 0 deletions
packages/world/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,14 @@ const RunFailedEventSchema = BaseEventSchema.extend({
 */
const RunCancelledEventSchema = BaseEventSchema.extend({
 eventType: z.literal('run_cancelled'),
 eventData: z
 .object({
 // Optional free-text reason for the cancellation. Kept as small
 // plaintext metadata (like run_failed's errorCode) so it survives
 // resolveData: 'none' and can be displayed without decryption.
 cancelReason: z.string().max(512).optional(),
 })
 .optional(),
});

// Discriminated union for user-creatable events (requests to world.events.create)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Backport #2840: Add optional reason to run cancellation by github-actions[bot] · Pull Request #2843 · vercel/workflow · GitHub
Skip to content
Backport #2840: Add optional reason to run cancellation#2843

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

 Closed

github-actions
wants to merge
1
commit into

from

 Closed


Backport #2840: Add optional reason to run cancellation
#2843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/run-cancel-reason.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@workflow/core': patch
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/web-shared': patch
---

Add an optional reason to run cancellation (`run.cancel({ cancelReason })`), recorded on the cancellation event and shown in the run detail view.

19 changes: 19 additions & 0 deletions
docs/content/docs/api-reference/workflow-api/get-run.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,25 @@ const { stoppedCount } = await run.wakeUp({
});
```

### Cancel a Run

Cancel a workflow run. You can pass an optional free-text `cancelReason` (up to 512 characters) that is recorded on the run's cancellation event and shown in the run detail view:

```typescript lineNumbers
import { getRun } from "workflow/api";

export async function POST(req: Request) {
 const { runId } = await req.json();
 const run = getRun(runId);

 await run.cancel({ cancelReason: "Superseded by a newer submission" }); // [!code highlight]

 return Response.json({ cancelled: true });
}
```

The options object is optional — `await run.cancel()` cancels the run without recording a reason.

## Related Functions

- [`start()`](/docs/api-reference/workflow-api/start) - Start a new workflow and get its run ID.

1 change: 1 addition & 0 deletions
packages/core/src/runtime.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 type WorkflowReadableStreamOptions,
} from './runtime/run.js';
export {
 type CancelRunOptions,
 cancelRun,
 listStreams,
 type ReadStreamOptions,
Expand Down

10 changes: 9 additions & 1 deletion
packages/core/src/runtime/run.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
} from '../serialization.js';
import { getWorkflowRunStreamId } from '../util.js';
import {
 type CancelRunOptions,
 type StopSleepOptions,
 type StopSleepResult,
 wakeUpRun,
Expand DownExpand Up@@ -142,11 +143,18 @@ export class Run<TResult> {

 /**
 * Cancels the workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event, surfaced in
 * the run detail view.
 */
 async cancel(): Promise<void> {
 async cancel(options?: CancelRunOptions): Promise<void> {
 await this.world.events.create(this.runId, {
 eventType: 'run_cancelled',
 specVersion: SPEC_VERSION_CURRENT,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 });
 }

Expand Down

24 changes: 21 additions & 3 deletions
packages/core/src/runtime/runs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,14 @@ export interface StopSleepOptions {
 correlationIds?: string[];
}

export interface CancelRunOptions {
 /**
 * Optional free-text reason for the cancellation (max 512 chars), recorded
 * on the run_cancelled event and surfaced in the run detail view.
 */
 cancelReason?: string;
}

const normalizeWorkflowArgs = (args: unknown): unknown[] => {
 return Array.isArray(args) ? args : [args];
};
Expand DownExpand Up@@ -85,17 +93,27 @@ export async function recreateRunFromExisting(

/**
 * Cancel a workflow run.
 *
 * @param options - Optional cancellation settings. `cancelReason` records a
 * free-text reason (max 512 chars) on the run_cancelled event.
 */
export async function cancelRun(world: World, runId: string): Promise<void> {
export async function cancelRun(
 world: World,
 runId: string,
 options?: CancelRunOptions
): Promise<void> {
 try {
 const run = await world.runs.get(runId, { resolveData: 'none' });
 const specVersion = run.specVersion ?? SPEC_VERSION_LEGACY;
 const compatMode = isLegacySpecVersion(specVersion);
 const eventData = {
 const eventRequest = {
 eventType: 'run_cancelled' as const,
 specVersion,
 ...(options?.cancelReason !== undefined
 ? { eventData: { cancelReason: options.cancelReason } }
 : {}),
 };
 await world.events.create(runId, eventData, { v1Compat: compatMode });
 await world.events.create(runId, eventRequest, { v1Compat: compatMode });
 } catch (err) {
 throw new Error(
 `Failed to cancel run ${runId}: ${err instanceof Error ? err.message : String(err)}`,
Expand Down

21 changes: 21 additions & 0 deletions
packages/web-shared/src/components/event-list-view.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -595,6 +595,27 @@ function PayloadBlock({
 );
 }

 // Cancellation reason — render the free-text reason as a readable line
 // instead of a raw JSON payload (the only field run_cancelled carries).
 if (eventType === 'run_cancelled') {
 const cancelReason =
 cleaned != null &&
 typeof cleaned === 'object' &&
 typeof (cleaned as Record<string, unknown>).cancelReason === 'string'
 ? ((cleaned as Record<string, unknown>).cancelReason as string)
 : null;
 if (cancelReason) {
 return (
 <div className="p-2 text-xs" style={{ color: 'var(--ds-gray-1000)' }}>
 <span style={{ color: 'var(--ds-gray-900)' }}>Reason: </span>
 <span className="whitespace-pre-wrap break-words">
 {cancelReason}
 </span>
 </div>
 );
 }
 }

 return (
 <div className="relative group/payload">
 <div
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api-workflow.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export type {
 CancelRunOptions,
 Event,
 StartOptions,
 StopSleepOptions,
Expand Down

1 change: 1 addition & 0 deletions
packages/workflow/src/api.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export {
 type CancelRunOptions,
 type Event,
 getHookByToken,
 getRun,
Expand Down

4 changes: 4 additions & 0 deletions
packages/world-vercel/src/events-v4.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,9 @@ export interface CreateEventV4Input {
 error?: unknown;
 /** Companion stack string for step_failed / step_retrying. */
 stack?: string;
 /** run_cancelled's optional free-text cancellation reason. Small plaintext
 * metadata, capped at 512 chars by the @workflow/world schema. */
 cancelReason?: string;
 /** Arbitrary structured map; rides as a native CBOR object in the
 * frame meta. Bounded by the server at 2 KB encoded. */
 executionContext?: Record<string, unknown>;
Expand DownExpand Up@@ -138,6 +141,7 @@ function buildPostFrameMeta(
 if (input.errorCode !== undefined) meta.errorCode = input.errorCode;
 if (input.error !== undefined) meta.error = input.error;
 if (input.stack !== undefined) meta.stack = input.stack;
 if (input.cancelReason !== undefined) meta.cancelReason = input.cancelReason;
 if (input.executionContext !== undefined) {
 meta.executionContext = input.executionContext;
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,27 @@ describe('splitEventDataForV4 structured errors', () => {
 expect(meta.stack).toBeUndefined();
 });

 it('carries the run_cancelled cancelReason in the frame meta, not the payload', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBe('superseded by newer run');
 });

 it('omits cancelReason from meta when run_cancelled carries no reason', () => {
 const { payload, meta } = splitEventDataForV4({
 eventType: 'run_cancelled',
 specVersion: 4,
 } as AnyEventRequest);

 expect(payload).toBeUndefined();
 expect(meta.cancelReason).toBeUndefined();
 });

 it('keeps an already-dehydrated (Uint8Array) error on the body path', () => {
 // A runtime that DOES dehydrate errors hands the split a Uint8Array;
 // it must stream as the opaque frame body, untouched, with no meta.error.
Expand Down

7 changes: 7 additions & 0 deletions
packages/world-vercel/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,7 @@ interface SplitEventData {
 * object instead.
 */
 stack?: string;
 cancelReason?: string;
 /** Structured executionContext, included verbatim in frame meta. */
 executionContext?: Record<string, unknown>;
 };
Expand All@@ -223,6 +224,7 @@ type MetaSourceField =
 // hook_created webhook flag (renamed to hookIsWebhook on the wire)
 | 'isWebhook'
 | 'errorCode'
 | 'cancelReason'
 // step_failed / step_retrying error stack (sibling of the message string)
 | 'stack'
 | 'executionContext';
Expand DownExpand Up@@ -324,6 +326,11 @@ export function splitEventDataForV4(data: AnyEventRequest): SplitEventData {
 if (typeof eventData.stack === 'string') {
 meta.stack = eventData.stack;
 }
 // run_cancelled optionally carries a free-text cancellation reason. Small
 // plaintext metadata, so it rides in the frame meta like errorCode.
 if (typeof eventData.cancelReason === 'string') {
 meta.cancelReason = eventData.cancelReason;
 }
 if (
 eventData.executionContext !== undefined &&
 eventData.executionContext !== null &&
Expand Down

50 changes: 50 additions & 0 deletions
packages/world/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
import { describe, expect, it } from 'vitest';
import { CreateEventSchema, EventSchema } from './events';

describe('run_cancelled cancelReason', () => {
 it('accepts a run_cancelled create request with no eventData', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 });
 expect(parsed.eventType).toBe('run_cancelled');
 });

 it('accepts an optional cancelReason on the create request', () => {
 const parsed = CreateEventSchema.parse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'superseded by newer run' },
 });
 expect(parsed.eventType).toBe('run_cancelled');
 // eventData is only present on the run_cancelled branch of the union.
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('superseded by newer run');
 });

 it('rejects a cancelReason longer than 512 chars', () => {
 const result = CreateEventSchema.safeParse({
 eventType: 'run_cancelled',
 specVersion: 4,
 eventData: { cancelReason: 'x'.repeat(513) },
 });
 expect(result.success).toBe(false);
 });

 it('retains cancelReason when reading back a stored run_cancelled event (not stripped)', () => {
 const parsed = EventSchema.parse({
 eventType: 'run_cancelled',
 runId: 'wrun_00000000000000000000000000',
 eventId: 'evnt_00000000000000000000000000',
 createdAt: new Date().toISOString(),
 specVersion: 4,
 eventData: { cancelReason: 'operator cancelled' },
 });
 expect(
 (parsed as { eventData?: { cancelReason?: string } }).eventData
 ?.cancelReason
 ).toBe('operator cancelled');
 });
});

8 changes: 8 additions & 0 deletions
packages/world/src/events.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,14 @@ const RunFailedEventSchema = BaseEventSchema.extend({
 */
const RunCancelledEventSchema = BaseEventSchema.extend({
 eventType: z.literal('run_cancelled'),
 eventData: z
 .object({
 // Optional free-text reason for the cancellation. Kept as small
 // plaintext metadata (like run_failed's errorCode) so it survives
 // resolveData: 'none' and can be displayed without decryption.
 cancelReason: z.string().max(512).optional(),
 })
 .optional(),
});

// Discriminated union for user-creatable events (requests to world.events.create)
Expand Down