chore: Use require instead of import to make worker-interface methods sync (#946)

Author: bergundy

packages/interceptors-opentelemetry/src/workflow/index.ts

@@ -130,6 +130,6 @@ export class OpenTelemetryInternalsInterceptor implements WorkflowInternalsInter
     if (contextManager !== undefined) {
       contextManager.disable();
     }
-    await next(input);
+    next(input);
   }
 }

packages/test/src/integration-tests.ts

@@ -1321,12 +1321,13 @@ export function runIntegrationTests(codec?: PayloadCodec): void {
       workflowId,
     });
     await handle.query(workflows.mutateWorkflowStateQuery);
+    await handle.terminate();
     // Worker did not crash
     t.pass();
   });
 
   /**
-   * NOTE: this test uses the `list` API which requires advanced visibility as of server 1.18.
+   * NOTE: this test uses the `IN` operator API which requires advanced visibility as of server 1.18.
    * Run with docker-compose
    */
   test('Download and replay multiple executions with client list method', async (t) => {

packages/worker/src/workflow/bundler.ts

@@ -125,11 +125,11 @@ export class WorkflowCodeBundler {
     if (stat.isFile()) {
       // workflowsPath is a file; make the entrypoint a sibling of that file
       const { root, dir, name } = path.parse(workflowsPath);
-      return path.format({ root, dir, base: `${name}-autogenerated-entrypoint.js` });
+      return path.format({ root, dir, base: `${name}-autogenerated-entrypoint.cjs` });
     } else {
       // workflowsPath is a directory; make the entrypoint a sibling of that directory
       const { root, dir, base } = path.parse(workflowsPath);
-      return path.format({ root, dir, base: `${base}-autogenerated-entrypoint.js` });
+      return path.format({ root, dir, base: `${base}-autogenerated-entrypoint.cjs` });
     }
   }
 
@@ -140,25 +140,24 @@ export class WorkflowCodeBundler {
    */
   protected genEntrypoint(vol: typeof memfs.vol, target: string): void {
     const interceptorImports = [...new Set(this.workflowInterceptorModules)]
-      .map((v) => `import(/* webpackMode: "eager" */ ${JSON.stringify(v)})`)
+      .map((v) => `require(/* webpackMode: "eager" */ ${JSON.stringify(v)})`)
       .join(', \n');
 
     const code = `
-import * as api from '@temporalio/workflow/lib/worker-interface.js';
+const api = require('@temporalio/workflow/lib/worker-interface.js');
 
-// Bundle all Workflows and interceptor modules for lazy evaluation
 api.overrideGlobals();
 
-export { api };
+exports.api = api;
 
-export function importWorkflows() {
-  return import(/* webpackMode: "eager" */ ${JSON.stringify(this.workflowsPath)});
+exports.importWorkflows = function importWorkflows() {
+  return require(/* webpackMode: "eager" */ ${JSON.stringify(this.workflowsPath)});
 }
 
-export function importInterceptors() {
-  return Promise.all([
+exports.importInterceptors = function importInterceptors() {
+  return [
     ${interceptorImports}
-  ]);
+  ];
 }
 `;
     try {

packages/worker/src/workflow/vm.ts

@@ -121,34 +121,23 @@ export class VMWorkflowCreator implements WorkflowCreator {
     const context = await this.getContext();
     const activationContext = { isReplaying: options.info.unsafe.isReplaying };
     this.injectConsole(context, options.info, activationContext);
-    const { hasSeparateMicrotaskQueue, isolateExecutionTimeoutMs } = this;
+    const { isolateExecutionTimeoutMs } = this;
     const workflowModule: WorkflowModule = new Proxy(
       {},
       {
         get(_: any, fn: string) {
           return (...args: any[]) => {
             context.__TEMPORAL__.args = args;
-            const ret = vm.runInContext(`__TEMPORAL__.api.${fn}(...__TEMPORAL__.args)`, context, {
+            return 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 &&
-              typeof ret === 'object' &&
-              ret != null &&
-              ret.constructor.name === 'Promise'
-            ) {
-              return new Promise((resolve, reject) => ret.then(resolve, reject));
-            }
-            return ret;
           };
         },
       }
     ) as any;
 
-    await workflowModule.initRuntime({ ...options, sourceMap: this.sourceMap });
+    workflowModule.initRuntime({ ...options, sourceMap: this.sourceMap });
 
     const newVM = new VMWorkflow(
       options.info,

packages/workflow/src/interceptors.ts

@@ -206,7 +206,7 @@ export interface WorkflowInternalsInterceptor {
    *
    * Implement this method to perform any resource cleanup.
    */
-  dispose?(input: DisposeInput, next: Next<this, 'dispose'>): Promise<void>;
+  dispose?(input: DisposeInput, next: Next<this, 'dispose'>): void;
 }
 
 /**

packages/workflow/src/worker-interface.ts

@@ -92,7 +92,7 @@ export function overrideGlobals(): void {
  *
  * Sets required internal state and instantiates the workflow and interceptors.
  */
-export async function initRuntime(options: WorkflowCreateOptionsWithSourceMap): Promise<void> {
+export function initRuntime(options: WorkflowCreateOptionsWithSourceMap): void {
   const { info } = options;
   info.unsafe.now = OriginalDate.now;
   const activator = new Activator(options);
@@ -101,18 +101,18 @@ export async function initRuntime(options: WorkflowCreateOptionsWithSourceMap):
   // as well as Date and Math.random.
   global.__TEMPORAL__.activator = activator;
 
-  // TODO(bergundy): check if we can use `require` with the ESM sample and make all of the runtime methods sync.
-
-  // @ts-expect-error this is a webpack alias to payloadConverterPath
-  const customPayloadConverter = (await import('__temporal_custom_payload_converter')).payloadConverter;
+  // webpack alias to payloadConverterPath
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const customPayloadConverter = require('__temporal_custom_payload_converter').payloadConverter;
   // The `payloadConverter` export is validated in the Worker
-  if (customPayloadConverter !== undefined) {
+  if (customPayloadConverter != null) {
     activator.payloadConverter = customPayloadConverter;
   }
-  // @ts-expect-error this is a webpack alias to failureConverterPath
-  const customFailureConverter = (await import('__temporal_custom_failure_converter')).failureConverter;
+  // webpack alias to failureConverterPath
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const customFailureConverter = require('__temporal_custom_failure_converter').failureConverter;
   // The `failureConverter` export is validated in the Worker
-  if (customFailureConverter !== undefined) {
+  if (customFailureConverter != null) {
     activator.failureConverter = customFailureConverter;
   }
 
@@ -121,7 +121,7 @@ export async function initRuntime(options: WorkflowCreateOptionsWithSourceMap):
     throw new IllegalStateError('Workflow bundle did not register import hooks');
   }
 
-  const interceptors = await importInterceptors();
+  const interceptors = importInterceptors();
   for (const mod of interceptors) {
     const factory: WorkflowInterceptorsFactory = mod.interceptors;
     if (factory !== undefined) {
@@ -135,7 +135,7 @@ export async function initRuntime(options: WorkflowCreateOptionsWithSourceMap):
     }
   }
 
-  const mod = await importWorkflows();
+  const mod = importWorkflows();
   const workflow = mod[info.workflowType];
   if (typeof workflow !== 'function') {
     throw new TypeError(`'${info.workflowType}' is not a function`);
@@ -248,9 +248,9 @@ export function showUnblockConditions(job: coresdk.workflow_activation.IWorkflow
   return !job.queryWorkflow && !job.notifyHasPatch;
 }
 
-export async function dispose(): Promise<void> {
+export function dispose(): void {
   const dispose = composeInterceptors(getActivator().interceptors.internals, 'dispose', async () => {
     storage.disable();
   });
-  await dispose({});
+  dispose({});
 }