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): mirror cli-daemon spawn pattern in `cli show` (#40770)
Simon Knottcdfe71c7aeb1
diff --git a/packages/playwright-core/src/tools/cli-client/program.ts b/packages/playwright-core/src/tools/cli-client/program.tsindex 1c8d21574d..c01d0aaf70 100644--- a/packages/playwright-core/src/tools/cli-client/program.ts+++ b/packages/playwright-core/src/tools/cli-client/program.ts@@ -33,7 +33,6 @@ import { minimist } from './minimist';import type { ListData, ListedBrowser, Output } from './output';import type { ClientInfo, SessionFile } from './registry';import type { MinimistArgs } from './minimist';-import type { Readable } from 'stream';type GlobalOptions = {help?: boolean;@@ -230,35 +229,46 @@ export async function program(options?: { embedderVersion?: string}) {const foreground = args.port !== undefined;const child = spawn(process.execPath, daemonArgs, {detached: !foreground,- stdio: foreground ? 'inherit' : ['ignore', 'ignore', 'ignore', 'pipe'],+ stdio: foreground ? 'inherit' : ['pipe', 'pipe', 'ignore'],});if (foreground) {await new Promise<void>(resolve => child.on('exit', () => resolve()));return;}- const readyStream = (child.stdio as unknown as Readable[])[3];try {await new Promise<void>((resolve, reject) => {+ let outLog = '';const settle = (err?: Error) => {clearTimeout(timer);- readyStream.destroy();+ child.stdout!.removeAllListeners();+ child.removeAllListeners('exit');if (err)reject(err);elseresolve();};- const timer = setTimeout(() => settle(new Error('Dashboard daemon did not spin up within 60s, killing it')), 60_000);- readyStream.once('data', () => settle());- readyStream.once('error', err => settle(err));- child.once('exit', (code, signal) => settle(new Error(`Dashboard daemon exited (code=${code}, signal=${signal}) before signaling READY`)));+ const timer = setTimeout(() => settle(new Error('Dashboard daemon did not spin up within 60s')), 60_000);+ child.stdout!.on('data', data => {+ outLog += data.toString();+ if (!outLog.includes('<EOF>'))+ return;+ if (outLog.match(/### Success\n[\s\S]*<EOF>/))+ settle();+ else+ settle(new Error(outLog.trim()));+ });+ child.stdout!.once('error', err => settle(err));+ child.once('exit', (code, signal) => settle(new Error(`Dashboard daemon exited (code=${code}, signal=${signal}) before signaling READY${outLog ? '\n' + outLog : ''}`)));});} catch (err) {- if (child.exitCode === null && child.signalCode === null) {- child.kill('SIGKILL');+ child.stdin!.destroy();+ child.stdout!.destroy();+ if (child.exitCode === null && child.signalCode === null)await new Promise<void>(resolve => child.once('exit', () => resolve()));- }throw err;}+ child.stdin!.destroy();+ child.stdout!.destroy();child.unref();output.show(sessionName, child.pid);return;diff --git a/packages/playwright-core/src/tools/cli-client/session.ts b/packages/playwright-core/src/tools/cli-client/session.tsindex ce533cbe42..86329934b2 100644--- a/packages/playwright-core/src/tools/cli-client/session.ts+++ b/packages/playwright-core/src/tools/cli-client/session.ts@@ -168,21 +168,17 @@ export class Session {outLog += data.toString();if (!outLog.includes('<EOF>'))return;- const errorMatch = outLog.match(/### Error\n([\s\S]*)<EOF>/);- const error = errorMatch ? errorMatch[1].trim() : undefined;- if (error) {- const errLogContent = fs.readFileSync(errLog, 'utf-8');- rejectWithPid(reject, error + (errLogContent ? '\n' + errLogContent : ''));- }-- const successMatch = outLog.match(/### Success\nDaemon listening on (.*)\n<EOF>/);- if (successMatch)+ if (outLog.match(/### Success\nDaemon listening on (.*)\n<EOF>/)) {resolve();+ return;+ }+ const errLogContent = fs.readFileSync(errLog, 'utf-8');+ rejectWithPid(reject, outLog.trim() + (errLogContent ? '\n' + errLogContent : ''));});child.on('close', code => {if (!signalled) {const errLogContent = fs.readFileSync(errLog, 'utf-8');- rejectWithPid(reject, `Daemon process exited with code ${code}` + (errLogContent ? '\n' + errLogContent : ''));+ rejectWithPid(reject, `Daemon process exited with code ${code}` + (outLog ? '\n' + outLog : '') + (errLogContent ? '\n' + errLogContent : ''));}});});diff --git a/packages/playwright-core/src/tools/dashboard/dashboardApp.ts b/packages/playwright-core/src/tools/dashboard/dashboardApp.tsindex b0cec86fee..ffa1a183e9 100644--- a/packages/playwright-core/src/tools/dashboard/dashboardApp.ts+++ b/packages/playwright-core/src/tools/dashboard/dashboardApp.ts@@ -311,15 +311,44 @@ export async function openDashboardApp() {selfDestructOnParentGone();return;}- let server: net.Server | undefined;- process.on('exit', () => server?.close());+ // Self-destruct if the parent CLI dies before we signal READY. Unregistered+ // before we signal so the daemon outlives the parent.+ const stopSelfDestruct = selfDestructOnParentGone();+ let server: net.Server;try {server = await acquireSingleton(options);} catch {+ // Another daemon is already running; acquireSingleton forwarded our+ // options to it. Signal success so the parent doesn't treat our clean+ // exit as a startup failure.+ stopSelfDestruct();+ // eslint-disable-next-line no-console+ console.log('### Success\nDashboard already running');+ // eslint-disable-next-line no-console+ console.log('<EOF>');return;}+ process.on('exit', () => server.close());+ try {+ await startApp(server, options);+ stopSelfDestruct();+ // eslint-disable-next-line no-console+ console.log('### Success\nDashboard ready');+ // eslint-disable-next-line no-console+ console.log('<EOF>');+ } catch (error) {+ const message = (error as Error).stack || (error as Error).message;+ // eslint-disable-next-line no-console+ console.log(`### Error\n${message}`);+ // eslint-disable-next-line no-console+ console.log('<EOF>');+ gracefullyProcessExitDoNotHang(1);+ }+}++async function startApp(server: net.Server, options: DashboardOptions) {const statePromise = innerOpenDashboardApp(options);- server?.on('connection', socket => {+ server.on('connection', socket => {let buffer = '';socket.on('data', data => {buffer += data.toString();@@ -356,7 +385,6 @@ export async function openDashboardApp() {});});await statePromise;- try { fs.writeSync(3, '.'); fs.closeSync(3); } catch {}}export async function openDashboardForContext(context: api.BrowserContext): Promise<void> {@@ -426,8 +454,8 @@ async function runAnnotateClient(options: DashboardOptions): Promise<void> {console.log(text);}-function selfDestructOnParentGone() {- process.stdin.on('close', () => {- gracefullyProcessExitDoNotHang(0);- });+function selfDestructOnParentGone(): () => void {+ const onClose = () => gracefullyProcessExitDoNotHang(0);+ process.stdin.on('close', onClose);+ return () => process.stdin.off('close', onClose);}