@brillout/test-e2e 0.4.12 → 0.4.14

package/dist/Logs.d.ts

@@ -2,9 +2,9 @@ export { expectError };
 export declare const Logs: {
     add: typeof add;
     flushLogs: typeof flushLogs;
-    logErrors: typeof logErrors;
+    logErrorsAndWarnings: typeof logErrorsAndWarnings;
     clearLogs: typeof clearLogs;
-    hasErrorLogs: typeof hasErrorLogs;
+    hasFailLogs: typeof hasFailLogs;
     logEagerly: boolean;
 };
 declare type LogSource = 'stdout' | 'stderr' | 'Browser Error' | 'Browser Warning' | 'Browser Log' | 'Playwright' | 'run()' | 'run() failure' | 'test()' | 'Connection Error';
@@ -13,13 +13,15 @@ declare type LogEntry = {
     logText: string;
     logTimestamp: string;
     isNotFailure: boolean;
+    loggedAfterExit: boolean;
 };
-declare function hasErrorLogs(failOnWarning: boolean): boolean;
+declare function hasFailLogs(failOnWarning: boolean): boolean;
 declare function clearLogs(): void;
-declare function logErrors(failOnWarning: boolean): void;
+declare function logErrorsAndWarnings(): void;
 declare function flushLogs(): void;
-declare function add({ logSource, logText }: {
+declare function add({ logSource, logText, loggedAfterExit, }: {
     logSource: LogSource;
     logText: string;
+    loggedAfterExit?: boolean;
 }): void;
 declare function expectError(logFilter: (browserLog: LogEntry) => boolean): void;

package/dist/Logs.js

@@ -7,9 +7,9 @@ exports.Logs = exports.expectError = void 0;
 exports.Logs = {
     add,
     flushLogs,
-    logErrors,
+    logErrorsAndWarnings,
     clearLogs,
-    hasErrorLogs,
+    hasFailLogs,
     logEagerly: false,
 };
 const utils_1 = require("./utils");
@@ -18,19 +18,23 @@ const getCurrentTest_1 = require("./getCurrentTest");
 const getConfig_1 = require("./getConfig");
 const logSection_1 = require("./logSection");
 let logEntries = [];
-function hasErrorLogs(failOnWarning) {
-    const errorLogs = getErrorLogs(failOnWarning);
-    return errorLogs.length > 0;
+function hasFailLogs(failOnWarning) {
+    const failLogs = getErrorLogs(failOnWarning);
+    return failLogs.length > 0;
 }
-function getErrorLogs(failOnWarning) {
-    const errorLogs = logEntries.filter(({ logSource, isNotFailure }) => {
+function getErrorLogs(includeWarnings) {
+    const errorLogs = logEntries.filter(({ logSource, isNotFailure, loggedAfterExit }) => {
         if (isNotFailure) {
-            return;
+            return false;
+        }
+        // taskkill makes process exit with exit code `1` which makes npm emit logs on stderr
+        if (loggedAfterExit && (0, utils_1.isWindows)() && logSource === 'stderr') {
+            return false;
         }
         if (logSource === 'run() failure') {
             return true;
         }
-        if (failOnWarning && (logSource === 'Browser Warning' || logSource === 'stderr')) {
+        if (includeWarnings && (logSource === 'Browser Warning' || logSource === 'stderr')) {
             return true;
         }
         if (logSource === 'Browser Error') {
@@ -43,19 +47,19 @@ function getErrorLogs(failOnWarning) {
 function clearLogs() {
     logEntries = [];
 }
-function logErrors(failOnWarning) {
-    if (!exports.Logs.hasErrorLogs(failOnWarning))
+function logErrorsAndWarnings() {
+    const errorAndWarningLogs = getErrorLogs(true);
+    if (errorAndWarningLogs.length === 0)
         return;
-    (0, logSection_1.logSection)(`ERROR${!failOnWarning ? '' : '/WARNING'} LOGS`);
-    const errorLogs = getErrorLogs(failOnWarning);
-    errorLogs.forEach((logEntry) => printLog(logEntry));
+    (0, logSection_1.logSection)('ERROR & WARNING LOGS');
+    errorAndWarningLogs.forEach((logEntry) => printLog(logEntry));
 }
 function flushLogs() {
     (0, logSection_1.logSection)('ALL LOGS');
-    logEntries.forEach((logEntry) => printLog(logEntry));
+    logEntries.filter((logEntry) => !logEntry.loggedAfterExit).forEach((logEntry) => printLog(logEntry));
     logEntries = [];
 }
-function add({ logSource, logText }) {
+function add({ logSource, logText, loggedAfterExit = false, }) {
     const logTimestamp = getTimestamp();
     const isNotFailure = (() => {
         const config = (0, getConfig_1.getConfig)();
@@ -72,6 +76,7 @@ function add({ logSource, logText }) {
         logText,
         logTimestamp,
         isNotFailure,
+        loggedAfterExit,
     };
     logEntries.push(logEntry);
     if (exports.Logs.logEagerly) {

package/dist/findTestFiles.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findTestFiles = void 0;
 const utils_1 = require("./utils");
-const github_action_1 = require("./github-action");
+const parallel_ci_1 = require("./parallel-ci");
 // Unit tests `**/*.spec.*` are handled by Vitest
 const testFilenamePattern = '**/*.test.ts';
 async function findTestFiles(findFilter) {
     {
-        const testFiles = (0, github_action_1.getTestFiles)();
+        const testFiles = (0, parallel_ci_1.getTestFilesForCurrentJob)();
         if (testFiles)
             return testFiles;
     }

package/dist/parallel-ci.d.ts

@@ -0,0 +1,4 @@
+export { abortIfParallelCI };
+export { getTestFilesForCurrentJob };
+declare function abortIfParallelCI(): void;
+declare function getTestFilesForCurrentJob(): null | string[];

package/dist/{github-action.js → parallel-ci.js}

@@ -3,21 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTestFiles = exports.abortIfGitHubAction = void 0;
+exports.getTestFilesForCurrentJob = exports.abortIfParallelCI = void 0;
 const utils_1 = require("./utils");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const cwd = process.cwd();
-function abortIfGitHubAction() {
-    if (isGitHubAction()) {
+function abortIfParallelCI() {
+    if (isParallelCI()) {
         process.exit(1);
     }
 }
-exports.abortIfGitHubAction = abortIfGitHubAction;
-function isGitHubAction() {
-    return getTestFiles() !== null;
+exports.abortIfParallelCI = abortIfParallelCI;
+function isParallelCI() {
+    return getTestFilesForCurrentJob() !== null;
 }
-function getTestFiles() {
+function getTestFilesForCurrentJob() {
     if (!('TEST_FILES' in process.env))
         return null;
     (0, utils_1.assert)(process.env.TEST_FILES);
@@ -27,4 +27,4 @@ function getTestFiles() {
     });
     return testFiles;
 }
-exports.getTestFiles = getTestFiles;
+exports.getTestFilesForCurrentJob = getTestFilesForCurrentJob;

package/dist/runAll.js

@@ -5,7 +5,7 @@ const getCurrentTest_1 = require("./getCurrentTest");
 const Logs_1 = require("./Logs");
 const utils_1 = require("./utils");
 const utils_2 = require("./utils");
-const github_action_1 = require("./github-action");
+const parallel_ci_1 = require("./parallel-ci");
 const getCurrentTest_2 = require("./getCurrentTest");
 const getBrowser_1 = require("./getBrowser");
 const buildTs_1 = require("./buildTs");
@@ -45,6 +45,7 @@ exports.runAll = runAll;
 async function buildAndTest(testFile, browser, isSecondAttempt) {
     (0, utils_1.assert)(testFile.endsWith('.ts'));
     const testFileJs = testFile.replace('.ts', '.mjs');
+    (0, utils_1.assert)(testFileJs.endsWith('.mjs'));
     const cleanBuild = await (0, buildTs_1.buildTs)(testFile, testFileJs);
     (0, getCurrentTest_2.setCurrentTest)(testFile);
     try {
@@ -56,7 +57,6 @@ async function buildAndTest(testFile, browser, isSecondAttempt) {
     const { success, clean } = await runTests(browser, isSecondAttempt);
     await clean();
     (0, getCurrentTest_2.setCurrentTest)(null);
-    (0, utils_1.assert)(testFileJs.endsWith('.mjs'));
     return success;
 }
 async function runTests(browser, isSecondAttempt) {
@@ -81,13 +81,15 @@ async function runTests(browser, isSecondAttempt) {
     (0, utils_1.assert)(testInfo.afterEach);
     // Set when user calls `test()`
     (0, utils_1.assert)(testInfo.tests);
-    const isFinalAttempt = isSecondAttempt || !testInfo.runInfo.isFlaky;
+    const { isFlaky } = testInfo.runInfo;
+    const isFinalAttempt = isSecondAttempt || !isFlaky;
     const clean = async () => {
         await testInfo.terminateServer?.();
         await page.close();
     };
     const failure = () => {
-        (0, github_action_1.abortIfGitHubAction)();
+        if (!isFlaky)
+            (0, parallel_ci_1.abortIfParallelCI)();
         return { success: false, clean };
     };
     try {
@@ -116,7 +118,7 @@ async function runTests(browser, isSecondAttempt) {
         testInfo.afterEach(!!err);
         {
             const failOnWarning = !testInfo.runInfo.doNotFailOnWarning;
-            const hasErrorLog = Logs_1.Logs.hasErrorLogs(failOnWarning);
+            const hasErrorLog = Logs_1.Logs.hasFailLogs(failOnWarning);
             const isFailure = err || hasErrorLog;
             if (isFailure) {
                 if (err) {
@@ -129,7 +131,7 @@ async function runTests(browser, isSecondAttempt) {
                 else {
                     (0, utils_1.assert)(false);
                 }
-                Logs_1.Logs.logErrors(failOnWarning);
+                Logs_1.Logs.logErrorsAndWarnings();
                 Logs_1.Logs.flushLogs();
                 return failure();
             }
@@ -139,11 +141,11 @@ async function runTests(browser, isSecondAttempt) {
     // Check whether stderr emitted during testInfo.terminateServer()
     {
         const failOnWarning = true;
-        if (Logs_1.Logs.hasErrorLogs(failOnWarning) &&
+        if (Logs_1.Logs.hasFailLogs(failOnWarning) &&
             // See comments about taskkill in src/setup.ts
             !(0, utils_1.isWindows)()) {
             (0, logTestStatus_1.logFail)(`${getErrorType(failOnWarning)} occurred during server termination`, isFinalAttempt);
-            Logs_1.Logs.logErrors(failOnWarning);
+            Logs_1.Logs.logErrorsAndWarnings();
             Logs_1.Logs.flushLogs();
             return failure();
         }

package/dist/setup.js

@@ -256,11 +256,10 @@ function stopProcess({ proc, cwd, cmd, force, }) {
         (0, child_process_1.spawn)('taskkill', ['/pid', String(proc.pid), '/f', '/t'], {
             stdio: [
                 'ignore',
-                // Ignore:
+                // Ignore following log to avoid polluting non-error logs. (Setting 'inherit' instead of 'ignore' attaches stdout to the root process and not to `proc` which is why the stdout of taskkill isn't intercepted by `proc.stdout.on('data', () => /* ... */)`.)
                 // ```
                 // SUCCESS: The process with PID 6932 (child process of PID 2744) has been terminated.
                 // ```
-                // (Setting 'inherit' instead of 'ignore' attaches stdout to the root process and not to `proc` which is why the stdout of taskkill isn't intercepted by `proc.stdout.on('data', () => /* ... */)`.
                 'ignore',
                 // Ignoring stderr doesn't solve the problem that taskkill makes the process exit with code 1
                 'inherit', // stderr
@@ -323,14 +322,8 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
         Logs_1.Logs.add({
             logSource: 'stdout',
             logText: data,
+            loggedAfterExit: procExited,
         });
-        /* These assertions sometimes fail, see comments in assertNotExited()
-        assertNotExited(data)
-        assert(getRunInfo().cmd === cmd)
-        /*/
-        if (procExited)
-            return undefined;
-        //*/
         onStdout?.(data);
     });
     proc.stderr.on('data', async (chunk) => {
@@ -338,14 +331,8 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
         Logs_1.Logs.add({
             logSource: 'stderr',
             logText: data,
+            loggedAfterExit: procExited,
         });
-        /* These assertions sometimes fail, see comments in assertNotExited()
-        assertNotExited(data)
-        assert(getRunInfo().cmd === cmd)
-        /*/
-        if (procExited)
-            return undefined;
-        //*/
         if (data.includes('EADDRINUSE')) {
             await exitAndFail(new Error('Port conflict? Port already in use EADDRINUSE.'));
         }
@@ -375,15 +362,6 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
         exitPromiseResolve();
     });
     return { terminate, processHasExited };
-    /* 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;
     }
@@ -391,8 +369,12 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
         let resolve;
         let reject;
         const promise = new Promise((_resolve, _reject) => {
-            resolve = _resolve;
-            reject = _reject;
+            resolve = () => {
+                _resolve();
+            };
+            reject = () => {
+                _reject();
+            };
         });
         const timeout = setTimeout(() => {
             const errMsg = 'Process termination timeout. Cmd: ' + cmd;

package/dist/utils/assert.js

@@ -34,7 +34,7 @@ function assert(condition, debugInfo) {
     (0, logTestStatus_1.logFail)('a bug occurred in @brillout/test-e2e', true);
     (0, logError_1.logError)(internalError, 'BUG');
     logDebugInfo();
-    Logs_1.Logs.logErrors(true);
+    Logs_1.Logs.logErrorsAndWarnings();
     Logs_1.Logs.flushLogs();
     throw new Error('Bug. See messages above.');
 }

package/package.json

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

package/dist/github-action.d.ts

@@ -1,4 +0,0 @@
-export { abortIfGitHubAction };
-export { getTestFiles };
-declare function abortIfGitHubAction(): void;
-declare function getTestFiles(): null | string[];