shaka-player 4.3.10 → 4.3.11

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

@@ -21,10 +21,18 @@ jobs:
           release-type: node
           # Make sure we create the PR against the correct branch.
           default-branch: ${{ github.ref_name }}
+          # Use a special shaka-bot access token for releases.
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
 
       # If we didn't create a release, we may have created or updated a PR.
+      # Check out the code, then update the Player version in the PR.
       - uses: actions/checkout@v3
         if: steps.release.outputs.release_created == false
+        with:
+          # Checkout the fork, where the PR is generated from.
+          repository: shaka-bot/${{ github.event.repository.name }}
+          # Use a special shaka-bot access token for releases.
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
       - name: Custom update Player version
         if: steps.release.outputs.release_created == false
         run: |
@@ -38,9 +46,9 @@ jobs:
           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"
+          # Set missing git config for the commit.
+          git config user.name "shaka-bot"
+          git config user.email "shaka-bot@users.noreply.github.com"
           # Update the PR.
           git commit --amend --no-edit
           git push -f
@@ -55,12 +63,17 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
+          # Check out the origin repo, not the fork, and do it at main, not the
+          # PR branch.
           ref: main
+          # Use a special shaka-bot access token for releases.
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
       - 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"
+          # Set missing git config for the tag.
+          git config user.name "shaka-bot"
+          git config user.email "shaka-bot@users.noreply.github.com"
+          # Tag the main branch.
           VERSION=${{ needs.release.outputs.tag_name }}
           git tag -m "$VERSION-main" "$VERSION-main"
           git push origin "$VERSION-main"
@@ -155,6 +168,8 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
+          # Use a special shaka-bot access token for releases.
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
 
       - name: Create release branch
         run: |

package/.github/workflows/report-incremental-coverage.yaml

@@ -21,7 +21,7 @@ jobs:
         id: compute
         shell: bash
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.SHAKA_BOT_TOKEN }}
         # Fetches the coverage data from the run that triggered the report,
         # parses it, compares it to the changed lines in the PR, and computes
         # the incremental code coverage.
@@ -36,4 +36,4 @@ jobs:
           message: "Incremental code coverage: ${{ steps.compute.outputs.coverage }}"
           comment_includes: "Incremental code coverage: "
           pr_number: ${{ steps.compute.outputs.pr_number }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.SHAKA_BOT_TOKEN }}

package/.github/workflows/shaka-bot-commands/command-help.sh

@@ -0,0 +1,27 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# The help command implementation.
+# Assumes that lib.sh has been loaded and all required variables are set.
+
+# Using single quotes to avoid executing the things in backticks, which are
+# really markdown.
+(
+  echo 'I honor the following commands from anyone:'
+  echo ' - `@shaka-bot help`: Show this help message'
+  echo ''
+  echo 'I honor the following commands from maintainers only:'
+  echo ' - `@shaka-bot test`: Start lab tests on all devices'
+  echo ' - `@shaka-bot test ce`: Start lab tests on CE devices only (no desktop browsers)'
+) | reply_from_pipe

package/.github/workflows/shaka-bot-commands/command-test.sh

@@ -0,0 +1,56 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# The test command implementation.
+# Assumes that lib.sh has been loaded and all required variables are set.
+
+if ! check_permissions; then
+  reply "Only maintainers may start lab tests."
+  exit 0
+fi
+
+# These are passed to the lab testing workflow.
+WORKFLOW_ARGS=( "pr=$PR_NUMBER" )
+
+case "${SHAKA_BOT_ARGUMENTS[0]}" in
+  # CE devices only.
+  ce) WORKFLOW_ARGS+=( "browser_filter=Tizen Chromecast ChromeAndroid" ) ;;
+
+  # No command argument, no extra workflow arguments.
+  "") ;;
+
+  *)
+    reply "Unrecognized test argument: ${SHAKA_BOT_ARGUMENTS[0]}"
+    exit 1
+    ;;
+esac
+
+if start_workflow selenium-lab-tests.yaml "${WORKFLOW_ARGS[@]}"; then
+  (
+    echo "Lab tests started with arguments:"
+    for arg in "${WORKFLOW_ARGS[@]}"; do
+      echo " - \`$arg\`"
+    done
+  ) | reply_from_pipe
+else
+  (
+    echo "I failed to start the lab test workflow."
+    echo ""
+    echo "Please check GitHub Actions logs for details."
+  ) | reply_from_pipe
+
+  # Fail this workflow to make it easier to find the right run
+  # and its logs.
+  exit 1
+fi

package/.github/workflows/shaka-bot-commands/lib.sh

@@ -0,0 +1,83 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Utilities for handling @shaka-bot commands.
+
+# Ignore case in all string comparisons.
+shopt -s nocasematch
+
+function check_required_variable() {
+  local VAR_NAME="$1"
+
+  # The ! syntax here is Bash variable indirection.
+  if [[ -z "${!VAR_NAME}" ]]; then
+    echo "Missing environment variable: $VAR_NAME"
+    exit 1
+  fi
+}
+
+# Leaving a comment requires a token with "repo" scope.
+function reply() {
+  echo "@$COMMENTER: $@" | \
+      gh issue comment "$PR_NUMBER" -R "$THIS_REPO" -F -
+}
+
+# Leaving a comment requires a token with "repo" scope.
+function reply_from_pipe() {
+  (echo -n "@$COMMENTER: "; cat /dev/stdin) | \
+      gh issue comment "$PR_NUMBER" -R "$THIS_REPO" -F -
+}
+
+# Checking permissions requires a token with "repo" and "org:read" scopes, and
+# write access.
+function check_permissions() {
+  # Check permissions: this API call fails if the commenter has no special
+  # permissions on the repo.
+  gh api "/repos/$THIS_REPO/collaborators/$COMMENTER"
+}
+
+# Starting a workflow requires a token with "repo" scope and write access.
+# $1 is the workflow filename.  Subsequent arguments are key=value pairs to be
+# passed as input to the workflow_dispatch event.
+function start_workflow() {
+  local WORKFLOW="$1"
+  shift
+
+  # The gh command wants -f before each key-value pair.  The caller shouldn't
+  # have to know that, so we rebuild the argument array with -f here.
+  local GH_ARGS=()
+  for arg in "$@"; do
+    GH_ARGS+=( "-f" "$arg" )
+  done
+
+  gh workflow run "$WORKFLOW" -R "$THIS_REPO" "${GH_ARGS[@]}"
+}
+
+# Outputs to global variables SHAKA_BOT_COMMAND and SHAKA_BOT_ARGUMENTS (array).
+function parse_command() {
+  # Tokenize the comment by whitespace.
+  local TOKENS=( $COMMENT_BODY )
+
+  local INDEX
+  for (( INDEX=0; INDEX < ${#TOKENS[@]}; INDEX++ )); do
+    if [[ "${TOKENS[i]}" == "@shaka-bot" ]]; then
+      SHAKA_BOT_COMMAND="${TOKENS[i+1]}"
+      # A slice of all tokens starting with index i+2.
+      SHAKA_BOT_ARGUMENTS=( "${TOKENS[@]:i+2}" )
+      return 0
+    fi
+  done
+
+  return 1
+}

package/.github/workflows/shaka-bot-commands/main.sh

@@ -0,0 +1,51 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Handle @shaka-bot commands commented on PRs.
+
+# Run everything from the folder in which this script lives.
+cd "$(dirname "$0")"
+
+# Load utils.
+. lib.sh
+
+# Check required environment variables passed from the workflow.
+# If running this manually while testing changes, supply these.
+check_required_variable GH_TOKEN      # With repo & org:read scope, write access
+check_required_variable THIS_REPO     # like shaka-project/shaka-player
+check_required_variable COMMENTER     # like joeyparrish
+check_required_variable PR_NUMBER     # like 1234
+check_required_variable COMMENT_BODY  # like "@shaka-bot howdy"
+
+if [[ "$COMMENTER" == "shaka-bot" ]]; then
+  # Exclude comments by shaka-bot, who will sometimes use its own name.
+  exit 0
+fi
+
+# Parse the command.  Outputs to globals SHAKA_BOT_COMMAND and
+# SHAKA_BOT_ARGUMENTS (array).
+parse_command
+
+if [[ "$SHAKA_BOT_COMMAND" == "" ]]; then
+  # No command found.
+  exit 0
+fi
+
+echo "PR $PR_NUMBER, detected command $SHAKA_BOT_COMMAND"
+
+case "$SHAKA_BOT_COMMAND" in
+  help) . command-help.sh ;;
+  test) . command-test.sh ;;
+  *) echo "Unknown command!" ;;
+esac

package/.github/workflows/talk-to-shaka-bot.yaml

@@ -0,0 +1,29 @@
+name: Talk to Shaka Bot (PRs)
+
+# Runs when comments are created or edited.  Jobs below will be filtered to
+# only run on PRs, not regular issues.
+on:
+  issue_comment:
+    types: [created, edited]
+
+jobs:
+  handle_command:
+    # Only runs on PRs that contain '@shaka-bot' comments, but not comments
+    # made by shaka-bot itself, who will sometimes use its own name.
+    # Note that contains() is not case sensitive.
+    if: github.event.issue.pull_request && contains(github.event.comment.body, '@shaka-bot') && github.event.comment.user.login != 'shaka-bot'
+    runs-on: [ubuntu-latest]
+    env:
+      # This token must have "repo" scope, "org:read" scope, and write access.
+      GH_TOKEN: ${{ secrets.SHAKA_BOT_TOKEN }}
+      THIS_REPO: ${{ github.repository }}
+      COMMENTER: ${{ github.event.comment.user.login }}
+      PR_NUMBER: ${{ github.event.issue.number }}
+      COMMENT_BODY: ${{ github.event.comment.body }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Handle command
+        shell: bash
+        run: .github/workflows/shaka-bot-commands/main.sh

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

@@ -23,7 +23,8 @@ jobs:
 
       - name: Update Issues
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # Use SHAKA_BOT_TOKEN if found, otherwise the default GITHUB_TOKEN.
+          GITHUB_TOKEN: ${{ secrets.SHAKA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
         run: |
           cd update-issues
           npm ci

package/.github/workflows/validate-pr-title.yaml

@@ -1,19 +1,11 @@
 name: Validate PR Title
 
-# We recommend that maintainers use this Chrome/Firefox extension so that
-# squashed PRs will have the merged commit message default to the PR title and
-# description:  https://github.com/zachwhaley/squashed-merge-message
-#
-# This avoids the need to amend commits after the fact to match the desired PR
-# syntax.  As long as the PR itself is properly-formatted, this extension will
-# help you commit the right format to the repo, too.  This, in turn, feeds the
-# changelog and release workflows.
-
 on:
   # NOTE: The automated PRs from release-please-action do not seem to trigger
   # any of the default PR triggers (opened, synchronize, reopened).  So we need
   # additional types.  This is a good set that makes it easy to trigger the
-  # workflow manually if needed.
+  # workflow manually if needed.  This is not neccessary if your release-please
+  # workflow uses a personal access token (PAT) from Shaka Bot.
   pull_request_target:
     types:
       - opened
@@ -30,6 +22,6 @@ jobs:
     name: Validate PR Title
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v4
+      - uses: amannn/action-semantic-pull-request@v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.3.11](https://github.com/shaka-project/shaka-player/compare/v4.3.10...v4.3.11) (2023-09-02)
+
+
+### Bug Fixes
+
+* **HLS:** Allow audio groups on audio-only content ([#5578](https://github.com/shaka-project/shaka-player/issues/5578)) ([9028495](https://github.com/shaka-project/shaka-player/commit/90284959bda3c0cadcacbd7acbe0425d3028d9d5))
+
 ## [4.3.10](https://github.com/shaka-project/shaka-player/compare/v4.3.9...v4.3.10) (2023-08-30)
 
 

package/dist/locales.js

@@ -721,45 +721,45 @@ shaka.ui.Locales.addTo = function(localization) {
  * @const
  */
 shaka.ui.Locales.Ids = {
-  OFF: 'OFF',
-  ENTER_LOOP_MODE: 'ENTER_LOOP_MODE',
-  AIRPLAY: 'AIRPLAY',
-  STATISTICS: 'STATISTICS',
-  RESOLUTION: 'RESOLUTION',
-  MORE_SETTINGS: 'MORE_SETTINGS',
-  MUTE: 'MUTE',
-  AUTO_QUALITY: 'AUTO_QUALITY',
-  SUBTITLE_FORCED: 'SUBTITLE_FORCED',
-  AD_PROGRESS: 'AD_PROGRESS',
-  CAST: 'CAST',
-  BACK: 'BACK',
-  EXIT_LOOP_MODE: 'EXIT_LOOP_MODE',
-  UNRECOGNIZED_LANGUAGE: 'UNRECOGNIZED_LANGUAGE',
+  QUALITY: 'QUALITY',
+  SEEK: 'SEEK',
+  REWIND: 'REWIND',
   VOLUME: 'VOLUME',
+  AIRPLAY: 'AIRPLAY',
+  UNMUTE: 'UNMUTE',
+  PAUSE: 'PAUSE',
+  ENTER_PICTURE_IN_PICTURE: 'ENTER_PICTURE_IN_PICTURE',
   LIVE: 'LIVE',
-  PLAYBACK_RATE: 'PLAYBACK_RATE',
+  EXIT_LOOP_MODE: 'EXIT_LOOP_MODE',
   FULL_SCREEN: 'FULL_SCREEN',
-  PICTURE_IN_PICTURE: 'PICTURE_IN_PICTURE',
-  AD_TIME: 'AD_TIME',
-  LOOP: 'LOOP',
-  NOT_APPLICABLE: 'NOT_APPLICABLE',
-  LANGUAGE: 'LANGUAGE',
-  ENTER_PICTURE_IN_PICTURE: 'ENTER_PICTURE_IN_PICTURE',
-  EXIT_PICTURE_IN_PICTURE: 'EXIT_PICTURE_IN_PICTURE',
-  UNDETERMINED_LANGUAGE: 'UNDETERMINED_LANGUAGE',
-  SKIP_TO_LIVE: 'SKIP_TO_LIVE',
+  CAST: 'CAST',
+  ON: 'ON',
+  UNRECOGNIZED_LANGUAGE: 'UNRECOGNIZED_LANGUAGE',
+  EXIT_FULL_SCREEN: 'EXIT_FULL_SCREEN',
   MULTIPLE_LANGUAGES: 'MULTIPLE_LANGUAGES',
-  UNMUTE: 'UNMUTE',
-  SEEK: 'SEEK',
   AD_DURATION: 'AD_DURATION',
+  PLAYBACK_RATE: 'PLAYBACK_RATE',
+  REPLAY: 'REPLAY',
+  BACK: 'BACK',
+  UNDETERMINED_LANGUAGE: 'UNDETERMINED_LANGUAGE',
+  ENTER_LOOP_MODE: 'ENTER_LOOP_MODE',
+  NOT_APPLICABLE: 'NOT_APPLICABLE',
+  RESOLUTION: 'RESOLUTION',
+  LOOP: 'LOOP',
+  SUBTITLE_FORCED: 'SUBTITLE_FORCED',
+  OFF: 'OFF',
+  AD_TIME: 'AD_TIME',
   CAPTIONS: 'CAPTIONS',
+  MORE_SETTINGS: 'MORE_SETTINGS',
+  MUTE: 'MUTE',
   PLAY: 'PLAY',
-  REPLAY: 'REPLAY',
-  EXIT_FULL_SCREEN: 'EXIT_FULL_SCREEN',
-  ON: 'ON',
-  REWIND: 'REWIND',
+  STATISTICS: 'STATISTICS',
+  PICTURE_IN_PICTURE: 'PICTURE_IN_PICTURE',
+  AD_PROGRESS: 'AD_PROGRESS',
+  LANGUAGE: 'LANGUAGE',
   FAST_FORWARD: 'FAST_FORWARD',
-  PAUSE: 'PAUSE',
   SKIP_AD: 'SKIP_AD',
-  QUALITY: 'QUALITY',
+  AUTO_QUALITY: 'AUTO_QUALITY',
+  EXIT_PICTURE_IN_PICTURE: 'EXIT_PICTURE_IN_PICTURE',
+  SKIP_TO_LIVE: 'SKIP_TO_LIVE',
 };