npm - @rstest/browser - Versions diffs - 0.8.1 → 0.8.3 - Mend

@rstest/browser 0.8.1 → 0.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/client/entry.d.ts CHANGED Viewed

@@ -4,4 +4,5 @@ declare global {
         __RSTEST_BROWSER_OPTIONS__?: BrowserHostConfig;
         __rstest_dispatch__?: (message: BrowserClientMessage) => void;
     }
+    var __coverage__: Record<string, unknown> | undefined;
 }

package/dist/hostController.d.ts CHANGED Viewed

@@ -14,4 +14,8 @@ export type ListBrowserTestsResult = {
  * This function creates a headless browser runtime, loads test files,
  * and collects their test structure (describe/test declarations).
  */
-export declare const listBrowserTests: (context: Rstest) => Promise<ListBrowserTestsResult>;
+export declare const listBrowserTests: (context: Rstest, options?: {
+    shardedEntries?: Map<string, {
+        entries: Record<string, string>;
+    }>;
+}) => Promise<ListBrowserTestsResult>;

package/dist/index.js CHANGED Viewed

@@ -2,7 +2,7 @@ import { __webpack_require__ } from "./rslib-runtime.js";
 import { existsSync } from "node:fs";
 import promises from "node:fs/promises";
 import { fileURLToPath } from "node:url";
-import { TEMP_RSTEST_OUTPUT_DIR, color, getSetupFiles, getTestEntries, isDebug, logger, rsbuild, serializableConfig } from "@rstest/core/browser";
+import { TEMP_RSTEST_OUTPUT_DIR, color, getSetupFiles, getTestEntries, isDebug, loadCoverageProvider, logger, rsbuild, serializableConfig } from "@rstest/core/browser";
 import open_editor from "open-editor";
 import { basename, dirname, join, normalize, relative, resolve as external_pathe_resolve } from "pathe";
 import sirv from "sirv";
@@ -1917,6 +1917,7 @@ const htmlTemplate = `<!DOCTYPE html>
   </body>
 </html>
 `;
+const VIRTUAL_MANIFEST_FILENAME = 'virtual-manifest.ts';
 const destroyBrowserRuntime = async (runtime)=>{
     try {
         await runtime.browser?.close?.();
@@ -1966,6 +1967,7 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
     const firstProject = browserProjects[0];
     const userPlugins = firstProject?.normalizedConfig.plugins || [];
     const userRsbuildConfig = firstProject?.normalizedConfig ?? {};
+    const browserConfig = firstProject?.normalizedConfig.browser ?? context.normalizedConfig.browser;
     const browserRuntimePath = fileURLToPath(import.meta.resolve('@rstest/core/browser-runtime'));
     const rstestInternalAliases = {
         '@rstest/browser-manifest': manifestPath,
@@ -1981,8 +1983,8 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
             plugins: userPlugins,
             server: {
                 printUrls: false,
-                port: context.normalizedConfig.browser.port ?? 4000,
-                strictPort: context.normalizedConfig.browser.strictPort
+                port: browserConfig.port ?? 4000,
+                strictPort: browserConfig.strictPort
             },
             dev: {
                 client: {
@@ -1990,7 +1992,7 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
                 }
             },
             environments: {
-                web: {}
+                [firstProject?.environmentName || 'web']: {}
             }
         }
     });
@@ -2067,6 +2069,13 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
             }
         }
     ]);
+    const coverage = firstProject?.normalizedConfig.coverage;
+    if (coverage?.enabled && 'list' !== context.command) {
+        const { pluginCoverage } = await loadCoverageProvider(coverage, context.rootPath);
+        rsbuildInstance.addPlugins([
+            pluginCoverage(coverage)
+        ]);
+    }
     const devServer = await rsbuildInstance.createDevServer({
         getPortSilently: true
     });
@@ -2177,7 +2186,7 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
     const wsPort = wss.address().port;
     logger.debug(`[Browser UI] WebSocket server started on port ${wsPort}`);
     let browserLauncher;
-    const browserName = context.normalizedConfig.browser.browser;
+    const browserName = browserConfig.browser;
     try {
         const playwright = await import("playwright");
         browserLauncher = playwright[browserName];
@@ -2189,7 +2198,7 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
     let browser;
     try {
         browser = await browserLauncher.launch({
-            headless: forceHeadless ?? context.normalizedConfig.browser.headless,
+            headless: forceHeadless ?? browserConfig.headless,
             args: 'chromium' === browserName ? [
                 '--disable-popup-blocking',
                 '--no-first-run',
@@ -2214,6 +2223,25 @@ const createBrowserRuntime = async ({ context, manifestPath, manifestSource, tem
         wss
     };
 };
+async function resolveProjectEntries(context, shardedEntries) {
+    if (shardedEntries) {
+        const browserProjects = getBrowserProjects(context);
+        const projectEntries = [];
+        for (const project of browserProjects){
+            const entryInfo = shardedEntries.get(project.environmentName);
+            if (entryInfo && Object.keys(entryInfo.entries).length > 0) {
+                const setup = getSetupFiles(project.normalizedConfig.setupFiles, project.rootPath);
+                projectEntries.push({
+                    project,
+                    setupFiles: Object.values(setup),
+                    testFiles: Object.values(entryInfo.entries)
+                });
+            }
+        }
+        return projectEntries;
+    }
+    return collectProjectEntries(context);
+}
 const runBrowserController = async (context, options)=>{
     const { skipOnTestRunEnd = false } = options ?? {};
     const buildStart = Date.now();
@@ -2235,17 +2263,21 @@ const runBrowserController = async (context, options)=>{
         ensureProcessExitCode(1);
         return;
     }
-    const projectEntries = await collectProjectEntries(context);
+    const projectEntries = await resolveProjectEntries(context, options?.shardedEntries);
     const totalTests = projectEntries.reduce((total, item)=>total + item.testFiles.length, 0);
     if (0 === totalTests) {
         const code = context.normalizedConfig.passWithNoTests ? 0 : 1;
-        if (!skipOnTestRunEnd) logger.log(color[code ? 'red' : 'yellow'](`No test files found, exiting with code ${code}.`));
+        if (!skipOnTestRunEnd) {
+            const message = `No test files found, exiting with code ${code}.`;
+            if (0 === code) logger.log(color.yellow(message));
+            else logger.error(color.red(message));
+        }
         if (0 !== code) ensureProcessExitCode(code);
         return;
     }
     const isWatchMode = 'watch' === context.command;
     const tempDir = isWatchMode && watchContext.runtime ? watchContext.runtime.tempDir : isWatchMode ? join(context.rootPath, TEMP_RSTEST_OUTPUT_DIR, 'browser', 'watch') : join(context.rootPath, TEMP_RSTEST_OUTPUT_DIR, 'browser', Date.now().toString());
-    const manifestPath = join(tempDir, 'manifest.ts');
+    const manifestPath = join(tempDir, VIRTUAL_MANIFEST_FILENAME);
     const manifestSource = generateManifestModule({
         manifestPath,
         entries: projectEntries
@@ -2499,15 +2531,15 @@ const runBrowserController = async (context, options)=>{
     }
     return result;
 };
-const listBrowserTests = async (context)=>{
-    const projectEntries = await collectProjectEntries(context);
+const listBrowserTests = async (context, options)=>{
+    const projectEntries = await resolveProjectEntries(context, options?.shardedEntries);
     const totalTests = projectEntries.reduce((total, item)=>total + item.testFiles.length, 0);
     if (0 === totalTests) return {
         list: [],
         close: async ()=>{}
     };
     const tempDir = join(context.rootPath, TEMP_RSTEST_OUTPUT_DIR, 'browser', `list-${Date.now()}`);
-    const manifestPath = join(tempDir, 'manifest.ts');
+    const manifestPath = join(tempDir, VIRTUAL_MANIFEST_FILENAME);
     const manifestSource = generateManifestModule({
         manifestPath,
         entries: projectEntries

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@rstest/browser",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "description": "Browser mode support for Rstest testing framework.",
   "bugs": {
     "url": "https://github.com/web-infra-dev/rstest/issues"
@@ -53,12 +53,12 @@
     "picomatch": "^4.0.3",
     "playwright": "^1.49.1",
     "@rstest/browser-ui": "0.0.0",
-    "@rstest/core": "0.8.1",
+    "@rstest/core": "0.8.3",
     "@rstest/tsconfig": "0.0.1"
   },
   "peerDependencies": {
     "playwright": "^1.49.1",
-    "@rstest/core": "^0.8.1"
+    "@rstest/core": "^0.8.3"
   },
   "peerDependenciesMeta": {
     "playwright": {

package/src/client/entry.ts CHANGED Viewed

@@ -7,6 +7,7 @@ import {
   projectTestContexts,
 } from '@rstest/browser-manifest';
 import type {
+  CoverageMapData,
   RunnerHooks,
   RuntimeConfig,
   WorkerState,
@@ -35,6 +36,8 @@ declare global {
     __RSTEST_BROWSER_OPTIONS__?: BrowserHostConfig;
     __rstest_dispatch__?: (message: BrowserClientMessage) => void;
   }
+  // eslint-disable-next-line no-var
+  var __coverage__: Record<string, unknown> | undefined;
 }
 /**
@@ -589,6 +592,11 @@ const run = async () => {
         runtime.api,
       );
+      // Collect coverage data from global __coverage__ object
+      if (globalThis.__coverage__) {
+        result.coverage = globalThis.__coverage__ as CoverageMapData;
+      }
       send({
         type: 'file-complete',
         payload: result,

package/src/hostController.ts CHANGED Viewed

@@ -12,6 +12,7 @@ import {
   getTestEntries,
   isDebug,
   type ListCommandResult,
+  loadCoverageProvider,
   logger,
   type ProjectContext,
   type Reporter,
@@ -715,6 +716,11 @@ const htmlTemplate = `<!DOCTYPE html>
 </html>
 `;
+// Workaround for noisy "removed ..." logs caused by VirtualModulesPlugin.
+// Rsbuild suppresses the removed-file log if all removed paths include "virtual":
+// https://github.com/web-infra-dev/rsbuild/blob/1258fa9dba5c321a4629b591a6dadbd2e26c6963/packages/core/src/createCompiler.ts#L73-L76
+const VIRTUAL_MANIFEST_FILENAME = 'virtual-manifest.ts';
 // ============================================================================
 // Browser Runtime Lifecycle
 // ============================================================================
@@ -817,6 +823,8 @@ const createBrowserRuntime = async ({
   const firstProject = browserProjects[0];
   const userPlugins = firstProject?.normalizedConfig.plugins || [];
   const userRsbuildConfig = firstProject?.normalizedConfig ?? {};
+  const browserConfig =
+    firstProject?.normalizedConfig.browser ?? context.normalizedConfig.browser;
   // Rstest internal aliases that must not be overridden by user config
   const browserRuntimePath = fileURLToPath(
@@ -841,8 +849,8 @@ const createBrowserRuntime = async ({
       plugins: userPlugins,
       server: {
         printUrls: false,
-        port: context.normalizedConfig.browser.port ?? 4000,
-        strictPort: context.normalizedConfig.browser.strictPort,
+        port: browserConfig.port ?? 4000,
+        strictPort: browserConfig.strictPort,
       },
       dev: {
         client: {
@@ -850,7 +858,7 @@ const createBrowserRuntime = async ({
         },
       },
       environments: {
-        web: {},
+        [firstProject?.environmentName || 'web']: {},
       },
     },
   });
@@ -970,6 +978,16 @@ const createBrowserRuntime = async ({
     ]);
   }
+  // Register coverage plugin for browser mode
+  const coverage = firstProject?.normalizedConfig.coverage;
+  if (coverage?.enabled && context.command !== 'list') {
+    const { pluginCoverage } = await loadCoverageProvider(
+      coverage,
+      context.rootPath,
+    );
+    rsbuildInstance.addPlugins([pluginCoverage(coverage)]);
+  }
   const devServer = await rsbuildInstance.createDevServer({
     getPortSilently: true,
   });
@@ -1134,7 +1152,7 @@ const createBrowserRuntime = async ({
   logger.debug(`[Browser UI] WebSocket server started on port ${wsPort}`);
   let browserLauncher: BrowserType;
-  const browserName = context.normalizedConfig.browser.browser;
+  const browserName = browserConfig.browser;
   try {
     const playwright = await import('playwright');
     browserLauncher = playwright[browserName];
@@ -1147,7 +1165,7 @@ const createBrowserRuntime = async ({
   let browser: BrowserInstance;
   try {
     browser = await browserLauncher.launch({
-      headless: forceHeadless ?? context.normalizedConfig.browser.headless,
+      headless: forceHeadless ?? browserConfig.headless,
       // Chromium-specific args (ignored by other browsers)
       args:
         browserName === 'chromium'
@@ -1178,6 +1196,32 @@ const createBrowserRuntime = async ({
   };
 };
+async function resolveProjectEntries(
+  context: Rstest,
+  shardedEntries?: Map<string, { entries: Record<string, string> }>,
+): Promise<BrowserProjectEntries[]> {
+  if (shardedEntries) {
+    const browserProjects = getBrowserProjects(context);
+    const projectEntries: BrowserProjectEntries[] = [];
+    for (const project of browserProjects) {
+      const entryInfo = shardedEntries.get(project.environmentName);
+      if (entryInfo && Object.keys(entryInfo.entries).length > 0) {
+        const setup = getSetupFiles(
+          project.normalizedConfig.setupFiles,
+          project.rootPath,
+        );
+        projectEntries.push({
+          project,
+          setupFiles: Object.values(setup),
+          testFiles: Object.values(entryInfo.entries),
+        });
+      }
+    }
+    return projectEntries;
+  }
+  return collectProjectEntries(context);
+}
 // ============================================================================
 // Main Entry Point
 // ============================================================================
@@ -1219,7 +1263,10 @@ export const runBrowserController = async (
     }
   }
-  const projectEntries = await collectProjectEntries(context);
+  const projectEntries = await resolveProjectEntries(
+    context,
+    options?.shardedEntries,
+  );
   const totalTests = projectEntries.reduce(
     (total, item) => total + item.testFiles.length,
     0,
@@ -1228,11 +1275,12 @@ export const runBrowserController = async (
   if (totalTests === 0) {
     const code = context.normalizedConfig.passWithNoTests ? 0 : 1;
     if (!skipOnTestRunEnd) {
-      logger.log(
-        color[code ? 'red' : 'yellow'](
-          `No test files found, exiting with code ${code}.`,
-        ),
-      );
+      const message = `No test files found, exiting with code ${code}.`;
+      if (code === 0) {
+        logger.log(color.yellow(message));
+      } else {
+        logger.error(color.red(message));
+      }
     }
     if (code !== 0) {
@@ -1253,8 +1301,8 @@ export const runBrowserController = async (
             'browser',
             Date.now().toString(),
           );
-  const manifestPath = join(tempDir, 'manifest.ts');
+  const manifestPath = join(tempDir, VIRTUAL_MANIFEST_FILENAME);
   const manifestSource = generateManifestModule({
     manifestPath,
     entries: projectEntries,
@@ -1700,8 +1748,14 @@ export type ListBrowserTestsResult = {
  */
 export const listBrowserTests = async (
   context: Rstest,
+  options?: {
+    shardedEntries?: Map<string, { entries: Record<string, string> }>;
+  },
 ): Promise<ListBrowserTestsResult> => {
-  const projectEntries = await collectProjectEntries(context);
+  const projectEntries = await resolveProjectEntries(
+    context,
+    options?.shardedEntries,
+  );
   const totalTests = projectEntries.reduce(
     (total, item) => total + item.testFiles.length,
     0,
@@ -1720,8 +1774,8 @@ export const listBrowserTests = async (
     'browser',
     `list-${Date.now()}`,
   );
-  const manifestPath = join(tempDir, 'manifest.ts');
+  const manifestPath = join(tempDir, VIRTUAL_MANIFEST_FILENAME);
   const manifestSource = generateManifestModule({
     manifestPath,
     entries: projectEntries,