From 018e23da800875497be6022c428affcf90c1710b Mon Sep 17 00:00:00 2001
From: robby <122219240+resslr@users.noreply.github.com>
Date: Wed, 8 Jan 2025 13:49:34 -0500
Subject: [PATCH] add: list installed browsers

Add new commands to list installed browsers.

Solves #34183

* Add `playwright ls` command to list installed browsers in `packages/playwright-core/src/cli/commands/ls.ts`.
* Add `--list` option to `npx playwright install` command in `packages/playwright-core/src/cli/commands/install.ts`.
* Register the new `ls` command in the CLI program in `packages/playwright-core/src/cli/program.ts`.
* Write tests for the `playwright ls` command in `packages/playwright-core/src/cli/commands/ls.test.ts`.
* Add documentation for the new `playwright ls` command and `--list` option in `docs/src/cli.md`.
* Update `.github/actions/run-test/action.yml` to use `npx playwright install --with-deps --list` to list installed browsers.
---
 .github/actions/run-test/action.yml           |  4 +-
 docs/src/cli.md                               | 64 +++++++++++++++++++
 .../src/cli/commands/install.ts               | 21 ++++++
 .../src/cli/commands/ls.test.ts               |  9 +++
 .../playwright-core/src/cli/commands/ls.ts    | 21 ++++++
 packages/playwright-core/src/cli/program.ts   | 14 +++-
 6 files changed, 130 insertions(+), 3 deletions(-)
 create mode 100644 docs/src/cli.md
 create mode 100644 packages/playwright-core/src/cli/commands/install.ts
 create mode 100644 packages/playwright-core/src/cli/commands/ls.test.ts
 create mode 100644 packages/playwright-core/src/cli/commands/ls.ts

diff --git a/.github/actions/run-test/action.yml b/.github/actions/run-test/action.yml
index c193515c4501d..3fa01011357ba 100644
--- a/.github/actions/run-test/action.yml
+++ b/.github/actions/run-test/action.yml
@@ -50,8 +50,8 @@ runs:
         echo "::endgroup::"
       shell: bash
     - run: |
-        echo "::group::npx playwright install --with-deps"
-        npx playwright install --with-deps ${{ inputs.browsers-to-install }}
+        echo "::group::npx playwright install --with-deps --list"
+        npx playwright install --with-deps --list ${{ inputs.browsers-to-install }}
         echo "::endgroup::"
       shell: bash
     - name: Run tests
diff --git a/docs/src/cli.md b/docs/src/cli.md
new file mode 100644
index 0000000000000..63615ed48d3e9
--- /dev/null
+++ b/docs/src/cli.md
@@ -0,0 +1,64 @@
+# Playwright CLI
+
+## `playwright ls`
+
+List installed browsers.
+
+### Usage
+
+```sh
+npx playwright ls
+```
+
+### Description
+
+The `playwright ls` command lists all installed browsers along with their versions and installation locations.
+
+### Example
+
+```sh
+$ npx playwright ls
+Browser: chromium
+  Version: 91.0.4472.124
+  Install location: /path/to/chromium
+
+Browser: firefox
+  Version: 89.0
+  Install location: /path/to/firefox
+
+Browser: webkit
+  Version: 14.2
+  Install location: /path/to/webkit
+```
+
+## `npx playwright install --list`
+
+List installed browsers after installing them.
+
+### Usage
+
+```sh
+npx playwright install --list
+```
+
+### Description
+
+The `--list` option for the `npx playwright install` command lists all installed browsers along with their versions and installation locations after installing them.
+
+### Example
+
+```sh
+$ npx playwright install --list
+Installing browsers...
+Browser: chromium
+  Version: 91.0.4472.124
+  Install location: /path/to/chromium
+
+Browser: firefox
+  Version: 89.0
+  Install location: /path/to/firefox
+
+Browser: webkit
+  Version: 14.2
+  Install location: /path/to/webkit
+```
diff --git a/packages/playwright-core/src/cli/commands/install.ts b/packages/playwright-core/src/cli/commands/install.ts
new file mode 100644
index 0000000000000..a2de797f54718
--- /dev/null
+++ b/packages/playwright-core/src/cli/commands/install.ts
@@ -0,0 +1,21 @@
+import { registry } from '../../server';
+import { gracefullyProcessExitDoNotHang } from '../../utils';
+
+async function listInstalledBrowsers() {
+  try {
+    const executables = registry.executables();
+    for (const executable of executables) {
+      if (executable.installType !== 'none') {
+        console.log(`Browser: ${executable.name}`);
+        console.log(`  Version: ${executable.browserVersion}`);
+        console.log(`  Install location: ${executable.directory}`);
+        console.log('');
+      }
+    }
+  } catch (e) {
+    console.log(`Failed to list installed browsers\n${e}`);
+    gracefullyProcessExitDoNotHang(1);
+  }
+}
+
+export { listInstalledBrowsers };
diff --git a/packages/playwright-core/src/cli/commands/ls.test.ts b/packages/playwright-core/src/cli/commands/ls.test.ts
new file mode 100644
index 0000000000000..c8a7fd2160a58
--- /dev/null
+++ b/packages/playwright-core/src/cli/commands/ls.test.ts
@@ -0,0 +1,9 @@
+import { execSync } from 'child_process';
+import { expect, test } from '@playwright/test';
+
+test('playwright ls command should list installed browsers', async () => {
+  const result = execSync('npx playwright ls').toString();
+  expect(result).toContain('Browser:');
+  expect(result).toContain('Version:');
+  expect(result).toContain('Install location:');
+});
diff --git a/packages/playwright-core/src/cli/commands/ls.ts b/packages/playwright-core/src/cli/commands/ls.ts
new file mode 100644
index 0000000000000..a2de797f54718
--- /dev/null
+++ b/packages/playwright-core/src/cli/commands/ls.ts
@@ -0,0 +1,21 @@
+import { registry } from '../../server';
+import { gracefullyProcessExitDoNotHang } from '../../utils';
+
+async function listInstalledBrowsers() {
+  try {
+    const executables = registry.executables();
+    for (const executable of executables) {
+      if (executable.installType !== 'none') {
+        console.log(`Browser: ${executable.name}`);
+        console.log(`  Version: ${executable.browserVersion}`);
+        console.log(`  Install location: ${executable.directory}`);
+        console.log('');
+      }
+    }
+  } catch (e) {
+    console.log(`Failed to list installed browsers\n${e}`);
+    gracefullyProcessExitDoNotHang(1);
+  }
+}
+
+export { listInstalledBrowsers };
diff --git a/packages/playwright-core/src/cli/program.ts b/packages/playwright-core/src/cli/program.ts
index 5cd941d5d42ed..c4a4f78c8a924 100644
--- a/packages/playwright-core/src/cli/program.ts
+++ b/packages/playwright-core/src/cli/program.ts
@@ -35,6 +35,7 @@ import { wrapInASCIIBox, isLikelyNpxGlobal, assert, gracefullyProcessExitDoNotHa
 import type { Executable } from '../server';
 import { registry, writeDockerVersion } from '../server';
 import { isTargetClosedError } from '../client/errors';
+import { listInstalledBrowsers } from './commands/ls';
 
 const packageJSON = require('../../package.json');
 
@@ -133,7 +134,8 @@ program
     .option('--force', 'force reinstall of stable browser channels')
     .option('--only-shell', 'only install headless shell when installing chromium')
     .option('--no-shell', 'do not install chromium headless shell')
-    .action(async function(args: string[], options: { withDeps?: boolean, force?: boolean, dryRun?: boolean, shell?: boolean, noShell?: boolean, onlyShell?: boolean }) {
+    .option('--list', 'list installed browsers')
+    .action(async function(args: string[], options: { withDeps?: boolean, force?: boolean, dryRun?: boolean, shell?: boolean, noShell?: boolean, onlyShell?: boolean, list?: boolean }) {
       // For '--no-shell' option, commander sets `shell: false` instead.
       if (options.shell === false)
         options.noShell = true;
@@ -183,6 +185,9 @@ program
             console.error(e);
           });
         }
+        if (options.list) {
+          await listInstalledBrowsers();
+        }
       } catch (e) {
         console.log(`Failed to install browsers\n${e}`);
         gracefullyProcessExitDoNotHang(1);
@@ -338,6 +343,13 @@ Examples:
 
   $ show-trace https://example.com/trace.zip`);
 
+program
+    .command('ls')
+    .description('list installed browsers')
+    .action(async function() {
+      await listInstalledBrowsers();
+    });
+
 type Options = {
   browser: string;
   channel?: string;