[world] When resolveData='none', only strip eventData related to refs, keep other metadata

.changeset/wise-hornets-fetch.md

@@ -0,0 +1,9 @@
+---
+"@workflow/web": patch
+"@workflow/world": patch
+"@workflow/world-vercel": patch
+"@workflow/world-postgres": patch
+"@workflow/world-local": patch
+---
+
+Strip only ref/payload fields from eventData when resolveData is 'none', preserving all other metadata

packages/web/app/lib/client/hooks/use-events-list-data.ts

@@ -53,7 +53,7 @@ export function useEventsListData(
         fetchEvents(env, runId, {
           sortOrder,
           limit: INITIAL_PAGE_SIZE,
-          withData: true,
+          withData: false,
         })
       );
       if (fetchError) {
@@ -108,7 +108,7 @@ export function useEventsListData(
           cursor,
           sortOrder,
           limit: LOAD_MORE_PAGE_SIZE,
-          withData: true,
+          withData: false,
         })
       );
       if (fetchError) {

packages/web/app/lib/client/hooks/use-trace-viewer.test.ts

@@ -144,7 +144,7 @@ describe('useWorkflowTraceViewerData', () => {
       'run-1',
       expect.objectContaining({
         sortOrder: 'asc',
-        withData: true,
+        withData: false,
       })
     );
   });

packages/web/app/lib/client/hooks/use-trace-viewer.ts

@@ -52,7 +52,7 @@ export function useWorkflowTraceViewerData(
         fetchEvents(env, runId, {
           sortOrder: 'asc',
           limit: INITIAL_PAGE_SIZE,
-          withData: true,
+          withData: false,
         })
       ),
     ]);
@@ -103,7 +103,7 @@ export function useWorkflowTraceViewerData(
           cursor: eventsCursor,
           sortOrder: 'asc',
           limit: LOAD_MORE_PAGE_SIZE,
-          withData: true,
+          withData: false,
         })
       );
 
@@ -161,7 +161,7 @@ export function useWorkflowTraceViewerData(
               cursor: eventsCursor,
               sortOrder: 'asc',
               limit: LIVE_POLL_LIMIT,
-              withData: true,
+              withData: false,
             })
           ),
         setItems: setEvents,

packages/world-local/src/storage.test.ts

@@ -2,8 +2,11 @@ import { promises as fs } from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 import { WorkflowAPIError } from '@workflow/errors';
-import type { Storage } from '@workflow/world';
-import { DEFAULT_TIMESTAMP_THRESHOLD_MS } from '@workflow/world';
+import type { Event, Storage } from '@workflow/world';
+import {
+  DEFAULT_TIMESTAMP_THRESHOLD_MS,
+  stripEventDataRefs,
+} from '@workflow/world';
 import { monotonicFactory } from 'ulid';
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 import { writeJSON } from './fs.js';
@@ -17,6 +20,120 @@ import {
   updateStep,
 } from './test-helpers.js';
 
+describe('stripEventDataRefs', () => {
+  const baseEvent = {
+    runId: 'wrun_test',
+    eventId: 'evnt_test',
+    createdAt: new Date(),
+    specVersion: 2,
+  };
+
+  it('should strip input ref from step_created, keep stepName', () => {
+    const event = {
+      ...baseEvent,
+      eventType: 'step_created' as const,
+      correlationId: 'step_1',
+      eventData: { stepName: 'my-step', input: new Uint8Array([1, 2, 3]) },
+    } as Event;
+
+    const result = stripEventDataRefs(event, 'none') as any;
+    expect(result.eventData).toEqual({ stepName: 'my-step' });
+    expect(result.eventData).not.toHaveProperty('input');
+  });
+
+  it('should strip input ref from run_created, keep workflowName and deploymentId', () => {
+    const event = {
+      ...baseEvent,
+      eventType: 'run_created' as const,
+      eventData: {
+        deploymentId: 'dpl_123',
+        workflowName: 'my-workflow',
+        input: new Uint8Array([1, 2, 3]),
+      },
+    } as Event;
+
+    const result = stripEventDataRefs(event, 'none') as any;
+    expect(result.eventData).toEqual({
+      deploymentId: 'dpl_123',
+      workflowName: 'my-workflow',
+    });
+    expect(result.eventData).not.toHaveProperty('input');
+  });
+
+  it('should strip result ref from step_completed entirely', () => {
+    const event = {
+      ...baseEvent,
+      eventType: 'step_completed' as const,
+      correlationId: 'step_1',
+      eventData: { result: new Uint8Array([4, 5]) },
+    } as Event;
+
+    const result = stripEventDataRefs(event, 'none') as any;
+    expect(result.eventData).toBeUndefined();
+  });
+
+  it('should strip error from run_failed, keep errorCode', () => {
+    const event = {
+      ...baseEvent,
+      eventType: 'run_failed' as const,
+      eventData: { error: 'something broke', errorCode: 'TIMEOUT' },
+    } as Event;
+
+    const result = stripEventDataRefs(event, 'none') as any;
+    expect(result.eventData).toEqual({ errorCode: 'TIMEOUT' });
+    expect(result.eventData).not.toHaveProperty('error');
+  });
+
+  it('should strip error from step_failed, keep stack', () => {
+    const event = {
+      ...baseEvent,
+      eventType: 'step_failed' as const,
+      correlationId: 'step_1',
+      eventData: { error: 'failed', stack: 'Error: failed\n  at ...' },
+    } as Event;
+
+    const result = stripEventDataRefs(event, 'none') as any;
+    expect(result.eventData).toEqual({ stack: 'Error: failed\n  at ...' });
+    expect(result.eventData).not.toHaveProperty('error');
+  });
+
+  it('should not strip anything when resolveData is "all"', () => {
+    const event = {
+      ...baseEvent,
+      eventType: 'step_created' as const,
+      correlationId: 'step_1',
+      eventData: { stepName: 'my-step', input: new Uint8Array([1, 2, 3]) },
+    } as Event;
+
+    const result = stripEventDataRefs(event, 'all') as any;
+    expect(result.eventData.stepName).toBe('my-step');
+    expect(result.eventData.input).toBeDefined();
+  });
+
+  it('should pass through events with no ref fields (e.g. run_started)', () => {
+    const event = {
+      ...baseEvent,
+      eventType: 'run_started' as const,
+    } as Event;
+
+    const result = stripEventDataRefs(event, 'none');
+    expect(result).toEqual(event);
+  });
+
+  it('should strip metadata from hook_created, keep token', () => {
+    const event = {
+      ...baseEvent,
+      eventType: 'hook_created' as const,
+      correlationId: 'hook_1',
+      eventData: { token: 'tok_abc', metadata: { some: 'data' } },
+    } as Event;
+
+    const result = stripEventDataRefs(event, 'none') as any;
+    expect(result.eventData).toEqual({ token: 'tok_abc' });
+    expect(result.eventData).not.toHaveProperty('metadata');
+  });
+});
+
 describe('Storage', () => {
   let testDir: string;
   let storage: Storage;
@@ -1024,7 +1141,12 @@ describe('Storage', () => {
 
         // step_created + step_completed = 2 events
         expect(result.data).toHaveLength(2);
-        expect((result.data[0] as any).eventData).toBeUndefined();
+        // step_created: ref field 'input' stripped, metadata like stepName preserved
+        expect((result.data[0] as any).eventData).toEqual({
+          stepName: 'test-step',
+        });
+        expect((result.data[0] as any).eventData).not.toHaveProperty('input');
+        // step_completed: only ref field 'result' exists, so eventData is removed entirely
         expect((result.data[1] as any).eventData).toBeUndefined();
         expect(result.data[0].correlationId).toBe(correlationId);
       });

packages/world-local/src/storage/events-storage.ts

@@ -31,7 +31,7 @@ import {
   writeExclusive,
   writeJSON,
 } from '../fs.js';
-import { filterEventData } from './filters.js';
+import { stripEventDataRefs } from './filters.js';
 import { getObjectCreatedAt, hashToken, monotonicUlid } from './helpers.js';
 import { deleteAllHooksForRun } from './hooks-storage.js';
 import { handleLegacyEvent } from './legacy.js';
@@ -177,7 +177,7 @@ export function createEventsStorage(
           const resolveData =
             params?.resolveData ?? DEFAULT_RESOLVE_DATA_OPTION;
           return {
-            event: filterEventData(event, resolveData),
+            event: stripEventDataRefs(event, resolveData),
             run: currentRun,
           };
         }
@@ -635,7 +635,7 @@ export function createEventsStorage(
 
           const resolveData =
             params?.resolveData ?? DEFAULT_RESOLVE_DATA_OPTION;
-          const filteredEvent = filterEventData(conflictEvent, resolveData);
+          const filteredEvent = stripEventDataRefs(conflictEvent, resolveData);
 
           // Return EventResult with conflict event (no hook entity created)
           return {
@@ -758,7 +758,7 @@ export function createEventsStorage(
       await writeJSON(taggedPath(basedir, 'events', compositeKey, tag), event);
 
       const resolveData = params?.resolveData ?? DEFAULT_RESOLVE_DATA_OPTION;
-      const filteredEvent = filterEventData(event, resolveData);
+      const filteredEvent = stripEventDataRefs(event, resolveData);
 
       // Return EventResult with event and any created/updated entity
       return {
@@ -783,7 +783,7 @@ export function createEventsStorage(
         throw new Error(`Event ${eventId} in run ${runId} not found`);
       }
       const resolveData = params?.resolveData ?? DEFAULT_RESOLVE_DATA_OPTION;
-      return filterEventData(event, resolveData);
+      return stripEventDataRefs(event, resolveData);
     },
 
     async list(params) {
@@ -806,10 +806,9 @@ export function createEventsStorage(
       if (resolveData === 'none') {
         return {
           ...result,
-          data: result.data.map((event) => {
-            const { eventData: _eventData, ...rest } = event as any;
-            return rest;
-          }),
+          data: result.data.map((event) =>
+            stripEventDataRefs(event, resolveData)
+          ),
         };
       }
 
@@ -837,10 +836,9 @@ export function createEventsStorage(
       if (resolveData === 'none') {
         return {
           ...result,
-          data: result.data.map((event) => {
-            const { eventData: _eventData, ...rest } = event as any;
-            return rest;
-          }),
+          data: result.data.map((event) =>
+            stripEventDataRefs(event, resolveData)
+          ),
         };
       }
 

packages/world-local/src/storage/filters.ts

@@ -1,12 +1,13 @@
 import type {
-  Event,
   Hook,
   Step,
   StepWithoutData,
   WorkflowRun,
   WorkflowRunWithoutData,
 } from '@workflow/world';
 
+export { stripEventDataRefs } from '@workflow/world';
+
 /**
  * Filter run data based on resolveData setting.
  * When resolveData is 'none', strips input/output to reduce payload size.
@@ -64,21 +65,6 @@ export function filterStepData(
   return step;
 }
 
-/**
- * Filter event data based on resolveData setting.
- * When resolveData is 'none', strips eventData to reduce payload size.
- */
-export function filterEventData(
-  event: Event,
-  resolveData: 'none' | 'all'
-): Event {
-  if (resolveData === 'none') {
-    const { eventData: _eventData, ...rest } = event as any;
-    return rest;
-  }
-  return event;
-}
-
 /**
  * Filter hook data based on resolveData setting.
  * When resolveData is 'none', strips metadata to reduce payload size.

packages/world-local/src/storage/legacy.ts

@@ -3,7 +3,7 @@ import type { Event, EventResult, WorkflowRun } from '@workflow/world';
 import { SPEC_VERSION_CURRENT } from '@workflow/world';
 import { DEFAULT_RESOLVE_DATA_OPTION } from '../config.js';
 import { writeJSON } from '../fs.js';
-import { filterEventData, filterRunData } from './filters.js';
+import { filterRunData, stripEventDataRefs } from './filters.js';
 import { monotonicUlid } from './helpers.js';
 import { deleteAllHooksForRun } from './hooks-storage.js';
 
@@ -72,7 +72,7 @@ export async function handleLegacyEvent(
       const compositeKey = `${runId}-${eventId}`;
       const eventPath = path.join(basedir, 'events', `${compositeKey}.json`);
       await writeJSON(eventPath, event);
-      return { event: filterEventData(event, resolveData) };
+      return { event: stripEventDataRefs(event, resolveData) };
     }
 
     default: