@brillout/test-e2e 0.5.24 → 0.5.26

package/dist/Logs/isTolerateError.js

@@ -8,7 +8,7 @@ const getConfig_1 = require("../getConfig");
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
 function isTolerateError({ logSource, logText }) {
     logText = (0, strip_ansi_1.default)(logText);
-    if (tolerateError({ logSource, logText })) {
+    if (tolerateErrorBuiltIn({ logSource, logText })) {
         return true;
     }
     const config = (0, getConfig_1.getConfig)();
@@ -18,20 +18,38 @@ function isTolerateError({ logSource, logText }) {
     return false;
 }
 exports.isTolerateError = isTolerateError;
-function tolerateError({ logSource, logText }) {
-    return isFetchExperimentalWarning() || isTerminationEPIPE();
-    function isFetchExperimentalWarning() {
-        return (logSource === 'stderr' &&
-            logText.includes('ExperimentalWarning: The Fetch API is an experimental feature. This feature could change at any time'));
-    }
-    /* Suppress:
-    ```
-    [16:00:26.335][/examples/i18n-v1][npm run dev][run()] Terminate server.
-    [16:00:26.342][/examples/i18n-v1][npm run dev][stderr] The service was stopped: write EPIPE
-    [16:00:26.342][/examples/i18n-v1][npm run dev][run()] Process termination. (Nominal, exit code: null.)
-    ```
-    */
-    function isTerminationEPIPE() {
-        return logSource === 'stderr' && logText.includes('The service was stopped: write EPIPE');
-    }
+function tolerateErrorBuiltIn({ logSource, logText }) {
+    return [
+        {
+            logText: 'ExperimentalWarning: The Fetch API is an experimental feature. This feature could change at any time',
+            logSource: 'stderr',
+        },
+        /* Ignore:
+        ```
+        [16:00:26.335][/examples/i18n-v1][npm run dev][run()] Terminate server.
+        [16:00:26.342][/examples/i18n-v1][npm run dev][stderr] The service was stopped: write EPIPE
+        [16:00:26.342][/examples/i18n-v1][npm run dev][run()] Process termination. (Nominal, exit code: null.)
+        ``` */
+        {
+            logText: 'The service was stopped: write EPIPE',
+            logSource: 'stderr',
+        },
+        /* Ignore Chrome logging warning when it cannot do its creepy tracking: https://stackoverflow.com/questions/69619035/error-with-permissions-policy-header-unrecognized-feature-interest-cohort/75119417#75119417
+        ```
+        [15:57:20.273][/test/abort/test-dev-server.test.ts][npm run dev:server][Browser Warning] {
+          "type": "warning",
+          "text": "Error with Permissions-Policy header: Origin trial controlled feature not enabled: 'interest-cohort'.",
+          "location": {
+            "url": "",
+            "lineNumber": 0,
+            "columnNumber": 0
+          },
+          "args": []
+        }
+        ``` */
+        {
+            logText: 'Error with Permissions-Policy header: Origin trial controlled feature not enabled',
+            logSource: 'Browser Warning',
+        },
+    ].some((l) => l.logSource === logSource && logText.includes(l.logText));
 }

package/dist/Logs.js

@@ -82,21 +82,21 @@ function add({ logSource, logText, loggedAfterExit = false, }) {
     }
 }
 function expectLog(logText, logFilter) {
-    const logsFound = logEntries.filter((logEntry) => {
+    let logsFound = logEntries.filter((logEntry) => {
         if (removeAnsi(logEntry).logText.includes(logText)) {
             logEntry.isNotFailure = true;
             return true;
         }
         return false;
     });
-    const logsFoundWithFilter = logsFound.filter((logEntry) => logFilter?.(removeAnsi(logEntry)));
-    if (logsFoundWithFilter.length === 0) {
-        if (logsFound.length === 0) {
-            throw new Error(`The following log was expected but it wasn't logged: "${logText}"`);
-        }
-        else {
-            throw new Error(`The following log was logged as expected, but it didn't match the logFilter() you provided`);
-        }
+    if (logsFound.length === 0) {
+        throw new Error(`The following log was expected but it wasn't logged: "${logText}"`);
+    }
+    if (!logFilter)
+        return;
+    logsFound = logsFound.filter((logEntry) => logFilter(removeAnsi(logEntry)));
+    if (logsFound.length === 0) {
+        throw new Error(`The following log was logged as expected, but it didn't match the logFilter() you provided: "${logText}"`);
     }
 }
 exports.expectLog = expectLog;

package/dist/buildTs.d.ts

@@ -1,2 +1,4 @@
 export { buildTs };
+export { sourceMaps };
+declare const sourceMaps: Record<string, string>;
 declare function buildTs(entry: string, outfile: string): Promise<() => void>;

package/dist/buildTs.js

@@ -3,15 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildTs = void 0;
+exports.sourceMaps = exports.buildTs = void 0;
 const esbuild_1 = __importDefault(require("esbuild"));
 const fs_1 = __importDefault(require("fs"));
 const utils_1 = require("./utils");
+const sourceMaps = {};
+exports.sourceMaps = sourceMaps;
 async function buildTs(entry, outfile) {
     await esbuild_1.default.build({
         platform: 'node',
         entryPoints: [entry],
-        sourcemap: 'inline',
+        sourcemap: true,
         outfile,
         logLevel: 'warning',
         format: 'esm',
@@ -20,12 +22,17 @@ async function buildTs(entry, outfile) {
         packages: 'external',
         minify: false,
     });
-    const removeBuildFile = () => {
+    {
+        const sourceMapFile = `${outfile}.map`;
+        sourceMaps[outfile] = fs_1.default.readFileSync(sourceMapFile, 'utf8');
+        fs_1.default.unlinkSync(sourceMapFile);
+    }
+    const clean = () => {
         if (utils_1.cliOptions.debugEsbuild) {
             return;
         }
         fs_1.default.unlinkSync(`${outfile}`);
     };
-    return removeBuildFile;
+    return clean;
 }
 exports.buildTs = buildTs;

package/dist/cli.js

@@ -2,10 +2,16 @@
 /* Track down log origins
 import './utils/trackLogs'
 //*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const source_map_support_1 = __importDefault(require("source-map-support"));
 const utils_1 = require("./utils");
 const runAll_1 = require("./runAll");
+const buildTs_1 = require("./buildTs");
 const Logs_1 = require("./Logs");
+initSourceMap();
 initPromiseRejectionHandler();
 initUserExitHandler();
 cli();
@@ -24,3 +30,29 @@ function initUserExitHandler() {
         Logs_1.Logs.flushLogs();
     });
 }
+// This mechanism seems necessary for the source map to apply for errors that happen a long time after the build file, which contains the inline source map, is removed.
+//  - The much simpler alternative used by Vike doesn't seem to work: https://github.com/brillout/vite-plugin-ssr/blob/77b1b0e8b6c1ed4efe3e3039f7c0b23a00651663/vite-plugin-ssr/node/plugin/plugins/importUserCode/v1-design/transpileAndLoadFile.ts#L200-L208
+//  - Failed attempt to make the simpler alternative work: https://github.com/brillout/test-e2e/commit/681abd19459b8c7d3ade9363ba32be86e3fdcb53
+function initSourceMap() {
+    source_map_support_1.default.install({
+        retrieveSourceMap: function (source) {
+            const prefix = utils_1.fsWindowsBugWorkaroundPrefix;
+            if (source.startsWith(prefix)) {
+                source = source.slice(prefix.length);
+                if (process.platform == 'win32') {
+                    (0, utils_1.assert)(source.startsWith('/'));
+                    source = source.slice(1);
+                    source = source.split('/').join('\\');
+                }
+            }
+            let sourceMap = buildTs_1.sourceMaps[source];
+            if (sourceMap) {
+                return {
+                    map: sourceMap,
+                };
+            }
+            (0, utils_1.assert)(!source.endsWith('.test.mjs'), { source, sourceMapsKeys: Object.keys(buildTs_1.sourceMaps) });
+            return null;
+        },
+    });
+}

package/dist/getConfig.js

@@ -16,7 +16,10 @@ function getConfig() {
 exports.getConfig = getConfig;
 async function loadConfig() {
     const configFilePath = find();
-    (0, utils_1.assertUsage)(configFilePath, `${configFileName} not found`);
+    if (!configFilePath) {
+        config = {};
+        return;
+    }
     const configFileExports = (await import((0, utils_1.fsWindowsBugWorkaround)(configFilePath)));
     (0, utils_1.assertUsage)('default' in configFileExports, `${configFileName} should have a default export`);
     assertConfig(configFileExports.default);

package/dist/runAll.d.ts

@@ -1,4 +1,3 @@
 export { runAll };
 import { type FindFilter } from './utils';
-import 'source-map-support/register.js';
 declare function runAll(filter: null | FindFilter): Promise<void>;

package/dist/runAll.js

@@ -16,7 +16,6 @@ const getConfig_1 = require("./getConfig");
 const logError_1 = require("./logError");
 const logTestStatus_1 = require("./logTestStatus");
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
-require("source-map-support/register.js");
 async function runAll(filter) {
     await (0, getConfig_1.loadConfig)();
     const testFiles = await (0, findTestFiles_1.findTestFiles)(filter);
@@ -78,7 +77,7 @@ async function buildAndTest(testFile, browser, isThirdAttempt) {
     const cacheBuster = Date.now();
     const testFileJs = testFile.replace('.ts', `.${cacheBuster}.mjs`);
     (0, utils_1.assert)(testFileJs.endsWith('.mjs'));
-    const removeBuildFile = await (0, buildTs_1.buildTs)(testFile, testFileJs);
+    const cleanBuild = await (0, buildTs_1.buildTs)(testFile, testFileJs);
     (0, getCurrentTest_2.setCurrentTest)(testFile);
     (0, logTestStatus_1.logBoot)();
     let execErr;
@@ -86,13 +85,11 @@ async function buildAndTest(testFile, browser, isThirdAttempt) {
         await import((0, utils_2.fsWindowsBugWorkaround)(testFileJs));
     }
     catch (err) {
-        // Ensure the source map is loaded before we remove testFileJs contains the inline source map
-        installSourceMap(err);
         (0, utils_1.assert)(err);
         execErr = err;
     }
     finally {
-        removeBuildFile();
+        cleanBuild();
     }
     if (execErr) {
         (0, logTestStatus_1.logFail)(`an error was thrown while executing the file ${testFile}`, true);
@@ -256,13 +253,3 @@ function assertSkipUsage(testInfo) {
         (0, utils_1.assertUsage)(testInfo.tests === undefined, err);
     }
 }
-// This tiggers Error.prepareStackTrace() which is needed for the npm package 'source-map-support': the Error.prepareStackTrace() hook of 'source-map-support' needs to be called before the file containing the source map is removed.
-function installSourceMap(err) {
-    if ((0, utils_1.isObject)(err)) {
-        // Accessing err.stack triggers prepareStackTrace()
-        const { stack } = err;
-        // Ensure no compiler removes the line above
-        if (1 + 1 === 3)
-            console.log('I_AM_NEVER_SHOWN' + stack);
-    }
-}

package/dist/testScreenshotFixture.js

@@ -17,7 +17,7 @@ async function testScreenshotFixture({ screenshotFixturePath, doNotTestLocally,
     const pngPaths = getPngPaths();
     const pngFixturPath = screenshotFixturePath || pngPaths.pngFixturPath;
     if (doNotTestLocally && !(0, utils_1.isCI)()) {
-        console.log(`\n${picocolors_1.default.blue(picocolors_1.default.bold('INFO'))} screenshot test ${pngFixturPath} skipped because running test locally (i.e. not in a CI environment)`);
+        console.log(`\n${picocolors_1.default.blue('INFO')} screenshot test skipped (because running test locally, i.e. not in a CI environment): ${pngFixturPath}`);
         return;
     }
     if (!fs_1.default.existsSync(pngFixturPath)) {

package/dist/utils/fsWindowsBugWorkaround.d.ts

@@ -1,2 +1,4 @@
 export { fsWindowsBugWorkaround };
+export { fsWindowsBugWorkaroundPrefix };
+declare const fsWindowsBugWorkaroundPrefix = "file://";
 declare function fsWindowsBugWorkaround(testFileJs: string): string;

package/dist/utils/fsWindowsBugWorkaround.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fsWindowsBugWorkaround = void 0;
+exports.fsWindowsBugWorkaroundPrefix = exports.fsWindowsBugWorkaround = void 0;
 const fsWindowsBugWorkaroundPrefix = 'file://';
+exports.fsWindowsBugWorkaroundPrefix = fsWindowsBugWorkaroundPrefix;
 // https://stackoverflow.com/questions/69665780/error-err-unsupported-esm-url-scheme-only-file-and-data-urls-are-supported-by/70057245#70057245
 function fsWindowsBugWorkaround(testFileJs) {
     return `${fsWindowsBugWorkaroundPrefix}${testFileJs}`;

package/package.json

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