Use BrowserStack to run macOS CI tests

Author: robwalch

.github/workflows/build.yml

@@ -20,6 +20,7 @@ jobs:
       cancel-in-progress: true
     outputs:
       canUseSauce: ${{ steps.check_sauce_access.outputs.result == 'true' }}
+      canUseBrowserStack: ${{ steps.check_browserstack_access.outputs.result == 'true' }}
       tag: ${{ steps.extract_tag.outputs.result }}
       isMainBranch: ${{ github.ref == 'refs/heads/master' }}
     steps:
@@ -33,6 +34,16 @@ jobs:
           CI: true
           SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
           SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
+      - name: check browserstack access
+        id: check_browserstack_access
+        run: |
+          if ! [[ -z "$BROWSERSTACK_USERNAME" ]] && ! [[ -z "$BROWSERSTACK_ACCESS_KEY" ]]; then
+            echo "result=true" >> $GITHUB_OUTPUT
+          fi
+        env:
+          CI: true
+          BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
+          BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
       - name: extract tag
         id: extract_tag
         uses: actions/github-script@v8
@@ -418,16 +429,9 @@ jobs:
       max-parallel: 8
       matrix:
         include:
-          - config: safari-macOS_13
-            ua: safari
-            os: macOS 13
           - config: firefox-win_10
             ua: firefox
             os: Windows 10
-          - config: chrome-mac_13-79.0
-            ua: chrome
-            os: macOS 12
-            uaVersion: '79.0'
 
     steps:
       - uses: actions/checkout@v5
@@ -479,3 +483,81 @@ jobs:
           UA: ${{ matrix.ua }}
           UA_VERSION: ${{ matrix.uaVersion }}
           OS: ${{ matrix.os }}
+
+  test_functional_browserstack:
+    needs: [config, test_unit]
+    if: needs.config.outputs.canUseBrowserStack == 'true'
+    runs-on: ubuntu-latest
+    concurrency:
+      group: 'build:test_functional_browserstack:${{ matrix.config }}:${{ github.ref }}'
+      cancel-in-progress: true
+    continue-on-error: true
+    name: test_functional_browserstack (${{ matrix.config }})
+    strategy:
+      fail-fast: false
+      max-parallel: 4
+      matrix:
+        include:
+          - config: safari-macOS_15
+            ua: safari
+            os: macOS 15
+          - config: chrome-macOS_14
+            ua: chrome
+            os: macOS 14
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: cache node_modules
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - name: use Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version-file: '.node-version'
+
+      - name: download build
+        uses: actions/download-artifact@v5
+        with:
+          name: build
+
+      - name: start BrowserStack Local
+        uses: browserstack/github-actions/setup-local@master
+        with:
+          local-testing: start
+          local-identifier: ${{ github.run_id }}-${{ matrix.config }}
+
+      - name: install
+        run: |
+          npm ci
+        env:
+          CI: true
+
+      - name: run functional tests
+        run: |
+          npm run test:func
+        env:
+          CI: true
+          BROWSERSTACK: 1
+          BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
+          BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+          BROWSERSTACK_LOCAL_IDENTIFIER: ${{ github.run_id }}-${{ matrix.config }}
+          BROWSERSTACK_BUILD_ID: ${{ github.run_id }}-${{ matrix.config }}
+          UA: ${{ matrix.ua }}
+          UA_VERSION: ${{ matrix.uaVersion }}
+          OS: ${{ matrix.os }}
+
+      - name: stop BrowserStack Local
+        if: always()
+        uses: browserstack/github-actions/setup-local@master
+        with:
+          local-testing: stop

package-lock.json

@@ -60,6 +60,7 @@
     "test:func": "BABEL_ENV=development mocha --require @babel/register tests/functional/auto/setup.js --timeout 40000 --exit",
     "test:func:light": "BABEL_ENV=development HLSJS_LIGHT=1 mocha --require @babel/register tests/functional/auto/setup.js --timeout 40000 --exit",
     "test:func:sauce": "SAUCE=1 UA=safari OS='OS X 10.15' BABEL_ENV=development mocha --require @babel/register tests/functional/auto/setup.js --timeout 40000 --exit",
+    "test:func:browserstack": "BROWSERSTACK=1 UA=safari OS='macOS 15' BABEL_ENV=development mocha --require @babel/register tests/functional/auto/setup.js --timeout 40000 --exit",
     "type-check": "tsc --noEmit",
     "type-check:watch": "npm run type-check -- --watch",
     "prepare": "husky"
@@ -92,6 +93,7 @@
     "@typescript-eslint/parser": "8.54.0",
     "babel-loader": "10.1.1",
     "babel-plugin-transform-remove-console": "6.9.4",
+    "browserstack-local": "1.5.13",
     "chai": "6.2.2",
     "chart.js": "2.9.4",
     "chromedriver": "146.0.6",