@vitest/browser 3.2.0-beta.2 → 3.2.0

package/dist/client/__vitest_browser__/{tester-CrBz0KXk.js → tester-B_w3in1j.js}

@@ -14,12 +14,22 @@ const seen = {};
 const __vitePreload = function preload(baseModule, deps, importerUrl) {
   let promise = Promise.resolve();
   if (deps && deps.length > 0) {
+    let allSettled2 = function(promises2) {
+      return Promise.all(
+        promises2.map(
+          (p2) => Promise.resolve(p2).then(
+            (value) => ({ status: "fulfilled", value }),
+            (reason) => ({ status: "rejected", reason })
+          )
+        )
+      );
+    };
     document.getElementsByTagName("link");
     const cspNonceMeta = document.querySelector(
       "meta[property=csp-nonce]"
     );
     const cspNonce = (cspNonceMeta == null ? void 0 : cspNonceMeta.nonce) || (cspNonceMeta == null ? void 0 : cspNonceMeta.getAttribute("nonce"));
-    promise = Promise.allSettled(
+    promise = allSettled2(
       deps.map((dep) => {
         dep = assetsURL(dep);
         if (dep in seen) return;
@@ -1419,6 +1429,9 @@ function parseStacktrace(stack, options = {}) {
       const fileUrl = stack2.file.startsWith("file://") ? stack2.file : `file://${stack2.file}`;
       const sourceRootUrl = map.sourceRoot ? new URL(map.sourceRoot, fileUrl) : fileUrl;
       file = new URL(source, sourceRootUrl).pathname;
+      if (file.match(/\/\w:\//)) {
+        file = file.slice(1);
+      }
     }
     if (shouldFilter(ignoreStackEntries, file)) {
       return null;
@@ -1586,6 +1599,31 @@ function createBrowserRunner(runnerClass, mocker, state, coverageModule) {
         }
         return rpc$2().onCollected(this.method, files);
       });
+      __publicField(this, "onTestAnnotate", (test, annotation) => {
+        if (annotation.location) {
+          const map = this.sourceMapCache.get(annotation.location.file);
+          if (!map) {
+            return rpc$2().onTaskAnnotate(test.id, annotation);
+          }
+          const traceMap = new TraceMap(map);
+          const { line, column, source } = originalPositionFor(traceMap, annotation.location);
+          if (line != null && column != null && source != null) {
+            let file = annotation.location.file;
+            if (source) {
+              const fileUrl = annotation.location.file.startsWith("file://") ? annotation.location.file : `file://${annotation.location.file}`;
+              const sourceRootUrl = map.sourceRoot ? new URL(map.sourceRoot, fileUrl) : fileUrl;
+              file = new URL(source, sourceRootUrl).pathname;
+            }
+            annotation.location = {
+              line,
+              column: column + 1,
+              // if the file path is on windows, we need to remove the starting slash
+              file: file.match(/\/\w:\//) ? file.slice(1) : file
+            };
+          }
+        }
+        return rpc$2().onTaskAnnotate(test.id, annotation);
+      });
       __publicField(this, "onTaskUpdate", (task, events) => {
         return rpc$2().onTaskUpdate(this.method, task, events);
       });
@@ -1652,14 +1690,23 @@ async function initiateRunner(state, mocker, config) {
   };
   return runner;
 }
+async function getTraceMap(file, sourceMaps) {
+  const result = sourceMaps.get(file) || await rpc$2().getBrowserFileSourceMap(file).then((map) => {
+    sourceMaps.set(file, map);
+    return map;
+  });
+  if (!result) {
+    return null;
+  }
+  return new TraceMap(result);
+}
 async function updateTestFilesLocations(files, sourceMaps) {
   const promises2 = files.map(async (file) => {
-    const result = sourceMaps.get(file.filepath) || await rpc$2().getBrowserFileSourceMap(file.filepath);
-    if (!result) {
+    const traceMap = await getTraceMap(file.filepath, sourceMaps);
+    if (!traceMap) {
       return null;
     }
-    const traceMap = new TraceMap(result);
-    function updateLocation(task) {
+    const updateLocation = (task) => {
       if (task.location) {
         const { line, column } = originalPositionFor(traceMap, task.location);
         if (line != null && column != null) {
@@ -1669,7 +1716,7 @@ async function updateTestFilesLocations(files, sourceMaps) {
       if ("tasks" in task) {
         task.tasks.forEach(updateLocation);
       }
-    }
+    };
     file.tasks.forEach(updateLocation);
     return null;
   });
@@ -3146,7 +3193,7 @@ class ModuleMocker {
       return;
     }
     await this.rpc.invalidate(ids);
-    this.interceptor.invalidate();
+    await this.interceptor.invalidate();
     this.registry.clear();
   }
   async importActual(id, importer) {
@@ -3254,6 +3301,8 @@ class ModuleMocker {
     });
     this.queue.add(promise);
   }
+  // We need to await mock registration before importing the actual module
+  // In case there is a mocked module in the import chain
   wrapDynamicImport(moduleFactory) {
     if (typeof moduleFactory === "function") {
       const promise = new Promise((resolve2, reject) => {
@@ -3497,6 +3546,9 @@ async function cleanup() {
     }
   }
   await userEvent.cleanup().catch((error) => unhandledError(error, "Cleanup Error"));
+  await Promise.all(
+    getBrowserState().cleanups.map((fn) => fn())
+  ).catch((error) => unhandledError(error, "Cleanup Error"));
   if (contextSwitched) {
     await rpc2.wdioSwitchContext("parent").catch((error) => unhandledError(error, "Cleanup Error"));
   }

package/dist/client/esm-client-injector.js

@@ -20,6 +20,7 @@
     wrapModule,
     wrapDynamicImport: wrapModule,
     moduleCache,
+    cleanups: [],
     config: { __VITEST_CONFIG__ },
     viteConfig: { __VITEST_VITE_CONFIG__ },
     type: { __VITEST_TYPE__ },

package/dist/client/orchestrator.html

@@ -26,7 +26,7 @@
     {__VITEST_INJECTOR__}
     {__VITEST_ERROR_CATCHER__}
     {__VITEST_SCRIPTS__}
-    <script type="module" crossorigin src="/__vitest_browser__/orchestrator-CuTjqoE1.js"></script>
+    <script type="module" crossorigin src="/__vitest_browser__/orchestrator-R-D9fwJI.js"></script>
     <link rel="modulepreload" crossorigin href="/__vitest_browser__/utils-Owv5OOOf.js">
   </head>
   <body>

package/dist/client/tester/tester.html

@@ -5,7 +5,7 @@
     <link rel="icon" href="{__VITEST_FAVICON__}" type="image/svg+xml">
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Vitest Browser Tester</title>
-    <script type="module" crossorigin src="/__vitest_browser__/tester-CrBz0KXk.js"></script>
+    <script type="module" crossorigin src="/__vitest_browser__/tester-B_w3in1j.js"></script>
     <link rel="modulepreload" crossorigin href="/__vitest_browser__/utils-Owv5OOOf.js">
   </head>
   <body>

package/dist/client.js

@@ -261,6 +261,7 @@ const stringify = (value, replacer, space) => {
 
 /* @__NO_SIDE_EFFECTS__ */
 function getBrowserState() {
+	// @ts-expect-error not typed global
 	return window.__vitest_browser_runner__;
 }
 
@@ -272,11 +273,13 @@ const PORT = location.port;
 const HOST = [location.hostname, PORT].filter(Boolean).join(":");
 const RPC_ID = PAGE_TYPE === "orchestrator" ? getBrowserState().sessionId : getBrowserState().testerId;
 const METHOD = getBrowserState().method;
-const ENTRY_URL = `${location.protocol === "https:" ? "wss:" : "ws:"}//${HOST}/__vitest_browser_api__?type=${PAGE_TYPE}&rpcId=${RPC_ID}&sessionId=${getBrowserState().sessionId}&projectName=${getBrowserState().config.name || ""}&method=${METHOD}&token=${window.VITEST_API_TOKEN}`;
+const ENTRY_URL = `${location.protocol === "https:" ? "wss:" : "ws:"}//${HOST}/__vitest_browser_api__?type=${PAGE_TYPE}&rpcId=${RPC_ID}&sessionId=${getBrowserState().sessionId}&projectName=${getBrowserState().config.name || ""}&method=${METHOD}&token=${window.VITEST_API_TOKEN || "0"}`;
 let setCancel = (_) => {};
 const onCancel = new Promise((resolve) => {
 	setCancel = resolve;
 });
+// ws connection can be established before the orchestrator is fully loaded
+// in very rare cases in the preview provider
 function waitForOrchestrator() {
 	return new Promise((resolve, reject) => {
 		const type = getBrowserState().type;
@@ -322,6 +325,7 @@ function createClient() {
 			cdp.emit(event, payload);
 		},
 		async resolveManualMock(url) {
+			// @ts-expect-error not typed global API
 			const mocker = globalThis.__vitest_mocker__;
 			const responseId = getBrowserState().sessionId;
 			if (!mocker) {
@@ -374,6 +378,7 @@ function createClient() {
 			if (ctx.ws.OPEN === ctx.ws.readyState) {
 				resolve();
 			}
+			// still have a listener even if it's already open to update tries
 			ctx.ws.addEventListener("open", () => {
 				tries = reconnectTries;
 				resolve();

package/dist/context.js

@@ -15,6 +15,7 @@ function ensureAwaited(promise) {
 			throw error;
 		}
 	});
+	// don't even start the promise if it's not awaited to not cause any unhanded promise rejections
 	let promiseResult;
 	return {
 		then(onFulfilled, onRejected) {
@@ -32,10 +33,12 @@ function ensureAwaited(promise) {
 }
 /* @__NO_SIDE_EFFECTS__ */
 function getBrowserState() {
+	// @ts-expect-error not typed global
 	return window.__vitest_browser_runner__;
 }
 /* @__NO_SIDE_EFFECTS__ */
 function getWorkerState() {
+	// @ts-expect-error not typed global
 	const state = window.__vitest_worker__;
 	if (!state) {
 		throw new Error("Worker state is not found. This is an issue with Vitest. Please, open an issue.");
@@ -55,14 +58,19 @@ function escapeIdForCSSSelector(id) {
 	return id.split("").map((char) => {
 		const code = char.charCodeAt(0);
 		if (char === " " || char === "#" || char === "." || char === ":" || char === "[" || char === "]" || char === ">" || char === "+" || char === "~" || char === "\\") {
+			// Escape common special characters with backslashes
 			return `\\${char}`;
 		} else if (code >= 65536) {
+			// Unicode escape for characters outside the BMP
 			return `\\${code.toString(16).toUpperCase().padStart(6, "0")} `;
 		} else if (code < 32 || code === 127) {
+			// Non-printable ASCII characters (0x00-0x1F and 0x7F) are escaped
 			return `\\${code.toString(16).toUpperCase().padStart(2, "0")} `;
 		} else if (code >= 128) {
+			// Non-ASCII characters (0x80 and above) are escaped
 			return `\\${code.toString(16).toUpperCase().padStart(2, "0")} `;
 		} else {
+			// Allowable characters are used directly
 			return char;
 		}
 	}).join("");
@@ -71,6 +79,7 @@ function getUniqueCssSelector(el) {
 	const path = [];
 	let parent;
 	let hasShadowRoot = false;
+	// eslint-disable-next-line no-cond-assign
 	while (parent = getParent(el)) {
 		if (parent.shadowRoot) {
 			hasShadowRoot = true;
@@ -115,11 +124,13 @@ function processTimeoutOptions(options_) {
 	if (options_ && options_.timeout != null || provider$1 !== "playwright") {
 		return options_;
 	}
+	// if there is a default action timeout, use it
 	if (getWorkerState().config.browser.providerOptions.actionTimeout != null) {
 		return options_;
 	}
 	const runner = getBrowserState().runner;
 	const startTime = runner._currentTaskStartTime;
+	// ignore timeout if this is called outside of a test
 	if (!startTime) {
 		return options_;
 	}
@@ -134,10 +145,13 @@ function processTimeoutOptions(options_) {
 	if (remainingTime <= 0) {
 		return options_;
 	}
+	// give us some time to process the timeout
 	options_.timeout = remainingTime - 100;
 	return options_;
 }
 
+// this file should not import anything directly, only types and utils
+// @ts-expect-error not typed global
 const provider = __vitest_browser_runner__.provider;
 const sessionId = getBrowserState().sessionId;
 const channel = new BroadcastChannel(`vitest:${sessionId}`);
@@ -149,12 +163,15 @@ function createUserEvent(__tl_user_event_base__, options) {
 		return createPreviewUserEvent(__tl_user_event_base__, options ?? {});
 	}
 	const keyboard = { unreleased: [] };
+	// https://playwright.dev/docs/api/class-keyboard
+	// https://webdriver.io/docs/api/browser/keys/
 	const modifier = provider === `playwright` ? "ControlOrMeta" : provider === "webdriverio" ? "Ctrl" : "Control";
 	const userEvent = {
 		setup() {
 			return createUserEvent();
 		},
 		async cleanup() {
+			// avoid cleanup rpc call if there is nothing to cleanup
 			if (!keyboard.unreleased.length) {
 				return;
 			}
@@ -423,6 +440,7 @@ const locators = {
 		const Locator = page._createLocator("css=body").constructor;
 		for (const method in methods) {
 			const cb = methods[method];
+			// @ts-expect-error types are hard to make work
 			Locator.prototype[method] = function(...args) {
 				const selectorOrLocator = cb.call(this, ...args);
 				if (typeof selectorOrLocator === "string") {

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import { ViteDevServer, HtmlTagDescriptor } from 'vite';
 import { CancelReason, BrowserTesterOptions, TestExecutionMethod, RunnerTestFile, AfterSuiteRunMeta, UserConsoleLog, SnapshotResult, SerializedConfig, ErrorWithDiff, ParsedStack } from 'vitest';
 import { MockedModuleSerialized } from '@vitest/mocker';
 import { ServerIdResolution, ServerMockResolution } from '@vitest/mocker/node';
-import { TaskResultPack, TaskEventPack } from '@vitest/runner';
+import { TestAnnotation, TaskResultPack, TaskEventPack } from '@vitest/runner';
 
 type ArgumentsType<T> = T extends (...args: infer A) => any ? A : never;
 type ReturnType<T> = T extends (...args: any) => infer R ? R : never;
@@ -29,6 +29,7 @@ interface WebSocketBrowserHandlers {
 	onUnhandledError: (error: unknown, type: string) => Promise<void>;
 	onQueued: (method: TestExecutionMethod, file: RunnerTestFile) => void;
 	onCollected: (method: TestExecutionMethod, files: RunnerTestFile[]) => Promise<void>;
+	onTaskAnnotate: (testId: string, annotation: TestAnnotation) => Promise<TestAnnotation>;
 	onTaskUpdate: (method: TestExecutionMethod, packs: TaskResultPack[], events: TaskEventPack[]) => void;
 	onAfterSuiteRun: (meta: AfterSuiteRunMeta) => void;
 	cancelCurrentRun: (reason: CancelReason) => void;
@@ -52,6 +53,7 @@ interface WebSocketBrowserHandlers {
 	registerMock: (sessionId: string, mock: MockedModuleSerialized) => void;
 	unregisterMock: (sessionId: string, id: string) => void;
 	clearMocks: (sessionId: string) => void;
+	// cdp
 	sendCdpEvent: (sessionId: string, event: string, payload?: Record<string, unknown>) => unknown;
 	trackCdpEvent: (sessionId: string, type: "on" | "once" | "off", event: string, listenerId: string) => void;
 }
@@ -135,6 +137,7 @@ declare class ParentBrowserProject {
 	children: Set<ProjectBrowser>;
 	vitest: Vitest;
 	config: ResolvedConfig;
+	// cache for non-vite source maps
 	private sourceMapCache;
 	constructor(project: TestProject, base: string);
 	setServer(vite: Vite.ViteDevServer): void;