Made ManifestParser.PlayerInterface.filter async.

This is a change in preparation for the adoption of the MediaCapabilities API. Related to #1391 Change-Id: If0988aedafe15aa3be794fb977fd8e04e91ca10e
shaka-project · Jun 5, 2020 · 8d65714 · 8d65714
1 parent 39090df
commit 8d65714
Show file tree

Hide file tree

Showing 14 changed files with 21 additions and 15 deletions.
diff --git a/build/misspellings.txt b/build/misspellings.txt
@@ -31,4 +31,5 @@
     r'(?i)wether': 'whether',
     r'(?i)@returns': '@return',
     r'(?i)varint': 'variant',
+    r'(?i)asynchronus': 'asynchronous',
 }
diff --git a/docs/tutorials/upgrade-manifest.md b/docs/tutorials/upgrade-manifest.md
@@ -48,6 +48,8 @@ Instead of `filterNewPeriod` and `filterAllPeriods`, there is now a single
 callback: {@link shaka.extern.ManifestParser.PlayerInterface#filter}.  This
 should be invoked any time new text streams or variants are added to the
 manifest.  `ManifestParser` plugins MUST be updated to use the new callback.
+Keep in mind that the new `filter` method is asynchronous, and thus it should
+probably be used in conjunction with `.then()` or `await`.
 
 ```js
 // v2.5:
@@ -59,7 +61,7 @@ this.playerInterface_.filterNewPeriod(someNewPeriod);
 
 // v3.0:
 // Call this after the initial parsing or after any new streams are added
-this.playerInterface_.filter(manifest);
+await this.playerInterface_.filter(manifest);
 ```
 
 

diff --git a/externs/shaka/manifest_parser.js b/externs/shaka/manifest_parser.js
@@ -99,7 +99,7 @@ shaka.extern.ManifestParser = class {
 /**
  * @typedef {{
  *   networkingEngine: !shaka.net.NetworkingEngine,
- *   filter: function(shaka.extern.Manifest),
+ *   filter: function(shaka.extern.Manifest):!Promise,
  *   onTimelineRegionAdded: function(shaka.extern.TimelineRegionInfo),
  *   onEvent: function(!Event),
  *   onError: function(!shaka.util.Error)
@@ -113,9 +113,9 @@ shaka.extern.ManifestParser = class {
  *
  * @property {!shaka.net.NetworkingEngine} networkingEngine
  *   The networking engine to use for network requests.
- * @property {function(shaka.extern.Manifest)} filter
+ * @property {function(shaka.extern.Manifest):!Promise} filter
  *   Should be called when new variants or text streams are added to the
- *   Manifest.
+ *   Manifest.  Note that this operation is asynchronous.
  * @property {function(shaka.extern.TimelineRegionInfo)} onTimelineRegionAdded
  *   Should be called when a new timeline region is added.
  * @property {function(!Event)} onEvent

diff --git a/lib/dash/dash_parser.js b/lib/dash/dash_parser.js
@@ -416,7 +416,7 @@ shaka.dash.DashParser = class {
     }
 
     goog.asserts.assert(this.manifest_, 'Manifest should exist by now!');
-    this.playerInterface_.filter(this.manifest_);
+    await this.playerInterface_.filter(this.manifest_);
   }
 
   /**

diff --git a/lib/hls/hls_parser.js b/lib/hls/hls_parser.js
@@ -478,7 +478,7 @@ shaka.hls.HlsParser = class {
       offlineSessionIds: [],
       minBufferTime: 0,
     };
-    this.playerInterface_.filter(this.manifest_);
+    await this.playerInterface_.filter(this.manifest_);
   }
 
   /**

diff --git a/lib/offline/storage.js b/lib/offline/storage.js
@@ -892,7 +892,7 @@ shaka.offline.Storage = class {
 
       // Don't bother filtering now. We will do that later when we have all the
       // information we need to filter.
-      filter: () => {},
+      filter: () => Promise.resolve(),
 
       onTimelineRegionAdded: () => {},
       onEvent: () => {},

diff --git a/lib/player.js b/lib/player.js
@@ -1559,9 +1559,11 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       }
     });
 
+    // TODO (#1391): Once filterManifest_ is async, remove this eslint disable.
+    /* eslint-disable require-await */
     const playerInterface = {
       networkingEngine: networkingEngine,
-      filter: (manifest) => this.filterManifest_(manifest),
+      filter: async (manifest) => this.filterManifest_(manifest),
 
       // Called when the parser finds a timeline region. This can be called
       // before we start playback or during playback (live/in-progress
@@ -1571,6 +1573,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       onEvent: (event) => this.dispatchEvent(event),
       onError: (error) => this.onError_(error),
     };
+    /* eslint-enable require-await */
 
     const startTime = Date.now() / 1000;
 

diff --git a/test/dash/dash_parser_content_protection_unit.js b/test/dash/dash_parser_content_protection_unit.js
@@ -32,7 +32,7 @@ describe('DashParser ContentProtection', () => {
 
     const playerInterface = {
       networkingEngine: netEngine,
-      filter: (manifest) => {},
+      filter: (manifest) => Promise.resolve(),
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
       onEvent: fail,
       onError: fail,

diff --git a/test/dash/dash_parser_live_unit.js b/test/dash/dash_parser_live_unit.js
@@ -25,7 +25,7 @@ describe('DashParser Live', () => {
     parser.configure(shaka.util.PlayerConfiguration.createDefault().manifest);
     playerInterface = {
       networkingEngine: fakeNetEngine,
-      filter: (manifest) => {},
+      filter: (manifest) => Promise.resolve(),
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
       onEvent: fail,
       onError: fail,

diff --git a/test/dash/dash_parser_manifest_unit.js b/test/dash/dash_parser_manifest_unit.js
@@ -30,7 +30,7 @@ describe('DashParser Manifest', () => {
     onEventSpy = jasmine.createSpy('onEvent');
     playerInterface = {
       networkingEngine: fakeNetEngine,
-      filter: (manifest) => {},
+      filter: (manifest) => Promise.resolve(),
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
       onEvent: shaka.test.Util.spyFunc(onEventSpy),
       onError: fail,

diff --git a/test/dash/dash_parser_segment_base_unit.js b/test/dash/dash_parser_segment_base_unit.js
@@ -27,7 +27,7 @@ describe('DashParser SegmentBase', () => {
 
     playerInterface = {
       networkingEngine: fakeNetEngine,
-      filter: (manifest) => {},
+      filter: (manifest) => Promise.resolve(),
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
       onEvent: fail,
       onError: fail,

diff --git a/test/dash/dash_parser_segment_template_unit.js b/test/dash/dash_parser_segment_template_unit.js
@@ -36,7 +36,7 @@ describe('DashParser SegmentTemplate', () => {
 
     playerInterface = {
       networkingEngine: fakeNetEngine,
-      filter: (manifest) => {},
+      filter: (manifest) => Promise.resolve(),
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
       onEvent: fail,
       onError: fail,

diff --git a/test/hls/hls_live_unit.js b/test/hls/hls_live_unit.js
@@ -103,7 +103,7 @@ describe('HlsParser live', () => {
 
     config = shaka.util.PlayerConfiguration.createDefault().manifest;
     playerInterface = {
-      filter: () => {},
+      filter: () => Promise.resolve(),
       networkingEngine: fakeNetEngine,
       onError: fail,
       onEvent: fail,

diff --git a/test/hls/hls_parser_unit.js b/test/hls/hls_parser_unit.js
@@ -77,7 +77,7 @@ describe('HlsParser', () => {
 
     config = shaka.util.PlayerConfiguration.createDefault().manifest;
     playerInterface = {
-      filter: () => {},
+      filter: () => Promise.resolve(),
       networkingEngine: fakeNetEngine,
       onError: fail,
       onEvent: fail,