Build: Improve Playwright detection using newer karma-webkit-launcher

mgol · mgol · commit 0ef966a4debf · 2023-01-19T13:45:04.000+01:00
diff --git a/package.json b/package.json
@@ -53,7 +53,7 @@
     "karma-ie-launcher": "1.0.0",
     "karma-jsdom-launcher": "12.0.0",
     "karma-qunit": "4.1.2",
-    "karma-webkit-launcher": "1.3.1",
+    "karma-webkit-launcher": "2.1.0",
     "load-grunt-tasks": "5.1.0",
     "native-promise-only": "0.8.1",
     "playwright-webkit": "1.29.2",
diff --git a/test/unit/selector.js b/test/unit/selector.js
@@ -1,9 +1,10 @@
 QUnit.module( "selector", {
 	beforeEach: function() {
 
-		// Playwright WebKit on macOS doesn't expose `Safari` in its user agent string.
-		// However, this particular version of WebKit is only present in modern
-		// WebKit UAs (Safari 13+) as Chromium is locked to an older version.
+		// Playwright WebKit on macOS doesn't expose `Safari` in its user agent
+		// string; use the "AppleWebKit" token. This token is also present
+		// in the Chromium UA, but it is locked to an older version there.
+		// Modern WebKit (Safari 13+) locks it to `605.1.15`.
 		this.safari = /\bapplewebkit\/605\.1\.15\b/i.test( navigator.userAgent );
 	},
 	afterEach: moduleTeardown
diff --git a/test/unit/support.js b/test/unit/support.js
@@ -107,19 +107,17 @@ testIframe(
 		expected = expectedMap.firefox;
 	} else if ( /(?:iphone|ipad);.*(?:iphone)? os \d+_/i.test( userAgent ) ) {
 		expected = expectedMap.ios;
-	} else if (
-
-		// Playwright WebKit on macOS doesn't expose `Safari` in its user agent string.
-		// However, this particular version of WebKit is only present in modern
-		// WebKit UAs (Safari 13+) as Chromium is locked to an older version.
-		( /\bapplewebkit\/605\.1\.15\b/i.test( userAgent ) &&
-			!/\bsafari\//i.test( userAgent ) ) ||
-
-		// The Linux version of Playwright WebKit does include the `Safari` token,
-		// though. Since there's no WebKit-based real browser that we officially
-		// support outside of macOS and GitHub Actions run on Linux, use it to
-		// detect Playwright WebKit.
-		/\blinux [^)]+\) applewebkit\/605\.1\.15\b/i.test( userAgent ) ) {
+	} else if ( typeof URLSearchParams !== "undefined" &&
+
+		// `karma-webkit-launcher` adds `test_browser=Playwright` to the query string.
+		// The normal way of using user agent to detect the browser won't help
+		// as on macOS Playwright doesn't specify the `Safari` token but on Linux
+		// it does.
+		// See https://github.com/google/karma-webkit-launcher#detected-if-safari-or-playwright-is-used
+		new URLSearchParams( document.referrer || window.location.search ).get(
+			"test_browser"
+		) === "Playwright"
+	) {
 		expected = expectedMap.webkit;
 	} else if ( /\b\d+(\.\d+)+ safari/i.test( userAgent ) ) {
 		expected = expectedMap.safari;
