fix: reusable-vm runs dispose interceptors (#1834)

Co-authored-by: Thomas Hardy <[email protected]>

Author: mnahkies

packages/test/src/test-interceptors.ts

@@ -15,7 +15,9 @@ import { defaultPayloadConverter, WorkflowInfo } from '@temporalio/workflow';
 import { cleanOptionalStackTrace, compareStackTrace, RUN_INTEGRATION_TESTS, Worker } from './helpers';
 import { defaultOptions } from './mock-native-worker';
 import {
+  checkDisposeRan,
   continueAsNewToDifferentWorkflow,
+  initAndResetFlag,
   interceptorExample,
   internalsInterceptorExample,
   unblockOrCancel,
@@ -285,4 +287,29 @@ if (RUN_INTEGRATION_TESTS) {
     );
     t.deepEqual(events, ['activate: 0', 'concludeActivation: 1', 'activate: 0', 'concludeActivation: 1']);
   });
+
+  test.serial('Internal interceptor disposes in reusable VM', async (t) => {
+    const taskQueue = 'test-reusable-vm-internal-interceptor-disposes';
+    const worker = await Worker.create({
+      ...defaultOptions,
+      taskQueue,
+      interceptors: {
+        workflowModules: [require.resolve('./workflows/internal-interceptor-dispose-global')],
+      },
+    });
+
+    const client = new WorkflowClient();
+    await worker.runUntil(async () => {
+      const disposeFlagSet = await client.execute(initAndResetFlag, {
+        taskQueue,
+        workflowId: uuid4(),
+      });
+      t.false(disposeFlagSet);
+      const disposeFlagSetNow = await client.execute(checkDisposeRan, {
+        taskQueue,
+        workflowId: uuid4(),
+      });
+      t.true(disposeFlagSetNow);
+    });
+  });
 }

packages/test/src/workflows/index.ts

@@ -46,6 +46,7 @@ export * from './log-before-timing-out';
 export * from './log-sink-tester';
 export * from './long-history-generator';
 export * from './multiple-activities-single-timeout';
+export { initAndResetFlag, checkDisposeRan } from './internal-interceptor-dispose-global';
 export * from './nested-cancellation';
 export * from './noncancellable-shields-children';
 export * from './partial-noncancelable';

packages/test/src/workflows/internal-interceptor-dispose-global.ts

@@ -0,0 +1,23 @@
+import { WorkflowInterceptors } from '@temporalio/workflow';
+
+const getOuterGlobal = globalThis.constructor.constructor;
+
+export async function initAndResetFlag(): Promise<boolean> {
+  getOuterGlobal(`globalThis.__dispose_ran__ = false`)();
+  return checkDisposeRan();
+}
+
+export async function checkDisposeRan(): Promise<boolean> {
+  return getOuterGlobal(`return globalThis.__dispose_ran__ === true`)();
+}
+
+export const interceptors = (): WorkflowInterceptors => ({
+  internals: [
+    {
+      dispose(input, next) {
+        getOuterGlobal(`globalThis.__dispose_ran__ = true`)();
+        return next(input);
+      },
+    },
+  ],
+});

packages/worker/src/workflow/reusable-vm.ts

@@ -222,6 +222,7 @@ type WorkflowModule = typeof internals;
  */
 export class ReusableVMWorkflow extends BaseVMWorkflow {
   public async dispose(): Promise<void> {
+    this.workflowModule.dispose();
     ReusableVMWorkflowCreator.workflowByRunId.delete(this.runId);
   }
 }