@brillout/test-e2e 0.4.6 → 0.4.8

package/dist/logError.d.ts

@@ -0,0 +1,2 @@
+export { logError };
+declare function logError(err: unknown, sectionTitle?: string): void;

package/dist/logError.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logError = void 0;
+const logSection_1 = require("./logSection");
+function logError(err, sectionTitle = 'ERROR') {
+    (0, logSection_1.logSection)(sectionTitle);
+    console.log(err);
+}
+exports.logError = logError;

package/dist/runTests.d.ts

@@ -1,3 +1,5 @@
 export { runTests };
+export { logFailure };
 import { type FindFilter } from './utils';
 declare function runTests(filter: null | FindFilter): Promise<void>;
+declare function logFailure(reason: string): void;

package/dist/runTests.js

@@ -3,19 +3,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runTests = void 0;
+exports.logFailure = exports.runTests = void 0;
 const getCurrentTest_1 = require("./getCurrentTest");
 const Logs_1 = require("./Logs");
 const utils_1 = require("./utils");
 const utils_2 = require("./utils");
 const picocolors_1 = __importDefault(require("picocolors"));
 const github_action_1 = require("./github-action");
-const logSection_1 = require("./logSection");
 const getCurrentTest_2 = require("./getCurrentTest");
 const getBrowser_1 = require("./getBrowser");
 const buildTs_1 = require("./buildTs");
 const findTestFiles_1 = require("./findTestFiles");
 const getConfig_1 = require("./getConfig");
+const logError_1 = require("./logError");
 async function runTests(filter) {
     await (0, getConfig_1.loadConfig)();
     const testFiles = await (0, findTestFiles_1.findTestFiles)(filter);
@@ -48,7 +48,7 @@ async function runTestFile(browser) {
     testInfo.page = page;
     // Set when user calls `skip()`
     if (testInfo.skipped) {
-        logResult(false);
+        logTestStatus(false);
         (0, utils_1.assertUsage)(!testInfo.runInfo, 'You cannot call `run()` after calling `skip()`');
         (0, utils_1.assertUsage)(testInfo.tests === undefined, 'You cannot call `test()` after calling `skip()`');
         return;
@@ -73,8 +73,8 @@ async function runTestFile(browser) {
         await testInfo.startServer();
     }
     catch (err) {
-        logFailureReason('an error occurred while starting the server');
-        logError(err);
+        logFailure('an error occurred while starting the server');
+        (0, logError_1.logError)(err);
         Logs_1.Logs.flushLogs();
         await abort();
         return;
@@ -100,11 +100,11 @@ async function runTestFile(browser) {
             const isFailure = err || hasErrorLog;
             if (isFailure) {
                 if (err) {
-                    logFailureReason(`the test "${testDesc}" threw an error`);
-                    logError(err);
+                    logFailure(`the test "${testDesc}" threw an error`);
+                    (0, logError_1.logError)(err);
                 }
                 else if (hasErrorLog) {
-                    logFailureReason(`${getErrorType(failOnWarning)} occurred while running the test "${testDesc}"`);
+                    logFailure(`${getErrorType(failOnWarning)} occurred while running the test "${testDesc}"`);
                 }
                 else {
                     (0, utils_1.assert)(false);
@@ -124,7 +124,7 @@ async function runTestFile(browser) {
         if (Logs_1.Logs.hasErrorLogs(failOnWarning) &&
             // See comments about taskkill in src/setup.ts
             !(0, utils_1.isWindows)()) {
-            logFailureReason(`${getErrorType(failOnWarning)} occurred during server termination`);
+            logFailure(`${getErrorType(failOnWarning)} occurred during server termination`);
             Logs_1.Logs.logErrors(failOnWarning);
             Logs_1.Logs.flushLogs();
             await abort();
@@ -132,7 +132,7 @@ async function runTestFile(browser) {
         }
     }
     Logs_1.Logs.clearLogs();
-    logResult(true);
+    logTestStatus(true);
 }
 function getErrorType(failOnWarning) {
     return !failOnWarning ? 'error(s)' : 'error(s)/warning(s)';
@@ -162,7 +162,7 @@ function runTest(testFn, testFunctionTimeout) {
     })();
     return promise;
 }
-function logResult(success) {
+function logTestStatus(success) {
     const testInfo = (0, getCurrentTest_1.getCurrentTest)();
     const { PASS, FAIL, WARN } = getStatusTags();
     if (success) {
@@ -177,17 +177,14 @@ function logResult(success) {
         console.log(`${FAIL} ${testInfo.testFile}`);
     }
 }
-function logFailureReason(reason) {
-    logResult(false);
+function logFailure(reason) {
+    logTestStatus(false);
     const { FAIL } = getStatusTags();
     const color = (s) => picocolors_1.default.red(picocolors_1.default.bold(s));
     const msg = `Test ${FAIL} because ${reason}, see below.`;
     console.log(color(msg));
 }
-function logError(err) {
-    (0, logSection_1.logSection)('ERROR');
-    console.log(err);
-}
+exports.logFailure = logFailure;
 function getStatusTags() {
     const PASS = picocolors_1.default.bold(picocolors_1.default.bgGreen(picocolors_1.default.white(' PASS ')));
     const FAIL = picocolors_1.default.bold(picocolors_1.default.bgRed(picocolors_1.default.white(' FAIL ')));

package/dist/setup.js

@@ -314,7 +314,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
     });
     proc.stdout.on('data', (chunk) => {
         const data = String(chunk);
-        assertNotExited(data);
+        // assertNotExited(data)
         (0, utils_2.assert)(getRunInfo().cmd === cmd);
         Logs_1.Logs.add({
             logSource: 'stdout',
@@ -324,7 +324,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
     });
     proc.stderr.on('data', async (chunk) => {
         const data = String(chunk);
-        assertNotExited(data);
+        // assertNotExited(data)
         (0, utils_2.assert)(getRunInfo().cmd === cmd);
         Logs_1.Logs.add({
             logSource: 'stderr',
@@ -359,14 +359,15 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
         exitPromiseResolve();
     });
     return { terminate, processHasExited };
-    function assertNotExited(data) {
-        if (!procExited)
-            return;
-        Logs_1.Logs.logErrors(true);
-        Logs_1.Logs.flushLogs();
-        logDebugInfo(data);
-        (0, utils_2.assert)(false);
+    /* Node.js seems to occasionally emit 'data' events after having the emitted 'exit' event, for example:
+     *  - `{"data":"[0] npm run serve:cdn  exited with code SIGTERM\n","dataLength":48}`.
+    function assertNotExited(data: string) {
+      if (!procExited) return
+      // Sometimes, a single white space is emitted after 'exit' has been emitted.
+      if (data.trim().length === 0) return
+      assert(false, { data, dataLength: data.length })
     }
+    */
     function processHasExited() {
         return procExited;
     }
@@ -493,16 +494,3 @@ function getPort() {
     (0, utils_2.assert)(/\d+/.test(port), { serverUrl });
     return port;
 }
-function logDebugInfo(data) {
-    console.log('vvvvv DEBUG INFO vvvvv');
-    const testInfo = (0, getCurrentTest_1.getCurrentTest)();
-    console.log('testInfo.hasStartedRunning', testInfo.hasStartedRunning);
-    console.log('testInfo.skipped', testInfo.skipped);
-    console.log('testInfo.runInfo', testInfo.runInfo);
-    console.log('testInfo.testFile', testInfo.testFile);
-    console.log('testInfo.testName', testInfo.testName);
-    console.log('data', data);
-    console.log('data.length', data.length);
-    console.log('process.platform', process.platform);
-    console.log('^^^^^ DEBUG INFO ^^^^^');
-}

package/dist/utils/assert.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.projectErrorPrefix = exports.getProjectError = exports.assertInfo = exports.assertWarning = exports.assertUsage = exports.assert = void 0;
-const createErrorWithCleanStackTrace_1 = require("./createErrorWithCleanStackTrace");
+const runTests_1 = require("../runTests");
 const projectInfo_1 = require("./projectInfo");
+const Logs_1 = require("../Logs");
+const getCurrentTest_1 = require("../getCurrentTest");
+const logSection_1 = require("../logSection");
+const logError_1 = require("../logError");
 const errorPrefix = `[${projectInfo_1.projectInfo.npmPackageName}]`;
 exports.projectErrorPrefix = errorPrefix;
 const internalErrorPrefix = `${errorPrefix}[Bug]`;
@@ -21,14 +25,19 @@ function assert(condition, debugInfo) {
         const debugInfoSerialized = typeof debugInfo === 'string' ? debugInfo : '`' + JSON.stringify(debugInfo) + '`';
         return `Debug info (this is for the ${projectInfo_1.projectInfo.projectName} maintainers; you can ignore this): ${debugInfoSerialized}.`;
     })();
-    const internalError = (0, createErrorWithCleanStackTrace_1.createErrorWithCleanStackTrace)([
+    const internalError = new Error([
         `${internalErrorPrefix} You stumbled upon a bug in ${projectInfo_1.projectInfo.projectName}'s source code.`,
         `Reach out at ${projectInfo_1.projectInfo.githubRepository}/issues/new and include this error stack (the error stack is usually enough to fix the problem).`,
         'A maintainer will fix the bug (usually under 24 hours).',
         `Do not hesitate to reach out as it makes ${projectInfo_1.projectInfo.projectName} more robust.`,
         debugStr,
-    ].join(' '), numberOfStackTraceLinesToRemove);
-    throw internalError;
+    ].join(' '));
+    (0, runTests_1.logFailure)('a bug occurred in @brillout/test-e2e');
+    (0, logError_1.logError)(internalError, 'BUG');
+    logDebugInfo();
+    Logs_1.Logs.logErrors(true);
+    Logs_1.Logs.flushLogs();
+    throw new Error('Bug. See messages above.');
 }
 exports.assert = assert;
 function assertUsage(condition, errorMessage) {
@@ -36,13 +45,12 @@ function assertUsage(condition, errorMessage) {
         return;
     }
     const whiteSpace = errorMessage.startsWith('[') ? '' : ' ';
-    const usageError = (0, createErrorWithCleanStackTrace_1.createErrorWithCleanStackTrace)(`${usageErrorPrefix}${whiteSpace}${errorMessage}`, numberOfStackTraceLinesToRemove);
-    throw usageError;
+    throw new Error(`${usageErrorPrefix}${whiteSpace}${errorMessage}`);
 }
 exports.assertUsage = assertUsage;
 function getProjectError(errorMessage) {
-    const pluginError = (0, createErrorWithCleanStackTrace_1.createErrorWithCleanStackTrace)(`${errorPrefix} ${errorMessage}`, numberOfStackTraceLinesToRemove);
-    return pluginError;
+    const projectError = new Error(`${errorPrefix} ${errorMessage}`);
+    return projectError;
 }
 exports.getProjectError = getProjectError;
 let loggedWarnings = new Set();
@@ -70,3 +78,13 @@ function assertInfo(condition, errorMessage) {
     console.warn(`${infoPrefix} ${errorMessage}`);
 }
 exports.assertInfo = assertInfo;
+function logDebugInfo() {
+    (0, logSection_1.logSection)('DEBUG INFO');
+    const testInfo = (0, getCurrentTest_1.getCurrentTest)();
+    console.log('testInfo.hasStartedRunning', testInfo.hasStartedRunning);
+    console.log('testInfo.skipped', testInfo.skipped);
+    console.log('testInfo.runInfo', testInfo.runInfo);
+    console.log('testInfo.testFile', testInfo.testFile);
+    console.log('testInfo.testName', testInfo.testName);
+    console.log('process.platform', process.platform);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/test-e2e",
-  "version": "0.4.6",
+  "version": "0.4.8",
   "bin": "./bin.js",
   "main": "./dist/index.js",
   "scripts": {

package/dist/utils/createErrorWithCleanStackTrace.d.ts

@@ -1,2 +0,0 @@
-export { createErrorWithCleanStackTrace };
-declare function createErrorWithCleanStackTrace(errorMessage: string, numberOfStackTraceLinesToRemove: number): Error;

package/dist/utils/createErrorWithCleanStackTrace.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createErrorWithCleanStackTrace = void 0;
-function createErrorWithCleanStackTrace(errorMessage, numberOfStackTraceLinesToRemove) {
-    let err;
-    {
-        var stackTraceLimit__original = Error.stackTraceLimit;
-        Error.stackTraceLimit = Infinity;
-        err = new Error(errorMessage);
-        Error.stackTraceLimit = stackTraceLimit__original;
-    }
-    err.stack = clean(err.stack, numberOfStackTraceLinesToRemove);
-    return err;
-}
-exports.createErrorWithCleanStackTrace = createErrorWithCleanStackTrace;
-function clean(errStack, numberOfStackTraceLinesToRemove) {
-    if (!errStack) {
-        return errStack;
-    }
-    const stackLines = splitByLine(errStack);
-    let linesRemoved = 0;
-    const stackLine__cleaned = stackLines
-        .filter((line) => {
-        // Remove internal stack traces
-        if (line.includes(' (internal/') || line.includes(' (node:internal')) {
-            return false;
-        }
-        if (linesRemoved < numberOfStackTraceLinesToRemove && isStackTraceLine(line)) {
-            linesRemoved++;
-            return false;
-        }
-        return true;
-    })
-        .join('\n');
-    return stackLine__cleaned;
-}
-function isStackTraceLine(line) {
-    return line.startsWith('    at ');
-}
-function splitByLine(str) {
-    // https://stackoverflow.com/questions/21895233/how-in-node-to-split-string-by-newline-n
-    return str.split(/\r?\n/);
-}