upstream-sync: sync Prebid.js 10.16.0 → 10.17.0

.devcontainer/postCreate.sh

@@ -1,5 +1,8 @@
 echo "Post Create Starting"
 
+export NVM_DIR="/usr/local/share/nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
+
 nvm install
 nvm use
 npm install gulp-cli -g

.github/actions/load/action.yml

@@ -0,0 +1,38 @@
+name: Load working directory
+description: Load working directory saved with "actions/save"
+inputs:
+  name:
+    description: The name used with actions/save
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Node.js
+      uses: actions/setup-node@v6
+      with:
+        node-version: '20'
+    - uses: actions/github-script@v8
+      id: platform
+      with:
+        result-encoding: string
+        script: |
+          const os = require('os');
+          return os.platform();
+    - name: 'Clear working directory'
+      shell: bash
+      run: |
+        rm -r "$(pwd)"/*
+
+    - name: Download artifact
+      uses: actions/download-artifact@v5
+      with:
+        path: '${{ runner.temp }}'
+        name: '${{ inputs.name }}'
+
+    - name: 'Untar working directory'
+      shell: bash
+      run: |
+        wdir="$(pwd)"
+        parent="$(dirname "$wdir")"
+        target="$(basename "$wdir")"
+        tar ${{ steps.platform.outputs.result == 'win32' && '--force-local' || '' }} -C "$parent" -xf '${{ runner.temp }}/${{ inputs.name }}.tar' "$target"

.github/actions/save/action.yml

@@ -0,0 +1,41 @@
+name: Save working directory
+description: Save working directory, preserving permissions
+inputs:
+  prefix:
+    description: Prefix to use for autogenerated names
+    required: false
+  name:
+    description: a name to reference with actions/load
+    required: false
+outputs:
+  name:
+    description: a name to reference with actions/load
+    value: ${{ fromJSON(steps.platform.outputs.result).name }}
+
+runs:
+  using: 'composite'
+  steps:
+    - uses: actions/github-script@v8
+      id: platform
+      with:
+        script: |
+          const os = require('os');
+          const crypto = require("crypto");
+          const id = crypto.randomBytes(16).toString("hex");          
+          return {       
+             name: ${{ inputs.name && format('"{0}"', inputs.name) || format('"{0}" + id', inputs.prefix || '') }},
+             platform: os.platform(),
+          }
+    - name: Tar working directory
+      shell: bash
+      run: |
+        wdir="$(pwd)"
+        parent="$(dirname "$wdir")"
+        target="$(basename "$wdir")"
+        tar ${{ fromJSON(steps.platform.outputs.result).platform == 'win32' && '--force-local' || '' }} -C "$parent" -cf "${{ runner.temp }}/${{ fromJSON(steps.platform.outputs.result).name }}.tar" "$target"
+    - name: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        path: '${{ runner.temp }}/${{ fromJSON(steps.platform.outputs.result).name }}.tar'
+        name: ${{ fromJSON(steps.platform.outputs.result).name }}
+        overwrite: true

.github/actions/wait-for-browserstack/action.yml

@@ -1,18 +1,10 @@
 name: Wait for browserstack sessions
 description: Wait until enough browserstack sessions have become available
-inputs:
-  BROWSERSTACK_USER_NAME:
-    description: "Browserstack user name"
-  BROWSERSTACK_ACCESS_KEY:
-    description: "Browserstack access key"
 
 runs:
   using: 'composite'
   steps:
-    - env:
-        BROWSERSTACK_USERNAME: ${{ inputs.BROWSERSTACK_USER_NAME }}
-        BROWSERSTACK_ACCESS_KEY: ${{ inputs.BROWSERSTACK_ACCESS_KEY }}
-      shell: bash
+    - shell: bash
       run: |
         while            
           status=$(curl -u "${BROWSERSTACK_USERNAME}:${BROWSERSTACK_ACCESS_KEY}" \

.github/workflows/browser-tests.yml

@@ -0,0 +1,116 @@
+name: Run unit tests on all browsers
+on:
+  workflow_call:
+    inputs:
+      chunks:
+        description: Number of chunks to split tests into
+        required: false
+        type: number
+        default: 1
+      build-cmd:
+        description: Build command, run once
+        required: false
+        type: string
+      test-cmd:
+        description: Test command, run once per chunk
+        required: true
+        type: string
+      timeout:
+        description: Timeout on test run
+        required: false
+        type: number
+        default: 10
+    outputs:
+      coverage:
+        description: Artifact name for coverage results
+        value: ${{ jobs.browser-tests.outputs.coverage }}
+    secrets:
+      BROWSERSTACK_USER_NAME:
+        description: "Browserstack user name"
+      BROWSERSTACK_ACCESS_KEY:
+        description: "Browserstack access key"
+jobs:
+  build:
+    uses: ./.github/workflows/build.yml
+    with:
+      build-cmd: ${{ inputs.build-cmd }}
+
+  setup:
+    needs: build
+    name: "Setup environment"
+    runs-on: ubuntu-latest
+    outputs:
+      browsers: ${{ toJSON(fromJSON(steps.define.outputs.result).browsers) }}
+      bstack-key: ${{ steps.bstack-save.outputs.name }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name:  Restore working directory
+        uses: ./.github/actions/load
+        with:
+          name: ${{ needs.build.outputs.built-key }}
+      - name: "Define testing strategy"
+        uses: actions/github-script@v8
+        id: define
+        with:
+          script: |
+            const fs = require('node:fs/promises');
+            const browsers = require('./.github/workflows/browser_testing.json');
+            const excludeFromBstack = Object.values(browsers).map(browser => browser.bsName);
+            const bstackBrowsers = Object.fromEntries(
+              // exlude "latest" version of browsers that we can test on GH actions
+              Object.entries(require('./browsers.json'))
+              .filter(([name, def]) => !excludeFromBstack.includes(def.browser) || def.browser_version !== 'latest')
+            )
+            const updatedBrowsersJson = JSON.stringify(bstackBrowsers, null,  2);
+            console.log("Using browsers.json:", updatedBrowsersJson);
+            await fs.writeFile('./browsers.json', updatedBrowsersJson);
+            return {
+              hasBSBrowsers: Object.keys(bstackBrowsers).length > 0,
+              browsers: Object.entries(browsers).map(([name, def]) => Object.assign({name}, def))
+            }
+      - name: "Save working directory"
+        id: bstack-save
+        if: ${{ fromJSON(steps.define.outputs.result).hasBSBrowsers }}
+        uses: ./.github/actions/save
+        with:
+          prefix: browserstack-
+
+  test-build-logic:
+    needs: build
+    name: "Test build logic"
+    uses:
+      ./.github/workflows/run-tests.yml
+    with:
+      built-key: ${{ needs.build.outputs.built-key }}
+      test-cmd: gulp test-build-logic
+
+  browser-tests:
+    needs: [setup, build]
+    name: "Browser: ${{ matrix.browser.name }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        browser: ${{ fromJSON(needs.setup.outputs.browsers) }}
+    uses:
+      ./.github/workflows/run-tests.yml
+    with:
+      built-key: ${{ needs.build.outputs.built-key }}
+      test-cmd: ${{ inputs.test-cmd }} --browsers ${{ matrix.browser.name }} ${{ matrix.browser.coverage && '--coverage' || '--no-coverage' }}
+      chunks: ${{ inputs.chunks }}
+      runs-on: ${{ matrix.browser.runsOn || 'ubuntu-latest' }}
+
+  browserstack-tests:
+    needs: setup
+    if: ${{ needs.setup.outputs.bstack-key }}
+    name: "Browserstack tests"
+    uses:
+      ./.github/workflows/run-tests.yml
+    with:
+      built-key: ${{ needs.setup.outputs.bstack-key }}
+      test-cmd: ${{ inputs.test-cmd }} --browserstack --no-coverage
+      chunks: ${{ inputs.chunks }}
+      browserstack: true
+    secrets:
+      BROWSERSTACK_USER_NAME: ${{ secrets.BROWSERSTACK_USER_NAME }}
+      BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}

.github/workflows/browser_testing.json

@@ -0,0 +1,17 @@
+{
+  "ChromeHeadless": {
+    "bsName": "chrome",
+    "coverage": true
+  },
+  "EdgeHeadless": {
+    "bsName": "edge",
+    "runsOn": "windows-latest"
+  },
+  "SafariNative": {
+    "bsName": "safari",
+    "runsOn": "macos-latest"
+  },
+  "FirefoxHeadless": {
+    "bsName": "firefox"
+  }
+}

.github/workflows/build.yml

@@ -0,0 +1,43 @@
+name: Run unit tests
+on:
+  workflow_call:
+    inputs:
+      source-key:
+        description: Artifact name for source directory
+        type: string
+        required: false
+        default: source
+      build-cmd:
+        description: Build command
+        required: false
+        type: string
+    outputs:
+      built-key:
+        description: Artifact name for built directory
+        value: ${{ jobs.build.outputs.built-key }}
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    outputs:
+      built-key: ${{ inputs.build-cmd && steps.save.outputs.name || inputs.source-key }}
+    steps:
+      - name: Checkout
+        if: ${{ inputs.build-cmd }}
+        uses: actions/checkout@v5
+      - name: Restore source
+        if: ${{ inputs.build-cmd }}
+        uses: ./.github/actions/load
+        with:
+          name: ${{ inputs.source-key }}
+      - name: Build
+        if: ${{ inputs.build-cmd }}
+        run: ${{ inputs.build-cmd }}
+      - name: 'Save working directory'
+        id: save
+        if: ${{ inputs.build-cmd }}
+        uses: ./.github/actions/save
+        with:
+          prefix: 'build-'