feat(worker): expose AbortController to the worker sandbox (#1576)

Author: lukeramsden

packages/test/src/test-worker-exposes-abortcontroller.ts

@@ -0,0 +1,22 @@
+import test from 'ava';
+import { v4 as uuid4 } from 'uuid';
+import { Client } from '@temporalio/client';
+import { RUN_INTEGRATION_TESTS, Worker } from './helpers';
+import { defaultOptions } from './mock-native-worker';
+import { abortController } from './workflows';
+
+if (RUN_INTEGRATION_TESTS) {
+  test(`Worker runtime exposes AbortController as a global`, async (t) => {
+    const worker = await Worker.create({ ...defaultOptions, taskQueue: 'test-worker-exposes-abortcontroller' });
+    const client = new Client();
+    const result = await worker.runUntil(
+      client.workflow.execute(abortController, {
+        args: [],
+        taskQueue: 'test-worker-exposes-abortcontroller',
+        workflowId: uuid4(),
+        workflowExecutionTimeout: '5s',
+      })
+    );
+    t.is(result, 'abort successful');
+  });
+}

packages/test/src/workflows/abort-controller.ts

@@ -0,0 +1,16 @@
+export async function abortController(): Promise<string | null> {
+  let aborted: string | null = null;
+
+  const controller = new AbortController();
+  const { signal } = controller;
+
+  const abortEventListener = () => {
+    aborted = signal.reason;
+  };
+
+  signal.addEventListener('abort', abortEventListener);
+  controller.abort('abort successful');
+  signal.removeEventListener('abort', abortEventListener);
+
+  return aborted;
+}

packages/test/src/workflows/index.ts

@@ -1,3 +1,4 @@
+export * from './abort-controller';
 export * from './activity-failure';
 export * from './activity-failures';
 export * from './args-and-return';

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

@@ -78,6 +78,7 @@ export class ReusableVMWorkflowCreator implements WorkflowCreator {
       __webpack_module_cache__,
       TextEncoder,
       TextDecoder,
+      AbortController,
     };
     this._context = vm.createContext(globals, { microtaskMode: 'afterEvaluate' });
     this.injectConsole();

packages/worker/src/workflow/vm.ts

@@ -86,6 +86,7 @@ export class VMWorkflowCreator implements WorkflowCreator {
       __webpack_module_cache__: {},
       TextEncoder,
       TextDecoder,
+      AbortController,
     };
     const context = vm.createContext(globals, { microtaskMode: 'afterEvaluate' });
     this.script.runInContext(context);