shaka-player 4.2.8 → 4.2.9

package/.github/workflows/build-and-test.yaml

@@ -16,7 +16,7 @@ on:
 # old one.  If a PR is updated and a new test run is started, the old test run
 # will be cancelled automatically to conserve resources.
 concurrency:
-  group: ${{ github.workflow }}-${{ github.event.inputs.ref || github.ref }}
+  group: ${{ github.workflow }}-${{ inputs.ref || github.ref }}
   cancel-in-progress: true
 
 jobs:
@@ -27,7 +27,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
         with:
-          ref: ${{ github.event.inputs.ref || github.ref }}
+          ref: ${{ inputs.ref || github.ref }}
 
       - name: Lint
         run: python build/check.py
@@ -103,7 +103,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
         with:
-          ref: ${{ github.event.inputs.ref || github.ref }}
+          ref: ${{ inputs.ref || github.ref }}
 
       # Older versions of Safari can be installed, but not to the root, and it
       # can't replace the standard version, at least not on GitHub's VMs.  If
@@ -206,7 +206,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
         with:
-          ref: ${{ github.event.inputs.ref || github.ref }}
+          ref: ${{ inputs.ref || github.ref }}
 
       - name: Docker
         run: |

package/.github/workflows/demo-version-index.yaml

@@ -11,6 +11,12 @@ on:
       - app-engine/demo-version-index/**
   release:
     types: [published]
+  # NOTE: So long as releases are made without a personal access token (PAT),
+  # they will not activate this workflow's release trigger.  For now, the
+  # schedule trigger will compensate for that by updating the index nightly.
+  schedule:
+    # Run every night at 10pm PST / 6am UTC.
+    - cron: '0 6 * * *'
 
 jobs:
   appspot:

package/.github/workflows/selenium-lab-tests.yaml

@@ -9,8 +9,24 @@ on:
         description: "A PR number to build and test in the lab.  If empty, will build and test from main."
         required: false
       test_filter:
-        description: "A filter to run a subset of the tests.  If empty, all tests will run."
+        description: "A regex filter to run a subset of the tests.  If empty, all tests will run."
         required: false
+  workflow_call:
+    # Allows for reuse from other workflows, such as "Update All Screenshots"
+    # workflow.
+    inputs:
+      pr:
+        description: "A PR number to build and test in the lab.  If empty, will build and test from main."
+        required: false
+        type: string
+      test_filter:
+        description: "A regex filter to run a subset of the tests.  If empty, all tests will run."
+        required: false
+        type: string
+      ignore_test_status:
+        description: "If true, ignore test success or failure, never set the commit status, and always upload screenshots."
+        required: false
+        type: boolean
   schedule:
     # Runs every night at 2am PST / 10am UTC, testing against the main branch.
     - cron: '0 10 * * *'
@@ -30,12 +46,12 @@ jobs:
       - name: Compute ref
         id: compute
         run: |
-          if [[ "${{ github.event.inputs.pr }}" != "" ]]; then
-            LAB_TEST_REF="refs/pull/${{ github.event.inputs.pr }}/head"
+          if [[ "${{ inputs.pr }}" != "" ]]; then
+            LAB_TEST_REF="refs/pull/${{ inputs.pr }}/head"
           else
             LAB_TEST_REF="main"
           fi
-          echo "REF=$LAB_TEST_REF" >> $GITHUB_OUTPUT
+          echo "REF=$LAB_TEST_REF" | tee -a $GITHUB_OUTPUT
 
   # Configure the build matrix based on our grid's YAML config.
   # The matrix contents will be computed by this first job and deserialized
@@ -100,6 +116,7 @@ jobs:
           ref: ${{ needs.compute-ref.outputs.REF }}
 
       - name: Set commit status to pending
+        if: ${{ inputs.ignore_test_status == false }}
         uses: ./.github/workflows/custom-actions/set-commit-status
         with:
           context: Selenium / Build
@@ -117,8 +134,9 @@ jobs:
           retention-days: 1
 
       - name: Report final commit status
-        # Will run on success or failure, but not if the workflow is cancelled.
-        if: ${{ success() || failure() }}
+        # Will run on success or failure, but not if the workflow is cancelled
+        # or if we were asked to ignore the test status.
+        if: ${{ (success() || failure()) && inputs.ignore_test_status == false }}
         uses: ./.github/workflows/custom-actions/set-commit-status
         with:
           context: Selenium / Build
@@ -142,6 +160,7 @@ jobs:
           ref: ${{ needs.compute-ref.outputs.REF }}
 
       - name: Set commit status to pending
+        if: ${{ inputs.ignore_test_status == false }}
         uses: ./.github/workflows/custom-actions/set-commit-status
         with:
           context: Selenium / ${{ matrix.browser }}
@@ -185,20 +204,28 @@ jobs:
       # the container.
       - name: Test Player
         run: |
+          # Use of an array keeps elements intact, and allows an element to
+          # contain spaces without being expanded into multiple arguments in a
+          # shell command.
+          extra_flags=()
+
           # Generate a coverage report from uncompiled code on ChromeLinux.
           # It should be the uncompiled build, or else we won't execute any
           # coverage instrumentation on full-stack player integration tests.
           if [[ "${{ matrix.browser }}" == "ChromeLinux" ]]; then
-            extra_flags="--html-coverage-report --uncompiled"
-          else
-            extra_flags=""
+            extra_flags+=(--html-coverage-report --uncompiled)
           fi
 
-          filter="${{ github.event.inputs.test_filter }}"
-          if [[ "$filter" != "" ]]; then
-            extra_flags="$extra_flags --filter $filter"
+          if [[ "${{ inputs.test_filter }}" != "" ]]; then
+            echo "Adding filter: ${{ inputs.test_filter }}"
+            extra_flags+=(--filter "${{ inputs.test_filter }}")
           fi
 
+          # Do not automatically fail when a command fails.  This allows us to
+          # implement the ignore_test_status input by capturing the exit code
+          # and examining it.
+          set +e
+          # Run the tests with any extra flags.
           python3 build/test.py \
               --no-build \
               --reporters spec --spec-hide-passed \
@@ -208,7 +235,18 @@ jobs:
               --grid-config build/shaka-lab.yaml \
               --grid-address selenium-grid.lab:4444 \
               --browsers ${{ matrix.browser }} \
-              $extra_flags
+              "${extra_flags[@]}"
+          # Capture the test exit code immediately after running the tests.
+          # There cannot be any other command between test.py and here.
+          exit_code=$?
+
+          # If ignoring test status, treat this as an exit code of 0 (success).
+          if [[ "${{ inputs.ignore_test_status }}" == "true" ]]; then
+            exit_code=0
+          fi
+
+          # Report the captured (and possibly overridden) exit status.
+          exit $exit_code
 
       - name: Find coverage report (ChromeLinux only)
         id: coverage
@@ -252,7 +290,7 @@ jobs:
       # Upload new screenshots and diffs on failure; ignore if missing
       - name: Upload screenshots
         uses: actions/upload-artifact@v3
-        if: ${{ failure() }}
+        if: ${{ failure() || inputs.ignore_test_status }}
         with:
           # In this workflow, "browser" is the selenium node name, which can
           # contain both browser and OS, such as "ChromeLinux".
@@ -264,8 +302,9 @@ jobs:
           retention-days: 5
 
       - name: Report final commit status
-        # Will run on success or failure, but not if the workflow is cancelled.
-        if: ${{ success() || failure() }}
+        # Will run on success or failure, but not if the workflow is cancelled
+        # or if we were asked to ignore the test status.
+        if: ${{ (success() || failure()) && inputs.ignore_test_status == false }}
         uses: ./.github/workflows/custom-actions/set-commit-status
         with:
           context: Selenium / ${{ matrix.browser }}

package/.github/workflows/update-screenshots.yaml

@@ -0,0 +1,142 @@
+name: Update All Screenshots
+# Updates all screenshots on an existing PR, assuming permission has been given
+# to maintainers to make edits.
+
+on:
+  workflow_dispatch:
+    # Allows for manual triggering on PRs.  They should be reviewed first, to
+    # avoid malicious code executing in the lab.
+    inputs:
+      pr:
+        description: "A PR number to build and test in the lab, then update all the screenshots."
+        required: true
+
+jobs:
+  set-pending-status:
+    name: Set Pending Status
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: refs/pull/${{ inputs.pr }}/head
+
+      - name: Set commit status to pending
+        uses: ./.github/workflows/custom-actions/set-commit-status
+        with:
+          context: Update All Screenshots
+          state: pending
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  run-lab-tests:
+    name: Get Selenium Lab Screenshots
+    needs: [set-pending-status]
+    uses: ./.github/workflows/selenium-lab-tests.yaml
+    with:
+      pr: ${{ inputs.pr }}
+      test_filter: layout
+      ignore_test_status: true
+
+  update-pr:
+    name: Update PR
+    runs-on: ubuntu-latest
+    needs: [run-lab-tests]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: refs/pull/${{ inputs.pr }}/head
+
+      - name: Set commit status to pending
+        uses: ./.github/workflows/custom-actions/set-commit-status
+        with:
+          context: Update All Screenshots
+          state: pending
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: new-screenshots
+
+      - name: Move screenshots
+        run: |
+          # The download-artifact action puts zip file contents into folders by
+          # the name of the artifact, so we can't have them downloaded directly
+          # to the screenshots folder.  Here we move them into the correct
+          # locations.
+          cd new-screenshots
+
+          # "$i" is a folder for an artifact (eg "screenshots-ChromeAndroid"),
+          # and it contains a single folder with the name we use in our
+          # screenshots (eg "chrome-Android").  We want the contents of that
+          # inner folder to be copied to test/test/assets/screenshots/, where a
+          # folder with the same name (eg "chrome-Android") already exists.
+          for i in screenshots*; do
+            cp -a $i/* ../test/test/assets/screenshots/
+          done
+
+      - name: Update screenshots
+        run: |
+          # Install prerequisites.
+          npm ci
+
+          # Update the official screenshots for any that have visibly changed.
+          # This is not a byte-for-byte comparison, but based on pixel diffs.
+          ./build/updateScreenshots.py
+
+          # Emulate the actions bot.
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+          # Commit the changes.  Ignore failure, in case there are no changes.
+          git add test/test/assets/screenshots/*/*.png || true
+          git commit -m ':robot: Update all screenshots' || true
+
+      - name: Update PR
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          # Update the PR.
+          PR_API_URL="/repos/${{ github.repository }}/pulls/${{ inputs.pr }}"
+          REMOTE=$(gh api $PR_API_URL | jq -r .head.repo.html_url)
+          BRANCH=$(gh api $PR_API_URL | jq -r .head.ref)
+
+          # If there were no changes, this will do nothing, but succeed.
+          git push "$REMOTE" HEAD:"$BRANCH"
+
+      - name: Debug
+        uses: mxschmitt/action-tmate@v3.6
+        with:
+          limit-access-to-actor: true
+        if: failure()
+
+  set-final-status:
+    name: Set Final Status
+    runs-on: ubuntu-latest
+    needs: [run-lab-tests, update-pr]
+    # Will run on success or failure, but not if the workflow is cancelled.
+    if: ${{ success() || failure() }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: refs/pull/${{ inputs.pr }}/head
+
+      - name: Compute final status
+        id: compute
+        run: |
+          LAB_TEST_STATUS="${{ needs.run-lab-tests.status }}"
+          UPDATE_PR_STATUS="${{ needs.update-pr.status }}"
+
+          # If run-lab-tests succeeded, use the status of update-pr, otherwise
+          # use run-lab-tests (which is "failed" or "error").
+          if [ "$LAB_TEST_STATUS" == "success" ]; then
+            echo "status=$UPDATE_PR_STATUS" >> $GITHUB_OUTPUT
+          else
+            echo "status=$LAST_TEST_STATUS" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Report final status
+        uses: ./.github/workflows/custom-actions/set-commit-status
+        with:
+          context: Update All Screenshots
+          state: ${{ steps.compute.outputs.status }}
+          token: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [4.2.9](https://github.com/shaka-project/shaka-player/compare/v4.2.8...v4.2.9) (2023-03-01)
+
+
+### Bug Fixes
+
+* **Ads:** Fix CS volume ad ([#5016](https://github.com/shaka-project/shaka-player/issues/5016)) ([70406d0](https://github.com/shaka-project/shaka-player/commit/70406d01f74ef213d1cbd396d9389f91374988af))
+* **Ads:** Fix usage of EventManager on CS ([#5017](https://github.com/shaka-project/shaka-player/issues/5017)) ([4aa25c6](https://github.com/shaka-project/shaka-player/commit/4aa25c6cefa8ebc9f9253873efdfa5eff87475cd))
+* **ads:** Fix VMAP ads stay muted on muted autoplay ([#4995](https://github.com/shaka-project/shaka-player/issues/4995)) ([c80c0bc](https://github.com/shaka-project/shaka-player/commit/c80c0bc9cc89cca1742e9820089b985b0aa1b2f0))
+* Allow the playback of TS without mux.js ([#5041](https://github.com/shaka-project/shaka-player/issues/5041)) ([8a55a25](https://github.com/shaka-project/shaka-player/commit/8a55a252f5b6e29e4e6278772c6591116d43fdd3))
+* Caption can not turn off at iOS Safari ([#4978](https://github.com/shaka-project/shaka-player/issues/4978)) ([0408c91](https://github.com/shaka-project/shaka-player/commit/0408c9166487ee444d48234846f527a60cf23a7b))
+* **Demo:** Allow manifest type for DAI custom assets ([#4977](https://github.com/shaka-project/shaka-player/issues/4977)) ([ea1ab66](https://github.com/shaka-project/shaka-player/commit/ea1ab66f484878cc97c70aeabbf6b22562204ed5))
+* DrmEngine exception thrown when using FairPlay ([#4971](https://github.com/shaka-project/shaka-player/issues/4971)) ([36aab19](https://github.com/shaka-project/shaka-player/commit/36aab19c416d58aae05c5daf8ff229e80184e14f))
+* Failed to set 'currentTime' property on 'HTMLMediaElement' on a Hisense TV ([#4962](https://github.com/shaka-project/shaka-player/issues/4962)) ([b753933](https://github.com/shaka-project/shaka-player/commit/b753933c76d6796cc734984d4a75c207aee71316))
+* Fallback to isTypeSupported when cast namespace is undefined ([#5012](https://github.com/shaka-project/shaka-player/issues/5012)) ([eff0b41](https://github.com/shaka-project/shaka-player/commit/eff0b411b11ed70717e5c9aac526afd9e8a0535f))
+* Fix video/mp2t mimetype conversion. ([#5039](https://github.com/shaka-project/shaka-player/issues/5039)) ([d41602e](https://github.com/shaka-project/shaka-player/commit/d41602e278ef91216bf0d7b1424d057292d2d861))
+* **HLS:** Add `.tsa` and .`tsv` file extensions as valid MPEG2-TS. ([#5034](https://github.com/shaka-project/shaka-player/issues/5034)) ([c72c5f6](https://github.com/shaka-project/shaka-player/commit/c72c5f65d6cc686520eda786ded2bf587ba68c6d))
+* Increase IndexedDB timeout ([#4984](https://github.com/shaka-project/shaka-player/issues/4984)) ([f2d681e](https://github.com/shaka-project/shaka-player/commit/f2d681e0957b86ca341895dbcf1bdcb7cc3ecfbd))
+* **MCap:** Remove robustness when robustness value is default ([#4953](https://github.com/shaka-project/shaka-player/issues/4953)) ([59bbb56](https://github.com/shaka-project/shaka-player/commit/59bbb5662dacca93b7b8becb50d1d4c4140ba516))
+* Prevent content from being restarted after Postroll ads ([#4979](https://github.com/shaka-project/shaka-player/issues/4979)) ([a907a4f](https://github.com/shaka-project/shaka-player/commit/a907a4f98c0d2a5d59c71efb77b228bff5689763)), closes [#4445](https://github.com/shaka-project/shaka-player/issues/4445)
+* Reject TS content on Edge ([#5043](https://github.com/shaka-project/shaka-player/issues/5043)) ([99fb4bb](https://github.com/shaka-project/shaka-player/commit/99fb4bb13c89f38dc43df0833e32a78705d42361))
+* **VTT:** Fix spacing between text lines ([#4961](https://github.com/shaka-project/shaka-player/issues/4961)) ([2bf8526](https://github.com/shaka-project/shaka-player/commit/2bf8526d6f626d7c002f97475e7ff23c2519e014))
+* **WebVTT:** Tags in the WebVTT subtitle are not parsed ([#4960](https://github.com/shaka-project/shaka-player/issues/4960)) ([933ee78](https://github.com/shaka-project/shaka-player/commit/933ee7801d921d8ea2430ba3919ffb9ac2dd8ca2))
+
 ## [4.2.8](https://github.com/shaka-project/shaka-player/compare/v4.2.7...v4.2.8) (2023-01-31)
 
 

package/demo/common/asset.js

@@ -76,6 +76,8 @@ const ShakaDemoAssetInfo = class {
     /** @type {?string} */
     this.imaContentSrcId = null;
     /** @type {?string} */
+    this.imaManifestType = null;
+    /** @type {?string} */
     this.mimeType = null;
     /** @type {?string} */
     this.mediaPlaylistFullMimeType = null;
@@ -267,6 +269,19 @@ const ShakaDemoAssetInfo = class {
     return this;
   }
 
+  /**
+   * @param {string} type
+   * @return {!ShakaDemoAssetInfo}
+   */
+  setIMAManifestType(type) {
+    this.imaManifestType = type;
+    if (!this.features.includes(shakaAssets.Feature.ADS)) {
+      this.addFeature(shakaAssets.Feature.ADS);
+    }
+
+    return this;
+  }
+
   /**
    * @param {string} headerName
    * @param {string} headerValue

package/demo/common/assets.js

@@ -536,7 +536,8 @@ shakaAssets.testAssets = [
       .addFeature(shakaAssets.Feature.MP4)
       .addFeature(shakaAssets.Feature.OFFLINE)
       .setIMAContentSourceId('2528370')
-      .setIMAVideoId('tears-of-steel'),
+      .setIMAVideoId('tears-of-steel')
+      .setIMAManifestType('HLS'),
   new ShakaDemoAssetInfo(
       /* name= */ 'Tears of Steel (live, DASH, Server Side ads)',
       /* iconUri= */ 'https://storage.googleapis.com/shaka-asset-icons/tears_of_steel.png',
@@ -546,7 +547,8 @@ shakaAssets.testAssets = [
       .addFeature(shakaAssets.Feature.MP4)
       .addFeature(shakaAssets.Feature.SUBTITLES)
       .addFeature(shakaAssets.Feature.LIVE)
-      .setIMAAssetKey('PSzZMzAkSXCmlJOWDmRj8Q'),
+      .setIMAAssetKey('PSzZMzAkSXCmlJOWDmRj8Q')
+      .setIMAManifestType('DASH'),
   new ShakaDemoAssetInfo(
       /* name= */ 'Tears of Steel (multicodec, surround + stereo)',
       /* iconUri= */ 'https://storage.googleapis.com/shaka-asset-icons/tears_of_steel.png',

package/demo/common/message_ids.js

@@ -97,6 +97,7 @@ shakaDemo.MessageIds = {
   ADS_TAB: 'DEMO_ADS_TAB',
   IMA_ASSET_KEY: 'DEMO_IMA_ASSET_KEY',
   IMA_CONTENT_SRC_ID: 'DEMO_IMA_CONTENT_SRC_ID',
+  IMA_MANIFEST_TYPE: 'DEMO_IMA_MANIFEST_TYPE',
   IMA_VIDEO_ID: 'DEMO_IMA_VIDEO_ID',
   CANCEL_BUTTON: 'DEMO_CANCEL_BUTTON',
   CUSTOM_INTRO_ONE: 'DEMO_CUSTOM_INTRO_ONE',

package/demo/custom.js

@@ -362,6 +362,25 @@ shakaDemo.Custom = class {
     this.makeField_(
         container, assetKeyName, assetKeySetup, assetKeyChange);
 
+    // Make the manifest type field.
+    const manifestTypeSetup = (input, container) => {
+      if (assetInProgress.imaManifestType) {
+        input.value = assetInProgress.imaManifestType;
+      }
+
+      this.manifestField_.required =
+        this.checkManifestRequired_(assetInProgress);
+    };
+    const manifestTypeChange = (input) => {
+      assetInProgress.imaManifestType = input.value;
+      this.manifestField_.required =
+        this.checkManifestRequired_(assetInProgress);
+    };
+    const manifestTypeName = shakaDemoMain.getLocalizedString(
+        shakaDemo.MessageIds.IMA_MANIFEST_TYPE);
+    this.makeField_(
+        container, manifestTypeName, manifestTypeSetup, manifestTypeChange);
+
     return adsDiv;
   }
 

package/demo/locales/en.json

@@ -100,6 +100,7 @@
   "DEMO_IGNORE_HLS_TEXT_FAILURES": "Ignore HLS Text Stream Failures",
   "DEMO_IMA_ASSET_KEY": "Asset key (for LIVE DAI Content)",
   "DEMO_IMA_CONTENT_SRC_ID": "Content source ID (for VOD DAI Content)",
+  "DEMO_IMA_MANIFEST_TYPE": "Manifest type (for DAI Content)",
   "DEMO_IMA_VIDEO_ID": "Video ID (for VOD DAI Content)",
   "DEMO_IGNORE_MANIFEST_PROGRAM_DATE_TIME": "Ignore Program Date Time from manifest",
   "DEMO_IGNORE_MIN_BUFFER_TIME": "Ignore Min Buffer Time",

package/demo/locales/source.json

@@ -403,6 +403,10 @@
     "description": "The label on a field that allows users to provide a content source id for a custom asset.",
     "message": "Asset key (for VOD DAI Content)"
   },
+  "DEMO_IMA_MANIFEST_TYPE": {
+    "description": "The label on a field that allows users to provide a manifest type for a custom asset.",
+    "message": "Manifest type (for DAI Content)"
+  },
   "DEMO_IMA_VIDEO_ID": {
     "description": "The label on a field that allows users to provide a video id for a custom asset.",
     "message": "Video ID (for VOD DAI Content)"

package/demo/main.js

@@ -1505,6 +1505,20 @@ shakaDemo.Main = class {
         request.contentSourceId = asset.imaContentSrcId;
         request.videoId = asset.imaVideoId;
       }
+      switch (asset.imaManifestType) {
+        case 'DASH':
+        case 'dash':
+        case 'MPD':
+        case 'mpd':
+          request.format = google.ima.dai.api.StreamRequest.StreamFormat.DASH;
+          break;
+        case 'HLS':
+        case 'hls':
+        case 'M3U8':
+        case 'm3u8':
+          request.format = google.ima.dai.api.StreamRequest.StreamFormat.HLS;
+          break;
+      }
 
       const uri = await adManager.requestServerSideStream(
           request, /* backupUri= */ asset.manifestUri);