@vitest/browser-playwright 4.1.0-beta.1 → 4.1.0-beta.2

package/dist/index.d.ts

@@ -31,6 +31,18 @@ interface PlaywrightProviderOptions {
 	* @default 0 (no timeout)
 	*/
 	actionTimeout?: number;
+	/**
+	* Use a persistent context instead of a regular browser context.
+	* This allows browser state (cookies, localStorage, DevTools settings, etc.) to persist between test runs.
+	* When set to `true`, the user data is stored in `./node_modules/.cache/vitest-playwright-user-data`.
+	* When set to a string, the value is used as the path to the user data directory.
+	*
+	* Note: This option is ignored when running tests in parallel (e.g. headless with fileParallelism enabled)
+	* because persistent context cannot be shared across parallel sessions.
+	* @default false
+	* @see {@link https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context}
+	*/
+	persistentContext?: boolean | string;
 }
 declare function playwright(options?: PlaywrightProviderOptions): BrowserProviderOption<PlaywrightProviderOptions>;
 declare class PlaywrightBrowserProvider implements BrowserProvider {
@@ -39,6 +51,7 @@ declare class PlaywrightBrowserProvider implements BrowserProvider {
 	name: "playwright";
 	supportsParallelism: boolean;
 	browser: Browser | null;
+	persistentContext: BrowserContext | null;
 	contexts: Map<string, BrowserContext>;
 	pages: Map<string, Page>;
 	mocker: BrowserModuleMocker;
@@ -52,6 +65,7 @@ declare class PlaywrightBrowserProvider implements BrowserProvider {
 	private openBrowser;
 	private createMocker;
 	private createContext;
+	private getContextOptions;
 	getPage(sessionId: string): Page;
 	getCommandsContext(sessionId: string): {
 		page: Page;
@@ -60,7 +74,9 @@ declare class PlaywrightBrowserProvider implements BrowserProvider {
 		readonly iframe: FrameLocator;
 	};
 	private openBrowserPage;
-	openPage(sessionId: string, url: string): Promise<void>;
+	openPage(sessionId: string, url: string, options: {
+		parallel: boolean;
+	}): Promise<void>;
 	private _throwIfClosing;
 	getCDPSession(sessionid: string): Promise<CDPSession$1>;
 	close(): Promise<void>;

package/dist/index.js

@@ -753,6 +753,7 @@ class PlaywrightBrowserProvider {
 	name = "playwright";
 	supportsParallelism = true;
 	browser = null;
+	persistentContext = null;
 	contexts = new Map();
 	pages = new Map();
 	mocker;
@@ -785,7 +786,7 @@ class PlaywrightBrowserProvider {
 			return Promise.allSettled(promises);
 		});
 	}
-	async openBrowser() {
+	async openBrowser(openBrowserOptions) {
 		await this._throwIfClosing();
 		if (this.browserPromise) {
 			debug?.("[%s] the browser is resolving, reusing the promise", this.browserName);
@@ -836,7 +837,22 @@ class PlaywrightBrowserProvider {
 				}
 			}
 			debug?.("[%s] initializing the browser with launch options: %O", this.browserName, launchOptions);
-			this.browser = await playwright[this.browserName].launch(launchOptions);
+			let persistentContextOption = this.options.persistentContext;
+			if (persistentContextOption && openBrowserOptions.parallel) {
+				persistentContextOption = false;
+				this.project.vitest.logger.warn(c.yellow(`The persistentContext option is ignored because tests are running in parallel.`));
+			}
+			if (persistentContextOption) {
+				const userDataDir = typeof this.options.persistentContext === "string" ? this.options.persistentContext : "./node_modules/.cache/vitest-playwright-user-data";
+				// TODO: how to avoid default "about" page?
+				this.persistentContext = await playwright[this.browserName].launchPersistentContext(userDataDir, {
+					...launchOptions,
+					...this.getContextOptions()
+				});
+				this.browser = this.persistentContext.browser();
+			} else {
+				this.browser = await playwright[this.browserName].launch(launchOptions);
+			}
 			this.browserPromise = null;
 			return this.browser;
 		})();
@@ -956,29 +972,22 @@ class PlaywrightBrowserProvider {
 			}
 		};
 	}
-	async createContext(sessionId) {
+	async createContext(sessionId, openBrowserOptions) {
 		await this._throwIfClosing();
 		if (this.contexts.has(sessionId)) {
 			debug?.("[%s][%s] the context already exists, reusing it", sessionId, this.browserName);
 			return this.contexts.get(sessionId);
 		}
-		const browser = await this.openBrowser();
+		const browser = await this.openBrowser(openBrowserOptions);
 		await this._throwIfClosing(browser);
 		const actionTimeout = this.options.actionTimeout;
-		const contextOptions = this.options.contextOptions ?? {};
-		const options = {
-			...contextOptions,
-			ignoreHTTPSErrors: true
-		};
-		if (this.project.config.browser.ui) {
-			options.viewport = null;
-		}
+		const options = this.getContextOptions();
 		// TODO: investigate the consequences for Vitest 5
 		// else {
 		// if UI is disabled, keep the iframe scale to 1
 		// options.viewport ??= this.project.config.browser.viewport
 		// }
-		const context = await browser.newContext(options);
+		const context = this.persistentContext ?? await browser.newContext(options);
 		await this._throwIfClosing(context);
 		if (actionTimeout != null) {
 			context.setDefaultTimeout(actionTimeout);
@@ -987,6 +996,17 @@ class PlaywrightBrowserProvider {
 		this.contexts.set(sessionId, context);
 		return context;
 	}
+	getContextOptions() {
+		const contextOptions = this.options.contextOptions ?? {};
+		const options = {
+			...contextOptions,
+			ignoreHTTPSErrors: true
+		};
+		if (this.project.config.browser.ui) {
+			options.viewport = null;
+		}
+		return options;
+	}
 	getPage(sessionId) {
 		const page = this.pages.get(sessionId);
 		if (!page) {
@@ -1020,7 +1040,7 @@ class PlaywrightBrowserProvider {
 			}
 		};
 	}
-	async openBrowserPage(sessionId) {
+	async openBrowserPage(sessionId, options) {
 		await this._throwIfClosing();
 		if (this.pages.has(sessionId)) {
 			debug?.("[%s][%s] the page already exists, closing the old one", sessionId, this.browserName);
@@ -1028,7 +1048,7 @@ class PlaywrightBrowserProvider {
 			await page.close();
 			this.pages.delete(sessionId);
 		}
-		const context = await this.createContext(sessionId);
+		const context = await this.createContext(sessionId, options);
 		const page = await context.newPage();
 		debug?.("[%s][%s] the page is ready", sessionId, this.browserName);
 		await this._throwIfClosing(page);
@@ -1040,9 +1060,9 @@ class PlaywrightBrowserProvider {
 		}
 		return page;
 	}
-	async openPage(sessionId, url) {
+	async openPage(sessionId, url, options) {
 		debug?.("[%s][%s] creating the browser page for %s", sessionId, this.browserName, url);
-		const browserPage = await this.openBrowserPage(sessionId);
+		const browserPage = await this.openBrowserPage(sessionId, options);
 		debug?.("[%s][%s] browser page is created, opening %s", sessionId, this.browserName, url);
 		await browserPage.goto(url, { timeout: 0 });
 		await this._throwIfClosing(browserPage);
@@ -1088,7 +1108,11 @@ class PlaywrightBrowserProvider {
 		this.browser = null;
 		await Promise.all([...this.pages.values()].map((p) => p.close()));
 		this.pages.clear();
-		await Promise.all([...this.contexts.values()].map((c) => c.close()));
+		if (this.persistentContext) {
+			await this.persistentContext.close();
+		} else {
+			await Promise.all([...this.contexts.values()].map((c) => c.close()));
+		}
 		this.contexts.clear();
 		await browser?.close();
 		debug?.("[%s] provider is closed", this.browserName);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/browser-playwright",
   "type": "module",
-  "version": "4.1.0-beta.1",
+  "version": "4.1.0-beta.2",
   "description": "Browser running for Vitest using playwright",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -42,7 +42,7 @@
   ],
   "peerDependencies": {
     "playwright": "*",
-    "vitest": "4.1.0-beta.1"
+    "vitest": "4.1.0-beta.2"
   },
   "peerDependenciesMeta": {
     "playwright": {
@@ -51,12 +51,12 @@
   },
   "dependencies": {
     "tinyrainbow": "^3.0.3",
-    "@vitest/browser": "4.1.0-beta.1",
-    "@vitest/mocker": "4.1.0-beta.1"
+    "@vitest/browser": "4.1.0-beta.2",
+    "@vitest/mocker": "4.1.0-beta.2"
   },
   "devDependencies": {
     "playwright": "^1.57.0",
-    "vitest": "4.1.0-beta.1"
+    "vitest": "4.1.0-beta.2"
   },
   "scripts": {
     "build": "premove dist && pnpm rollup -c",