@outputai/core 0.2.1-next.380dff4.0 → 0.2.1-next.52e960c.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outputai/core",
-  "version": "0.2.1-next.380dff4.0",
+  "version": "0.2.1-next.52e960c.0",
   "description": "The core module of the output framework",
   "type": "module",
   "exports": {

package/src/activity_integration/tracing.d.ts

@@ -1,32 +1,45 @@
 /**
- * Record the start of an event on the default trace for the current workflow.
+ * Creates a new event.
  *
- * @param args - Event information
- * @param args.id - A unique id for the Event, must be the same across all phases: start, end, error.
+ * @param args
+ * @param args.id - A unique id for the Event.
  * @param args.kind - The kind of Event, like HTTP, DiskWrite, DBOp, etc.
- * @param args.name - The human friendly name of the Event: query, request, create.
- * @param args.details - Arbitrary metadata associated with this phase (e.g., payloads, summaries).
+ * @param args.name - The human-friendly name of the Event: query, request, create.
+ * @param args.details - Arbitrary data to add to this event, it will be used as the "input" field.
  */
 export declare function addEventStart( args: { id: string; kind: string; name: string; details: unknown } ): void;
 
 /**
- * Record the end of an event on the default trace for the current workflow.
+ * Concludes an event.
  *
- * Use the same id as the start phase to correlate phases.
- *
- * @param args - Event information
- * @param args.id - Identifier matching the event's start phase.
- * @param args.details - Arbitrary metadata associated with this phase (e.g., results, response body).
+ * @param args
+ * @param args.id - The id of the event to conclude.
+ * @param args.details - Arbitrary data to add to this event, it will be used as the "output" field.
  */
 export declare function addEventEnd( args: { id: string; details: unknown } ): void;
 
 /**
- * Record an error for an event on the default trace for the current workflow.
- *
- * Use the same id as the start phase to correlate phases.
+ * Concludes an event with an error.
  *
- * @param args - Event metadata for the error phase.
- * @param args.id - Identifier matching the event's start phase.
- * @param args.details - Arbitrary metadata associated with this phase, possible error info.
+ * @param args
+ * @param args.id - The id of the event to conclude.
+ * @param args.details - Arbitrary data to add to this event, it will be used as the "error" field.
  */
 export declare function addEventError( args: { id: string; details: unknown } ): void;
+
+/**
+ * Adds an attribute to an event.
+ *
+ * @param args
+ * @param args.eventId - The id of the event to attach the attribute to.
+ * @param args.name - The attribute name
+ * @param args.value - The attribute value
+ */
+export declare function addEventAttribute( args: { eventId: string; name: string, value: unknown } ): void;
+
+/**
+ * Known attributes.
+ */
+export declare const Attribute: {
+  COST: 'cost';
+};

package/src/activity_integration/tracing.js

@@ -1,37 +1,53 @@
-import { addEventPhaseWithContext } from '#tracing';
+import { addEventActionWithContext, EventAction } from '#tracing';
 
 /**
- * Adds the start phase of a new event at the default trace for the current workflow.
+ * Creates a new event.
  *
  * @param {object} args
- * @param {string} args.id - A unique id for the Event, must be the same across all phases: start, end, error.
+ * @param {string} args.id - A unique id for the Event.
  * @param {string} args.kind - The kind of Event, like HTTP, DiskWrite, DBOp, etc.
- * @param {string} args.name - The human friendly name of the Event: query, request, create.
- * @param {object} args.details - All details attached to this Event Phase. DB queried records, HTTP response body.
+ * @param {string} args.name - The human-friendly name of the Event: query, request, create.
+ * @param {object} args.details - Arbitrary data to add to this event, it will be used as the "input" field.
  * @returns {void}
  */
-export const addEventStart = ( { id, kind, name, details } ) => addEventPhaseWithContext( 'start', { kind, name, details, id } );
+export const addEventStart = ( { id, kind, name, details } ) =>
+  addEventActionWithContext( EventAction.START, { kind, name, details, id } );
 
 /**
- * Adds the end phase at an event at the default trace for the current workflow.
- *
- * It needs to use the same id of the start phase.
+ * Concludes an event.
  *
  * @param {object} args
- * @param {string} args.id - A unique id for the Event, must be the same across all phases: start, end, error.
- * @param {object} args.details - All details attached to this Event Phase. DB queried records, HTTP response body.
+ * @param {string} args.id - The id of the event to conclude.
+ * @param {object} args.details - Arbitrary data to add to this event, it will be used as the "output" field.
  * @returns {void}
  */
-export const addEventEnd = ( { id, details } ) => addEventPhaseWithContext( 'end', { id, details } );
+export const addEventEnd = ( { id, details } ) => addEventActionWithContext( EventAction.END, { id, details } );
 
 /**
- * Adds the error phase at an event as error at the default trace for the current workflow.
+ * Concludes an event with an error.
  *
- * It needs to use the same id of the start phase.
+ * @param {object} args
+ * @param {string} args.id - The id of the event to conclude.
+ * @param {object} args.details - Arbitrary data to add to this event, it will be used as the "error" field.
+ * @returns {void}
+ */
+export const addEventError = ( { id, details } ) => addEventActionWithContext( EventAction.ERROR, { id, details } );
+
+/**
+ * Adds an attribute to an event.
  *
  * @param {object} args
- * @param {string} args.id - A unique id for the Event, must be the same across all phases: start, end, error.
- * @param {object} args.details - All details attached to this Event Phase. DB queried records, HTTP response body.
+ * @param {string} args.eventId - The id of the event to attach the attribute to.
+ * @param {string} args.name - The attribute name
+ * @param {unknown} args.value - The attribute value
  * @returns {void}
  */
-export const addEventError = ( { id, details } ) => addEventPhaseWithContext( 'error', { id, details } );
+export const addEventAttribute = ( { eventId, name, value } ) =>
+  addEventActionWithContext( EventAction.ADD_ATTR, { id: eventId, details: { name, value } } );
+
+/**
+ * Known attributes
+ */
+export const Attribute = {
+  COST: 'cost'
+};

package/src/tracing/internal_interface.js

@@ -1,4 +1,5 @@
-import { addEventPhase, addEventPhaseWithContext, init, getDestinations } from './trace_engine.js';
+import { addEventAction, addEventActionWithContext, init, getDestinations } from './trace_engine.js';
+import { EventAction } from './trace_consts.js';
 
 /**
  * Init method, if not called, no processors are attached and trace functions are dummy
@@ -6,66 +7,71 @@ import { addEventPhase, addEventPhaseWithContext, init, getDestinations } from '
 export { init, getDestinations };
 
 /**
- * Internal use only - adds event phase with AsyncLocalStorage context resolution
+ * Internal use only - adds an action with AsyncLocalStorage context resolution
  */
-export { addEventPhaseWithContext };
+export { addEventActionWithContext };
+
+export { EventAction };
 
 /**
  * Trace nomenclature
  *
  * Trace - The collection of Events;
- * Event - Any entry in the Trace file, must have the two phases START and END or ERROR;
- * Phase - An specific part of an Event, either START or the conclusive END or ERROR;
+ * Event - Any entry in the Trace file must have both START and END/ERROR actions, plus any number of ADD_ATTR actions;
+ * Action - A specific part of an Event: START, END, ERROR, or ADD_ATTR;
  */
 
 /**
  * Internal use only
  *
- * Adds the start phase of a new event at the default trace for the current workflow.
+ * Creates a new event and appends it to the trace.
  *
  * @param {object} args
- * @param {string} args.id - A unique id for the Event, must be the same across all phases: start, end, error.
+ * @param {string} args.id - A unique id for the Event.
  * @param {string} args.kind - The kind of Event, like HTTP, DiskWrite, DBOp, etc.
- * @param {string} args.name - The human friendly name of the Event: query, request, create.
- * @param {any} args.details - All details attached to this Event Phase. DB queried records, HTTP response body.
- * @param {string} args.parentId - The parent Event, used to build a three.
+ * @param {string} args.name - The human-friendly name of the Event: query, request, create.
+ * @param {any} args.details - Arbitrary data to add to this event, it will be used as the "input" field.
+ * @param {string} args.parentId - The parent Event, used to build a tree.
  * @param {object} args.executionContext - The original execution context from the workflow
  * @returns {void}
  */
-export const addEventStart = options => addEventPhase( 'start', options );
+export const addEventStart = options => addEventAction( EventAction.START, options );
 
 /**
  * Internal use only
  *
- * Adds the end phase at an event at the default trace for the current workflow.
- *
- * It needs to use the same id of the start phase.
+ * Concludes an event, matching by its id.
  *
  * @param {object} args
- * @param {string} args.id - A unique id for the Event, must be the same across all phases: start, end, error.
- * @param {string} args.kind - The kind of Event, like HTTP, DiskWrite, DBOp, etc.
- * @param {string} args.name - The human friendly name of the Event: query, request, create.
- * @param {any} args.details - All details attached to this Event Phase. DB queried records, HTTP response body.
- * @param {string} args.parentId - The parent Event, used to build a three.
+ * @param {string} args.id - The id of the event to conclude.
+ * @param {any} args.details - Arbitrary data to add to the event; it is used as the "output" field.
  * @param {object} args.executionContext - The original execution context from the workflow
  * @returns {void}
  */
-export const addEventEnd = options => addEventPhase( 'end', options );
+export const addEventEnd = options => addEventAction( EventAction.END, options );
 
 /**
  * Internal use only
  *
- * Adds the error phase at an event as error at the default trace for the current workflow.
+ * Concludes an event with an error, matching by its id.
+ *
+ * @param {object} args
+ * @param {string} args.id - The id of the event to conclude.
+ * @param {any} args.details - Arbitrary data to add to the event; it is used as the "error" field.
+ * @param {object} args.executionContext - The original execution context from the workflow
+ * @returns {void}
+ */
+export const addEventError = options => addEventAction( EventAction.ERROR, options );
+
+/**
+ * Internal use only
  *
- * It needs to use the same id of the start phase.
+ * Adds an attribute to an event using its id.
  *
  * @param {object} args
- * @param {string} args.id - A unique id for the Event, must be the same across all phases: start, end, error.
- * @param {string} args.kind - The kind of Event, like HTTP, DiskWrite, DBOp, etc.
- * @param {string} args.name - The human friendly name of the Event: query, request, create.
- * @param {any} args.details - All details attached to this Event Phase. DB queried records, HTTP response body.
- * @param {string} args.parentId - The parent Event, used to build a three.
+ * @param {string} args.id - The id of the event to attach the attribute to.
+ * @param {object} args.details - The attribute to add to this event, must be in `{ name: string, value: any }` format.
  * @param {object} args.executionContext - The original execution context from the workflow
  * @returns {void}
  */
-export const addEventError = options => addEventPhase( 'error', options );
+export const addEventAttribute = options => addEventAction( EventAction.ADD_ATTR, options );

package/src/tracing/processors/local/index.js

@@ -2,6 +2,7 @@ import { appendFileSync, mkdirSync, readdirSync, readFileSync, rmSync, writeFile
 import { dirname, join } from 'node:path';
 import { fileURLToPath } from 'url';
 import buildTraceTree from '../../tools/build_trace_tree.js';
+import { safeFormatJSON } from '../../tools/utils.js';
 import { EOL } from 'node:os';
 
 const __dirname = dirname( fileURLToPath( import.meta.url ) );
@@ -13,12 +14,32 @@ const callerDir = process.argv[2];
 
 const tempTraceFilesDir = join( __dirname, 'temp', 'traces' );
 
-const accumulate = ( { entry, executionContext: { workflowId, startTime } } ) => {
-  const path = join( tempTraceFilesDir, `${startTime}_${workflowId}.trace` );
-  appendFileSync( path, JSON.stringify( entry ) + EOL, 'utf-8' );
-  return readFileSync( path, 'utf-8' ).split( EOL ).slice( 0, -1 ).map( v => JSON.parse( v ) );
-};
+/**
+ * Builds the temp file path to accumulate trace entries
+ *
+ * @param {object} executionContext - The execution context around a given trace entry
+ * @returns {string}
+ */
+const createTempFilePath = ( { workflowId, startTime } ) => join( tempTraceFilesDir, `${startTime}_${workflowId}.trace` );
 
+/**
+ * Adds a trace entry to the accumulation file.
+ * @param {object} entry - The trace entry
+ * @param {string} path - Accumulation file path
+ */
+const addEntry = ( entry, path ) => appendFileSync( path, JSON.stringify( entry ) + EOL, 'utf-8' );
+
+/**
+ * Reads the accumulation file and returns all the entries, each serialized to JSON
+ * @param {string} path - Accumulation file path
+ * @returns {object[]} Trace entries
+ */
+const getEntries = path => readFileSync( path, 'utf-8' ).split( EOL ).slice( 0, -1 ).map( v => JSON.parse( v ) );
+
+/**
+ * Deletes old accumulation files
+ * @param {number} [threshold] Timestamp in ms epoch. All files below this date are considered old
+ */
 const cleanupOldTempFiles = ( threshold = Date.now() - tempFilesTTL ) =>
   readdirSync( tempTraceFilesDir )
     .filter( f => +f.split( '_' )[0] < threshold )
@@ -79,21 +100,33 @@ export const init = () => {
 /**
  * Execute this processor:
  *
- * Persist a trace tree file to local file system, updating upon each new entry
+ * Appends each trace entry to a temp file.
+ *
+ * When the root workflow ends or the entry is an error action, build the trace tree and write the JSON file.
  *
  * @param {object} args
- * @param {object} entry - Trace event phase
- * @param {object} executionContext - Execution info: workflowId, workflowName, startTime
+ * @param {object} args.entry - The trace entry to append.
+ * @param {object} args.executionContext - Execution info: workflowId, workflowName, startTime
  * @returns {void}
  */
 export const exec = ( { entry, executionContext } ) => {
   const { workflowId, workflowName, startTime } = executionContext;
-  const content = buildTraceTree( accumulate( { entry, executionContext } ) );
+  const tempFilePath = createTempFilePath( executionContext );
+  addEntry( entry, tempFilePath );
+
+  const isRootWorkflowEnd = entry.id === workflowId && entry.action !== 'start';
+  const isError = entry.action === 'error';
+
+  if ( !isRootWorkflowEnd && !isError ) {
+    return;
+  }
+
+  const content = buildTraceTree( getEntries( tempFilePath ) );
   const dir = resolveIOPath( workflowName );
   const path = join( dir, buildTraceFilename( { startTime, workflowId } ) );
 
   mkdirSync( dir, { recursive: true } );
-  writeFileSync( path, JSON.stringify( content, undefined, 2 ) + EOL, 'utf-8' );
+  writeFileSync( path, safeFormatJSON( content ) + EOL, 'utf-8' );
 };
 
 /**

package/src/tracing/processors/local/index.spec.js

@@ -1,4 +1,5 @@
 import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { EOL } from 'node:os';
 
 // In-memory fs mock store
 const store = { files: new Map() };
@@ -24,12 +25,17 @@ vi.mock( 'node:fs', () => ( {
 const buildTraceTreeMock = vi.fn( entries => ( { count: entries.length } ) );
 vi.mock( '../../tools/build_trace_tree.js', () => ( { default: buildTraceTreeMock } ) );
 
+/** Flush happens when the root id matches workflowId and action is not 'start', or when action is 'error'. */
+const rootStart = ( workflowId, ts ) => ( { id: workflowId, action: 'start', timestamp: ts } );
+const rootEnd = ( workflowId, ts ) => ( { id: workflowId, action: 'end', timestamp: ts } );
+const childTick = ( id, ts ) => ( { id, action: 'tick', timestamp: ts } );
+
 describe( 'tracing/processors/local', () => {
   beforeEach( () => {
     vi.clearAllMocks();
     store.files.clear();
     process.argv[2] = '/tmp/project';
-    delete process.env.OUTPUT_TRACE_HOST_PATH; // Clear OUTPUT_TRACE_HOST_PATH for clean tests
+    delete process.env.OUTPUT_TRACE_HOST_PATH;
   } );
 
   it( 'init(): creates temp dir and cleans up old files', async () => {
@@ -40,34 +46,63 @@ describe( 'tracing/processors/local', () => {
 
     init();
 
-    // Should create temp dir relative to module location using __dirname
     expect( mkdirSyncMock ).toHaveBeenCalledWith( expect.stringMatching( /temp\/traces$/ ), { recursive: true } );
     expect( rmSyncMock ).toHaveBeenCalledTimes( 1 );
   } );
 
-  it( 'exec(): accumulates entries and writes aggregated tree', async () => {
+  it( 'exec(): appends each entry and writes aggregated tree once on root workflow end', async () => {
     const { exec, init } = await import( './index.js' );
     init();
 
     const startTime = Date.parse( '2020-01-02T03:04:05.678Z' );
-    const ctx = { executionContext: { workflowId: 'id1', workflowName: 'WF', startTime } };
+    const workflowId = 'id1';
+    const ctx = { executionContext: { workflowId, workflowName: 'WF', startTime } };
 
-    exec( { ...ctx, entry: { name: 'A', phase: 'start', timestamp: startTime } } );
-    exec( { ...ctx, entry: { name: 'A', phase: 'tick', timestamp: startTime + 1 } } );
-    exec( { ...ctx, entry: { name: 'A', phase: 'end', timestamp: startTime + 2 } } );
+    exec( { ...ctx, entry: rootStart( workflowId, startTime ) } );
+    exec( { ...ctx, entry: childTick( 'child-1', startTime + 1 ) } );
+    exec( { ...ctx, entry: rootEnd( workflowId, startTime + 2 ) } );
 
-    // buildTraceTree called with 1, 2, 3 entries respectively
-    expect( buildTraceTreeMock ).toHaveBeenCalledTimes( 3 );
-    expect( buildTraceTreeMock.mock.calls.at( -1 )[0].length ).toBe( 3 );
+    expect( buildTraceTreeMock ).toHaveBeenCalledTimes( 1 );
+    expect( buildTraceTreeMock.mock.calls[0][0] ).toHaveLength( 3 );
 
-    expect( writeFileSyncMock ).toHaveBeenCalledTimes( 3 );
-    const [ writtenPath, content ] = writeFileSyncMock.mock.calls.at( -1 );
-    // Changed: Now uses process.cwd() + '/logs' fallback when OUTPUT_TRACE_HOST_PATH not set
-    expect( writtenPath ).toMatch( /\/runs\/WF\// );
+    expect( writeFileSyncMock ).toHaveBeenCalledTimes( 1 );
+    const [ writtenPath, content ] = writeFileSyncMock.mock.calls[0];
+    expect( writtenPath ).toMatch( /\/tmp\/project\/logs\/runs\/WF\// );
     expect( JSON.parse( content.trim() ).count ).toBe( 3 );
   } );
 
-  it( 'getDestination(): returns absolute path', async () => {
+  it( 'exec(): does not build or write on non-flush entries', async () => {
+    const { exec, init } = await import( './index.js' );
+    init();
+
+    const startTime = Date.parse( '2020-01-02T03:04:05.678Z' );
+    const workflowId = 'id1';
+    const ctx = { executionContext: { workflowId, workflowName: 'WF', startTime } };
+
+    exec( { ...ctx, entry: rootStart( workflowId, startTime ) } );
+    exec( { ...ctx, entry: childTick( 'child-1', startTime + 1 ) } );
+
+    expect( buildTraceTreeMock ).not.toHaveBeenCalled();
+    expect( writeFileSyncMock ).not.toHaveBeenCalled();
+  } );
+
+  it( 'exec(): flushes on error action before root end', async () => {
+    const { exec, init } = await import( './index.js' );
+    init();
+
+    const startTime = Date.parse( '2020-01-02T03:04:05.678Z' );
+    const workflowId = 'id1';
+    const ctx = { executionContext: { workflowId, workflowName: 'WF', startTime } };
+
+    exec( { ...ctx, entry: rootStart( workflowId, startTime ) } );
+    exec( { ...ctx, entry: { id: 'step-1', action: 'error', timestamp: startTime + 1 } } );
+
+    expect( buildTraceTreeMock ).toHaveBeenCalledTimes( 1 );
+    expect( buildTraceTreeMock.mock.calls[0][0] ).toHaveLength( 2 );
+    expect( writeFileSyncMock ).toHaveBeenCalledTimes( 1 );
+  } );
+
+  it( 'getDestination(): returns absolute path under callerDir logs', async () => {
     const { getDestination } = await import( './index.js' );
 
     const startTime = Date.parse( '2020-01-02T03:04:05.678Z' );
@@ -76,36 +111,36 @@ describe( 'tracing/processors/local', () => {
 
     const destination = getDestination( { startTime, workflowId, workflowName } );
 
-    // Should return an absolute path
-    expect( destination ).toMatch( /^\/|^[A-Z]:\\/i ); // Starting with / or Windows drive letter
-    expect( destination ).toContain( '/logs/runs/test-workflow/2020-01-02-03-04-05-678Z_workflow-id-123.json' );
+    expect( destination ).toMatch( /^\/|^[A-Z]:\\/i );
+    expect( destination ).toBe(
+      '/tmp/project/logs/runs/test-workflow/2020-01-02-03-04-05-678Z_workflow-id-123.json'
+    );
   } );
 
-  it( 'exec(): writes to container path regardless of OUTPUT_TRACE_HOST_PATH', async () => {
+  it( 'exec(): writes under process.argv[2] logs even when OUTPUT_TRACE_HOST_PATH is set', async () => {
     const { exec, init } = await import( './index.js' );
 
-    // Set OUTPUT_TRACE_HOST_PATH to simulate Docker environment
     process.env.OUTPUT_TRACE_HOST_PATH = '/host/path/logs';
 
     init();
 
     const startTime = Date.parse( '2020-01-02T03:04:05.678Z' );
-    const ctx = { executionContext: { workflowId: 'id1', workflowName: 'WF', startTime } };
+    const workflowId = 'id1';
+    const ctx = { executionContext: { workflowId, workflowName: 'WF', startTime } };
 
-    exec( { ...ctx, entry: { name: 'A', phase: 'start', timestamp: startTime } } );
+    exec( { ...ctx, entry: rootStart( workflowId, startTime ) } );
+    exec( { ...ctx, entry: rootEnd( workflowId, startTime + 1 ) } );
 
     expect( writeFileSyncMock ).toHaveBeenCalledTimes( 1 );
-    const [ writtenPath ] = writeFileSyncMock.mock.calls.at( -1 );
+    const [ writtenPath ] = writeFileSyncMock.mock.calls[0];
 
-    // Should write to process.cwd()/logs, NOT to OUTPUT_TRACE_HOST_PATH
     expect( writtenPath ).not.toContain( '/host/path/logs' );
-    expect( writtenPath ).toMatch( /logs\/runs\/WF\// );
+    expect( writtenPath ).toMatch( /\/tmp\/project\/logs\/runs\/WF\// );
   } );
 
   it( 'getDestination(): returns OUTPUT_TRACE_HOST_PATH when set', async () => {
     const { getDestination } = await import( './index.js' );
 
-    // Set OUTPUT_TRACE_HOST_PATH to simulate Docker environment
     process.env.OUTPUT_TRACE_HOST_PATH = '/host/path/logs';
 
     const startTime = Date.parse( '2020-01-02T03:04:05.678Z' );
@@ -114,14 +149,12 @@ describe( 'tracing/processors/local', () => {
 
     const destination = getDestination( { startTime, workflowId, workflowName } );
 
-    // Should return OUTPUT_TRACE_HOST_PATH-based path for reporting
     expect( destination ).toBe( '/host/path/logs/runs/test-workflow/2020-01-02-03-04-05-678Z_workflow-id-123.json' );
   } );
 
   it( 'separation of write and report paths works correctly', async () => {
     const { exec, getDestination, init } = await import( './index.js' );
 
-    // Set OUTPUT_TRACE_HOST_PATH to simulate Docker environment
     process.env.OUTPUT_TRACE_HOST_PATH = '/Users/ben/project/logs';
 
     init();
@@ -131,19 +164,16 @@ describe( 'tracing/processors/local', () => {
     const workflowName = 'test-workflow';
     const ctx = { executionContext: { workflowId, workflowName, startTime } };
 
-    // Execute to write file
-    exec( { ...ctx, entry: { name: 'A', phase: 'start', timestamp: startTime } } );
+    exec( { ...ctx, entry: rootStart( workflowId, startTime ) } );
+    exec( { ...ctx, entry: rootEnd( workflowId, startTime + 1 ) } );
 
-    // Get destination for reporting
     const destination = getDestination( { startTime, workflowId, workflowName } );
 
-    // Verify write path is local
-    const [ writtenPath ] = writeFileSyncMock.mock.calls.at( -1 );
+    const [ writtenPath, payload ] = writeFileSyncMock.mock.calls[0];
     expect( writtenPath ).not.toContain( '/Users/ben/project' );
-    expect( writtenPath ).toMatch( /logs\/runs\/test-workflow\// );
+    expect( writtenPath ).toMatch( /\/tmp\/project\/logs\/runs\/test-workflow\// );
+    expect( payload.endsWith( EOL ) ).toBe( true );
 
-    // Verify report path uses OUTPUT_TRACE_HOST_PATH
     expect( destination ).toBe( '/Users/ben/project/logs/runs/test-workflow/2020-01-02-03-04-05-678Z_workflow-id-123.json' );
   } );
 } );
-

package/src/tracing/processors/s3/index.js

@@ -4,6 +4,7 @@ import buildTraceTree from '../../tools/build_trace_tree.js';
 import { EOL } from 'node:os';
 import { loadEnv, getVars } from './configs.js';
 import { createChildLogger } from '#logger';
+import { safeFormatJSON } from '../../tools/utils.js';
 
 const log = createChildLogger( 'S3 Processor' );
 
@@ -66,11 +67,15 @@ export const init = async () => {
 };
 
 /**
- * Execute this processor: send a complete trace tree file to S3 when the workflow finishes
+ * Execute this processor:
+ *
+ * Appends each trace entry to Redis.
+ *
+ * When the root workflow ends or the entry is an error action, it builds the trace tree and uploads it to S3.
  *
  * @param {object} args
- * @param {object} entry - Trace event phase
- * @param {object} executionContext - Execution info: workflowId, workflowName, startTime
+ * @param {object} args.entry - The trace entry to append
+ * @param {object} args.executionContext - Execution info: workflowId, workflowName, startTime
  */
 export const exec = async ( { entry, executionContext } ) => {
   const { workflowName, workflowId, startTime } = executionContext;
@@ -78,7 +83,7 @@ export const exec = async ( { entry, executionContext } ) => {
 
   await addEntry( entry, cacheKey );
 
-  const isRootWorkflowEnd = entry.id === workflowId && entry.phase !== 'start';
+  const isRootWorkflowEnd = entry.id === workflowId && entry.action !== 'start';
   if ( !isRootWorkflowEnd ) {
     return;
   }
@@ -97,7 +102,7 @@ export const exec = async ( { entry, executionContext } ) => {
   }
   await upload( {
     key: getS3Key( { workflowId, workflowName, startTime } ),
-    content: JSON.stringify( content, undefined, 2 ) + EOL
+    content: safeFormatJSON( content ) + EOL
   } );
   await bustEntries( cacheKey );
 };

package/src/tracing/processors/s3/index.spec.js

@@ -52,9 +52,9 @@ describe( 'tracing/processors/s3', () => {
 
     redisMulti.exec.mockResolvedValue( [] );
 
-    const workflowStart = { id: 'id1', name: 'WF', kind: 'workflow', phase: 'start', details: {}, timestamp: startTime };
-    const activityStart = { id: 'act-1', name: 'DoSomething', kind: 'step', parentId: 'id1', phase: 'start', details: {}, timestamp: startTime + 1 };
-    const workflowEnd = { id: 'id1', phase: 'end', details: { ok: true }, timestamp: startTime + 2 };
+    const workflowStart = { id: 'id1', name: 'WF', kind: 'workflow', action: 'start', details: {}, timestamp: startTime };
+    const activityStart = { id: 'act-1', name: 'DoSomething', kind: 'step', parentId: 'id1', action: 'start', details: {}, timestamp: startTime + 1 };
+    const workflowEnd = { id: 'id1', action: 'end', details: { ok: true }, timestamp: startTime + 2 };
     zRangeMock.mockResolvedValue( [
       JSON.stringify( workflowStart ),
       JSON.stringify( activityStart ),
@@ -97,7 +97,7 @@ describe( 'tracing/processors/s3', () => {
 
     redisMulti.exec.mockResolvedValue( [] );
     const workflowStart = {
-      kind: 'workflow', id: 'id1', name: 'WF', parentId: undefined, phase: 'start', details: {}, timestamp: startTime
+      kind: 'workflow', id: 'id1', name: 'WF', parentId: undefined, action: 'start', details: {}, timestamp: startTime
     };
     zRangeMock.mockResolvedValue( [ JSON.stringify( workflowStart ) ] );
 
@@ -113,8 +113,8 @@ describe( 'tracing/processors/s3', () => {
     const ctx = { executionContext: { workflowId: 'id1', workflowName: 'WF', startTime } };
 
     redisMulti.exec.mockResolvedValue( [] );
-    const workflowStart = { id: 'id1', name: 'WF', kind: 'workflow', phase: 'start', details: {}, timestamp: startTime };
-    const stepEndNoParent = { id: 'step-1', phase: 'end', details: { done: true }, timestamp: startTime + 1 };
+    const workflowStart = { id: 'id1', name: 'WF', kind: 'workflow', action: 'start', details: {}, timestamp: startTime };
+    const stepEndNoParent = { id: 'step-1', action: 'end', details: { done: true }, timestamp: startTime + 1 };
     zRangeMock.mockResolvedValue( [
       JSON.stringify( workflowStart ),
       JSON.stringify( stepEndNoParent )
@@ -136,7 +136,7 @@ describe( 'tracing/processors/s3', () => {
 
     redisMulti.exec.mockResolvedValue( [] );
     const workflowEnd = {
-      kind: 'workflow', id: 'id1', name: 'WF', parentId: undefined, phase: 'end', details: {}, timestamp: startTime
+      kind: 'workflow', id: 'id1', name: 'WF', parentId: undefined, action: 'end', details: {}, timestamp: startTime
     };
     zRangeMock.mockResolvedValue( [ JSON.stringify( workflowEnd ) ] );
     buildTraceTreeMock.mockReturnValueOnce( null );