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
fix(dashboard): block `show -s` until the controller acks the reveal (#40902)
Simon Knotta5126302a672
diff --git a/packages/playwright-core/src/tools/cli-client/program.ts b/packages/playwright-core/src/tools/cli-client/program.tsindex 8c4de36b1b..1eb3e7c4a6 100644--- a/packages/playwright-core/src/tools/cli-client/program.ts+++ b/packages/playwright-core/src/tools/cli-client/program.ts@@ -204,9 +204,16 @@ export async function program(options?: { embedderVersion?: string}) {const daemonScript = libPath('entry', 'dashboardApp.js');const daemonArgs = [daemonScript,- `--sessionName=${sessionName}`,`--workspaceDir=${clientInfo.workspaceDir ?? ''}`,];+ // Only pass --sessionName when the user explicitly requested a session+ // (via -s/--session or PLAYWRIGHT_CLI_SESSION). Bare `playwright cli show`+ // opens the dashboard generically, with no specific session to reveal,+ // so the daemon should ack as soon as it's ready rather than waiting for+ // a reveal that was never asked for.+ const explicit = explicitSessionName(args.session as string);+ if (explicit)+ daemonArgs.push(`--sessionName=${explicit}`);if (args.port !== undefined)daemonArgs.push(`--port=${args.port}`);if (args.host !== undefined)diff --git a/packages/playwright-core/src/tools/dashboard/dashboardApp.ts b/packages/playwright-core/src/tools/dashboard/dashboardApp.tsindex 26afa59aae..892b9e9df3 100644--- a/packages/playwright-core/src/tools/dashboard/dashboardApp.ts+++ b/packages/playwright-core/src/tools/dashboard/dashboardApp.ts@@ -22,6 +22,7 @@ import http from 'http';import { HttpServer } from '@utils/httpServer';import { makeSocketPath } from '@utils/fileUtils';import { gracefullyProcessExitDoNotHang } from '@utils/processLauncher';+import { ManualPromise } from '@isomorphic/manualPromise';import { libPath } from '../../package';import { playwright } from '../../inprocess';import { findChromiumChannelBestEffort, registryDirectory } from '../../server/registry/index';@@ -41,9 +42,8 @@ declare const __PW_HMR__: boolean;type DashboardServer = {url: string;- reveal: (options: DashboardOptions) => void;- triggerAnnotate: () => void;- registerAnnotateWaiter: (socket: net.Socket) => void;+ reveal: (options: DashboardOptions) => Promise<void>;+ triggerAnnotate: (socket: net.Socket) => Promise<void>;close: () => Promise<void>;};@@ -52,8 +52,7 @@ async function startDashboardServer(provider: SessionProvider, options: Dashboarconst httpServer = new HttpServer(dashboardDir);const connections = new Set<DashboardConnection>();- let currentReveal: DashboardOptions = options;- let pendingAnnotate = false;+ let connectionLanded = new ManualPromise<void>();const waitingSockets = new Set<net.Socket>();const submitAnnotation = (frames: SubmittedAnnotationFrame[], feedback: string) => {@@ -70,15 +69,12 @@ async function startDashboardServer(provider: SessionProvider, options: DashboarhttpServer.createWebSocket(() => {let connection: DashboardConnection;// eslint-disable-next-line prefer-const- connection = new DashboardConnection(provider, () => connections.delete(connection), () => {- if (currentReveal.pageId)- connection.revealPage(currentReveal.pageId);- else if (currentReveal.sessionName)- connection.revealSession(currentReveal.sessionName, currentReveal.workspaceDir);- if (pendingAnnotate) {- pendingAnnotate = false;- connection.emitAnnotate();- }+ connection = new DashboardConnection(provider, () => {+ connections.delete(connection);+ if (connections.size === 0)+ connectionLanded = new ManualPromise<void>();+ }, () => {+ connectionLanded.resolve();}, submitAnnotation);connections.add(connection);return connection;@@ -102,48 +98,38 @@ async function startDashboardServer(provider: SessionProvider, options: DashboarattachDashboardStaticServer(httpServer, dashboardDir);await httpServer.start({ port: options.port, host: options.host });- const reveal = (next: DashboardOptions) => {- currentReveal = next;- if (next.pageId) {- for (const connection of connections)- connection.revealPage(next.pageId);- return;- }- if (!next.sessionName)- return;- for (const connection of connections)- connection.revealSession(next.sessionName, next.workspaceDir);+ const reveal = async (next: DashboardOptions): Promise<void> => {+ await connectionLanded;+ await Promise.all([...connections].map(async c => {+ if (next.pageId)+ await c.revealPage(next.pageId);+ else if (next.sessionName)+ await c.revealSession(next.sessionName, next.workspaceDir);+ }));};- const triggerAnnotate = () => {- if (connections.size === 0) {- pendingAnnotate = true;- return;- }- for (const connection of connections)- connection.emitAnnotate();- };-- const notifyAnnotateEnded = () => {- pendingAnnotate = false;- for (const connection of connections)- connection.emitCancelAnnotate();- };-- const registerAnnotateWaiter = (socket: net.Socket) => {+ const triggerAnnotate = async (socket: net.Socket) => {waitingSockets.add(socket);const cleanup = () => {if (!waitingSockets.delete(socket))return;- if (waitingSockets.size === 0)- notifyAnnotateEnded();+ if (waitingSockets.size === 0) {+ for (const connection of connections)+ connection.emitCancelAnnotate();+ }};socket.on('close', cleanup);socket.on('error', cleanup);++ await connectionLanded;+ if (waitingSockets.size === 0)+ return;+ for (const connection of connections)+ connection.emitAnnotate();};const close = () => httpServer.stop();- return { url: httpServer.urlPrefix('human-readable'), reveal, triggerAnnotate, registerAnnotateWaiter, close };+ return { url: httpServer.urlPrefix('human-readable'), reveal, triggerAnnotate, close };}function attachDashboardStaticServer(httpServer: HttpServer, dashboardDir: string) {@@ -168,6 +154,7 @@ async function attachDashboardDevServer(httpServer: HttpServer) {async function innerOpenDashboardApp(options: DashboardOptions): Promise<{ page: api.Page; server: DashboardServer }> {const server = await startDashboardServer(new RegistrySessionProvider(), options);+ void server.reveal(options).catch(() => {});const { page } = await launchApp('dashboard', { onClose: () => gracefullyProcessExitDoNotHang(0) });await page.goto(server.url);return { page, server };@@ -279,8 +266,8 @@ async function acquireSingleton(options: DashboardOptions): Promise<net.Server>return reject(err);const client = net.connect(socketPath, () => {client.write(JSON.stringify(options) + '\n');- reject(new Error('already running'));});+ client.on('end', () => reject(new Error('already running')));client.on('error', () => {if (process.platform !== 'win32')fs.unlinkSync(socketPath);@@ -305,9 +292,10 @@ export async function openDashboardApp() {console.error('Unhandled promise rejection:', error);});if (options.port !== undefined) {- const { url } = await startDashboardServer(new RegistrySessionProvider(), options);+ const server = await startDashboardServer(new RegistrySessionProvider(), options);+ void server.reveal(options).catch(() => {});// eslint-disable-next-line no-console- console.log(`Listening on ${url}`);+ console.log(`Listening on ${server.url}`);// eslint-disable-next-line no-restricted-propertiesawait new Promise(f => process.stdout.write('', f)); // Make sure stdout is flushed.selfDestructOnParentGone();@@ -345,7 +333,7 @@ async function startApp(server: net.Server, options: DashboardOptions) {const statePromise = innerOpenDashboardApp(options);server.on('connection', socket => {let buffer = '';- socket.on('data', data => {+ socket.on('data', async data => {buffer += data.toString();const newlineIndex = buffer.indexOf('\n');if (newlineIndex === -1)@@ -362,21 +350,27 @@ async function startApp(server: net.Server, options: DashboardOptions) {socket.end();return;}- void statePromise.then(({ page, server: dashboard }) => {- if (parsed.annotate) {- page?.bringToFront().catch(() => {});- dashboard.reveal(parsed);- dashboard.triggerAnnotate();- dashboard.registerAnnotateWaiter(socket);- } else if (parsed.kill) {- socket.end();- gracefullyProcessExitDoNotHang(0);- } else {- page?.bringToFront().catch(() => {});- dashboard.reveal(parsed);+ const { page, server: dashboard } = await statePromise;+ if (parsed.annotate) {+ try {+ await page?.bringToFront();+ await dashboard.reveal(parsed);+ await dashboard.triggerAnnotate(socket);+ } catch (e) {+ socket.end(e);+ }+ } else if (parsed.kill) {+ socket.end();+ gracefullyProcessExitDoNotHang(0);+ } else {+ try {+ await page?.bringToFront();+ await dashboard.reveal(parsed);socket.end();+ } catch (e) {+ socket.end(e);}- });+ }});});await statePromise;diff --git a/packages/playwright-core/src/tools/dashboard/dashboardController.ts b/packages/playwright-core/src/tools/dashboard/dashboardController.tsindex b11df9415d..dfa9bc2216 100644--- a/packages/playwright-core/src/tools/dashboard/dashboardController.ts+++ b/packages/playwright-core/src/tools/dashboard/dashboardController.ts@@ -20,6 +20,7 @@ import fs from 'fs';import crypto from 'crypto';import { execFile } from 'child_process';import { Disposable } from '@isomorphic/disposable';+import { ManualPromise } from '@isomorphic/manualPromise';import { eventsHelper } from '@utils/eventsHelper';import { createClientInfo } from '../cli-client/registry';@@ -42,7 +43,7 @@ export class DashboardConnection implements Transport {private _onAnnotationSubmit?: (frames: SubmittedAnnotationFrame[], feedback: string) => void;private _pushTabsScheduled = false;private _visible = true;- private _pendingReveal: { sessionName?: string; workspaceDir?: string; pageId?: string } | undefined;+ private _pendingReveal: { sessionName?: string; workspaceDir?: string; pageId?: string; done: ManualPromise<void> } | undefined;private _annotateWaitingForAttach = false;_recordingDir: string;@@ -80,6 +81,9 @@ export class DashboardConnection implements Transport {this._provider.dispose();this._attachedPage?.dispose();this._attachedPage = undefined;+ // Reject any in-flight reveal so callers awaiting it don't hang.+ this._pendingReveal?.done.reject(new Error('Dashboard connection closed'));+ this._pendingReveal = undefined;for (const stream of this._streams.values()) {void stream.handle.close().catch(() => {})@@ -137,14 +141,29 @@ export class DashboardConnection implements Transport {await this._attachedPage?.setScreencastActive(params.visible);}- revealSession(sessionName: string, workspaceDir?: string) {- this._pendingReveal = { sessionName, workspaceDir };+ revealSession(sessionName: string, workspaceDir?: string): Promise<void> {+ const existing = this._pendingReveal;+ if (existing+ && existing.pageId === undefined+ && existing.sessionName === sessionName+ && existing.workspaceDir === workspaceDir)+ return existing.done;+ existing?.done.reject(new Error('Reveal superseded'));+ const done = new ManualPromise<void>();+ this._pendingReveal = { sessionName, workspaceDir, done };void this._tryRevealPending();+ return done;}- revealPage(pageId: string) {- this._pendingReveal = { pageId };+ revealPage(pageId: string): Promise<void> {+ const existing = this._pendingReveal;+ if (existing && existing.pageId === pageId)+ return existing.done;+ existing?.done.reject(new Error('Reveal superseded'));+ const done = new ManualPromise<void>();+ this._pendingReveal = { pageId, done };void this._tryRevealPending();+ return done;}private async _tryRevealPending() {@@ -163,8 +182,14 @@ export class DashboardConnection implements Transport {if (!page)return;this._pendingReveal = undefined;- await this._switchAttachedTo(page);- this._pushTabs();+ try {+ await this._switchAttachedTo(page);+ this._pushTabs();+ pending.done.resolve();+ } catch (e) {+ pending.done.reject(e instanceof Error ? e : new Error(String(e)));+ throw e;+ }}async submitAnnotation(params: { frames: SubmittedAnnotationFrame[]; feedback: string }) {