shaka-player 4.12.8 → 4.13.0

package/eslint.config.mjs

@@ -0,0 +1,343 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+// ESlint config
+
+import js from '@eslint/js';
+import google from 'eslint-config-google';
+import jsdoc from 'eslint-plugin-jsdoc';
+import shakaRules from 'eslint-plugin-shaka-rules';
+import globals from 'globals';
+
+// This is a matcher (usable in no-restricted-syntax) that matches either a
+// test or a before/after block.
+const testNameRegex =
+    '/^([fx]?it|(drm|quarantined)It|(before|after)(Each|All))$/';
+const testCall = `CallExpression[callee.name=${testNameRegex}]`;
+
+const commonNoRestrictedSyntax = [
+  {
+    'selector':
+        'MemberExpression[object.name="goog"][property.name="inherits"]',
+    'message': 'Don\'t use goog.inherits.',
+  },
+  {
+    'selector': ':not(MethodDefinition) > FunctionExpression',
+    'message': 'Use arrow functions instead of "function" functions.',
+  },
+  {
+    'selector': 'CallExpression[callee.property.name="forEach"] >' +
+                ':function[params.length=1]',
+    'message': 'Use for-of instead of forEach',
+  },
+  {
+    // NOTE: prefer-spread rule covers .apply() already.
+    'selector': 'CallExpression[callee.property.name=/^(bind|call)$/]',
+    'message': 'Don\'t use Function bind/call.',
+  },
+  {
+    'selector': 'MemberExpression[property.name="prototype"]',
+    'message': 'Use ES6 classes not .prototype.',
+  },
+  {
+    'selector': 'BinaryExpression[operator=/^([<>!=]=?)$/] > ' +
+                'CallExpression[callee.property.name=indexOf]',
+    'message': 'Use Array.includes instead of indexOf.',
+  },
+];
+
+export default [
+  {
+    ignores: ['!**/eslint.config.mjs'],
+  },
+  js.configs.recommended,
+  jsdoc.configs['flat/recommended-error'],
+  google,
+  shakaRules.configs.config,
+  {
+    languageOptions: {
+      globals: globals.browser,
+      ecmaVersion: 2017,
+    },
+    settings: {
+      jsdoc: {
+        mode: 'closure',
+        preferredTypes: {
+          '.<>': '<>',
+          'object': 'Object',
+          'symbol': 'Symbol',
+        },
+        tagNamePreference: {
+          augments: 'extends',
+          constant: 'const',
+          constructor: 'constructor',
+          file: 'fileoverview',
+          returns: 'return',
+        },
+      },
+    },
+    rules: {
+      // Things the compiler already takes care of, with more precision: {{{
+      'no-console': 'off',
+      'no-eq-null': 'off',
+      'no-eval': 'off',
+      'no-undef': 'off',
+      // }}}
+
+      // Things we should probably fix, but in stages in multiple commits: {{{
+
+      // These could catch real bugs
+      'default-case': 'off',
+      // TODO: Enable no-loop-func in next eslint release.  We can't use it
+      // now since it doesn't allow capturing "const" variables, which is safe
+      'no-loop-func': 'off',
+      // Conflicts with some Closure declarations
+      'no-unused-expressions': 'off',
+      'prefer-promise-reject-errors': 'off',
+      // These could improve readability
+      'complexity': 'off',
+      'no-negated-condition': 'off',
+      'no-shadow': 'off',
+      // }}}
+
+      // "Possible error" rules: {{{
+      'no-async-promise-executor': 'error',
+      'no-await-in-loop': 'error',
+      'no-empty': ['error', {
+        allowEmptyCatch: true,
+      }],
+      'no-misleading-character-class': 'error',
+      'no-template-curly-in-string': 'error',
+      'no-fallthrough': ['error', {
+        allowEmptyCase: true,
+      }],
+      // TODO: Try to re-enable this if possible.  Right now, it produces way
+      // too many false-positives with eslint 7.
+      // It worked well enough in eslint 5.
+      // 'require-atomic-updates': 'error',
+      // }}}
+
+      // "Best practices" rules: {{{
+      'accessor-pairs': 'error',
+      'array-callback-return': 'error',
+      // causes issues when implementing an interface
+      'class-methods-use-this': 'off',
+      'consistent-return': 'error',
+      'dot-location': ['error', 'property'],
+      'dot-notation': 'off', // We use bracket notation in tests on purpose
+      'eqeqeq': 'off',       // Compiler handles type checking in advance
+      'guard-for-in': 'off',
+      'no-alert': 'error',
+      'no-caller': 'error',
+      'no-div-regex': 'error',
+      'no-extend-native': 'error', // May conflict with future polyfills
+      'no-extra-label': 'error',
+      'no-floating-decimal': 'error',
+      'no-implicit-coercion': ['error', {
+        allow: ['!!'],
+      }],
+      'no-implied-eval': 'error',
+      'no-invalid-this': 'error',
+      'no-iterator': 'error',
+      'no-labels': 'error',
+      'no-lone-blocks': 'error',
+      'no-multi-spaces': ['error', {
+        ignoreEOLComments: true,
+      }],
+      'no-multi-str': 'error',
+      'no-new': 'error',
+      'no-new-func': 'error',
+      'no-new-wrappers': 'error',
+      'no-octal-escape': 'error',
+      'no-proto': 'error',
+      'no-return-assign': 'error',
+      'no-return-await': 'error',
+      'no-script-url': 'error',
+      'no-self-compare': 'error',
+      'no-sequences': 'error',
+      'no-throw-literal': 'error',
+      'no-unmodified-loop-condition': 'error',
+      // Interface implementations may not require all args
+      'no-unused-vars': 'off',
+      'no-useless-call': 'error',
+      'no-useless-catch': 'error',
+      'no-useless-concat': 'error',
+      'no-useless-return': 'error',
+      'no-void': 'error',
+      'no-warning-comments': 'off', // TODO and FIXME are fine
+      'radix': ['error', 'always'],
+      'require-await': 'error',
+      'wrap-iife': ['error', 'inside'],
+      'yoda': ['error', 'never'],
+      // }}}
+
+      // "Variables" rules: {{{
+      'no-label-var': 'error',
+      'no-shadow-restricted-names': 'error',
+      'no-undef-init': 'off', // Sometimes necessary with hacky compiler casts
+      'no-undefined': 'off',  // We use undefined in many places, legitimately
+      // Does not know when things are executed, false positives
+      'no-use-before-define': 'off',
+      // }}}
+
+      // "Stylistic Issues" rules: {{{
+      'array-bracket-newline': ['error', 'consistent'],
+      'block-spacing': ['error', 'always'],
+      'brace-style': ['error', '1tbs', {
+        allowSingleLine: true,
+      }],
+      'id-denylist': ['error', 'async'],
+      'lines-between-class-members': 'error',
+      'max-statements-per-line': ['error', {
+        max: 1,
+      }],
+      'new-parens': 'error',
+      'no-mixed-operators': ['error', {
+        groups: [['&', '|', '^', '~', '<<', '>>', '>>>', '&&', '||']],
+        allowSamePrecedence: false,
+      }],
+      'no-restricted-syntax': [
+        'error',
+        ...commonNoRestrictedSyntax,
+      ],
+      'no-whitespace-before-property': 'error',
+      // cspell:ignore nonblock
+      'nonblock-statement-body-position': ['error', 'below'],
+      'operator-assignment': 'error',
+      'spaced-comment': ['error', 'always', {
+        // Characters which may be glued to the start of a comment block, but
+        // which do not violate the rule.  The "*" is for jsdoc's "/**" syntax,
+        // and the "!" is for the "/*!" of license headers which are passed
+        // verbatim through the compiler.
+        markers: ['*', '!'],
+      }],
+      // }}}
+
+      // "ECMAScript 6" rules: {{{
+      'arrow-spacing': 'error',
+      'no-useless-constructor': 'error',
+      'prefer-arrow-callback': 'error',
+      'prefer-const': ['error', {
+        ignoreReadBeforeAssign: true,
+      }],
+      // }}}
+
+      // jsdoc rules {{{
+      'jsdoc/check-tag-names': ['error', {
+        definedTags: ['exportDoc', 'exportInterface'],
+      }],
+      // Do not check license, authors, etc
+      'jsdoc/check-values': 'off',
+      // This should be checked by the compiler
+      'jsdoc/no-undefined-types': 'off',
+      // Some params/props/returns are self-explanatory
+      'jsdoc/require-param-description': 'off',
+      'jsdoc/require-property-description': 'off',
+      'jsdoc/require-returns-description': 'off',
+      'jsdoc/tag-lines': 'off',
+      // It throws syntax error on @suppress {missingReturn}
+      'jsdoc/valid-types': 'off',
+      // }}}
+    },
+  },
+  {
+    files: ['test/**/*.js'],
+    rules: {
+      'no-restricted-syntax': [
+        'error',
+        {
+          'selector': 'CallExpression[callee.name="beforeAll"] ' +
+                        ':matches(' +
+                        'CallExpression[callee.property.name="createSpy"],' +
+                        'CallExpression[callee.name="spyOn"])',
+          'message': 'Create spies in beforeEach, not beforeAll.',
+        },
+        {
+          'selector': testCall + ' > :function[params.length>0]',
+          'message': 'Use async instead of "done" in tests.',
+        },
+        {
+          'selector': testCall + ' > CallExpression',
+          'message': 'Use filterDescribe instead of checkAndRun calls',
+        },
+        {
+          'selector': 'CatchClause',
+          'message': 'Use expect.toThrow or expectAsync.toBeRejected',
+        },
+        {
+          'selector': 'CallExpression[callee.name=expect] >' +
+                        'CallExpression[callee.property.name=count]' +
+                        '[callee.object.property.name=calls]',
+          'message': 'Use expect.toHaveBeenCalledTimes',
+        },
+        {
+          'selector':
+                'CallExpression[callee.property.name=toHaveBeenCalledTimes] >' +
+                'Literal[value=0]',
+          'message': 'Use expect.not.toHaveBeenCalled',
+        },
+        ...commonNoRestrictedSyntax,
+      ],
+    },
+  },
+  {
+    files: [
+      // Closure requires using var in externs.
+      'ui/externs/*.js',
+      'externs/**/*.js',
+      'test/test/externs/*.js',
+      // Use var in load.js so it works in old browsers.  We'll use
+      // compiled mode for the main library and the demo.
+      'demo/load.js',
+    ],
+    rules: {
+      'no-restricted-syntax': 'off',
+      'no-var': 'off',
+      'jsdoc/require-returns-check': 'off',
+    },
+  },
+  {
+    files: [
+      // Test code should still use "arguments", since the alternate
+      // "rest parameter" syntax won't work in uncompiled code on IE.
+      'test/**/*.js',
+      // These two files use "arguments" to patch over functions.  It
+      // is difficult to reason about whether or not these instances
+      // would always work with rest parameters, so just allow them to
+      'demo/log_section.js',
+      'lib/debug/asserts.js',
+    ],
+    rules: {
+      'prefer-rest-params': 'off',
+    },
+  },
+  {
+    files: ['externs/**/*.js'],
+    rules: {
+      // Disable rules on useless constructors so we can use ES6 classes in
+      // externs.
+      'no-useless-constructor': 'off',
+    },
+  },
+  {
+    files: ['ui/externs/*.js', 'externs/**/*.js', 'test/test/externs/*.js'],
+    rules: {
+      // Externs naturally redeclare things eslint knows about.
+      'no-redeclare': 'off',
+    },
+  },
+  {
+    files: [
+      'demo/load.js',
+      'externs/**/*.js',
+      'test/**/*.js',
+    ],
+    rules: {
+      // JSDoc is not strictly required in externs, tests, and in load.js.
+      'jsdoc/require-jsdoc': 'off',
+    },
+  },
+];

package/externs/airplay.js

@@ -26,5 +26,5 @@ HTMLMediaElement.prototype.webkitShowPlaybackTargetPicker = function() {};
 
 var AirPlayEvent = class extends Event {};
 
-/** @type {String} */
+/** @type {string} */
 AirPlayEvent.prototype.availability;

package/externs/audiotrack.js

@@ -34,7 +34,7 @@ AudioTrack.prototype.sourceBuffer;
 
 
 /**
- * @extends {IArrayLike.<AudioTrack>}
+ * @extends {IArrayLike<AudioTrack>}
  * @extends {EventTarget}
  * @interface
  */

package/externs/awesomplete.js

@@ -13,7 +13,7 @@
 class Awesomplete {
   /** @param {!Element} input */
   constructor(input) {
-    /** @type {!Array.<string>} */
+    /** @type {!Array<string>} */
     this.list;
 
     /** @type {number} */

package/externs/cast-sdk-v2.js

@@ -93,7 +93,7 @@ cast.receiver.CastReceiverManager = class {
    */
   getCastMessageBus(namespace, messageType) {}
 
-  /** @return {Array.<string>} */
+  /** @return {Array<string>} */
   getSenders() {}
 
   start() {}
@@ -268,7 +268,7 @@ chrome.cast.Session = class {
 chrome.cast.SessionRequest = class {
   /**
    * @param {string} appId
-   * @param {Array.<Object>} capabilities
+   * @param {Array<Object>} capabilities
    * @param {?number} timeout
    * @param {boolean} androidReceiverCompatible
    * @param {Object} credentialsData

package/externs/cmcd.js

@@ -31,7 +31,9 @@
  *   st: (string|undefined),
  *   v: (number|undefined),
  *   bs: (boolean|undefined),
- *   rtp: (number|undefined)
+ *   rtp: (number|undefined),
+ *   msd: (number|undefined),
+ *   ltc: (number|undefined),
  * }}
  *
  * @description
@@ -182,5 +184,18 @@
  *   delivery. The concept is that each client receives the throughput necessary
  *   for great performance, but no more. The CDN may not support the rtp
  *   feature.
+ *
+ * @property {number} msd
+ *   The Media Start Delay represents in milliseconds the delay between the
+ *   initiation of the playback request and the moment the first frame is
+ *   rendered. This is sent only once when it is calculated.
+ *
+ * @property {number} ltc
+ *   Live Stream Latency
+ *
+ *   The time delta between when a given media timestamp was made available at
+ *   the origin and when it was rendered by the client. The accuracy of this
+ *   estimate is dependent on synchronization between the packager and the
+ *   player clocks.
  */
 var CmcdData;

package/externs/device_sensor_event.js

@@ -13,6 +13,6 @@
 
 
 /**
- * @return {!Promise.<string>}
+ * @return {!Promise<string>}
  */
 DeviceMotionEvent.requestPermission = function() {};

package/externs/ima.js

@@ -96,7 +96,7 @@ google.ima.AdsManager = class {
   resize(width, height, viewMode) {}
 
   /**
-   * @return {!Array.<number>}
+   * @return {!Array<number>}
    */
   getCuePoints() {}
 
@@ -133,10 +133,10 @@ google.ima.AdsManagerLoadedEvent = class extends Event {
  *   bitrate: (number),
  *   enablePreloading: (boolean),
  *   loadVideoTimeout: (number),
- *   mimeTypes: (?Array.<string>),
+ *   mimeTypes: (?Array<string>),
  *   playAdsAfterTime: (number),
  *   restoreCustomPlaybackStateOnAdBreakComplete: (boolean),
- *   uiElements: (?Array.<string>),
+ *   uiElements: (?Array<string>),
  *   useStyledLinearAds: (boolean),
  *   useStyledNonLinearAds: (boolean),
  * }}
@@ -161,7 +161,7 @@ google.ima.AdsManagerLoadedEvent = class extends Event {
  *   If loading takes longer than this timeout, the ad playback is canceled
  *   and the next ad in the pod plays, if available.
  *   Use -1 for the default of 8 seconds.
- * @property {?Array.<string>} mimeTypes
+ * @property {?Array<string>} mimeTypes
  *   Only supported for linear video mime types.
  *   If specified, the SDK will include media that matches
  *   the MIME type(s) specified in the list and exclude media.
@@ -180,7 +180,7 @@ google.ima.AdsManagerLoadedEvent = class extends Event {
  *   state after an ad break completes. This is setting is used primarily
  *   when the publisher passes in its content player to use for
  *   custom ad playback.
- * @property {?Array.<string>} uiElements
+ * @property {?Array<string>} uiElements
  *   Specifies whether the UI elements that should be displayed.
  *   The elements in this array are ignored for AdSense/AdX ads.
  * @property {boolean} useStyledLinearAds
@@ -518,7 +518,7 @@ google.ima.dai.api.Ad = class {
   /** @return {string} */
   getCreativeAdId() {}
 
-  /** @return {!Array.<!google.ima.dai.api.CompanionAd>} */
+  /** @return {!Array<!google.ima.dai.api.CompanionAd>} */
   getCompanionAds() {}
 };
 
@@ -606,7 +606,7 @@ google.ima.dai.api.StreamData.prototype.adProgressData;
 google.ima.dai.api.StreamData.prototype.url;
 
 
-/** @type {!Array.<!google.ima.dai.api.CuePoint>} */
+/** @type {!Array<!google.ima.dai.api.CuePoint>} */
 google.ima.dai.api.StreamData.prototype.cuepoints;
 
 
@@ -657,7 +657,7 @@ google.ima.dai.api.StreamRequest.prototype.format;
 
 
 /**
- * @type {Object.<
+ * @type {Object<
  *   google.ima.dai.api.OmidVerificationVendor,
  *   (google.ima.dai.api.OmidAccessMode | undefined)>}
  */

package/externs/isoboxer.js

@@ -57,8 +57,8 @@ var ISOBoxerUtils;
  *   type: string,
  *   size: number,
  *   _parent: ISOBox,
- *   boxes: !Array.<!ISOBox>,
- *   entry: !Array.<!Object>,
+ *   boxes: !Array<!ISOBox>,
+ *   entry: !Array<!Object>,
  *   version: !number,
  *   flags: !number,
  *   sample_count: !number,
@@ -73,8 +73,8 @@ var ISOBoxerUtils;
  *   _procSubEntries: function(!ISOBox, !string, !number, !function(!ISOEntry)),
  *   major_brand: string,
  *   minor_version: number,
- *   compatible_brands: Array.<string>,
- *   _data: Array.<number>,
+ *   compatible_brands: Array<string>,
+ *   _data: Array<number>,
  *   creation_time: number,
  *   modification_time: number,
  *   timescale: number,
@@ -82,9 +82,9 @@ var ISOBoxerUtils;
  *   rate: number,
  *   volume: number,
  *   reserved1: number,
- *   reserved2: (Array.<number>|number),
- *   matrix: Array.<number>,
- *   pre_defined: (Array.<number>|number),
+ *   reserved2: (Array<number>|number),
+ *   matrix: Array<number>,
+ *   pre_defined: (Array<number>|number),
  *   next_track_ID: number,
  *   track_ID: number,
  *   layer: number,
@@ -95,20 +95,20 @@ var ISOBoxerUtils;
  *   language: string,
  *   handler_type: string,
  *   name: string,
- *   reserved: Array.<number>,
+ *   reserved: Array<number>,
  *   graphicsmode: number,
- *   opcolor: Array.<number>,
+ *   opcolor: Array<number>,
  *   balance: number,
- *   entries: Array.<!ISOEntry>,
+ *   entries: Array<!ISOEntry>,
  *   location: string,
  *   data_reference_index: number,
  *   pre_defined1: number,
- *   pre_defined2: Array.<number>,
+ *   pre_defined2: Array<number>,
  *   pre_defined3: number,
  *   horizresolution: number,
  *   vertresolution: number,
  *   frame_count: number,
- *   compressorname: Array.<number>,
+ *   compressorname: Array<number>,
  *   depth: number,
  *   config: Uint8Array,
  *   channelcount: number,
@@ -121,23 +121,23 @@ var ISOBoxerUtils;
  *   scheme_version: number,
  *   default_IsEncrypted: number,
  *   default_IV_size: number,
- *   default_KID: Array.<number>,
+ *   default_KID: Array<number>,
  *   default_sample_description_index: number,
  *   default_sample_duration: number,
  *   default_sample_size: number,
  *   default_sample_flags: number,
  *   baseMediaDecodeTime: number,
  *   usertype: (string|null|undefined),
- *   offset: Array.<number>,
- *   sample_info_size: Array.<number>,
+ *   offset: Array<number>,
+ *   sample_info_size: Array<number>,
  *   data_offset: number
  * }}
  * @property {boolean} _parsing
  * @property {string} type
  * @property {number} size
  * @property {ISOBox} _parent
- * @property {!Array.<!ISOBox>} boxes
- * @property {!Array.<!ISOEntry>} entry
+ * @property {!Array<!ISOBox>} boxes
+ * @property {!Array<!ISOEntry>} entry
  * @property {!number} version
  * @property {!number} flags
  * @property {!number} sample_count
@@ -148,12 +148,12 @@ var ISOBoxerUtils;
  * @property {function(!string, !number, !string, !number)} _procFieldArray
  * @property {function(!string, !number, !function(!ISOEntry))} _procEntries
  * @property {function(!ISOBox, !string, !string, !number)} _procEntryField
- * @property {function(!ISOBox, !string, !number, !function(!ISOEntry))}
- *    _procSubEntries
+ * @property {function(!ISOBox, !string, !number, !function(!ISOEntry))
+ *           } _procSubEntries
  * @property {string} major_brand
  * @property {number} minor_version
- * @property {Array.<string>} compatible_brands
- * @property {Array.<number>} _data
+ * @property {Array<string>} compatible_brands
+ * @property {Array<number>} _data
  * @property {number} creation_time
  * @property {number} modification_time
  * @property {number} timescale
@@ -161,9 +161,9 @@ var ISOBoxerUtils;
  * @property {number} rate
  * @property {number} volume
  * @property {number} reserved1
- * @property {Array.<number>|number} reserved2
- * @property {Array.<number>} matrix
- * @property {Array.<number>|number} pre_defined
+ * @property {Array<number>|number} reserved2
+ * @property {Array<number>} matrix
+ * @property {Array<number>|number} pre_defined
  * @property {number} next_track_ID
  * @property {number} track_ID
  * @property {number} layer
@@ -174,15 +174,15 @@ var ISOBoxerUtils;
  * @property {string} language
  * @property {string} handler_type
  * @property {string} name
- * @property {Array.<number>} reserved
+ * @property {Array<number>} reserved
  * @property {number} graphicsmode
- * @property {Array.<number>} opcolor
+ * @property {Array<number>} opcolor
  * @property {number} balance
- * @property {Array.<!ISOEntry>} entries
+ * @property {Array<!ISOEntry>} entries
  * @property {string} location
  * @property {number} data_reference_index
  * @property {number} pre_defined1
- * @property {Array.<number>} pre_defined2
+ * @property {Array<number>} pre_defined2
  * @property {number} pre_defined3
  * @property {number} horizresolution
  * @property {number} vertresolution
@@ -200,15 +200,15 @@ var ISOBoxerUtils;
  * @property {number} scheme_version
  * @property {number} default_IsEncrypted
  * @property {number} default_IV_size
- * @property {Array.<number>} default_KID
+ * @property {Array<number>} default_KID
  * @property {number} default_sample_description_index
  * @property {number} default_sample_duration
  * @property {number} default_sample_size
  * @property {number} default_sample_flags
  * @property {number} baseMediaDecodeTime
  * @property {string|null|undefined} usertype
- * @property {Array.<number} offset
- * @property {Array.<number} sample_info_size
+ * @property {Array<number} offset
+ * @property {Array<number} sample_info_size
  * @property {number} data_offset
  * @const
  */

package/externs/jwk_set.js

@@ -13,7 +13,7 @@
 /** A JSON Web Key set. */
 class JWKSet {
   constructor() {
-    /** @type {Array.<JWK>} */
+    /** @type {Array<JWK>} */
     this.keys = [];
   }
 }