Fix halt test

src/browser-pool/basic-pool.ts

@@ -111,10 +111,10 @@ export class BasicPool implements Pool {
         });
     }
 
-    cancel(): void {
+    cancel(err?: Error): void {
         this._cancelled = true;
 
-        _.forEach(this._activeSessions, browser => browser.quit());
+        _.forEach(this._activeSessions, browser => browser.quit(err));
 
         this._activeSessions = {};
     }

src/browser-pool/caching-pool.ts

@@ -115,9 +115,9 @@ export class CachingPool implements Pool {
         return cache.push(browser);
     }
 
-    cancel(): void {
+    cancel(err?: Error): void {
         this.log("cancel");
-        this.underlyingPool.cancel();
+        this.underlyingPool.cancel(err);
     }
 }
 

src/browser/commands/assert-view/errors/no-ref-image-error.ts

@@ -30,5 +30,6 @@ export class NoRefImageError extends BaseStateError {
         super(stateName, currImg, refImg);
 
         this.message = `can not find reference image at ${this.refImg.path} for "${stateName}" state`;
+        this.stack = undefined;
     }
 }

src/runner/test-runner/regular-test-runner.js

@@ -4,6 +4,7 @@ const crypto = require("crypto");
 const _ = require("lodash");
 const { RunnableEmitter } = require("../types");
 const logger = require("../../utils/logger");
+const { formatError } = require("../../utils/format-error");
 const { MasterEvents } = require("../../events");
 const AssertViewResults = require("../../browser/commands/assert-view/assert-view-results");
 const RuntimeConfig = require("../../config/runtime-config");
@@ -85,7 +86,7 @@ module.exports = class RegularTestRunner extends RunnableEmitter {
 
             this._emit(MasterEvents.TEST_PASS);
         } catch (error) {
-            this._test.err = this._browser?.exitError || error;
+            this._test.err = formatError(this._browser?.exitError || error);
 
             this._applyTestResults(this._test.err);
 

src/testplane.ts

@@ -454,6 +454,8 @@ export class Testplane extends BaseTestplane {
             message: this._profiler.sanitizeMessage(err?.message ?? "Testplane run was aborted"),
         });
 
+        signalHandler.emit(MasterEvents.EXIT, err);
+
         if (timeout > 0) {
             setTimeout(() => {
                 logger.error("Forcing shutdown...");

src/utils/format-error.ts

@@ -0,0 +1,15 @@
+export const formatError = (err: Error): Error => {
+    const TRIM_MARKERS = ["Tests were stopped by the user"];
+
+    if (!TRIM_MARKERS.some(marker => err.stack?.includes(marker))) {
+        return err;
+    }
+
+    const newErr = new Error(err.message);
+
+    if (err.stack) {
+        newErr.stack = err.stack.split("\n")[0];
+    }
+
+    return newErr;
+};

test/src/utils/format-error.ts

@@ -0,0 +1,54 @@
+import { formatError } from "../../../src/utils/format-error";
+
+describe("utils/format-error", () => {
+    describe("when stack does not contain trigger string", () => {
+        it("should return the same error instance", () => {
+            const err = new Error("some error");
+            err.stack = "Error: some error\n    at foo (foo.js:1:1)\n    at bar (bar.js:2:2)";
+
+            const result = formatError(err);
+
+            assert.strictEqual(result, err);
+        });
+    });
+
+    describe("when stack contains 'Tests were stopped by the user'", () => {
+        it("should return a new Error instance", () => {
+            const err = new Error("Tests were stopped by the user");
+            err.stack = "Error: Tests were stopped by the user\n    at foo (foo.js:1:1)";
+
+            const result = formatError(err);
+
+            assert.notStrictEqual(result, err);
+        });
+
+        it("should preserve original error message", () => {
+            const err = new Error("Tests were stopped by the user");
+            err.stack = "Error: Tests were stopped by the user\n    at foo (foo.js:1:1)";
+
+            const result = formatError(err);
+
+            assert.equal(result.message, err.message);
+        });
+
+        it("should trim stack to first line only", () => {
+            const err = new Error("Tests were stopped by the user");
+            err.stack = "Error: Tests were stopped by the user\n    at foo (foo.js:1:1)\n    at bar (bar.js:2:2)";
+
+            const result = formatError(err);
+
+            assert.equal(result.stack, "Error: Tests were stopped by the user");
+        });
+    });
+
+    describe("when stack is undefined", () => {
+        it("should return the same error instance", () => {
+            const err = new Error("some error");
+            err.stack = undefined;
+
+            const result = formatError(err);
+
+            assert.strictEqual(result, err);
+        });
+    });
+});