@vitest/browser 4.0.0-beta.12 → 4.0.0-beta.13

package/dist/index.js

@@ -4,7 +4,7 @@ import c from 'tinyrainbow';
 import { isValidApiRequest, isFileServingAllowed, distDir, resolveApiServerConfig, resolveFsAllow, rolldownVersion, createDebugger, createViteLogger, createViteServer } from 'vitest/node';
 import fs, { readFileSync, lstatSync, createReadStream, promises, existsSync } from 'node:fs';
 import { createRequire } from 'node:module';
-import { slash as slash$1, toArray, deepMerge, createDefer } from '@vitest/utils/helpers';
+import { slash as slash$1, toArray, nanoid as nanoid$1, deepMerge, createDefer } from '@vitest/utils/helpers';
 import MagicString from 'magic-string';
 import sirv from 'sirv';
 import { coverageConfigDefaults } from 'vitest/config';
@@ -22,7 +22,7 @@ import pm from 'pixelmatch';
 import { WebSocketServer } from 'ws';
 import { performance } from 'node:perf_hooks';
 
-var version = "4.0.0-beta.12";
+var version = "4.0.0-beta.13";
 
 const _DRIVE_LETTER_START_RE = /^[A-Za-z]:\//;
 function normalizeWindowsPath(input = "") {
@@ -339,7 +339,7 @@ async function getBrowserProvider(options, project) {
 		if (!(name in providers)) {
 			throw new Error(`Unknown browser provider "${name}". Available providers: ${Object.keys(providers).join(", ")}.`);
 		}
-		return providers[name]().factory(project);
+		return providers[name](options.provider?.options).factory(project);
 	}
 	const supportedBrowsers = options.provider.supportedBrowser || [];
 	if (supportedBrowsers.length && !supportedBrowsers.includes(browser)) {
@@ -2394,8 +2394,12 @@ async function takeScreenshot(context, name, options) {
 		throw new Error(`Cannot take a screenshot without a test path`);
 	}
 	const path = resolveScreenshotPath(context.testPath, name, context.project.config, options.path);
-	const savePath = normalize$1(path);
-	await mkdir(dirname(path), { recursive: true });
+	// playwright does not need a screenshot path if we don't intend to save it
+	let savePath;
+	if (options.save) {
+		savePath = normalize(path);
+		await mkdir(dirname(savePath), { recursive: true });
+	}
 	if (context.provider instanceof PlaywrightBrowserProvider) {
 		const mask = options.mask?.map((selector) => context.iframe.locator(selector));
 		if (options.element) {
@@ -2404,7 +2408,7 @@ async function takeScreenshot(context, name, options) {
 			const buffer = await element.screenshot({
 				...config,
 				mask,
-				path: options.save ? savePath : undefined
+				path: savePath
 			});
 			return {
 				buffer,
@@ -2414,7 +2418,7 @@ async function takeScreenshot(context, name, options) {
 		const buffer = await context.iframe.locator("body").screenshot({
 			...options,
 			mask,
-			path: options.save ? savePath : undefined
+			path: savePath
 		});
 		return {
 			buffer,
@@ -2422,11 +2426,17 @@ async function takeScreenshot(context, name, options) {
 		};
 	}
 	if (context.provider instanceof WebdriverBrowserProvider) {
+		// webdriverio needs a path, so if one is not already set we create a temporary one
+		if (savePath === undefined) {
+			savePath = resolve(context.project.tmpDir, nanoid$1());
+			await mkdir(context.project.tmpDir, { recursive: true });
+		}
 		const page = context.provider.browser;
 		const element = !options.element ? await page.$("body") : await page.$(`${options.element}`);
 		// webdriverio expects the path to contain the extension and only works with PNG files
 		const savePathWithExtension = savePath.endsWith(".png") ? savePath : `${savePath}.png`;
-		const buffer = await element.saveScreenshot(savePathWithExtension);
+		// there seems to be a bug in webdriverio, `X:/` gets appended to cwd, so we convert to `X:\`
+		const buffer = await element.saveScreenshot(normalize$1(savePathWithExtension));
 		if (!options.save) {
 			await rm(savePathWithExtension, { force: true });
 		}
@@ -4082,6 +4092,11 @@ class BrowserPool {
 			return;
 		}
 		const provider = this.project.browser.provider;
+		const browser = this.project.config.browser.name;
+		if (shouldIgnoreDebugger(provider.name, browser)) {
+			debug?.("[$s] ignoring debugger in %s browser because it is not supported", sessionId, browser);
+			return;
+		}
 		if (!provider.getCDPSession) {
 			throw new Error("Unable to set breakpoint, CDP not supported");
 		}
@@ -4094,6 +4109,12 @@ class BrowserPool {
 		});
 	}
 }
+function shouldIgnoreDebugger(provider, browser) {
+	if (provider === "webdriverio") {
+		return browser !== "chrome" && browser !== "edge";
+	}
+	return browser !== "chromium";
+}
 
 async function createBrowserServer(project, configFile, prePlugins = [], postPlugins = []) {
 	if (project.vitest.version !== version) {

package/dist/providers/playwright.d.ts

@@ -31,7 +31,7 @@ interface PlaywrightProviderOptions {
 	*/
 	actionTimeout?: number;
 }
-declare function playwright(options?: PlaywrightProviderOptions): BrowserProviderOption;
+declare function playwright(options?: PlaywrightProviderOptions): BrowserProviderOption<PlaywrightProviderOptions>;
 declare class PlaywrightBrowserProvider implements BrowserProvider {
 	private project;
 	private options;

package/dist/providers/playwright.js

@@ -12,6 +12,7 @@ function playwright(options = {}) {
 	return {
 		name: "playwright",
 		supportedBrowser: playwrightBrowsers,
+		options,
 		factory(project) {
 			return new PlaywrightBrowserProvider(project, options);
 		},
@@ -42,10 +43,10 @@ class PlaywrightBrowserProvider {
 			}
 			const promises = [];
 			for (const [trace, contextId] of this.pendingTraces.entries()) {
-				promises.push(() => {
+				promises.push((() => {
 					const context = this.contexts.get(contextId);
 					return context?.tracing.stopChunk({ path: trace });
-				});
+				})());
 			}
 			return Promise.allSettled(promises);
 		});
@@ -81,10 +82,11 @@ class PlaywrightBrowserProvider {
 			if (typeof options.trace === "object" && options.trace.tracesDir) {
 				launchOptions.tracesDir = options.trace?.tracesDir;
 			}
-			if (this.project.config.inspector.enabled) {
+			const inspector = this.project.vitest.config.inspector;
+			if (inspector.enabled) {
 				// NodeJS equivalent defaults: https://nodejs.org/en/learn/getting-started/debugging#enable-inspector
-				const port = this.project.config.inspector.port || 9229;
-				const host = this.project.config.inspector.host || "127.0.0.1";
+				const port = inspector.port || 9229;
+				const host = inspector.host || "127.0.0.1";
 				launchOptions.args ||= [];
 				launchOptions.args.push(`--remote-debugging-port=${port}`);
 				launchOptions.args.push(`--remote-debugging-address=${host}`);

package/dist/providers/preview.js

@@ -1,6 +1,7 @@
 function preview() {
 	return {
 		name: "preview",
+		options: {},
 		factory(project) {
 			return new PreviewBrowserProvider(project);
 		},

package/dist/providers/webdriverio.d.ts

@@ -1,9 +1,9 @@
 import { ScreenshotMatcherOptions, ScreenshotComparatorRegistry } from '@vitest/browser/context';
-import { BrowserProviderOption, BrowserProvider, TestProject } from 'vitest/node';
+import { BrowserProviderOption, BrowserProvider, TestProject, CDPSession } from 'vitest/node';
 import { ClickOptions, DragAndDropOptions, remote } from 'webdriverio';
 
 interface WebdriverProviderOptions extends Partial<Parameters<typeof remote>[0]> {}
-declare function webdriverio(options?: WebdriverProviderOptions): BrowserProviderOption;
+declare function webdriverio(options?: WebdriverProviderOptions): BrowserProviderOption<WebdriverProviderOptions>;
 declare class WebdriverBrowserProvider implements BrowserProvider {
 	name: "webdriverio";
 	supportsParallelism: boolean;
@@ -31,6 +31,7 @@ declare class WebdriverBrowserProvider implements BrowserProvider {
 	openPage(sessionId: string, url: string): Promise<void>;
 	private _throwIfClosing;
 	close(): Promise<void>;
+	getCDPSession(_sessionId: string): Promise<CDPSession>;
 }
 declare module "vitest/node" {
 	interface UserEventClickOptions extends ClickOptions {}

package/dist/providers/webdriverio.js

@@ -11,6 +11,7 @@ function webdriverio(options = {}) {
 	return {
 		name: "webdriverio",
 		supportedBrowser: webdriverBrowsers,
+		options,
 		factory(project) {
 			return new WebdriverBrowserProvider(project, options);
 		},
@@ -135,6 +136,19 @@ class WebdriverBrowserProvider {
 			capabilities[key] ??= {};
 			capabilities[key].args = args;
 		}
+		const inspector = this.project.vitest.config.inspector;
+		if (inspector.enabled && (browser === "chrome" || browser === "edge")) {
+			const key = browser === "chrome" ? "goog:chromeOptions" : "ms:edgeOptions";
+			const args = capabilities[key]?.args || [];
+			// NodeJS equivalent defaults: https://nodejs.org/en/learn/getting-started/debugging#enable-inspector
+			const port = inspector.port || 9229;
+			const host = inspector.host || "127.0.0.1";
+			args.push(`--remote-debugging-port=${port}`);
+			args.push(`--remote-debugging-address=${host}`);
+			this.project.vitest.logger.log(`Debugger listening on ws://${host}:${port}`);
+			capabilities[key] ??= {};
+			capabilities[key].args = args;
+		}
 		return capabilities;
 	}
 	async openPage(sessionId, url) {
@@ -166,6 +180,27 @@ class WebdriverBrowserProvider {
 		browser.sessionId = undefined;
 		this.browser = null;
 	}
+	async getCDPSession(_sessionId) {
+		return {
+			send: (method, params) => {
+				if (!this.browser) {
+					throw new Error(`The environment was torn down.`);
+				}
+				return this.browser.sendCommandAndGetResult(method, params ?? {}).catch((error) => {
+					return Promise.reject(new Error(`Failed to execute "${method}" command.`, { cause: error }));
+				});
+			},
+			on: () => {
+				throw new Error(`webdriverio provider doesn't support cdp.on()`);
+			},
+			once: () => {
+				throw new Error(`webdriverio provider doesn't support cdp.once()`);
+			},
+			off: () => {
+				throw new Error(`webdriverio provider doesn't support cdp.off()`);
+			}
+		};
+	}
 }
 
 export { WebdriverBrowserProvider, webdriverio };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/browser",
   "type": "module",
-  "version": "4.0.0-beta.12",
+  "version": "4.0.0-beta.13",
   "description": "Browser running for Vitest",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -58,7 +58,7 @@
   "peerDependencies": {
     "playwright": "*",
     "webdriverio": "^7.0.0 || ^8.0.0 || ^9.0.0",
-    "vitest": "4.0.0-beta.12"
+    "vitest": "4.0.0-beta.13"
   },
   "peerDependenciesMeta": {
     "playwright": {
@@ -80,8 +80,8 @@
     "sirv": "^3.0.2",
     "tinyrainbow": "^3.0.3",
     "ws": "^8.18.3",
-    "@vitest/mocker": "4.0.0-beta.12",
-    "@vitest/utils": "4.0.0-beta.12"
+    "@vitest/mocker": "4.0.0-beta.13",
+    "@vitest/utils": "4.0.0-beta.13"
   },
   "devDependencies": {
     "@types/pngjs": "^6.0.5",
@@ -95,8 +95,8 @@
     "playwright": "^1.55.0",
     "playwright-core": "^1.55.0",
     "webdriverio": "^9.19.2",
-    "@vitest/runner": "4.0.0-beta.12",
-    "vitest": "4.0.0-beta.12"
+    "@vitest/runner": "4.0.0-beta.13",
+    "vitest": "4.0.0-beta.13"
   },
   "scripts": {
     "typecheck": "tsc -p ./src/client/tsconfig.json --noEmit",