Skip to content

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

chore(devtools): block 'show' until devtools is open (#39409)

Simon Knott6ba04594a12f
diff --git a/packages/playwright/src/cli/client/devtoolsApp.ts b/packages/playwright/src/cli/client/devtoolsApp.ts
index f5d121e9d8..e6ac791e25 100644
--- a/packages/playwright/src/cli/client/devtoolsApp.ts
+++ b/packages/playwright/src/cli/client/devtoolsApp.ts
@@ -17,6 +17,7 @@
import fs from 'fs';
import path from 'path';
import os from 'os';
+import crypto from 'crypto';
import net from 'net';
import { chromium } from 'playwright-core';
@@ -116,7 +117,7 @@ async function handleApiRequest(clientInfo: ClientInfo, request: http.IncomingMe
response.end(JSON.stringify({ error: 'Not found' }));
}
-async function openDevToolsApp(): Promise<Page> {
+async function openDevToolsApp(): Promise<{ page: Page, url: string }> {
const httpServer = new HttpServer();
const libDir = require.resolve('playwright-core/package.json');
const devtoolsDir = path.join(path.dirname(libDir), 'lib/vite/devtools');
@@ -143,7 +144,7 @@ async function openDevToolsApp(): Promise<Page> {
const { page } = await launchApp('devtools');
await page.goto(url);
- return page;
+ return { page, url };
}
async function launchApp(appName: string) {
@@ -212,13 +213,15 @@ function socketsDirectory() {
}
function devtoolsSocketPath() {
+ const suffix = process.env.PLAYWRIGHT_DAEMON_SESSION_DIR ? crypto.createHash('sha256').update(process.env.PLAYWRIGHT_DAEMON_SESSION_DIR).digest('hex').substring(0, 8) : '';
return process.platform === 'win32'
- ? `\\\\.\\pipe\\playwright-devtools-${process.env.USERNAME || 'default'}`
- : path.join(socketsDirectory(), 'devtools.sock');
+ ? `\\\\.\\pipe\\playwright-devtools-${process.env.USERNAME || 'default'}${suffix}`
+ : path.join(socketsDirectory(), `devtools${suffix}.sock`);
}
-async function acquireSingleton(): Promise<net.Server> {
+async function acquireSingleton(): Promise<net.Server | string> {
const socketPath = devtoolsSocketPath();
+ await fs.promises.mkdir(path.dirname(socketPath), { recursive: true });
return await new Promise((resolve, reject) => {
const server = net.createServer();
@@ -228,8 +231,11 @@ async function acquireSingleton(): Promise<net.Server> {
return reject(err);
const client = net.connect(socketPath, () => {
client.write('bringToFront');
- client.end();
- reject(new Error('already running'));
+ });
+ let data = '';
+ client.on('data', chunk => { data += chunk.toString(); });
+ client.on('end', () => {
+ resolve(data);
});
client.on('error', () => {
if (process.platform !== 'win32')
@@ -241,20 +247,36 @@ async function acquireSingleton(): Promise<net.Server> {
}
async function main() {
- let server: net.Server | undefined;
- process.on('exit', () => server?.close());
- try {
- server = await acquireSingleton();
- } catch {
- return;
- }
- const page = await openDevToolsApp();
- server.on('connection', socket => {
- socket.on('data', data => {
- if (data.toString() === 'bringToFront')
- page?.bringToFront().catch(() => {});
+ const result = await acquireSingleton();
+ let status = typeof result === 'string' ? result : 'Starting';
+
+ if (typeof result !== 'string') {
+ const server = result;
+ process.on('exit', () => server.close());
+
+ let page: Page | undefined = undefined;
+ server.on('connection', socket => {
+ socket.on('data', data => {
+ if (data.toString() === 'bringToFront')
+ page?.bringToFront().catch(() => {});
+ socket.end(status);
+ });
});
- });
+
+ const app = await openDevToolsApp();
+ page = app.page;
+ status = `DevTools pid ${process.pid} listening on ${app.url}`;
+ }
+
+
+ // eslint-disable-next-line no-console
+ console.log(status);
+ // eslint-disable-next-line no-console
+ console.log('<EOF>');
}
-void main();
+void main().catch(e => {
+ // eslint-disable-next-line no-console
+ console.log(e);
+ throw e;
+});
diff --git a/packages/playwright/src/cli/client/program.ts b/packages/playwright/src/cli/client/program.ts
index cd37b22fb2..a86d82b3b0 100644
--- a/packages/playwright/src/cli/client/program.ts
+++ b/packages/playwright/src/cli/client/program.ts
@@ -193,9 +193,29 @@ export async function program(options?: { embedderVersion?: string}) {
const daemonScript = path.join(__dirname, 'devtoolsApp.js');
const child = spawn(process.execPath, [daemonScript], {
detached: true,
- stdio: 'ignore',
+ stdio: ['ignore', 'pipe', 'ignore'],
});
+
+ const status = await new Promise<string>((resolve, reject) => {
+ let outLog = '';
+ child.stdout!.on('data', (data: Buffer) => {
+ outLog += data.toString();
+ if (outLog.includes('<EOF>'))
+ resolve(outLog.split('<EOF>')[0]);
+ });
+ child.on('close', code => {
+ process.exitCode = code || 1;
+ reject(new Error(outLog));
+ });
+ });
+
+ child.stdout!.destroy();
child.unref();
+
+ // TODO: update check-deps to allow importing isUnderTest()
+ if (process.env.PWTEST_UNDER_TEST)
+ console.log(status);
+
return;
}
default: {
diff --git a/tests/mcp/cli-fixtures.ts b/tests/mcp/cli-fixtures.ts
index a40b1a8d98..a8c65cc6e9 100644
--- a/tests/mcp/cli-fixtures.ts
+++ b/tests/mcp/cli-fixtures.ts
@@ -33,21 +33,23 @@ export const test = baseTest.extend<{
}>;
}>({
cli: async ({ mcpBrowser, mcpHeadless, childProcess }, use) => {
- const sessions: { name: string, pid: number }[] = [];
+ const daemons: { session?: string, pid: number }[] = [];
await fs.promises.mkdir(test.info().outputPath('.playwright'), { recursive: true });
await use(async (...args: string[]) => {
const cliArgs = args.filter(arg => typeof arg === 'string');
const cliOptions = args.findLast(arg => typeof arg === 'object') || {};
- return await runCli(childProcess, cliArgs, cliOptions, { mcpBrowser, mcpHeadless }, sessions);
+ return await runCli(childProcess, cliArgs, cliOptions, { mcpBrowser, mcpHeadless }, daemons);
});
- for (const session of sessions) {
- await runCli(childProcess, ['--session=' + session.name, 'close'], {}, { mcpBrowser, mcpHeadless }, []).catch(e => {
- if (!e.message.includes('is not running'))
- throw e;
- });
- killProcessGroup(session.pid);
+ for (const daemon of daemons) {
+ if (daemon.session) {
+ await runCli(childProcess, ['--session=' + daemon.session, 'close'], {}, { mcpBrowser, mcpHeadless }, []).catch(e => {
+ if (!e.message.includes('is not running'))
+ throw e;
+ });
+ }
+ killProcessGroup(daemon.pid);
}
const daemonDir = path.join(test.info().outputDir, 'daemon');
@@ -57,7 +59,7 @@ export const test = baseTest.extend<{
},
});
-async function runCli(childProcess: CommonFixtures['childProcess'], args: string[], cliOptions: { cwd?: string, env?: Record<string, string> }, options: { mcpBrowser: string, mcpHeadless: boolean }, sessions: { name: string, pid: number }[]) {
+async function runCli(childProcess: CommonFixtures['childProcess'], args: string[], cliOptions: { cwd?: string, env?: Record<string, string> }, options: { mcpBrowser: string, mcpHeadless: boolean }, daemons: { session?: string, pid: number }[]) {
const stepTitle = `cli ${args.join(' ')}`;
return await test.step(stepTitle, async () => {
const testInfo = test.info();
@@ -86,7 +88,12 @@ async function runCli(childProcess: CommonFixtures['childProcess'], args: string
const matches = cli.stdout.includes('### Browser') ? cli.stdout.match(/Browser `(.+)` opened with pid (\d+)\./) : undefined;
const [, sessionName, pid] = matches ?? [];
if (sessionName && pid)
- sessions.push({ name: sessionName, pid: +pid });
+ daemons.push({ session: sessionName, pid: +pid });
+
+ const devtoolsMatch = cli.stdout.match(/DevTools pid (\d+) listening/);
+ if (devtoolsMatch)
+ daemons.push({ pid: +devtoolsMatch[1] });
+
return {
exitCode: await cli.exitCode,
output: cli.stdout.trim(),
diff --git a/tests/mcp/cli-show.spec.ts b/tests/mcp/cli-show.spec.ts
new file mode 100644
index 0000000000..147401ca3c
--- /dev/null
+++ b/tests/mcp/cli-show.spec.ts
@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { test, expect } from './cli-fixtures';
+
+test('running show twice gets same PID', async ({ cli }) => {
+ const one = await cli('show', { env: { PWTEST_UNDER_TEST: '1' } });
+ const two = await cli('show', { env: { PWTEST_UNDER_TEST: '1' } });
+ expect(one.output).toEqual(two.output);
+});