shaka-player 3.3.2 → 3.3.5

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.')
@@ -183,8 +209,14 @@ class Launcher:
         action='store_true')
     running_commands.add_argument(
         '--drm',
-        help='Run tests that require DRM.',
+        help='Run tests that require DRM (on by default).',
+        default=True,
         action='store_true')
+    running_commands.add_argument(
+        '--no-drm', '--nodrm',
+        help='Skip tests that require DRM (opposite of --drm).',
+        dest='drm',
+        action='store_false')
     running_commands.add_argument(
         '--quarantined',
         help='Run tests that have been quarantined.',
@@ -215,9 +247,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 +276,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 +290,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 +352,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 +395,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 +433,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 +468,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.

package/build/types/core

@@ -84,7 +84,6 @@
 +../../lib/util/mp4_box_parsers.js
 +../../lib/util/mp4_parser.js
 +../../lib/util/multi_map.js
-+../../lib/util/mutex.js
 +../../lib/util/networking.js
 +../../lib/util/object_utils.js
 +../../lib/util/operation_manager.js

package/build/types/polyfill

@@ -15,6 +15,7 @@
 +../../lib/polyfill/pip_webkit.js
 +../../lib/polyfill/random_uuid.js
 +../../lib/polyfill/storage_estimate.js
++../../lib/polyfill/symbol.js
 +../../lib/polyfill/video_play_promise.js
 +../../lib/polyfill/videoplaybackquality.js
 +../../lib/polyfill/vttcue.js

package/build/wrapper.template.js

@@ -6,7 +6,7 @@
 
 (function() {
   // This is "window" in browsers and "global" in nodejs.
-  // See https://github.com/google/shaka-player/issues/1445
+  // See https://github.com/shaka-project/shaka-player/issues/1445
   var innerGlobal = typeof window != 'undefined' ? window : global;
 
   // This is where our library exports things to.  It is "this" in the wrapped
@@ -18,7 +18,7 @@
   // $jscomp.global, which will be "window", or "global", or "this", depending
   // on circumstances.
   // See https://github.com/google/closure-compiler/issues/2957 and
-  // https://github.com/google/shaka-player/issues/1455#issuecomment-393250035
+  // https://github.com/shaka-project/shaka-player/issues/1455#issuecomment-393250035
 
   // We provide "global" for use by Closure, and "window" for use by the Shaka
   // library itself.  Both point to "innerGlobal" above.

package/demo/asset_card.js

@@ -4,11 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-
 goog.provide('shakaDemo.AssetCard');
 
-
 goog.require('goog.asserts');
+goog.require('shakaAssets');
 goog.require('shakaDemo.MessageIds');
 goog.require('shakaDemo.Tooltips');
 goog.requireType('ShakaDemoAssetInfo');

package/demo/cast_receiver/index.html

@@ -63,7 +63,7 @@ UNCOMPILED_JS = [
     <script defer src="../load.js"></script>
   </head>
   <body>
-    <div data-shaka-player-container id="videoContainer">
+    <div data-shaka-player-container id="video-container">
       <video autoplay data-shaka-player id="video"></video>
     </div>
     <!-- Covers everything else while idle -->

package/demo/cast_receiver/receiver_app.css

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/* Experimentation has revealed that unless html, body, and videoContainer are
+/* Experimentation has revealed that unless html, body, and video-container are
  * width and height 100%, video can force all its parents to grow larger than
  * window.innerHeight, causing things to be cut off for some content.
  */
@@ -25,7 +25,7 @@ body {
   color: white;
 }
 
-#videoContainer {
+#video-container {
   width: 100%;
   height: 100%;
 }
@@ -83,29 +83,29 @@ body:after {
   height: 0;
   overflow: hidden;
   z-index: -1;
-  content: url(idle1.jpg) url(idle2.jpg) url(idle3.jpg);
+  content: url("idle1.jpg") url("idle2.jpg") url("idle3.jpg");
 }
 
 @keyframes bg-change {
-  0% { background-image: url('idle1.jpg'); padding-left: 0; }
+  0% { background-image: url("idle1.jpg"); padding-left: 0; }
 
-  32% { background-image: url('idle1.jpg'); padding-left: 0; }
+  32% { background-image: url("idle1.jpg"); padding-left: 0; }
 
-  34% { background-image: url('idle2.jpg'); padding-left: 0; }
+  34% { background-image: url("idle2.jpg"); padding-left: 0; }
 
-  49% { background-image: url('idle2.jpg'); padding-left: 0; }
+  49% { background-image: url("idle2.jpg"); padding-left: 0; }
 
-  50% { background-image: url('idle2.jpg'); padding-left: 400px; }
+  50% { background-image: url("idle2.jpg"); padding-left: 400px; }
 
-  65% { background-image: url('idle2.jpg'); padding-left: 400px; }
+  65% { background-image: url("idle2.jpg"); padding-left: 400px; }
 
-  67% { background-image: url('idle3.jpg'); padding-left: 400px; }
+  67% { background-image: url("idle3.jpg"); padding-left: 400px; }
 
-  87% { background-image: url('idle3.jpg'); padding-left: 400px; }
+  87% { background-image: url("idle3.jpg"); padding-left: 400px; }
 
-  88% { background-image: url('idle3.jpg'); padding-left: 0; }
+  88% { background-image: url("idle3.jpg"); padding-left: 0; }
 
-  98% { background-image: url('idle3.jpg'); padding-left: 0; }
+  98% { background-image: url("idle3.jpg"); padding-left: 0; }
 
-  100% { background-image: url('idle1.jpg'); padding-left: 0; }
+  100% { background-image: url("idle1.jpg"); padding-left: 0; }
 }

package/demo/common/assets.js

@@ -13,6 +13,8 @@
 goog.require('ShakaDemoAssetInfo');
 goog.require('shakaDemo.MessageIds');
 
+goog.provide('shakaAssets');
+
 
 // Types and enums {{{
 /**

package/demo/config.js

@@ -11,7 +11,6 @@ goog.require('goog.asserts');
 goog.require('shakaDemo.BoolInput');
 goog.require('shakaDemo.DatalistInput');
 goog.require('shakaDemo.InputContainer');
-goog.require('shakaDemo.Main');
 goog.require('shakaDemo.MessageIds');
 goog.require('shakaDemo.NumberInput');
 goog.require('shakaDemo.SelectInput');

package/demo/custom.js

@@ -12,7 +12,6 @@ goog.require('ShakaDemoAssetInfo');
 goog.require('shakaDemo.AssetCard');
 goog.require('shakaDemo.Input');
 goog.require('shakaDemo.InputContainer');
-goog.require('shakaDemo.Main');
 goog.require('shakaDemo.MessageIds');
 goog.require('shakaDemo.TextInput');
 

package/demo/customWarning.txt

@@ -4,5 +4,5 @@ of the asset you were playing at the time you pressed the bug report button.
 We have detected that you were playing a custom asset.
 If this asset's URL is confidential, you might instead want to fill out an issue
 template manually:
-https://github.com/google/shaka-player/issues/new/choose
--->
+https://github.com/shaka-project/shaka-player/issues/new/choose
+-->

package/demo/demo.less

@@ -4,6 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/* stylelint-disable selector-class-pattern -- MDL classes can't be changed */
+
 // Import the MDL styles with the desired color scheme.
 @import (css, inline) "../node_modules/material-design-lite/dist/material.indigo-blue.min.css";
 @import (css, inline) "../node_modules/dialog-polyfill/dialog-polyfill.css";
@@ -15,7 +17,7 @@
 @drawer-width: 550px;
 
 @mdl-footer-link-color: #9e9e9e;  /* copied from MDL stylesheet */
-@mdl-button-color: rgb(63,81,181);  /* copied from MDL stylesheet */
+@mdl-button-color: rgb(63 81 181);  /* copied from MDL stylesheet */
 
 @progress-circle-size: 45px;
 @progress-circle-thickness: 5px;
@@ -24,7 +26,7 @@
  * here we override the font family for the MDL class.  Without this, the menu
  * on the left side of the screen has no icon. */
 .material-icons {
-  font-family: 'Material Icons Round';
+  font-family: "Material Icons Round";
 }
 
 /* Conflicting styles between the icons font & the MDL buttons caused some
@@ -73,12 +75,21 @@ main.mdl-layout__content {
   border-radius: 50%;
   width: 32px;
   color: #000;
-  background: rgba(255, 255, 255, 0.85);
+  background: rgba(255 255 255 / 85%);
 }
 
 html, body {
   /* Ensure everything has a consistent font. */
-  font-family: "Roboto", "Helvetica", "Arial", sans-serif;
+  font-family: Roboto-Regular, Roboto, sans-serif, TengwarTelcontar;
+}
+
+// This font supports the Sindarin (sjn) translation.
+@font-face {
+  font-family: TengwarTelcontar;
+  // This could be served from demo/ (uncompiled) or dist (compiled).
+  src: url("../demo/TengwarTelcontar.woff2") format("woff2");
+  font-weight: normal;
+  font-style: normal;
 }
 
 /* Change the default opacity of the ripple container, to get around an iOS bug.
@@ -171,7 +182,7 @@ html, body {
   background-color: @error-color;
   color: white;
   position: relative;
-  padding: 0 0;
+  padding: 0;
   top: 0;
   right: 1em;
   float: right;
@@ -203,56 +214,56 @@ html, body {
 
   /* features */
   &[icon="high_definition"] {
-    background-image: data-uri('icons/custom_high_definition.svg');
+    background-image: data-uri("icons/custom_high_definition.svg");
   }
 
   &[icon="ultra_high_definition"] {
-    background-image: data-uri('icons/custom_ultra_high_definition.svg');
+    background-image: data-uri("icons/custom_ultra_high_definition.svg");
   }
 
   &[icon="subtitles"] {
-    background-image: data-uri('icons/baseline-subtitles-24px.svg');
+    background-image: data-uri("icons/baseline-subtitles-24px.svg");
   }
 
   &[icon="closed_caption"] {
-    background-image: data-uri('icons/baseline-closed_caption-24px.svg');
+    background-image: data-uri("icons/baseline-closed_caption-24px.svg");
   }
 
   &[icon="live"] {
-    background-image: data-uri('icons/baseline-live_tv-24px.svg');
+    background-image: data-uri("icons/baseline-live_tv-24px.svg");
   }
 
   &[icon="trick_mode"] {
-    background-image: data-uri('icons/baseline-fast_forward-24px.svg');
+    background-image: data-uri("icons/baseline-fast_forward-24px.svg");
   }
 
   &[icon="surround_sound"] {
-    background-image: data-uri('icons/baseline-surround_sound-24px.svg');
+    background-image: data-uri("icons/baseline-surround_sound-24px.svg");
   }
 
   &[icon="multiple_languages"] {
-    background-image: data-uri('icons/baseline-language-24px.svg');
+    background-image: data-uri("icons/baseline-language-24px.svg");
   }
 
   &[icon="ad"] {
-    background-image: data-uri('icons/custom_ad.svg');
+    background-image: data-uri("icons/custom_ad.svg");
   }
 
   &[icon="audio_only"] {
-    background-image: data-uri('icons/baseline-audiotrack-24px.svg');
+    background-image: data-uri("icons/baseline-audiotrack-24px.svg");
   }
 
   /* key systems */
   &[icon="widevine"] {
-    background-image: data-uri('icons/custom_widevine.svg');
+    background-image: data-uri("icons/custom_widevine.svg");
   }
 
   &[icon="clear_key"] {
-    background-image: data-uri('icons/custom_clear_key.svg');
+    background-image: data-uri("icons/custom_clear_key.svg");
   }
 
   &[icon="playready"] {
-    background-image: data-uri('icons/custom_playready.svg');
+    background-image: data-uri("icons/custom_playready.svg");
   }
 }
 

package/demo/demo_uncompiled.js

@@ -4,20 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shakaDemo.AssetCard');
-goog.require('shakaDemo.CloseButton');
 goog.require('shakaDemo.Config');
 goog.require('shakaDemo.Custom');
-goog.require('shakaDemo.Utils');
 goog.require('shakaDemo.Front');
-goog.require('shakaDemo.BoolInput');
-goog.require('shakaDemo.DatalistInput');
-goog.require('shakaDemo.Input');
-goog.require('shakaDemo.MessageIds');
-goog.require('shakaDemo.NumberInput');
-goog.require('shakaDemo.SelectInput');
-goog.require('shakaDemo.TextInput');
-goog.require('shakaDemo.InputContainer');
-goog.require('shakaDemo.Main');
 goog.require('shakaDemo.Search');
-goog.require('shakaDemo.Tooltips');
+goog.require('shakaDemo.Main');

package/demo/index.html

@@ -141,7 +141,7 @@ UNCOMPILED_JS = [
               <ul class="mdl-mega-footer__link-list">
                 <li><a rel="noopener" target="_blank" href="../docs/api/index.html" localized-string="DOCUMENTATION"></a></li>
                 <li><a rel="noopener" target="_blank" href="https://www.apache.org/licenses/LICENSE-2.0" localized-string="LICENSE"></a></li>
-                <li><a rel="noopener" target="_blank" href="https://github.com/google/shaka-player" localized-string="SOURCE"></a></li>
+                <li><a rel="noopener" target="_blank" href="https://github.com/shaka-project/shaka-player" localized-string="SOURCE"></a></li>
                 <li><a rel="noopener" target="_blank" href="https://www.npmjs.com/package/shaka-player" localized-string="NPM"></a></li>
                 <li><a rel="noopener" target="_blank" href="../support.html" localized-string="SUPPORT"></a></li>
               </ul>

package/demo/main.js

@@ -164,7 +164,7 @@ shakaDemo.Main = class {
       case shaka.ui.Overlay.FailReasonCode.NO_BROWSER_SUPPORT:
         message = this.getLocalizedString(
             shakaDemo.MessageIds.FAILURE_NO_BROWSER_SUPPORT);
-        href = 'https://github.com/google/shaka-player#' +
+        href = 'https://github.com/shaka-project/shaka-player#' +
                 'platform-and-browser-support-matrix';
         break;
       case shaka.ui.Overlay.FailReasonCode.PLAYER_FAILED_TO_LOAD:
@@ -289,7 +289,7 @@ shakaDemo.Main = class {
 
     // Navigate to the github issue opening interface, with the
     // partially-filled template as a preset body.
-    let url = 'https://github.com/google/shaka-player/issues/new?';
+    let url = 'https://github.com/shaka-project/shaka-player/issues/new?';
     url += 'body=' + encodeURIComponent(text);
     // Open in another tab.
     window.open(url, '_blank');
@@ -1608,7 +1608,7 @@ shakaDemo.Main = class {
 
   /**
    * Sets the "version-string" divs to a version string.
-   * For example, "v2.5.4-master (uncompiled)".
+   * For example, "v2.5.4-main (uncompiled)".
    * @private
    */
   setUpVersionStrings_() {