Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: use bind to test dashboard (#40289)

Pavel Feldmanc1ce7404a530
diff --git a/packages/playwright-core/src/tools/cli-client/output.ts b/packages/playwright-core/src/tools/cli-client/output.ts
index 4d8584b5f7..39d49d24e6 100644
--- a/packages/playwright-core/src/tools/cli-client/output.ts
+++ b/packages/playwright-core/src/tools/cli-client/output.ts
@@ -22,6 +22,7 @@ import path from 'path';
import { remoteDebuggingHint } from './channelSessions';
import type { ChannelSession } from './channelSessions';
+import type { BrowserStatus } from '../../serverRegistry';
export type ListedBrowser = {
name: string;
@@ -36,19 +37,10 @@ export type ListedBrowser = {
version: string;
};
-export type ListedServer = {
- workspace: string;
- title: string;
- browser: string;
- playwrightVersion: string;
- status: 'open' | 'closed';
- userDataDir: string | null;
-};
-
export type ListData = {
all: boolean;
browsers: ListedBrowser[];
- servers?: ListedServer[];
+ servers?: BrowserStatus[];
channelSessions?: ChannelSession[];
};
@@ -145,12 +137,12 @@ export class TextOutput implements Output {
if (count)
console.log('');
console.log('### Browser servers available for attach');
- const serversByWorkspace = new Map<string, ListedServer[]>();
+ const serversByWorkspace = new Map<string, BrowserStatus[]>();
for (const server of servers) {
- let list = serversByWorkspace.get(server.workspace);
+ let list = serversByWorkspace.get(server.workspaceDir ?? '');
if (!list) {
list = [];
- serversByWorkspace.set(server.workspace, list);
+ serversByWorkspace.set(server.workspaceDir ?? '', list);
}
list.push(server);
}
@@ -356,13 +348,13 @@ function renderBrowser(browser: ListedBrowser): string {
return lines.join('\n');
}
-function renderServer(server: ListedServer): string {
+function renderServer(server: BrowserStatus): string {
const lines = [`- browser "${server.title}":`];
- lines.push(` - browser: ${server.browser}`);
+ lines.push(` - browser: ${server.browser.browserName}`);
lines.push(` - version: v${server.playwrightVersion}`);
- lines.push(` - status: ${server.status}`);
- if (server.userDataDir)
- lines.push(` - data-dir: ${server.userDataDir}`);
+ lines.push(` - status: ${server.canConnect ? 'open' : 'closed'}`);
+ if (server.browser.userDataDir)
+ lines.push(` - data-dir: ${server.browser.userDataDir}`);
else
lines.push(` - data-dir: <in-memory>`);
lines.push(` - run \`playwright-cli attach "${server.title}"\` to attach`);
diff --git a/packages/playwright-core/src/tools/cli-client/program.ts b/packages/playwright-core/src/tools/cli-client/program.ts
index bcbdcfe5ef..5a7dabd03a 100644
--- a/packages/playwright-core/src/tools/cli-client/program.ts
+++ b/packages/playwright-core/src/tools/cli-client/program.ts
@@ -29,7 +29,7 @@ import { libPath } from '../../package';
import { serverRegistry } from '../../serverRegistry';
import { minimist } from './minimist';
-import type { ListData, ListedBrowser, ListedServer, Output } from './output';
+import type { ListData, ListedBrowser, Output } from './output';
import type { ClientInfo, SessionFile } from './registry';
import type { MinimistArgs } from './minimist';
@@ -340,19 +340,7 @@ async function collectList(registry: Registry, clientInfo: ClientInfo, all: bool
return { all, browsers };
const serverEntries = await serverRegistry.list();
- const servers: ListedServer[] = [];
- for (const [workspaceKey, list] of serverEntries) {
- for (const descriptor of list) {
- servers.push({
- workspace: workspaceKey,
- title: descriptor.title,
- browser: descriptor.browser.browserName,
- playwrightVersion: descriptor.playwrightVersion,
- status: descriptor.canConnect ? 'open' : 'closed',
- userDataDir: descriptor.browser.userDataDir ?? null,
- });
- }
- }
+ const servers = [...serverEntries.values()].flat();
return { all, browsers, servers, channelSessions: await listChannelSessions() };
}
diff --git a/packages/playwright-core/src/tools/dashboard/dashboardApp.ts b/packages/playwright-core/src/tools/dashboard/dashboardApp.ts
index 89a918d122..fb1feba7e6 100644
--- a/packages/playwright-core/src/tools/dashboard/dashboardApp.ts
+++ b/packages/playwright-core/src/tools/dashboard/dashboardApp.ts
@@ -79,20 +79,20 @@ async function innerOpenDashboardApp(initialReveal: RevealOptions): Promise<{ pa
async function launchApp(appName: string) {
const channel = findChromiumChannelBestEffort('javascript');
- const debugPort = parseInt(process.env.PLAYWRIGHT_DASHBOARD_DEBUG_PORT!, 10) || undefined;
const context = await playwright.chromium.launchPersistentContext('', {
ignoreDefaultArgs: ['--enable-automation'],
channel,
- headless: debugPort !== undefined,
+ headless: !!process.env.PW_DASHBOARD_APP_BIND_TITLE,
args: [
'--app=data:text/html,',
'--test-type=',
`--window-size=1280,800`,
`--window-position=100,100`,
- ...(debugPort !== undefined ? [`--remote-debugging-port=${debugPort}`] : []),
],
viewport: null,
});
+ if (process.env.PW_DASHBOARD_APP_BIND_TITLE)
+ await context.browser()?.bind(process.env.PW_DASHBOARD_APP_BIND_TITLE, { workspaceDir: process.cwd() });
const [page] = context.pages();
// Chromium on macOS opens a new tab when clicking on the dock icon.
diff --git a/tests/mcp/dashboard.spec.ts b/tests/mcp/dashboard.spec.ts
index 33bd405f4e..34ce4d145a 100644
--- a/tests/mcp/dashboard.spec.ts
+++ b/tests/mcp/dashboard.spec.ts
@@ -92,16 +92,22 @@ function isAlive(pid: number): boolean {
}
}
-test('daemon show: closing page exits the process', async ({ playwright, cli, findFreePort, waitForPort }) => {
- const cdpPort = await findFreePort();
- const { exitCode, pid } = await cli('show', { env: { PLAYWRIGHT_PRINT_DASHBOARD_PID_FOR_TEST: '1', PLAYWRIGHT_DASHBOARD_DEBUG_PORT: String(cdpPort) } });
+test('daemon show: closing page exits the process', async ({ playwright, cli }) => {
+ const bindTitle = `--playwright-internal--${crypto.randomUUID()}`;
+ const { exitCode, pid } = await cli('show', { env: { PLAYWRIGHT_PRINT_DASHBOARD_PID_FOR_TEST: '1', PW_DASHBOARD_APP_BIND_TITLE: bindTitle } });
expect(exitCode).toBe(0);
expect(pid).toBeDefined();
expect(isAlive(pid!)).toBe(true);
- await waitForPort(cdpPort);
+ let endpoint = '';
+ await expect(async () => {
+ const { output } = await cli('list', '--all', '--json');
+ const { servers } = JSON.parse(output);
+ expect(servers[0].title).toBe(bindTitle);
+ endpoint = servers[0].endpoint;
+ }).toPass();
- const browser = await playwright.chromium.connectOverCDP(`http://127.0.0.1:${cdpPort}`);
+ const browser = await playwright.chromium.connect(endpoint);
const page = browser.contexts()[0].pages()[0];
await page.close();