feat(webkit): allow running WebKit via WSL on Windows

Author: mxschmitt

.github/actions/run-test/action.yml

@@ -51,6 +51,20 @@ runs:
         npx playwright install --with-deps ${{ inputs.browsers-to-install }}
         echo "::endgroup::"
       shell: bash
+    # As per https://github.com/actions/runner-images/issues/12466
+    - name: Allow WSL network access for WSL2
+      if: contains(inputs.browsers-to-install, 'webkit-wsl')
+      shell: powershell
+      run: |
+        $wslAdapter = Get-NetAdapter | Where-Object {$_.Name -like "*WSL*"}
+        if ($wslAdapter) {
+            $wslIP = Get-NetIPAddress -InterfaceIndex $wslAdapter.InterfaceIndex | Where-Object {$_.AddressFamily -eq "IPv4"}
+            if ($wslIP) {
+                $networkRange = "$($wslIP.IPAddress)/$($wslIP.PrefixLength)"
+                Write-Host "Found WSL network: $networkRange"
+                netsh advfirewall firewall add rule name="WSL2-Auto" dir=in action=allow protocol=TCP remoteip=$networkRange
+            }
+        }
     - name: Run tests
       if: inputs.shell == 'bash'
       run: |

.github/workflows/tests_primary.yml

@@ -26,218 +26,19 @@ env:
   DEBUG_GIT_COMMIT_INFO: 1
 
 jobs:
-  test_linux:
-    name: ${{ matrix.os }} (${{ matrix.browser }} - Node.js ${{ matrix.node-version }})
-    environment: ${{ github.event_name == 'push' && 'allow-uploading-flakiness-results' || null }}
-    strategy:
-      fail-fast: false
-      matrix:
-        browser: [chromium, firefox, webkit]
-        os: [ubuntu-22.04]
-        node-version: [18]
-        include:
-          - os: ubuntu-22.04
-            node-version: 20
-            browser: chromium
-          - os: ubuntu-22.04
-            node-version: 22
-            browser: chromium
-          - os: ubuntu-22.04
-            node-version: 24
-            browser: chromium
-    runs-on: ${{ matrix.os }}
-    permissions:
-      id-token: write   # This is required for OIDC login (azure/login) to succeed
-      contents: read    # This is required for actions/checkout to succeed
+  test_webkit_wsl:
+    name: Webkit WSL
+    runs-on: windows-2025
     steps:
     - uses: actions/checkout@v4
     - uses: ./.github/actions/run-test
       with:
-        node-version: ${{ matrix.node-version }}
-        browsers-to-install: ${{ matrix.browser }} chromium
-        command: npm run test -- --project=${{ matrix.browser }}-*
-        bot-name: "${{ matrix.browser }}-${{ matrix.os }}-node${{ matrix.node-version }}"
-        flakiness-client-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_CLIENT_ID }}
-        flakiness-tenant-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_TENANT_ID }}
-        flakiness-subscription-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_SUBSCRIPTION_ID }}
-
-  test_linux_chromium_tot:
-    name: ${{ matrix.os }} (chromium tip-of-tree)
-    environment: ${{ github.event_name == 'push' && 'allow-uploading-flakiness-results' || null }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-22.04]
-    runs-on: ${{ matrix.os }}
-    permissions:
-      id-token: write   # This is required for OIDC login (azure/login) to succeed
-      contents: read    # This is required for actions/checkout to succeed
-    steps:
-    - uses: actions/checkout@v4
-    - uses: ./.github/actions/run-test
-      with:
-        browsers-to-install: chromium-tip-of-tree
-        command: npm run test -- --project=chromium-*
-        bot-name: "${{ matrix.os }}-chromium-tip-of-tree"
+        node-version: 22
+        browsers-to-install: webkit-wsl chromium
+        command: npm run test -- --project=webkit-* --reporter=list
+        bot-name: "webkit-wsl-headed"
         flakiness-client-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_CLIENT_ID }}
         flakiness-tenant-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_TENANT_ID }}
         flakiness-subscription-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_SUBSCRIPTION_ID }}
       env:
-        PWTEST_CHANNEL: chromium-tip-of-tree
-
-  test_test_runner:
-    name: Test Runner
-    environment: ${{ github.event_name == 'push' && 'allow-uploading-flakiness-results' || null }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [18]
-        shardIndex: [1, 2]
-        shardTotal: [2]
-        include:
-          - os: ubuntu-latest
-            node-version: 20
-            shardIndex: 1
-            shardTotal: 2
-          - os: ubuntu-latest
-            node-version: 20
-            shardIndex: 2
-            shardTotal: 2
-          - os: ubuntu-latest
-            node-version: 22
-            shardIndex: 1
-            shardTotal: 2
-          - os: ubuntu-latest
-            node-version: 22
-            shardIndex: 2
-            shardTotal: 2
-          - os: ubuntu-latest
-            node-version: 24
-            shardIndex: 1
-            shardTotal: 2
-          - os: ubuntu-latest
-            node-version: 24
-            shardIndex: 2
-            shardTotal: 2
-    runs-on: ${{ matrix.os }}
-    permissions:
-      id-token: write   # This is required for OIDC login (azure/login) to succeed
-      contents: read    # This is required for actions/checkout to succeed
-    steps:
-    - uses: actions/checkout@v4
-    - uses: ./.github/actions/run-test
-      with:
-        node-version: ${{matrix.node-version}}
-        command: npm run ttest -- --shard ${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
-        bot-name: "${{ matrix.os }}-node${{ matrix.node-version }}-${{ matrix.shardIndex }}"
-        flakiness-client-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_CLIENT_ID }}
-        flakiness-tenant-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_TENANT_ID }}
-        flakiness-subscription-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_SUBSCRIPTION_ID }}
-      env:
-        PWTEST_CHANNEL: firefox-beta
-
-  test_web_components:
-    name: Web Components
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: 18
-    - run: npm ci
-    - run: npm run build
-
-    - run: npx playwright install --with-deps
-    - run: npm run test-html-reporter
-      env:
-        PWTEST_BOT_NAME: "web-components-html-reporter"
-    - name: Upload blob report
-      if: ${{ !cancelled() }}
-      uses: ./.github/actions/upload-blob-report
-      with:
-        report_dir: packages/html-reporter/blob-report
-        job_name: "web-components-html-reporter"
-
-    - run: npm run test-web
-      if: ${{ !cancelled() }}
-      env:
-        PWTEST_BOT_NAME: "web-components-web"
-    - name: Upload blob report
-      if: ${{ !cancelled() }}
-      uses: ./.github/actions/upload-blob-report
-      with:
-        report_dir: packages/web/blob-report
-        job_name: "web-components-web"
-
-  test_vscode_extension:
-    name: VSCode Extension
-    runs-on: ubuntu-latest
-    env:
-      PWTEST_BOT_NAME: "vscode-extension"
-      DEBUG_GIT_COMMIT_INFO: ""
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: 18
-    - run: npm ci
-      env:
-        DEBUG: pw:install
-    - run: npm run build
-    - run: npx playwright install chromium
-    - name: Checkout extension
-      run: git clone https://github.com/microsoft/playwright-vscode.git
-    - name: Print extension revision
-      run: git rev-parse HEAD
-      working-directory: ./playwright-vscode
-    - name: Remove @playwright/test from extension dependencies
-      run: node -e "const p = require('./package.json'); delete p.devDependencies['@playwright/test']; fs.writeFileSync('./package.json', JSON.stringify(p, null, 2));"
-      working-directory: ./playwright-vscode
-    - name: Build extension
-      run: npm ci && npm run build
-      working-directory: ./playwright-vscode
-    - name: Run extension tests
-      run: npm run test -- --workers=1
-      working-directory: ./playwright-vscode
-    - name: Upload blob report
-      if: ${{ !cancelled() }}
-      uses: ./.github/actions/upload-blob-report
-      with:
-        report_dir: playwright-vscode/blob-report
-        job_name: ${{ env.PWTEST_BOT_NAME }}
-
-  test_package_installations:
-    name: "Installation Test ${{ matrix.os }}"
-    environment: ${{ github.event_name == 'push' && 'allow-uploading-flakiness-results' || null }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-        - ubuntu-latest
-        - macos-latest
-        - windows-latest
-    runs-on: ${{ matrix.os  }}
-    timeout-minutes: 30
-    permissions:
-      id-token: write   # This is required for OIDC login (azure/login) to succeed
-      contents: read    # This is required for actions/checkout to succeed
-    steps:
-    - uses: actions/checkout@v4
-    - run: npm install -g yarn@1
-    - run: npm install -g pnpm@8
-    - name: Setup Ubuntu Binary Installation # TODO: Remove when https://github.com/electron/electron/issues/42510 is fixed
-      if: ${{ runner.os == 'Linux' }}
-      run: |
-        if grep -q "Ubuntu 24" /etc/os-release; then
-          sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
-        fi
-      shell: bash
-    - uses: ./.github/actions/run-test
-      with:
-        command: npm run itest
-        bot-name: "package-installations-${{ matrix.os }}"
-        shell: ${{ matrix.os == 'windows-latest' && 'pwsh' || 'bash' }}
-        flakiness-client-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_CLIENT_ID }}
-        flakiness-tenant-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_TENANT_ID }}
-        flakiness-subscription-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_SUBSCRIPTION_ID }}
+        PWTEST_CHANNEL: webkit-wsl

packages/playwright-core/bin/install_webkit_wsl.ps1

@@ -0,0 +1,29 @@
+$ErrorActionPreference = 'Stop'
+
+$Distribution = "playwright"
+$Username = "pwuser"
+
+$distributions = (wsl --list --quiet) -split "\r?\n"
+if ($distributions -contains $Distribution) {
+    Write-Host "WSL distribution '$Distribution' already exists. Skipping installation."
+} else {
+    Write-Host "Installing new WSL distribution '$Distribution'..."
+    wsl --install -d Ubuntu-24.04 --name $Distribution --no-launch
+    wsl -d $Distribution -u root adduser --gecos GECOS --disabled-password $Username
+}
+
+$pwshDirname = (Resolve-Path -Path $PSScriptRoot).Path;
+$playwrightCoreRoot = Resolve-Path (Join-Path $pwshDirname "..")
+
+$initScript = @"
+if [ ! -f "/home/$Username/node/bin/node" ]; then
+  mkdir -p /home/$Username/node
+  curl -fsSL https://nodejs.org/dist/v22.17.0/node-v22.17.0-linux-x64.tar.xz -o /home/$Username/node/node-v22.17.0-linux-x64.tar.xz
+  tar -xJf /home/$Username/node/node-v22.17.0-linux-x64.tar.xz -C /home/$Username/node --strip-components=1
+fi
+/home/$Username/node/bin/node cli.js install-deps
+cp bin/webkit-wsl-pipe-wrapper.mjs /home/$Username/
+sudo -u $Username PLAYWRIGHT_SKIP_BROWSER_GC=1 /home/$Username/node/bin/node cli.js install webkit
+"@ -replace "\r\n", "`n"
+
+wsl -d $Distribution --cd $playwrightCoreRoot -u root -- bash -c "$initScript"

packages/playwright-core/bin/webkit-wsl-pipe-wrapper.mjs

@@ -0,0 +1,49 @@
+// @ts-check
+import net from 'net';
+import { execSync, spawn } from 'child_process';
+
+const socketPort = process.env.PW_WKWSL_PORT;
+delete process.env.PW_WKWSL_PORT;
+if (!socketPort)
+    throw new Error('PW_WKWSL_PORT env var is not set');
+
+const address = (() => {
+    if (execSync('wslinfo --networking-mode', { encoding: 'utf8' }).trim() === 'nat') {
+        const ip = execSync('ip route show', { encoding: 'utf8' }).trim().split('\n').find(line => line.includes('default'))?.split(' ')[2];
+        if (!ip)
+            throw new Error('Could not determine WSL IP address (NAT mode).');
+        return ip;
+    }
+    return '127.0.0.1';
+})();
+
+const socket = net.createConnection(parseInt(socketPort), address);
+socket.setNoDelay(true);
+
+await new Promise((resolve, reject) => {
+    socket.on('connect', resolve);
+    socket.on('error', reject);
+});
+
+const [executable, ...args] = process.argv.slice(2);
+
+// 3 is readFD and 4 is writeFD
+const child = spawn(executable, args, {
+    stdio: ['inherit', 'inherit', 'inherit', 'pipe', 'pipe']
+});
+
+socket.pipe(/** @type {NodeJS.WritableStream} */ (child.stdio[3]));
+/** @type {NodeJS.ReadableStream} */ (child.stdio[4]).pipe(socket);
+
+// Handle cleanup
+socket.on('end', () => child.kill());
+
+child.on('exit', (exitCode) => {
+    socket.end();
+    process.exit(exitCode || 0);
+});
+
+await new Promise((resolve, reject) => {
+    child.on('exit', resolve);
+    child.on('error', reject);
+});

packages/playwright-core/src/server/bidi/bidiChromium.ts

@@ -77,7 +77,7 @@ export class BidiChromium extends BrowserType {
     return error;
   }
 
-  override amendEnvironment(env: Env): Env {
+  override async amendEnvironment(env: Env) {
     return env;
   }
 
@@ -92,7 +92,7 @@ export class BidiChromium extends BrowserType {
     return false;
   }
 
-  override defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {
+  override async defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string) {
     const chromeArguments = this._innerDefaultArgs(options);
     chromeArguments.push(`--user-data-dir=${userDataDir}`);
     chromeArguments.push('--remote-debugging-port=0');

packages/playwright-core/src/server/bidi/bidiFirefox.ts

@@ -57,7 +57,7 @@ export class BidiFirefox extends BrowserType {
     return error;
   }
 
-  override amendEnvironment(env: Env): Env {
+  override async amendEnvironment(env: Env) {
     if (!path.isAbsolute(os.homedir()))
       throw new Error(`Cannot launch Firefox with relative home directory. Did you set ${os.platform() === 'win32' ? 'USERPROFILE' : 'HOME'} to a relative path?`);
 
@@ -92,7 +92,7 @@ export class BidiFirefox extends BrowserType {
     });
   }
 
-  override defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {
+  override async defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string) {
     const { args = [], headless } = options;
     const userDataDirArg = args.find(arg => arg.startsWith('-profile') || arg.startsWith('--profile'));
     if (userDataDirArg)