chore: add multi platform browser tests

Author: maartyman

.github/workflows/push.yml

@@ -30,14 +30,10 @@ jobs:
             .rdf-test-suite-cache
             .rdf-test-suite-ldf-cache
           key: ${{ runner.os }}-test-modules-${{ secrets.CACHE_VERSION }}-${{ hashFiles('**/yarn.lock') }}
-      - name: Install dependencies
+      - name: Install dependencies & build
         run: yarn install --pure-lockfile
-      - name: Build project
-        run: yarn run build
       - name: Run depcheck
         run: yarn run depcheck
-      - name: Run browser-tests
-        run: yarn run test-browser
       - name: Run tests
         run: yarn run test-ci
       - name: Submit coverage results
@@ -47,6 +43,47 @@ jobs:
           flag-name: run-${{ matrix.node-version }}
           parallel: true
 
+  test-browser:
+    name: Browser tests
+    strategy:
+      fail-fast: false
+      matrix:
+        browser:
+          - Chrome
+          - Firefox
+          - Webkit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Ensure line endings are consistent
+        run: git config --global core.autocrlf input
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Load cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-test-modules-${{ secrets.CACHE_VERSION }}-${{ hashFiles('**/yarn.lock') }}
+      - name: Install dependencies & build
+        run: yarn install --pure-lockfile
+      - name: Install ${{ matrix.browser }} via Playwright
+        if: startsWith(matrix.browser, 'Webkit')
+        # The @L will convert 'Webkit' into lowercase 'webkit' which is the name Playwright expects.
+        run: yarn playwright install --with-deps ${BROWSER_NAME@L}
+        env:
+          BROWSER_NAME: ${{ matrix.browser }}
+      - name: Run browser tests
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 2
+          max_attempts: 3
+          # The tests will run on 'WebkitHeadless', 'FirefoxHeadless' and 'ChromeHeadless'
+          command: yarn run test-browser --browsers ${{ matrix.browser }}Headless
+
   coveralls:
     needs: test
     runs-on: ubuntu-latest
@@ -78,6 +115,7 @@ jobs:
   docs:
     needs:
       - test
+      - test-browser
       - lint
     if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest

karma.config.js

@@ -1,11 +1,13 @@
-const Path = require('node:path');
+const webkit = require('@playwright/test').webkit;
 const NodePolyfillPlugin = require('node-polyfill-webpack-plugin');
 const webpack = require('webpack');
 
 const testFiles = [
   'engines/query-sparql-incremental/test-browser/QuerySparql-test.ts',
 ];
 
+process.env.WEBKIT_HEADLESS_BIN = webkit.executablePath();
+
 // Based on https://github.com/tom-sherman/blog/blob/main/posts/02-running-jest-tests-in-a-browser.md
 module.exports = function(config) {
   config.set({
@@ -15,6 +17,7 @@ module.exports = function(config) {
       'karma-jasmine',
       'karma-chrome-launcher',
       'karma-firefox-launcher',
+      'karma-webkit-launcher',
       'karma-sourcemap-loader',
       'karma-jasmine-html-reporter',
     ],
@@ -36,7 +39,6 @@ module.exports = function(config) {
         alias: {
           fs: false,
           module: false,
-          [Path.resolve(__dirname, 'engines/query-sparql-incremental/test/util.js')]: Path.resolve(__dirname, 'engines/query-sparql-incremental/test-browser/util-browser.js'),
           'jest.unmock': false,
         },
         extensions: [ '.js', '.jsx', '.ts', '.tsx' ],
@@ -91,6 +93,7 @@ module.exports = function(config) {
     browsers: [
       'ChromeHeadless',
       'FirefoxHeadless',
+      'WebkitHeadless',
     ],
   });
 };

package.json

@@ -40,6 +40,7 @@
   "devDependencies": {
     "@comunica/utils-jest": "^4.0.1",
     "@comunica/utils-monorepo": "^4.0.1",
+    "@playwright/test": "^1.47.2",
     "@rubensworks/eslint-config": "^3.0.0",
     "@types/jest": "^29.0.0",
     "@types/md5": "^2.3.5",
@@ -60,6 +61,7 @@
     "karma-jasmine": "^5.1.0",
     "karma-jasmine-html-reporter": "^2.0.0",
     "karma-sourcemap-loader": "^0.4.0",
+    "karma-webkit-launcher": "^2.6.0",
     "karma-webpack": "^5.0.0",
     "lerna": "^7.4.2",
     "lerna-script": "^1.4.0",

run-browser-tests.js

@@ -162,7 +162,7 @@ function endServers() {
 
 // eslint-disable-next-line no-console
 console.log('Starting Karma tests:');
-const lsProcess = spawn('karma', [ 'start', 'karma.config.js', '--single-run' ]);
+const lsProcess = spawn('karma', [ 'start', 'karma.config.js', '--single-run', ...process.argv.splice(2) ]);
 lsProcess.stdout.on('data', (data) => {
   process.stdout.write(data);
 });

yarn.lock

@@ -3970,6 +3970,13 @@
   resolved "https://registry.yarnpkg.com/@pkgr/core/-/core-0.1.1.tgz#1ec17e2edbec25c8306d424ecfbf13c7de1aaa31"
   integrity sha512-cq8o4cWH0ibXh9VGi5P20Tu9XF/0fFXl9EUinr9QfTM7a7p0oTA4iJRCQWppXR1Pg8dSM0UCItCkPwsk9qWWYA==
 
+"@playwright/test@^1.47.2":
+  version "1.50.1"
+  resolved "https://registry.yarnpkg.com/@playwright/test/-/test-1.50.1.tgz#027d00ca77ec79688764eb765cfe9a688807bf0b"
+  integrity sha512-Jii3aBg+CEDpgnuDxEp/h7BimHcUTDlpEtce89xEumlJ5ef2hqepZ+PWp1DDpYC/VO9fmWVI1IlEaoI5fK9FXQ==
+  dependencies:
+    playwright "1.50.1"
+
 "@rdfjs/types@*", "@rdfjs/types@1.1.2", "@rdfjs/types@^1.1.0", "@rdfjs/types@^2.0.0":
   version "1.1.2"
   resolved "https://registry.yarnpkg.com/@rdfjs/types/-/types-1.1.2.tgz#9c2f9848c44c26d383bed2a808571de3b93b808d"
@@ -8145,6 +8152,11 @@ fs.realpath@^1.0.0:
   resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f"
   integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==
 
+fsevents@2.3.2:
+  version "2.3.2"
+  resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.2.tgz#8a526f78b8fdf4623b709e0b975c52c24c02fd1a"
+  integrity sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==
+
 fsevents@^2.3.2, fsevents@~2.3.2:
   version "2.3.3"
   resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6"
@@ -9134,7 +9146,7 @@ is-callable@^1.1.3, is-callable@^1.1.4, is-callable@^1.2.7:
   resolved "https://registry.yarnpkg.com/is-callable/-/is-callable-1.2.7.tgz#3bc2a85ea742d9e36205dcacdd72ca1fdc51b055"
   integrity sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==
 
-is-ci@3.0.1:
+is-ci@3.0.1, is-ci@^3.0.1:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/is-ci/-/is-ci-3.0.1.tgz#db6ecbed1bd659c43dac0f45661e7674103d1867"
   integrity sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==
@@ -10223,6 +10235,14 @@ karma-sourcemap-loader@^0.4.0:
   dependencies:
     graceful-fs "^4.2.10"
 
+karma-webkit-launcher@^2.6.0:
+  version "2.6.0"
+  resolved "https://registry.yarnpkg.com/karma-webkit-launcher/-/karma-webkit-launcher-2.6.0.tgz#2e3ba096b69139e608d9ce6e89816a17f358b700"
+  integrity sha512-IDURopxJ1SbuqnvPaE+lP2qiP2Ie7I+ojwJRBpr0tfGwObsaVdjMkUkmZ1BcXUtYRt5ogs9cyCH2Wb9sNv0BbQ==
+  dependencies:
+    is-ci "^3.0.1"
+    uuid "^10.0.0"
+
 karma-webpack@^5.0.0:
   version "5.0.0"
   resolved "https://registry.yarnpkg.com/karma-webpack/-/karma-webpack-5.0.0.tgz#2a2c7b80163fe7ffd1010f83f5507f95ef39f840"
@@ -12176,6 +12196,20 @@ pkg-types@^1.0.3, pkg-types@^1.2.0:
     mlly "^1.7.2"
     pathe "^1.1.2"
 
+playwright-core@1.50.1:
+  version "1.50.1"
+  resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.50.1.tgz#6a0484f1f1c939168f40f0ab3828c4a1592c4504"
+  integrity sha512-ra9fsNWayuYumt+NiM069M6OkcRb1FZSK8bgi66AtpFoWkg2+y0bJSNmkFrWhMbEBbVKC/EruAHH3g0zmtwGmQ==
+
+playwright@1.50.1:
+  version "1.50.1"
+  resolved "https://registry.yarnpkg.com/playwright/-/playwright-1.50.1.tgz#2f93216511d65404f676395bfb97b41aa052b180"
+  integrity sha512-G8rwsOQJ63XG6BbKj2w5rHeavFjy5zynBA9zsJMMtBoe/Uf757oG12NXz6e6OirF7RCrTVAKFXbLmn1RbL7Qaw==
+  dependencies:
+    playwright-core "1.50.1"
+  optionalDependencies:
+    fsevents "2.3.2"
+
 please-upgrade-node@^3.2.0:
   version "3.2.0"
   resolved "https://registry.yarnpkg.com/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz#aeddd3f994c933e4ad98b99d9a556efa0e2fe942"
@@ -14656,6 +14690,11 @@ utils-merge@1.0.1:
   resolved "https://registry.yarnpkg.com/utils-merge/-/utils-merge-1.0.1.tgz#9f95710f50a267947b2ccc124741c1028427e713"
   integrity sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==
 
+uuid@^10.0.0:
+  version "10.0.0"
+  resolved "https://registry.yarnpkg.com/uuid/-/uuid-10.0.0.tgz#5a95aa454e6e002725c79055fd42aaba30ca6294"
+  integrity sha512-8XkAphELsDnEGrDxUOHB3RGvXz6TeuYSGEZBOjtTtPm2lwhGBjLgOzLHB63IUWfBpNucQjND6d3AOudO+H3RWQ==
+
 uuid@^9.0.0:
   version "9.0.1"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-9.0.1.tgz#e188d4c8853cc722220392c424cd637f32293f30"