shaka-player 3.3.2 → 3.3.3

package/.csslintrc

@@ -1,13 +1,23 @@
 {
     "extends": "stylelint-config-standard",
+    "customSyntax": "postcss-less",
     "rules": {
       "font-family-no-missing-generic-family-keyword": null,
       "declaration-block-single-line-max-declarations": null,
       "declaration-empty-line-before": null,
-      "max-line-length": [ 80, {
+      "max-line-length": [80, {
         ignorePattern: "/^@import\\s+/",
       }],
+      "function-no-unknown": [true, {
+        ignoreFunctions: [
+          "data-uri",
+          "lighten",
+          "percentage",
+        ],
+      }],
+      "property-no-vendor-prefix": null,
       "selector-list-comma-newline-after": "always-multi-line",
+      "selector-no-vendor-prefix": null,
       "selector-pseudo-element-colon-notation": "single",
       "unit-allowed-list": ["em", "%", "px", "s", "deg", "vmin", "ms", "vh"]
     }

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -18,7 +18,7 @@ assignees: ''
 **Can you reproduce the issue with our latest release version?**
 
 
-**Can you reproduce the issue with the latest code from `master`?**
+**Can you reproduce the issue with the latest code from `main`?**
 
 
 **Are you using the demo app or your own custom app?**

package/.github/pull_request_template.md

@@ -1,38 +1,10 @@
-## Description
-
 <!--
-  Give the PR a helpful title that summaries what this PR changes. Here, include
-  a summary of the change and which issue is fixed. Also include relevant
-  motivation and context. List any dependencies that are required for this
-  change.
-
-  If this fixes any issues, include lines like this:
-  Fixes #123
--->
+Please remember to:
 
+1. Use Conventional Commits syntax (fix: ..., feat: ..., etc.) in commits and
+   PR title (https://www.conventionalcommits.org/)
+2. Tag any related or fixed issues ("Issue #123", "Closes #420")
+3. Sign the Google CLA if you haven't (https://cla.developers.google.com)
 
-## Screenshots (optional)
-
-<!--
-  If you change the UI, add before and after screenshots demonstrating your
-  changes.
+You may delete this comment from the PR description.
 -->
-
-
-## Type of change
-
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to
-  not work as expected)
-- [ ] This change requires a documentation update
-
-## Checklist:
-
-- [ ] I have signed the Google CLA <https://cla.developers.google.com>
-- [ ] My code follows the style guidelines of this project
-- [ ] I have made corresponding changes to the documentation
-- [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] I have verified my change on multiple browsers on different platforms
-- [ ] I have run `./build/all.py` and the build passes
-- [ ] I have run `./build/test.py` and all tests pass

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

@@ -0,0 +1,130 @@
+name: Build and Test PR
+
+on:
+  pull_request: # Trigger for pull requests.
+    types: [opened, synchronize, reopened]
+    branches:
+      - main
+      - v[0-9]*
+  workflow_dispatch: # Allows for manual triggering.
+    inputs:
+      ref:
+        description: "The ref to build and test."
+        required: false
+
+# If another instance of this workflow is started for the same PR, cancel the
+# 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 }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.inputs.ref || github.ref }}
+
+      - name: Lint
+        run: python build/check.py
+
+  build_and_test:
+    # Don't waste time doing a full matrix of test runs when there was an
+    # obvious linter error.
+    needs: lint
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        browser: ["Chrome", "Firefox", "Edge", "Safari", "Safari-14"]
+        exclude:
+          - os: ubuntu-latest
+            browser: Edge
+          - os: windows-latest
+            browser: Safari
+          - os: windows-latest
+            browser: Safari-14
+          - os: ubuntu-latest
+            browser: Safari
+          - os: ubuntu-latest
+            browser: Safari-14
+        include:
+          # Run Linux browsers with xvfb, so they're in a headless X session.
+          - os: ubuntu-latest
+            extra_flags: "--use-xvfb"
+      # Disable fail-fast so that one matrix-job failing doesn't make the other
+      # ones end early.
+      fail-fast: false
+
+    name: ${{ matrix.os }} ${{ matrix.browser }}
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      # Firefox on Ubuntu appears to not have the right things installed in
+      # the environment used by GitHub actions, so make sure that ffmpeg is
+      # installed. Otherwise, the browser might not support some codecs that the
+      # tests assume will be supported.
+      - name: Install FFmpeg
+        if: matrix.os == 'ubuntu-latest' && matrix.browser == 'Firefox'
+        run: sudo apt -y update && sudo apt -y install ffmpeg
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.inputs.ref || github.ref }}
+
+      # Safari 14 can be installed, but not to the root, and it can't replace
+      # the standard version, at least not on GitHub's VMs.  If you try to
+      # install directly to the root with sudo, it will appear to succeed, but
+      # will have no effect.  If you try to script it explicitly with rm -rf
+      # and cp, this will fail.  Safari may be on a read-only filesystem.
+      - name: Install Safari 14 to home directory
+        if: matrix.os == 'macos-latest' && matrix.browser == 'Safari-14'
+        run: |
+          # Download Safari 14
+          # See also https://www.macupdate.com/app/mac/15675/apple-safari/old-versions
+          curl -Lv https://www.macupdate.com/action/download/63550 > safari-14.1.2.pkg
+
+          # Install Safari 14 to homedir specifically.
+          installer -pkg safari-14.1.2.pkg -target CurrentUserHomeDirectory
+
+          # Install a launcher that can execute a shell script to launch this
+          npm install karma-script-launcher --save-dev
+
+      - name: Build Player
+        run: python build/all.py
+
+      - name: Test Player
+        shell: bash
+        run: |
+          browser=${{ matrix.browser }}
+
+          if [[ "$browser" == "Safari-14" ]]; then
+            # Replace the browser name with a script that can launch this
+            # browser from the command line.
+            browser="$PWD/.github/workflows/safari-homedir-launcher.sh"
+          fi
+
+          python build/test.py \
+            --browsers "$browser" \
+            --reporters spec --spec-hide-passed \
+            --drm \
+            ${{ matrix.extra_flags }}
+
+  build_in_docker:
+    # Don't waste time doing a full matrix of test runs when there was an
+    # obvious linter error.
+    needs: lint
+    name: Docker
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.inputs.ref || github.ref }}
+
+      - name: Docker
+        run: docker-compose -f build/docker/docker-compose.yml up

package/.github/workflows/custom-actions/prep-for-appspot/action.yaml

@@ -0,0 +1,56 @@
+name: Prep Appspot Deployment
+
+description: |
+  A reusable action that prepares the sources to deploy the Shaka Player Demo
+  to appspot.  Assumes that the source is already checked out.
+
+runs:
+  using: composite
+  steps:
+    - name: Install dependencies
+      shell: bash
+      run: npm ci
+
+    - name: Build Shaka Player
+      shell: bash
+      run: python build/all.py
+
+    - name: Extract git version
+      shell: bash
+      run: |
+        (
+          cd build
+          python3 -c 'from shakaBuildHelpers import git_version; print(git_version())'
+        ) > demo-version
+
+    - name: Tag the Player version
+      shell: bash
+      run: |
+        DEMO_VERSION="$(cat demo-version)-uncompiled"
+        sed \
+            -i lib/player.js \
+            -e "s/\(shaka.Player.version\) = .*/\1 = '$DEMO_VERSION';/"
+        rm demo-version
+
+    - name: Backup demo node modules
+      shell: bash
+      run: |
+        DEMO_NODE_MODULES=$(jq -r .shakaCustom.demoDeps[] package.json)
+        tar cf demo-modules.tar \
+            $(echo "$DEMO_NODE_MODULES" | sed -e 's@^@node_modules/@')
+
+    - name: Delete unneeded files
+      shell: bash
+      run: rm -rf .git .github build externs test node_modules
+
+    - name: Restore demo node modules
+      shell: bash
+      run: |
+        tar xf demo-modules.tar
+        rm demo-modules.tar
+
+    - name: Install App Engine code
+      shell: bash
+      run: |
+        mv app-engine/shaka-player-demo/* .
+        rm README.md

package/.github/workflows/custom-actions/set-commit-status/action.yaml

@@ -0,0 +1,41 @@
+name: Set Commit Status
+
+description: |
+  A reusable action that sets the commit status.  This is used to set PR status
+  from workflows with non-PR triggers (such as manually-triggered workflows).
+
+inputs:
+  context:
+    description: An arbitrary string to identify the status check.
+    required: true
+  state:
+    description: Either "pending", "error", "success", or "failure".
+    required: true
+  ref:
+    description: A git ref for which to set the commit status.  For PRs, use the head commit, not the merge commit.  Defaults to HEAD.
+    required: false
+    default: HEAD
+  token:
+    description: A GitHub access token.
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Report Commit Status
+      shell: bash
+      run: |
+        # This is the URL to view this workflow run on GitHub.  It will be
+        # attached to the commit status, so that when someone clicks "details"
+        # next to the status on the PR, it will link to this run where they can
+        # see the logs.
+        RUN_URL="https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}"
+        SHA1=$(git rev-parse "${{ inputs.ref }}")
+
+        GITHUB_TOKEN=${{ inputs.token }} \
+        gh api \
+          -X POST \
+          -F "context=${{ inputs.context }}" \
+          -F "state=${{ inputs.state }}" \
+          -F "target_url=$RUN_URL" \
+          "repos/${{ github.repository }}/statuses/$SHA1"

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

@@ -0,0 +1,29 @@
+name: Deploy Demo Version Index
+
+on:
+  workflow_dispatch:
+    # Allows for manual triggering.
+  push:
+    branches:
+      - main
+    paths:
+      - .github/workflows/demo-version-index.yaml
+      - app-engine/demo-version-index/**
+
+jobs:
+  appspot:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: google-github-actions/auth@v0
+        with:
+          credentials_json: '${{ secrets.APPENGINE_DEPLOY_KEY }}'
+
+      - uses: google-github-actions/deploy-appengine@v0
+        with:
+          project_id: shaka-player-demo
+          version: index
+          working_directory: app-engine/demo-version-index/
+          promote: false
+

package/.github/workflows/nightly-demo.yaml

@@ -0,0 +1,42 @@
+name: Deploy Nightly Demo
+
+on:
+  workflow_dispatch:
+    # Allows for manual triggering.
+  schedule:
+    # Run every night at midnight PST / 8am UTC.
+    - cron: '0 8 * * *'
+
+jobs:
+  appspot:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+
+      # The nightly demo has its own receiver app ID that points to the nightly
+      # demo itself for the receiver side.
+      - name: Override Cast Receiver App ID
+        run: |
+          sed \
+            -i demo/index.html \
+            -e 's/\(data-shaka-player-cast-receiver-id\)="[^"]*"/\1="07AEE832"/'
+
+      - uses: ./.github/workflows/custom-actions/prep-for-appspot
+
+      - uses: google-github-actions/auth@v0
+        with:
+          credentials_json: '${{ secrets.APPENGINE_DEPLOY_KEY }}'
+
+      - uses: google-github-actions/deploy-appengine@v0
+        with:
+          project_id: shaka-player-demo
+          version: nightly
+          promote: false

package/.github/workflows/release-please.yaml

@@ -0,0 +1,145 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+      - v[0-9]*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      # Create/update release PR
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          # Required input to specify the release type (node package).
+          release-type: node
+          # Make sure we create the PR against the correct branch.
+          default-branch: ${{ github.ref_name }}
+
+      # If we didn't create a release, we may have created or updated a PR.
+      - uses: actions/checkout@v2
+        if: steps.release.outputs.release_created == false
+      - name: Custom update Player version
+        if: steps.release.outputs.release_created == false
+        run: |
+          # Check out the branch that release-please created, if it exists.
+          git fetch
+          git checkout release-please--branches--${{ github.ref_name }} || exit 0
+          # If it does exist, update lib/player.js in the PR branch, so that the
+          # -uncompiled tag remains in the player version in that context.
+          VERSION="v$(jq -r .version package.json)-uncompiled"
+          sed -e "s/^\\(shaka.Player.version =\\).*/\\1 '$VERSION';/" \
+              -i lib/player.js
+          git add lib/player.js
+          # Emulate the actions bot.
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          # Update the PR.
+          git commit --amend --no-edit
+          git push -f
+
+  # The jobs below are all conditional on a release having been created by
+  # someone merging the release PR.  They all run in parallel.
+
+  tag-main:
+    runs-on: ubuntu-latest
+    needs: release
+    if: needs.release.outputs.release_created
+    steps:
+      - uses: actions/checkout@v2
+      - name: Tag the main branch
+        run: |
+          # Emulate the actions bot.
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          VERSION=${{ needs.release.outputs.tag_name }}
+          git tag -m "$VERSION-main" "$VERSION-main"
+          git push origin "$VERSION-main"
+
+  npm:
+    runs-on: ubuntu-latest
+    needs: release
+    if: needs.release.outputs.release_created
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+
+      - run: npm pack
+      - uses: svenstaro/upload-release-action@483c1e56f95e88835747b1c7c60581215016cbf2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ needs.release.outputs.tag_name }}
+          file: shaka-player-*.tgz
+          file_glob: true
+          overwrite: true
+
+  appspot:
+    runs-on: ubuntu-latest
+    needs: release
+    if: needs.release.outputs.release_created
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Compute appspot subdomain and promotion
+        run: |
+          # This is the same as the version tag, but with dots replaced by
+          # dashes.  For example, v3.2.2 would have the subdomain v3-2-2.
+          APPSPOT_SUBDOMAIN=$( echo ${{ needs.release.outputs.tag_name }} | sed -e 's/\./-/g' )
+          echo APPSPOT_SUBDOMAIN=$APPSPOT_SUBDOMAIN >> $GITHUB_ENV
+
+          # "Promoting" an appspot deployment makes it the default which shows
+          # up on shaka-player-demo.appspot.com (no subdomain).  This should be
+          # done for the latest release version from the latest release branch.
+          RELEASE_TAGS=$(git tag | grep ^v[0-9] | grep -Ev -- '-(master|main)')
+          LATEST_RELEASE=$(echo "$RELEASE_TAGS" | sort --version-sort | tail -1)
+          TAG_NAME=${{ needs.release.outputs.tag_name }}
+
+          if [[ "$TAG_NAME" == "$LATEST_RELEASE" ]]; then
+            echo APPSPOT_PROMOTE=true >> $GITHUB_ENV
+          else
+            echo APPSPOT_PROMOTE=false >> $GITHUB_ENV
+          fi
+
+          # Debug the decisions made here.
+          echo "Subdomain: $APPSPOT_SUBDOMAIN"
+          echo "Latest release: $LATEST_RELEASE"
+          echo "This release: $TAG_NAME"
+          echo "Promote: $APPSPOT_PROMOTE"
+
+      - uses: ./.github/workflows/custom-actions/prep-for-appspot
+
+      - uses: google-github-actions/auth@v0
+        with:
+          credentials_json: '${{ secrets.APPENGINE_DEPLOY_KEY }}'
+
+      - uses: google-github-actions/deploy-appengine@v0
+        with:
+          project_id: shaka-player-demo
+          version: ${{ env.APPSPOT_SUBDOMAIN }}
+          promote: ${{ env.APPSPOT_PROMOTE }}

package/.github/workflows/safari-homedir-launcher.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# A script to launch a homedir-installed copy of Safari in Karma.  Used with
+# karma-script-launcher and --browsers path/to/script.
+
+# There is an issue where opening a URL in a browser that is not already open
+# will also open it in the default browser.  See
+# https://apple.stackexchange.com/a/122000/454832 and the comments below it for
+# details.
+
+# The workaround is to open the browser explicitly first, without a URL.
+open -a ~/Applications/Safari.app --fresh
+sleep 5
+
+# Then open the browser with the URL, and wait for it to quite.  In fact, the
+# browser won't be closed automatically at all, and Karma will kill this script
+# when the tests complete.  But if we don't wait, Karma will error instead.
+open -a ~/Applications/Safari.app --wait-apps "$1"

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

@@ -0,0 +1,93 @@
+name: Selenium Lab Tests
+
+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.  If empty, will build and test from main."
+        required: false
+  schedule:
+    # Runs every night at 2am PST / 10am UTC, testing against the main branch.
+    - cron: '0 10 * * *'
+
+# Only one run of this workflow is allowed at a time, since it uses physical
+# resources in our lab.
+concurrency: selenium-lab
+
+jobs:
+  lab-tests:
+    # This is a self-hosted runner in a Docker container, with access to our
+    # lab's Selenium grid on port 4444.
+    runs-on: self-hosted-selenium
+
+    steps:
+      # This runs on our self-hosted runner, and the Docker image it is based
+      # on doesn't have GitHub's CLI pre-installed.  This installs it.  Taken
+      # verbatim from the official installation instructions at
+      # https://github.com/cli/cli/blob/trunk/docs/install_linux.md
+      - name: Install GitHub Actions CLI
+        run: |
+          curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
+          echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
+          sudo apt update
+          sudo apt install gh
+
+      - name: Compute ref
+        run: |
+          if [[ "${{ github.event.inputs.pr }}" != "" ]]; then
+            echo LAB_TEST_REF="refs/pull/${{ github.event.inputs.pr }}/head" >> $GITHUB_ENV
+          else
+            echo LAB_TEST_REF="main" >> $GITHUB_ENV
+          fi
+
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ env.LAB_TEST_REF }}
+
+      - name: Set Commit Status to Pending
+        uses: ./.github/workflows/custom-actions/set-commit-status
+        with:
+          context: Selenium Lab Tests
+          state: pending
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+
+      # The Docker image for this self-hosted runner doesn't contain java.
+      - uses: actions/setup-java@v2
+        with:
+          distribution: zulu
+          java-version: 11
+
+      # The Docker image for this self-hosted runner has "python3" but not
+      # plain "python".
+      - name: Build Player
+        run: python3 build/all.py
+
+      # Run tests on the Selenium grid in our lab.  This uses a private
+      # hostname and TLS cert to get EME tests working on all platforms
+      # (since EME only works on https or localhost).
+      - name: Test Player
+        run: |
+          python3 build/test.py \
+              --reporters spec --spec-hide-passed \
+              --drm \
+              --lets-encrypt-folder /etc/shakalab.rocks \
+              --hostname karma.shakalab.rocks \
+              --port 61731 \
+              --grid-config build/shaka-lab.yaml \
+              --grid-address selenium-grid.lab:4444
+
+      - name: Report Final Commit Status
+        # Will run on success or failure, but not if the workflow is cancelled.
+        if: ${{ success() || failure() }}
+        uses: ./.github/workflows/custom-actions/set-commit-status
+        with:
+          context: Selenium Lab Tests
+          state: ${{ job.status }}
+          token: ${{ secrets.GITHUB_TOKEN }}

package/AUTHORS

@@ -33,6 +33,7 @@ Enson Choy <enson.choy@harmonicinc.com>
 Esteban Dosztal <edosztal@gmail.com>
 Fadomire <fadomire@gmail.com>
 Gil Gonen <gil.gonen@gmail.com>
+Giorgio Gamberoni <giorgio.gamberoni@gmail.com>
 Giuseppe Samela <giuseppe.samela@gmail.com>
 Google Inc. <*@google.com>
 Itay Kinnrot <Itay.Kinnrot@Kaltura.com>
@@ -41,6 +42,7 @@ Jesper Haug Karsrud <jesper.karsrud@gmail.com>
 Johan Sundström <oyasumi@gmail.com>
 Jonas Birmé <jonas.birme@eyevinn.se>
 Jozef Chúťka <jozefchutka@gmail.com>
+Jun Hong Chong <chongjunhong@gmail.com>
 JW Player <*@jwplayer.com>
 Lucas Gabriel Sánchez <unkiwii@gmail.com>
 Matthias Van Parijs <matvp91@gmail.com>