fix: Destroy isolates and scripts in tests and when Worker completes

bergundy · bergundy · commit df31adeeb763 · 2021-08-08T15:04:33.000+03:00
diff --git a/packages/test/src/mock-native-worker.ts b/packages/test/src/mock-native-worker.ts
@@ -203,6 +203,9 @@ export function isolateFreeWorker(
       getContext() {
         throw new Error('Not implemented');
       },
+      destroy() {
+        /* Nothing to destroy */
+      },
     },
     resolvedActivities,
     compileWorkerOptions(addDefaults(options))
diff --git a/packages/test/src/test-workflows.ts b/packages/test/src/test-workflows.ts
@@ -31,7 +31,11 @@ test.before(async (t) => {
     ['@activities/failure-tester', failureTesterActivityFunctions],
   ]);
   const builder = new WorkflowIsolateBuilder(logger, nodeModulesPath, workflowsPath, activities);
-  t.context.contextProvider = await RoundRobinIsolateContextProvider.create(builder, 2, 1024);
+  t.context.contextProvider = await RoundRobinIsolateContextProvider.create(builder, 1, 1024);
+});
+
+test.after.always((t) => {
+  t.context.contextProvider.destroy();
 });
 
 test.beforeEach(async (t) => {
diff --git a/packages/worker/src/isolate-context-provider.ts b/packages/worker/src/isolate-context-provider.ts
@@ -9,6 +9,11 @@ export interface IsolateContextProvider {
    * Get an isolate context for running a Workflow
    */
   getContext(): Promise<ivm.Context>;
+
+  /**
+   * Destroy and cleanup any resources
+   */
+  destroy(): void;
 }
 
 /**
@@ -52,4 +57,13 @@ export class RoundRobinIsolateContextProvider implements IsolateContextProvider
     }
     return new this(poolSize, isolates, scripts);
   }
+
+  public destroy(): void {
+    for (const script of this.scripts) {
+      script.release();
+    }
+    for (const isolate of this.isolates) {
+      isolate.dispose();
+    }
+  }
 }
diff --git a/packages/worker/src/worker.ts b/packages/worker/src/worker.ts
@@ -1168,6 +1168,7 @@ export class Worker<T extends WorkerSpec = DefaultWorkerSpec> {
         .toPromise();
     } finally {
       await this.nativeWorker.completeShutdown();
+      this.isolateContextProvider.destroy();
     }
   }
 

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,11 @@ export interface IsolateContextProvider {`
`9`	`9`	`* Get an isolate context for running a Workflow`
`10`	`10`	`*/`
`11`	`11`	`getContext(): Promise<ivm.Context>;`
	`12`	`+`
	`13`	`+ /**`
	`14`	`+ * Destroy and cleanup any resources`
	`15`	`+ */`
	`16`	`+ destroy(): void;`
`12`	`17`	`}`
`13`	`18`
`14`	`19`	`/**`
`@@ -52,4 +57,13 @@ export class RoundRobinIsolateContextProvider implements IsolateContextProvider`
`52`	`57`	`}`
`53`	`58`	`return new this(poolSize, isolates, scripts);`
`54`	`59`	`}`
	`60`	`+`
	`61`	`+ public destroy(): void {`
	`62`	`+ for (const script of this.scripts) {`
	`63`	`+ script.release();`
	`64`	`+ }`
	`65`	`+ for (const isolate of this.isolates) {`
	`66`	`+ isolate.dispose();`
	`67`	`+ }`
	`68`	`+ }`
`55`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1168,6 +1168,7 @@ export class Worker<T extends WorkerSpec = DefaultWorkerSpec> {`
`1168`	`1168`	`.toPromise();`
`1169`	`1169`	`} finally {`
`1170`	`1170`	`await this.nativeWorker.completeShutdown();`
	`1171`	`+ this.isolateContextProvider.destroy();`
`1171`	`1172`	`}`
`1172`	`1173`	`}`
`1173`	`1174`