chore: Refactor module scoped state variable to use globals (#944)

Author: bergundy

packages/worker/src/workflow/bundler.ts

@@ -148,18 +148,18 @@ import * as api from '@temporalio/workflow/lib/worker-interface.js';
 
 // Bundle all Workflows and interceptor modules for lazy evaluation
 api.overrideGlobals();
-api.setImportFuncs({
-  importWorkflows: () => {
-    return import(/* webpackMode: "eager" */ ${JSON.stringify(this.workflowsPath)});
-  },
-  importInterceptors: () => {
-    return Promise.all([
-      ${interceptorImports}
-    ]);
-  }
-});
 
 export { api };
+
+export function importWorkflows() {
+  return import(/* webpackMode: "eager" */ ${JSON.stringify(this.workflowsPath)});
+}
+
+export function importInterceptors() {
+  return Promise.all([
+    ${interceptorImports}
+  ]);
+}
 `;
     try {
       vol.mkdirSync(path.dirname(target), { recursive: true });

packages/worker/src/workflow/interface.ts

@@ -1,6 +1,6 @@
 import { coresdk } from '@temporalio/proto';
 import { SinkCall } from '@temporalio/workflow';
-import { WorkflowCreateOptions } from '@temporalio/workflow/lib/worker-interface';
+import { WorkflowCreateOptions } from '@temporalio/workflow/lib/interfaces';
 
 export { WorkflowCreateOptions };
 

packages/worker/src/workflow/vm.ts

@@ -46,7 +46,7 @@ function getPromiseStackStore(promise: Promise<any>): internals.PromiseStackStor
   // Access the global scope associated with the promise (unique per workflow - vm.context)
   // See for reference https://github.com/patriksimek/vm2/issues/32
   const ctor = promise.constructor.constructor;
-  return ctor('return globalThis.__TEMPORAL__?.promiseStackStore')();
+  return ctor('return globalThis.__TEMPORAL__?.activator?.promiseStackStore')();
 }
 
 /**
@@ -72,7 +72,7 @@ export function setUnhandledRejectionHandler(): void {
     // Get the runId associated with the vm context.
     // See for reference https://github.com/patriksimek/vm2/issues/32
     const ctor = promise.constructor.constructor;
-    const runId = ctor('return globalThis.__TEMPORAL__?.runId')();
+    const runId = ctor('return globalThis.__TEMPORAL__?.activator?.info?.runId')();
     if (runId !== undefined) {
       const workflow = VMWorkflowCreator.workflowByRunId.get(runId);
       if (workflow !== undefined) {
@@ -127,11 +127,12 @@ export class VMWorkflowCreator implements WorkflowCreator {
       {
         get(_: any, fn: string) {
           return (...args: any[]) => {
-            context.args = args;
-            const ret = vm.runInContext(`__TEMPORAL__.api.${fn}(...globalThis.args)`, context, {
+            context.__TEMPORAL__.args = args;
+            const ret = vm.runInContext(`__TEMPORAL__.api.${fn}(...__TEMPORAL__.args)`, context, {
               timeout: isolateExecutionTimeoutMs,
               displayErrors: true,
             });
+
             // When running with microtaskMode `afterEvaluate`, promises from context cannot be directly awaited outside of it.
             if (
               hasSeparateMicrotaskQueue &&
@@ -348,7 +349,7 @@ export class VMWorkflow implements Workflow {
 
   constructor(
     public readonly info: WorkflowInfo,
-    protected context: vm.Context | undefined,
+    protected context: any | undefined,
     readonly workflowModule: WorkflowModule,
     public readonly isolateExecutionTimeoutMs: number,
     public readonly hasSeparateMicrotaskQueue: boolean,
@@ -407,7 +408,7 @@ export class VMWorkflow implements Workflow {
     if (this.unhandledRejection) {
       return coresdk.workflow_completion.WorkflowActivationCompletion.encodeDelimited({
         runId: activation.runId,
-        failed: { failure: this.workflowModule.errorToFailure(this.unhandledRejection) },
+        failed: { failure: this.context.__TEMPORAL__.activator.errorToFailure(this.unhandledRejection) },
       }).finish();
     }
     return coresdk.workflow_completion.WorkflowActivationCompletion.encodeDelimited(completion).finish();

packages/workflow/src/cancellation-scope.ts

@@ -162,7 +162,8 @@ export class CancellationScope {
    * Get the current "active" scope
    */
   static current(): CancellationScope {
-    return storage.getStore() ?? ROOT_SCOPE;
+    // Using globals directly instead of a helper function to avoid circular import
+    return storage.getStore() ?? (globalThis as any).__TEMPORAL__.activator.rootScope;
   }
 
   /** Alias to `new CancellationScope({ cancellable: true }).run(fn)` */
@@ -187,14 +188,15 @@ export class CancellationScope {
 export const storage = new AsyncLocalStorage<CancellationScope>();
 
 export class RootCancellationScope extends CancellationScope {
+  constructor() {
+    super({ cancellable: true, parent: NO_PARENT });
+  }
+
   cancel(): void {
     this.reject(new CancelledFailure('Workflow cancelled'));
   }
 }
 
-/** There can only be one of these */
-export const ROOT_SCOPE = new RootCancellationScope({ cancellable: true, parent: NO_PARENT });
-
 /** This function is here to avoid a circular dependency between this module and workflow.ts */
 let sleep = (_: number | string): Promise<void> => {
   throw new IllegalStateError('Workflow has not been properly initialized');

packages/workflow/src/index.ts

@@ -80,7 +80,7 @@ export {
 } from '@temporalio/common/lib/interfaces';
 export * from '@temporalio/common/lib/workflow-handle';
 export * from '@temporalio/common/lib/workflow-options';
-export { AsyncLocalStorage, CancellationScope, CancellationScopeOptions, ROOT_SCOPE } from './cancellation-scope';
+export { AsyncLocalStorage, CancellationScope, CancellationScopeOptions } from './cancellation-scope';
 export * from './errors';
 export * from './interceptors';
 export {

packages/workflow/src/interfaces.ts

@@ -1,3 +1,4 @@
+import type { RawSourceMap } from 'source-map';
 import { RetryPolicy, TemporalFailure, CommonWorkflowOptions, SearchAttributes } from '@temporalio/common';
 import { checkExtends } from '@temporalio/common/lib/type-helpers';
 import type { coresdk } from '@temporalio/proto';
@@ -363,3 +364,15 @@ export interface EnhancedStackTrace {
   sources: Record<string, FileSlice[]>;
   stacks: StackTrace[];
 }
+
+export interface WorkflowCreateOptions {
+  info: WorkflowInfo;
+  randomnessSeed: number[];
+  now: number;
+  patches: string[];
+  showStackTraceSources: boolean;
+}
+
+export interface WorkflowCreateOptionsWithSourceMap extends WorkflowCreateOptions {
+  sourceMap: RawSourceMap;
+}