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

mxschmitt · 2025-06-19T12:29:22Z

This PR adds support for running WebKit in a dedicated WSL environment (webkit-wsl) on Windows. It introduces a transport layer to proxy browser communication between Windows and WSL, along with a PowerShell script to install and configure a WSL distro with the necessary WebKit setup.

#37036

agg23

This is very clean. I like it.

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

packages/playwright-core/src/server/browserType.ts

packages/playwright-core/src/server/webkit/webkit.ts

packages/playwright-core/src/server/browserType.ts

packages/playwright-core/src/server/webkit/webkit.ts

Skn0tt

looks great! there's a few places where comments could help, but otherwise I only have nits.

Skn0tt · 2025-08-18T09:49:38Z

packages/playwright-core/bin/webkit-wsl-transport-client.mjs

+const [executable, ...args] = process.argv.slice(2);
+
+if (!(await fs.promises.stat(executable)).isFile())
+    throw new Error(`Executable does not exist. Did you update Playwright recently? Make sure to run npx playwright install webkit-wsl`);


Hmm, can we throw the exact error somewhere in a parent? We try to detect the package manager, so npx isn't necessarily accurate.

packages/playwright-core/bin/webkit-wsl-transport-client.mjs

packages/playwright-core/bin/webkit-wsl-transport-server.mjs

packages/playwright-core/src/server/webkit/webkit.ts

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

dgozman

The implementation looks mostly good, but I got tired halfway through the tests. It seems like we should address those tests that do not work and minimize changes that should be done by the user.

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

packages/playwright-core/bin/install_webkit_wsl.ps1

packages/playwright-core/src/server/registry/index.ts

dgozman · 2025-08-26T07:31:43Z

packages/playwright-core/src/server/webkit/webkit.ts

@@ -98,3 +108,8 @@ export class WebKit extends BrowserType {
    return webkitArguments;
  }
 }
+
+export async function translatePathToWSL(path: string): Promise<string> {


As discussed before, perhaps do this once, save somewhere on WKBrowser and then just path.join() when needed?

The input path is from the user, could be from a different drive, network file share, be a symlink etc. so I don't think any custom path join logic would be bug-free looking at their impl - lets keep the async call for now and iterate later on it if needed?

packages/playwright-core/src/server/registry/index.ts

dgozman · 2025-08-26T07:48:19Z

packages/playwright-core/src/server/webkit/wsl/webkit-wsl-transport-server.ts

+
+  child.on('close', (code, signal) => {
+    log('Child exit', { code, signal });
+    shutdown(code ?? (signal ? 0 : 0));


Shouldn't this be non-zero when signal is present?

Done, ptal.

dgozman · 2025-08-26T07:49:31Z

packages/playwright-core/src/server/webkit/wsl/webkit-wsl-transport-server.ts

+    parentOut.destroy();
+
+    // Close listener and destroy any sockets
+    await new Promise(resolve => server.close(() => resolve(null)));


I think the pattern should be:

call server.close()

destroy sockets

wait for server.close callback

Done, ptal.

dgozman · 2025-08-26T07:52:40Z

packages/playwright-core/src/server/webkit/wsl/webkit-wsl-transport-client.ts

+  });
+})().catch(error => {
+  console.error('Error occurred:', error);
+  process.exit(1);


Can we try to preserve the childs error code?

The child's exit code is already preserved on lines 67-70. The process.exit(1) in the catch block is only for setup errors that happen before the child process starts (like missing env vars, file not found, socket connection issues). Those aren't child exit codes since the child hasn't run yet.

packages/playwright-core/src/server/webkit/wsl/webkit-wsl-transport-client.ts

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

packages/playwright-core/src/server/webkit/wsl/webkit-wsl-transport-server.ts

tests/config/browserTest.ts

tests/page/page-goto.spec.ts

github-actions · 2025-09-09T11:15:30Z

Test results for "tests 1"

1 failed
❌ [playwright-test] › runner.spec.ts:118 › should ignore subprocess creation error because of SIGINT @macos-latest-node18-1

3 flaky

⚠️ [firefox-library] › library/inspector/cli-codegen-1.spec.ts:1079 › cli codegen › should not throw csp directive violation errors `@firefox-ubuntu-22.04-node18`
⚠️ [firefox-page] › page/page-emulate-media.spec.ts:144 › should keep reduced motion and color emulation after reload `@firefox-ubuntu-22.04-node18`
⚠️ [chromium-library] › library/proxy.spec.ts:93 › should proxy local network requests › with other bypasses › loopback address `@ubuntu-22.04-chromium-tip-of-tree`

46774 passed, 821 skipped

Merge workflow run.

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 10a64dd to 34667d2 Compare June 19, 2025 12:30

This comment has been minimized.

Sign in to view

agg23 reviewed Jun 19, 2025

View reviewed changes

packages/playwright-core/bin/webkit-wsl-pipe-wrapper.mjs Outdated Show resolved Hide resolved

packages/playwright-core/src/server/browserType.ts Outdated Show resolved Hide resolved

mxschmitt force-pushed the webkit-via-wsl-experiment branch 8 times, most recently from bae0c10 to 18c9ba8 Compare June 30, 2025 11:17

This was referenced Jun 30, 2025

test: use http endpoint instead of local file for codegen tests #36498

Merged

test: allow running routeWebSocket tests on different host #36500

Merged

mxschmitt force-pushed the webkit-via-wsl-experiment branch from ba3bd42 to 48251d4 Compare June 30, 2025 15:40

mxschmitt mentioned this pull request Jul 1, 2025

test: use less localhost for cookies test #36508

Merged

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 48251d4 to 62bd7f5 Compare July 1, 2025 09:00

mxschmitt commented Jul 1, 2025

View reviewed changes

packages/playwright-core/src/server/webkit/webkit.ts Outdated Show resolved Hide resolved

mxschmitt mentioned this pull request Jul 1, 2025

chore: set CURL_COOKIE_JAR_PATH env var for WK only in persistent mode #36521

Merged

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 62bd7f5 to e8c3971 Compare July 2, 2025 12:20

mxschmitt mentioned this pull request Jul 3, 2025

test: do not rely on localhost in tests #36545

Merged

dgozman reviewed Jul 3, 2025

View reviewed changes

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 71966c1 to ba2acea Compare July 3, 2025 14:18

This comment has been minimized.

Sign in to view

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 3bebff5 to add6387 Compare August 5, 2025 12:02

This comment has been minimized.

Sign in to view

mxschmitt force-pushed the webkit-via-wsl-experiment branch from add6387 to 5e6d1dd Compare August 13, 2025 14:12

This comment has been minimized.

Sign in to view

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 5e6d1dd to a572b25 Compare August 15, 2025 09:33

This comment has been minimized.

Sign in to view

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 7f35898 to b9d96dd Compare August 17, 2025 15:17

This comment has been minimized.

Sign in to view

Skn0tt reviewed Aug 18, 2025

View reviewed changes

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 8d9d0ca to e0ddad3 Compare August 18, 2025 12:16

This comment has been minimized.

Sign in to view

mxschmitt marked this pull request as ready for review August 18, 2025 15:47

dgozman reviewed Aug 26, 2025

View reviewed changes

mxschmitt force-pushed the webkit-via-wsl-experiment branch from e0ddad3 to 763eddd Compare August 26, 2025 14:56

This comment has been minimized.

Sign in to view

yury-s reviewed Aug 26, 2025

View reviewed changes

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 763eddd to 539a7cd Compare August 27, 2025 11:28

This comment has been minimized.

Sign in to view

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 539a7cd to 294493a Compare September 5, 2025 16:02

This comment has been minimized.

Sign in to view

mxschmitt added 3 commits September 9, 2025 11:12

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

30b5071

review nits

1b52c17

rebase tests

6887a77

mxschmitt force-pushed the webkit-via-wsl-experiment branch from 0f3c524 to 6887a77 Compare September 9, 2025 09:12

review feedback

87c2e67

This comment has been minimized.

Sign in to view

dgozman approved these changes Sep 9, 2025

View reviewed changes

This comment has been minimized.

Sign in to view

review feedback

99ad183

mxschmitt merged commit 573441c into microsoft:main Sep 9, 2025
34 of 37 checks passed

mxschmitt deleted the webkit-via-wsl-experiment branch September 9, 2025 10:34

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

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

Uh oh!

Conversation

mxschmitt commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

agg23 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Skn0tt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

dgozman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mxschmitt commented Jun 19, 2025 •

edited

Loading