@outputai/core 0.10.0 → 0.10.1-next.09ed166.0

package/src/hooks/index.spec.js

@@ -1,22 +1,33 @@
 import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { BusEventType, ComponentType, WORKFLOW_CATALOG } from '#consts';
+import { BusEventType } from '#consts';
 
 const logErrorMock = vi.hoisted( () => vi.fn() );
 const createChildLoggerMock = vi.hoisted( () =>
   vi.fn( () => ( { error: logErrorMock } ) )
 );
 
-const onHandlers = vi.hoisted( () => ( {} ) );
-const messageBusMock = vi.hoisted( () => ( {
+const mainOnHandlers = vi.hoisted( () => ( {} ) );
+const stepOnHandlers = vi.hoisted( () => ( {} ) );
+const mainEventBusMock = vi.hoisted( () => ( {
   on: vi.fn( ( eventType, handler ) => {
-    onHandlers[eventType] = handler;
+    mainOnHandlers[eventType] = handler;
+  } )
+} ) );
+const stepEventBusMock = vi.hoisted( () => ( {
+  emit: vi.fn( () => true ),
+  on: vi.fn( ( eventType, handler ) => {
+    stepOnHandlers[eventType] = handler;
   } )
 } ) );
 
 vi.mock( '#logger', () => ( { createChildLogger: createChildLoggerMock } ) );
-vi.mock( '#bus', () => ( { messageBus: messageBusMock } ) );
+vi.mock( '#bus', () => ( {
+  mainEventBus: mainEventBusMock,
+  stepEventBus: stepEventBusMock
+} ) );
 
 import {
+  emit,
   on,
   onActivityEnd,
   onActivityError,
@@ -38,11 +49,6 @@ const workflowDetails = {
   attempt: 1
 };
 
-const catalogWorkflowDetails = {
-  ...workflowDetails,
-  workflowType: WORKFLOW_CATALOG
-};
-
 const activityInfo = {
   activityId: 'act-1',
   activityType: 'wf#step',
@@ -61,8 +67,11 @@ const aggregations = {
 describe( 'hooks/index', () => {
   beforeEach( () => {
     vi.clearAllMocks();
-    Object.keys( onHandlers ).forEach( k => {
-      delete onHandlers[k];
+    Object.keys( mainOnHandlers ).forEach( k => {
+      delete mainOnHandlers[k];
+    } );
+    Object.keys( stepOnHandlers ).forEach( k => {
+      delete stepOnHandlers[k];
     } );
   } );
 
@@ -71,9 +80,9 @@ describe( 'hooks/index', () => {
       const handler = vi.fn().mockResolvedValue( undefined );
       onError( handler );
 
-      expect( messageBusMock.on ).toHaveBeenCalledWith( BusEventType.ACTIVITY_ERROR, expect.any( Function ) );
-      expect( messageBusMock.on ).toHaveBeenCalledWith( BusEventType.WORKFLOW_ERROR, expect.any( Function ) );
-      expect( messageBusMock.on ).toHaveBeenCalledWith( BusEventType.RUNTIME_ERROR, expect.any( Function ) );
+      expect( mainEventBusMock.on ).toHaveBeenCalledWith( BusEventType.ACTIVITY_ERROR, expect.any( Function ) );
+      expect( mainEventBusMock.on ).toHaveBeenCalledWith( BusEventType.WORKFLOW_ERROR, expect.any( Function ) );
+      expect( mainEventBusMock.on ).toHaveBeenCalledWith( BusEventType.RUNTIME_ERROR, expect.any( Function ) );
     } );
 
     it( 'invokes handler with activity-shaped payload, forwarding bus fields', async () => {
@@ -81,7 +90,7 @@ describe( 'hooks/index', () => {
       onError( handler );
 
       const err = new Error( 'act-fail' );
-      await onHandlers[BusEventType.ACTIVITY_ERROR]( {
+      await mainOnHandlers[BusEventType.ACTIVITY_ERROR]( {
         eventId: 'evt-act-1',
         eventDate,
         activityInfo,
@@ -108,7 +117,7 @@ describe( 'hooks/index', () => {
       onError( handler );
 
       const err = new Error( 'wf-fail' );
-      await onHandlers[BusEventType.WORKFLOW_ERROR]( {
+      await mainOnHandlers[BusEventType.WORKFLOW_ERROR]( {
         eventId: 'evt-wf-1',
         eventDate,
         workflowDetails,
@@ -131,7 +140,7 @@ describe( 'hooks/index', () => {
       onError( handler );
 
       const error = new Error( 'rt' );
-      await onHandlers[BusEventType.RUNTIME_ERROR]( { eventId: 'evt-rt-1', eventDate, error } );
+      await mainOnHandlers[BusEventType.RUNTIME_ERROR]( { eventId: 'evt-rt-1', eventDate, error } );
 
       expect( handler ).toHaveBeenCalledWith( { eventId: 'evt-rt-1', eventDate, source: 'runtime', error } );
     } );
@@ -142,68 +151,35 @@ describe( 'hooks/index', () => {
       const handler = vi.fn().mockResolvedValue( undefined );
       onBeforeWorkerStart( handler );
 
-      expect( messageBusMock.on ).toHaveBeenCalledWith( BusEventType.WORKER_BEFORE_START, expect.any( Function ) );
-      await onHandlers[BusEventType.WORKER_BEFORE_START]();
+      expect( mainEventBusMock.on ).toHaveBeenCalledWith( BusEventType.WORKER_BEFORE_START, expect.any( Function ) );
+      await mainOnHandlers[BusEventType.WORKER_BEFORE_START]();
 
       expect( handler ).toHaveBeenCalledWith( undefined );
     } );
   } );
 
-  describe( 'onWorkflowStart', () => {
-    it( 'skips catalog workflow and forwards bus fields for real workflows', async () => {
-      const handler = vi.fn().mockResolvedValue( undefined );
-      onWorkflowStart( handler );
-
-      await Promise.resolve( onHandlers[BusEventType.WORKFLOW_START]( {
-        eventId: 'evt-ignored', eventDate, workflowDetails: catalogWorkflowDetails
-      } ) );
-      expect( handler ).not.toHaveBeenCalled();
-
-      await Promise.resolve( onHandlers[BusEventType.WORKFLOW_START]( {
-        eventId: 'evt-start-1', eventDate, workflowDetails, extra: 'passthrough'
-      } ) );
-      expect( handler ).toHaveBeenCalledWith( {
-        eventId: 'evt-start-1', eventDate, workflowDetails, extra: 'passthrough'
-      } );
-    } );
-  } );
-
-  describe( 'onWorkflowEnd', () => {
-    it( 'skips catalog workflow and forwards bus fields for real workflows', async () => {
-      const handler = vi.fn().mockResolvedValue( undefined );
-      onWorkflowEnd( handler );
-
-      await Promise.resolve( onHandlers[BusEventType.WORKFLOW_END]( {
-        eventId: 'evt-ignored', eventDate, workflowDetails: catalogWorkflowDetails
-      } ) );
-      expect( handler ).not.toHaveBeenCalled();
-
-      await Promise.resolve( onHandlers[BusEventType.WORKFLOW_END]( {
-        eventId: 'evt-end-1', eventDate, workflowDetails, extra: 'passthrough'
-      } ) );
-      expect( handler ).toHaveBeenCalledWith( {
-        eventId: 'evt-end-1', eventDate, workflowDetails, extra: 'passthrough'
-      } );
-    } );
-  } );
+  describe( 'workflow lifecycle hooks', () => {
+    const cases = [
+      [ 'onWorkflowStart', onWorkflowStart, BusEventType.WORKFLOW_START, {} ],
+      [ 'onWorkflowEnd', onWorkflowEnd, BusEventType.WORKFLOW_END, {} ],
+      [ 'onWorkflowError', onWorkflowError, BusEventType.WORKFLOW_ERROR, { error: new Error( 'workflow failed' ) } ]
+    ];
 
-  describe( 'onWorkflowError', () => {
-    it( 'skips catalog workflow and forwards bus fields for real workflows', async () => {
+    it.each( cases )( '%s forwards bus fields', async ( _name, registerHook, eventType, extraFields ) => {
       const handler = vi.fn().mockResolvedValue( undefined );
-      const err = new Error( 'wf' );
-      onWorkflowError( handler );
+      const payload = {
+        eventId: 'evt-workflow-1',
+        eventDate,
+        workflowDetails,
+        extra: 'passthrough',
+        ...extraFields
+      };
+      registerHook( handler );
 
-      await Promise.resolve( onHandlers[BusEventType.WORKFLOW_ERROR]( {
-        eventId: 'evt-ignored', eventDate, workflowDetails: catalogWorkflowDetails, error: err
-      } ) );
-      expect( handler ).not.toHaveBeenCalled();
+      expect( mainEventBusMock.on ).toHaveBeenCalledWith( eventType, expect.any( Function ) );
+      await mainOnHandlers[eventType]( payload );
 
-      await Promise.resolve( onHandlers[BusEventType.WORKFLOW_ERROR]( {
-        eventId: 'evt-err-1', eventDate, workflowDetails, error: err, extra: 'passthrough'
-      } ) );
-      expect( handler ).toHaveBeenCalledWith( {
-        eventId: 'evt-err-1', eventDate, workflowDetails, error: err, extra: 'passthrough'
-      } );
+      expect( handler ).toHaveBeenCalledWith( payload );
     } );
   } );
 
@@ -214,53 +190,49 @@ describe( 'hooks/index', () => {
       [ 'onActivityError', onActivityError, BusEventType.ACTIVITY_ERROR, { error: new Error( 'activity failed' ) } ]
     ];
 
-    it.each( cases )( '%s skips internal activities and forwards bus fields', async ( _name, registerHook, eventType, extraFields = {} ) => {
+    it.each( cases )( '%s forwards internal activity bus fields', async ( _name, registerHook, eventType, extraFields = {} ) => {
       const handler = vi.fn().mockResolvedValue( undefined );
-      registerHook( handler );
-
-      expect( messageBusMock.on ).toHaveBeenCalledWith( eventType, expect.any( Function ) );
-
-      await Promise.resolve( onHandlers[eventType]( {
-        eventId: 'evt-ignored',
-        eventDate,
-        activityInfo,
-        workflowDetails,
-        outputActivityKind: ComponentType.INTERNAL_STEP,
-        ...extraFields
-      } ) );
-      expect( handler ).not.toHaveBeenCalled();
-
-      await Promise.resolve( onHandlers[eventType]( {
+      const payload = {
         eventId: 'evt-activity-1',
         eventDate,
         activityInfo,
         workflowDetails,
-        outputActivityKind: ComponentType.STEP,
+        outputActivityKind: 'internal_step',
         extra: 'passthrough',
         ...extraFields
-      } ) );
+      };
+      registerHook( handler );
 
-      expect( handler ).toHaveBeenCalledWith( {
-        eventId: 'evt-activity-1',
-        eventDate,
-        activityInfo,
-        workflowDetails,
-        outputActivityKind: ComponentType.STEP,
-        extra: 'passthrough',
-        ...extraFields
-      } );
+      expect( mainEventBusMock.on ).toHaveBeenCalledWith( eventType, expect.any( Function ) );
+      await mainOnHandlers[eventType]( payload );
+
+      expect( handler ).toHaveBeenCalledWith( payload );
     } );
   } );
 
   describe( 'on', () => {
-    it( 'subscribes to external event channel and forwards payload', async () => {
+    it( 'subscribes to SDK and user event channels and forwards payloads', async () => {
       const handler = vi.fn().mockResolvedValue( undefined );
       on( 'myEvent', handler );
 
-      expect( messageBusMock.on ).toHaveBeenCalledWith( 'external:myEvent', expect.any( Function ) );
-      await onHandlers['external:myEvent']( { foo: 1 } );
+      expect( stepEventBusMock.on ).toHaveBeenCalledWith( 'sdk:myEvent', expect.any( Function ) );
+      expect( stepEventBusMock.on ).toHaveBeenCalledWith( 'usr:myEvent', expect.any( Function ) );
+      await stepOnHandlers['sdk:myEvent']( { payload: { source: 'sdk' } } );
+      await stepOnHandlers['usr:myEvent']( { payload: { source: 'user' } } );
+
+      expect( handler ).toHaveBeenNthCalledWith( 1, { payload: { source: 'sdk' } } );
+      expect( handler ).toHaveBeenNthCalledWith( 2, { payload: { source: 'user' } } );
+    } );
+  } );
+
+  describe( 'emit', () => {
+    it( 'emits payloads on the user event channel', () => {
+      const payload = { foo: 1 };
+
+      const emitted = emit( 'myEvent', payload );
 
-      expect( handler ).toHaveBeenCalledWith( { foo: 1 } );
+      expect( stepEventBusMock.emit ).toHaveBeenCalledWith( 'usr:myEvent', payload );
+      expect( emitted ).toBe( true );
     } );
   } );
 } );

package/src/interface/workflow.js

@@ -7,104 +7,111 @@ import { TraceInfo } from '#helpers/trace_info';
 import { deepMerge } from '#helpers/object';
 import { defaultOptions } from './workflow_activity_options.js';
 import { createWorkflow } from '#helpers/component';
-import {
-  ACTIVITY_GET_TRACE_DESTINATIONS,
-  METADATA_ACCESS_SYMBOL,
-  SHARED_STEP_PREFIX,
-  WORKFLOW_WRAPPER_VERSION_FIELD
-} from '#consts';
+import { FatalError } from '#errors';
+import * as C from '#consts';
 
 /**
- * Create a new workflow and return a wrapper function around its fn handler
+ * Execute the workflow without temporal, using the fn handler function.
+ * This is important to allow for workflows to have unit tests
  */
+const executeWithoutTemporal = async ( { input, validator, handler, contextOverrides = {} } ) => {
+  validator.validateInput( input );
+  const output = await handler( input, deepMerge( WorkflowContext.build(), contextOverrides ) );
+  validator.validateOutput( output );
+  return output;
+};
+
+/**
+ * Add a global dispatcher function to be used to invoke activities.
+ * This will replace direct activity invocation in the user code by the webpack loader.
+ *
+ * Important: Keep this as a configurable global assignment (configurable=true, enumerable=true),
+ * so Temporal's reusable VM can delete it when switching workflow scopes.
+ */
+const createGlobalDispatcher = ( { runId, workflowType, activities } ) => {
+  const dispatcher = async ( activityType, ...args ) => activities[`${workflowType}#${activityType}`]( ...args ).then( r => r.output );
+  dispatcher.runId = runId;
+  globalThis[C.INVOKE_ACTIVITY_SYMBOL] = dispatcher;
+};
+
+/**  Validate if the global dispatcher wasn't set by another workflow, indicating global context contamination. */
+const checkGlobalContextContamination = runId => {
+  const globalContextRunId = globalThis?.[C.INVOKE_ACTIVITY_SYMBOL]?.runId;
+  if ( globalContextRunId && globalContextRunId !== runId ) {
+    throw new FatalError( 'Contamination of the workflow Node global context.' +
+      ` Var "globalThis[${String( C.INVOKE_ACTIVITY_SYMBOL )}]" was set by another workflow (${globalContextRunId})` );
+  }
+};
+
+/** Create a new workflow and return a wrapper function around its fn handler */
 export function workflow( { name, description, inputSchema, outputSchema, fn, options = {}, aliases = [] } ) {
   WorkflowValidator.validateDefinition( { name, description, inputSchema, outputSchema, fn, options, aliases } );
 
-  const { disableTrace, activityOptions } = deepMerge( defaultOptions, options );
+  // Disable trace can only be defined at the definition level
+  const disableTrace = options.disableTrace ?? defaultOptions.disableTrace;
   const validator = new WorkflowValidator( { name, inputSchema, outputSchema } );
 
-  return createWorkflow( {
-    name,
-    description,
-    inputSchema,
-    outputSchema,
-    options,
-    aliases,
-    handler: async ( input, extra = {} ) => {
-      validator.validateInvocationOptions( extra );
-
-      // this returns a plain function, for example, in unit tests
-      if ( !inWorkflowContext() ) {
-        validator.validateInput( input );
-        const output = await fn( input, deepMerge( WorkflowContext.build(), extra?.context ) );
-        validator.validateOutput( output );
-        return output;
-      }
+  const handler = async ( input, invocationOptions = {} ) => {
+    validator.validateInvocationOptions( invocationOptions );
 
-      const { workflowId, memo, root } = workflowInfo();
-
-      // if the stack already includes this workflowId, means the workflow() function was called
-      // from within a running workflow, meaning it is suppose to start a child workflow
-      const isChild = Array.isArray( memo.stack ) ? memo.stack.includes( workflowId ) : false;
-
-      if ( isChild ) {
-        const result = await executeChild( name, {
-          args: undefined === input ? [] : [ input ],
-          workflowId: `${workflowId}-${toUrlSafeBase64( uuid4() )}`,
-          parentClosePolicy: ParentClosePolicy[extra?.detached ? 'ABANDON' : 'TERMINATE'],
-          memo: {
-            ...memo, // Preserve memo and mix activityOptions, if provided
-            ...( extra?.activityOptions && {
-              activityOptions: deepMerge( memo?.activityOptions ?? {}, extra?.activityOptions )
-            } )
-          }
-        } );
-        return result.output;
-      }
+    // If called outside Temporal workflow context, just execute the handler function
+    if ( !inWorkflowContext() ) {
+      return executeWithoutTemporal( { input, validator, handler: fn, contextOverrides: invocationOptions?.context } );
+    }
+
+    const { workflowId, runId, memo, root } = workflowInfo();
 
-      const isRoot = !root;
+    checkGlobalContextContamination( runId );
 
-      memo.stack = [ ...memo.stack ?? [], workflowId ];
-      // Parent options have prevalence on nested calls, child will be overwritten
-      memo.activityOptions = deepMerge( activityOptions, memo.activityOptions );
-      // Trace info is only added in the root and only when trace is not disabled
-      if ( isRoot && !disableTrace ) {
-        memo.traceInfo = TraceInfo.build();
+    // If the parent workflow already installed the activity dispatcher, it means that calls to workflow() will trigger child workflows
+    const isChildWorkflowCall = !!globalThis[C.INVOKE_ACTIVITY_SYMBOL];
+    if ( isChildWorkflowCall ) {
+      const parentClosePolicy = ParentClosePolicy[invocationOptions?.detached ? 'ABANDON' : 'TERMINATE'];
+      const childWorkflowId = `${workflowId}-${toUrlSafeBase64( uuid4() )}`;
+      const args = [ input, { activityOptions: invocationOptions?.activityOptions } ];
+      return executeChild( name, { args, workflowId: childWorkflowId, parentClosePolicy, memo } ).then( r => r.output );
+    }
+
+    const isRoot = !root; // Check if this is the root most workflow
+
+    // Trace info is only added in the root and only when trace is not disabled
+    if ( isRoot && !disableTrace ) {
+      memo.traceInfo = TraceInfo.build();
+    }
+
+    // Resolve the activity options: invocation options > definition options > parent options > default options
+    const activityOptions = deepMerge(
+      defaultOptions.activityOptions, // default
+      memo?.parentActivityOptions, // parent options
+      options?.activityOptions, // definition options
+      invocationOptions.activityOptions // invocation options
+    );
+    // Resolved activity options are added to memo so child workflow executions can continue the policy chain.
+    memo.parentActivityOptions = activityOptions;
+    const activities = proxyActivities( activityOptions );
+
+    createGlobalDispatcher( { runId, workflowType: name, activities } );
+
+    const traceDestinations = isRoot && {
+      trace: {
+        destinations: disableTrace ? {} : await activities[C.ACTIVITY_GET_TRACE_DESTINATIONS]( memo.traceInfo ).then( r => r.output ) ?? {}
       }
+    };
 
-      const steps = proxyActivities( memo.activityOptions );
-      const traceDestinations = isRoot && {
-        trace: {
-          destinations: disableTrace ? {} : ( await steps[ACTIVITY_GET_TRACE_DESTINATIONS]( memo.traceInfo ) ).output ?? {}
-        }
-      };
-
-      try {
-        validator.validateInput( input );
-
-        // Creates an activity caller based on a prefix
-        const createCaller = prefix => async ( t, ...args ) => ( await steps[`${prefix}#${t}`]( ...args ) ).output;
-
-        // This are functions used by the AST to replace direct activity (step/evaluator) calls
-        const dispatchers = {
-          invokeStep: createCaller( name ),
-          invokeSharedStep: createCaller( SHARED_STEP_PREFIX ),
-          invokeEvaluator: createCaller( name ),
-          invokeSharedEvaluator: createCaller( SHARED_STEP_PREFIX )
-        };
-
-        // The workflow function execution with "this" set with the dispatchers
-        const output = await fn.call( dispatchers, input, WorkflowContext.build() );
-        validator.validateOutput( output );
-
-        return { [WORKFLOW_WRAPPER_VERSION_FIELD]: 1, output, ...traceDestinations };
-      } catch ( error ) {
-        if ( traceDestinations ) {
-          // Append the trace destinations so it is carried to interceptor
-          error[METADATA_ACCESS_SYMBOL] = traceDestinations;
-        }
-        throw error;
+    try {
+      validator.validateInput( input );
+      const output = await fn( input, WorkflowContext.build() );
+      validator.validateOutput( output );
+
+      return { [C.WORKFLOW_WRAPPER_VERSION_FIELD]: 1, output, ...traceDestinations };
+    } catch ( error ) {
+      if ( traceDestinations ) {
+        // Append the trace destinations so it is carried to interceptor
+        error[C.METADATA_ACCESS_SYMBOL] = traceDestinations;
       }
+      throw error;
     }
-  } );
+  };
+
+  return createWorkflow( { name, description, inputSchema, outputSchema, options, aliases, handler } );
 }