Remove global event listeners and abort all pending tests on context …

…dispose.
postmanlabs · May 29, 2023 · a2b5dba · a2b5dba
1 parent 64dc679
commit a2b5dba
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 9 deletions.
diff --git a/lib/postman-sandbox.js b/lib/postman-sandbox.js
@@ -6,6 +6,8 @@ const _ = require('lodash'),
 
     TO_WAIT_BUFFER = 500, // time to wait for sandbox to declare timeout
     CONSOLE_EVENT_NAME = 'execution.console',
+    ASSERTION_EVENT_NAME = 'execution.assertion',
+    ERROR_EVENT_NAME = 'execution.error',
     EXECUTION_TIMEOUT_ERROR_MESSAGE = 'sandbox not responding',
     BRIDGE_DISCONNECTING_ERROR_MESSAGE = 'sandbox: execution interrupted, bridge disconnecting.';
 
@@ -131,19 +133,25 @@ class PostmanSandbox extends UniversalVM {
     }
 
     dispose () {
-        _.forEach(this._executing, (irq, id) => {
-            irq && clearTimeout(irq);
+        this.once('dispose', () => {
+            _.forEach(this._executing, (irq, id) => {
+                irq && clearTimeout(irq);
 
-            // send an abort event to the sandbox so that it can do cleanups
-            this.dispatch('execution.abort.' + id);
+                // send an abort event to the sandbox so that it can do cleanups
+                this.dispatch('execution.abort.' + id);
 
-            // even though sandbox could bubble the result event upon receiving abort, that would reduce
-            // stability of the system in case sandbox was unresponsive.
-            this.emit('execution.result.' + id, new Error(BRIDGE_DISCONNECTING_ERROR_MESSAGE));
+                // even though sandbox could bubble the result event upon receiving abort, that would reduce
+                // stability of the system in case sandbox was unresponsive.
+                this.emit('execution.result.' + id, new Error(BRIDGE_DISCONNECTING_ERROR_MESSAGE));
+            });
+
+            this.removeAllListeners(CONSOLE_EVENT_NAME);
+            this.removeAllListeners(ASSERTION_EVENT_NAME);
+            this.removeAllListeners(ERROR_EVENT_NAME);
+            this.disconnect();
         });
 
-        this.removeAllListeners(CONSOLE_EVENT_NAME);
-        this.disconnect();
+        this.dispatch('dispose');
     }
 }
 

diff --git a/lib/sandbox/execute.js b/lib/sandbox/execute.js
@@ -86,6 +86,14 @@ module.exports = function (bridge, glob) {
         });
     });
 
+    bridge.once('dispose', () => {
+        // Abort all pending assertions and cleanup the global tests state
+        Object.values(testsState).forEach((test) => { test.abort(); });
+        testsState = {};
+
+        bridge.dispatch('dispose');
+    });
+
     /**
      * @param {String} id
      * @param {Event} event

diff --git a/lib/sandbox/pmapi-setup-runner.js b/lib/sandbox/pmapi-setup-runner.js
@@ -195,6 +195,12 @@ module.exports = function (pm, testsState, onAssertion) {
             testId = testState.testId,
             assertionData = getAssertionObject(testId, name, false);
 
+        // TODO: Do this along with test state initialization.
+        testState.abort = () => {
+            markAssertionAsFailure(assertionData, new Error('Execution aborted before test could complete'));
+            processAssertion(_testId, assertionData, options);
+        };
+
         // if there is no assertion function, we simply move on
         if (typeof assert !== FUNCTION) {
             // Sending `options` as empty to force resolve the test