Skip to content

Backport #3381: [core] Ignore duplicate events per event class instead of failing the run#3487

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 #3381: [core] Ignore duplicate events per event class instead of failing the run #3487

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
6 changes: 6 additions & 0 deletions .changeset/dull-hats-melt.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@workflow/core': patch
'@workflow/world': patch
---

Ignore duplicate events that a concurrent replay wrote for an entity the event log already records, instead of failing the run with a corrupted event log
153 changes: 153 additions & 0 deletions packages/core/src/duplicate-events.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import type { Event } from '@workflow/world';
import { describe, expect, it, vi } from 'vitest';
import { WorkflowSuspension } from './global.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { createUseStep } from './step.js';
import {
CORR_IDS,
runWithDiscontinuation,
setupWorkflowContext,
} from './test-support/orchestrator-context.js';
import { createSleep } from './workflow/sleep.js';

/**
* Concurrent replays of one run share a single event log and write to it
* without a currency guard, so a replay working from a stale prefix can commit
* a second `step_created` / `step_started` / `wait_created` for an entity the
* log already records one of. Those writes are committed but inert: every
* replay reads the first event of that class at the same position, so the
* straggler cannot change what the workflow observes.
*
* Before this behavior existed the straggler had no consumer left to claim it
* (the entity's consumer deregistered when it took the step's result), which
* surfaced as `ReplayDivergenceError` and, after retries, a terminal
* `CORRUPTED_EVENT_LOG` on a run whose log was fine.
*
* These tests drive the real step and sleep primitives against hand-written
* logs. The unit-level behavior lives in `events-consumer.test.ts`.
*/

const RESUME_AT = new Date('2099-01-01T00:00:00.000Z');

async function dehydrate(value: unknown) {
const ops: Promise<unknown>[] = [];
return await dehydrateStepReturnValue(value, 'wrun_test', undefined, ops);
}

function event(
index: number,
eventType: string,
correlationId: string,
eventData: Record<string, unknown>
): Event {
return {
eventId: `evnt_${index}`,
runId: 'wrun_test',
eventType,
correlationId,
eventData,
createdAt: new Date(),
} as unknown as Event;
}

function pendingStepNames(ctx: ReturnType<typeof setupWorkflowContext>) {
return [...ctx.invocationsQueue.values()]
.filter((i) => i.type === 'step')
.map((i) => (i.type === 'step' ? i.stepName : undefined));
}

describe('events repeating a class already in the log', () => {
it('ignores a step_started that lands after the step completed', async () => {
const result = await dehydrate('a-result');
const onDuplicateEvent = vi.fn();
const events = [
event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
stepName: 'stepA',
result,
}),
// A concurrent replay that had not yet seen evnt_2 re-invokes stepA.
event(3, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
event(4, 'step_created', `step_${CORR_IDS[1]}`, { stepName: 'stepB' }),
];
const ctx = setupWorkflowContext(events, { onDuplicateEvent });
const useStep = createUseStep(ctx);

const observed: unknown[] = [];
const { error } = await runWithDiscontinuation(ctx, async () => {
const stepA = useStep('stepA');
const stepB = useStep('stepB');
observed.push(await stepA());
observed.push(await stepB());
return 'done';
});

// Suspension, not divergence: the run is waiting on stepB.
expect(WorkflowSuspension.is(error)).toBe(true);
expect(observed).toEqual(['a-result']);
expect(pendingStepNames(ctx)).toEqual(['stepB']);
expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
expect(onDuplicateEvent).toHaveBeenCalledWith(events[3], 'step_started');
});

it('ignores a wait_created that lands after the wait completed', async () => {
const onDuplicateEvent = vi.fn();
const events = [
event(0, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
event(1, 'wait_completed', `wait_${CORR_IDS[0]}`, {
resumeAt: RESUME_AT,
}),
// A concurrent replay that had not yet seen evnt_1 re-created the sleep.
event(2, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
event(3, 'step_created', `step_${CORR_IDS[1]}`, {
stepName: 'afterSleep',
}),
];
const ctx = setupWorkflowContext(events, { onDuplicateEvent });
const sleep = createSleep(ctx);
const useStep = createUseStep(ctx);

const { error } = await runWithDiscontinuation(ctx, async () => {
await sleep(RESUME_AT);
await useStep('afterSleep')();
return 'done';
});

expect(WorkflowSuspension.is(error)).toBe(true);
expect(pendingStepNames(ctx)).toEqual(['afterSleep']);
expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
expect(onDuplicateEvent).toHaveBeenCalledWith(events[2], 'wait_created');
});

it('still reports divergence for an event repeating nothing in the log', async () => {
const result = await dehydrate('a-result');
const onDuplicateEvent = vi.fn();
const events = [
event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
stepName: 'stepA',
result,
}),
// Belongs to no entity this workflow ever creates: the sleep below mints
// CORR_IDS[1]. Nothing can consume it, and nothing should suppress it.
event(3, 'wait_created', 'wait_01JZZZZZZZZZZZZZZZZZZZZZZZ', {
resumeAt: RESUME_AT,
}),
];
const ctx = setupWorkflowContext(events, { onDuplicateEvent });
const sleep = createSleep(ctx);
const useStep = createUseStep(ctx);

const { error } = await runWithDiscontinuation(ctx, async () => {
await useStep('stepA')();
await sleep(RESUME_AT);
return 'done';
});

expect(WorkflowSuspension.is(error)).toBe(false);
expect(String(error)).toContain('Unconsumed event in event log');
expect(onDuplicateEvent).not.toHaveBeenCalled();
});
});
Loading
, '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 #3381: [core] Ignore duplicate events per event class instead of failing the run by github-actions[bot] · Pull Request #3487 · vercel/workflow · GitHub
Skip to content
Backport #3381: [core] Ignore duplicate events per event class instead of failing the run#3487

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 #3381: [core] Ignore duplicate events per event class instead of failing the run
#3487
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


6 changes: 6 additions & 0 deletions
.changeset/dull-hats-melt.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@workflow/core': patch
'@workflow/world': patch
---

Ignore duplicate events that a concurrent replay wrote for an entity the event log already records, instead of failing the run with a corrupted event log

153 changes: 153 additions & 0 deletions
packages/core/src/duplicate-events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import type { Event } from '@workflow/world';
import { describe, expect, it, vi } from 'vitest';
import { WorkflowSuspension } from './global.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { createUseStep } from './step.js';
import {
 CORR_IDS,
 runWithDiscontinuation,
 setupWorkflowContext,
} from './test-support/orchestrator-context.js';
import { createSleep } from './workflow/sleep.js';

/**
 * Concurrent replays of one run share a single event log and write to it
 * without a currency guard, so a replay working from a stale prefix can commit
 * a second `step_created` / `step_started` / `wait_created` for an entity the
 * log already records one of. Those writes are committed but inert: every
 * replay reads the first event of that class at the same position, so the
 * straggler cannot change what the workflow observes.
 *
 * Before this behavior existed the straggler had no consumer left to claim it
 * (the entity's consumer deregistered when it took the step's result), which
 * surfaced as `ReplayDivergenceError` and, after retries, a terminal
 * `CORRUPTED_EVENT_LOG` on a run whose log was fine.
 *
 * These tests drive the real step and sleep primitives against hand-written
 * logs. The unit-level behavior lives in `events-consumer.test.ts`.
 */

const RESUME_AT = new Date('2099-01-01T00:00:00.000Z');

async function dehydrate(value: unknown) {
 const ops: Promise<unknown>[] = [];
 return await dehydrateStepReturnValue(value, 'wrun_test', undefined, ops);
}

function event(
 index: number,
 eventType: string,
 correlationId: string,
 eventData: Record<string, unknown>
): Event {
 return {
 eventId: `evnt_${index}`,
 runId: 'wrun_test',
 eventType,
 correlationId,
 eventData,
 createdAt: new Date(),
 } as unknown as Event;
}

function pendingStepNames(ctx: ReturnType<typeof setupWorkflowContext>) {
 return [...ctx.invocationsQueue.values()]
 .filter((i) => i.type === 'step')
 .map((i) => (i.type === 'step' ? i.stepName : undefined));
}

describe('events repeating a class already in the log', () => {
 it('ignores a step_started that lands after the step completed', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // A concurrent replay that had not yet seen evnt_2 re-invokes stepA.
 event(3, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(4, 'step_created', `step_${CORR_IDS[1]}`, { stepName: 'stepB' }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const useStep = createUseStep(ctx);

 const observed: unknown[] = [];
 const { error } = await runWithDiscontinuation(ctx, async () => {
 const stepA = useStep('stepA');
 const stepB = useStep('stepB');
 observed.push(await stepA());
 observed.push(await stepB());
 return 'done';
 });

 // Suspension, not divergence: the run is waiting on stepB.
 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(observed).toEqual(['a-result']);
 expect(pendingStepNames(ctx)).toEqual(['stepB']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[3], 'step_started');
 });

 it('ignores a wait_created that lands after the wait completed', async () => {
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(1, 'wait_completed', `wait_${CORR_IDS[0]}`, {
 resumeAt: RESUME_AT,
 }),
 // A concurrent replay that had not yet seen evnt_1 re-created the sleep.
 event(2, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(3, 'step_created', `step_${CORR_IDS[1]}`, {
 stepName: 'afterSleep',
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await sleep(RESUME_AT);
 await useStep('afterSleep')();
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(pendingStepNames(ctx)).toEqual(['afterSleep']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[2], 'wait_created');
 });

 it('still reports divergence for an event repeating nothing in the log', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // Belongs to no entity this workflow ever creates: the sleep below mints
 // CORR_IDS[1]. Nothing can consume it, and nothing should suppress it.
 event(3, 'wait_created', 'wait_01JZZZZZZZZZZZZZZZZZZZZZZZ', {
 resumeAt: RESUME_AT,
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await useStep('stepA')();
 await sleep(RESUME_AT);
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(false);
 expect(String(error)).toContain('Unconsumed event in event log');
 expect(onDuplicateEvent).not.toHaveBeenCalled();
 });
});
Loading

, '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 #3381: [core] Ignore duplicate events per event class instead of failing the run by github-actions[bot] · Pull Request #3487 · vercel/workflow · GitHub
Skip to content
Backport #3381: [core] Ignore duplicate events per event class instead of failing the run#3487

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 #3381: [core] Ignore duplicate events per event class instead of failing the run
#3487
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


6 changes: 6 additions & 0 deletions
.changeset/dull-hats-melt.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@workflow/core': patch
'@workflow/world': patch
---

Ignore duplicate events that a concurrent replay wrote for an entity the event log already records, instead of failing the run with a corrupted event log

153 changes: 153 additions & 0 deletions
packages/core/src/duplicate-events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import type { Event } from '@workflow/world';
import { describe, expect, it, vi } from 'vitest';
import { WorkflowSuspension } from './global.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { createUseStep } from './step.js';
import {
 CORR_IDS,
 runWithDiscontinuation,
 setupWorkflowContext,
} from './test-support/orchestrator-context.js';
import { createSleep } from './workflow/sleep.js';

/**
 * Concurrent replays of one run share a single event log and write to it
 * without a currency guard, so a replay working from a stale prefix can commit
 * a second `step_created` / `step_started` / `wait_created` for an entity the
 * log already records one of. Those writes are committed but inert: every
 * replay reads the first event of that class at the same position, so the
 * straggler cannot change what the workflow observes.
 *
 * Before this behavior existed the straggler had no consumer left to claim it
 * (the entity's consumer deregistered when it took the step's result), which
 * surfaced as `ReplayDivergenceError` and, after retries, a terminal
 * `CORRUPTED_EVENT_LOG` on a run whose log was fine.
 *
 * These tests drive the real step and sleep primitives against hand-written
 * logs. The unit-level behavior lives in `events-consumer.test.ts`.
 */

const RESUME_AT = new Date('2099-01-01T00:00:00.000Z');

async function dehydrate(value: unknown) {
 const ops: Promise<unknown>[] = [];
 return await dehydrateStepReturnValue(value, 'wrun_test', undefined, ops);
}

function event(
 index: number,
 eventType: string,
 correlationId: string,
 eventData: Record<string, unknown>
): Event {
 return {
 eventId: `evnt_${index}`,
 runId: 'wrun_test',
 eventType,
 correlationId,
 eventData,
 createdAt: new Date(),
 } as unknown as Event;
}

function pendingStepNames(ctx: ReturnType<typeof setupWorkflowContext>) {
 return [...ctx.invocationsQueue.values()]
 .filter((i) => i.type === 'step')
 .map((i) => (i.type === 'step' ? i.stepName : undefined));
}

describe('events repeating a class already in the log', () => {
 it('ignores a step_started that lands after the step completed', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // A concurrent replay that had not yet seen evnt_2 re-invokes stepA.
 event(3, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(4, 'step_created', `step_${CORR_IDS[1]}`, { stepName: 'stepB' }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const useStep = createUseStep(ctx);

 const observed: unknown[] = [];
 const { error } = await runWithDiscontinuation(ctx, async () => {
 const stepA = useStep('stepA');
 const stepB = useStep('stepB');
 observed.push(await stepA());
 observed.push(await stepB());
 return 'done';
 });

 // Suspension, not divergence: the run is waiting on stepB.
 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(observed).toEqual(['a-result']);
 expect(pendingStepNames(ctx)).toEqual(['stepB']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[3], 'step_started');
 });

 it('ignores a wait_created that lands after the wait completed', async () => {
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(1, 'wait_completed', `wait_${CORR_IDS[0]}`, {
 resumeAt: RESUME_AT,
 }),
 // A concurrent replay that had not yet seen evnt_1 re-created the sleep.
 event(2, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(3, 'step_created', `step_${CORR_IDS[1]}`, {
 stepName: 'afterSleep',
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await sleep(RESUME_AT);
 await useStep('afterSleep')();
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(pendingStepNames(ctx)).toEqual(['afterSleep']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[2], 'wait_created');
 });

 it('still reports divergence for an event repeating nothing in the log', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // Belongs to no entity this workflow ever creates: the sleep below mints
 // CORR_IDS[1]. Nothing can consume it, and nothing should suppress it.
 event(3, 'wait_created', 'wait_01JZZZZZZZZZZZZZZZZZZZZZZZ', {
 resumeAt: RESUME_AT,
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await useStep('stepA')();
 await sleep(RESUME_AT);
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(false);
 expect(String(error)).toContain('Unconsumed event in event log');
 expect(onDuplicateEvent).not.toHaveBeenCalled();
 });
});
Loading

, '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 #3381: [core] Ignore duplicate events per event class instead of failing the run by github-actions[bot] · Pull Request #3487 · vercel/workflow · GitHub
Skip to content
Backport #3381: [core] Ignore duplicate events per event class instead of failing the run#3487

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 #3381: [core] Ignore duplicate events per event class instead of failing the run
#3487
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


6 changes: 6 additions & 0 deletions
.changeset/dull-hats-melt.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@workflow/core': patch
'@workflow/world': patch
---

Ignore duplicate events that a concurrent replay wrote for an entity the event log already records, instead of failing the run with a corrupted event log

153 changes: 153 additions & 0 deletions
packages/core/src/duplicate-events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import type { Event } from '@workflow/world';
import { describe, expect, it, vi } from 'vitest';
import { WorkflowSuspension } from './global.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { createUseStep } from './step.js';
import {
 CORR_IDS,
 runWithDiscontinuation,
 setupWorkflowContext,
} from './test-support/orchestrator-context.js';
import { createSleep } from './workflow/sleep.js';

/**
 * Concurrent replays of one run share a single event log and write to it
 * without a currency guard, so a replay working from a stale prefix can commit
 * a second `step_created` / `step_started` / `wait_created` for an entity the
 * log already records one of. Those writes are committed but inert: every
 * replay reads the first event of that class at the same position, so the
 * straggler cannot change what the workflow observes.
 *
 * Before this behavior existed the straggler had no consumer left to claim it
 * (the entity's consumer deregistered when it took the step's result), which
 * surfaced as `ReplayDivergenceError` and, after retries, a terminal
 * `CORRUPTED_EVENT_LOG` on a run whose log was fine.
 *
 * These tests drive the real step and sleep primitives against hand-written
 * logs. The unit-level behavior lives in `events-consumer.test.ts`.
 */

const RESUME_AT = new Date('2099-01-01T00:00:00.000Z');

async function dehydrate(value: unknown) {
 const ops: Promise<unknown>[] = [];
 return await dehydrateStepReturnValue(value, 'wrun_test', undefined, ops);
}

function event(
 index: number,
 eventType: string,
 correlationId: string,
 eventData: Record<string, unknown>
): Event {
 return {
 eventId: `evnt_${index}`,
 runId: 'wrun_test',
 eventType,
 correlationId,
 eventData,
 createdAt: new Date(),
 } as unknown as Event;
}

function pendingStepNames(ctx: ReturnType<typeof setupWorkflowContext>) {
 return [...ctx.invocationsQueue.values()]
 .filter((i) => i.type === 'step')
 .map((i) => (i.type === 'step' ? i.stepName : undefined));
}

describe('events repeating a class already in the log', () => {
 it('ignores a step_started that lands after the step completed', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // A concurrent replay that had not yet seen evnt_2 re-invokes stepA.
 event(3, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(4, 'step_created', `step_${CORR_IDS[1]}`, { stepName: 'stepB' }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const useStep = createUseStep(ctx);

 const observed: unknown[] = [];
 const { error } = await runWithDiscontinuation(ctx, async () => {
 const stepA = useStep('stepA');
 const stepB = useStep('stepB');
 observed.push(await stepA());
 observed.push(await stepB());
 return 'done';
 });

 // Suspension, not divergence: the run is waiting on stepB.
 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(observed).toEqual(['a-result']);
 expect(pendingStepNames(ctx)).toEqual(['stepB']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[3], 'step_started');
 });

 it('ignores a wait_created that lands after the wait completed', async () => {
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(1, 'wait_completed', `wait_${CORR_IDS[0]}`, {
 resumeAt: RESUME_AT,
 }),
 // A concurrent replay that had not yet seen evnt_1 re-created the sleep.
 event(2, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(3, 'step_created', `step_${CORR_IDS[1]}`, {
 stepName: 'afterSleep',
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await sleep(RESUME_AT);
 await useStep('afterSleep')();
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(pendingStepNames(ctx)).toEqual(['afterSleep']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[2], 'wait_created');
 });

 it('still reports divergence for an event repeating nothing in the log', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // Belongs to no entity this workflow ever creates: the sleep below mints
 // CORR_IDS[1]. Nothing can consume it, and nothing should suppress it.
 event(3, 'wait_created', 'wait_01JZZZZZZZZZZZZZZZZZZZZZZZ', {
 resumeAt: RESUME_AT,
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await useStep('stepA')();
 await sleep(RESUME_AT);
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(false);
 expect(String(error)).toContain('Unconsumed event in event log');
 expect(onDuplicateEvent).not.toHaveBeenCalled();
 });
});
Loading

, '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 #3381: [core] Ignore duplicate events per event class instead of failing the run by github-actions[bot] · Pull Request #3487 · vercel/workflow · GitHub
Skip to content
Backport #3381: [core] Ignore duplicate events per event class instead of failing the run#3487

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 #3381: [core] Ignore duplicate events per event class instead of failing the run
#3487
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


6 changes: 6 additions & 0 deletions
.changeset/dull-hats-melt.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@workflow/core': patch
'@workflow/world': patch
---

Ignore duplicate events that a concurrent replay wrote for an entity the event log already records, instead of failing the run with a corrupted event log

153 changes: 153 additions & 0 deletions
packages/core/src/duplicate-events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import type { Event } from '@workflow/world';
import { describe, expect, it, vi } from 'vitest';
import { WorkflowSuspension } from './global.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { createUseStep } from './step.js';
import {
 CORR_IDS,
 runWithDiscontinuation,
 setupWorkflowContext,
} from './test-support/orchestrator-context.js';
import { createSleep } from './workflow/sleep.js';

/**
 * Concurrent replays of one run share a single event log and write to it
 * without a currency guard, so a replay working from a stale prefix can commit
 * a second `step_created` / `step_started` / `wait_created` for an entity the
 * log already records one of. Those writes are committed but inert: every
 * replay reads the first event of that class at the same position, so the
 * straggler cannot change what the workflow observes.
 *
 * Before this behavior existed the straggler had no consumer left to claim it
 * (the entity's consumer deregistered when it took the step's result), which
 * surfaced as `ReplayDivergenceError` and, after retries, a terminal
 * `CORRUPTED_EVENT_LOG` on a run whose log was fine.
 *
 * These tests drive the real step and sleep primitives against hand-written
 * logs. The unit-level behavior lives in `events-consumer.test.ts`.
 */

const RESUME_AT = new Date('2099-01-01T00:00:00.000Z');

async function dehydrate(value: unknown) {
 const ops: Promise<unknown>[] = [];
 return await dehydrateStepReturnValue(value, 'wrun_test', undefined, ops);
}

function event(
 index: number,
 eventType: string,
 correlationId: string,
 eventData: Record<string, unknown>
): Event {
 return {
 eventId: `evnt_${index}`,
 runId: 'wrun_test',
 eventType,
 correlationId,
 eventData,
 createdAt: new Date(),
 } as unknown as Event;
}

function pendingStepNames(ctx: ReturnType<typeof setupWorkflowContext>) {
 return [...ctx.invocationsQueue.values()]
 .filter((i) => i.type === 'step')
 .map((i) => (i.type === 'step' ? i.stepName : undefined));
}

describe('events repeating a class already in the log', () => {
 it('ignores a step_started that lands after the step completed', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // A concurrent replay that had not yet seen evnt_2 re-invokes stepA.
 event(3, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(4, 'step_created', `step_${CORR_IDS[1]}`, { stepName: 'stepB' }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const useStep = createUseStep(ctx);

 const observed: unknown[] = [];
 const { error } = await runWithDiscontinuation(ctx, async () => {
 const stepA = useStep('stepA');
 const stepB = useStep('stepB');
 observed.push(await stepA());
 observed.push(await stepB());
 return 'done';
 });

 // Suspension, not divergence: the run is waiting on stepB.
 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(observed).toEqual(['a-result']);
 expect(pendingStepNames(ctx)).toEqual(['stepB']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[3], 'step_started');
 });

 it('ignores a wait_created that lands after the wait completed', async () => {
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(1, 'wait_completed', `wait_${CORR_IDS[0]}`, {
 resumeAt: RESUME_AT,
 }),
 // A concurrent replay that had not yet seen evnt_1 re-created the sleep.
 event(2, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(3, 'step_created', `step_${CORR_IDS[1]}`, {
 stepName: 'afterSleep',
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await sleep(RESUME_AT);
 await useStep('afterSleep')();
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(pendingStepNames(ctx)).toEqual(['afterSleep']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[2], 'wait_created');
 });

 it('still reports divergence for an event repeating nothing in the log', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // Belongs to no entity this workflow ever creates: the sleep below mints
 // CORR_IDS[1]. Nothing can consume it, and nothing should suppress it.
 event(3, 'wait_created', 'wait_01JZZZZZZZZZZZZZZZZZZZZZZZ', {
 resumeAt: RESUME_AT,
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await useStep('stepA')();
 await sleep(RESUME_AT);
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(false);
 expect(String(error)).toContain('Unconsumed event in event log');
 expect(onDuplicateEvent).not.toHaveBeenCalled();
 });
});
Loading

, '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 #3381: [core] Ignore duplicate events per event class instead of failing the run by github-actions[bot] · Pull Request #3487 · vercel/workflow · GitHub
Skip to content
Backport #3381: [core] Ignore duplicate events per event class instead of failing the run#3487

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 #3381: [core] Ignore duplicate events per event class instead of failing the run
#3487
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


6 changes: 6 additions & 0 deletions
.changeset/dull-hats-melt.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@workflow/core': patch
'@workflow/world': patch
---

Ignore duplicate events that a concurrent replay wrote for an entity the event log already records, instead of failing the run with a corrupted event log

153 changes: 153 additions & 0 deletions
packages/core/src/duplicate-events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import type { Event } from '@workflow/world';
import { describe, expect, it, vi } from 'vitest';
import { WorkflowSuspension } from './global.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { createUseStep } from './step.js';
import {
 CORR_IDS,
 runWithDiscontinuation,
 setupWorkflowContext,
} from './test-support/orchestrator-context.js';
import { createSleep } from './workflow/sleep.js';

/**
 * Concurrent replays of one run share a single event log and write to it
 * without a currency guard, so a replay working from a stale prefix can commit
 * a second `step_created` / `step_started` / `wait_created` for an entity the
 * log already records one of. Those writes are committed but inert: every
 * replay reads the first event of that class at the same position, so the
 * straggler cannot change what the workflow observes.
 *
 * Before this behavior existed the straggler had no consumer left to claim it
 * (the entity's consumer deregistered when it took the step's result), which
 * surfaced as `ReplayDivergenceError` and, after retries, a terminal
 * `CORRUPTED_EVENT_LOG` on a run whose log was fine.
 *
 * These tests drive the real step and sleep primitives against hand-written
 * logs. The unit-level behavior lives in `events-consumer.test.ts`.
 */

const RESUME_AT = new Date('2099-01-01T00:00:00.000Z');

async function dehydrate(value: unknown) {
 const ops: Promise<unknown>[] = [];
 return await dehydrateStepReturnValue(value, 'wrun_test', undefined, ops);
}

function event(
 index: number,
 eventType: string,
 correlationId: string,
 eventData: Record<string, unknown>
): Event {
 return {
 eventId: `evnt_${index}`,
 runId: 'wrun_test',
 eventType,
 correlationId,
 eventData,
 createdAt: new Date(),
 } as unknown as Event;
}

function pendingStepNames(ctx: ReturnType<typeof setupWorkflowContext>) {
 return [...ctx.invocationsQueue.values()]
 .filter((i) => i.type === 'step')
 .map((i) => (i.type === 'step' ? i.stepName : undefined));
}

describe('events repeating a class already in the log', () => {
 it('ignores a step_started that lands after the step completed', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // A concurrent replay that had not yet seen evnt_2 re-invokes stepA.
 event(3, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(4, 'step_created', `step_${CORR_IDS[1]}`, { stepName: 'stepB' }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const useStep = createUseStep(ctx);

 const observed: unknown[] = [];
 const { error } = await runWithDiscontinuation(ctx, async () => {
 const stepA = useStep('stepA');
 const stepB = useStep('stepB');
 observed.push(await stepA());
 observed.push(await stepB());
 return 'done';
 });

 // Suspension, not divergence: the run is waiting on stepB.
 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(observed).toEqual(['a-result']);
 expect(pendingStepNames(ctx)).toEqual(['stepB']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[3], 'step_started');
 });

 it('ignores a wait_created that lands after the wait completed', async () => {
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(1, 'wait_completed', `wait_${CORR_IDS[0]}`, {
 resumeAt: RESUME_AT,
 }),
 // A concurrent replay that had not yet seen evnt_1 re-created the sleep.
 event(2, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(3, 'step_created', `step_${CORR_IDS[1]}`, {
 stepName: 'afterSleep',
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await sleep(RESUME_AT);
 await useStep('afterSleep')();
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(pendingStepNames(ctx)).toEqual(['afterSleep']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[2], 'wait_created');
 });

 it('still reports divergence for an event repeating nothing in the log', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // Belongs to no entity this workflow ever creates: the sleep below mints
 // CORR_IDS[1]. Nothing can consume it, and nothing should suppress it.
 event(3, 'wait_created', 'wait_01JZZZZZZZZZZZZZZZZZZZZZZZ', {
 resumeAt: RESUME_AT,
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await useStep('stepA')();
 await sleep(RESUME_AT);
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(false);
 expect(String(error)).toContain('Unconsumed event in event log');
 expect(onDuplicateEvent).not.toHaveBeenCalled();
 });
});
Loading

, '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 #3381: [core] Ignore duplicate events per event class instead of failing the run by github-actions[bot] · Pull Request #3487 · vercel/workflow · GitHub
Skip to content
Backport #3381: [core] Ignore duplicate events per event class instead of failing the run#3487

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 #3381: [core] Ignore duplicate events per event class instead of failing the run
#3487
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


6 changes: 6 additions & 0 deletions
.changeset/dull-hats-melt.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@workflow/core': patch
'@workflow/world': patch
---

Ignore duplicate events that a concurrent replay wrote for an entity the event log already records, instead of failing the run with a corrupted event log

153 changes: 153 additions & 0 deletions
packages/core/src/duplicate-events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import type { Event } from '@workflow/world';
import { describe, expect, it, vi } from 'vitest';
import { WorkflowSuspension } from './global.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { createUseStep } from './step.js';
import {
 CORR_IDS,
 runWithDiscontinuation,
 setupWorkflowContext,
} from './test-support/orchestrator-context.js';
import { createSleep } from './workflow/sleep.js';

/**
 * Concurrent replays of one run share a single event log and write to it
 * without a currency guard, so a replay working from a stale prefix can commit
 * a second `step_created` / `step_started` / `wait_created` for an entity the
 * log already records one of. Those writes are committed but inert: every
 * replay reads the first event of that class at the same position, so the
 * straggler cannot change what the workflow observes.
 *
 * Before this behavior existed the straggler had no consumer left to claim it
 * (the entity's consumer deregistered when it took the step's result), which
 * surfaced as `ReplayDivergenceError` and, after retries, a terminal
 * `CORRUPTED_EVENT_LOG` on a run whose log was fine.
 *
 * These tests drive the real step and sleep primitives against hand-written
 * logs. The unit-level behavior lives in `events-consumer.test.ts`.
 */

const RESUME_AT = new Date('2099-01-01T00:00:00.000Z');

async function dehydrate(value: unknown) {
 const ops: Promise<unknown>[] = [];
 return await dehydrateStepReturnValue(value, 'wrun_test', undefined, ops);
}

function event(
 index: number,
 eventType: string,
 correlationId: string,
 eventData: Record<string, unknown>
): Event {
 return {
 eventId: `evnt_${index}`,
 runId: 'wrun_test',
 eventType,
 correlationId,
 eventData,
 createdAt: new Date(),
 } as unknown as Event;
}

function pendingStepNames(ctx: ReturnType<typeof setupWorkflowContext>) {
 return [...ctx.invocationsQueue.values()]
 .filter((i) => i.type === 'step')
 .map((i) => (i.type === 'step' ? i.stepName : undefined));
}

describe('events repeating a class already in the log', () => {
 it('ignores a step_started that lands after the step completed', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // A concurrent replay that had not yet seen evnt_2 re-invokes stepA.
 event(3, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(4, 'step_created', `step_${CORR_IDS[1]}`, { stepName: 'stepB' }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const useStep = createUseStep(ctx);

 const observed: unknown[] = [];
 const { error } = await runWithDiscontinuation(ctx, async () => {
 const stepA = useStep('stepA');
 const stepB = useStep('stepB');
 observed.push(await stepA());
 observed.push(await stepB());
 return 'done';
 });

 // Suspension, not divergence: the run is waiting on stepB.
 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(observed).toEqual(['a-result']);
 expect(pendingStepNames(ctx)).toEqual(['stepB']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[3], 'step_started');
 });

 it('ignores a wait_created that lands after the wait completed', async () => {
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(1, 'wait_completed', `wait_${CORR_IDS[0]}`, {
 resumeAt: RESUME_AT,
 }),
 // A concurrent replay that had not yet seen evnt_1 re-created the sleep.
 event(2, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(3, 'step_created', `step_${CORR_IDS[1]}`, {
 stepName: 'afterSleep',
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await sleep(RESUME_AT);
 await useStep('afterSleep')();
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(pendingStepNames(ctx)).toEqual(['afterSleep']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[2], 'wait_created');
 });

 it('still reports divergence for an event repeating nothing in the log', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // Belongs to no entity this workflow ever creates: the sleep below mints
 // CORR_IDS[1]. Nothing can consume it, and nothing should suppress it.
 event(3, 'wait_created', 'wait_01JZZZZZZZZZZZZZZZZZZZZZZZ', {
 resumeAt: RESUME_AT,
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await useStep('stepA')();
 await sleep(RESUME_AT);
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(false);
 expect(String(error)).toContain('Unconsumed event in event log');
 expect(onDuplicateEvent).not.toHaveBeenCalled();
 });
});
Loading

, '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 #3381: [core] Ignore duplicate events per event class instead of failing the run by github-actions[bot] · Pull Request #3487 · vercel/workflow · GitHub
Skip to content
Backport #3381: [core] Ignore duplicate events per event class instead of failing the run#3487

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 #3381: [core] Ignore duplicate events per event class instead of failing the run
#3487
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


6 changes: 6 additions & 0 deletions
.changeset/dull-hats-melt.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@workflow/core': patch
'@workflow/world': patch
---

Ignore duplicate events that a concurrent replay wrote for an entity the event log already records, instead of failing the run with a corrupted event log

153 changes: 153 additions & 0 deletions
packages/core/src/duplicate-events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import type { Event } from '@workflow/world';
import { describe, expect, it, vi } from 'vitest';
import { WorkflowSuspension } from './global.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { createUseStep } from './step.js';
import {
 CORR_IDS,
 runWithDiscontinuation,
 setupWorkflowContext,
} from './test-support/orchestrator-context.js';
import { createSleep } from './workflow/sleep.js';

/**
 * Concurrent replays of one run share a single event log and write to it
 * without a currency guard, so a replay working from a stale prefix can commit
 * a second `step_created` / `step_started` / `wait_created` for an entity the
 * log already records one of. Those writes are committed but inert: every
 * replay reads the first event of that class at the same position, so the
 * straggler cannot change what the workflow observes.
 *
 * Before this behavior existed the straggler had no consumer left to claim it
 * (the entity's consumer deregistered when it took the step's result), which
 * surfaced as `ReplayDivergenceError` and, after retries, a terminal
 * `CORRUPTED_EVENT_LOG` on a run whose log was fine.
 *
 * These tests drive the real step and sleep primitives against hand-written
 * logs. The unit-level behavior lives in `events-consumer.test.ts`.
 */

const RESUME_AT = new Date('2099-01-01T00:00:00.000Z');

async function dehydrate(value: unknown) {
 const ops: Promise<unknown>[] = [];
 return await dehydrateStepReturnValue(value, 'wrun_test', undefined, ops);
}

function event(
 index: number,
 eventType: string,
 correlationId: string,
 eventData: Record<string, unknown>
): Event {
 return {
 eventId: `evnt_${index}`,
 runId: 'wrun_test',
 eventType,
 correlationId,
 eventData,
 createdAt: new Date(),
 } as unknown as Event;
}

function pendingStepNames(ctx: ReturnType<typeof setupWorkflowContext>) {
 return [...ctx.invocationsQueue.values()]
 .filter((i) => i.type === 'step')
 .map((i) => (i.type === 'step' ? i.stepName : undefined));
}

describe('events repeating a class already in the log', () => {
 it('ignores a step_started that lands after the step completed', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // A concurrent replay that had not yet seen evnt_2 re-invokes stepA.
 event(3, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(4, 'step_created', `step_${CORR_IDS[1]}`, { stepName: 'stepB' }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const useStep = createUseStep(ctx);

 const observed: unknown[] = [];
 const { error } = await runWithDiscontinuation(ctx, async () => {
 const stepA = useStep('stepA');
 const stepB = useStep('stepB');
 observed.push(await stepA());
 observed.push(await stepB());
 return 'done';
 });

 // Suspension, not divergence: the run is waiting on stepB.
 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(observed).toEqual(['a-result']);
 expect(pendingStepNames(ctx)).toEqual(['stepB']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[3], 'step_started');
 });

 it('ignores a wait_created that lands after the wait completed', async () => {
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(1, 'wait_completed', `wait_${CORR_IDS[0]}`, {
 resumeAt: RESUME_AT,
 }),
 // A concurrent replay that had not yet seen evnt_1 re-created the sleep.
 event(2, 'wait_created', `wait_${CORR_IDS[0]}`, { resumeAt: RESUME_AT }),
 event(3, 'step_created', `step_${CORR_IDS[1]}`, {
 stepName: 'afterSleep',
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await sleep(RESUME_AT);
 await useStep('afterSleep')();
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(true);
 expect(pendingStepNames(ctx)).toEqual(['afterSleep']);
 expect(onDuplicateEvent).toHaveBeenCalledTimes(1);
 expect(onDuplicateEvent).toHaveBeenCalledWith(events[2], 'wait_created');
 });

 it('still reports divergence for an event repeating nothing in the log', async () => {
 const result = await dehydrate('a-result');
 const onDuplicateEvent = vi.fn();
 const events = [
 event(0, 'step_created', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(1, 'step_started', `step_${CORR_IDS[0]}`, { stepName: 'stepA' }),
 event(2, 'step_completed', `step_${CORR_IDS[0]}`, {
 stepName: 'stepA',
 result,
 }),
 // Belongs to no entity this workflow ever creates: the sleep below mints
 // CORR_IDS[1]. Nothing can consume it, and nothing should suppress it.
 event(3, 'wait_created', 'wait_01JZZZZZZZZZZZZZZZZZZZZZZZ', {
 resumeAt: RESUME_AT,
 }),
 ];
 const ctx = setupWorkflowContext(events, { onDuplicateEvent });
 const sleep = createSleep(ctx);
 const useStep = createUseStep(ctx);

 const { error } = await runWithDiscontinuation(ctx, async () => {
 await useStep('stepA')();
 await sleep(RESUME_AT);
 return 'done';
 });

 expect(WorkflowSuspension.is(error)).toBe(false);
 expect(String(error)).toContain('Unconsumed event in event log');
 expect(onDuplicateEvent).not.toHaveBeenCalled();
 });
});
Loading