@brillout/test-e2e 0.1.19 → 0.1.21

package/dist/Logs.d.ts

@@ -13,7 +13,7 @@ declare type LogEntry = {
     logTimestamp: string;
     isNotFailure: boolean;
 };
-declare function hasError(onlyFailOnBrowserError: boolean): boolean;
+declare function hasError(onlyFailOnBrowserError?: boolean): boolean;
 declare function clear(): void;
 declare function flush(): void;
 declare function add({ logSource, logText }: {

package/dist/Logs.js

@@ -17,7 +17,7 @@ const getCurrentTest_1 = require("./getCurrentTest");
 const getConfig_1 = require("./getConfig");
 let logEntries = [];
 let logEntriesNotPrinted = [];
-function hasError(onlyFailOnBrowserError) {
+function hasError(onlyFailOnBrowserError = false) {
     const logErrors = logEntries.filter(({ logSource, isNotFailure }) => {
         if (isNotFailure) {
             return;

package/dist/runTests.js

@@ -5,6 +5,7 @@ const getCurrentTest_1 = require("./getCurrentTest");
 const Logs_1 = require("./Logs");
 const utils_1 = require("./utils");
 const picocolors_1 = require("picocolors");
+const logsContainError_errMsg = 'The browser/server threw/logged one or more error/warning, see logs below.';
 async function runTests(browser) {
     const testInfo = (0, getCurrentTest_1.getCurrentTest)();
     if (utils_1.isTTY) {
@@ -60,7 +61,7 @@ async function runTests(browser) {
                 console.error(err);
             }
             if (hasErrorLog) {
-                console.log(new Error('The browser/server threw/logged one or more error/warning, see logs below.'));
+                console.log(new Error(logsContainError_errMsg));
             }
             Logs_1.Logs.flush();
             process.exit(1);
@@ -71,6 +72,11 @@ async function runTests(browser) {
     }
     await testInfo.terminateServer();
     await page.close();
+    // Handle case that an error occured during `terminateServer()`
+    if (Logs_1.Logs.hasError()) {
+        console.log(new Error(logsContainError_errMsg));
+        Logs_1.Logs.flush();
+    }
     logTestsResult(true);
 }
 exports.runTests = runTests;
@@ -110,7 +116,7 @@ function logTestsResult(success) {
         return;
     }
     if (testInfo.skipped) {
-        console.log(`${skipStyle('SKIP')} ${testInfo.testFile} (${testInfo.skipped})`);
+        console.log(`${skipStyle('WARN')} ${testInfo.testFile} (${testInfo.skipped})`);
     }
     else {
         console.log(`${failStyle('FAIL')} ${testInfo.testFile}`);

package/dist/setup.js

@@ -25,7 +25,7 @@ exports.urlBaseChange = urlBaseChange;
 var editFile_2 = require("./editFile");
 Object.defineProperty(exports, "editFile", { enumerable: true, get: function () { return editFile_2.editFile; } });
 Object.defineProperty(exports, "editFileRevert", { enumerable: true, get: function () { return editFile_2.editFileRevert; } });
-const TIMEOUT_NPM_SCRIPT = 30 * 1000 * (!isGithubAction() ? 1 : isLinux() ? 1 : isWindows() ? 5 : 4);
+const TIMEOUT_NPM_SCRIPT = 2 * 60 * 1000;
 const TIMEOUT_TEST_FUNCTION = 60 * 1000 * (!isGithubAction() ? 1 : isWindows() ? 5 : 3);
 const TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!isGithubAction() ? 1 : isLinux() ? 1 : 4);
 const TIMEOUT_AUTORETRY = TIMEOUT_TEST_FUNCTION / 2;
@@ -79,19 +79,15 @@ additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect
         }
     };
     testInfo.terminateServer = async () => {
+        Logs_1.Logs.add({
+            logSource: 'run()',
+            logText: 'Terminate server.',
+        });
         page_1.page.off('console', onConsole);
         page_1.page.off('pageerror', onPageError);
         // `runProcess` is `undefined` if `start()` failed.
         if (runProcess) {
-            try {
-                await runProcess.terminate('SIGINT');
-            }
-            catch (err) {
-                Logs_1.Logs.add({
-                    logSource: 'run()',
-                    logText: String(err),
-                });
-            }
+            await runProcess.terminate('SIGINT');
         }
     };
     return;
@@ -141,9 +137,11 @@ async function start() {
     let rejectServerStart;
     const promise = new Promise((_resolve, _reject) => {
         resolveServerStart = () => {
+            (0, utils_2.assert)(!processHasExited());
+            (0, utils_2.assert)(getRunInfo().cmd === cmd);
             Logs_1.Logs.add({
                 logSource: 'run()',
-                logText: 'server is ready',
+                logText: 'Server is ready.',
             });
             hasSuccessfullyStarted = true;
             clearTimeout(serverStartTimeout);
@@ -151,45 +149,40 @@ async function start() {
             _resolve(runProcess);
         };
         rejectServerStart = async (err) => {
+            (0, utils_2.assert)(processHasExited());
             (0, utils_2.assert)(getRunInfo().cmd === cmd);
             done(true);
-            Logs_1.Logs.add({
-                logSource: 'run() failure',
-                logText: String(err),
-            });
             clearTimeout(serverStartTimeout);
-            try {
-                await terminate('SIGKILL');
-            }
-            catch (err) {
-                Logs_1.Logs.add({
-                    logSource: 'run()',
-                    logText: String(err),
-                });
-            }
             _reject(err);
         };
     });
     const timeoutTotal = TIMEOUT_NPM_SCRIPT + additionalTimeout;
     let hasTimedout = false;
-    const serverStartTimeout = setTimeout(() => {
+    const serverStartTimeout = setTimeout(async () => {
+        hasTimedout = true;
         let errMsg = '';
         errMsg += `Server still didn't start after ${(0, utils_1.humanizeTime)(timeoutTotal)} of running the npm script \`${cmd}\`.`;
         if (serverIsReadyMessage) {
             errMsg += ` (The stdout of the npm script did not include: "${serverIsReadyMessage}".)`;
         }
-        hasTimedout = true;
+        Logs_1.Logs.add({
+            logSource: 'run() failure',
+            logText: errMsg,
+        });
+        await terminate();
         rejectServerStart(new Error(errMsg));
     }, timeoutTotal);
     // Kill any process that listens to port `3000`
     if (!process.env.CI && isLinux()) {
         await (0, utils_1.runCommand)('fuser -k 3000/tcp', { swallowError: true, timeout: 10 * 1000 });
     }
-    const { terminate } = execRunScript({
-        onError(err) {
+    const { terminate, processHasExited } = execRunScript({
+        async onFailure(err) {
+            (0, utils_2.assert)(processHasExited());
             rejectServerStart(err);
         },
         onExit() {
+            (0, utils_2.assert)(processHasExited());
             const exitIsPossible = hasSuccessfullyStarted === true || hasTimedout;
             return exitIsPossible;
         },
@@ -211,11 +204,6 @@ async function start() {
                 done();
             }
         },
-        onStderr(data) {
-            if (data.includes('EADDRINUSE')) {
-                rejectServerStart(new Error('Port conflict? Port already in use EADDRINUSE.'));
-            }
-        },
     });
     return promise;
 }
@@ -276,7 +264,7 @@ function stopProcess({ proc, cwd, cmd, signal, }) {
     }
     return promise;
 }
-function execRunScript({ onStdout, onStderr, onError, onExit, }) {
+function execRunScript({ onStdout, onFailure, onExit, }) {
     const { cwd, cmd } = getRunInfo();
     let [command, ...args] = cmd.split(' ');
     let detached = true;
@@ -291,10 +279,20 @@ function execRunScript({ onStdout, onStderr, onError, onExit, }) {
         logText: `Spawn command \`${cmd}\``,
     });
     const proc = (0, child_process_1.spawn)(command, args, { cwd, detached });
+    let procExited = false;
+    const exitAndFail = async (err) => {
+        Logs_1.Logs.add({
+            logText: err.message,
+            logSource: 'run() failure',
+        });
+        await terminate();
+        onFailure(err);
+    };
     proc.stdin.on('data', async (data) => {
-        onError(new Error(`Command is \`${cmd}\` (${cwd}) is invoking \`stdin\`: ${data}.`));
+        await exitAndFail(new Error(`Command is \`${cmd}\` (${cwd}) is invoking \`stdin\`: ${data}.`));
     });
     proc.stdout.on('data', (data) => {
+        (0, utils_2.assert)(!procExited);
         (0, utils_2.assert)(getRunInfo().cmd === cmd);
         data = data.toString();
         Logs_1.Logs.add({
@@ -303,16 +301,22 @@ function execRunScript({ onStdout, onStderr, onError, onExit, }) {
         });
         onStdout?.(data);
     });
-    proc.stderr.on('data', (data) => {
+    proc.stderr.on('data', async (data) => {
+        (0, utils_2.assert)(!procExited);
         (0, utils_2.assert)(getRunInfo().cmd === cmd);
         data = data.toString();
         Logs_1.Logs.add({
             logSource: 'stderr',
             logText: data,
         });
-        onStderr?.(data);
+        if (data.includes('EADDRINUSE')) {
+            await exitAndFail(new Error('Port conflict? Port already in use EADDRINUSE.'));
+        }
     });
+    let exitPromiseResolve;
+    const exitPromise = new Promise((r) => (exitPromiseResolve = r));
     proc.on('exit', (code) => {
+        procExited = true;
         (0, utils_2.assert)(getRunInfo().cmd === cmd);
         const exitIsPossible = onExit();
         const isSuccessCode = [0, null].includes(code) || (isWindows() && code === 1);
@@ -323,16 +327,7 @@ function execRunScript({ onStdout, onStderr, onError, onExit, }) {
                 logText: errMsg,
                 logSource: 'run() failure',
             });
-            onError(new Error(errMsg));
-            /*
-            try {
-              await terminate('SIGKILL')
-            } catch (err: unknown) {
-              if( !err.code === 'ESRCH' ) {
-                onError(err as Error)
-              }
-            }
-            */
+            onFailure(new Error(errMsg));
         }
         else {
             Logs_1.Logs.add({
@@ -340,9 +335,13 @@ function execRunScript({ onStdout, onStderr, onError, onExit, }) {
                 logSource: 'run()',
             });
         }
+        exitPromiseResolve();
     });
-    return { terminate };
-    async function terminate(signal) {
+    return { terminate, processHasExited };
+    function processHasExited() {
+        return procExited;
+    }
+    async function terminate(signal = 'SIGKILL') {
         let resolve;
         let reject;
         const promise = new Promise((_resolve, _reject) => {
@@ -350,16 +349,30 @@ function execRunScript({ onStdout, onStderr, onError, onExit, }) {
             reject = _reject;
         });
         const timeout = setTimeout(() => {
-            reject(new Error('Process termination timeout. Cmd: ' + cmd));
+            const errMsg = 'Process termination timeout. Cmd: ' + cmd;
+            Logs_1.Logs.add({
+                logSource: 'run() failure',
+                logText: errMsg,
+            });
+            reject(new Error(errMsg));
         }, TIMEOUT_PROCESS_TERMINATION);
         (0, utils_2.assert)(proc);
-        await stopProcess({
-            proc,
-            cwd,
-            cmd,
-            signal,
-        });
+        try {
+            await stopProcess({
+                proc,
+                cwd,
+                cmd,
+                signal,
+            });
+        }
+        catch (err) {
+            Logs_1.Logs.add({
+                logSource: 'run() failure',
+                logText: String(err),
+            });
+        }
         clearTimeout(timeout);
+        await exitPromise;
         resolve();
         return promise;
     }

package/package.json

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