@outputai/core 0.2.1-next.fd72d95.0 → 0.3.0

package/src/tracing/tools/utils.spec.js

@@ -1,5 +1,15 @@
-import { describe, it, expect } from 'vitest';
-import { serializeError } from './utils.js';
+import { describe, it, expect, vi } from 'vitest';
+import { safeFormatJSON, serializeError } from './utils.js';
+
+const isPrettyStringifyCall = args => args.length >= 3 && args[2] === 2;
+
+/** @param {number} targetBytes UTF-8 size of compact JSON.stringify( { a: "<xs>" } ) */
+const objectWithCompactByteLength = targetBytes => {
+  const sample = { a: '' };
+  const overhead = Buffer.byteLength( JSON.stringify( sample ), 'utf8' );
+  const repeat = Math.max( 0, targetBytes - overhead );
+  return { a: 'x'.repeat( repeat ) };
+};
 
 describe( 'tracing/utils', () => {
   it( 'serializeError unwraps causes and keeps message/stack', () => {
@@ -11,4 +21,126 @@ describe( 'tracing/utils', () => {
     expect( out.message ).toBe( 'inner' );
     expect( typeof out.stack ).toBe( 'string' );
   } );
+
+  describe( 'safeFormatJSON', () => {
+    it( 'formats small objects with indentation when under threshold', () => {
+      const content = { a: 1, b: [ 2, 3 ] };
+      const out = safeFormatJSON( content, 10_000 );
+
+      expect( out ).toContain( '\n' );
+      expect( out ).toMatch( /^\{\n/ );
+      expect( JSON.parse( out ) ).toEqual( content );
+    } );
+
+    it( 'formats small arrays with indentation when under threshold', () => {
+      const content = [ 1, { nested: true } ];
+      const out = safeFormatJSON( content, 10_000 );
+
+      expect( out ).toContain( '\n' );
+      expect( out.trimStart() ).toMatch( /^\[/ );
+      expect( JSON.parse( out ) ).toEqual( content );
+    } );
+
+    it( 'returns compact JSON when compact UTF-8 size is strictly greater than threshold', () => {
+      const content = objectWithCompactByteLength( 40 );
+      const compact = JSON.stringify( content );
+      expect( Buffer.byteLength( compact, 'utf8' ) ).toBe( 40 );
+
+      const out = safeFormatJSON( content, 39 );
+      expect( out ).toBe( compact );
+      expect( out ).not.toContain( '\n  ' );
+      expect( JSON.parse( out ) ).toEqual( content );
+    } );
+
+    it( 'uses pretty JSON when compact UTF-8 size equals threshold', () => {
+      const content = objectWithCompactByteLength( 40 );
+      const compact = JSON.stringify( content );
+      expect( Buffer.byteLength( compact, 'utf8' ) ).toBe( 40 );
+
+      const out = safeFormatJSON( content, 40 );
+      expect( out ).not.toBe( compact );
+      expect( out ).toContain( '\n' );
+      expect( JSON.parse( out ) ).toEqual( content );
+    } );
+
+    it( 'uses UTF-8 byte length for threshold, not JavaScript string length', () => {
+      const content = { label: 'éclair' };
+      const compact = JSON.stringify( content );
+      expect( compact.length ).toBeLessThan( Buffer.byteLength( compact, 'utf8' ) );
+
+      const bytes = Buffer.byteLength( compact, 'utf8' );
+      const outCompact = safeFormatJSON( content, bytes - 1 );
+      expect( outCompact ).toBe( compact );
+
+      const outPretty = safeFormatJSON( content, bytes + 100 );
+      expect( outPretty ).toContain( '\n' );
+      expect( JSON.parse( outPretty ) ).toEqual( content );
+    } );
+
+    it( 'round-trips empty object and primitives for both branches', () => {
+      const tiny = {};
+      const pretty = safeFormatJSON( tiny, 100 );
+      expect( JSON.parse( pretty ) ).toEqual( tiny );
+
+      const forcedCompact = safeFormatJSON( tiny, 0 );
+      expect( JSON.parse( forcedCompact ) ).toEqual( tiny );
+    } );
+
+    it( 'returns compact JSON when pretty stringify throws Invalid string length', () => {
+      const content = { a: 1 };
+      const compact = JSON.stringify( content );
+      const origStringify = JSON.stringify.bind( JSON );
+
+      const spy = vi.spyOn( JSON, 'stringify' ).mockImplementation( ( ...args ) => {
+        if ( isPrettyStringifyCall( args ) ) {
+          throw new RangeError( 'Invalid string length' );
+        }
+        return origStringify( ...args );
+      } );
+
+      try {
+        const out = safeFormatJSON( content, 10_000 );
+        expect( out ).toBe( compact );
+        expect( JSON.parse( out ) ).toEqual( content );
+      } finally {
+        spy.mockRestore();
+      }
+    } );
+
+    it( 'rethrows RangeError when message is not Invalid string length', () => {
+      const content = { a: 1 };
+      const origStringify = JSON.stringify.bind( JSON );
+
+      const spy = vi.spyOn( JSON, 'stringify' ).mockImplementation( ( ...args ) => {
+        if ( isPrettyStringifyCall( args ) ) {
+          throw new RangeError( 'not the string length error' );
+        }
+        return origStringify( ...args );
+      } );
+
+      try {
+        expect( () => safeFormatJSON( content, 10_000 ) ).toThrow( RangeError );
+      } finally {
+        spy.mockRestore();
+      }
+    } );
+
+    it( 'rethrows non-RangeError from pretty stringify', () => {
+      const content = { a: 1 };
+      const origStringify = JSON.stringify.bind( JSON );
+
+      const spy = vi.spyOn( JSON, 'stringify' ).mockImplementation( ( ...args ) => {
+        if ( isPrettyStringifyCall( args ) ) {
+          throw new TypeError( 'cyclic structure' );
+        }
+        return origStringify( ...args );
+      } );
+
+      try {
+        expect( () => safeFormatJSON( content, 10_000 ) ).toThrow( TypeError );
+      } finally {
+        spy.mockRestore();
+      }
+    } );
+  } );
 } );

package/src/tracing/trace_consts.js

@@ -0,0 +1,9 @@
+/**
+ * Each possible action of a trace event
+ */
+export const EventAction = {
+  START: 'start',
+  END: 'end',
+  ERROR: 'error',
+  ADD_ATTR: 'add_attr'
+};

package/src/tracing/trace_engine.js

@@ -64,34 +64,34 @@ export const init = async () => {
 const serializeDetails = details => details instanceof Error ? serializeError( details ) : details;
 
 /**
- * Creates a new trace event phase and sends it to be written
+ * Emits an event action to the event bus.
  *
- * @param {string} phase - The phase
+ * @param {string} action - The action
  * @param {object} fields - All the trace fields
  * @returns {void}
  */
-export const addEventPhase = ( phase, { kind, name, id, parentId, details, executionContext } ) => {
+export const addEventAction = ( action, { kind, name, id, parentId, details, executionContext } ) => {
   // Ignores internal steps in the actual trace files, ignore trace if the flag is true
   if ( kind !== ComponentType.INTERNAL_STEP && !executionContext.disableTrace ) {
     traceBus.emit( 'entry', {
       executionContext,
-      entry: { kind, phase, name, id, parentId, timestamp: Date.now(), details: serializeDetails( details ) }
+      entry: { kind, action, name, id, parentId, timestamp: Date.now(), details: serializeDetails( details ) }
     } );
   }
 };
 
 /**
- * Adds an Event Phase, complementing the options with parentId and executionContext from the async storage.
+ * Attaches contextual information to an event action before calling the method to emit it to the bus.
  *
- * This function will have no effect if called from outside an Temporal Workflow/Activity environment,
- * so it is safe to be used on unit tests or any dependencies that might be used elsewhere
+ * This function has no effect if called outside a Temporal Workflow/Activity environment,
+ * so it is safe to use in unit tests or dependencies that might be used elsewhere.
  *
  * @param {object} options - The common trace configurations
  */
-export function addEventPhaseWithContext( phase, options ) {
+export function addEventActionWithContext( action, options ) {
   const storeContent = Storage.load();
-  if ( storeContent ) { // If there is no storageContext this was not called from an Temporal Environment
+  if ( storeContent ) { // If there is no storageContext this was not called from a Temporal environment
     const { parentId, executionContext } = storeContent;
-    addEventPhase( phase, { ...options, parentId, executionContext } );
+    addEventAction( action, { ...options, parentId, executionContext } );
   }
 };

package/src/tracing/trace_engine.spec.js

@@ -39,7 +39,7 @@ describe( 'tracing/trace_engine', () => {
   it( 'init() starts only enabled processors and attaches listeners', async () => {
     process.env.OUTPUT_TRACE_LOCAL_ON = '1';
     process.env.OUTPUT_TRACE_REMOTE_ON = '0';
-    const { init, addEventPhase } = await loadTraceEngine();
+    const { init, addEventAction } = await loadTraceEngine();
 
     await init();
 
@@ -47,96 +47,96 @@ describe( 'tracing/trace_engine', () => {
     expect( s3InitMock ).not.toHaveBeenCalled();
 
     const executionContext = { disableTrace: false };
-    addEventPhase( 'start', {
+    addEventAction( 'start', {
       kind: 'step', name: 'N', id: '1', parentId: 'p', details: { ok: true }, executionContext
     } );
     expect( localExecMock ).toHaveBeenCalledTimes( 1 );
     const payload = localExecMock.mock.calls[0][0];
     expect( payload.entry.name ).toBe( 'N' );
     expect( payload.entry.kind ).toBe( 'step' );
-    expect( payload.entry.phase ).toBe( 'start' );
+    expect( payload.entry.action ).toBe( 'start' );
     expect( payload.entry.details ).toEqual( { ok: true } );
     expect( payload.executionContext ).toBe( executionContext );
   } );
 
-  it( 'addEventPhase() emits an entry consumed by processors', async () => {
+  it( 'addEventAction() emits an entry consumed by processors', async () => {
     process.env.OUTPUT_TRACE_LOCAL_ON = 'on';
-    const { init, addEventPhase } = await loadTraceEngine();
+    const { init, addEventAction } = await loadTraceEngine();
     await init();
 
-    addEventPhase( 'end', {
+    addEventAction( 'end', {
       kind: 'workflow', name: 'W', id: '2', parentId: 'p2', details: 'done',
       executionContext: { disableTrace: false }
     } );
     expect( localExecMock ).toHaveBeenCalledTimes( 1 );
     const payload = localExecMock.mock.calls[0][0];
     expect( payload.entry.name ).toBe( 'W' );
-    expect( payload.entry.phase ).toBe( 'end' );
+    expect( payload.entry.action ).toBe( 'end' );
     expect( payload.entry.details ).toBe( 'done' );
   } );
 
-  it( 'addEventPhase() does not emit when executionContext.disableTrace is true', async () => {
+  it( 'addEventAction() does not emit when executionContext.disableTrace is true', async () => {
     process.env.OUTPUT_TRACE_LOCAL_ON = '1';
-    const { init, addEventPhase } = await loadTraceEngine();
+    const { init, addEventAction } = await loadTraceEngine();
     await init();
 
-    addEventPhase( 'start', {
+    addEventAction( 'start', {
       kind: 'step', name: 'X', id: '1', parentId: 'p', details: {},
       executionContext: { disableTrace: true }
     } );
     expect( localExecMock ).not.toHaveBeenCalled();
   } );
 
-  it( 'addEventPhase() does not emit when kind is INTERNAL_STEP', async () => {
+  it( 'addEventAction() does not emit when kind is INTERNAL_STEP', async () => {
     process.env.OUTPUT_TRACE_LOCAL_ON = '1';
-    const { init, addEventPhase } = await loadTraceEngine();
+    const { init, addEventAction } = await loadTraceEngine();
     await init();
 
-    addEventPhase( 'start', {
+    addEventAction( 'start', {
       kind: 'internal_step', name: 'Internal', id: '1', parentId: 'p', details: {},
       executionContext: { disableTrace: false }
     } );
     expect( localExecMock ).not.toHaveBeenCalled();
   } );
 
-  it( 'addEventPhaseWithContext() uses storage when available', async () => {
+  it( 'addEventActionWithContext() uses storage when available', async () => {
     process.env.OUTPUT_TRACE_LOCAL_ON = 'true';
     storageLoadMock.mockReturnValue( {
       parentId: 'ctx-p',
       executionContext: { runId: 'r1', disableTrace: false }
     } );
-    const { init, addEventPhaseWithContext } = await loadTraceEngine();
+    const { init, addEventActionWithContext } = await loadTraceEngine();
     await init();
 
-    addEventPhaseWithContext( 'tick', { kind: 'step', name: 'S', id: '3', details: 1 } );
+    addEventActionWithContext( 'tick', { kind: 'step', name: 'S', id: '3', details: 1 } );
     expect( localExecMock ).toHaveBeenCalledTimes( 1 );
     const payload = localExecMock.mock.calls[0][0];
     expect( payload.executionContext ).toEqual( { runId: 'r1', disableTrace: false } );
     expect( payload.entry.parentId ).toBe( 'ctx-p' );
     expect( payload.entry.name ).toBe( 'S' );
-    expect( payload.entry.phase ).toBe( 'tick' );
+    expect( payload.entry.action ).toBe( 'tick' );
   } );
 
-  it( 'addEventPhaseWithContext() does not emit when storage executionContext.disableTrace is true', async () => {
+  it( 'addEventActionWithContext() does not emit when storage executionContext.disableTrace is true', async () => {
     process.env.OUTPUT_TRACE_LOCAL_ON = '1';
     storageLoadMock.mockReturnValue( {
       parentId: 'ctx-p',
       executionContext: { runId: 'r1', disableTrace: true }
     } );
-    const { init, addEventPhaseWithContext } = await loadTraceEngine();
+    const { init, addEventActionWithContext } = await loadTraceEngine();
     await init();
 
-    addEventPhaseWithContext( 'tick', { kind: 'step', name: 'S', id: '3', details: 1 } );
+    addEventActionWithContext( 'tick', { kind: 'step', name: 'S', id: '3', details: 1 } );
     expect( localExecMock ).not.toHaveBeenCalled();
   } );
 
-  it( 'addEventPhaseWithContext() is a no-op when storage is absent', async () => {
+  it( 'addEventActionWithContext() is a no-op when storage is absent', async () => {
     process.env.OUTPUT_TRACE_LOCAL_ON = '1';
     storageLoadMock.mockReturnValue( undefined );
-    const { init, addEventPhaseWithContext } = await loadTraceEngine();
+    const { init, addEventActionWithContext } = await loadTraceEngine();
     await init();
 
-    addEventPhaseWithContext( 'noop', { kind: 'step', name: 'X', id: '4', details: null } );
+    addEventActionWithContext( 'noop', { kind: 'step', name: 'X', id: '4', details: null } );
     expect( localExecMock ).not.toHaveBeenCalled();
   } );
 

package/src/worker/configs.js

@@ -26,7 +26,14 @@ const envVarSchema = z.object( {
   // Whether to send activity heartbeats (enabled by default)
   OUTPUT_ACTIVITY_HEARTBEAT_ENABLED: z.transform( v => v === undefined ? true : isStringboolTrue( v ) ),
   // Time to allow for hooks to flush before shutdown
-  OUTPUT_PROCESS_FAILURE_SHUTDOWN_DELAY: z.preprocess( coalesceEmptyString, z.coerce.number().int().positive().default( 3000 ) )
+  OUTPUT_PROCESS_FAILURE_SHUTDOWN_DELAY: z.preprocess( coalesceEmptyString, z.coerce.number().int().positive().default( 3000 ) ),
+  // HTTP CONNECT proxy for Temporal gRPC connections (e.g. "proxy-host:8080").
+  // Must be a bare host:port — no scheme (Temporal's native HTTP CONNECT
+  // option is not a URL).
+  TEMPORAL_GRPC_PROXY: z.string().optional().refine(
+    v => !v || !v.includes( '://' ),
+    'TEMPORAL_GRPC_PROXY must be host:port without a scheme (e.g. "proxy:8080", not "http://proxy:8080")'
+  )
 } );
 
 const { data: envVars, error } = envVarSchema.safeParse( process.env );
@@ -47,3 +54,4 @@ export const catalogId = envVars.OUTPUT_CATALOG_ID;
 export const activityHeartbeatIntervalMs = envVars.OUTPUT_ACTIVITY_HEARTBEAT_INTERVAL_MS;
 export const activityHeartbeatEnabled = envVars.OUTPUT_ACTIVITY_HEARTBEAT_ENABLED;
 export const processFailureShutdownDelay = envVars.OUTPUT_PROCESS_FAILURE_SHUTDOWN_DELAY;
+export const grpcProxy = envVars.TEMPORAL_GRPC_PROXY;

package/src/worker/index.js

@@ -9,6 +9,7 @@ import { initInterceptors } from './interceptors.js';
 import { createChildLogger } from '#logger';
 import { registerShutdown } from './shutdown.js';
 import { startCatalog } from './start_catalog.js';
+import { bootstrapFetchProxy } from './proxy.js';
 import { messageBus } from '#bus';
 import './log_hooks.js';
 import { BusEventType } from '#consts';
@@ -24,6 +25,7 @@ const callerDir = process.argv[2];
     apiKey,
     namespace,
     taskQueue,
+    grpcProxy,
     maxConcurrentWorkflowTaskExecutions,
     maxConcurrentActivityTaskExecutions,
     maxCachedWorkflows,
@@ -41,6 +43,7 @@ const callerDir = process.argv[2];
   const activities = await loadActivities( callerDir, workflows );
 
   messageBus.emit( BusEventType.WORKER_BEFORE_START );
+  bootstrapFetchProxy();
 
   log.info( 'Creating worker entry point...' );
   const workflowsPath = createWorkflowsEntryPoint( workflows );
@@ -52,8 +55,11 @@ const callerDir = process.argv[2];
   const catalog = createCatalog( { workflows, activities } );
 
   log.info( 'Connecting Temporal...' );
-  // Enable TLS when connecting to remote Temporal (API key present)
-  const connection = await NativeConnection.connect( { address, tls: Boolean( apiKey ), apiKey } );
+  const proxy = grpcProxy ? { type: 'http-connect', targetHost: grpcProxy } : undefined;
+  if ( proxy ) {
+    log.info( 'Using gRPC proxy', { targetHost: grpcProxy } );
+  }
+  const connection = await NativeConnection.connect( { address, tls: Boolean( apiKey ), apiKey, proxy } );
 
   log.info( 'Creating worker...' );
   const worker = await Worker.create( {

package/src/worker/index.spec.js

@@ -16,6 +16,7 @@ const configValues = {
   namespace: 'default',
   taskQueue: 'test-queue',
   catalogId: 'test-catalog',
+  grpcProxy: undefined,
   maxConcurrentWorkflowTaskExecutions: 200,
   maxConcurrentActivityTaskExecutions: 40,
   maxCachedWorkflows: 1000,
@@ -52,6 +53,9 @@ vi.mock( './interceptors.js', () => ( { initInterceptors: initInterceptorsMock }
 const startCatalogMock = vi.fn().mockResolvedValue( undefined );
 vi.mock( './start_catalog.js', () => ( { startCatalog: startCatalogMock } ) );
 
+const bootstrapFetchProxyMock = vi.fn();
+vi.mock( './proxy.js', () => ( { bootstrapFetchProxy: bootstrapFetchProxyMock } ) );
+
 const registerShutdownMock = vi.fn();
 vi.mock( './shutdown.js', () => ( { registerShutdown: registerShutdownMock } ) );
 
@@ -101,10 +105,12 @@ describe( 'worker/index', () => {
     expect( createWorkflowsEntryPointMock ).toHaveBeenCalledWith( [] );
     expect( initTracing ).toHaveBeenCalled();
     expect( createCatalogMock ).toHaveBeenCalledWith( { workflows: [], activities: {} } );
+    expect( bootstrapFetchProxyMock ).toHaveBeenCalled();
     expect( NativeConnection.connect ).toHaveBeenCalledWith( {
       address: configValues.address,
       tls: false,
-      apiKey: undefined
+      apiKey: undefined,
+      proxy: undefined
     } );
     expect( Worker.create ).toHaveBeenCalledWith( expect.objectContaining( {
       namespace: configValues.namespace,

package/src/worker/proxy.js

@@ -0,0 +1,32 @@
+import { EnvHttpProxyAgent, setGlobalDispatcher } from 'undici';
+import { createChildLogger } from '#logger';
+
+const log = createChildLogger( 'Proxy' );
+
+/**
+ * Routes all `fetch()` calls (including those inside Temporal activities)
+ * through an HTTP/HTTPS proxy when standard proxy env vars are set
+ * (`HTTPS_PROXY`, `https_proxy`, `HTTP_PROXY`, `http_proxy`). No-op when
+ * none are set. Invalid URLs are logged and skipped so the worker keeps
+ * running.
+ *
+ * Call once at worker startup, before any network activity.
+ */
+export const bootstrapFetchProxy = () => {
+  const proxyUrl = process.env.HTTPS_PROXY || process.env.https_proxy ||
+    process.env.HTTP_PROXY || process.env.http_proxy;
+
+  if ( !proxyUrl ) {
+    return;
+  }
+
+  try {
+    new URL( proxyUrl );
+  } catch {
+    log.warn( 'Ignoring invalid proxy URL', { proxyUrl } );
+    return;
+  }
+
+  log.info( 'Routing fetch() through HTTP proxy', { proxyUrl } );
+  setGlobalDispatcher( new EnvHttpProxyAgent() );
+};

package/src/worker/proxy.spec.js

@@ -0,0 +1,71 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+
+const mockSetGlobalDispatcher = vi.fn();
+const MockEnvHttpProxyAgent = vi.fn();
+
+vi.mock( 'undici', () => ( {
+  EnvHttpProxyAgent: MockEnvHttpProxyAgent,
+  setGlobalDispatcher: mockSetGlobalDispatcher
+} ) );
+
+vi.mock( '#logger', () => ( {
+  createChildLogger: () => ( { info: vi.fn(), warn: vi.fn(), error: vi.fn() } )
+} ) );
+
+describe( 'worker/proxy', () => {
+  const originalEnv = { ...process.env };
+
+  beforeEach( () => {
+    vi.clearAllMocks();
+    delete process.env.HTTPS_PROXY;
+    delete process.env.https_proxy;
+    delete process.env.HTTP_PROXY;
+    delete process.env.http_proxy;
+  } );
+
+  afterEach( () => {
+    process.env = { ...originalEnv };
+  } );
+
+  it( 'does nothing when no proxy env vars are set', async () => {
+    const { bootstrapFetchProxy } = await import( './proxy.js' );
+    bootstrapFetchProxy();
+
+    expect( mockSetGlobalDispatcher ).not.toHaveBeenCalled();
+  } );
+
+  it( 'sets global dispatcher when HTTPS_PROXY is set', async () => {
+    process.env.HTTPS_PROXY = 'http://proxy:8080';
+    const { bootstrapFetchProxy } = await import( './proxy.js' );
+    bootstrapFetchProxy();
+
+    expect( MockEnvHttpProxyAgent ).toHaveBeenCalled();
+    expect( mockSetGlobalDispatcher ).toHaveBeenCalledTimes( 1 );
+  } );
+
+  it( 'sets global dispatcher when HTTP_PROXY is set', async () => {
+    process.env.HTTP_PROXY = 'http://proxy:8080';
+    const { bootstrapFetchProxy } = await import( './proxy.js' );
+    bootstrapFetchProxy();
+
+    expect( MockEnvHttpProxyAgent ).toHaveBeenCalled();
+    expect( mockSetGlobalDispatcher ).toHaveBeenCalledTimes( 1 );
+  } );
+
+  it( 'prefers HTTPS_PROXY over HTTP_PROXY for detection', async () => {
+    process.env.HTTPS_PROXY = 'http://secure-proxy:8080';
+    process.env.HTTP_PROXY = 'http://plain-proxy:8080';
+    const { bootstrapFetchProxy } = await import( './proxy.js' );
+    bootstrapFetchProxy();
+
+    expect( mockSetGlobalDispatcher ).toHaveBeenCalledTimes( 1 );
+  } );
+
+  it( 'does not set global dispatcher when proxy URL is malformed', async () => {
+    process.env.HTTPS_PROXY = 'not a url';
+    const { bootstrapFetchProxy } = await import( './proxy.js' );
+    bootstrapFetchProxy();
+
+    expect( mockSetGlobalDispatcher ).not.toHaveBeenCalled();
+  } );
+} );