@rstest/browser 0.10.3 → 0.10.5

package/dist/index.js

@@ -2,15 +2,14 @@ import { existsSync } from "node:fs";
 import promises from "node:fs/promises";
 import { fileURLToPath } from "node:url";
 import { isDeepStrictEqual } from "node:util";
-import { PhaseTracker, color, createCoverageProvider, getNoTestFilesMessage, getSetupFiles, getTestEntries, isDebug, loadCoverageProvider, logger, resolveProjectBuildCache, rsbuild, serializableConfig } from "@rstest/core/browser";
+import { DEFAULT_TEST_TIMEOUT, PhaseTracker, RSTEST_ENV_SYMBOL_KEY, color, createCoverageProvider, getNoTestFilesMessage, getNumCpus, getSetupFiles, getTestEntries, isDebug, isTTY, loadCoverageProvider, logger, parseWorkers, resolveProjectBuildCache, rsbuild, serializableConfig } from "@rstest/core/internal/browser";
 import open_editor from "open-editor";
 import { basename, dirname, join, normalize, relative, resolve as external_pathe_resolve } from "pathe";
 import sirv from "sirv";
 import { WebSocketServer } from "ws";
-import node_os from "node:os";
 import convert_source_map from "convert-source-map";
 import { __webpack_require__ } from "./rslib-runtime.js";
-import { DISPATCH_RPC_BRIDGE_NAME, DISPATCH_MESSAGE_TYPE } from "./626.js";
+import { DISPATCH_RPC_BRIDGE_NAME, DISPATCH_NAMESPACE_SNAPSHOT, DISPATCH_MESSAGE_TYPE, DISPATCH_NAMESPACE_BROWSER } from "./626.js";
 __webpack_require__.add({
     "../../node_modules/.pnpm/picomatch@4.0.4/node_modules/picomatch/index.js" (module, __unused_rspack_exports, __webpack_require__) {
         const pico = __webpack_require__("../../node_modules/.pnpm/picomatch@4.0.4/node_modules/picomatch/lib/picomatch.js");
@@ -1632,6 +1631,113 @@ __webpack_require__.add({
         };
     }
 });
+const BROWSER_VIEWPORT_PRESET_DIMENSIONS = {
+    iPhoneSE: {
+        width: 375,
+        height: 667
+    },
+    iPhoneXR: {
+        width: 414,
+        height: 896
+    },
+    iPhone12Pro: {
+        width: 390,
+        height: 844
+    },
+    iPhone14ProMax: {
+        width: 430,
+        height: 932
+    },
+    Pixel7: {
+        width: 412,
+        height: 915
+    },
+    SamsungGalaxyS8Plus: {
+        width: 360,
+        height: 740
+    },
+    SamsungGalaxyS20Ultra: {
+        width: 412,
+        height: 915
+    },
+    iPadMini: {
+        width: 768,
+        height: 1024
+    },
+    iPadAir: {
+        width: 820,
+        height: 1180
+    },
+    iPadPro: {
+        width: 1024,
+        height: 1366
+    },
+    SurfacePro7: {
+        width: 912,
+        height: 1368
+    },
+    SurfaceDuo: {
+        width: 540,
+        height: 720
+    },
+    GalaxyZFold5: {
+        width: 344,
+        height: 882
+    },
+    AsusZenbookFold: {
+        width: 853,
+        height: 1280
+    },
+    SamsungGalaxyA51A71: {
+        width: 412,
+        height: 914
+    },
+    NestHub: {
+        width: 1024,
+        height: 600
+    },
+    NestHubMax: {
+        width: 1280,
+        height: 800
+    }
+};
+const resolveBrowserViewportPreset = (presetId)=>{
+    const size = BROWSER_VIEWPORT_PRESET_DIMENSIONS[presetId];
+    return size ?? null;
+};
+const SUPPORTED_PROVIDERS = [
+    'playwright'
+];
+const isPlainObject = (value)=>'[object Object]' === Object.prototype.toString.call(value);
+const validateViewport = (viewport)=>{
+    if (null == viewport) return;
+    if ('string' == typeof viewport) {
+        const presetId = viewport.trim();
+        if (!presetId) throw new Error('browser.viewport must be a non-empty preset id.');
+        if (!resolveBrowserViewportPreset(presetId)) throw new Error(`browser.viewport must be a valid preset id. Received: ${viewport}`);
+        return;
+    }
+    if (isPlainObject(viewport)) {
+        const width = viewport.width;
+        const height = viewport.height;
+        if (!Number.isFinite(width) || width <= 0) throw new Error('browser.viewport.width must be a positive number.');
+        if (!Number.isFinite(height) || height <= 0) throw new Error('browser.viewport.height must be a positive number.');
+        return;
+    }
+    throw new Error('browser.viewport must be either a preset id or { width, height }.');
+};
+const validateBrowserConfig = (context)=>{
+    for (const project of context.projects){
+        const { browser, output } = project.normalizedConfig;
+        if (browser.enabled) {
+            if (!browser.provider) throw new Error('browser.provider is required when browser.enabled is true.');
+            if (!SUPPORTED_PROVIDERS.includes(browser.provider)) throw new Error(`browser.provider must be one of: ${SUPPORTED_PROVIDERS.join(', ')}.`);
+            validateViewport(browser.viewport);
+            if (!isPlainObject(browser.providerOptions)) throw new Error('browser.providerOptions must be a plain object.');
+            if (output?.bundleDependencies === false) throw new Error('output.bundleDependencies false is not supported in browser mode.');
+        }
+    }
+};
 const TYPE_REQUEST = "q";
 const TYPE_RESPONSE = "s";
 function createPromiseWithResolvers() {
@@ -1828,15 +1934,6 @@ function createBirpc($functions, options) {
     return rpc;
 }
 const DEFAULT_MAX_HEADLESS_WORKERS = 12;
-const getNumCpus = ()=>node_os.availableParallelism?.() ?? node_os.cpus().length;
-const parseWorkers = (maxWorkers, numCpus = getNumCpus())=>{
-    const parsed = Number.parseInt(maxWorkers.toString(), 10);
-    if ('string' == typeof maxWorkers && maxWorkers.trim().endsWith('%')) {
-        const workers = Math.floor(parsed / 100 * numCpus);
-        return Math.max(workers, 1);
-    }
-    return parsed > 0 ? parsed : 1;
-};
 const resolveDefaultHeadlessWorkers = (command, numCpus = getNumCpus())=>{
     const baseWorkers = Math.max(Math.min(DEFAULT_MAX_HEADLESS_WORKERS, numCpus - 1), 1);
     return 'watch' === command ? Math.max(Math.floor(baseWorkers / 2), 1) : baseWorkers;
@@ -1895,72 +1992,49 @@ class HostDispatchRouter {
         }
     }
 }
+const snapshotRequestBuilders = {
+    resolveSnapshotPath: (id, args)=>({
+            id,
+            method: 'resolveSnapshotPath',
+            args: args
+        }),
+    readSnapshotFile: (id, args)=>({
+            id,
+            method: 'readSnapshotFile',
+            args: args
+        }),
+    saveSnapshotFile: (id, args)=>({
+            id,
+            method: 'saveSnapshotFile',
+            args: args
+        }),
+    removeSnapshotFile: (id, args)=>({
+            id,
+            method: 'removeSnapshotFile',
+            args: args
+        })
+};
 const toSnapshotRpcRequest = (request)=>{
-    switch(request.method){
-        case 'resolveSnapshotPath':
-            return {
-                id: request.requestId,
-                method: 'resolveSnapshotPath',
-                args: request.args
-            };
-        case 'readSnapshotFile':
-            return {
-                id: request.requestId,
-                method: 'readSnapshotFile',
-                args: request.args
-            };
-        case 'saveSnapshotFile':
-            return {
-                id: request.requestId,
-                method: 'saveSnapshotFile',
-                args: request.args
-            };
-        case 'removeSnapshotFile':
-            return {
-                id: request.requestId,
-                method: 'removeSnapshotFile',
-                args: request.args
-            };
-        default:
-            return null;
-    }
+    const builder = snapshotRequestBuilders[request.method];
+    return builder ? builder(request.requestId, request.args) : null;
 };
 const createHostDispatchRouter = ({ routerOptions, runnerCallbacks, runSnapshotRpc, extensionHandlers, onDuplicateNamespace })=>{
     const router = new HostDispatchRouter(routerOptions);
-    router.register('runner', async (request)=>{
-        switch(request.method){
-            case 'file-start':
-                await runnerCallbacks.onTestFileStart(request.args);
-                break;
-            case 'file-ready':
-                await runnerCallbacks.onTestFileReady(request.args);
-                break;
-            case 'suite-start':
-                await runnerCallbacks.onTestSuiteStart(request.args);
-                break;
-            case 'suite-result':
-                await runnerCallbacks.onTestSuiteResult(request.args);
-                break;
-            case 'case-start':
-                await runnerCallbacks.onTestCaseStart(request.args);
-                break;
-            case 'case-result':
-                await runnerCallbacks.onTestCaseResult(request.args);
-                break;
-            case 'file-complete':
-                await runnerCallbacks.onTestFileComplete(request.args);
-                break;
-            case 'log':
-                await runnerCallbacks.onLog(request.args);
-                break;
-            case 'fatal':
-                await runnerCallbacks.onFatal(request.args);
-                break;
-            default:
-                break;
-        }
+    const runnerMethodHandlers = {
+        'file-start': (args)=>runnerCallbacks.onTestFileStart(args),
+        'file-ready': (args)=>runnerCallbacks.onTestFileReady(args),
+        'suite-start': (args)=>runnerCallbacks.onTestSuiteStart(args),
+        'suite-result': (args)=>runnerCallbacks.onTestSuiteResult(args),
+        'case-start': (args)=>runnerCallbacks.onTestCaseStart(args),
+        'case-result': (args)=>runnerCallbacks.onTestCaseResult(args),
+        'file-complete': (args)=>runnerCallbacks.onTestFileComplete(args),
+        log: (args)=>runnerCallbacks.onLog(args),
+        fatal: (args)=>runnerCallbacks.onFatal(args)
+    };
+    router.register("runner", async (request)=>{
+        await runnerMethodHandlers[request.method]?.(request.args);
     });
-    router.register('snapshot', async (request)=>{
+    router.register(DISPATCH_NAMESPACE_SNAPSHOT, async (request)=>{
         const snapshotRequest = toSnapshotRpcRequest(request);
         if (!snapshotRequest) return;
         return runSnapshotRpc(snapshotRequest);
@@ -2672,101 +2746,7 @@ const loadSourceMapWithCache = async ({ jsUrl, cache, force = false, origin, fet
         return null;
     }
 };
-const BROWSER_VIEWPORT_PRESET_IDS = [
-    'iPhoneSE',
-    'iPhoneXR',
-    'iPhone12Pro',
-    'iPhone14ProMax',
-    'Pixel7',
-    'SamsungGalaxyS8Plus',
-    'SamsungGalaxyS20Ultra',
-    'iPadMini',
-    'iPadAir',
-    'iPadPro',
-    'SurfacePro7',
-    'SurfaceDuo',
-    'GalaxyZFold5',
-    'AsusZenbookFold',
-    'SamsungGalaxyA51A71',
-    'NestHub',
-    'NestHubMax'
-];
-const BROWSER_VIEWPORT_PRESET_DIMENSIONS = {
-    iPhoneSE: {
-        width: 375,
-        height: 667
-    },
-    iPhoneXR: {
-        width: 414,
-        height: 896
-    },
-    iPhone12Pro: {
-        width: 390,
-        height: 844
-    },
-    iPhone14ProMax: {
-        width: 430,
-        height: 932
-    },
-    Pixel7: {
-        width: 412,
-        height: 915
-    },
-    SamsungGalaxyS8Plus: {
-        width: 360,
-        height: 740
-    },
-    SamsungGalaxyS20Ultra: {
-        width: 412,
-        height: 915
-    },
-    iPadMini: {
-        width: 768,
-        height: 1024
-    },
-    iPadAir: {
-        width: 820,
-        height: 1180
-    },
-    iPadPro: {
-        width: 1024,
-        height: 1366
-    },
-    SurfacePro7: {
-        width: 912,
-        height: 1368
-    },
-    SurfaceDuo: {
-        width: 540,
-        height: 720
-    },
-    GalaxyZFold5: {
-        width: 344,
-        height: 882
-    },
-    AsusZenbookFold: {
-        width: 853,
-        height: 1280
-    },
-    SamsungGalaxyA51A71: {
-        width: 412,
-        height: 914
-    },
-    NestHub: {
-        width: 1024,
-        height: 600
-    },
-    NestHubMax: {
-        width: 1280,
-        height: 800
-    }
-};
-const resolveBrowserViewportPreset = (presetId)=>{
-    const size = BROWSER_VIEWPORT_PRESET_DIMENSIONS[presetId];
-    return size ?? null;
-};
-const isTTY = ()=>Boolean(process.stdin.isTTY && !process.env.CI);
-const isBrowserWatchCliShortcutsEnabled = ()=>isTTY();
+const isBrowserWatchCliShortcutsEnabled = ()=>isTTY('stdin');
 const getBrowserWatchCliShortcutsHintMessage = ()=>`  ${color.dim('press')} ${color.bold('q')} ${color.dim('to quit')}\n`;
 const logBrowserWatchReadyMessage = (enableCliShortcuts)=>{
     logger.log(color.green('  Waiting for file changes...'));
@@ -2835,6 +2815,7 @@ var picomatch_default = /*#__PURE__*/ __webpack_require__.n(picomatch);
 const { createRsbuild: createRsbuild, rspack: rspack } = rsbuild;
 const hostController_dirname = dirname(fileURLToPath(import.meta.url));
 const OPTIONS_PLACEHOLDER = '__RSTEST_OPTIONS_PLACEHOLDER__';
+const PER_FILE_TIMEOUT_BUFFER_MS = 30000;
 let nextBrowserFilePid = 1000000000;
 const serializeForInlineScript = (value)=>JSON.stringify(value).replace(/</g, '\\u003c').replace(/\u2028/g, '\\u2028').replace(/\u2029/g, '\\u2029');
 const getBrowserProviderOptions = (project)=>{
@@ -3101,6 +3082,7 @@ const getRuntimeConfigFromProject = (project)=>{
     return {
         env: {
             NODE_ENV: process.env.NODE_ENV,
+            RSTEST: 'true',
             ...env
         },
         testNamePattern,
@@ -3328,12 +3310,12 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
         ]));
     const userPlugins = browserProjects.flatMap((project)=>project.normalizedConfig.plugins || []);
     const browserLaunchOptions = ensureConsistentBrowserLaunchOptions(browserProjects);
-    const browserRuntimePath = fileURLToPath(import.meta.resolve('@rstest/core/browser-runtime'));
+    const browserRuntimePath = fileURLToPath(import.meta.resolve('@rstest/core/internal/browser-runtime'));
     const rstestInternalAliases = {
         '@rstest/browser-manifest': manifestPath,
         '@rstest/core': resolveBrowserFile('client/public.ts'),
         '@rstest/browser': resolveBrowserFile('browser.ts'),
-        '@rstest/core/browser-runtime': browserRuntimePath,
+        '@rstest/core/internal/browser-runtime': browserRuntimePath,
         '@sinonjs/fake-timers': resolveBrowserFile('client/fakeTimersStub.ts')
     };
     const rsbuildInstance = await createRsbuild({
@@ -3375,6 +3357,7 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
                             project
                         });
                         const setupFiles = Object.values(getSetupFiles(project.normalizedConfig.setupFiles, project.rootPath));
+                        const rstestEnvDefine = `globalThis[Symbol.for(${JSON.stringify(RSTEST_ENV_SYMBOL_KEY)})]`;
                         const merged = mergeEnvironmentConfig(config, {
                             ...userRsbuildConfig,
                             performance: buildCache ? {
@@ -3387,8 +3370,8 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
                             },
                             source: {
                                 define: {
-                                    'process.env': 'globalThis[Symbol.for("rstest.env")]',
-                                    'import.meta.env': 'globalThis[Symbol.for("rstest.env")]'
+                                    'process.env': rstestEnvDefine,
+                                    'import.meta.env': rstestEnvDefine
                                 }
                             },
                             output: {
@@ -3824,7 +3807,7 @@ const runBrowserController = async (context, options)=>{
             runtimeConfig: serializableConfig(getRuntimeConfigFromProject(project)),
             viewport: project.normalizedConfig.browser.viewport
         }));
-    const maxTestTimeoutForRpc = Math.max(...browserProjects.map((p)=>p.normalizedConfig.testTimeout ?? 5000));
+    const maxTestTimeoutForRpc = Math.max(...browserProjects.map((p)=>p.normalizedConfig.testTimeout ?? DEFAULT_TEST_TIMEOUT));
     const hostOptions = {
         rootPath: normalize(context.rootPath),
         projects: projectRuntimeConfigs,
@@ -3867,7 +3850,7 @@ const runBrowserController = async (context, options)=>{
             throw String(error);
         }
     };
-    runtime.dispatchHandlers.set('browser', async (dispatchRequest)=>{
+    runtime.dispatchHandlers.set(DISPATCH_NAMESPACE_BROWSER, async (dispatchRequest)=>{
         const request = validateBrowserRpcRequest(dispatchRequest.args);
         return dispatchBrowserRpcRequest({
             request,
@@ -4011,7 +3994,7 @@ const runBrowserController = async (context, options)=>{
     const pushTaskId = (taskIds, taskId)=>{
         if (!taskIds.includes(taskId)) taskIds.push(taskId);
     };
-    const shouldEmitUserConsoleLog = (log)=>context.normalizedConfig.onConsoleLog?.(log.content) !== false;
+    const shouldEmitUserConsoleLog = (log)=>context.normalizedConfig.onConsoleLog?.(log.content, log.type) !== false;
     const emitUserConsoleLog = async (log)=>{
         if (!shouldEmitUserConsoleLog(log)) return;
         await Promise.all(context.reporters.map((reporter)=>reporter.onUserConsoleLog?.(log)));
@@ -4062,7 +4045,10 @@ const runBrowserController = async (context, options)=>{
             case 'removeSnapshotFile':
                 return snapshotRpcMethods.removeSnapshotFile(request.args.filepath);
             default:
-                return;
+                {
+                    const _exhaustive = request;
+                    return _exhaustive;
+                }
         }
     };
     const createDispatchRouter = (options)=>createHostDispatchRouter({
@@ -4112,7 +4098,7 @@ const runBrowserController = async (context, options)=>{
         });
         const dispatchRunnerMessage = async (run, file, sessionId, message)=>{
             const response = await dispatchRouter.dispatch({
-                requestId: nextDispatchRequestId('runner'),
+                requestId: nextDispatchRequestId("runner"),
                 runToken: run.token,
                 namespace: "runner",
                 method: message.type,
@@ -4148,7 +4134,7 @@ const runBrowserController = async (context, options)=>{
                 resolveDone = resolve;
             });
             const projectRuntime = projectRuntimeConfigs.find((project)=>project.name === file.projectName);
-            const perFileTimeoutMs = (projectRuntime?.runtimeConfig.testTimeout ?? maxTestTimeoutForRpc) + 30000;
+            const perFileTimeoutMs = (projectRuntime?.runtimeConfig.testTimeout ?? maxTestTimeoutForRpc) + PER_FILE_TIMEOUT_BUFFER_MS;
             let timeoutId;
             try {
                 page = await browserContext.newPage();
@@ -4471,7 +4457,7 @@ const runBrowserController = async (context, options)=>{
     };
     const getHeadedPerFileTimeoutMs = (file)=>{
         const projectRuntime = projectRuntimeConfigs.find((project)=>project.name === file.projectName);
-        return (projectRuntime?.runtimeConfig.testTimeout ?? maxTestTimeoutForRpc) + 30000;
+        return (projectRuntime?.runtimeConfig.testTimeout ?? maxTestTimeoutForRpc) + PER_FILE_TIMEOUT_BUFFER_MS;
     };
     let containerContext;
     let containerPage;
@@ -4779,7 +4765,7 @@ const listBrowserTests = async (context, options)=>{
             runtimeConfig: serializableConfig(getRuntimeConfigFromProject(project)),
             viewport: project.normalizedConfig.browser.viewport
         }));
-    const maxTestTimeoutForRpc = Math.max(...browserProjects.map((p)=>p.normalizedConfig.testTimeout ?? 5000));
+    const maxTestTimeoutForRpc = Math.max(...browserProjects.map((p)=>p.normalizedConfig.testTimeout ?? DEFAULT_TEST_TIMEOUT));
     const hostOptions = {
         rootPath: normalize(context.rootPath),
         projects: projectRuntimeConfigs,
@@ -4885,43 +4871,10 @@ const listBrowserTests = async (context, options)=>{
         close: cleanup
     };
 };
-const SUPPORTED_PROVIDERS = [
-    'playwright'
-];
-const isPlainObject = (value)=>'[object Object]' === Object.prototype.toString.call(value);
-const validateViewport = (viewport)=>{
-    if (null == viewport) return;
-    if ('string' == typeof viewport) {
-        const presetId = viewport.trim();
-        if (!presetId) throw new Error('browser.viewport must be a non-empty preset id.');
-        if (!resolveBrowserViewportPreset(presetId)) throw new Error(`browser.viewport must be a valid preset id. Received: ${viewport}`);
-        return;
-    }
-    if (isPlainObject(viewport)) {
-        const width = viewport.width;
-        const height = viewport.height;
-        if (!Number.isFinite(width) || width <= 0) throw new Error('browser.viewport.width must be a positive number.');
-        if (!Number.isFinite(height) || height <= 0) throw new Error('browser.viewport.height must be a positive number.');
-        return;
-    }
-    throw new Error('browser.viewport must be either a preset id or { width, height }.');
-};
-const validateBrowserConfig = (context)=>{
-    for (const project of context.projects){
-        const { browser, output } = project.normalizedConfig;
-        if (browser.enabled) {
-            if (!browser.provider) throw new Error('browser.provider is required when browser.enabled is true.');
-            if (!SUPPORTED_PROVIDERS.includes(browser.provider)) throw new Error(`browser.provider must be one of: ${SUPPORTED_PROVIDERS.join(', ')}.`);
-            validateViewport(browser.viewport);
-            if (!isPlainObject(browser.providerOptions)) throw new Error('browser.providerOptions must be a plain object.');
-            if (output?.bundleDependencies === false) throw new Error('output.bundleDependencies false is not supported in browser mode.');
-        }
-    }
-};
 async function runBrowserTests(context, options) {
     return runBrowserController(context, options);
 }
-async function src_listBrowserTests(context) {
-    return listBrowserTests(context);
+async function src_listBrowserTests(context, options) {
+    return listBrowserTests(context, options);
 }
-export { BROWSER_VIEWPORT_PRESET_DIMENSIONS, BROWSER_VIEWPORT_PRESET_IDS, resolveBrowserViewportPreset, runBrowserTests, src_listBrowserTests as listBrowserTests, validateBrowserConfig };
+export { runBrowserTests, src_listBrowserTests as listBrowserTests, validateBrowserConfig };