@brillout/test-e2e 0.1.20 → 0.1.22

package/dist/Logs.d.ts

@@ -1,9 +1,9 @@
 export { expectError };
 export declare const Logs: {
     add: typeof add;
-    flush: typeof flush;
-    clear: typeof clear;
-    hasError: typeof hasError;
+    flushLogs: typeof flushLogs;
+    clearLogs: typeof clearLogs;
+    hasErrorLogs: typeof hasErrorLogs;
     flushEagerly: boolean;
 };
 declare type LogSource = 'stdout' | 'stderr' | 'Browser Error' | 'Browser Warning' | 'Browser Log' | 'Playwright' | 'run()' | 'run() failure' | 'test()' | 'Connection Error';
@@ -13,9 +13,9 @@ declare type LogEntry = {
     logTimestamp: string;
     isNotFailure: boolean;
 };
-declare function hasError(onlyFailOnBrowserError: boolean): boolean;
-declare function clear(): void;
-declare function flush(): void;
+declare function hasErrorLogs(onlyFailOnBrowserError?: boolean): boolean;
+declare function clearLogs(): void;
+declare function flushLogs(): void;
 declare function add({ logSource, logText }: {
     logSource: LogSource;
     logText: string;

package/dist/Logs.js

@@ -6,9 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logs = exports.expectError = void 0;
 exports.Logs = {
     add,
-    flush,
-    clear,
-    hasError,
+    flushLogs,
+    clearLogs,
+    hasErrorLogs,
     flushEagerly: false,
 };
 const utils_1 = require("./utils");
@@ -16,8 +16,7 @@ const picocolors_1 = __importDefault(require("picocolors"));
 const getCurrentTest_1 = require("./getCurrentTest");
 const getConfig_1 = require("./getConfig");
 let logEntries = [];
-let logEntriesNotPrinted = [];
-function hasError(onlyFailOnBrowserError) {
+function hasErrorLogs(onlyFailOnBrowserError = false) {
     const logErrors = logEntries.filter(({ logSource, isNotFailure }) => {
         if (isNotFailure) {
             return;
@@ -35,13 +34,12 @@ function hasError(onlyFailOnBrowserError) {
     });
     return logErrors.length > 0;
 }
-function clear() {
+function clearLogs() {
     logEntries = [];
-    logEntriesNotPrinted = [];
 }
-function flush() {
-    logEntriesNotPrinted.forEach((logEntry) => printLog(logEntry));
-    logEntriesNotPrinted = [];
+function flushLogs() {
+    logEntries.forEach((logEntry) => printLog(logEntry));
+    logEntries = [];
 }
 function add({ logSource, logText }) {
     const logTimestamp = getTimestamp();
@@ -61,10 +59,9 @@ function add({ logSource, logText }) {
         logTimestamp,
         isNotFailure,
     };
-    logEntriesNotPrinted.push(logEntry);
     logEntries.push(logEntry);
     if (exports.Logs.flushEagerly) {
-        flush();
+        flushLogs();
     }
 }
 function expectError(logFilter) {

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) {
@@ -34,7 +35,7 @@ async function runTests(browser) {
     catch (err) {
         logTestsResult(false);
         console.log(err);
-        Logs_1.Logs.flush();
+        Logs_1.Logs.flushLogs();
         process.exit(1);
     }
     for (const { testDesc, testFn } of testInfo.tests) {
@@ -52,7 +53,7 @@ async function runTests(browser) {
         }
         done(!!err);
         testInfo.afterEach(!!err);
-        const hasErrorLog = Logs_1.Logs.hasError(testInfo.runInfo.onlyFailOnBrowserError);
+        const hasErrorLog = Logs_1.Logs.hasErrorLogs(testInfo.runInfo.onlyFailOnBrowserError);
         const isFailure = err || hasErrorLog;
         if (isFailure) {
             logTestsResult(false);
@@ -60,17 +61,29 @@ 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();
+            Logs_1.Logs.flushLogs();
             process.exit(1);
         }
         else {
-            Logs_1.Logs.clear();
+            Logs_1.Logs.clearLogs();
         }
     }
     await testInfo.terminateServer();
     await page.close();
+    // Handle case that an error occured during `terminateServer()`
+    if (Logs_1.Logs.hasErrorLogs()) {
+        if ((0, utils_1.isWindows)()) {
+            // On Windows, the sever sometimes terminates with an exit code of `1`. I don't know why.
+            Logs_1.Logs.clearLogs();
+        }
+        else {
+            console.log(new Error(logsContainError_errMsg));
+            Logs_1.Logs.flushLogs();
+            process.exit(1);
+        }
+    }
     logTestsResult(true);
 }
 exports.runTests = runTests;
@@ -110,7 +123,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.d.ts

@@ -1,4 +1,4 @@
-import { sleep } from './utils';
+import { sleep, isWindows, isLinux, isGithubAction, isMac } from './utils';
 import fetch_ from 'node-fetch';
 export { partRegex } from '@brillout/part-regex';
 export { autoRetry };
@@ -31,7 +31,3 @@ declare function autoRetry(test: () => void | Promise<void>, { timeout }?: {
 declare function fetchHtml(pathname: string): Promise<string>;
 declare function fetch(...args: Parameters<typeof fetch_>): Promise<import("node-fetch").Response>;
 declare function isMinNodeVersion(minNodeVersion: 14): boolean;
-declare function isWindows(): boolean;
-declare function isLinux(): boolean;
-declare function isMac(): boolean;
-declare function isGithubAction(): boolean;

package/dist/setup.js

@@ -8,6 +8,10 @@ const child_process_1 = require("child_process");
 const path_1 = require("path");
 const utils_1 = require("./utils");
 Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return utils_1.sleep; } });
+Object.defineProperty(exports, "isWindows", { enumerable: true, get: function () { return utils_1.isWindows; } });
+Object.defineProperty(exports, "isLinux", { enumerable: true, get: function () { return utils_1.isLinux; } });
+Object.defineProperty(exports, "isGithubAction", { enumerable: true, get: function () { return utils_1.isGithubAction; } });
+Object.defineProperty(exports, "isMac", { enumerable: true, get: function () { return utils_1.isMac; } });
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const utils_2 = require("./utils");
 const Logs_1 = require("./Logs");
@@ -25,9 +29,9 @@ 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_TEST_FUNCTION = 60 * 1000 * (!isGithubAction() ? 1 : isWindows() ? 5 : 3);
-const TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!isGithubAction() ? 1 : isLinux() ? 1 : 4);
+const TIMEOUT_NPM_SCRIPT = 2 * 60 * 1000;
+const TIMEOUT_TEST_FUNCTION = 60 * 1000 * (!(0, utils_1.isGithubAction)() ? 1 : (0, utils_1.isWindows)() ? 5 : 3);
+const TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!(0, utils_1.isGithubAction)() ? 1 : (0, utils_1.isLinux)() ? 1 : 4);
 const TIMEOUT_AUTORETRY = TIMEOUT_TEST_FUNCTION / 2;
 const TIMEOUT_PLAYWRIGHT = TIMEOUT_TEST_FUNCTION / 2;
 function skip(reason) {
@@ -79,6 +83,10 @@ 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.
@@ -137,7 +145,7 @@ async function start() {
             (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);
@@ -169,7 +177,7 @@ async function start() {
         rejectServerStart(new Error(errMsg));
     }, timeoutTotal);
     // Kill any process that listens to port `3000`
-    if (!process.env.CI && isLinux()) {
+    if (!process.env.CI && (0, utils_1.isLinux)()) {
         await (0, utils_1.runCommand)('fuser -k 3000/tcp', { swallowError: true, timeout: 10 * 1000 });
     }
     const { terminate, processHasExited } = execRunScript({
@@ -212,7 +220,7 @@ function stopProcess({ proc, cwd, cmd, signal, }) {
         reject = _reject;
     });
     const onProcessClose = (code) => {
-        if (code === 0 || code === null || (code === 1 && isWindows())) {
+        if (code === 0 || code === null || (code === 1 && (0, utils_1.isWindows)())) {
             resolve();
         }
         else {
@@ -221,7 +229,7 @@ function stopProcess({ proc, cwd, cmd, signal, }) {
     };
     proc.on('close', onProcessClose);
     proc.on('exit', onProcessClose);
-    if (isWindows()) {
+    if ((0, utils_1.isWindows)()) {
         // - https://github.com/nodejs/node/issues/3617#issuecomment-377731194
         // - https://stackoverflow.com/questions/23706055/why-can-i-not-kill-my-child-process-in-nodejs-on-windows/28163919#28163919
         (0, child_process_1.spawn)('taskkill', ['/pid', String(proc.pid), '/f', '/t'], {
@@ -264,7 +272,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
     const { cwd, cmd } = getRunInfo();
     let [command, ...args] = cmd.split(' ');
     let detached = true;
-    if (isWindows()) {
+    if ((0, utils_1.isWindows)()) {
         detached = false;
         if (command === 'npm' || command === 'pnpm') {
             command = command + '.cmd';
@@ -309,11 +317,13 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
             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);
+        const isSuccessCode = [0, null].includes(code) || ((0, utils_1.isWindows)() && code === 1);
         const isExpected = isSuccessCode && exitIsPossible;
         if (!isExpected) {
             const errMsg = `Unexpected premature process termination, exit code: ${code}`;
@@ -329,6 +339,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
                 logSource: 'run()',
             });
         }
+        exitPromiseResolve();
     });
     return { terminate, processHasExited };
     function processHasExited() {
@@ -365,6 +376,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
             });
         }
         clearTimeout(timeout);
+        await exitPromise;
         resolve();
         return promise;
     }
@@ -436,26 +448,6 @@ function isMinNodeVersion(minNodeVersion) {
     return major >= minNodeVersion;
 }
 exports.isMinNodeVersion = isMinNodeVersion;
-function isWindows() {
-    return process.platform === 'win32';
-}
-exports.isWindows = isWindows;
-function isLinux() {
-    return process.platform === 'linux';
-}
-exports.isLinux = isLinux;
-function isMac() {
-    if (process.platform === 'darwin') {
-        return true;
-    }
-    (0, utils_2.assert)(isLinux() || isWindows());
-    return false;
-}
-exports.isMac = isMac;
-function isGithubAction() {
-    return !!process.env.CI;
-}
-exports.isGithubAction = isGithubAction;
 function getCwd() {
     const { testFile } = (0, getCurrentTest_1.getCurrentTest)();
     const cwd = (0, path_1.dirname)(testFile);

package/dist/utils/index.d.ts

@@ -9,3 +9,4 @@ export * from './cliConfig';
 export * from './fsWindowsBugWorkaround';
 export * from './isObject';
 export * from './isCallable';
+export * from './platform';

package/dist/utils/index.js

@@ -25,3 +25,4 @@ __exportStar(require("./cliConfig"), exports);
 __exportStar(require("./fsWindowsBugWorkaround"), exports);
 __exportStar(require("./isObject"), exports);
 __exportStar(require("./isCallable"), exports);
+__exportStar(require("./platform"), exports);

package/dist/utils/platform.d.ts

@@ -0,0 +1,8 @@
+export { isGithubAction };
+export { isLinux };
+export { isWindows };
+export { isMac };
+declare function isWindows(): boolean;
+declare function isLinux(): boolean;
+declare function isMac(): boolean;
+declare function isGithubAction(): boolean;

package/dist/utils/platform.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMac = exports.isWindows = exports.isLinux = exports.isGithubAction = void 0;
+const assert_1 = require("./assert");
+function isWindows() {
+    return process.platform === 'win32';
+}
+exports.isWindows = isWindows;
+function isLinux() {
+    return process.platform === 'linux';
+}
+exports.isLinux = isLinux;
+function isMac() {
+    if (process.platform === 'darwin') {
+        return true;
+    }
+    (0, assert_1.assert)(isLinux() || isWindows());
+    return false;
+}
+exports.isMac = isMac;
+function isGithubAction() {
+    return !!process.env.CI;
+}
+exports.isGithubAction = isGithubAction;

package/package.json

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