shaka-player 4.4.3 → 4.6.0

package/test/util/content_steering_manager_unit.js

@@ -0,0 +1,427 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+describe('ContentSteeringManager', () => {
+  /** @type {!shaka.test.FakeNetworkingEngine} */
+  let fakeNetEngine;
+
+  /** @type {!shaka.util.ContentSteeringManager} */
+  let manager;
+
+  beforeEach(() => {
+    fakeNetEngine = new shaka.test.FakeNetworkingEngine();
+    const playerInterface = {
+      networkingEngine: fakeNetEngine,
+      modifyManifestRequest: fail,
+      modifySegmentRequest: fail,
+      filter: fail,
+      makeTextStreamsForClosedCaptions: fail,
+      onTimelineRegionAdded: fail,
+      onEvent: fail,
+      onError: fail,
+      isLowLatencyMode: fail,
+      isAutoLowLatencyMode: fail,
+      enableLowLatencyMode: fail,
+      updateDuration: fail,
+      newDrmInfo: fail,
+      onManifestUpdated: fail,
+      getBandwidthEstimate: () => 1e6,
+    };
+    const config = shaka.util.PlayerConfiguration.createDefault().manifest;
+    manager = new shaka.util.ContentSteeringManager(playerInterface);
+    manager.configure(config);
+    manager.setBaseUris([
+      'http://default',
+    ]);
+    manager.addLocation('foo', 'cdn-a', 'http://cdn-a');
+    manager.addLocation('foo', 'cdn-b', 'http://cdn-b');
+    manager.addLocation('foo', 'cdn-c', 'http://cdn-c');
+  });
+
+  afterEach(async () => {
+    await manager.destroy();
+  });
+
+  describe('defaultPathwayId', () => {
+    it('allows no value', () => {
+      manager.setDefaultPathwayId(null);
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(3);
+      expect(locations[0]).toBe('http://cdn-a');
+      expect(locations[1]).toBe('http://cdn-b');
+      expect(locations[2]).toBe('http://cdn-c');
+    });
+
+    it('allows one value', () => {
+      manager.setDefaultPathwayId('cdn-b');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(1);
+      expect(locations[0]).toBe('http://cdn-b');
+    });
+
+    it('allows multiple values', () => {
+      manager.setDefaultPathwayId('cdn-b,cdn-a,cdn-c');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(3);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+      expect(locations[2]).toBe('http://cdn-c');
+    });
+  });
+
+  describe('queryParams', () => {
+    it('send the correct value for DASH', async () => {
+      manager.setManifestType(shaka.media.ManifestParser.DASH);
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(2);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+
+      const manifestUpdate = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+        ],
+      });
+      const updateUrl = 'http://foo.bar/update?_DASH_pathway=cdn-b&_DASH_throughput=1000000';
+      fakeNetEngine.setResponseText(updateUrl, manifestUpdate);
+
+      await shaka.test.Util.delay(1);
+
+      const newLocations = manager.getLocations('foo');
+      expect(newLocations.length).toBe(1);
+      expect(newLocations[0]).toBe('http://cdn-b');
+    });
+
+    it('send the correct value for HLS', async () => {
+      manager.setManifestType(shaka.media.ManifestParser.HLS);
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(2);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+
+      const manifestUpdate = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+        ],
+      });
+      const updateUrl = 'http://foo.bar/update?_HLS_pathway=cdn-b&_HLS_throughput=1000000';
+      fakeNetEngine.setResponseText(updateUrl, manifestUpdate);
+
+      await shaka.test.Util.delay(1);
+
+      const newLocations = manager.getLocations('foo');
+      expect(newLocations.length).toBe(1);
+      expect(newLocations[0]).toBe('http://cdn-b');
+    });
+
+    it('not send value for unknown manifest', async () => {
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(2);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+
+      const manifestUpdate = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/update', manifestUpdate);
+
+      await shaka.test.Util.delay(1);
+
+      const newLocations = manager.getLocations('foo');
+      expect(newLocations.length).toBe(1);
+      expect(newLocations[0]).toBe('http://cdn-b');
+    });
+  });
+
+  describe('steeringManifest', () => {
+    it('ignores manifest with a version different than 1', async () => {
+      const manifest = JSON.stringify({
+        'VERSION': 35,
+        'TTL': 10,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(3);
+      expect(locations[0]).toBe('http://cdn-a');
+      expect(locations[1]).toBe('http://cdn-b');
+      expect(locations[2]).toBe('http://cdn-c');
+    });
+
+    it('honors RELOAD-URI', async () => {
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(2);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+
+      const manifestUpdate = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/update', manifestUpdate);
+
+      await shaka.test.Util.delay(1);
+
+      const newLocations = manager.getLocations('foo');
+      expect(newLocations.length).toBe(1);
+      expect(newLocations[0]).toBe('http://cdn-b');
+    });
+
+    it('fallback for no RELOAD-URI', async () => {
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(2);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+
+      const manifestUpdate = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifestUpdate);
+
+      await shaka.test.Util.delay(1);
+
+      const newLocations = manager.getLocations('foo');
+      expect(newLocations.length).toBe(1);
+      expect(newLocations[0]).toBe('http://cdn-b');
+    });
+
+    it('honors TTL', async () => {
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 1,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(2);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+
+      const manifestUpdate = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 2,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/update', manifestUpdate);
+
+      await shaka.test.Util.delay(2);
+
+      const newLocations = manager.getLocations('foo');
+      expect(newLocations.length).toBe(1);
+      expect(newLocations[0]).toBe('http://cdn-b');
+    });
+  });
+
+  describe('get correct locations', () => {
+    it('with PATHWAY-PRIORITY', async () => {
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 10,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+          'cdn-c',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(3);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+      expect(locations[2]).toBe('http://cdn-c');
+    });
+
+    it('with PATHWAY-PRIORITY and PATHWAY-CLONES', async () => {
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 10,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-d',
+          'cdn-b',
+          'cdn-a',
+          'cdn-c',
+        ],
+        'PATHWAY-CLONES': [
+          {
+            'BASE-ID': 'cdn-c',
+            'ID': 'cdn-d',
+            'URI-REPLACEMENT': {
+              'HOST': 'cdn-d',
+            },
+          },
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(4);
+      expect(locations[0]).toBe('http://cdn-d');
+      expect(locations[1]).toBe('http://cdn-b');
+      expect(locations[2]).toBe('http://cdn-a');
+      expect(locations[3]).toBe('http://cdn-c');
+    });
+
+    it('without PATHWAY-PRIORITY but with defaultPathwayId', () => {
+      manager.setDefaultPathwayId('cdn-b,cdn-a,cdn-c');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(3);
+      expect(locations[0]).toBe('http://cdn-b');
+      expect(locations[1]).toBe('http://cdn-a');
+      expect(locations[2]).toBe('http://cdn-c');
+    });
+
+    it('without PATHWAY-PRIORITY neither defaultPathwayId', () => {
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(3);
+      expect(locations[0]).toBe('http://cdn-a');
+      expect(locations[1]).toBe('http://cdn-b');
+      expect(locations[2]).toBe('http://cdn-c');
+    });
+
+    it('use baseuris if no locations', () => {
+      manager.clearPreviousLocations();
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(1);
+      expect(locations[0]).toBe('http://default');
+    });
+  });
+
+  describe('allow ban locations', () => {
+    it('with PATHWAY-PRIORITY', async () => {
+      const manifest = JSON.stringify({
+        'VERSION': 1,
+        'TTL': 10,
+        'RELOAD-URI': 'http://foo.bar/update',
+        'PATHWAY-PRIORITY': [
+          'cdn-b',
+          'cdn-a',
+          'cdn-c',
+        ],
+      });
+      fakeNetEngine.setResponseText('http://foo.bar/manifest', manifest);
+
+      await manager.requestInfo('http://foo.bar/manifest');
+
+      manager.banLocation('http://cdn-b');
+
+      const locations = manager.getLocations('foo');
+      expect(locations.length).toBe(2);
+      expect(locations[0]).toBe('http://cdn-a');
+      expect(locations[1]).toBe('http://cdn-c');
+    });
+  });
+});

package/test/util/id3_utils_unit.js

@@ -13,6 +13,44 @@ describe('Id3Utils', () => {
     expect(Id3Utils.getID3Frames(new Uint8Array([]))).toEqual([]);
   });
 
+  it('parse an APIC frame with image data', () => {
+    const apicValue = new Uint8Array([
+      3, 105, 109, 97, 103, 101, 47, 106, 112, 101, 103, 0, 3, 83, 104, 97,
+      107, 97, 0, 1, 2, 3,
+    ]);
+    const apicFrame = Id3Generator.generateId3Frame('APIC', apicValue);
+    const apicID3 = Id3Generator.generateId3(apicFrame);
+    const expectedID3 = [
+      {
+        key: 'APIC',
+        mimeType: 'image/jpeg',
+        pictureType: 3,
+        description: 'Shaka',
+        data: BufferUtils.toArrayBuffer(new Uint8Array([1, 2, 3])),
+      },
+    ];
+    expect(Id3Utils.getID3Frames(apicID3)).toEqual(expectedID3);
+  });
+
+  it('parse an APIC frame with image URL', () => {
+    const apicValue = new Uint8Array([
+      3, 45, 45, 62, 0, 3, 83, 104, 97, 107, 97, 0, 103, 111, 111, 103, 108,
+      101, 46, 99, 111, 109,
+    ]);
+    const apicFrame = Id3Generator.generateId3Frame('APIC', apicValue);
+    const apicID3 = Id3Generator.generateId3(apicFrame);
+    const expectedID3 = [
+      {
+        key: 'APIC',
+        mimeType: '-->',
+        pictureType: 3,
+        description: 'Shaka',
+        data: 'google.com',
+      },
+    ];
+    expect(Id3Utils.getID3Frames(apicID3)).toEqual(expectedID3);
+  });
+
   it('parse a TXXX frame', () => {
     const txxxValue = new Uint8Array([3, 65, 0, 83, 104, 97, 107, 97]);
     const txxxFrame = Id3Generator.generateId3Frame('TXXX', txxxValue);
@@ -22,6 +60,8 @@ describe('Id3Utils', () => {
         key: 'TXXX',
         description: 'A',
         data: 'Shaka',
+        mimeType: null,
+        pictureType: null,
       },
     ];
     expect(Id3Utils.getID3Frames(txxxID3)).toEqual(expectedID3);
@@ -36,6 +76,8 @@ describe('Id3Utils', () => {
         key: 'TXXX',
         description: 'A',
         data: 'Shaka',
+        mimeType: null,
+        pictureType: null,
       },
     ];
     expect(Id3Utils.getID3Frames(txxxID3)).toEqual(expectedID3);
@@ -51,6 +93,8 @@ describe('Id3Utils', () => {
         key: 'TCOP',
         description: '',
         data: 'Shaka 2016',
+        mimeType: null,
+        pictureType: null,
       },
     ];
     expect(Id3Utils.getID3Frames(tcopID3)).toEqual(expectedID3);
@@ -66,6 +110,8 @@ describe('Id3Utils', () => {
         key: 'WXXX',
         description: 'A',
         data: 'google.com',
+        mimeType: null,
+        pictureType: null,
       },
     ];
     expect(Id3Utils.getID3Frames(wxxxID3)).toEqual(expectedID3);
@@ -81,6 +127,8 @@ describe('Id3Utils', () => {
         key: 'WCOP',
         description: '',
         data: 'google.com',
+        mimeType: null,
+        pictureType: null,
       },
     ];
     expect(Id3Utils.getID3Frames(wcopID3)).toEqual(expectedID3);
@@ -95,6 +143,8 @@ describe('Id3Utils', () => {
         key: 'PRIV',
         description: 'A',
         data: BufferUtils.toArrayBuffer(new Uint8Array([83, 104, 97, 107])),
+        mimeType: null,
+        pictureType: null,
       },
     ];
     expect(Id3Utils.getID3Frames(privID3)).toEqual(expectedID3);
@@ -109,6 +159,8 @@ describe('Id3Utils', () => {
         key: 'XXXX',
         description: '',
         data: BufferUtils.toArrayBuffer(new Uint8Array([83, 104, 97, 107])),
+        mimeType: null,
+        pictureType: null,
       },
     ];
     expect(Id3Utils.getID3Frames(unknownID3)).toEqual(expectedID3);