@brillout/test-e2e 0.5.8 → 0.5.10

package/dist/setup.js

@@ -1,499 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getServerUrl = exports.sleep = exports.isMac = exports.isWindows = exports.isLinux = exports.isCI = 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");
-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, "isCI", { enumerable: true, get: function () { return utils_1.isCI; } });
-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");
-const strip_ansi_1 = __importDefault(require("strip-ansi"));
-const editFile_1 = require("./editFile");
-const getCurrentTest_1 = require("./getCurrentTest");
-const page_1 = require("./page");
-const logTestStatus_1 = require("./logTestStatus");
-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, "expectError", { enumerable: true, get: function () { return Logs_2.expectError; } });
-const serverUrlDefault = 'http://localhost:3000';
-const TIMEOUT_NPM_SCRIPT = 2 * 60 * 1000 * (!(0, utils_1.isCI)() ? 1 : (0, utils_1.isWindows)() ? 2 : 1);
-const TIMEOUT_TEST_FUNCTION = 60 * 1000 * (!(0, utils_1.isCI)() ? 1 : (0, utils_1.isWindows)() ? 5 : 3);
-const TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!(0, utils_1.isCI)() ? 1 : (0, utils_1.isWindows)() ? 3 : !(0, utils_1.isLinux)() ? 3 : 1);
-const TIMEOUT_AUTORETRY = TIMEOUT_TEST_FUNCTION / 2;
-const TIMEOUT_PLAYWRIGHT = TIMEOUT_TEST_FUNCTION / 2;
-function skip(reason) {
-    const testInfo = (0, getCurrentTest_1.getCurrentTest)();
-    testInfo.skipped = { reason };
-}
-exports.skip = skip;
-function run(cmd, { 
-//baseUrl = '',
-additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect = utils_1.cliConfig.inspect, cwd, doNotFailOnWarning = false, serverUrl = serverUrlDefault, isFlaky = false, } = {}) {
-    additionalTimeout += serverIsReadyDelay;
-    const testInfo = (0, getCurrentTest_1.getCurrentTest)();
-    testInfo.runInfo = {
-        cmd,
-        cwd: cwd || getCwd(),
-        additionalTimeout,
-        testFunctionTimeout: TIMEOUT_TEST_FUNCTION + additionalTimeout,
-        serverIsReadyMessage,
-        serverIsReadyDelay,
-        inspect,
-        doNotFailOnWarning,
-        serverUrl,
-        isFlaky,
-    };
-    if (inspect) {
-        Logs_1.Logs.logEagerly = true;
-    }
-    let runProcess = null;
-    testInfo.startServer = async () => {
-        runProcess = await start();
-        page_1.page.on('console', onConsole);
-        page_1.page.on('pageerror', onPageError);
-        // This setting will change the default maximum time for all the methods accepting timeout option.
-        // https://playwright.dev/docs/api/class-page#page-set-default-timeout
-        page_1.page.setDefaultTimeout(TIMEOUT_PLAYWRIGHT + additionalTimeout);
-        /*
-        await bailOnTimeout(
-          async () => {
-            await page.goto(getServerUrl() + baseUrl)
-          },
-          { timeout: TIMEOUT_PAGE_LOAD + additionalTimeout },
-        )
-        */
-    };
-    testInfo.afterEach = (hasFailed) => {
-        if (!hasFailed) {
-            (0, editFile_1.editFileAssertReverted)();
-        }
-        else {
-            (0, editFile_1.editFileRevert)();
-        }
-    };
-    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) {
-            await runProcess.terminate();
-        }
-    };
-    return;
-    // Also called when the page throws an error or a warning
-    function onConsole(msg) {
-        const type = msg.type();
-        Logs_1.Logs.add({
-            logSource: (() => {
-                if (type === 'error') {
-                    return 'Browser Error';
-                }
-                if (type === 'warning') {
-                    return 'Browser Warning';
-                }
-                return 'Browser Log';
-            })(),
-            logText: JSON.stringify({
-                type,
-                text: msg.text(),
-                location: msg.location(),
-                args: msg.args(),
-            }, null, 2),
-        });
-    }
-    // For uncaught exceptions
-    function onPageError(err) {
-        Logs_1.Logs.add({
-            logSource: 'Browser Error',
-            logText: JSON.stringify({
-                text: err.message,
-                location: err.stack,
-            }, null, 2),
-        });
-    }
-}
-exports.run = run;
-function getRunInfo() {
-    const testInfo = (0, getCurrentTest_1.getCurrentTest)();
-    (0, utils_2.assert)(testInfo.runInfo);
-    return testInfo.runInfo;
-}
-async function start() {
-    const { cmd, additionalTimeout, serverIsReadyMessage, serverIsReadyDelay } = getRunInfo();
-    if (utils_1.isTTY) {
-        console.log();
-        (0, logTestStatus_1.logBoot)();
-    }
-    const done = (0, utils_1.logProgress)(`[run] ${cmd}`);
-    let hasSuccessfullyStarted = false;
-    let resolveServerStart;
-    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.',
-            });
-            hasSuccessfullyStarted = true;
-            clearTimeout(serverStartTimeout);
-            const runProcess = { terminate };
-            _resolve(runProcess);
-        };
-        rejectServerStart = async (err) => {
-            (0, utils_2.assert)(processHasExited());
-            (0, utils_2.assert)(getRunInfo().cmd === cmd);
-            done(true);
-            clearTimeout(serverStartTimeout);
-            _reject(err);
-        };
-    });
-    const timeoutTotal = TIMEOUT_NPM_SCRIPT + additionalTimeout;
-    let hasTimedout = false;
-    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}".)`;
-        }
-        Logs_1.Logs.add({
-            logSource: 'run() failure',
-            logText: errMsg,
-        });
-        await terminate(true);
-        rejectServerStart(new Error(errMsg));
-    }, timeoutTotal);
-    // Kill any process that listens to the server port
-    if (!process.env.CI && (0, utils_1.isLinux)()) {
-        const port = getPort();
-        (0, utils_2.assert)(/\d+/.test(port));
-        await (0, utils_1.runCommand)(`fuser -k ${port}/tcp`, { swallowError: true, timeout: 10 * 1000 });
-    }
-    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;
-        },
-        async onStdout(data) {
-            const log = (0, strip_ansi_1.default)(data);
-            const isServerReady = 
-            // Custom
-            (typeof serverIsReadyMessage === 'string' && log.includes(serverIsReadyMessage)) ||
-                ((0, utils_1.isCallable)(serverIsReadyMessage) && serverIsReadyMessage(log)) ||
-                // Express.js server
-                log.includes('Server running at') ||
-                // npm package `serve`
-                log.includes('Accepting connections at') ||
-                // Vite
-                (log.includes('Local:') && log.includes('http://localhost:3000/'));
-            if (isServerReady) {
-                (0, utils_2.assert)(serverIsReadyDelay);
-                await (0, utils_1.sleep)(serverIsReadyDelay);
-                resolveServerStart();
-                done();
-            }
-        },
-    });
-    return promise;
-}
-function stopProcess({ proc, cwd, cmd, force, }) {
-    const prefix = `[Run Stop][${cwd}][${cmd}]`;
-    let resolve;
-    let reject;
-    const promise = new Promise((_resolve, _reject) => {
-        resolve = _resolve;
-        reject = _reject;
-    });
-    const onProcessClose = (code) => {
-        if (code === 0 || code === null || (code === 1 && (0, utils_1.isWindows)())) {
-            resolve();
-        }
-        else {
-            reject(new Error(`${prefix} Terminated with non-0 error code ${code}`));
-        }
-    };
-    proc.on('close', onProcessClose);
-    proc.on('exit', onProcessClose);
-    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
-        // - taskkill seems to be buggy in many ways:
-        //   - taskkill seems to make the process exit with code `1`
-        //   - Because process exits with code `1`, Node.js/npm complains:
-        //     ```
-        //     [15:36:10.626][\examples\react][npm run preview][stderr] npm
-        //     [15:36:10.626][\examples\react][npm run preview][stderr]
-        //     [15:36:10.626][\examples\react][npm run preview][stderr] ERR!
-        //     [15:36:10.626][\examples\react][npm run preview][stderr]
-        //     [15:36:10.626][\examples\react][npm run preview][stderr] code
-        //     [15:36:10.626][\examples\react][npm run preview][stderr] ELIFECYCLE
-        //     ```
-        //     Because stderr isn't empty, runTests() believes that the termination failed.
-        //   - taskkill sometimes 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.
-        //     ```
-        //     ```
-        //     ERROR: The process "6564" not found.
-        //     ```
-        //     There doesn't seem to be an option to suppress these errors: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/taskkill#parameters
-        (0, child_process_1.spawn)('taskkill', ['/pid', String(proc.pid), '/f', '/t'], {
-            stdio: [
-                '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.
-                // ```
-                'ignore',
-                // Ignoring stderr doesn't solve the problem that taskkill makes the process exit with code 1
-                'inherit', // stderr
-            ],
-        });
-    }
-    else {
-        (0, utils_2.assert)(proc.pid);
-        const processGroup = -1 * proc.pid;
-        const signal = force ? 'SIGKILL' : 'SIGTERM';
-        process.kill(processGroup, signal);
-        /*
-          try {
-            process.kill(-proc.pid, signal)
-          } catch (err: unknown) {
-            // ESRCH: No process or process group can be found corresponding to that specified by pid.
-            //  => probably means that the process was killed already.
-            if (typeof err === 'object' && err !== null && 'code' in err && err['code'] === 'ESRCH') {
-              printLog('stdout', '=============== swallowError')
-              return
-            } else {
-              printLog('stdout', '=============== no swallowError')
-              throw err
-            }
-          }
-          */
-    }
-    return promise;
-}
-function execRunScript({ onStdout, onFailure, onExit, }) {
-    const { cwd, cmd } = getRunInfo();
-    let [command, ...args] = cmd.split(' ');
-    let detached = true;
-    if ((0, utils_1.isWindows)()) {
-        detached = false;
-        if (command === 'npm' || command === 'pnpm') {
-            command = command + '.cmd';
-        }
-    }
-    Logs_1.Logs.add({
-        logSource: 'run()',
-        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(true);
-        onFailure(err);
-    };
-    proc.stdin.on('data', async (chunk) => {
-        const data = String(chunk);
-        await exitAndFail(new Error(`Command is \`${cmd}\` (${cwd}) is invoking \`stdin\`: ${data}.`));
-    });
-    proc.stdout.on('data', (chunk) => {
-        const data = String(chunk);
-        Logs_1.Logs.add({
-            logSource: 'stdout',
-            logText: data,
-            loggedAfterExit: procExited,
-        });
-        onStdout?.(data);
-    });
-    proc.stderr.on('data', async (chunk) => {
-        const data = String(chunk);
-        Logs_1.Logs.add({
-            logSource: 'stderr',
-            logText: data,
-            loggedAfterExit: procExited,
-        });
-        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) || ((0, utils_1.isWindows)() && code === 1);
-        const isExpected = isSuccessCode && exitIsPossible;
-        if (!isExpected) {
-            const errMsg = `Unexpected premature process termination, exit code: ${code}`;
-            Logs_1.Logs.add({
-                logText: errMsg,
-                logSource: 'run() failure',
-            });
-            onFailure(new Error(errMsg));
-        }
-        else {
-            Logs_1.Logs.add({
-                logText: `Process termination. (Nominal, exit code: ${code}.)`,
-                logSource: 'run()',
-            });
-        }
-        exitPromiseResolve();
-    });
-    return { terminate, processHasExited };
-    function processHasExited() {
-        return procExited;
-    }
-    async function terminate(force) {
-        let resolve;
-        let reject;
-        const promise = new Promise((_resolve, _reject) => {
-            resolve = () => {
-                _resolve();
-            };
-            reject = () => {
-                _reject();
-            };
-        });
-        const timeout = setTimeout(() => {
-            const errMsg = 'Process termination timeout. Cmd: ' + cmd;
-            Logs_1.Logs.add({
-                logSource: 'run() failure',
-                logText: errMsg,
-            });
-            /* Don't interrupt the test runner, as the test runner may recover thanks to the process-killing-by-port
-            reject(new Error(errMsg))
-            */
-            resolve();
-        }, TIMEOUT_PROCESS_TERMINATION);
-        (0, utils_2.assert)(proc);
-        try {
-            await stopProcess({
-                proc,
-                cwd,
-                cmd,
-                force,
-            });
-        }
-        catch (err) {
-            Logs_1.Logs.add({
-                logSource: 'run() failure',
-                logText: String(err),
-            });
-        }
-        clearTimeout(timeout);
-        await exitPromise;
-        resolve();
-        return promise;
-    }
-}
-async function autoRetry(test, { timeout = TIMEOUT_AUTORETRY } = {}) {
-    const period = 100;
-    const numberOfTries = timeout / period;
-    let i = 0;
-    while (true) {
-        try {
-            await test();
-            return;
-        }
-        catch (err) {
-            i = i + 1;
-            if (i > numberOfTries) {
-                throw err;
-            }
-        }
-        await (0, utils_1.sleep)(period);
-    }
-}
-exports.autoRetry = autoRetry;
-async function fetchHtml(pathname) {
-    const response = await fetch(getServerUrl() + pathname);
-    const html = await response.text();
-    return html;
-}
-exports.fetchHtml = fetchHtml;
-async function fetch(...args) {
-    try {
-        return await (0, node_fetch_1.default)(...args);
-    }
-    catch (err) {
-        Logs_1.Logs.add({
-            logSource: 'Connection Error',
-            logText: `Couldn't connect to \`${args[0]}\`. Args: \`${JSON.stringify(args.slice(1))}\`. Err: \`${
-            // @ts-ignore
-            err.message}\``,
-        });
-        throw new Error("Couldn't connect to server. See `Connection Error` log for more details.");
-    }
-}
-exports.fetch = fetch;
-/*
-async function bailOnTimeout(asyncFunc: () => Promise<void>, { timeout }: { timeout: number }) {
-  let resolve: () => void
-  let reject: (err: Error) => void
-  const promise = new Promise<void>((_resolve, _reject) => {
-    resolve = _resolve
-    reject = _reject
-  })
-
-  const t = setTimeout(() => {
-    reject(new Error(`Function timeout.`))
-  }, timeout)
-  await asyncFunc()
-  clearTimeout(t)
-  resolve()
-
-  return promise
-}
-*/
-function isMinNodeVersion(minNodeVersion) {
-    const { version } = process;
-    (0, utils_2.assert)(version.startsWith('v'));
-    const major = parseInt(version[1] + version[2], 10);
-    (0, utils_2.assert)(12 <= major && major <= 50);
-    return major >= minNodeVersion;
-}
-exports.isMinNodeVersion = isMinNodeVersion;
-function getCwd() {
-    const { testFile } = (0, getCurrentTest_1.getCurrentTest)();
-    const cwd = (0, path_1.dirname)(testFile);
-    return cwd;
-}
-function getServerUrl() {
-    const testInfo = (0, getCurrentTest_1.getCurrentTest)();
-    const serverUrl = testInfo.runInfo?.serverUrl;
-    return serverUrl;
-}
-exports.getServerUrl = getServerUrl;
-function getPort() {
-    const serverUrl = getServerUrl();
-    const port = serverUrl.split(':').slice(-1)[0].split('/')[0];
-    (0, utils_2.assert)(/\d+/.test(port), { serverUrl });
-    return port;
-}