Skip to content

Commit da7057e

Browse files
mgolmgol
committed
Build: Run GitHub Action browser tests on Playwright WebKit
So far, we've been running browser tests on GitHub Actions in Chrome and Firefox. Regular Safari is not available in GitHub Actions but Playwright WebKit comes close to a dev version of Safari. With this change, our GitHub CI & local test runs will invoke tests on all actively developed browser engines on all PRs. Also, our GitHub Actions browser tests are now running on Node.js 18. Detection of the Playwright WebKit browser in support unit tests is done by checking if the `test_browser` query parameter is set to `"Playwright"`; this is a `karma-webkit-launcher` feature. Detecting that browser via user agent as we normally do is hard as the UA on Linux is very similar to a real Safari one but it actually uses a newer version of the engine. In addition, we now allow to pass custom browsers when one needs it; e.g., to run the tests in all three engines on Linux/macOS, run: ``` grunt && BROWSERS=ChromeHeadless,FirefoxHeadless,WebkitHeadless grunt karma:main ``` Closes gh-5190 (cherry picked from commit b02a257)
1 parent 6b2abbd commit da7057e

File tree

7 files changed

+93
-35
lines changed

7 files changed

+93
-35
lines changed

‎.github/workflows/node.js.yml

+15-11
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,28 @@ jobs:
1616
NODE_VERSION: [10.x, 14.x, 16.x, 18.x, 19.x]
1717
NPM_SCRIPT: ["test:browserless"]
1818
include:
19-
- NAME: "Browser tests: full build, Chrome & Firefox stable"
20-
NODE_VERSION: "16.x"
19+
- NAME: "Browser tests: full build, Chrome, Firefox & WebKit"
20+
NODE_VERSION: "18.x"
2121
NPM_SCRIPT: "test:browser"
22-
BROWSERS: "ChromeHeadless,FirefoxHeadless"
23-
- NAME: "Browser tests: slim build, Chrome stable"
24-
NODE_VERSION: "16.x"
22+
BROWSERS: "ChromeHeadless,FirefoxHeadless,WebkitHeadless"
23+
- NAME: "Browser tests: slim build, Chrome"
24+
NODE_VERSION: "18.x"
2525
NPM_SCRIPT: "test:slim"
2626
BROWSERS: "ChromeHeadless"
27-
- NAME: "Browser tests: no-deprecated build, Chrome stable"
28-
NODE_VERSION: "16.x"
27+
- NAME: "Browser tests: no-deprecated build, Chrome"
28+
NODE_VERSION: "18.x"
2929
NPM_SCRIPT: "test:no-deprecated"
3030
BROWSERS: "ChromeHeadless"
31-
- NAME: "Browser tests: selector-native build, Chrome stable"
32-
NODE_VERSION: "16.x"
31+
- NAME: "Browser tests: selector-native build, Chrome"
32+
NODE_VERSION: "18.x"
3333
NPM_SCRIPT: "test:selector-native"
3434
BROWSERS: "ChromeHeadless"
3535
- NAME: "Browser tests: AMD build, Chrome stable"
36-
NODE_VERSION: "16.x"
36+
NODE_VERSION: "18.x"
3737
NPM_SCRIPT: "test:amd"
3838
BROWSERS: "ChromeHeadless"
3939
- NAME: "Browser tests: full build, Firefox ESR"
40-
NODE_VERSION: "16.x"
40+
NODE_VERSION: "18.x"
4141
NPM_SCRIPT: "test:browser"
4242
BROWSERS: "FirefoxHeadless"
4343
steps:
@@ -67,6 +67,10 @@ jobs:
6767
run: |
6868
npm install
6969
70+
- name: Install Playwright dependencies
71+
run: npx playwright-webkit install-deps
72+
if: "matrix.NPM_SCRIPT == 'test:browser'"
73+
7074
- name: Run tests
7175
env:
7276
BROWSERS: ${{ matrix.BROWSERS }}

‎Gruntfile.js

+21-14
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
module.exports = function( grunt ) {
44
function readOptionalJSON( filepath ) {
5-
var stripJSONComments = require( "strip-json-comments" ),
6-
data = {};
5+
const stripJSONComments = require( "strip-json-comments" );
6+
let data = {};
77
try {
88
data = JSON.parse( stripJSONComments(
99
fs.readFileSync( filepath, { encoding: "utf8" } )
@@ -12,19 +12,23 @@ module.exports = function( grunt ) {
1212
return data;
1313
}
1414

15-
// Support: Node.js <12
16-
// Skip running tasks that dropped support for Node.js 10
15+
const fs = require( "fs" );
16+
const gzip = require( "gzip-js" );
17+
const nodeV14OrNewer = !/^v1[0-3]\./.test( process.version );
18+
const nodeV17OrNewer = !/^v1[0-6]\./.test( process.version );
19+
const customBrowsers = process.env.BROWSERS && process.env.BROWSERS.split( "," );
20+
21+
// Support: Node.js <14
22+
// Skip running tasks that dropped support for Node.js 10 or 12
1723
// in this Node version.
1824
function runIfNewNode( task ) {
19-
return oldNode ? "print_old_node_message:" + task : task;
25+
return nodeV14OrNewer ? task : "print_old_node_message:" + task;
2026
}
2127

22-
var fs = require( "fs" ),
23-
gzip = require( "gzip-js" ),
24-
oldNode = /^v10\./.test( process.version ),
25-
nodeV17OrNewer = !/^v1[0246]\./.test( process.version ),
26-
isCi = process.env.GITHUB_ACTION,
27-
ciBrowsers = process.env.BROWSERS && process.env.BROWSERS.split( "," );
28+
if ( nodeV14OrNewer ) {
29+
const playwright = require( "playwright-webkit" );
30+
process.env.WEBKIT_HEADLESS_BIN = playwright.webkit.executablePath();
31+
}
2832

2933
if ( !grunt.option( "filename" ) ) {
3034
grunt.option( "filename", "jquery.js" );
@@ -228,10 +232,11 @@ module.exports = function( grunt ) {
228232
singleRun: true
229233
},
230234
main: {
231-
browsers: isCi && ciBrowsers || [ "ChromeHeadless", "FirefoxHeadless" ]
235+
browsers: customBrowsers ||
236+
[ "ChromeHeadless", "FirefoxHeadless", "WebkitHeadless" ]
232237
},
233238
amd: {
234-
browsers: isCi && ciBrowsers || [ "ChromeHeadless" ],
239+
browsers: customBrowsers || [ "ChromeHeadless" ],
235240
options: {
236241
client: {
237242
qunit: {
@@ -333,7 +338,9 @@ module.exports = function( grunt ) {
333338
} );
334339

335340
// Load grunt tasks from NPM packages
336-
require( "load-grunt-tasks" )( grunt );
341+
require( "load-grunt-tasks" )( grunt, {
342+
pattern: nodeV14OrNewer ? [ "grunt-*" ] : [ "grunt-*", "!grunt-eslint" ]
343+
} );
337344

338345
// Integrate jQuery specific tasks
339346
grunt.loadTasks( "build/tasks" );

‎package.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,17 @@
4545
"gzip-js": "0.3.2",
4646
"husky": "4.2.5",
4747
"jsdom": "19.0.0",
48-
"karma": "^6.3.17",
48+
"karma": "6.4.1",
4949
"karma-browserstack-launcher": "1.6.0",
5050
"karma-chrome-launcher": "3.1.1",
5151
"karma-firefox-launcher": "2.1.2",
5252
"karma-ie-launcher": "1.0.0",
5353
"karma-jsdom-launcher": "12.0.0",
5454
"karma-qunit": "4.1.2",
55+
"karma-webkit-launcher": "2.1.0",
5556
"load-grunt-tasks": "5.1.0",
5657
"native-promise-only": "0.8.1",
58+
"playwright-webkit": "1.29.2",
5759
"promises-aplus-tests": "2.1.2",
5860
"q": "1.5.1",
5961
"qunit": "2.9.2",

‎test/unit/ajax.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2201,7 +2201,7 @@ if ( typeof window.ArrayBuffer === "undefined" || typeof new XMLHttpRequest().re
22012201
// Safari 13 did similar changes. The below check will catch them both.
22022202
// Edge Legacy fakes Chrome which fakes Safari in their user agents so we need
22032203
// to exclude Edge specifically here so that the test continues to run there.
2204-
if ( !/safari/i.test( navigator.userAgent ) || /edge\//i.test( navigator.userAgent ) ) {
2204+
if ( !/webkit/i.test( navigator.userAgent ) || /edge\//i.test( navigator.userAgent ) ) {
22052205
testIframe(
22062206
"trac-14379 - jQuery.ajax() on unload",
22072207
"ajax/onunload.html",

‎test/unit/css.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -1773,11 +1773,11 @@ QUnit.test( "Do not throw on frame elements from css method (trac-15098)", funct
17731773
"</style>"
17741774
);
17751775

1776-
var div = jQuery( "<div>" ).appendTo( "#qunit-fixture" ),
1777-
$elem = jQuery( "<div>" ).addClass( "test__customProperties" )
1778-
.appendTo( "#qunit-fixture" ),
1779-
webkitOrBlink = /\bsafari\b/i.test( navigator.userAgent ),
1780-
expected = 20;
1776+
var div = jQuery( "<div>" ).appendTo( "#qunit-fixture" ),
1777+
$elem = jQuery( "<div>" ).addClass( "test__customProperties" )
1778+
.appendTo( "#qunit-fixture" ),
1779+
webkitOrBlink = /\webkit\b/i.test( navigator.userAgent ) && !/edge\//i.test( navigator.userAgent ),
1780+
expected = 20;
17811781

17821782
if ( webkitOrBlink ) {
17831783
expected -= 2;

‎test/unit/selector.js

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
QUnit.module( "selector", {
22
beforeEach: function() {
3-
this.safari = /\bsafari\b/i.test( navigator.userAgent ) &&
4-
!/\b(?:headless)?chrome\b/i.test( navigator.userAgent );
3+
4+
// Playwright WebKit on macOS doesn't expose `Safari` in its user agent
5+
// string; use the "AppleWebKit" token. This token is also present
6+
// in the Chromium UA, but it is locked to an older version there.
7+
// Modern WebKit (Safari 13+) locks it to `605.1.15`.
8+
// Since the `3.x` branch is also tested on older WebKit UAs, we
9+
// need the `Safari` check as well.
10+
this.safari = /\bapplewebkit\/605\.1\.15\b/i.test( navigator.userAgent ) ||
11+
/\bsafari\b/i.test( navigator.userAgent );
512
},
613
afterEach: moduleTeardown
714
} );

‎test/unit/support.js

+39-1
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,31 @@ testIframe(
183183
sortDetached: true,
184184
sortStable: true
185185
},
186+
webkit: {
187+
ajax: true,
188+
boxSizingReliable: true,
189+
checkClone: true,
190+
checkOn: true,
191+
clearCloneStyle: true,
192+
cssSupportsSelector: true,
193+
cors: true,
194+
createHTMLDocument: true,
195+
disconnectedMatch: true,
196+
focusin: false,
197+
getById: true,
198+
noCloneChecked: true,
199+
option: true,
200+
optSelected: true,
201+
pixelBoxStyles: true,
202+
pixelPosition: true,
203+
radioValue: true,
204+
reliableMarginLeft: true,
205+
reliableTrDimensions: true,
206+
scope: true,
207+
scrollboxSize: true,
208+
sortDetached: true,
209+
sortStable: true
210+
},
186211
safari_9_10: {
187212
ajax: true,
188213
boxSizingReliable: true,
@@ -459,6 +484,18 @@ testIframe(
459484
expected = expectedMap.ios_7;
460485
} else if ( /(?:iphone|ipad);.*(?:iphone)? os \d+_/i.test( userAgent ) ) {
461486
expected = expectedMap.ios;
487+
} else if ( typeof URLSearchParams !== "undefined" &&
488+
489+
// `karma-webkit-launcher` adds `test_browser=Playwright` to the query string.
490+
// The normal way of using user agent to detect the browser won't help
491+
// as on macOS Playwright doesn't specify the `Safari` token but on Linux
492+
// it does.
493+
// See https://github.com/google/karma-webkit-launcher#detected-if-safari-or-playwright-is-used
494+
new URLSearchParams( document.referrer || window.location.search ).get(
495+
"test_browser"
496+
) === "Playwright"
497+
) {
498+
expected = expectedMap.webkit;
462499
} else if ( /\b\d+(\.\d+)+ safari/i.test( userAgent ) ) {
463500
expected = expectedMap.safari;
464501
}
@@ -491,7 +528,8 @@ testIframe(
491528
if ( includesModule( "ajax" ) || i !== "ajax" && i !== "cors" ) {
492529
assert.equal( computedSupport[ i ], expected[ i ],
493530
"jQuery.support['" + i + "']: " + computedSupport[ i ] +
494-
", expected['" + i + "']: " + expected[ i ] );
531+
", expected['" + i + "']: " + expected[ i ] +
532+
";\nUser Agent: " + navigator.userAgent );
495533
} else {
496534
assert.ok( true, "no ajax; skipping jQuery.support['" + i + "']" );
497535
}

0 commit comments

Comments
 (0)