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(cli): require explicit target for attach (#40418)
Pavel Feldman8d548bcd48d1
diff --git a/packages/dashboard/src/dashboardChannel.ts b/packages/dashboard/src/dashboardChannel.tsindex 5f117a8892..870cbc29d3 100644--- a/packages/dashboard/src/dashboardChannel.ts+++ b/packages/dashboard/src/dashboardChannel.ts@@ -15,9 +15,9 @@*/import type { ClientInfo } from '../../playwright-core/src/tools/cli-client/registry';-import type { BrowserStatus } from '../../playwright-core/src/serverRegistry';+import type { BrowserDescriptor } from '../../playwright-core/src/serverRegistry';-export type SessionStatus = BrowserStatus;+export type SessionStatus = BrowserDescriptor;export type Tab = {browser: string;diff --git a/packages/dashboard/src/sessionSidebar.tsx b/packages/dashboard/src/sessionSidebar.tsxindex 991132b5f7..74ee1bde6f 100644--- a/packages/dashboard/src/sessionSidebar.tsx+++ b/packages/dashboard/src/sessionSidebar.tsx@@ -78,7 +78,7 @@ const TabRow: React.FC<{ tab: Tab; model: DashboardModel }> = ({ tab, model }) =export const SessionSidebar: React.FC<SessionSidebarProps> = ({ model }) => {const { sessions, clientInfo, loadingSessions, tabs: allTabs } = model.state;- const openSessions = React.useMemo(() => sessions.filter(session => session.canConnect), [sessions]);+ const openSessions = sessions;const tabsByBrowserAndContext = React.useMemo(() => {const map = new Map<string, Map<string, Tab[]>>();diff --git a/packages/playwright-core/src/serverRegistry.ts b/packages/playwright-core/src/serverRegistry.tsindex 576a37886f..98a82863fb 100644--- a/packages/playwright-core/src/serverRegistry.ts+++ b/packages/playwright-core/src/serverRegistry.ts@@ -89,7 +89,7 @@ class ServerRegistry extends EventEmitter {return this._ready ?? Promise.resolve();}- async list(): Promise<Map<string, BrowserStatus[]>> {+ async list(): Promise<Map<string, BrowserDescriptor[]>> {const ownWatcher = !this._watcher;let dispose: (() => void) | undefined;if (ownWatcher)@@ -102,7 +102,7 @@ class ServerRegistry extends EventEmitter {return { descriptor, canConnect };}),);- const result = new Map<string, BrowserStatus[]>();+ const result = new Map<string, BrowserDescriptor[]>();for (const { descriptor, canConnect } of statuses) {if (!canConnect) {await fs.promises.unlink(path.join(this._browsersDir(), descriptor.browser.guid)).catch(() => {});@@ -114,7 +114,7 @@ class ServerRegistry extends EventEmitter {list = [];result.set(key, list);}- list.push({ ...descriptor, canConnect });+ list.push(descriptor);}return result;} finally {@@ -133,7 +133,7 @@ class ServerRegistry extends EventEmitter {endpoint: endpoint.endpoint,workspaceDir: endpoint.workspaceDir,};- await fs.promises.writeFile(file, JSON.stringify(descriptor), 'utf-8');+ await fs.promises.writeFile(file, JSON.stringify(descriptor, null, 2), 'utf-8');}async delete(guid: string): Promise<void> {diff --git a/packages/playwright-core/src/tools/cli-client/output.ts b/packages/playwright-core/src/tools/cli-client/output.tsindex 562041b263..9e1b7b586c 100644--- a/packages/playwright-core/src/tools/cli-client/output.ts+++ b/packages/playwright-core/src/tools/cli-client/output.ts@@ -22,7 +22,7 @@ import path from 'path';import { playwrightExtensionInstallUrl } from '../utils/extension';import type { ChannelSession } from './channelSessions';-import type { BrowserStatus } from '../../serverRegistry';+import type { BrowserDescriptor } from '../../serverRegistry';export type ListedBrowser = {name: string;@@ -40,7 +40,7 @@ export type ListedBrowser = {export type ListData = {all: boolean;browsers: ListedBrowser[];- servers?: BrowserStatus[];+ servers?: BrowserDescriptor[];channelSessions?: ChannelSession[];};@@ -55,6 +55,7 @@ export interface Output {errorAttachConflict(): never;errorDetachNotAttached(session: string): never;errorBrowserNotOpenForTool(session: string): never;+ errorAttachNoTarget(): never;list(data: ListData): void;closeAll(sessions: string[]): void;@@ -112,6 +113,11 @@ export class TextOutput implements Output {return process.exit(1);}+ errorAttachNoTarget(): never {+ console.error(`Error: no target specified for attach command; use one of [name], --cdp, --endpoint, or --extension to specify the target to attach to.`);+ return process.exit(1);+ }+list({ all, browsers, servers, channelSessions }: ListData): void {const byWorkspace = new Map<string, ListedBrowser[]>();for (const browser of browsers) {@@ -144,7 +150,7 @@ export class TextOutput implements Output {if (count)console.log('');console.log('### Browser servers available for attach');- const serversByWorkspace = new Map<string, BrowserStatus[]>();+ const serversByWorkspace = new Map<string, BrowserDescriptor[]>();for (const server of servers) {let list = serversByWorkspace.get(server.workspaceDir ?? '');if (!list) {@@ -204,7 +210,8 @@ export class TextOutput implements Output {attach(session: string, pid: number | undefined, endpoint: string | undefined, toolResult: string): void {if (endpoint) {console.log(`### Session \`${session}\` created, attached to \`${endpoint}\`.`);- console.log(`Run commands with: playwright-cli --session=${session} <command>`);+ console.log(`Run commands with: playwright-cli --s=${session} <command>`);+ console.log('');} else {console.log(`### Browser \`${session}\` opened with pid ${pid}.`);}@@ -282,6 +289,11 @@ export class JsonOutput implements Output {return process.exit(1);}+ errorAttachNoTarget(): never {+ this._emit({ isError: true, error: `no target specified for attach command; use one of [name], --cdp, --endpoint, or --extension to specify the target to attach to.` });+ return process.exit(1);+ }+list({ all, browsers, servers, channelSessions }: ListData): void {const payload: Record<string, unknown> = { browsers };if (all) {@@ -372,11 +384,10 @@ function renderBrowser(browser: ListedBrowser): string {return lines.join('\n');}-function renderServer(server: BrowserStatus): string {+function renderServer(server: BrowserDescriptor): string {const lines = [`- browser "${server.title}":`];lines.push(` - browser: ${server.browser.browserName}`);lines.push(` - version: v${server.playwrightVersion}`);- lines.push(` - status: ${server.canConnect ? 'open' : 'closed'}`);if (server.browser.userDataDir)lines.push(` - data-dir: ${server.browser.userDataDir}`);elsediff --git a/packages/playwright-core/src/tools/cli-client/program.ts b/packages/playwright-core/src/tools/cli-client/program.tsindex cf9817e0b5..88fee00f5a 100644--- a/packages/playwright-core/src/tools/cli-client/program.ts+++ b/packages/playwright-core/src/tools/cli-client/program.ts@@ -160,18 +160,22 @@ export async function program(options?: { embedderVersion?: string}) {output.errorAttachConflict();if (attachTarget)args.endpoint = attachTarget;- const extensionChannel = typeof args.extension === 'string' && isKnownChannel(args.extension) ? args.extension : undefined;- if (typeof args.extension === 'string') {- args.browser = args.extension;+ const extensionChannel = typeof args.extension === 'string' ? args.extension : undefined;+ if (extensionChannel) {+ args.browser = extensionChannel;args.extension = true;}+const cdpChannel = typeof args.cdp === 'string' && isKnownChannel(args.cdp) ? args.cdp : undefined;+ const targetName = attachTarget ?? cdpChannel ?? extensionChannel ?? args.cdp as string;+ if (!targetName)+ output.errorAttachNoTarget();const attachSessionName = explicitSessionName(args.session as string) ?? attachTarget ?? cdpChannel ?? extensionChannel ?? sessionName;args.session = attachSessionName;- const { pid, endpoint } = await startSession(attachSessionName, registry, clientInfo, args, 'attach');+ const { pid } = await startSession(attachSessionName, registry, clientInfo, args, 'attach');const newEntry = await registry.loadEntry(clientInfo, attachSessionName);const toolText = await runInSession(newEntry, clientInfo, { _: ['snapshot'], filename: '<auto>' }, output);- output.attach(attachSessionName, pid, endpoint, toolText);+ output.attach(attachSessionName, pid, targetName, toolText);return;}case 'close': {@@ -341,6 +345,9 @@ async function killAllDaemons(): Promise<number[]> {async function collectList(registry: Registry, clientInfo: ClientInfo, all: boolean): Promise<ListData> {const browsers: ListedBrowser[] = [];const entries = registry.entryMap();++ // List early to GC.+ const serverEntries = await serverRegistry.list();const key = clientKey(clientInfo);for (const [workspaceKey, list] of entries) {if (!all && workspaceKey !== key)@@ -348,7 +355,7 @@ async function collectList(registry: Registry, clientInfo: ClientInfo, all: boolfor (const entry of list) {const session = new Session(entry);const canConnect = await session.canConnect();- if (!canConnect && !session.config.cli.persistent) {+ if (!canConnect) {await session.deleteSessionConfig();continue;}@@ -372,7 +379,6 @@ async function collectList(registry: Registry, clientInfo: ClientInfo, all: boolif (!all)return { all, browsers };- const serverEntries = await serverRegistry.list();const servers = [...serverEntries.values()].flat();return { all, browsers, servers, channelSessions: await listChannelSessions() };}diff --git a/packages/playwright-core/src/tools/cli-client/skill/SKILL.md b/packages/playwright-core/src/tools/cli-client/skill/SKILL.mdindex 7d1fddbbc2..bde0b60004 100644--- a/packages/playwright-core/src/tools/cli-client/skill/SKILL.md+++ b/packages/playwright-core/src/tools/cli-client/skill/SKILL.md@@ -209,8 +209,8 @@ playwright-cli open --persistent# Use persistent profile with custom directoryplaywright-cli open --profile=/path/to/profile-# Connect to browser via extension-playwright-cli attach --extension+# Connect to browser via Playwright Extension+playwright-cli attach --extension=chrome# Connect to a running Chrome or Edge by channel nameplaywright-cli attach --cdp=chromediff --git a/packages/playwright-core/src/tools/cli-daemon/commands.ts b/packages/playwright-core/src/tools/cli-daemon/commands.tsindex 5e55b3bce9..a83d53ddf2 100644--- a/packages/playwright-core/src/tools/cli-daemon/commands.ts+++ b/packages/playwright-core/src/tools/cli-daemon/commands.ts@@ -888,9 +888,9 @@ const videoChapter = declareCommand({toolParams: ({ title, description, duration }) => ({ title, description, duration }),});-const devtoolsShow = declareCommand({+const dashboardShow = declareCommand({name: 'show',- description: 'Show browser DevTools',+ description: 'Show Playwright Dashboard',category: 'devtools',args: z.object({}),options: z.object({@@ -1111,7 +1111,7 @@ const commandsArray: AnyCommandSchema[] = [videoStart,videoStop,videoChapter,- devtoolsShow,+ dashboardShow,pauseAt,resume,stepOver,diff --git a/packages/playwright-core/src/tools/dashboard/dashboardController.ts b/packages/playwright-core/src/tools/dashboard/dashboardController.tsindex 09e9da2ea1..f5c5af5c9a 100644--- a/packages/playwright-core/src/tools/dashboard/dashboardController.ts+++ b/packages/playwright-core/src/tools/dashboard/dashboardController.ts@@ -28,7 +28,7 @@ import { createClientInfo } from '../cli-client/registry';import type * as api from '../../..';import type { Transport } from '@utils/httpServer';import type { AnnotationData, Tab } from '@dashboard/dashboardChannel';-import type { BrowserDescriptor, BrowserStatus } from '../../serverRegistry';+import type { BrowserDescriptor } from '../../serverRegistry';type BrowserTrackerCallbacks = {onTabsChanged: () => void;@@ -274,7 +274,7 @@ export class DashboardConnection implements Transport {return this._visible;}- emitSessions(sessions: BrowserStatus[]) {+ emitSessions(sessions: BrowserDescriptor[]) {this.sendEvent?.('sessions', { sessions, clientInfo: createClientInfo() });}@@ -379,7 +379,7 @@ export class DashboardConnection implements Transport {this._pushSessionsScheduled = false;try {const byWs = await serverRegistry.list();- const sessions: BrowserStatus[] = [];+ const sessions: BrowserDescriptor[] = [];for (const list of byWs.values()) {for (const status of list) {if (status.title.startsWith('--playwright-internal'))@@ -397,12 +397,10 @@ export class DashboardConnection implements Transport {});};- private async _reconcile(sessions: BrowserStatus[]) {- const connectable = new Map<string, BrowserStatus>();- for (const status of sessions) {- if (status.canConnect)- connectable.set(status.browser.guid, status);- }+ private async _reconcile(sessions: BrowserDescriptor[]) {+ const connectable = new Map<string, BrowserDescriptor>();+ for (const status of sessions)+ connectable.set(status.browser.guid, status);for (const [guid, slot] of this._browsers) {if (connectable.has(guid))diff --git a/tests/extension/cli.spec.ts b/tests/extension/cli.spec.tsindex 44df0621f5..4125b667f3 100644--- a/tests/extension/cli.spec.ts+++ b/tests/extension/cli.spec.ts@@ -34,7 +34,7 @@ const test = base.extend<{const confirmationPagePromise = browserContext.waitForEvent('page', page =>page.url().startsWith(`chrome-extension://${extensionId}/connect.html`));- const cliPromise = cli('attach', '--extension', `--config=cli-config.json`);+ const cliPromise = cli('attach', '--extension=chromium', `--config=cli-config.json`);const confirmationPage = await confirmationPagePromise;return { confirmationPage, cliPromise };});@@ -81,7 +81,7 @@ test('attach <url> --extension', async ({ startAttach, cli, server }) => {}{- const { output } = await cli('goto', server.HELLO_WORLD);+ const { output } = await cli('-s=chromium', 'goto', server.HELLO_WORLD);expect(output).toContain(`### Page`);expect(output).toContain(`- Page URL: ${server.HELLO_WORLD}`);expect(output).toContain(`- Page Title: Title`);diff --git a/tests/mcp/cli-cdp.spec.ts b/tests/mcp/cli-cdp.spec.tsindex 8d32e88437..a2f5c3a6ef 100644--- a/tests/mcp/cli-cdp.spec.ts+++ b/tests/mcp/cli-cdp.spec.ts@@ -93,10 +93,9 @@ test('cdp server', async ({ cdpServer, cli, server }) => {const configPath = test.info().outputPath('config.ini');await fs.promises.writeFile(configPath, `-browser.cdpEndpoint=${cdpServer.endpoint}browser.isolated=false`);- await cli('attach', `--config=${configPath}`);+ await cli('attach', `--cdp=${cdpServer.endpoint}`, `--config=${configPath}`);const { inlineSnapshot } = await cli('snapshot');expect(inlineSnapshot).toContain(`- generic [active] [ref=e1]: Hello, world!`);});diff --git a/tests/mcp/cli-session.spec.ts b/tests/mcp/cli-session.spec.tsindex 00f8ff7538..a299f81f08 100644--- a/tests/mcp/cli-session.spec.ts+++ b/tests/mcp/cli-session.spec.ts@@ -69,19 +69,6 @@ test('close non-running session', async ({ cli }) => {expect(output).toContain(`Browser 'nonexistent' is not open.`);});-test('persistent session shows in list after close', async ({ cli, server }) => {- await cli('open', server.HELLO_WORLD, '--persistent');-- const { output: listBefore } = await cli('list');- expect(listBefore).toContain('- default:');- expect(listBefore).not.toContain('<in-memory>');-- await cli('close');-- const { output: listAfter } = await cli('list');- expect(listAfter).toContain('- default:');-});-test('close-all', async ({ cli, server }) => {await cli('-s', 'session1', 'open', server.HELLO_WORLD);await cli('-s', 'session2', 'open', server.HELLO_WORLD);@@ -310,7 +297,6 @@ workspace1:- browser "foobar":- browser: ${/* FIX browser._options */ mcpBrowser.replace('chrome', 'chromium')}- version: ${version}- - status: open- data-dir: <in-memory>- run \`playwright-cli attach "foobar"\` to attach`);});@@ -323,7 +309,7 @@ workspace1:await page.setContent('<title>My Page</title>');const { output: openOutput } = await cli('attach', 'foobar');expect(openOutput).toContain('### Session `foobar` created, attached to `foobar`.');- expect(openOutput).toContain('Run commands with: playwright-cli --session=foobar <command>');+ expect(openOutput).toContain('Run commands with: playwright-cli --s=foobar <command>');const { output: listOutput } = await cli('list', '--all');expect(listOutput).toBe(`### Browsers/:@@ -336,7 +322,6 @@ workspace1:- browser "foobar":- browser: ${mcpBrowser.replace('chrome', 'chromium')}- version: ${version}- - status: open- data-dir: <in-memory>- run \`playwright-cli attach "foobar"\` to attach`);});@@ -349,33 +334,6 @@ workspace1:expect(error).toContain('Error: unable to connect to a browser that does not have any contexts');});- test('attach via PLAYWRIGHT_CLI_SESSION env', async ({ cli, mcpBrowser }) => {- const browserName = mcpBrowser.replace('chrome', 'chromium');- await using browser = await playwright[browserName].launch({ headless: true });- const page = await browser.newPage();- await page.setContent('<title>Env Page</title><h1>Hello from env</h1>');- await browser.bind('foobar', { workspaceDir: 'workspace1' });- const { output: openOutput, snapshot } = await cli('attach', { env: { PLAYWRIGHT_CLI_SESSION: 'foobar' } });- expect(openOutput).toContain('### Browser `foobar` opened with pid');- expect(openOutput).toContain('Env Page');- expect(snapshot).toContain('Hello from env');- const { output: listOutput } = await cli('list', '--all');- expect(listOutput).toBe(`### Browsers-/:-- foobar:- - status: open- - browser-type: ${mcpBrowser.replace('chrome', 'chromium')} (attached)--### Browser servers available for attach-workspace1:-- browser "foobar":- - browser: ${mcpBrowser.replace('chrome', 'chromium')}- - version: ${version}- - status: open- - data-dir: <in-memory>- - run \`playwright-cli attach "foobar"\` to attach`);- });-test('attach with session alias', async ({ cli, mcpBrowser }) => {const browserName = mcpBrowser.replace('chrome', 'chromium');await using browser = await playwright[browserName].launch({ headless: true });@@ -384,7 +342,7 @@ workspace1:await page.setContent('<title>Alias Page</title>');const { output: openOutput } = await cli('attach', 'foobar', '--session=mybrowser');expect(openOutput).toContain('### Session `mybrowser` created, attached to `foobar`.');- expect(openOutput).toContain('Run commands with: playwright-cli --session=mybrowser <command>');+ expect(openOutput).toContain('Run commands with: playwright-cli --s=mybrowser <command>');await cli('-s', 'mybrowser', 'close');});@@ -402,7 +360,6 @@ workspace1:- browser \"foobar\":- browser: ${/* FIX browser._options */ mcpBrowser.replace('chrome', 'chromium')}- version: ${version}- - status: open- data-dir: <in-memory>- run \`playwright-cli attach \"foobar\"\` to attach`);});