@output.ai/core 0.1.2 → 0.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/core",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "The core module of the output framework",
   "type": "module",
   "exports": {
@@ -11,6 +11,10 @@
     "./tracing": {
       "types": "./src/tracing/index.d.ts",
       "import": "./src/tracing/index.js"
+    },
+    "./utils": {
+      "types": "./src/utils/index.d.ts",
+      "import": "./src/utils/index.js"
     }
   },
   "files": [
@@ -33,13 +37,14 @@
     "@temporalio/worker": "1.13.1",
     "@temporalio/workflow": "1.13.1",
     "redis": "5.8.3",
+    "stacktrace-parser": "0.1.11",
     "zod": "4.1.12"
   },
   "license": "UNLICENSED",
   "imports": {
     "#consts": "./src/consts.js",
     "#errors": "./src/errors.js",
-    "#utils": "./src/utils.js",
+    "#utils": "./src/utils/index.js",
     "#tracing": "./src/tracing/internal_interface.js",
     "#async_storage": "./src/async_storage.js",
     "#temporal_options": "./src/temporal_options.js",

package/src/interface/workflow.js

@@ -1,10 +1,9 @@
 // THIS RUNS IN THE TEMPORAL'S SANDBOX ENVIRONMENT
 import { proxyActivities, inWorkflowContext, executeChild, workflowInfo } from '@temporalio/workflow';
-import { getInvocationDir } from './utils.js';
 import { validateWorkflow } from './validations/static.js';
 import { validateWithSchema } from './validations/runtime.js';
 import { SHARED_STEP_PREFIX } from '#consts';
-import { mergeActivityOptions, setMetadata } from '#utils';
+import { mergeActivityOptions, resolveInvocationDir, setMetadata } from '#utils';
 import { FatalError, ValidationError } from '#errors';
 
 const defaultActivityOptions = {
@@ -20,7 +19,7 @@ const defaultActivityOptions = {
 
 export function workflow( { name, description, inputSchema, outputSchema, fn, options } ) {
   validateWorkflow( { name, description, inputSchema, outputSchema, fn, options } );
-  const workflowPath = getInvocationDir();
+  const workflowPath = resolveInvocationDir();
 
   const activityOptions = mergeActivityOptions( defaultActivityOptions, options );
   const steps = proxyActivities( activityOptions );

package/src/utils/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Return the directory of the file invoking the code that called this function
+ * Excludes `@output.ai/core`, node, and other internal paths
+ */
+export function resolveInvocationDir(): string;
+
+/**
+ * Node safe clone implementation that doesn't use global structuredClone()
+ * @param {object} v
+ * @returns {object}
+ */
+export function clone( v: object ): object;
+
+/**
+ * Throw given error
+ * @param {Error} e
+ * @throws {e}
+ */
+export function throws( e: Error ): void;
+
+/**
+ * Add metadata "values" property to a given object
+ * @param {object} target
+ * @param {object} values
+ * @returns
+ */
+export function setMetadata( target: object, values: object ): void;
+
+/**
+ * Merge two temporal activity options
+ */
+export function mergeActivityOptions(
+  base?: import( '@temporalio/workflow' ).ActivityOptions,
+  ext?: import( '@temporalio/workflow' ).ActivityOptions
+): import( '@temporalio/workflow' ).ActivityOptions;

package/src/utils/index.js

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

package/src/utils/resolve_invocation_dir.js

@@ -0,0 +1,27 @@
+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 ignorePaths = [
+  `${SEP}node_modules${SEP}`,
+  `${SEP}app${SEP}sdk${SEP}`,
+  `node:internal${SEP}`,
+  'evalmachine.',
+  `webpack${SEP}bootstrap`
+];
+
+/**
+ * Return the directory of the file invoking the code that called this function
+ * Excludes some internal paths and the sdk itself
+ */
+export default () => {
+  const stack = new Error().stack;
+  const lines = stackTraceParser.parse( stack );
+
+  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 );
+};

package/src/utils/resolve_invocation_dir.spec.js

@@ -0,0 +1,102 @@
+import { afterEach, describe, expect, it } from 'vitest';
+import resolveInvocationDir from './resolve_invocation_dir';
+
+const OriginalError = Error;
+
+describe( 'Resolve Invocation Dir', () => {
+  afterEach( () => {
+    Error = OriginalError;
+  } );
+
+  it( 'Should detect the invocation dir from the tests workflow', () => {
+    const stack = `Error
+    at resolveInvocationDir (file:///app/sdk/core/src/utils/resolve_invocation_dir.js)
+    at fn (file:///app/test_workflows/dist/simple/steps.js:8:21)
+    at wrapper (file:///app/sdk/core/src/interface/step.js:12:26)
+    at executeNextHandler (/app/node_modules/@temporalio/worker/lib/activity.js:99:54)
+    at Storage.runWithContext.parentId (file:///app/sdk/core/src/worker/interceptors/activity.js:31:63)
+    at AsyncLocalStorage.run (node:internal/async_local_storage/async_context_frame:63:14)
+    at Object.runWithContext (file:///app/sdk/core/src/async_storage.js:12:44)
+    at ActivityExecutionInterceptor.execute (file:///app/sdk/core/src/worker/interceptors/activity.js:31:36)
+    at next (/app/node_modules/@temporalio/common/lib/interceptors.js:22:51)
+    at Activity.execute (/app/node_modules/@temporalio/worker/lib/activity.js:101:26)
+    at /app/node_modules/@temporalio/worker/lib/activity.js:149:29`;
+
+    Error = class extends OriginalError {
+      constructor( ...args ) {
+        super( ...args );
+        this.stack = stack;
+      }
+    };
+
+    expect( resolveInvocationDir() ).toBe( '/app/test_workflows/dist/simple' );
+  } );
+
+  it( 'Should detect the invocation dir from the sandbox environment at sdk/core', () => {
+    const stack = `Error
+    at resolveInvocationDir (file:///app/sdk/core/src/utils/resolve_invocation_dir.js)
+    at workflow (file:///app/sdk/core/src/interface/workflow.js:25:16)
+    at file:///app/test_workflows/dist/nested/workflow.js:4:16
+    at ModuleJob.run (node:internal/modules/esm/module_job:365:25)
+    at async onImport.tracePromise.__proto__ (node:internal/modules/esm/loader:665:26)
+    at async importComponents (file:///app/sdk/core/src/worker/loader_tools.js:54:22)
+    at async loadWorkflows (file:///app/sdk/core/src/worker/loader.js:64:38)
+    at async file:///app/sdk/core/src/worker/index.js:21:21`;
+
+    Error = class extends OriginalError {
+      constructor( ...args ) {
+        super( ...args );
+        this.stack = stack;
+      }
+    };
+
+    expect( resolveInvocationDir() ).toBe( '/app/test_workflows/dist/nested' );
+  } );
+
+  it( 'Should detect the invocation dir from workflow loading at core', () => {
+    const stack = `Error
+    at __WEBPACK_DEFAULT_EXPORT__ (/app/sdk/core/src/utils/resolve_invocation_dir.js:13:0)
+    at workflow (/app/sdk/core/src/interface/workflow.js:22:43)
+    at ../../test_workflows/dist/nested/workflow.js (/app/test_workflows/dist/nested/workflow.js:4:24)
+    at __webpack_require__ (webpack/bootstrap:19:0)
+    at ./src/worker/temp/__workflows_entrypoint.js (null:null:null)
+    at __webpack_require__ (webpack/bootstrap:19:0)
+    at importWorkflows (/app/sdk/core/src/worker/temp/__workflows_entrypoint-autogenerated-entrypoint.cjs:9:9)
+    at Object.initRuntime (/app/node_modules/@temporalio/workflow/src/worker-interface.ts:78:16)
+    at __TEMPORAL_CALL_INTO_SCOPE (evalmachine.<anonymous>:30:40)
+    at evalmachine.<anonymous>:1:1`;
+
+    Error = class extends OriginalError {
+      constructor( ...args ) {
+        super( ...args );
+        this.stack = stack;
+      }
+    };
+
+    expect( resolveInvocationDir() ).toBe( '/app/test_workflows/dist/nested' );
+  } );
+
+  it( 'Should detect the invocation dir from a workflow using core installed via NPM', () => {
+    const stack = `Error
+    at resolveInvocationDir (file:///app/node_modules/@output.ai/core/src/utils/resolve_invocation_dir.js)
+    at fn (file:///app/dist/simple/steps.js:8:21)
+    at wrapper (file:///app/node_modules/@output.ai/core/src/interface/step.js:12:26)
+    at executeNextHandler (/app/node_modules/@temporalio/worker/lib/activity.js:99:54)
+    at Storage.runWithContext.parentId (file:///app/node_modules/@output.ai/core/src/worker/interceptors/activity.js:31:63)
+    at AsyncLocalStorage.run (node:internal/async_local_storage/async_context_frame:63:14)
+    at Object.runWithContext (file:///app/node_modules/@output.ai/core/src/async_storage.js:12:44)
+    at ActivityExecutionInterceptor.execute (file:///app/node_modules/@output.ai/core/src/worker/interceptors/activity.js:31:36)
+    at next (/app/node_modules/@temporalio/common/lib/interceptors.js:22:51)
+    at Activity.execute (/app/node_modules/@temporalio/worker/lib/activity.js:101:26)
+    at /app/node_modules/@temporalio/worker/lib/activity.js:149:29`;
+
+    Error = class extends OriginalError {
+      constructor( ...args ) {
+        super( ...args );
+        this.stack = stack;
+      }
+    };
+
+    expect( resolveInvocationDir() ).toBe( '/app/dist/simple' );
+  } );
+} );

package/src/interface/utils.js

@@ -1,19 +0,0 @@
-/**
- * Function rigged to return the folder path of the source of calls for the interface methods (step/workflow)
- *
- * IMPORTANT!!!
- * If to refactor this, pay attention to the depth in the stack trace to extract the info.
- * Currently it is 3:
- * - 1st line is the name of the function;
- * - 2nd line is this function;
- * - 3rd line is step/workflow;
- * - 4th line is caller;
- *
- * @returns {string} The folder path of the caller
- */
-export const getInvocationDir = () => new Error()
-  .stack.split( '\n' )[3]
-  .split( ' ' )
-  .at( -1 )
-  .replace( /\((.+):\d+:\d+\)/, '$1' )
-  .split( '/' ).slice( 0, -1 ).join( '/' );

package/src/interface/utils.spec.js

@@ -1,35 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { getInvocationDir } from './utils.js';
-
-describe( 'interface/utils', () => {
-  describe( 'getInvocationDir', () => {
-    it( 'returns the caller directory from stack trace', () => {
-      const fakeCaller = '/tmp/project/src/caller/file.js';
-      const OriginalError = Error;
-      // Provide a deterministic stack shape for the function under test
-      // Lines: 1) Error, 2) getInvocationDir, 3) step/workflow, 4) actual caller
-      // Include typical V8 formatting with leading spaces and without function name
-      // for the caller line
-
-      Error = class extends OriginalError {
-        constructor( ...args ) {
-          super( ...args );
-          this.stack = [
-            'Error',
-            '    at getInvocationDir (a:1:1)',
-            '    at step (b:1:1)',
-            `    at ${fakeCaller}:10:20`
-          ].join( '\n' );
-        }
-      };
-      try {
-        const dir = getInvocationDir();
-        expect( dir ).toBe( '/tmp/project/src/caller' );
-      } finally {
-
-        Error = OriginalError;
-      }
-    } );
-  } );
-} );
-