@brillout/test-e2e 0.1.15 → 0.1.16

package/dist/Logs.d.ts

@@ -1,4 +1,4 @@
-export { expectBrowserError };
+export { expectError };
 export declare const Logs: {
     add: typeof add;
     flush: typeof flush;
@@ -11,7 +11,7 @@ declare type LogEntry = {
     logSource: LogSource;
     logText: string;
     logTimestamp: string;
-    isExpectedError: boolean;
+    isNotFailure: boolean;
 };
 declare function hasError(onlyFailOnBrowserError: boolean): boolean;
 declare function clear(): void;
@@ -20,4 +20,4 @@ declare function add({ logSource, logText }: {
     logSource: LogSource;
     logText: string;
 }): void;
-declare function expectBrowserError(browserLogFilter: (browserLog: LogEntry) => boolean): void;
+declare function expectError(logFilter: (browserLog: LogEntry) => boolean): void;

package/dist/Logs.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logs = exports.expectBrowserError = void 0;
+exports.Logs = exports.expectError = void 0;
 exports.Logs = {
     add,
     flush,
@@ -14,11 +14,12 @@ exports.Logs = {
 const utils_1 = require("./utils");
 const picocolors_1 = __importDefault(require("picocolors"));
 const getCurrentTest_1 = require("./getCurrentTest");
+const getConfig_1 = require("./getConfig");
 let logEntries = [];
 let logEntriesNotPrinted = [];
 function hasError(onlyFailOnBrowserError) {
-    const logErrors = logEntries.filter(({ logSource, isExpectedError }) => {
-        if (isExpectedError) {
+    const logErrors = logEntries.filter(({ logSource, isNotFailure }) => {
+        if (isNotFailure) {
             return;
         }
         if (!onlyFailOnBrowserError && (logSource === 'Browser Warning' || logSource === 'stderr')) {
@@ -41,11 +42,21 @@ function flush() {
 }
 function add({ logSource, logText }) {
     const logTimestamp = getTimestamp();
+    const isNotFailure = (() => {
+        const config = (0, getConfig_1.getConfig)();
+        if (!config.tolerateError) {
+            return false;
+        }
+        return config.tolerateError({
+            logSource,
+            logText,
+        });
+    })();
     const logEntry = {
         logSource,
         logText,
         logTimestamp,
-        isExpectedError: false,
+        isNotFailure,
     };
     logEntriesNotPrinted.push(logEntry);
     logEntries.push(logEntry);
@@ -53,18 +64,18 @@ function add({ logSource, logText }) {
         flush();
     }
 }
-function expectBrowserError(browserLogFilter) {
-    const found = !!logEntries.find((logEntry) => {
-        if (browserLogFilter(logEntry)) {
-            logEntry.isExpectedError = true;
+function expectError(logFilter) {
+    const logFounds = logEntries.filter((logEntry) => {
+        if (logFilter(logEntry)) {
+            logEntry.isNotFailure = true;
             return true;
         }
         return false;
     });
-    //expect(found).toBe(true)
-    (0, utils_1.assert)(found === true);
+    //expect(logFounds.length).not.toBe(0)
+    (0, utils_1.assert)(logFounds.length > 0);
 }
-exports.expectBrowserError = expectBrowserError;
+exports.expectError = expectError;
 function getTimestamp() {
     const now = new Date();
     const time = now.toTimeString().split(' ')[0];

package/dist/chai/types.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="chai-subset" />
 export type { ChaiPlugin };
 export type { Expect };
 import type { use as chaiUse } from 'chai';

package/dist/getConfig.d.ts

@@ -0,0 +1,7 @@
+export { getConfig };
+export { loadConfig };
+declare type Config = {
+    tolerateError?: Function;
+};
+declare function getConfig(): Config;
+declare function loadConfig(): Promise<void>;

package/dist/getConfig.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfig = exports.getConfig = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const utils_1 = require("./utils");
+const configFileName = 'test-e2e.config.mjs';
+const errPrefix = `Config file \`${configFileName}\` `;
+let config = null;
+function getConfig() {
+    (0, utils_1.assert)(config);
+    return config;
+}
+exports.getConfig = getConfig;
+async function loadConfig() {
+    const configFilePath = find();
+    (0, utils_1.assertUsage)(configFilePath, errPrefix + 'not found');
+    const configFileExports = (await import(configFilePath));
+    (0, utils_1.assertUsage)('default' in configFileExports, errPrefix + 'should have a default export');
+    assertConfig(configFileExports.default);
+    config = configFileExports.default;
+}
+exports.loadConfig = loadConfig;
+function assertConfig(config) {
+    (0, utils_1.assertUsage)((0, utils_1.isObject)(config), errPrefix + 'default export should be an object');
+    if ('tolerateError' in config) {
+        (0, utils_1.assertUsage)((0, utils_1.isCallable)(config.tolerateError), errPrefix + '`tolerateError` should be a function');
+    }
+}
+function find() {
+    let curr = process.cwd();
+    do {
+        const dir = path_1.default.dirname(curr);
+        if (dir === curr) {
+            return null;
+        }
+        const configFilePath = path_1.default.join(dir, configFileName);
+        if (fs_1.default.existsSync(configFilePath)) {
+            return configFilePath;
+        }
+        curr = dir;
+    } while (true);
+}

package/dist/runTestSuites.js

@@ -7,7 +7,9 @@ const runTests_1 = require("./runTests");
 const getBrowser_1 = require("./getBrowser");
 const buildTs_1 = require("./buildTs");
 const findTestFiles_1 = require("./findTestFiles");
+const getConfig_1 = require("./getConfig");
 async function runTestSuites(filter) {
+    await (0, getConfig_1.loadConfig)();
     const testFiles = await (0, findTestFiles_1.findTestFiles)(filter);
     const browser = await (0, getBrowser_1.getBrowser)();
     for (const testFile of testFiles) {

package/dist/setup.d.ts

@@ -4,7 +4,7 @@ export { partRegex } from '@brillout/part-regex';
 export { autoRetry };
 export { fetchHtml };
 export { fetch };
-export { expectBrowserError } from './Logs';
+export { expectError } from './Logs';
 export { run };
 export { skip };
 export { isMinNodeVersion };

package/dist/setup.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.editFileRevert = exports.editFile = exports.urlBaseChange = exports.urlBase = exports.sleep = exports.isMac = exports.isWindows = exports.isLinux = exports.isGithubAction = exports.isMinNodeVersion = exports.skip = exports.run = exports.expectBrowserError = exports.fetch = exports.fetchHtml = exports.autoRetry = exports.partRegex = void 0;
+exports.editFileRevert = exports.editFile = exports.urlBaseChange = exports.urlBase = exports.sleep = exports.isMac = exports.isWindows = exports.isLinux = exports.isGithubAction = exports.isMinNodeVersion = exports.skip = exports.run = exports.expectError = exports.fetch = exports.fetchHtml = exports.autoRetry = exports.partRegex = void 0;
 const child_process_1 = require("child_process");
 const path_1 = require("path");
 const utils_1 = require("./utils");
@@ -18,7 +18,7 @@ const page_1 = require("./page");
 var part_regex_1 = require("@brillout/part-regex");
 Object.defineProperty(exports, "partRegex", { enumerable: true, get: function () { return part_regex_1.partRegex; } });
 var Logs_2 = require("./Logs");
-Object.defineProperty(exports, "expectBrowserError", { enumerable: true, get: function () { return Logs_2.expectBrowserError; } });
+Object.defineProperty(exports, "expectError", { enumerable: true, get: function () { return Logs_2.expectError; } });
 exports.urlBase = 'http://localhost:3000';
 const urlBaseChange = (url) => (exports.urlBase = url);
 exports.urlBaseChange = urlBaseChange;
@@ -83,7 +83,15 @@ additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect
         page_1.page.off('pageerror', onPageError);
         // `runProcess` is `undefined` if `start()` failed.
         if (runProcess) {
-            await runProcess.terminate('SIGINT');
+            try {
+                await runProcess.terminate('SIGINT');
+            }
+            catch (err) {
+                Logs_1.Logs.add({
+                    logSource: 'run()',
+                    logText: String(err),
+                });
+            }
         }
     };
     return;
@@ -231,7 +239,19 @@ function stopProcess({ proc, cwd, cmd, signal, }) {
     if (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'], { stdio: ['ignore', 'ignore', 'inherit'] });
+        (0, child_process_1.spawn)('taskkill', ['/pid', String(proc.pid), '/f', '/t'], {
+            stdio: [
+                'ignore',
+                'ignore',
+                // Should we ignore `stderr`? Because `taskkill` somtimes throws:
+                // ```
+                // ERROR: The process with PID 6052 (child process of PID 3184) could not be terminated.
+                // Reason: There is no running instance of the task.
+                // ```
+                // There doesn't seem to be an option to suppress that error: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/taskkill#parameters
+                'inherit', // stderr
+            ],
+        });
     }
     else {
         (0, utils_2.assert)(proc.pid);

package/dist/utils/index.d.ts

@@ -7,3 +7,5 @@ export * from './findFiles';
 export * from './logProgress';
 export * from './cliConfig';
 export * from './fsWindowsBugWorkaround';
+export * from './isObject';
+export * from './isCallable';

package/dist/utils/index.js

@@ -23,3 +23,5 @@ __exportStar(require("./findFiles"), exports);
 __exportStar(require("./logProgress"), exports);
 __exportStar(require("./cliConfig"), exports);
 __exportStar(require("./fsWindowsBugWorkaround"), exports);
+__exportStar(require("./isObject"), exports);
+__exportStar(require("./isCallable"), exports);

package/dist/utils/isCallable.d.ts

@@ -0,0 +1 @@
+export declare function isCallable<T extends Function>(thing: T | unknown): thing is T;

package/dist/utils/isCallable.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCallable = void 0;
+function isCallable(thing) {
+    return thing instanceof Function || typeof thing === 'function';
+}
+exports.isCallable = isCallable;

package/dist/utils/isObject.d.ts

@@ -0,0 +1 @@
+export declare function isObject(value: unknown): value is Record<string | symbol, unknown>;

package/dist/utils/isObject.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = void 0;
+function isObject(value) {
+    return typeof value === 'object' && value !== null;
+}
+exports.isObject = isObject;

package/package.json

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