@output.ai/core 0.0.9 → 0.0.10

package/README.md

@@ -126,5 +126,16 @@ To develop workflows you need the code, which will be called the worker, the API
 After having the API and the engine running, to start the worker just run:
 
 ```js
-`outputai`
+`npm run outputai`
 ```
+
+## Env variables
+
+Necessary env variables to run the worker locally:
+
+- `TEMPORAL_ADDRESS`: The temporal backend address, prefer the remote;
+- `TEMPORAL_NAMESPACE`: The name of the namespace, if using remote, use: "output-staging.i0jzq";
+- `TEMPORAL_API_KEY`: The API key to access remote temporal. If using local temporal, leave it blank;
+- `CATALOG_ID`: The name of the local catalog, always set this. Use your email;
+- `API_AUTH_KEY`: The API key to access the Framework API. Local can be blank, remote use the proper API Key;
+- `TRACING_ENABLED`: A "stringbool" value indicating if traces should be generated or note;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/core",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "The core module of the output framework",
   "type": "module",
   "main": "src/index.js",
@@ -21,10 +21,10 @@
     "url": "git+https://github.com/growthxai/flow-sdk"
   },
   "dependencies": {
-    "@babel/generator": "7.26.5",
-    "@babel/parser": "7.26.7",
-    "@babel/traverse": "7.25.9",
-    "@babel/types": "7.26.7",
+    "@babel/generator": "7.28.3",
+    "@babel/parser": "7.28.4",
+    "@babel/traverse": "7.28.4",
+    "@babel/types": "7.28.4",
     "@temporalio/worker": "1.13.0",
     "@temporalio/workflow": "1.13.0",
     "ajv": "8.17.1",

package/src/configs.js

@@ -1,17 +1,39 @@
+import * as z from 'zod';
+
+class InvalidEnvVarsErrors extends Error {}
+
+const envVarSchema = z.object( {
+  TEMPORAL_ADDRESS: z.union( [
+    z.httpUrl(),
+    z.string().regex( /^[a-z0-9_-]+:\d{2,5}$/i ) // local docker container name like worker:7233
+  ] ),
+  TEMPORAL_NAMESPACE: z.string().optional().default( 'default' ),
+  TEMPORAL_API_KEY: z.string().optional(),
+  CATALOG_ID: z.string().regex( /^[a-z0-9_.@-]+$/i ),
+  API_AUTH_KEY: z.string().optional(),
+  TRACING_ENABLED: z.stringbool().optional()
+} );
+
+const { data: safeEnvVar, error } = envVarSchema.safeParse( process.env );
+if ( error ) {
+  throw new InvalidEnvVarsErrors( z.prettifyError( error ) );
+}
+
 export const worker = {
-  address: process.env.TEMPORAL_ADDRESS,
-  apiKey: process.env.TEMPORAL_API_KEY,
+  address: safeEnvVar.TEMPORAL_ADDRESS,
+  apiKey: safeEnvVar.TEMPORAL_API_KEY,
   executionTimeout: '1m',
   maxActivities: 100,
   maxWorkflows: 100,
-  namespace: process.env.TEMPORAL_NAMESPACE ?? 'default',
-  taskQueue: process.env.TEMPORAL_TASK_QUEUE
+  namespace: safeEnvVar.TEMPORAL_NAMESPACE ?? 'default',
+  taskQueue: safeEnvVar.CATALOG_ID,
+  catalogId: safeEnvVar.CATALOG_ID
 };
 
 export const api = {
-  authKey: process.env.API_AUTH_KEY
+  authKey: safeEnvVar.API_AUTH_KEY
 };
 
 export const tracing = {
-  enabled: [ '1', 'true' ].includes( process.env.TRACING_ENABLED )
+  enabled: safeEnvVar.TRACING_ENABLED
 };

package/src/worker/index.js

@@ -15,7 +15,7 @@ const __dirname = dirname( fileURLToPath( import.meta.url ) );
 // expose the coreTracker so other parts of the SDK can use it
 setupGlobalTracer();
 
-const { address, apiKey, maxActivities, maxWorkflows, namespace, taskQueue } = workerConfig;
+const { address, apiKey, maxActivities, maxWorkflows, namespace, taskQueue, catalogId } = workerConfig;
 
 // Get caller directory from command line arguments
 const callerDir = process.argv[2];
@@ -75,7 +75,7 @@ const callerDir = process.argv[2];
   console.log( '[Core]', 'Starting catalog workflow...' );
   await new Client( { connection, namespace } ).workflow.start( 'catalog', {
     taskQueue,
-    workflowId: taskQueue, // use the name of the task queue as the catalog name, ensuring uniqueness
+    workflowId: catalogId, // use the name of the task queue as the catalog name, ensuring uniqueness
     workflowIdConflictPolicy: WorkflowIdConflictPolicy.TERMINATE_EXISTING,
     args: [ catalog ]
   } );

package/src/worker/tracer/index.test.js

@@ -6,12 +6,33 @@ import { THIS_LIB_NAME } from '#consts';
 
 const createTempDir = () => mkdtempSync( join( tmpdir(), 'flow-sdk-trace-' ) );
 
+// Single mocks (configured per-test by mutating the backing objects)
+const mockConfig = { tracing: { enabled: false } };
+vi.mock( '#configs', () => mockConfig );
+
+const mockStorageData = {
+  activityId: 's1',
+  activityType: 'Step 1',
+  workflowId: 'wf1',
+  workflowType: 'prompt',
+  workflowPath: '/workflows/prompt.js',
+  parentWorkflowId: undefined,
+  rootWorkflowId: undefined,
+  rootWorkflowType: undefined
+};
+vi.mock( '../async_storage.js', () => ( {
+  Storage: { load: () => mockStorageData }
+} ) );
+
+vi.mock( './tracer_tree.js', () => ( { buildLogTree: vi.fn() } ) );
+
 describe( 'tracer/index', () => {
   beforeEach( () => {
     vi.resetModules();
     vi.clearAllMocks();
     vi.useFakeTimers();
     vi.setSystemTime( new Date( '2020-01-01T00:00:00.000Z' ) );
+
   } );
 
   afterEach( () => {
@@ -23,29 +44,14 @@ describe( 'tracer/index', () => {
     const tmp = createTempDir();
     process.argv[2] = tmp;
 
-    const prevTracing = process.env.TRACING_ENABLED;
-    process.env.TRACING_ENABLED = 'true';
-    vi.mock( '../async_storage.js', () => ( {
-      Storage: {
-        load: () => ( {
-          activityId: 's1',
-          activityType: 'Step 1',
-          workflowId: 'wf1',
-          workflowType: 'prompt',
-          workflowPath: '/workflows/prompt.js',
-          parentWorkflowId: undefined,
-          rootWorkflowId: undefined,
-          rootWorkflowType: undefined
-        } )
-      }
-    } ) );
-    vi.mock( './tracer_tree.js', () => ( { buildLogTree: vi.fn() } ) );
+    mockConfig.tracing.enabled = true;
+
+    const { buildLogTree } = await import( './tracer_tree.js' );
     const { trace } = await import( './index.js' );
 
     const input = { foo: 1 };
     trace( { lib: THIS_LIB_NAME, event: 'workflow_start', input, output: null } );
 
-    const { buildLogTree } = await import( './tracer_tree.js' );
     expect( buildLogTree ).toHaveBeenCalledTimes( 1 );
     const logPath = buildLogTree.mock.calls[0][0];
 
@@ -67,7 +73,6 @@ describe( 'tracer/index', () => {
     expect( typeof entry.timestamp ).toBe( 'number' );
 
     rmSync( tmp, { recursive: true, force: true } );
-    process.env.TRACING_ENABLED = prevTracing;
     process.argv[2] = originalArgv2;
   } );
 
@@ -76,40 +81,23 @@ describe( 'tracer/index', () => {
     const tmp = createTempDir();
     process.argv[2] = tmp;
 
-    const prevTracing = process.env.TRACING_ENABLED;
-    process.env.TRACING_ENABLED = 'false';
-    vi.mock( '../async_storage.js', () => ( {
-      Storage: {
-        load: () => ( {
-          activityId: 's1',
-          activityType: 'Step 1',
-          workflowId: 'wf1',
-          workflowType: 'prompt',
-          workflowPath: '/workflows/prompt.js'
-        } )
-      }
-    } ) );
-    vi.mock( './tracer_tree.js', () => ( { buildLogTree: vi.fn() } ) );
+    mockConfig.tracing.enabled = false;
+    const { buildLogTree } = await import( './tracer_tree.js' );
     const { trace } = await import( './index.js' );
 
     trace( { lib: THIS_LIB_NAME, event: 'workflow_start', input: {}, output: null } );
 
-    const { buildLogTree } = await import( './tracer_tree.js' );
     expect( buildLogTree ).not.toHaveBeenCalled();
 
     rmSync( tmp, { recursive: true, force: true } );
-    process.env.TRACING_ENABLED = prevTracing;
     process.argv[2] = originalArgv2;
   } );
 
   it( 'setupGlobalTracer installs global symbol', async () => {
-    const prevTracing = process.env.TRACING_ENABLED;
-    process.env.TRACING_ENABLED = 'false';
+    mockConfig.tracing.enabled = false;
     const { setupGlobalTracer } = await import( './index.js' );
     setupGlobalTracer();
     const sym = Symbol.for( '__trace' );
     expect( typeof globalThis[sym] ).toBe( 'function' );
-    process.env.TRACING_ENABLED = prevTracing;
   } );
 } );
-