Skip to content

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

test(cli): `list --all` cleans up stale sessions (#39458)

Dmitry Gozmandefaa0a66eb3
diff --git a/packages/playwright-core/src/cli/client/program.ts b/packages/playwright-core/src/cli/client/program.ts
index 8cfad9dcb4..2eff9ad027 100644
--- a/packages/playwright-core/src/cli/client/program.ts
+++ b/packages/playwright-core/src/cli/client/program.ts
@@ -393,12 +393,8 @@ async function listSessions(registry: Registry, clientInfo: ClientInfo, all: boo
console.log('No browsers found.');
return;
}
- for (const [workspace, list] of entries) {
- if (!list.length)
- continue;
- console.log(`${workspace}:`);
- await gcAndPrintSessions(clientInfo, list.map(entry => new Session(entry)));
- }
+ for (const [workspace, list] of entries)
+ await gcAndPrintSessions(clientInfo, list.map(entry => new Session(entry)), `${workspace}:`);
} else {
console.log('### Browsers');
const entries = registry.entries(clientInfo);
@@ -406,7 +402,7 @@ async function listSessions(registry: Registry, clientInfo: ClientInfo, all: boo
}
}
-async function gcAndPrintSessions(clientInfo: ClientInfo, sessions: Session[]) {
+async function gcAndPrintSessions(clientInfo: ClientInfo, sessions: Session[], header?: string) {
const running: Session[] = [];
const stopped: Session[] = [];
@@ -422,6 +418,9 @@ async function gcAndPrintSessions(clientInfo: ClientInfo, sessions: Session[]) {
}
}
+ if (header && (running.length || stopped.length))
+ console.log(header);
+
for (const session of running)
console.log(await renderSessionStatus(clientInfo, session));
for (const session of stopped)
@@ -429,7 +428,6 @@ async function gcAndPrintSessions(clientInfo: ClientInfo, sessions: Session[]) {
if (running.length === 0 && stopped.length === 0)
console.log(' (no browsers)');
-
}
async function renderSessionStatus(clientInfo: ClientInfo, session: Session) {
diff --git a/tests/mcp/cli-fixtures.ts b/tests/mcp/cli-fixtures.ts
index 7927a1f140..56d0076323 100644
--- a/tests/mcp/cli-fixtures.ts
+++ b/tests/mcp/cli-fixtures.ts
@@ -31,6 +31,7 @@ export const test = baseTest.extend<{
exitCode: number | undefined,
snapshot?: string,
attachments?: { name: string, data: Buffer | null }[],
+ pid?: number,
}>;
}>({
cliEnv: async ({}, use) => {
@@ -102,7 +103,8 @@ async function runCli(childProcess: CommonFixtures['childProcess'], args: string
output: cli.stdout.trim(),
error: cli.stderr.trim(),
snapshot,
- attachments
+ attachments,
+ pid: pid ? +pid : undefined,
};
});
}
diff --git a/tests/mcp/cli-session.spec.ts b/tests/mcp/cli-session.spec.ts
index bf80a76787..b1adb837ce 100644
--- a/tests/mcp/cli-session.spec.ts
+++ b/tests/mcp/cli-session.spec.ts
@@ -17,6 +17,7 @@
import fs from 'fs';
import path from 'path';
import { test, expect, daemonFolder } from './cli-fixtures';
+import { killProcessGroup } from '../config/commonFixtures';
test('list', async ({ cli, server }) => {
const { output: emptyOutput } = await cli('list');
@@ -185,27 +186,68 @@ test('list --all lists sessions from all workspaces', async ({ cli, server }, te
// Create two separate workspaces with their own daemon dirs
const workspace1 = testInfo.outputPath('workspace1');
const workspace2 = testInfo.outputPath('workspace2');
+ const workspace3 = testInfo.outputPath('workspace3');
await fs.promises.mkdir(workspace1, { recursive: true });
await fs.promises.mkdir(workspace2, { recursive: true });
+ await fs.promises.mkdir(workspace3, { recursive: true });
await cli('install', { cwd: workspace1 });
await cli('install', { cwd: workspace2 });
+ await cli('install', { cwd: workspace3 });
- // Open sessions in both workspaces
await cli('-s', 'session1', 'open', server.HELLO_WORLD, { cwd: workspace1 });
await cli('-s', 'session2', 'open', server.HELLO_WORLD, { cwd: workspace2 });
+ const session3 = await cli('-s', 'session3', 'open', server.HELLO_WORLD, { cwd: workspace3 });
// List all sessions from workspace1
const { output: allList } = await cli('list', '--all', { cwd: workspace1 });
// Should include both workspace folders and sessions
expect(allList).toContain(workspace1);
- expect(allList).toContain(workspace2);
expect(allList).toContain('session1');
+ expect(allList).toContain(workspace2);
expect(allList).toContain('session2');
+ expect(allList).toContain(workspace3);
+ expect(allList).toContain('session3');
+
+ const rootDir = test.info().outputPath('daemon');
+ const dirs = await fs.promises.readdir(rootDir);
+ const getSessionFiles = async () => (await Promise.all(dirs.map(dir => fs.promises.readdir(path.join(rootDir, dir))))).flat();
+
+ const sessionFilesBefore = await getSessionFiles();
+ expect(sessionFilesBefore).toContain('session1.session');
+ expect(sessionFilesBefore).toContain('session2.session');
+ expect(sessionFilesBefore).toContain('session3.session');
await cli('-s', 'session1', 'close', { cwd: workspace1 });
- await cli('-s', 'session2', 'close', { cwd: workspace2 });
+
+ const { output: listTwo } = await cli('list', '--all', { cwd: workspace2 });
+ expect(listTwo).not.toContain(workspace1);
+ expect(listTwo).not.toContain('session1');
+ expect(listTwo).toContain(workspace2);
+ expect(listTwo).toContain('session2');
+ expect(listTwo).toContain(workspace3);
+ expect(listTwo).toContain('session3');
+
+ const sessionFilesAfterClose = await getSessionFiles();
+ expect(sessionFilesAfterClose).not.toContain('session1.session');
+ expect(sessionFilesAfterClose).toContain('session2.session');
+ expect(sessionFilesAfterClose).toContain('session3.session');
+
+ killProcessGroup(session3.pid);
+
+ const { output: listOne } = await cli('list', '--all', { cwd: workspace2 });
+ expect(listOne).not.toContain(workspace1);
+ expect(listOne).not.toContain('session1');
+ expect(listOne).toContain(workspace2);
+ expect(listOne).toContain('session2');
+ expect(listOne).not.toContain(workspace3);
+ expect(listOne).not.toContain('session3');
+
+ const sessionFilesAfterList = await getSessionFiles();
+ expect(sessionFilesAfterList).not.toContain('session1.session');
+ expect(sessionFilesAfterList).toContain('session2.session');
+ expect(sessionFilesAfterList).not.toContain('session3.session');
});
test('newer client with older daemon is compatible', async ({ cli, server }) => {