Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore(devtools): delete user data (#39597)
Yury Semikhatsky114f3a296a78
diff --git a/packages/devtools/src/grid.tsx b/packages/devtools/src/grid.tsxindex 2dd8de1601..de27e32e25 100644--- a/packages/devtools/src/grid.tsx+++ b/packages/devtools/src/grid.tsx@@ -91,7 +91,7 @@ export const Grid: React.FC<{ model: SessionModel }> = ({ model }) => {</div>{isExpanded && (<div className='session-chips'>- {entries.map(session => <SessionChip key={session.browserDescriptor.pipeName} descriptor={session.browserDescriptor} wsUrl={session.wsUrl} visible={isExpanded} model={model} />)}+ {entries.map(session => <SessionChip key={session.browserDescriptor.guid} descriptor={session.browserDescriptor} wsUrl={session.wsUrl} visible={isExpanded} model={model} />)}</div>)}</div>@@ -103,7 +103,7 @@ export const Grid: React.FC<{ model: SessionModel }> = ({ model }) => {};const SessionChip: React.FC<{ descriptor: BrowserDescriptor; wsUrl: string | undefined; visible: boolean; model: SessionModel }> = ({ descriptor, wsUrl, visible, model }) => {- const href = '#session=' + encodeURIComponent(descriptor.pipeName!);+ const href = '#session=' + encodeURIComponent(descriptor.guid);const channel = React.useMemo(() => {if (!wsUrl || !visible)diff --git a/packages/devtools/src/index.tsx b/packages/devtools/src/index.tsxindex 99bd7acc6e..8bebaaba90 100644--- a/packages/devtools/src/index.tsx+++ b/packages/devtools/src/index.tsx@@ -60,7 +60,7 @@ const App: React.FC = () => {}, []);if (socketPath) {- const wsUrl = model.sessionBySocketPath(socketPath)?.wsUrl;+ const wsUrl = model.sessionByGuid(socketPath)?.wsUrl;return <DevTools wsUrl={wsUrl || undefined} />;}return <Grid model={model} />;diff --git a/packages/devtools/src/sessionModel.ts b/packages/devtools/src/sessionModel.tsindex f80a373977..869e378938 100644--- a/packages/devtools/src/sessionModel.ts+++ b/packages/devtools/src/sessionModel.ts@@ -66,8 +66,8 @@ export class SessionModel {}}- sessionBySocketPath(socketPath: string): SessionStatus | undefined {- return this.sessions.find(s => s.browserDescriptor.pipeName === socketPath);+ sessionByGuid(guid: string): SessionStatus | undefined {+ return this.sessions.find(s => s.browserDescriptor.guid === guid);}private async _fetchSessions() {@@ -103,7 +103,7 @@ export class SessionModel {await fetch('/api/sessions/close', {method: 'POST',headers: { 'Content-Type': 'application/json' },- body: JSON.stringify({ browserDescriptor: descriptor }),+ body: JSON.stringify({ sessionGuid: descriptor.guid }),});await this._fetchSessions();}@@ -112,7 +112,7 @@ export class SessionModel {await fetch('/api/sessions/delete-data', {method: 'POST',headers: { 'Content-Type': 'application/json' },- body: JSON.stringify({ browserDescriptor: descriptor }),+ body: JSON.stringify({ sessionGuid: descriptor.guid }),});await this._fetchSessions();}diff --git a/packages/playwright-core/src/cli/client/program.ts b/packages/playwright-core/src/cli/client/program.tsindex 7d3708393d..63705f9714 100644--- a/packages/playwright-core/src/cli/client/program.ts+++ b/packages/playwright-core/src/cli/client/program.ts@@ -338,7 +338,7 @@ async function killAllDaemons(): Promise<void> {async function listSessions(registry: Registry, clientInfo: ClientInfo, all: boolean): Promise<void> {if (all) {const entries = registry.entryMap();- const serverEntries = await serverRegistry.list({ gc: true });+ const serverEntries = await serverRegistry.list();if (entries.size === 0 && serverEntries.size === 0) {console.log('No browsers found.');return;diff --git a/packages/playwright-core/src/devtools/devtoolsApp.ts b/packages/playwright-core/src/devtools/devtoolsApp.tsindex 79bbd8df0d..4025f299af 100644--- a/packages/playwright-core/src/devtools/devtoolsApp.ts+++ b/packages/playwright-core/src/devtools/devtoolsApp.ts@@ -31,7 +31,6 @@ import { connectToBrowserAcrossVersions } from '../client/connect';import type * as api from '../..';import type { SessionStatus } from '@devtools/sessionModel';-import type { BrowserDescriptor } from '../serverRegistry';function readBody(request: http.IncomingMessage): Promise<any> {return new Promise((resolve, reject) => {@@ -49,11 +48,11 @@ function readBody(request: http.IncomingMessage): Promise<any> {});}-async function parseRequest(request: http.IncomingMessage): Promise<{ browserDescriptor: BrowserDescriptor }> {+async function parseRequest(request: http.IncomingMessage): Promise<{ sessionGuid: string }> {const body = await readBody(request);- if (!body.browserDescriptor)+ if (!body.sessionGuid)throw new Error('Dashboard app is too old, please close it and open again');- return { browserDescriptor: body.browserDescriptor };+ return { sessionGuid: body.sessionGuid };}function sendJSON(response: http.ServerResponse, data: any, statusCode = 200) {@@ -63,14 +62,14 @@ function sendJSON(response: http.ServerResponse, data: any, statusCode = 200) {}async function loadBrowserDescriptorSessions(wsPath: string): Promise<SessionStatus[]> {- const servers = await serverRegistry.list({ includeDisconnected: true });+ const servers = await serverRegistry.list();const sessions: SessionStatus[] = [];for (const [, browsers] of servers) {for (const browser of browsers) {let wsUrl: string | undefined;if (browser.canConnect) {const url = new URL(wsPath, 'http://localhost');- url.searchParams.set('browserDescriptor', JSON.stringify(browser));+ url.searchParams.set('sessionGuid', browser.guid);wsUrl = url.pathname + url.search;}sessions.push({ browserDescriptor: browser, wsUrl });@@ -79,7 +78,7 @@ async function loadBrowserDescriptorSessions(wsPath: string): Promise<SessionStareturn sessions;}-const socketPathToDevToolsConnection = new Map<string, DevToolsConnection>();+const browserGuidToDevToolsConnection = new Map<string, DevToolsConnection>();async function handleApiRequest(httpServer: HttpServer, request: http.IncomingMessage, response: http.ServerResponse) {const url = new URL(request.url!, httpServer.urlPrefix('human-readable'));@@ -92,9 +91,10 @@ async function handleApiRequest(httpServer: HttpServer, request: http.IncomingMe}if (apiPath === '/api/sessions/close' && request.method === 'POST') {- const { browserDescriptor } = await parseRequest(request);+ const { sessionGuid } = await parseRequest(request);let browser: api.Browser;try {+ const browserDescriptor = serverRegistry.readDescriptor(sessionGuid);browser = await connectToBrowserAcrossVersions(browserDescriptor);} catch (e) {sendJSON(response, { error: 'Failed to connect to browser socket: ' + e.message }, 500);@@ -112,6 +112,13 @@ async function handleApiRequest(httpServer: HttpServer, request: http.IncomingMe}if (apiPath === '/api/sessions/delete-data' && request.method === 'POST') {+ const { sessionGuid } = await parseRequest(request);+ try {+ await serverRegistry.deleteUserData(sessionGuid);+ } catch (e) {+ sendJSON(response, { error: 'Failed to delete session data: ' + e.message }, 500);+ return;+ }sendJSON(response, { success: true });return;}@@ -134,29 +141,27 @@ async function openDevToolsApp(): Promise<api.Page> {});httpServer.createWebSocket(url => {- const descriptorJson = url.searchParams.get('browserDescriptor');- if (!descriptorJson)+ const sessionGuid = url.searchParams.get('sessionGuid');+ if (!sessionGuid)throw new Error('Unsupported WebSocket URL: ' + url.toString());- const browserDescriptor = JSON.parse(descriptorJson) as BrowserDescriptor;+ const browserDescriptor = serverRegistry.readDescriptor(sessionGuid);const cdpPageId = url.searchParams.get('cdpPageId');if (cdpPageId) {- const socketPath = browserDescriptor.pipeName!;- const connection = socketPathToDevToolsConnection.get(socketPath);+ const connection = browserGuidToDevToolsConnection.get(sessionGuid);if (!connection)- throw new Error('CDP connection not found for socket path: ' + socketPath);+ throw new Error('CDP connection not found for session: ' + sessionGuid);const page = connection.pageForId(cdpPageId);if (!page)throw new Error('Page not found for page ID: ' + cdpPageId);return new CDPConnection(page);}- const socketPath = browserDescriptor.pipeName!;const cdpUrl = new URL(httpServer.urlPrefix('human-readable'));cdpUrl.pathname = httpServer.wsGuid()!;- cdpUrl.searchParams.set('browserDescriptor', descriptorJson);- const connection = new DevToolsConnection(browserDescriptor, cdpUrl, () => socketPathToDevToolsConnection.delete(socketPath));- socketPathToDevToolsConnection.set(socketPath, connection);+ cdpUrl.searchParams.set('sessionGuid', sessionGuid);+ const connection = new DevToolsConnection(browserDescriptor, cdpUrl, () => browserGuidToDevToolsConnection.delete(sessionGuid));+ browserGuidToDevToolsConnection.set(sessionGuid, connection);return connection;});diff --git a/packages/playwright-core/src/server/browser.ts b/packages/playwright-core/src/server/browser.tsindex f2a1af5d08..a324724824 100644--- a/packages/playwright-core/src/server/browser.ts+++ b/packages/playwright-core/src/server/browser.ts@@ -61,6 +61,7 @@ export type BrowserOptions = {wsEndpoint?: string; // Only there when connected over web socket.sdkLanguage?: Language;originalLaunchOptions: types.LaunchOptions;+ userDataDir?: string;};export abstract class Browser extends SdkObject {@@ -212,6 +213,7 @@ export class BrowserServer {private _wsServer?: PlaywrightWebSocketServer;private _pipeSocketPath?: string;private _isStarted = false;+ private _sessionGuid?: string;constructor(browser: Browser) {this._browser = browser;@@ -234,7 +236,7 @@ export class BrowserServer {result.wsEndpoint = await this._wsServer.listen(0, 'localhost', path);}- await serverRegistry.create(this._browser, {+ this._sessionGuid = await serverRegistry.create(this._browser, {title,wsEndpoint: result.wsEndpoint,pipeName: result.pipeName,@@ -244,7 +246,9 @@ export class BrowserServer {}async stop() {- await serverRegistry.delete(this._browser);+ if (this._sessionGuid)+ await serverRegistry.delete(this._browser, this._sessionGuid);+ this._sessionGuid = undefined;if (this._pipeSocketPath && process.platform !== 'win32')await fs.promises.unlink(this._pipeSocketPath).catch(() => {});await this._pipeServer?.close();diff --git a/packages/playwright-core/src/server/browserType.ts b/packages/playwright-core/src/server/browserType.tsindex d50d288503..ac90054934 100644--- a/packages/playwright-core/src/server/browserType.ts+++ b/packages/playwright-core/src/server/browserType.ts@@ -129,6 +129,7 @@ export abstract class BrowserType extends SdkObject {browserLogsCollector,wsEndpoint: transport instanceof WebSocketTransport ? transport.wsEndpoint : undefined,originalLaunchOptions: options,+ userDataDir: persistent ? userDataDir : undefined,};if (persistent)validateBrowserContextOptions(persistent, browserOptions);diff --git a/packages/playwright-core/src/serverRegistry.ts b/packages/playwright-core/src/serverRegistry.tsindex b13e743682..e9d28433e6 100644--- a/packages/playwright-core/src/serverRegistry.ts+++ b/packages/playwright-core/src/serverRegistry.ts@@ -18,6 +18,7 @@ import fs from 'fs';import net from 'net';import path from 'path';import os from 'os';+import crypto from 'crypto';import type { Browser } from './server/browser';import type { LaunchOptions } from './server/types';@@ -33,11 +34,13 @@ export type BrowserInfo = {};export type BrowserDescriptor = BrowserInfo & {+ guid: string;playwrightVersion: string;playwrightLib: string;browser: {browserName: BrowserName;launchOptions: LaunchOptions;+ userDataDir?: string;};};@@ -46,7 +49,7 @@ export type BrowserStatus = BrowserDescriptor & { canConnect: boolean };type BrowserEntry = BrowserStatus & { file: string };class ServerRegistry {- async list(options?: { gc?: boolean, includeDisconnected?: boolean }): Promise<Map<string, BrowserStatus[]>> {+ async list(): Promise<Map<string, BrowserStatus[]>> {const files = await fs.promises.readdir(this._browsersDir()).catch(() => []);const result = new Map<string, Promise<BrowserEntry>[]>();for (const file of files) {@@ -68,42 +71,65 @@ class ServerRegistry {const resolvedResult = new Map<string, BrowserStatus[]>();for (const [key, promises] of result) {const entries = await Promise.all(promises);- if (options?.gc) {- for (const entry of entries) {- if (!entry.canConnect)- await fs.promises.unlink(entry.file).catch(() => {});+ const descriptors = [];+ for (const entry of entries) {+ if (!entry.canConnect && !entry.browser.userDataDir) {+ await fs.promises.unlink(entry.file).catch(() => {});+ continue;}+ descriptors.push(entry);}- const list = options?.includeDisconnected ? entries : entries.filter(entry => entry.canConnect);- if (list.length)- resolvedResult.set(key, list);+ if (descriptors.length)+ resolvedResult.set(key, descriptors);}return resolvedResult;}- async create(browser: Browser, info: BrowserInfo): Promise<void> {- const file = path.join(this._browsersDir(), browser.guid);+ async create(browser: Browser, info: BrowserInfo): Promise<string> {+ const guid = createGuid();+ const file = path.join(this._browsersDir(), guid);await fs.promises.mkdir(this._browsersDir(), { recursive: true });const descriptor: BrowserDescriptor = {+ guid,playwrightVersion: packageVersion,playwrightLib: require.resolve('..'),title: info.title,browser: {browserName: browser.options.browserType,launchOptions: browser.options.originalLaunchOptions,+ userDataDir: browser.options.userDataDir,},wsEndpoint: info.wsEndpoint,pipeName: info.pipeName,workspaceDir: info.workspaceDir,};await fs.promises.writeFile(file, JSON.stringify(descriptor), 'utf-8');+ return guid;}- async delete(browser: Browser): Promise<void> {- const file = path.join(this._browsersDir(), browser.guid);+ async delete(browser: Browser, sessionGuid: string): Promise<void> {+ if (browser.options.userDataDir)+ return;+ const file = path.join(this._browsersDir(), sessionGuid);await fs.promises.unlink(file).catch(() => {});}+ async deleteUserData(sessionGuid: string): Promise<void> {+ const filePath = path.join(this._browsersDir(), sessionGuid);+ const content = await fs.promises.readFile(filePath, 'utf-8');+ const descriptor: BrowserDescriptor = JSON.parse(content);+ if (descriptor.browser.userDataDir)+ await fs.promises.rm(descriptor.browser.userDataDir, { recursive: true, force: true });+ await fs.promises.unlink(filePath);+ }++ readDescriptor(sessionGuid: string): BrowserDescriptor {+ const filePath = path.join(this._browsersDir(), sessionGuid);+ const content = fs.readFileSync(filePath, 'utf-8');+ const descriptor: BrowserDescriptor = JSON.parse(content);+ return descriptor;+ }+async find(name: string): Promise<BrowserDescriptor | null> {const entries = await this.list();for (const [, browsers] of entries) {@@ -120,6 +146,10 @@ class ServerRegistry {}}+function createGuid(): string {+ return crypto.randomBytes(16).toString('hex');+}+async function canConnect(descriptor: BrowserDescriptor): Promise<boolean> {if (descriptor.pipeName) {return await new Promise(resolve => {diff --git a/tests/library/browser-server.spec.ts b/tests/library/browser-server.spec.tsindex 4d082134d0..bd605a0ce3 100644--- a/tests/library/browser-server.spec.ts+++ b/tests/library/browser-server.spec.ts@@ -25,10 +25,6 @@ it.beforeEach(({}, testInfo) => {process.env.PLAYWRIGHT_SERVER_REGISTRY = testInfo.outputPath('registry');});-function descriptorPath(browser: any) {- return path.join(it.info().outputPath('registry'), browser._guid);-}-it('should start and stop pipe server', async ({ browserType, browser }) => {const serverInfo = await (browser as any)._startServer('default', {});expect(serverInfo).toEqual(expect.objectContaining({@@ -61,11 +57,12 @@ it('should start and stop ws server', async ({ browserType, browser }) => {});it('should write descriptor on start and remove on stop', async ({ browser }) => {- const file = descriptorPath(browser);- expect(fs.existsSync(file)).toBe(false);-const serverInfo = await (browser as any)._startServer('my-title', { wsPath: 'test' });+ const registryDir = it.info().outputPath('registry');+ const fileName = fs.readdirSync(registryDir)[0];+ const file = path.join(registryDir, fileName);+const descriptor = JSON.parse(fs.readFileSync(file, 'utf-8'));expect(descriptor.title).toBe('my-title');expect(descriptor.playwrightVersion).toBeTruthy();