shaka-player 3.2.4 → 3.2.5

package/app-engine/shaka-player-demo/posters.py

@@ -0,0 +1,110 @@
+# Shaka Player Demo - Poster Definitions
+# Copyright 2022 Google LLC
+# SPDX-License-Identifier: Apache-2.0
+
+# A Doodle-like service to change the poster on certain days.
+# All posters are chosen based on the current date in PST.
+
+# Month constants to make specific dates easier to read.
+JANUARY = 1
+FEBRUARY = 2
+MARCH = 3
+APRIL = 4
+MAY = 5
+JUNE = 6
+JULY = 7
+AUGUST = 8
+SEPTEMBER = 9
+OCTOBER = 10
+NOVEMBER = 11
+DECEMBER = 12
+
+# Special posters for certain days.
+VIDEO_POSTERS = {
+  # These are the same every year:
+  # =====
+  (FEBRUARY, 14): 'valentines.png',
+  (APRIL, 1): 'colorbars.gif',
+  (APRIL, 5): 'trek.jpg',  # "First Contact Day": https://bit.ly/2CSXbxw
+  (OCTOBER, 31): 'zombie.jpg',
+  # =====
+
+  # These birthday posters changed each year:
+  (DECEMBER, 19, 2015): '1yo.jpg',
+  (DECEMBER, 19, 2016): '2yo.png',
+  (DECEMBER, 19, 2017): '3yo.png',
+
+  # After this, the birthday poster shows for a whole week:
+  (DECEMBER, 17, 2018): '4yo.png',
+  (DECEMBER, 18, 2018): '4yo.png',
+  (DECEMBER, 19, 2018): '4yo.png',
+  (DECEMBER, 20, 2018): '4yo.png',
+
+  (DECEMBER, 19, 2019): '5yo.png',
+  (DECEMBER, 20, 2019): '5yo.png',
+  (DECEMBER, 21, 2019): '5yo.png',
+  (DECEMBER, 22, 2019): '5yo.png',
+  (DECEMBER, 23, 2019): '5yo.png',
+  (DECEMBER, 24, 2019): '5yo.png',
+  (DECEMBER, 25, 2019): '5yo.png',
+
+  (DECEMBER, 19, 2020): '6yo.png',
+  (DECEMBER, 20, 2020): '6yo.png',
+  (DECEMBER, 21, 2020): '6yo.png',
+  (DECEMBER, 22, 2020): '6yo.png',
+  (DECEMBER, 23, 2020): '6yo.png',
+  (DECEMBER, 24, 2020): '6yo.png',
+  (DECEMBER, 25, 2020): '6yo.png',
+
+  (DECEMBER, 19, 2021): '7yo.png',
+  (DECEMBER, 20, 2021): '7yo.png',
+  (DECEMBER, 21, 2021): '7yo.png',
+  (DECEMBER, 22, 2021): '7yo.png',
+  (DECEMBER, 23, 2021): '7yo.png',
+  (DECEMBER, 24, 2021): '7yo.png',
+  (DECEMBER, 25, 2021): '7yo.png',
+
+  (DECEMBER, 19, 2022): '8yo.png',
+  (DECEMBER, 20, 2022): '8yo.png',
+  (DECEMBER, 21, 2022): '8yo.png',
+  (DECEMBER, 22, 2022): '8yo.png',
+  (DECEMBER, 23, 2022): '8yo.png',
+  (DECEMBER, 24, 2022): '8yo.png',
+  (DECEMBER, 25, 2022): '8yo.png',
+
+  (DECEMBER, 19, 2023): '9yo.png',
+  (DECEMBER, 20, 2023): '9yo.png',
+  (DECEMBER, 21, 2023): '9yo.png',
+  (DECEMBER, 22, 2023): '9yo.png',
+  (DECEMBER, 23, 2023): '9yo.png',
+  (DECEMBER, 24, 2023): '9yo.png',
+  (DECEMBER, 25, 2023): '9yo.png',
+
+  (DECEMBER, 19, 2024): '10yo.png',
+  (DECEMBER, 20, 2024): '10yo.png',
+  (DECEMBER, 21, 2024): '10yo.png',
+  (DECEMBER, 22, 2024): '10yo.png',
+  (DECEMBER, 23, 2024): '10yo.png',
+  (DECEMBER, 24, 2024): '10yo.png',
+  (DECEMBER, 25, 2024): '10yo.png',
+}
+
+# The default poster.
+VIDEO_DEFAULT = 'standard.png'
+
+# Special audio-only posters.
+AUDIO_POSTERS = {
+  # http://discordia.wikia.com/wiki/Chaoflux
+  (FEBRUARY, 19): 'audioRickRoll.gif',
+  # http://discordia.wikia.com/wiki/Discoflux
+  (MAY, 3): 'audioRickRoll.gif',
+  # http://discordia.wikia.com/wiki/Confuflux
+  (JULY, 15): 'audioRickRoll.gif',
+  # http://discordia.wikia.com/wiki/Bureflux
+  (SEPTEMBER, 26): 'audioRickRoll.gif',
+  # http://discordia.wikia.com/wiki/Afflux
+  (DECEMBER, 8): 'audioRickRoll.gif',
+}
+
+# The default audio-only poster.
+AUDIO_DEFAULT = 'audioOnly.gif'

package/app-engine/shaka-player-demo/requirements.txt

@@ -0,0 +1,5 @@
+# Shaka Player Demo - Appspot Python Runtime Requirements
+# Copyright 2022 Google LLC
+# SPDX-License-Identifier: Apache-2.0
+
+Flask==2.0.3

package/app-engine/shaka-player-demo/time.txt

@@ -0,0 +1 @@
+Time is an illusion; lunchtime doubly so.

package/build/README.md

@@ -99,7 +99,7 @@ will choose a defaults based on your platform.  However, if you pass any
 arguments to `test.py`, it will not choose browsers and you *must* pass
 `--browsers`.
 
-[lib/debug/log.js]: https://github.com/google/shaka-player/blob/master/lib/debug/log.js
+[lib/debug/log.js]: https://github.com/shaka-project/shaka-player/blob/main/lib/debug/log.js
 
 ## Stats
 

package/build/conformance.textproto

@@ -306,3 +306,16 @@ requirement: {
                  'instead.'
   whitelist_regexp: 'lib/net/http_fetch_plugin.js'
 }
+
+# Disallow the use of generators, which are a major performance issue.  See
+# https://github.com/shaka-project/shaka-player/issues/4062#issuecomment-1079428268
+requirement: {
+  type: BANNED_CODE_PATTERN
+  value:
+    "/** @param {*} x */ "
+    "function *template(x) { yield x; }"
+  error_message:
+    "ES6 generators are a major performance issue!  Find another solution. "
+    "See also https://bit.ly/3wAsoj5"
+  whitelist_regexp: "node_modules/"
+}

package/build/docker/Dockerfile

@@ -0,0 +1,20 @@
+# Alpine was chosen by providing a node container less than 100mb
+FROM node:17.7.1-alpine3.15
+
+WORKDIR /usr/src/app
+
+# Install dependencies
+RUN apk add --update --no-cache openssh git python3 openjdk11-jre-headless
+RUN ln -sf python3 /usr/bin/python
+
+# Change to non-root user
+USER node
+
+# Prevent proxy timeout error (very slow connections)
+RUN npm config set fetch-retry-mintimeout 20000
+RUN npm config set fetch-retry-maxtimeout 120000
+RUN npm config rm proxy
+RUN npm config rm https-proxy
+
+# Run compilation
+CMD [ "python", "build/all.py" ]

package/build/docker/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3'
+
+services:
+  shaka-compiler:
+    build: ./
+    container_name: shaka-compiler
+    volumes:
+      - ../../:/usr/src/app
+
+# Others services can be added here

package/build/gendeps.py

@@ -24,17 +24,6 @@ import sys
 import shakaBuildHelpers
 
 
-# The relative path in each of these is relative to Closure's base.js, which
-# lives at node_modules/google-closure-library/closure/goog/base.js
-deps_args = [
-    '--root_with_prefix=lib ../../../../lib',
-    '--root_with_prefix=ui ../../../../ui',
-    '--root_with_prefix=third_party ../../../../third_party',
-    '--root_with_prefix=dist ../../../../dist',
-    '--root_with_prefix=demo ../../../../demo',
-]
-
-
 def main(_):
   """Generates the uncompiled dependencies files."""
   # Update node modules if needed.
@@ -50,13 +39,27 @@ def main(_):
   except OSError:
     pass
   os.chdir(base)
-  deps_writer = os.path.join(
-      'node_modules', 'google-closure-library',
-      'closure', 'bin', 'build', 'depswriter.py')
+
+  make_deps = shakaBuildHelpers.get_node_binary(
+      'google-closure-deps', 'closure-make-deps')
 
   try:
-    cmd_line = [sys.executable or 'python', deps_writer] + deps_args
+    cmd_line = make_deps + [
+      # Folders to search for sources using goog.require/goog.provide
+      '-r', 'demo', 'lib', 'ui', 'third_party',
+      # Individual files to add to those
+      '-f', 'dist/locales.js',
+      # The path to the folder containing the Closure library's base.js
+      '--closure-path', 'node_modules/google-closure-library/closure/goog',
+    ]
     deps = shakaBuildHelpers.execute_get_output(cmd_line)
+
+    # This command doesn't use exit codes for some stupid reason.
+    # TODO: Remove when https://github.com/google/closure-library/issues/1162
+    # is resolved and we have upgraded.
+    if len(deps) == 0:
+      return 1
+
     with open(os.path.join(base, 'dist', 'deps.js'), 'wb') as f:
       f.write(deps)
     return 0

package/build/shaka-lab.yaml

@@ -0,0 +1,163 @@
+# Selenium grid config for the Shaka lab.  This is the source of truth for the
+# browsers and devices in the Shaka lab at Google.
+
+# For syntax and general information, see docs/selenium-grid-config.md
+
+
+# A set of variables to contain repeated configurations which can then be
+# referenced below.  The syntax for the variable is "name: &name", which
+# generates an "anchor" with the given name.  Later, you can inject the
+# contents of the variable with "*name".
+vars:
+  firefox_config: &firefox_config
+    moz:firefoxOptions:
+      # Override Firefox default preferences in the temporary profile created
+      # for each test run.
+      prefs:
+        # Overrides Selenium's explicit default setting, to allow Firefox to
+        # install the Widevine CDM on demand.
+        media.gmp-manager.updateEnabled: true
+        # Overrides Firefox's Linux-specific default setting to disable DRM.
+        media.eme.enabled: true
+
+  minimum_chrome_args: &minimum_chrome_args
+    # On Chrome m59+ we can test EME on platforms with pop-up prompts, such as
+    # Android and ChromeOS.  Note that this flag does not take a port number
+    # (domain vs origin).
+    # This flag requires setting --user-data-dir as well, however, webdriver
+    # already takes care of that for us (except on Android).
+    - "--unsafely-allow-protected-media-identifier-for-domain=karma.shakalab.rocks"
+    # Normally, Chrome disallows autoplaying videos in many cases.  Enable it
+    # for testing.
+    - "--autoplay-policy=no-user-gesture-required"
+
+  minimum_chrome_android_args: &minimum_chrome_android_args
+    # There is no way in YAML to natively merge arrays, so we start by
+    # duplicating the flags from minimum_chrome_args above.
+    - "--unsafely-allow-protected-media-identifier-for-domain=karma.shakalab.rocks"
+    - "--autoplay-policy=no-user-gesture-required"
+    # On Android we must set --user-data-dir.  WebDriver does not do it for
+    # us as it does on other platforms.  Without --user-data-dir,
+    # --unsafely-allow... does not work.
+    - "--user-data-dir=/data/data/com.android.chrome/cache"
+
+  minimum_chromeos_args: &minimum_chromeos_args
+    # There is no way in YAML to natively merge arrays, so we start by
+    # duplicating the flags from minimum_chrome_args above.
+    - "--unsafely-allow-protected-media-identifier-for-domain=karma.shakalab.rocks"
+    - "--autoplay-policy=no-user-gesture-required"
+    # Allow remote attestation even though the device may be in dev mode.  This
+    # is critical for testing involving L1 content licenses.
+    - "--allow-ra-in-dev-mode"
+
+  chrome_config: &chrome_config
+    goog:chromeOptions:
+      args: *minimum_chrome_args
+
+      # Instruct chromedriver not to disable component updater. The
+      # component updater must run in order for the Widevine CDM to be
+      # available when using a new user-data-dir.
+      # TODO(http://crbug.com/613581): Remove once Chrome bug is fixed.
+      excludeSwitches:
+        - "disable-component-update"
+
+  chrome_android_config: &chrome_android_config
+    goog:chromeOptions:
+      args: *minimum_chrome_android_args
+
+      # Once the new session request reaches chromedriver, it will take
+      # the androidPackage option as a request to start Chrome through
+      # adb on the tethered device.
+      androidPackage: com.android.chrome
+
+  chromeos_config: &chromeos_config
+    # Pass these client-specified arguments through generic-webdriver-server.
+    # This array will be appended after "--" instead of being set through one
+    # specific flag.  For example, with ["--foo", "--bar=baz"] in the args,
+    # this would generate a command like:
+    #   chromeos-webdriver-server.js -- --foo --bar=baz
+    # Those parameters will be passed on to Chrome instead of used by the
+    # WebDriver server.
+    generic:args: *minimum_chromeos_args
+
+
+ChromeMac:
+  browser: chrome
+  os: Mac
+  extra_config: *chrome_config
+
+FirefoxMac:
+  browser: firefox
+  os: Mac
+  extra_config: *firefox_config
+
+Safari:
+  browser: safari
+  os: Mac
+
+SafariTP:
+  # TODO(b/152646297): Safari TP not launching as of Safari 15.4
+  disabled: true
+  browser: safari
+  os: Mac
+  extra_config:
+    safari.options:
+      technologyPreview: true
+
+ChromeWindows:
+  browser: chrome
+  os: Windows
+  extra_config: *chrome_config
+
+FirefoxWindows:
+  browser: firefox
+  os: Windows
+  extra_config: *firefox_config
+
+IE11:
+  # IE11 support has been removed from the latest release branch.
+  disabled: true
+  browser: internet explorer
+  os: Windows
+  extra_config:
+    se:ieOptions:
+      # The zoom setting must be checked, or screenshot tests will be way off!
+      ignoreZoomSetting: false
+      ignoreProtectedModeSettings: true
+
+Edge:
+  browser: msedge
+  os: Windows
+
+ChromeLinux:
+  browser: chrome
+  os: Linux
+  extra_config: *chrome_config
+
+FirefoxLinux:
+  browser: firefox
+  os: Linux
+  extra_config: *firefox_config
+
+ChromeAndroid:
+  browser: chrome
+  os: Android
+  extra_config: *chrome_android_config
+
+Chromecast:
+  browser: chromecast
+
+Chromebook:
+  # TODO(b/145916766): Persistent license tests failing
+  disabled: true
+  browser: chromeos
+  version: Pixelbook
+  extra_config: *chromeos_config
+
+Tizen:
+  # TODO(joeyparrish): Get Tizen TV mounted in the lab and connected
+  disabled: true
+  browser: tizen
+
+XboxOne:
+  browser: xboxone

package/build/shakaBuildHelpers.py

@@ -63,23 +63,6 @@ def _modules_need_update():
 
   return False
 
-
-def _parse_version(version):
-  """Converts the given string version to a tuple of numbers."""
-  # Handle any prerelease or build metadata, such as -beta or -g1234
-  if '-' in version:
-    version, trailer = version.split('-')
-  else:
-    # Versions without a trailer should sort later than those with a trailer.
-    # For example, 2.5.0-beta comes before 2.5.0.
-    # To accomplish this, we synthesize a trailer which sorts later than any
-    # _reasonable_ alphanumeric version trailer would.  These characters have a
-    # high value in ASCII.
-    trailer = '}}}'
-  numeric_parts = [int(i) for i in version.split('.')]
-  return tuple(numeric_parts + [trailer])
-
-
 def get_source_base():
   """Returns the absolute path to the source code base."""
   return os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
@@ -338,21 +321,13 @@ def update_node_modules():
 
   base = cygwin_safe_path(get_source_base())
 
-  # Check the version of npm.
-  version = execute_get_output(['npm', '-v']).decode('utf8')
-
-  if _parse_version(version) < _parse_version('5.0.0'):
-    logging.error('npm version is too old, please upgrade.  e.g.:')
-    logging.error('  npm install -g npm')
-    return False
-
   # Update the modules.
   # Actually change directories instead of using npm --prefix.
-  # See npm/npm#17027 and google/shaka-player#776 for more details.
+  # See npm/npm#17027 and shaka-project/shaka-player#776 for more details.
   with InDir(base):
-    # npm update seems to be the wrong thing in npm v5, so use install.
-    # See google/shaka-player#854 for more details.
-    execute_get_output(['npm', 'install'])
+    # npm ci uses package-lock.json to get a stable, reproducible set of
+    # packages installed.
+    execute_get_output(['npm', 'ci'])
 
   # Update the timestamp of the file that tracks when we last updated.
   open(_node_modules_last_update_path(), 'wb').close()

package/build/test.py

@@ -19,13 +19,22 @@
 import argparse
 import json
 import logging
+import os
 import platform
+import re
 
 import build
 import gendeps
 import shakaBuildHelpers
 
 
+# Set a higher default for capture_timeout in grid mode.  If the test gets
+# queued by the grid, this may prevent Karma from killing the session while
+# waiting.
+LOCAL_CAPTURE_TIMEOUT = 1 * 60 * 1000  # 1m in ms
+SELENIUM_CAPTURE_TIMEOUT = 10 * 60 * 1000  # 10m in ms
+
+
 class _HandleMixedListsAction(argparse.Action):
   '''Action to handle comma-separated and space-separated lists.
 
@@ -59,6 +68,21 @@ class _HandleKeyValuePairs(argparse.Action):
     merged[key] = value
     setattr(namespace, self.dest, merged)
 
+def _KeyValueValidator(argument):
+    '''To validate the option has a key value pair format.
+
+      When you forget to provide the option in key=value format,
+      it reminds you by throwing an error before executing any tests.
+    '''
+
+    keyValuePair = [str for str in argument.split('=') if str != ''];
+
+    if len(keyValuePair) == 2:
+      return argument
+    else:
+      raise argparse.ArgumentTypeError(
+        'Received %s but expecting format of key=value' % argument
+      ) 
 
 def _IntGreaterThanZero(x):
   i = int(x)
@@ -85,6 +109,8 @@ def _GetDefaultBrowsers():
   raise Error('Unrecognized system: %s' % platform.uname()[0])
 
 
+# TODO(joeyparrish): When internal tools using this Launcher system are removed,
+# simplify this whole mess.
 class Launcher:
   """A stateful object for parsing arguments and running Karma commands.
 
@@ -111,7 +137,7 @@ class Launcher:
 
     running_commands = self.parser.add_argument_group(
         'Running',
-        'These commands affect how tests are ran.')
+        'These commands affect how tests are run.')
     logging_commands = self.parser.add_argument_group(
         'Logging',
         'These commands affect what gets logged and how the logs will appear.')
@@ -215,9 +241,9 @@ class Launcher:
     running_commands.add_argument(
         '--capture-timeout',
         help='Kill the browser if it does not capture in the given time [ms]. '
-             '(default %(default)s)',
-        type=int,
-        default=60000)
+             '(default {} for local, {} for Selenium)'.format(
+                 LOCAL_CAPTURE_TIMEOUT, SELENIUM_CAPTURE_TIMEOUT),
+        type=int)
     running_commands.add_argument(
         '--delay-tests',
         help='Insert an artificial delay between tests, in seconds. '
@@ -244,7 +270,7 @@ class Launcher:
         help='Configure license servers for the custom asset playback test. '
              'May be specified multiple times to configure multiple key '
              'systems.',
-        type=str,
+        type=_KeyValueValidator,
         metavar='KEY_SYSTEM_ID=LICENSE_SERVER_URI',
         action=_HandleKeyValuePairs)
     running_commands.add_argument(
@@ -258,6 +284,13 @@ class Launcher:
         help="Don't use Babel to convert ES6 to ES5.",
         dest='babel',
         action='store_false')
+    running_commands.add_argument(
+        '--grid-address',
+        help='Address (hostname:port) of a Selenium grid to run tests on.')
+    running_commands.add_argument(
+        '--grid-config',
+        help='Path to a yaml config defining Selenium grid browsers. '
+             '(See docs/selenium-grid-config.md)')
 
 
     logging_commands.add_argument(
@@ -313,6 +346,17 @@ class Launcher:
         help='Specify the hostname to be used when capturing browsers. This '
              'defaults to localhost.',
         default='localhost')
+    networking_commands.add_argument(
+        '--tls-key',
+        help='Specify a TLS key to serve tests over HTTPs.')
+    networking_commands.add_argument(
+        '--tls-cert',
+        help='Specify a TLS cert to serve tests over HTTPs.')
+    networking_commands.add_argument(
+        '--lets-encrypt-folder',
+        help="Specify a Let's Encrypt folder to search for the latest key and "
+             "cert, to serve tests over HTTPs.  This overrides --tls-key and "
+             "--tls-cert.")
 
 
     pre_launch_commands.add_argument(
@@ -345,28 +389,36 @@ class Launcher:
     pass_through = [
       'auto_watch',
       'babel',
+      'browsers',
       'capture_timeout',
       'colors',
+      'delay_tests',
       'drm',
+      'exclude_browsers',
       'external',
       'filter',
+      'grid_address',
+      'grid_config',
       'hostname',
       'html_coverage_report',
       'log_level',
       'logging',
+      'no_browsers',
       'port',
       'quarantined',
       'quick',
       'random',
+      'reporters',
       'report_slower_than',
       'seed',
       'single_run',
-      'uncompiled',
-      'delay_tests',
       'spec_hide_passed',
       'test_custom_asset',
       'test_custom_license_server',
       'test_timeout',
+      'tls_key',
+      'tls_cert',
+      'uncompiled',
     ]
 
     # Check each value before setting it to avoid passing null values.
@@ -375,8 +427,33 @@ class Launcher:
       if value is not None:
         self.karma_config[name] = value
 
-    if self.parsed_args.reporters:
-      self.karma_config['reporters'] = self.parsed_args.reporters
+    if not self.parsed_args.capture_timeout:
+      # The default for capture_timeout depends on whether or not we are using
+      # a Selenium grid.
+      if self.parsed_args.grid_config:
+        self.karma_config['capture_timeout'] = SELENIUM_CAPTURE_TIMEOUT
+      else:
+        self.karma_config['capture_timeout'] = LOCAL_CAPTURE_TIMEOUT
+
+    self._HandleLetsEncryptConfig()
+
+  def _HandleLetsEncryptConfig(self):
+    folder = self.parsed_args.lets_encrypt_folder
+    if not folder:
+      return
+
+    max_serial_number = 0
+    # Go through the contents of the folder to find the latest key & cert.
+    for file_name in os.listdir(folder):
+      matches = re.match(r'(?:privkey|fullchain)(\d+).pem', file_name)
+      if matches:
+        serial_number = int(matches.group(1))
+        max_serial_number = max(max_serial_number, serial_number)
+
+    self.karma_config['tls_key'] = os.path.join(
+        folder, 'privkey{}.pem'.format(max_serial_number))
+    self.karma_config['tls_cert'] = os.path.join(
+        folder, 'fullchain{}.pem'.format(max_serial_number))
 
   def ResolveBrowsers(self, default_browsers):
     """Decide what browsers we should use.
@@ -385,25 +462,7 @@ class Launcher:
        additional logic to derive a browser list from the parsed arguments.
     """
     assert(default_browsers and len(default_browsers))
-
-    if self.parsed_args.no_browsers:
-      logging.warning('In this mode browsers must manually connect to karma.')
-    elif self.parsed_args.browsers:
-      self.karma_config['browsers'] = self.parsed_args.browsers
-    else:
-      logging.warning('Using default browsers: %s', default_browsers)
-      self.karma_config['browsers'] = default_browsers
-
-    # Check if there are any browsers that we should remove
-    if self.parsed_args.exclude_browsers and 'browsers' in self.karma_config:
-      all_browsers = set(self.karma_config['browsers'])
-      bad_browsers = set(self.parsed_args.exclude_browsers)
-      if bad_browsers - all_browsers:
-        raise RuntimeError('Attempting to exclude unselected browsers: %s' %
-                           ','.join(bad_browsers - all_browsers))
-
-      good_browsers = all_browsers - bad_browsers
-      self.karma_config['browsers'] = list(good_browsers)
+    self.karma_config['default_browsers'] = default_browsers
 
   def RunCommand(self, karma_conf):
     """Build a command and send it to Karma for execution.