@outputai/core 0.8.2-next.e1cd79b.0 → 0.8.2-next.e658cc2.0

package/src/worker/sinks.js

@@ -1,7 +1,7 @@
 import { BusEventType, ComponentType } from '#consts';
 import * as Tracing from '#tracing';
 import { messageBus } from '#bus';
-import { createWorkflowDetails } from '#internal_utils/temporal_context';
+import { createWorkflowDetails } from '#helpers/temporal_context';
 
 // This sink allow for sandbox Temporal environment to send trace logs back to the main thread.
 export const sinks = {
@@ -10,6 +10,12 @@ export const sinks = {
    * Workflow lifecycle sinks
    */
   workflow: {
+    log: {
+      fn: ( workflowInfo, { level, message, metadata } ) => {
+        messageBus.emit( BusEventType.WORKFLOW_LOG, { level, message, metadata, workflowDetails: createWorkflowDetails( workflowInfo ) } );
+      },
+      callDuringReplay: false
+    },
     start: {
       fn: ( workflowInfo, input ) => {
         const { runId, workflowType, memo: { traceInfo }, parent } = workflowInfo;

package/src/worker/sinks.spec.js

@@ -0,0 +1,203 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { BusEventType, ComponentType } from '#consts';
+
+const messageBusMock = vi.hoisted( () => ( {
+  emit: vi.fn()
+} ) );
+
+const addEventStartMock = vi.hoisted( () => vi.fn() );
+const addEventEndMock = vi.hoisted( () => vi.fn() );
+const addEventErrorMock = vi.hoisted( () => vi.fn() );
+
+const createWorkflowDetailsMock = vi.hoisted( () => vi.fn( workflowInfo => ( {
+  workflowId: workflowInfo.workflowId,
+  workflowType: workflowInfo.workflowType,
+  runId: workflowInfo.runId
+} ) ) );
+
+vi.mock( '#bus', () => ( { messageBus: messageBusMock } ) );
+vi.mock( '#tracing', () => ( {
+  addEventStart: addEventStartMock,
+  addEventEnd: addEventEndMock,
+  addEventError: addEventErrorMock
+} ) );
+vi.mock( '#helpers/temporal_context', () => ( {
+  createWorkflowDetails: createWorkflowDetailsMock
+} ) );
+
+describe( 'worker/sinks', () => {
+  const workflowInfo = {
+    workflowId: 'wf-1',
+    workflowType: 'myWorkflow',
+    runId: 'run-1',
+    memo: {
+      traceInfo: { traceId: 'trace-1' }
+    },
+    parent: {
+      runId: 'parent-run-1'
+    }
+  };
+  const workflowDetails = {
+    workflowId: 'wf-1',
+    workflowType: 'myWorkflow',
+    runId: 'run-1'
+  };
+
+  beforeEach( () => {
+    vi.clearAllMocks();
+  } );
+
+  it( 'disables replay calls for side-effecting sinks', async () => {
+    const { sinks } = await import( './sinks.js' );
+
+    expect( sinks.workflow.start.callDuringReplay ).toBe( false );
+    expect( sinks.workflow.end.callDuringReplay ).toBe( false );
+    expect( sinks.workflow.error.callDuringReplay ).toBe( false );
+    expect( sinks.trace.start.callDuringReplay ).toBe( false );
+    expect( sinks.trace.end.callDuringReplay ).toBe( false );
+    expect( sinks.trace.error.callDuringReplay ).toBe( false );
+  } );
+
+  it( 'workflow.log emits workflow log events with metadata and workflow details', async () => {
+    const { sinks } = await import( './sinks.js' );
+    const metadata = { requestId: 'req-1' };
+
+    sinks.workflow.log.fn( workflowInfo, {
+      level: 'info',
+      message: 'workflow detail',
+      metadata
+    } );
+
+    expect( createWorkflowDetailsMock ).toHaveBeenCalledWith( workflowInfo );
+    expect( messageBusMock.emit ).toHaveBeenCalledWith( BusEventType.WORKFLOW_LOG, {
+      level: 'info',
+      message: 'workflow detail',
+      metadata,
+      workflowDetails
+    } );
+  } );
+
+  it( 'workflow.start emits workflow start events and trace start events', async () => {
+    const { sinks } = await import( './sinks.js' );
+    const input = { value: 'input' };
+
+    sinks.workflow.start.fn( workflowInfo, input );
+
+    expect( messageBusMock.emit ).toHaveBeenCalledWith( BusEventType.WORKFLOW_START, { workflowDetails } );
+    expect( addEventStartMock ).toHaveBeenCalledWith( {
+      id: 'run-1',
+      kind: ComponentType.WORKFLOW,
+      name: 'myWorkflow',
+      details: input,
+      parentId: 'parent-run-1',
+      traceInfo: { traceId: 'trace-1' }
+    } );
+  } );
+
+  it( 'workflow.start skips tracing when trace info is absent', async () => {
+    const { sinks } = await import( './sinks.js' );
+
+    sinks.workflow.start.fn( { ...workflowInfo, memo: {} }, { value: 'input' } );
+
+    expect( messageBusMock.emit ).toHaveBeenCalledWith( BusEventType.WORKFLOW_START, { workflowDetails } );
+    expect( addEventStartMock ).not.toHaveBeenCalled();
+  } );
+
+  it( 'workflow.end emits workflow end events and trace end events', async () => {
+    const { sinks } = await import( './sinks.js' );
+    const output = { value: 'output' };
+
+    sinks.workflow.end.fn( workflowInfo, output );
+
+    expect( messageBusMock.emit ).toHaveBeenCalledWith( BusEventType.WORKFLOW_END, { workflowDetails } );
+    expect( addEventEndMock ).toHaveBeenCalledWith( {
+      id: 'run-1',
+      details: output,
+      traceInfo: { traceId: 'trace-1' }
+    } );
+  } );
+
+  it( 'workflow.end skips tracing when trace info is absent', async () => {
+    const { sinks } = await import( './sinks.js' );
+
+    sinks.workflow.end.fn( { ...workflowInfo, memo: {} }, { value: 'output' } );
+
+    expect( messageBusMock.emit ).toHaveBeenCalledWith( BusEventType.WORKFLOW_END, { workflowDetails } );
+    expect( addEventEndMock ).not.toHaveBeenCalled();
+  } );
+
+  it( 'workflow.error emits workflow error events and trace error events', async () => {
+    const { sinks } = await import( './sinks.js' );
+    const error = new Error( 'workflow failed' );
+
+    sinks.workflow.error.fn( workflowInfo, error );
+
+    expect( messageBusMock.emit ).toHaveBeenCalledWith( BusEventType.WORKFLOW_ERROR, { workflowDetails, error } );
+    expect( addEventErrorMock ).toHaveBeenCalledWith( {
+      id: 'run-1',
+      details: error,
+      traceInfo: { traceId: 'trace-1' }
+    } );
+  } );
+
+  it( 'workflow.error skips tracing when trace info is absent', async () => {
+    const { sinks } = await import( './sinks.js' );
+    const error = new Error( 'workflow failed' );
+
+    sinks.workflow.error.fn( { ...workflowInfo, memo: {} }, error );
+
+    expect( messageBusMock.emit ).toHaveBeenCalledWith( BusEventType.WORKFLOW_ERROR, { workflowDetails, error } );
+    expect( addEventErrorMock ).not.toHaveBeenCalled();
+  } );
+
+  it( 'trace.start records trace start events with workflow parent context', async () => {
+    const { sinks } = await import( './sinks.js' );
+
+    sinks.trace.start.fn( workflowInfo, {
+      id: 'step-1',
+      kind: ComponentType.STEP,
+      name: 'myStep',
+      details: { input: true }
+    } );
+
+    expect( addEventStartMock ).toHaveBeenCalledWith( {
+      id: 'step-1',
+      kind: ComponentType.STEP,
+      name: 'myStep',
+      details: { input: true },
+      parentId: 'parent-run-1',
+      traceInfo: { traceId: 'trace-1' }
+    } );
+  } );
+
+  it( 'trace.end records trace end events', async () => {
+    const { sinks } = await import( './sinks.js' );
+
+    sinks.trace.end.fn( workflowInfo, {
+      id: 'step-1',
+      details: { output: true }
+    } );
+
+    expect( addEventEndMock ).toHaveBeenCalledWith( {
+      id: 'step-1',
+      details: { output: true },
+      traceInfo: { traceId: 'trace-1' }
+    } );
+  } );
+
+  it( 'trace.error records trace error events', async () => {
+    const { sinks } = await import( './sinks.js' );
+    const error = new Error( 'step failed' );
+
+    sinks.trace.error.fn( workflowInfo, {
+      id: 'step-1',
+      details: error
+    } );
+
+    expect( addEventErrorMock ).toHaveBeenCalledWith( {
+      id: 'step-1',
+      details: error,
+      traceInfo: { traceId: 'trace-1' }
+    } );
+  } );
+} );

package/src/activity_integration/context.d.ts

@@ -1,23 +0,0 @@
-import type { Info } from '@temporalio/activity';
-/**
- * Context returned by {@link getContext} when running inside a Temporal Activity (step or evaluator).
- */
-export type Context = {
-  /** Temporal info about the current activity */
-  activityInfo: Info,
-  /** Path of the workflow file */
-  workflowFilename: string
-};
-
-/**
- * Returns information about the current Temporal execution.
- *
- * Only available when called from within a step or evaluator (Temporal Activities) running in the Temporal runtime.
- *
- * @remarks
- * - Returns `null` when not called inside a Temporal Activity (steps/evaluators);
- * - Returns `null` when not called from within a running Temporal worker, like in unit tests environment;
- *
- * @returns The workflow context, or `null` if unavailable or incomplete.
- */
-export declare function getExecutionContext(): Context | null;

package/src/activity_integration/context.js

@@ -1,18 +0,0 @@
-import { Storage } from '#async_storage';
-
-/**
- * Returns information trapped on AsyncStorage about the workflow invoking an activity
- *
- * @returns {object}
- */
-export const getExecutionContext = () => {
-  const ctx = Storage.load();
-  if ( !ctx ) {
-    return null;
-  }
-
-  return {
-    workflowFilename: ctx.workflowFilename,
-    activityInfo: ctx.activityInfo
-  };
-};

package/src/activity_integration/event_id_integration.spec.js

@@ -1,52 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { messageBus } from '#bus';
-import { emitEvent } from './events.js';
-
-const UUID_V4_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
-
-describe( 'eventId integration', () => {
-  beforeEach( () => {
-    messageBus.removeAllListeners();
-  } );
-
-  it( 'stamps a UUID v4 eventId on every emit (end-to-end via messageBus)', () => {
-    const handler = vi.fn();
-    messageBus.on( 'external:cost:llm:request', handler );
-
-    emitEvent( 'cost:llm:request', { modelId: 'gpt-4o' } );
-
-    expect( handler ).toHaveBeenCalledWith( expect.objectContaining( {
-      eventId: expect.stringMatching( UUID_V4_REGEX ),
-      modelId: 'gpt-4o'
-    } ) );
-  } );
-
-  it( 'cost:http:request and http:request for the same fetch get distinct eventIds', () => {
-    const costHandler = vi.fn();
-    const reqHandler = vi.fn();
-    messageBus.on( 'external:cost:http:request', costHandler );
-    messageBus.on( 'external:http:request', reqHandler );
-
-    const sharedRequestId = 'req-xyz';
-    emitEvent( 'cost:http:request', { requestId: sharedRequestId, url: 'https://x.test', cost: 1 } );
-    emitEvent( 'http:request', { requestId: sharedRequestId, url: 'https://x.test', status: 200 } );
-
-    const costEventId = costHandler.mock.calls[0][0].eventId;
-    const reqEventId = reqHandler.mock.calls[0][0].eventId;
-    expect( costEventId ).toMatch( UUID_V4_REGEX );
-    expect( reqEventId ).toMatch( UUID_V4_REGEX );
-    expect( costEventId ).not.toBe( reqEventId );
-  } );
-
-  it( 'honors a caller-supplied eventId end-to-end', () => {
-    const handler = vi.fn();
-    messageBus.on( 'external:custom:event', handler );
-
-    emitEvent( 'custom:event', { eventId: 'fixed-id-123', payload: 'hi' } );
-
-    expect( handler ).toHaveBeenCalledWith( expect.objectContaining( {
-      eventId: 'fixed-id-123',
-      payload: 'hi'
-    } ) );
-  } );
-} );

package/src/activity_integration/events.d.ts

@@ -1,10 +0,0 @@
-/**
- * Emits a custom event on the in-process message bus.
- *
- * When called inside an Output activity context, the framework automatically
- * attaches `activityInfo`, `workflowDetails`, and `outputActivityKind` onto the emitted payload.
- *
- * @param eventName - The name of the event to emit
- * @param payload - An optional payload to send to the event
- */
-export declare function emitEvent( eventName: string, payload?: unknown ): void;

package/src/activity_integration/events.js

@@ -1,15 +0,0 @@
-import { messageBus } from '#bus';
-import { Storage } from '#async_storage';
-
-export const emitEvent = ( eventName, payload ) => {
-  const ctx = Storage.load();
-
-  messageBus.emit( `external:${eventName}`, {
-    ...payload ?? {},
-    ...( ctx && {
-      activityInfo: ctx.activityInfo,
-      workflowDetails: ctx.workflowDetails,
-      outputActivityKind: ctx.outputActivityKind
-    } )
-  } );
-};

package/src/activity_integration/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * > [!WARNING]
- * > **Internal use only.** Not part of the public API; may change without notice.
- *
- * @packageDocumentation
- */
-export { getExecutionContext } from './context';
-export { emitEvent } from './events';
-export * as Tracing from './tracing';

package/src/activity_integration/index.js

@@ -1,3 +0,0 @@
-export { getExecutionContext } from './context.js';
-export { emitEvent } from './events.js';
-export * as Tracing from './tracing.js';

package/src/activity_integration/tracing.d.ts

@@ -1,40 +0,0 @@
-import type { Attribute } from '#trace_attribute';
-
-export { Attribute } from '#trace_attribute';
-/**
- * Creates a new event.
- *
- * @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 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;
-
-/**
- * Concludes an event.
- *
- * @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;
-
-/**
- * Concludes an event with an error.
- *
- * @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.attribute - The attribute to attach to the event.
- */
-export declare function addEventAttribute( args: { eventId: string; attribute: Attribute.Instance } ): void;

package/src/activity_integration/tracing.js

@@ -1,48 +0,0 @@
-import { addEventActionWithContext, EventAction } from '#tracing';
-
-export { Attribute } from '#trace_attribute';
-
-/**
- * Creates a new event.
- *
- * @param {object} args
- * @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 - Arbitrary data to add to this event, it will be used as the "input" field.
- * @returns {void}
- */
-export const addEventStart = ( { id, kind, name, details } ) =>
-  addEventActionWithContext( EventAction.START, { kind, name, details, id } );
-
-/**
- * Concludes an event.
- *
- * @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 "output" field.
- * @returns {void}
- */
-export const addEventEnd = ( { id, details } ) => addEventActionWithContext( EventAction.END, { id, details } );
-
-/**
- * Concludes an event with an error.
- *
- * @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.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 addEventAttribute = ( { eventId, attribute } ) =>
-  addEventActionWithContext( EventAction.ADD_ATTR, { id: eventId, details: attribute } );

package/src/utils/index.d.ts

@@ -1,180 +0,0 @@
-/**
- * > [!WARNING]
- * > **Internal use only.** Not part of the public API; may change without notice.
- *
- * @packageDocumentation
- */
-
-/**
- * Return the first immediate directory of the file invoking the code that called this function.
- *
- * Excludes `@outputai/core`, node, and other internal paths.
- */
-export function resolveInvocationDir(): string;
-
-/**
- * Node safe clone implementation that doesn't use global structuredClone().
- *
- * Returns a cloned version of the object.
- *
- * Only clones static properties. Getters become static properties.
- *
- * @param object
- */
-export function clone( object: object ): object;
-
-/**
- * Receives an error as argument and throws it.
- *
- * @param error
- * @throws {Error}
- */
-export function throws( error: Error ): void;
-
-/**
- * Attach given value to an object with the METADATA_ACCESS_SYMBOL symbol as key.
- *
- * @param target
- * @param value
- * @returns
- */
-export function setMetadata( target: object, value: object ): void;
-
-/**
- * Read metadata previously attached via setMetadata.
- *
- * @param target - The function or object to read metadata from.
- * @returns The metadata object, or null if none is attached.
- */
-export function getMetadata( target: Function ): { name: string; description?: string; type?: string } | null;
-
-/** Represents a {Response} serialized to plain object  */
-export type SerializedFetchResponse = {
-  /** The response url */
-  url: string,
-
-  /** The response status code */
-  status: number,
-
-  /** The response status text */
-  statusText: string,
-
-  /** Flag indicating if the request succeeded */
-  ok: boolean,
-
-  /** Object with response headers */
-  headers: Record<string, string>,
-
-  /** Response body, either JSON, text or arrayBuffer converter to base64 */
-  body: object | string
-};
-
-/**
- * Consumes an HTTP `Response` and serializes it to a plain object.
- *
- * @param response - The response to serialize.
- * @returns SerializedFetchResponse
- */
-export function serializeFetchResponse( response: Response ): SerializedFetchResponse;
-
-export type SerializedBodyAndContentType = {
-  /** The body as a string when possible; otherwise the original value */
-  body: string | unknown,
-  /** The inferred `Content-Type` header value, if any */
-  contentType: string | undefined
-};
-
-/**
- * Serializes a payload for use as a fetch POST body and infers its `Content-Type`.
- *
- * @param body - The payload to serialize.
- * @returns The serialized body and inferred `Content-Type`.
- */
-export function serializeBodyAndInferContentType( body: unknown ): SerializedBodyAndContentType;
-
-/**
- * Returns true if the value is a plain object:
- * - `{}`
- * - `new Object()`
- * - `Object.create(null)`
- *
- * @param object - The value to check.
- * @returns Whether the value is a plain object.
- */
-export function isPlainObject( object: unknown ): boolean;
-
-/**
- * Returns a copy of an array with its content shuffled.
- *
- * @param arr - The array to shuffle
- * @returns A shuffled array copy
- */
-export function shuffleArray( arr: unknown[] ): unknown[];
-
-/**
- * Creates a new object by merging object `b` onto object `a`, biased toward `b`:
- * - Fields in `b` overwrite fields in `a`.
- * - Fields in `b` that don't exist in `a` are created.
- * - Fields in `a` that don't exist in `b` are left unchanged.
- *
- * @param a - The base object.
- * @param b - The overriding object.
- * @throws {Error} If either `a` or `b` is not a plain object.
- * @returns A new merged object.
- */
-export function deepMerge( a: object, b: object | null | undefined ): object;
-
-/**
- * Creates a new object by merging object `b` onto object `a`, biased toward `b`:
- * - Fields in `b` that don't exist in `a` are created.
- * - Fields in `a` that don't exist in `b` are left unchanged.
- * - Fields in `a` and `b` are passed as arguments to the resolve function (a,b) and its return assigns the new value.
- *
- * @param a - The base object.
- * @param b - The overriding object.
- * @param resolver - The resolver function.
- * @throws {Error} If either `a` or `b` is not a plain object.
- * @returns A new merged object.
- */
-export function deepMergeWithResolver( a: object, b: object | null | undefined, resolver: function ): object;
-
-/**
- * Shortens a UUID to a url-safe base64-like string (custom 64-char alphabet).
- * Temporal-friendly: no Buffer or crypto; safe to use inside workflows.
- *
- * @param uuid - Standard UUID (e.g. `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`).
- * @returns Short string using A–Z, a–z, 0–9, `_`, `-` (typically 21–22 chars).
- */
-export function toUrlSafeBase64( uuid: string ): string;
-
-/**
- * Similar to native Promise.allSettled, but rejects with `{ isTimeout: true }`
- * if the execution exceeds the given timeout.
- *
- * @param promises - Values or promises to wait for.
- * @param timeoutMs - Maximum wait time in milliseconds.
- * @returns Native Promise.allSettled-style results.
- */
-export function allSettledWithTimeout<T>(
-  promises: Array<T | PromiseLike<T>>,
-  timeoutMs: number
-): Promise<PromiseSettledResult<Awaited<T>>[]>;
-
-/**
- * Promise wrapper that can be resolved externally.
- */
-export class CancellablePromise {
-  /** The internal promise */
-  readonly promise: Promise<void>;
-  /** Whether the promise is already resolved or not */
-  readonly completed: boolean;
-  /** Resolves the promise */
-  complete(): void;
-}
-
-/**
- * Returns a function that invokes the wrapped function once.
- */
-export function runOnce<Args extends unknown[], Return>(
-  fn: ( ...args: Args ) => Return
-): ( ...args: Args ) => Return;

package/src/utils/index.js

@@ -1,2 +0,0 @@
-export { default as resolveInvocationDir } from './resolve_invocation_dir.js';
-export * from './utils.js';

package/src/utils/resolve_invocation_dir.js

@@ -1,34 +0,0 @@
-import * as stackTraceParser from 'stacktrace-parser';
-
-// OS separator, but in a deterministic way, allowing this to work in Temporal's sandbox
-// This avoids importing from node:path
-const SEP = new Error().stack.includes( '/' ) ? '/' : '\\';
-
-const transformSeparators = path => path.replaceAll( '/', SEP );
-const defaultIgnorePaths = [
-  '/@outputai/core/',
-  '/@outputai/llm/',
-  '/@outputai/evals/',
-  '/sdk/core/',
-  '/sdk/llm/',
-  '/sdk/evals/',
-  'node:internal/',
-  'evalmachine.',
-  'webpack/bootstrap'
-];
-
-/**
- * Return the directory of the file invoking the code that called this function
- * Excludes some internal paths and the sdk itself
- */
-export default ( additionalIgnorePaths = [] ) => {
-  const stack = new Error().stack;
-  const lines = stackTraceParser.parse( stack );
-  const ignorePaths = [ ...additionalIgnorePaths, ...defaultIgnorePaths ].map( transformSeparators );
-
-  const frame = lines.find( l => !ignorePaths.some( p => l.file.includes( p ) ) );
-  if ( !frame ) {
-    throw new Error( `Invocation dir resolution via stack trace failed. Stack: ${stack}` );
-  }
-  return frame.file.replace( 'file://', '' ).split( SEP ).slice( 0, -1 ).join( SEP );
-};