Skip to content

Backport #2580: Send occurredAt with workflow events#2589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
karthikscale3 merged 2 commits into from
Jun 23, 2026
Merged

Backport #2580: Send occurredAt with workflow events #2589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5110e11
Send occurredAt with workflow events (#2580)
github-actions[bot] Jun 23, 2026
c0544f2
Merge branch 'stable' into backport/pr-2580-to-stable
karthikscale3 Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/send-event-occurred-at.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/world-postgres': patch
---

Send optional client-side event occurrence timestamps through world event creation.
2 changes: 1 addition & 1 deletion packages/world-postgres/src/drizzle/schema.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ export const events = schema.table(
eventData: Cbor<unknown>()('payload_cbor'),
specVersion: integer('spec_version'),
} satisfies DrizzlishOfType<
Cborized<Event & { eventData?: undefined }, 'eventData'>
Cborized<Omit<Event, 'occurredAt'> & { eventData?: undefined }, 'eventData'>
>,
(tb) => [
index().on(tb.runId),
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@@ -54,6 +54,8 @@ export interface CreateEventV4Input {
specVersion: number;
correlationId?: string;
vercelId?: string;
/** Client-side time at which the event occurred. */
occurredAt?: Date;
remoteRefBehavior?: 'resolve' | 'lazy';
deploymentId?: string;
workflowName?: string;
Expand DownExpand Up@@ -119,6 +121,7 @@ function buildPostFrameMeta(
if (input.correlationId !== undefined)
meta.correlationId = input.correlationId;
if (input.vercelId !== undefined) meta.vercelId = input.vercelId;
if (input.occurredAt !== undefined) meta.occurredAt = input.occurredAt;
if (input.remoteRefBehavior !== undefined) {
meta.remoteRefBehavior = input.remoteRefBehavior;
}
Expand DownExpand Up@@ -277,6 +280,7 @@ export interface DecodedV4Event {
eventType: string;
correlationId?: string;
createdAt: Date | string;
occurredAt?: Date | string;
specVersion?: number;
eventData?: Record<string, unknown>;
}
Expand Down
66 changes: 65 additions & 1 deletion packages/world-vercel/src/events.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { AnyEventRequest } from '@workflow/world';
import { encode } from 'cbor-x';
import { decode, encode } from 'cbor-x';
import { MockAgent } from 'undici';
import { describe, expect, it } from 'vitest';
import {
Expand All@@ -17,6 +17,19 @@ function mockAgent() {
return agent;
}

function decodePostedMeta(rawBody: unknown): Record<string, unknown> {
const bytes =
typeof rawBody === 'string'
? new TextEncoder().encode(rawBody)
: new Uint8Array(rawBody as ArrayBufferLike);
const metaLen = new DataView(
bytes.buffer,
bytes.byteOffset,
bytes.byteLength
).getUint32(0, false);
return decode(bytes.subarray(4, 4 + metaLen)) as Record<string, unknown>;
}

/**
* Legacy (spec-version-1) runs predate event sourcing: the runtime still
* posts hook_received (resumeHook) and wait_completed (wakeUpRun) for them
Expand DownExpand Up@@ -212,6 +225,52 @@ describe('splitEventDataForV4 hook fields', () => {
});

describe('createWorkflowRunEvent response coercion', () => {
it('sends occurredAt in the v4 frame meta', async () => {
const agent = mockAgent();
const occurredAt = new Date('2026-06-10T00:00:03.000Z');
let capturedMeta: Record<string, unknown> | undefined;

agent
.get(ORIGIN)
.intercept({
path: '/api/v4/runs/wrun_1/events/run_started',
method: 'POST',
})
.reply(
200,
(opts: { body?: unknown }) => {
capturedMeta = decodePostedMeta(opts.body);
return encode({
run: {
runId: 'wrun_1',
status: 'running',
startedAt: new Date('2026-06-10T00:00:04.000Z'),
},
});
},
{
headers: {
'x-wf-event-id': 'evnt_1',
'x-wf-run-id': 'wrun_1',
'x-wf-created-at': '2026-06-10T00:00:04.000Z',
},
}
);

await createWorkflowRunEvent(
'wrun_1',
{ eventType: 'run_started', specVersion: 2 } as AnyEventRequest,
{ occurredAt },
{ token: 'test-token', dispatcher: agent }
);

expect(capturedMeta?.occurredAt).toBeInstanceOf(Date);
expect((capturedMeta?.occurredAt as Date).getTime()).toBe(
occurredAt.getTime()
);
agent.assertNoPendingInterceptors();
});

it('coerces ISO-string dates in the returned event and preloaded events', async () => {
// Persisted events store nested eventData dates as ISO strings
// (the backend's entity layer converts Date → toISOString on write with
Expand DownExpand Up@@ -239,6 +298,7 @@ describe('createWorkflowRunEvent response coercion', () => {
runId: 'wrun_1',
eventType: 'run_started',
createdAt: '2026-06-10T00:00:01.000Z',
occurredAt: '2026-06-10T00:00:00.500Z',
eventData: {},
},
events: [
Expand All@@ -248,6 +308,7 @@ describe('createWorkflowRunEvent response coercion', () => {
eventType: 'wait_created',
correlationId: 'wait_1',
createdAt: '2026-06-10T00:00:02.000Z',
occurredAt: '2026-06-10T00:00:01.500Z',
specVersion: 2,
eventData: { resumeAt: '2026-06-10T01:00:00.000Z' },
},
Expand All@@ -272,11 +333,14 @@ describe('createWorkflowRunEvent response coercion', () => {
);

expect(result.event?.createdAt).toBeInstanceOf(Date);
expect(result.event?.occurredAt).toBeInstanceOf(Date);
const preloaded = result.events?.[0] as {
createdAt: Date;
occurredAt: Date;
eventData: { resumeAt: Date };
};
expect(preloaded.createdAt).toBeInstanceOf(Date);
expect(preloaded.occurredAt).toBeInstanceOf(Date);
expect(preloaded.eventData.resumeAt).toBeInstanceOf(Date);
expect(preloaded.eventData.resumeAt.getTime()).toBe(
new Date('2026-06-10T01:00:00.000Z').getTime()
Expand Down
9 changes: 9 additions & 0 deletions packages/world-vercel/src/events.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -461,6 +461,14 @@ function buildEventFromV4(
decoded.createdAt instanceof Date
? decoded.createdAt
: new Date(decoded.createdAt),
...(decoded.occurredAt !== undefined
? {
occurredAt:
decoded.occurredAt instanceof Date
? decoded.occurredAt
: new Date(decoded.occurredAt),
}
: {}),
...(decoded.correlationId ? { correlationId: decoded.correlationId } : {}),
eventData,
...(decoded.specVersion !== undefined
Expand DownExpand Up@@ -619,6 +627,7 @@ async function createWorkflowRunEventInner(
specVersion: data.specVersion ?? 2,
...(data.correlationId ? { correlationId: data.correlationId } : {}),
...(params?.requestId ? { vercelId: params.requestId } : {}),
occurredAt: params?.occurredAt ?? new Date(),
remoteRefBehavior,
payload,
...meta,
Expand Down
7 changes: 7 additions & 0 deletions packages/world/src/events.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,7 @@ export const EventSchema = AllEventsSchema.and(
runId: z.string(),
eventId: z.string(),
createdAt: z.coerce.date(),
occurredAt: z.coerce.date().optional(),
specVersion: z.number().optional(),
})
);
Expand DownExpand Up@@ -397,6 +398,12 @@ export interface CreateEventParams {
resolveData?: ResolveData;
/** Request ID (x-vercel-id when on Vercel) for correlating request logs with workflow events. */
requestId?: string;
/**
* Timestamp for when the event occurred on the client side. Worlds that
* support this can persist it separately from `createdAt`, which represents
* when the backing service accepted or stored the event.
*/
occurredAt?: Date;
}

/**
Expand Down
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 #2580: Send occurredAt with workflow events by github-actions[bot] · Pull Request #2589 · vercel/workflow · GitHub
Skip to content
Backport #2580: Send occurredAt with workflow events#2589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

karthikscale3
merged 2 commits into

from

Jun 23, 2026
 Merged


Backport #2580: Send occurredAt with workflow events
#2589
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5110e11

Send occurredAt with workflow events (#2580)


github-actions[bot] Jun 23, 2026
c0544f2

Merge branch 'stable' into backport/pr-2580-to-stable


karthikscale3 Jun 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/send-event-occurred-at.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/world-postgres': patch
---

Send optional client-side event occurrence timestamps through world event creation.

2 changes: 1 addition & 1 deletion
packages/world-postgres/src/drizzle/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ export const events = schema.table(
 eventData: Cbor<unknown>()('payload_cbor'),
 specVersion: integer('spec_version'),
 } satisfies DrizzlishOfType<
 Cborized<Event & { eventData?: undefined }, 'eventData'>
 Cborized<Omit<Event, 'occurredAt'> & { eventData?: undefined }, 'eventData'>
 >,
 (tb) => [
 index().on(tb.runId),
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@@ -54,6 +54,8 @@ export interface CreateEventV4Input {
 specVersion: number;
 correlationId?: string;
 vercelId?: string;
 /** Client-side time at which the event occurred. */
 occurredAt?: Date;
 remoteRefBehavior?: 'resolve' | 'lazy';
 deploymentId?: string;
 workflowName?: string;
Expand DownExpand Up@@ -119,6 +121,7 @@ function buildPostFrameMeta(
 if (input.correlationId !== undefined)
 meta.correlationId = input.correlationId;
 if (input.vercelId !== undefined) meta.vercelId = input.vercelId;
 if (input.occurredAt !== undefined) meta.occurredAt = input.occurredAt;
 if (input.remoteRefBehavior !== undefined) {
 meta.remoteRefBehavior = input.remoteRefBehavior;
 }
Expand DownExpand Up@@ -277,6 +280,7 @@ export interface DecodedV4Event {
 eventType: string;
 correlationId?: string;
 createdAt: Date | string;
 occurredAt?: Date | string;
 specVersion?: number;
 eventData?: Record<string, unknown>;
}
Expand Down

66 changes: 65 additions & 1 deletion
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { AnyEventRequest } from '@workflow/world';
import { encode } from 'cbor-x';
import { decode, encode } from 'cbor-x';
import { MockAgent } from 'undici';
import { describe, expect, it } from 'vitest';
import {
Expand All@@ -17,6 +17,19 @@ function mockAgent() {
 return agent;
}

function decodePostedMeta(rawBody: unknown): Record<string, unknown> {
 const bytes =
 typeof rawBody === 'string'
 ? new TextEncoder().encode(rawBody)
 : new Uint8Array(rawBody as ArrayBufferLike);
 const metaLen = new DataView(
 bytes.buffer,
 bytes.byteOffset,
 bytes.byteLength
 ).getUint32(0, false);
 return decode(bytes.subarray(4, 4 + metaLen)) as Record<string, unknown>;
}

/**
 * Legacy (spec-version-1) runs predate event sourcing: the runtime still
 * posts hook_received (resumeHook) and wait_completed (wakeUpRun) for them
Expand DownExpand Up@@ -212,6 +225,52 @@ describe('splitEventDataForV4 hook fields', () => {
});

describe('createWorkflowRunEvent response coercion', () => {
 it('sends occurredAt in the v4 frame meta', async () => {
 const agent = mockAgent();
 const occurredAt = new Date('2026-06-10T00:00:03.000Z');
 let capturedMeta: Record<string, unknown> | undefined;

 agent
 .get(ORIGIN)
 .intercept({
 path: '/api/v4/runs/wrun_1/events/run_started',
 method: 'POST',
 })
 .reply(
 200,
 (opts: { body?: unknown }) => {
 capturedMeta = decodePostedMeta(opts.body);
 return encode({
 run: {
 runId: 'wrun_1',
 status: 'running',
 startedAt: new Date('2026-06-10T00:00:04.000Z'),
 },
 });
 },
 {
 headers: {
 'x-wf-event-id': 'evnt_1',
 'x-wf-run-id': 'wrun_1',
 'x-wf-created-at': '2026-06-10T00:00:04.000Z',
 },
 }
 );

 await createWorkflowRunEvent(
 'wrun_1',
 { eventType: 'run_started', specVersion: 2 } as AnyEventRequest,
 { occurredAt },
 { token: 'test-token', dispatcher: agent }
 );

 expect(capturedMeta?.occurredAt).toBeInstanceOf(Date);
 expect((capturedMeta?.occurredAt as Date).getTime()).toBe(
 occurredAt.getTime()
 );
 agent.assertNoPendingInterceptors();
 });

 it('coerces ISO-string dates in the returned event and preloaded events', async () => {
 // Persisted events store nested eventData dates as ISO strings
 // (the backend's entity layer converts Date → toISOString on write with
Expand DownExpand Up@@ -239,6 +298,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 runId: 'wrun_1',
 eventType: 'run_started',
 createdAt: '2026-06-10T00:00:01.000Z',
 occurredAt: '2026-06-10T00:00:00.500Z',
 eventData: {},
 },
 events: [
Expand All@@ -248,6 +308,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 eventType: 'wait_created',
 correlationId: 'wait_1',
 createdAt: '2026-06-10T00:00:02.000Z',
 occurredAt: '2026-06-10T00:00:01.500Z',
 specVersion: 2,
 eventData: { resumeAt: '2026-06-10T01:00:00.000Z' },
 },
Expand All@@ -272,11 +333,14 @@ describe('createWorkflowRunEvent response coercion', () => {
 );

 expect(result.event?.createdAt).toBeInstanceOf(Date);
 expect(result.event?.occurredAt).toBeInstanceOf(Date);
 const preloaded = result.events?.[0] as {
 createdAt: Date;
 occurredAt: Date;
 eventData: { resumeAt: Date };
 };
 expect(preloaded.createdAt).toBeInstanceOf(Date);
 expect(preloaded.occurredAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt.getTime()).toBe(
 new Date('2026-06-10T01:00:00.000Z').getTime()
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -461,6 +461,14 @@ function buildEventFromV4(
 decoded.createdAt instanceof Date
 ? decoded.createdAt
 : new Date(decoded.createdAt),
 ...(decoded.occurredAt !== undefined
 ? {
 occurredAt:
 decoded.occurredAt instanceof Date
 ? decoded.occurredAt
 : new Date(decoded.occurredAt),
 }
 : {}),
 ...(decoded.correlationId ? { correlationId: decoded.correlationId } : {}),
 eventData,
 ...(decoded.specVersion !== undefined
Expand DownExpand Up@@ -619,6 +627,7 @@ async function createWorkflowRunEventInner(
 specVersion: data.specVersion ?? 2,
 ...(data.correlationId ? { correlationId: data.correlationId } : {}),
 ...(params?.requestId ? { vercelId: params.requestId } : {}),
 occurredAt: params?.occurredAt ?? new Date(),
 remoteRefBehavior,
 payload,
 ...meta,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,7 @@ export const EventSchema = AllEventsSchema.and(
 runId: z.string(),
 eventId: z.string(),
 createdAt: z.coerce.date(),
 occurredAt: z.coerce.date().optional(),
 specVersion: z.number().optional(),
 })
);
Expand DownExpand Up@@ -397,6 +398,12 @@ export interface CreateEventParams {
 resolveData?: ResolveData;
 /** Request ID (x-vercel-id when on Vercel) for correlating request logs with workflow events. */
 requestId?: string;
 /**
 * Timestamp for when the event occurred on the client side. Worlds that
 * support this can persist it separately from `createdAt`, which represents
 * when the backing service accepted or stored the event.
 */
 occurredAt?: Date;
}

/**
Expand Down
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 #2580: Send occurredAt with workflow events by github-actions[bot] · Pull Request #2589 · vercel/workflow · GitHub
Skip to content
Backport #2580: Send occurredAt with workflow events#2589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

karthikscale3
merged 2 commits into

from

Jun 23, 2026
 Merged


Backport #2580: Send occurredAt with workflow events
#2589
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5110e11

Send occurredAt with workflow events (#2580)


github-actions[bot] Jun 23, 2026
c0544f2

Merge branch 'stable' into backport/pr-2580-to-stable


karthikscale3 Jun 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/send-event-occurred-at.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/world-postgres': patch
---

Send optional client-side event occurrence timestamps through world event creation.

2 changes: 1 addition & 1 deletion
packages/world-postgres/src/drizzle/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ export const events = schema.table(
 eventData: Cbor<unknown>()('payload_cbor'),
 specVersion: integer('spec_version'),
 } satisfies DrizzlishOfType<
 Cborized<Event & { eventData?: undefined }, 'eventData'>
 Cborized<Omit<Event, 'occurredAt'> & { eventData?: undefined }, 'eventData'>
 >,
 (tb) => [
 index().on(tb.runId),
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@@ -54,6 +54,8 @@ export interface CreateEventV4Input {
 specVersion: number;
 correlationId?: string;
 vercelId?: string;
 /** Client-side time at which the event occurred. */
 occurredAt?: Date;
 remoteRefBehavior?: 'resolve' | 'lazy';
 deploymentId?: string;
 workflowName?: string;
Expand DownExpand Up@@ -119,6 +121,7 @@ function buildPostFrameMeta(
 if (input.correlationId !== undefined)
 meta.correlationId = input.correlationId;
 if (input.vercelId !== undefined) meta.vercelId = input.vercelId;
 if (input.occurredAt !== undefined) meta.occurredAt = input.occurredAt;
 if (input.remoteRefBehavior !== undefined) {
 meta.remoteRefBehavior = input.remoteRefBehavior;
 }
Expand DownExpand Up@@ -277,6 +280,7 @@ export interface DecodedV4Event {
 eventType: string;
 correlationId?: string;
 createdAt: Date | string;
 occurredAt?: Date | string;
 specVersion?: number;
 eventData?: Record<string, unknown>;
}
Expand Down

66 changes: 65 additions & 1 deletion
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { AnyEventRequest } from '@workflow/world';
import { encode } from 'cbor-x';
import { decode, encode } from 'cbor-x';
import { MockAgent } from 'undici';
import { describe, expect, it } from 'vitest';
import {
Expand All@@ -17,6 +17,19 @@ function mockAgent() {
 return agent;
}

function decodePostedMeta(rawBody: unknown): Record<string, unknown> {
 const bytes =
 typeof rawBody === 'string'
 ? new TextEncoder().encode(rawBody)
 : new Uint8Array(rawBody as ArrayBufferLike);
 const metaLen = new DataView(
 bytes.buffer,
 bytes.byteOffset,
 bytes.byteLength
 ).getUint32(0, false);
 return decode(bytes.subarray(4, 4 + metaLen)) as Record<string, unknown>;
}

/**
 * Legacy (spec-version-1) runs predate event sourcing: the runtime still
 * posts hook_received (resumeHook) and wait_completed (wakeUpRun) for them
Expand DownExpand Up@@ -212,6 +225,52 @@ describe('splitEventDataForV4 hook fields', () => {
});

describe('createWorkflowRunEvent response coercion', () => {
 it('sends occurredAt in the v4 frame meta', async () => {
 const agent = mockAgent();
 const occurredAt = new Date('2026-06-10T00:00:03.000Z');
 let capturedMeta: Record<string, unknown> | undefined;

 agent
 .get(ORIGIN)
 .intercept({
 path: '/api/v4/runs/wrun_1/events/run_started',
 method: 'POST',
 })
 .reply(
 200,
 (opts: { body?: unknown }) => {
 capturedMeta = decodePostedMeta(opts.body);
 return encode({
 run: {
 runId: 'wrun_1',
 status: 'running',
 startedAt: new Date('2026-06-10T00:00:04.000Z'),
 },
 });
 },
 {
 headers: {
 'x-wf-event-id': 'evnt_1',
 'x-wf-run-id': 'wrun_1',
 'x-wf-created-at': '2026-06-10T00:00:04.000Z',
 },
 }
 );

 await createWorkflowRunEvent(
 'wrun_1',
 { eventType: 'run_started', specVersion: 2 } as AnyEventRequest,
 { occurredAt },
 { token: 'test-token', dispatcher: agent }
 );

 expect(capturedMeta?.occurredAt).toBeInstanceOf(Date);
 expect((capturedMeta?.occurredAt as Date).getTime()).toBe(
 occurredAt.getTime()
 );
 agent.assertNoPendingInterceptors();
 });

 it('coerces ISO-string dates in the returned event and preloaded events', async () => {
 // Persisted events store nested eventData dates as ISO strings
 // (the backend's entity layer converts Date → toISOString on write with
Expand DownExpand Up@@ -239,6 +298,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 runId: 'wrun_1',
 eventType: 'run_started',
 createdAt: '2026-06-10T00:00:01.000Z',
 occurredAt: '2026-06-10T00:00:00.500Z',
 eventData: {},
 },
 events: [
Expand All@@ -248,6 +308,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 eventType: 'wait_created',
 correlationId: 'wait_1',
 createdAt: '2026-06-10T00:00:02.000Z',
 occurredAt: '2026-06-10T00:00:01.500Z',
 specVersion: 2,
 eventData: { resumeAt: '2026-06-10T01:00:00.000Z' },
 },
Expand All@@ -272,11 +333,14 @@ describe('createWorkflowRunEvent response coercion', () => {
 );

 expect(result.event?.createdAt).toBeInstanceOf(Date);
 expect(result.event?.occurredAt).toBeInstanceOf(Date);
 const preloaded = result.events?.[0] as {
 createdAt: Date;
 occurredAt: Date;
 eventData: { resumeAt: Date };
 };
 expect(preloaded.createdAt).toBeInstanceOf(Date);
 expect(preloaded.occurredAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt.getTime()).toBe(
 new Date('2026-06-10T01:00:00.000Z').getTime()
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -461,6 +461,14 @@ function buildEventFromV4(
 decoded.createdAt instanceof Date
 ? decoded.createdAt
 : new Date(decoded.createdAt),
 ...(decoded.occurredAt !== undefined
 ? {
 occurredAt:
 decoded.occurredAt instanceof Date
 ? decoded.occurredAt
 : new Date(decoded.occurredAt),
 }
 : {}),
 ...(decoded.correlationId ? { correlationId: decoded.correlationId } : {}),
 eventData,
 ...(decoded.specVersion !== undefined
Expand DownExpand Up@@ -619,6 +627,7 @@ async function createWorkflowRunEventInner(
 specVersion: data.specVersion ?? 2,
 ...(data.correlationId ? { correlationId: data.correlationId } : {}),
 ...(params?.requestId ? { vercelId: params.requestId } : {}),
 occurredAt: params?.occurredAt ?? new Date(),
 remoteRefBehavior,
 payload,
 ...meta,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,7 @@ export const EventSchema = AllEventsSchema.and(
 runId: z.string(),
 eventId: z.string(),
 createdAt: z.coerce.date(),
 occurredAt: z.coerce.date().optional(),
 specVersion: z.number().optional(),
 })
);
Expand DownExpand Up@@ -397,6 +398,12 @@ export interface CreateEventParams {
 resolveData?: ResolveData;
 /** Request ID (x-vercel-id when on Vercel) for correlating request logs with workflow events. */
 requestId?: string;
 /**
 * Timestamp for when the event occurred on the client side. Worlds that
 * support this can persist it separately from `createdAt`, which represents
 * when the backing service accepted or stored the event.
 */
 occurredAt?: Date;
}

/**
Expand Down
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 #2580: Send occurredAt with workflow events by github-actions[bot] · Pull Request #2589 · vercel/workflow · GitHub
Skip to content
Backport #2580: Send occurredAt with workflow events#2589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

karthikscale3
merged 2 commits into

from

Jun 23, 2026
 Merged


Backport #2580: Send occurredAt with workflow events
#2589
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5110e11

Send occurredAt with workflow events (#2580)


github-actions[bot] Jun 23, 2026
c0544f2

Merge branch 'stable' into backport/pr-2580-to-stable


karthikscale3 Jun 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/send-event-occurred-at.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/world-postgres': patch
---

Send optional client-side event occurrence timestamps through world event creation.

2 changes: 1 addition & 1 deletion
packages/world-postgres/src/drizzle/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ export const events = schema.table(
 eventData: Cbor<unknown>()('payload_cbor'),
 specVersion: integer('spec_version'),
 } satisfies DrizzlishOfType<
 Cborized<Event & { eventData?: undefined }, 'eventData'>
 Cborized<Omit<Event, 'occurredAt'> & { eventData?: undefined }, 'eventData'>
 >,
 (tb) => [
 index().on(tb.runId),
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@@ -54,6 +54,8 @@ export interface CreateEventV4Input {
 specVersion: number;
 correlationId?: string;
 vercelId?: string;
 /** Client-side time at which the event occurred. */
 occurredAt?: Date;
 remoteRefBehavior?: 'resolve' | 'lazy';
 deploymentId?: string;
 workflowName?: string;
Expand DownExpand Up@@ -119,6 +121,7 @@ function buildPostFrameMeta(
 if (input.correlationId !== undefined)
 meta.correlationId = input.correlationId;
 if (input.vercelId !== undefined) meta.vercelId = input.vercelId;
 if (input.occurredAt !== undefined) meta.occurredAt = input.occurredAt;
 if (input.remoteRefBehavior !== undefined) {
 meta.remoteRefBehavior = input.remoteRefBehavior;
 }
Expand DownExpand Up@@ -277,6 +280,7 @@ export interface DecodedV4Event {
 eventType: string;
 correlationId?: string;
 createdAt: Date | string;
 occurredAt?: Date | string;
 specVersion?: number;
 eventData?: Record<string, unknown>;
}
Expand Down

66 changes: 65 additions & 1 deletion
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { AnyEventRequest } from '@workflow/world';
import { encode } from 'cbor-x';
import { decode, encode } from 'cbor-x';
import { MockAgent } from 'undici';
import { describe, expect, it } from 'vitest';
import {
Expand All@@ -17,6 +17,19 @@ function mockAgent() {
 return agent;
}

function decodePostedMeta(rawBody: unknown): Record<string, unknown> {
 const bytes =
 typeof rawBody === 'string'
 ? new TextEncoder().encode(rawBody)
 : new Uint8Array(rawBody as ArrayBufferLike);
 const metaLen = new DataView(
 bytes.buffer,
 bytes.byteOffset,
 bytes.byteLength
 ).getUint32(0, false);
 return decode(bytes.subarray(4, 4 + metaLen)) as Record<string, unknown>;
}

/**
 * Legacy (spec-version-1) runs predate event sourcing: the runtime still
 * posts hook_received (resumeHook) and wait_completed (wakeUpRun) for them
Expand DownExpand Up@@ -212,6 +225,52 @@ describe('splitEventDataForV4 hook fields', () => {
});

describe('createWorkflowRunEvent response coercion', () => {
 it('sends occurredAt in the v4 frame meta', async () => {
 const agent = mockAgent();
 const occurredAt = new Date('2026-06-10T00:00:03.000Z');
 let capturedMeta: Record<string, unknown> | undefined;

 agent
 .get(ORIGIN)
 .intercept({
 path: '/api/v4/runs/wrun_1/events/run_started',
 method: 'POST',
 })
 .reply(
 200,
 (opts: { body?: unknown }) => {
 capturedMeta = decodePostedMeta(opts.body);
 return encode({
 run: {
 runId: 'wrun_1',
 status: 'running',
 startedAt: new Date('2026-06-10T00:00:04.000Z'),
 },
 });
 },
 {
 headers: {
 'x-wf-event-id': 'evnt_1',
 'x-wf-run-id': 'wrun_1',
 'x-wf-created-at': '2026-06-10T00:00:04.000Z',
 },
 }
 );

 await createWorkflowRunEvent(
 'wrun_1',
 { eventType: 'run_started', specVersion: 2 } as AnyEventRequest,
 { occurredAt },
 { token: 'test-token', dispatcher: agent }
 );

 expect(capturedMeta?.occurredAt).toBeInstanceOf(Date);
 expect((capturedMeta?.occurredAt as Date).getTime()).toBe(
 occurredAt.getTime()
 );
 agent.assertNoPendingInterceptors();
 });

 it('coerces ISO-string dates in the returned event and preloaded events', async () => {
 // Persisted events store nested eventData dates as ISO strings
 // (the backend's entity layer converts Date → toISOString on write with
Expand DownExpand Up@@ -239,6 +298,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 runId: 'wrun_1',
 eventType: 'run_started',
 createdAt: '2026-06-10T00:00:01.000Z',
 occurredAt: '2026-06-10T00:00:00.500Z',
 eventData: {},
 },
 events: [
Expand All@@ -248,6 +308,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 eventType: 'wait_created',
 correlationId: 'wait_1',
 createdAt: '2026-06-10T00:00:02.000Z',
 occurredAt: '2026-06-10T00:00:01.500Z',
 specVersion: 2,
 eventData: { resumeAt: '2026-06-10T01:00:00.000Z' },
 },
Expand All@@ -272,11 +333,14 @@ describe('createWorkflowRunEvent response coercion', () => {
 );

 expect(result.event?.createdAt).toBeInstanceOf(Date);
 expect(result.event?.occurredAt).toBeInstanceOf(Date);
 const preloaded = result.events?.[0] as {
 createdAt: Date;
 occurredAt: Date;
 eventData: { resumeAt: Date };
 };
 expect(preloaded.createdAt).toBeInstanceOf(Date);
 expect(preloaded.occurredAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt.getTime()).toBe(
 new Date('2026-06-10T01:00:00.000Z').getTime()
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -461,6 +461,14 @@ function buildEventFromV4(
 decoded.createdAt instanceof Date
 ? decoded.createdAt
 : new Date(decoded.createdAt),
 ...(decoded.occurredAt !== undefined
 ? {
 occurredAt:
 decoded.occurredAt instanceof Date
 ? decoded.occurredAt
 : new Date(decoded.occurredAt),
 }
 : {}),
 ...(decoded.correlationId ? { correlationId: decoded.correlationId } : {}),
 eventData,
 ...(decoded.specVersion !== undefined
Expand DownExpand Up@@ -619,6 +627,7 @@ async function createWorkflowRunEventInner(
 specVersion: data.specVersion ?? 2,
 ...(data.correlationId ? { correlationId: data.correlationId } : {}),
 ...(params?.requestId ? { vercelId: params.requestId } : {}),
 occurredAt: params?.occurredAt ?? new Date(),
 remoteRefBehavior,
 payload,
 ...meta,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,7 @@ export const EventSchema = AllEventsSchema.and(
 runId: z.string(),
 eventId: z.string(),
 createdAt: z.coerce.date(),
 occurredAt: z.coerce.date().optional(),
 specVersion: z.number().optional(),
 })
);
Expand DownExpand Up@@ -397,6 +398,12 @@ export interface CreateEventParams {
 resolveData?: ResolveData;
 /** Request ID (x-vercel-id when on Vercel) for correlating request logs with workflow events. */
 requestId?: string;
 /**
 * Timestamp for when the event occurred on the client side. Worlds that
 * support this can persist it separately from `createdAt`, which represents
 * when the backing service accepted or stored the event.
 */
 occurredAt?: Date;
}

/**
Expand Down
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 #2580: Send occurredAt with workflow events by github-actions[bot] · Pull Request #2589 · vercel/workflow · GitHub
Skip to content
Backport #2580: Send occurredAt with workflow events#2589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

karthikscale3
merged 2 commits into

from

Jun 23, 2026
 Merged


Backport #2580: Send occurredAt with workflow events
#2589
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5110e11

Send occurredAt with workflow events (#2580)


github-actions[bot] Jun 23, 2026
c0544f2

Merge branch 'stable' into backport/pr-2580-to-stable


karthikscale3 Jun 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/send-event-occurred-at.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/world-postgres': patch
---

Send optional client-side event occurrence timestamps through world event creation.

2 changes: 1 addition & 1 deletion
packages/world-postgres/src/drizzle/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ export const events = schema.table(
 eventData: Cbor<unknown>()('payload_cbor'),
 specVersion: integer('spec_version'),
 } satisfies DrizzlishOfType<
 Cborized<Event & { eventData?: undefined }, 'eventData'>
 Cborized<Omit<Event, 'occurredAt'> & { eventData?: undefined }, 'eventData'>
 >,
 (tb) => [
 index().on(tb.runId),
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@@ -54,6 +54,8 @@ export interface CreateEventV4Input {
 specVersion: number;
 correlationId?: string;
 vercelId?: string;
 /** Client-side time at which the event occurred. */
 occurredAt?: Date;
 remoteRefBehavior?: 'resolve' | 'lazy';
 deploymentId?: string;
 workflowName?: string;
Expand DownExpand Up@@ -119,6 +121,7 @@ function buildPostFrameMeta(
 if (input.correlationId !== undefined)
 meta.correlationId = input.correlationId;
 if (input.vercelId !== undefined) meta.vercelId = input.vercelId;
 if (input.occurredAt !== undefined) meta.occurredAt = input.occurredAt;
 if (input.remoteRefBehavior !== undefined) {
 meta.remoteRefBehavior = input.remoteRefBehavior;
 }
Expand DownExpand Up@@ -277,6 +280,7 @@ export interface DecodedV4Event {
 eventType: string;
 correlationId?: string;
 createdAt: Date | string;
 occurredAt?: Date | string;
 specVersion?: number;
 eventData?: Record<string, unknown>;
}
Expand Down

66 changes: 65 additions & 1 deletion
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { AnyEventRequest } from '@workflow/world';
import { encode } from 'cbor-x';
import { decode, encode } from 'cbor-x';
import { MockAgent } from 'undici';
import { describe, expect, it } from 'vitest';
import {
Expand All@@ -17,6 +17,19 @@ function mockAgent() {
 return agent;
}

function decodePostedMeta(rawBody: unknown): Record<string, unknown> {
 const bytes =
 typeof rawBody === 'string'
 ? new TextEncoder().encode(rawBody)
 : new Uint8Array(rawBody as ArrayBufferLike);
 const metaLen = new DataView(
 bytes.buffer,
 bytes.byteOffset,
 bytes.byteLength
 ).getUint32(0, false);
 return decode(bytes.subarray(4, 4 + metaLen)) as Record<string, unknown>;
}

/**
 * Legacy (spec-version-1) runs predate event sourcing: the runtime still
 * posts hook_received (resumeHook) and wait_completed (wakeUpRun) for them
Expand DownExpand Up@@ -212,6 +225,52 @@ describe('splitEventDataForV4 hook fields', () => {
});

describe('createWorkflowRunEvent response coercion', () => {
 it('sends occurredAt in the v4 frame meta', async () => {
 const agent = mockAgent();
 const occurredAt = new Date('2026-06-10T00:00:03.000Z');
 let capturedMeta: Record<string, unknown> | undefined;

 agent
 .get(ORIGIN)
 .intercept({
 path: '/api/v4/runs/wrun_1/events/run_started',
 method: 'POST',
 })
 .reply(
 200,
 (opts: { body?: unknown }) => {
 capturedMeta = decodePostedMeta(opts.body);
 return encode({
 run: {
 runId: 'wrun_1',
 status: 'running',
 startedAt: new Date('2026-06-10T00:00:04.000Z'),
 },
 });
 },
 {
 headers: {
 'x-wf-event-id': 'evnt_1',
 'x-wf-run-id': 'wrun_1',
 'x-wf-created-at': '2026-06-10T00:00:04.000Z',
 },
 }
 );

 await createWorkflowRunEvent(
 'wrun_1',
 { eventType: 'run_started', specVersion: 2 } as AnyEventRequest,
 { occurredAt },
 { token: 'test-token', dispatcher: agent }
 );

 expect(capturedMeta?.occurredAt).toBeInstanceOf(Date);
 expect((capturedMeta?.occurredAt as Date).getTime()).toBe(
 occurredAt.getTime()
 );
 agent.assertNoPendingInterceptors();
 });

 it('coerces ISO-string dates in the returned event and preloaded events', async () => {
 // Persisted events store nested eventData dates as ISO strings
 // (the backend's entity layer converts Date → toISOString on write with
Expand DownExpand Up@@ -239,6 +298,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 runId: 'wrun_1',
 eventType: 'run_started',
 createdAt: '2026-06-10T00:00:01.000Z',
 occurredAt: '2026-06-10T00:00:00.500Z',
 eventData: {},
 },
 events: [
Expand All@@ -248,6 +308,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 eventType: 'wait_created',
 correlationId: 'wait_1',
 createdAt: '2026-06-10T00:00:02.000Z',
 occurredAt: '2026-06-10T00:00:01.500Z',
 specVersion: 2,
 eventData: { resumeAt: '2026-06-10T01:00:00.000Z' },
 },
Expand All@@ -272,11 +333,14 @@ describe('createWorkflowRunEvent response coercion', () => {
 );

 expect(result.event?.createdAt).toBeInstanceOf(Date);
 expect(result.event?.occurredAt).toBeInstanceOf(Date);
 const preloaded = result.events?.[0] as {
 createdAt: Date;
 occurredAt: Date;
 eventData: { resumeAt: Date };
 };
 expect(preloaded.createdAt).toBeInstanceOf(Date);
 expect(preloaded.occurredAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt.getTime()).toBe(
 new Date('2026-06-10T01:00:00.000Z').getTime()
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -461,6 +461,14 @@ function buildEventFromV4(
 decoded.createdAt instanceof Date
 ? decoded.createdAt
 : new Date(decoded.createdAt),
 ...(decoded.occurredAt !== undefined
 ? {
 occurredAt:
 decoded.occurredAt instanceof Date
 ? decoded.occurredAt
 : new Date(decoded.occurredAt),
 }
 : {}),
 ...(decoded.correlationId ? { correlationId: decoded.correlationId } : {}),
 eventData,
 ...(decoded.specVersion !== undefined
Expand DownExpand Up@@ -619,6 +627,7 @@ async function createWorkflowRunEventInner(
 specVersion: data.specVersion ?? 2,
 ...(data.correlationId ? { correlationId: data.correlationId } : {}),
 ...(params?.requestId ? { vercelId: params.requestId } : {}),
 occurredAt: params?.occurredAt ?? new Date(),
 remoteRefBehavior,
 payload,
 ...meta,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,7 @@ export const EventSchema = AllEventsSchema.and(
 runId: z.string(),
 eventId: z.string(),
 createdAt: z.coerce.date(),
 occurredAt: z.coerce.date().optional(),
 specVersion: z.number().optional(),
 })
);
Expand DownExpand Up@@ -397,6 +398,12 @@ export interface CreateEventParams {
 resolveData?: ResolveData;
 /** Request ID (x-vercel-id when on Vercel) for correlating request logs with workflow events. */
 requestId?: string;
 /**
 * Timestamp for when the event occurred on the client side. Worlds that
 * support this can persist it separately from `createdAt`, which represents
 * when the backing service accepted or stored the event.
 */
 occurredAt?: Date;
}

/**
Expand Down
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 #2580: Send occurredAt with workflow events by github-actions[bot] · Pull Request #2589 · vercel/workflow · GitHub
Skip to content
Backport #2580: Send occurredAt with workflow events#2589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

karthikscale3
merged 2 commits into

from

Jun 23, 2026
 Merged


Backport #2580: Send occurredAt with workflow events
#2589
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5110e11

Send occurredAt with workflow events (#2580)


github-actions[bot] Jun 23, 2026
c0544f2

Merge branch 'stable' into backport/pr-2580-to-stable


karthikscale3 Jun 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/send-event-occurred-at.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/world-postgres': patch
---

Send optional client-side event occurrence timestamps through world event creation.

2 changes: 1 addition & 1 deletion
packages/world-postgres/src/drizzle/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ export const events = schema.table(
 eventData: Cbor<unknown>()('payload_cbor'),
 specVersion: integer('spec_version'),
 } satisfies DrizzlishOfType<
 Cborized<Event & { eventData?: undefined }, 'eventData'>
 Cborized<Omit<Event, 'occurredAt'> & { eventData?: undefined }, 'eventData'>
 >,
 (tb) => [
 index().on(tb.runId),
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@@ -54,6 +54,8 @@ export interface CreateEventV4Input {
 specVersion: number;
 correlationId?: string;
 vercelId?: string;
 /** Client-side time at which the event occurred. */
 occurredAt?: Date;
 remoteRefBehavior?: 'resolve' | 'lazy';
 deploymentId?: string;
 workflowName?: string;
Expand DownExpand Up@@ -119,6 +121,7 @@ function buildPostFrameMeta(
 if (input.correlationId !== undefined)
 meta.correlationId = input.correlationId;
 if (input.vercelId !== undefined) meta.vercelId = input.vercelId;
 if (input.occurredAt !== undefined) meta.occurredAt = input.occurredAt;
 if (input.remoteRefBehavior !== undefined) {
 meta.remoteRefBehavior = input.remoteRefBehavior;
 }
Expand DownExpand Up@@ -277,6 +280,7 @@ export interface DecodedV4Event {
 eventType: string;
 correlationId?: string;
 createdAt: Date | string;
 occurredAt?: Date | string;
 specVersion?: number;
 eventData?: Record<string, unknown>;
}
Expand Down

66 changes: 65 additions & 1 deletion
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { AnyEventRequest } from '@workflow/world';
import { encode } from 'cbor-x';
import { decode, encode } from 'cbor-x';
import { MockAgent } from 'undici';
import { describe, expect, it } from 'vitest';
import {
Expand All@@ -17,6 +17,19 @@ function mockAgent() {
 return agent;
}

function decodePostedMeta(rawBody: unknown): Record<string, unknown> {
 const bytes =
 typeof rawBody === 'string'
 ? new TextEncoder().encode(rawBody)
 : new Uint8Array(rawBody as ArrayBufferLike);
 const metaLen = new DataView(
 bytes.buffer,
 bytes.byteOffset,
 bytes.byteLength
 ).getUint32(0, false);
 return decode(bytes.subarray(4, 4 + metaLen)) as Record<string, unknown>;
}

/**
 * Legacy (spec-version-1) runs predate event sourcing: the runtime still
 * posts hook_received (resumeHook) and wait_completed (wakeUpRun) for them
Expand DownExpand Up@@ -212,6 +225,52 @@ describe('splitEventDataForV4 hook fields', () => {
});

describe('createWorkflowRunEvent response coercion', () => {
 it('sends occurredAt in the v4 frame meta', async () => {
 const agent = mockAgent();
 const occurredAt = new Date('2026-06-10T00:00:03.000Z');
 let capturedMeta: Record<string, unknown> | undefined;

 agent
 .get(ORIGIN)
 .intercept({
 path: '/api/v4/runs/wrun_1/events/run_started',
 method: 'POST',
 })
 .reply(
 200,
 (opts: { body?: unknown }) => {
 capturedMeta = decodePostedMeta(opts.body);
 return encode({
 run: {
 runId: 'wrun_1',
 status: 'running',
 startedAt: new Date('2026-06-10T00:00:04.000Z'),
 },
 });
 },
 {
 headers: {
 'x-wf-event-id': 'evnt_1',
 'x-wf-run-id': 'wrun_1',
 'x-wf-created-at': '2026-06-10T00:00:04.000Z',
 },
 }
 );

 await createWorkflowRunEvent(
 'wrun_1',
 { eventType: 'run_started', specVersion: 2 } as AnyEventRequest,
 { occurredAt },
 { token: 'test-token', dispatcher: agent }
 );

 expect(capturedMeta?.occurredAt).toBeInstanceOf(Date);
 expect((capturedMeta?.occurredAt as Date).getTime()).toBe(
 occurredAt.getTime()
 );
 agent.assertNoPendingInterceptors();
 });

 it('coerces ISO-string dates in the returned event and preloaded events', async () => {
 // Persisted events store nested eventData dates as ISO strings
 // (the backend's entity layer converts Date → toISOString on write with
Expand DownExpand Up@@ -239,6 +298,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 runId: 'wrun_1',
 eventType: 'run_started',
 createdAt: '2026-06-10T00:00:01.000Z',
 occurredAt: '2026-06-10T00:00:00.500Z',
 eventData: {},
 },
 events: [
Expand All@@ -248,6 +308,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 eventType: 'wait_created',
 correlationId: 'wait_1',
 createdAt: '2026-06-10T00:00:02.000Z',
 occurredAt: '2026-06-10T00:00:01.500Z',
 specVersion: 2,
 eventData: { resumeAt: '2026-06-10T01:00:00.000Z' },
 },
Expand All@@ -272,11 +333,14 @@ describe('createWorkflowRunEvent response coercion', () => {
 );

 expect(result.event?.createdAt).toBeInstanceOf(Date);
 expect(result.event?.occurredAt).toBeInstanceOf(Date);
 const preloaded = result.events?.[0] as {
 createdAt: Date;
 occurredAt: Date;
 eventData: { resumeAt: Date };
 };
 expect(preloaded.createdAt).toBeInstanceOf(Date);
 expect(preloaded.occurredAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt.getTime()).toBe(
 new Date('2026-06-10T01:00:00.000Z').getTime()
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -461,6 +461,14 @@ function buildEventFromV4(
 decoded.createdAt instanceof Date
 ? decoded.createdAt
 : new Date(decoded.createdAt),
 ...(decoded.occurredAt !== undefined
 ? {
 occurredAt:
 decoded.occurredAt instanceof Date
 ? decoded.occurredAt
 : new Date(decoded.occurredAt),
 }
 : {}),
 ...(decoded.correlationId ? { correlationId: decoded.correlationId } : {}),
 eventData,
 ...(decoded.specVersion !== undefined
Expand DownExpand Up@@ -619,6 +627,7 @@ async function createWorkflowRunEventInner(
 specVersion: data.specVersion ?? 2,
 ...(data.correlationId ? { correlationId: data.correlationId } : {}),
 ...(params?.requestId ? { vercelId: params.requestId } : {}),
 occurredAt: params?.occurredAt ?? new Date(),
 remoteRefBehavior,
 payload,
 ...meta,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,7 @@ export const EventSchema = AllEventsSchema.and(
 runId: z.string(),
 eventId: z.string(),
 createdAt: z.coerce.date(),
 occurredAt: z.coerce.date().optional(),
 specVersion: z.number().optional(),
 })
);
Expand DownExpand Up@@ -397,6 +398,12 @@ export interface CreateEventParams {
 resolveData?: ResolveData;
 /** Request ID (x-vercel-id when on Vercel) for correlating request logs with workflow events. */
 requestId?: string;
 /**
 * Timestamp for when the event occurred on the client side. Worlds that
 * support this can persist it separately from `createdAt`, which represents
 * when the backing service accepted or stored the event.
 */
 occurredAt?: Date;
}

/**
Expand Down
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 #2580: Send occurredAt with workflow events by github-actions[bot] · Pull Request #2589 · vercel/workflow · GitHub
Skip to content
Backport #2580: Send occurredAt with workflow events#2589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

karthikscale3
merged 2 commits into

from

Jun 23, 2026
 Merged


Backport #2580: Send occurredAt with workflow events
#2589
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5110e11

Send occurredAt with workflow events (#2580)


github-actions[bot] Jun 23, 2026
c0544f2

Merge branch 'stable' into backport/pr-2580-to-stable


karthikscale3 Jun 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/send-event-occurred-at.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/world-postgres': patch
---

Send optional client-side event occurrence timestamps through world event creation.

2 changes: 1 addition & 1 deletion
packages/world-postgres/src/drizzle/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ export const events = schema.table(
 eventData: Cbor<unknown>()('payload_cbor'),
 specVersion: integer('spec_version'),
 } satisfies DrizzlishOfType<
 Cborized<Event & { eventData?: undefined }, 'eventData'>
 Cborized<Omit<Event, 'occurredAt'> & { eventData?: undefined }, 'eventData'>
 >,
 (tb) => [
 index().on(tb.runId),
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@@ -54,6 +54,8 @@ export interface CreateEventV4Input {
 specVersion: number;
 correlationId?: string;
 vercelId?: string;
 /** Client-side time at which the event occurred. */
 occurredAt?: Date;
 remoteRefBehavior?: 'resolve' | 'lazy';
 deploymentId?: string;
 workflowName?: string;
Expand DownExpand Up@@ -119,6 +121,7 @@ function buildPostFrameMeta(
 if (input.correlationId !== undefined)
 meta.correlationId = input.correlationId;
 if (input.vercelId !== undefined) meta.vercelId = input.vercelId;
 if (input.occurredAt !== undefined) meta.occurredAt = input.occurredAt;
 if (input.remoteRefBehavior !== undefined) {
 meta.remoteRefBehavior = input.remoteRefBehavior;
 }
Expand DownExpand Up@@ -277,6 +280,7 @@ export interface DecodedV4Event {
 eventType: string;
 correlationId?: string;
 createdAt: Date | string;
 occurredAt?: Date | string;
 specVersion?: number;
 eventData?: Record<string, unknown>;
}
Expand Down

66 changes: 65 additions & 1 deletion
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { AnyEventRequest } from '@workflow/world';
import { encode } from 'cbor-x';
import { decode, encode } from 'cbor-x';
import { MockAgent } from 'undici';
import { describe, expect, it } from 'vitest';
import {
Expand All@@ -17,6 +17,19 @@ function mockAgent() {
 return agent;
}

function decodePostedMeta(rawBody: unknown): Record<string, unknown> {
 const bytes =
 typeof rawBody === 'string'
 ? new TextEncoder().encode(rawBody)
 : new Uint8Array(rawBody as ArrayBufferLike);
 const metaLen = new DataView(
 bytes.buffer,
 bytes.byteOffset,
 bytes.byteLength
 ).getUint32(0, false);
 return decode(bytes.subarray(4, 4 + metaLen)) as Record<string, unknown>;
}

/**
 * Legacy (spec-version-1) runs predate event sourcing: the runtime still
 * posts hook_received (resumeHook) and wait_completed (wakeUpRun) for them
Expand DownExpand Up@@ -212,6 +225,52 @@ describe('splitEventDataForV4 hook fields', () => {
});

describe('createWorkflowRunEvent response coercion', () => {
 it('sends occurredAt in the v4 frame meta', async () => {
 const agent = mockAgent();
 const occurredAt = new Date('2026-06-10T00:00:03.000Z');
 let capturedMeta: Record<string, unknown> | undefined;

 agent
 .get(ORIGIN)
 .intercept({
 path: '/api/v4/runs/wrun_1/events/run_started',
 method: 'POST',
 })
 .reply(
 200,
 (opts: { body?: unknown }) => {
 capturedMeta = decodePostedMeta(opts.body);
 return encode({
 run: {
 runId: 'wrun_1',
 status: 'running',
 startedAt: new Date('2026-06-10T00:00:04.000Z'),
 },
 });
 },
 {
 headers: {
 'x-wf-event-id': 'evnt_1',
 'x-wf-run-id': 'wrun_1',
 'x-wf-created-at': '2026-06-10T00:00:04.000Z',
 },
 }
 );

 await createWorkflowRunEvent(
 'wrun_1',
 { eventType: 'run_started', specVersion: 2 } as AnyEventRequest,
 { occurredAt },
 { token: 'test-token', dispatcher: agent }
 );

 expect(capturedMeta?.occurredAt).toBeInstanceOf(Date);
 expect((capturedMeta?.occurredAt as Date).getTime()).toBe(
 occurredAt.getTime()
 );
 agent.assertNoPendingInterceptors();
 });

 it('coerces ISO-string dates in the returned event and preloaded events', async () => {
 // Persisted events store nested eventData dates as ISO strings
 // (the backend's entity layer converts Date → toISOString on write with
Expand DownExpand Up@@ -239,6 +298,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 runId: 'wrun_1',
 eventType: 'run_started',
 createdAt: '2026-06-10T00:00:01.000Z',
 occurredAt: '2026-06-10T00:00:00.500Z',
 eventData: {},
 },
 events: [
Expand All@@ -248,6 +308,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 eventType: 'wait_created',
 correlationId: 'wait_1',
 createdAt: '2026-06-10T00:00:02.000Z',
 occurredAt: '2026-06-10T00:00:01.500Z',
 specVersion: 2,
 eventData: { resumeAt: '2026-06-10T01:00:00.000Z' },
 },
Expand All@@ -272,11 +333,14 @@ describe('createWorkflowRunEvent response coercion', () => {
 );

 expect(result.event?.createdAt).toBeInstanceOf(Date);
 expect(result.event?.occurredAt).toBeInstanceOf(Date);
 const preloaded = result.events?.[0] as {
 createdAt: Date;
 occurredAt: Date;
 eventData: { resumeAt: Date };
 };
 expect(preloaded.createdAt).toBeInstanceOf(Date);
 expect(preloaded.occurredAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt.getTime()).toBe(
 new Date('2026-06-10T01:00:00.000Z').getTime()
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -461,6 +461,14 @@ function buildEventFromV4(
 decoded.createdAt instanceof Date
 ? decoded.createdAt
 : new Date(decoded.createdAt),
 ...(decoded.occurredAt !== undefined
 ? {
 occurredAt:
 decoded.occurredAt instanceof Date
 ? decoded.occurredAt
 : new Date(decoded.occurredAt),
 }
 : {}),
 ...(decoded.correlationId ? { correlationId: decoded.correlationId } : {}),
 eventData,
 ...(decoded.specVersion !== undefined
Expand DownExpand Up@@ -619,6 +627,7 @@ async function createWorkflowRunEventInner(
 specVersion: data.specVersion ?? 2,
 ...(data.correlationId ? { correlationId: data.correlationId } : {}),
 ...(params?.requestId ? { vercelId: params.requestId } : {}),
 occurredAt: params?.occurredAt ?? new Date(),
 remoteRefBehavior,
 payload,
 ...meta,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,7 @@ export const EventSchema = AllEventsSchema.and(
 runId: z.string(),
 eventId: z.string(),
 createdAt: z.coerce.date(),
 occurredAt: z.coerce.date().optional(),
 specVersion: z.number().optional(),
 })
);
Expand DownExpand Up@@ -397,6 +398,12 @@ export interface CreateEventParams {
 resolveData?: ResolveData;
 /** Request ID (x-vercel-id when on Vercel) for correlating request logs with workflow events. */
 requestId?: string;
 /**
 * Timestamp for when the event occurred on the client side. Worlds that
 * support this can persist it separately from `createdAt`, which represents
 * when the backing service accepted or stored the event.
 */
 occurredAt?: Date;
}

/**
Expand Down
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 #2580: Send occurredAt with workflow events by github-actions[bot] · Pull Request #2589 · vercel/workflow · GitHub
Skip to content
Backport #2580: Send occurredAt with workflow events#2589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

karthikscale3
merged 2 commits into

from

Jun 23, 2026
 Merged


Backport #2580: Send occurredAt with workflow events
#2589
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5110e11

Send occurredAt with workflow events (#2580)


github-actions[bot] Jun 23, 2026
c0544f2

Merge branch 'stable' into backport/pr-2580-to-stable


karthikscale3 Jun 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/send-event-occurred-at.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@workflow/world': patch
'@workflow/world-vercel': patch
'@workflow/world-postgres': patch
---

Send optional client-side event occurrence timestamps through world event creation.

2 changes: 1 addition & 1 deletion
packages/world-postgres/src/drizzle/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ export const events = schema.table(
 eventData: Cbor<unknown>()('payload_cbor'),
 specVersion: integer('spec_version'),
 } satisfies DrizzlishOfType<
 Cborized<Event & { eventData?: undefined }, 'eventData'>
 Cborized<Omit<Event, 'occurredAt'> & { eventData?: undefined }, 'eventData'>
 >,
 (tb) => [
 index().on(tb.runId),
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@@ -54,6 +54,8 @@ export interface CreateEventV4Input {
 specVersion: number;
 correlationId?: string;
 vercelId?: string;
 /** Client-side time at which the event occurred. */
 occurredAt?: Date;
 remoteRefBehavior?: 'resolve' | 'lazy';
 deploymentId?: string;
 workflowName?: string;
Expand DownExpand Up@@ -119,6 +121,7 @@ function buildPostFrameMeta(
 if (input.correlationId !== undefined)
 meta.correlationId = input.correlationId;
 if (input.vercelId !== undefined) meta.vercelId = input.vercelId;
 if (input.occurredAt !== undefined) meta.occurredAt = input.occurredAt;
 if (input.remoteRefBehavior !== undefined) {
 meta.remoteRefBehavior = input.remoteRefBehavior;
 }
Expand DownExpand Up@@ -277,6 +280,7 @@ export interface DecodedV4Event {
 eventType: string;
 correlationId?: string;
 createdAt: Date | string;
 occurredAt?: Date | string;
 specVersion?: number;
 eventData?: Record<string, unknown>;
}
Expand Down

66 changes: 65 additions & 1 deletion
packages/world-vercel/src/events.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { AnyEventRequest } from '@workflow/world';
import { encode } from 'cbor-x';
import { decode, encode } from 'cbor-x';
import { MockAgent } from 'undici';
import { describe, expect, it } from 'vitest';
import {
Expand All@@ -17,6 +17,19 @@ function mockAgent() {
 return agent;
}

function decodePostedMeta(rawBody: unknown): Record<string, unknown> {
 const bytes =
 typeof rawBody === 'string'
 ? new TextEncoder().encode(rawBody)
 : new Uint8Array(rawBody as ArrayBufferLike);
 const metaLen = new DataView(
 bytes.buffer,
 bytes.byteOffset,
 bytes.byteLength
 ).getUint32(0, false);
 return decode(bytes.subarray(4, 4 + metaLen)) as Record<string, unknown>;
}

/**
 * Legacy (spec-version-1) runs predate event sourcing: the runtime still
 * posts hook_received (resumeHook) and wait_completed (wakeUpRun) for them
Expand DownExpand Up@@ -212,6 +225,52 @@ describe('splitEventDataForV4 hook fields', () => {
});

describe('createWorkflowRunEvent response coercion', () => {
 it('sends occurredAt in the v4 frame meta', async () => {
 const agent = mockAgent();
 const occurredAt = new Date('2026-06-10T00:00:03.000Z');
 let capturedMeta: Record<string, unknown> | undefined;

 agent
 .get(ORIGIN)
 .intercept({
 path: '/api/v4/runs/wrun_1/events/run_started',
 method: 'POST',
 })
 .reply(
 200,
 (opts: { body?: unknown }) => {
 capturedMeta = decodePostedMeta(opts.body);
 return encode({
 run: {
 runId: 'wrun_1',
 status: 'running',
 startedAt: new Date('2026-06-10T00:00:04.000Z'),
 },
 });
 },
 {
 headers: {
 'x-wf-event-id': 'evnt_1',
 'x-wf-run-id': 'wrun_1',
 'x-wf-created-at': '2026-06-10T00:00:04.000Z',
 },
 }
 );

 await createWorkflowRunEvent(
 'wrun_1',
 { eventType: 'run_started', specVersion: 2 } as AnyEventRequest,
 { occurredAt },
 { token: 'test-token', dispatcher: agent }
 );

 expect(capturedMeta?.occurredAt).toBeInstanceOf(Date);
 expect((capturedMeta?.occurredAt as Date).getTime()).toBe(
 occurredAt.getTime()
 );
 agent.assertNoPendingInterceptors();
 });

 it('coerces ISO-string dates in the returned event and preloaded events', async () => {
 // Persisted events store nested eventData dates as ISO strings
 // (the backend's entity layer converts Date → toISOString on write with
Expand DownExpand Up@@ -239,6 +298,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 runId: 'wrun_1',
 eventType: 'run_started',
 createdAt: '2026-06-10T00:00:01.000Z',
 occurredAt: '2026-06-10T00:00:00.500Z',
 eventData: {},
 },
 events: [
Expand All@@ -248,6 +308,7 @@ describe('createWorkflowRunEvent response coercion', () => {
 eventType: 'wait_created',
 correlationId: 'wait_1',
 createdAt: '2026-06-10T00:00:02.000Z',
 occurredAt: '2026-06-10T00:00:01.500Z',
 specVersion: 2,
 eventData: { resumeAt: '2026-06-10T01:00:00.000Z' },
 },
Expand All@@ -272,11 +333,14 @@ describe('createWorkflowRunEvent response coercion', () => {
 );

 expect(result.event?.createdAt).toBeInstanceOf(Date);
 expect(result.event?.occurredAt).toBeInstanceOf(Date);
 const preloaded = result.events?.[0] as {
 createdAt: Date;
 occurredAt: Date;
 eventData: { resumeAt: Date };
 };
 expect(preloaded.createdAt).toBeInstanceOf(Date);
 expect(preloaded.occurredAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt).toBeInstanceOf(Date);
 expect(preloaded.eventData.resumeAt.getTime()).toBe(
 new Date('2026-06-10T01:00:00.000Z').getTime()
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -461,6 +461,14 @@ function buildEventFromV4(
 decoded.createdAt instanceof Date
 ? decoded.createdAt
 : new Date(decoded.createdAt),
 ...(decoded.occurredAt !== undefined
 ? {
 occurredAt:
 decoded.occurredAt instanceof Date
 ? decoded.occurredAt
 : new Date(decoded.occurredAt),
 }
 : {}),
 ...(decoded.correlationId ? { correlationId: decoded.correlationId } : {}),
 eventData,
 ...(decoded.specVersion !== undefined
Expand DownExpand Up@@ -619,6 +627,7 @@ async function createWorkflowRunEventInner(
 specVersion: data.specVersion ?? 2,
 ...(data.correlationId ? { correlationId: data.correlationId } : {}),
 ...(params?.requestId ? { vercelId: params.requestId } : {}),
 occurredAt: params?.occurredAt ?? new Date(),
 remoteRefBehavior,
 payload,
 ...meta,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,7 @@ export const EventSchema = AllEventsSchema.and(
 runId: z.string(),
 eventId: z.string(),
 createdAt: z.coerce.date(),
 occurredAt: z.coerce.date().optional(),
 specVersion: z.number().optional(),
 })
);
Expand DownExpand Up@@ -397,6 +398,12 @@ export interface CreateEventParams {
 resolveData?: ResolveData;
 /** Request ID (x-vercel-id when on Vercel) for correlating request logs with workflow events. */
 requestId?: string;
 /**
 * Timestamp for when the event occurred on the client side. Worlds that
 * support this can persist it separately from `createdAt`, which represents
 * when the backing service accepted or stored the event.
 */
 occurredAt?: Date;
}

/**
Expand Down
Loading