rx-player 4.2.0-dev.2024082600 → 4.2.0-dev.2024090500

package/src/core/adaptive/__tests__/buffer_based_chooser.test.ts

@@ -1,12 +1,7 @@
 import { describe, beforeEach, it, expect, vi } from "vitest";
+import type IBufferBasedChooser from "../buffer_based_chooser";
 import { ScoreConfidenceLevel } from "../utils/representation_score_calculator";
 
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 describe("BufferBasedChooser", () => {
   beforeEach(() => {
     vi.resetModules();
@@ -17,8 +12,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([]);
     bbc.onAddedSegment({ bufferGap: 0, speed: 1 });
@@ -79,8 +74,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     const bbc = new BufferBasedChooser([10, 20]);
     bbc.onAddedSegment({
@@ -101,8 +96,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([10, 20, 40]);
     bbc.onAddedSegment({
@@ -164,8 +159,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([10, 20, 40]);
     bbc.onAddedSegment({
@@ -227,8 +222,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([10, 20, 40]);
     bbc.onAddedSegment({
@@ -281,8 +276,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([10, 20, 40]);
     bbc.onAddedSegment({
@@ -314,8 +309,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([10, 20, 40]);
     bbc.onAddedSegment({
@@ -368,8 +363,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([10, 20, 40]);
     bbc.onAddedSegment({
@@ -422,8 +417,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([10, 20, 40]);
     bbc.onAddedSegment({
@@ -485,8 +480,8 @@ describe("BufferBasedChooser", () => {
     vi.doMock("../../../log", () => ({
       default: logger,
     }));
-    const BufferBasedChooser = ((await vi.importActual("../buffer_based_chooser")) as any)
-      .default;
+    const BufferBasedChooser = (await vi.importActual("../buffer_based_chooser"))
+      .default as typeof IBufferBasedChooser;
 
     let bbc = new BufferBasedChooser([10, 20, 40]);
     bbc.onAddedSegment({

package/src/core/cmcd/cmcd_data_builder.ts

@@ -377,8 +377,8 @@ export default class CmcdDataBuilder {
       }
     };
 
-    addNumberProperty("br", "object");
     addNumberProperty("bl", "request");
+    addNumberProperty("br", "object");
     addBooleanProperty("bs", "status");
     addStringProperty("cid", "session");
     addNumberProperty("d", "object");

package/src/core/fetchers/README.md

@@ -18,8 +18,8 @@ This directory actually exports two completely isolated type of fetchers:
 
 - The **Manifest fetcher** is used to download and parse the manifest file.
 
-- The **SegmentFetcherCreator** is used to create Segment fetchers, allowing to download
-  and parse media segments.
+- The **SegmentQueueCreator** is used to create `SegmentQueue` objects, allowing to
+  download and parse media segments.
 
 ## The Manifest fetcher
 
@@ -32,22 +32,23 @@ parsing of the Manifest file.
 It also regularly refreshes the Manifest, based on its attributes and other criteria, like
 performances when doing that.
 
-## The SegmentFetcherCreator
+## The SegmentQueueCreator
 
-The SegmentFetcherCreator allows to easily perform segment downloads for the rest of the
+The SegmentQueueCreator allows to easily perform segment downloads for the rest of the
 code. This is the part of the code that interacts with the transport protocols - defined
-in `stc/transports` - to load and parse media segments.
+in `src/transports` - to load and parse media segments.
 
-To do so, the SegmentFetcherCreator creates "segment fetchers" of different types
-(example: a video or audio segment fetcher) when you ask for it. Through those fetchers,
-you can then schedule various segment requests with a given priority.
+To do so, the SegmentQueueCreator creates `SegmentQueue` classes of different types
+(example: a video or audio `SegmentQueue`) when you ask for it. Through those
+`SegmentQueue`, you can then schedule various a FIFO queue of segment requests each with a
+given priority.
 
 The priority of this request is then corroborated with the priority of all requests
-currently pending in the SegmentFetcherCreator (and not only with those on the current
-segment fetcher) to know when the request should effectively be done - more prioritary
+currently pending in the SegmentQueueCreator (and not only with those on the current
+`SegmentQueue`) to know when the request should effectively be done - more prioritary
 requests will be done first.
 
-During the lifecycle of the request, the segment fetcher will communicate about data and
+During the lifecycle of the request, the `SegmentQueue` will communicate about data and
 metrics through several means - documented in the code.
 
 ### Priorization
@@ -64,7 +65,7 @@ If the request has no priorization number, the lowest priorization number (the h
 priority) will be set on it: `0`
 
 Basically, any new request will have their priorization number compared to the one of the
-current request(s) done by the SegmentFetcherCreator:
+current request(s) done by the SegmentQueueCreator:
 
 - if no request is already pending, we perform the request immediately
 

package/src/core/fetchers/index.ts

@@ -20,17 +20,14 @@ import type {
   IManifestRefreshSettings,
 } from "./manifest";
 import ManifestFetcher from "./manifest";
-import type {
-  IPrioritizedSegmentFetcher,
-  ISegmentFetcherCreatorBackoffOptions,
-} from "./segment";
-import SegmentFetcherCreator from "./segment";
+import type { SegmentQueue, ISegmentQueueCreatorBackoffOptions } from "./segment";
+import SegmentQueueCreator from "./segment";
 
 export type {
   IManifestFetcherSettings,
   IManifestFetcherEvent,
   IManifestRefreshSettings,
-  IPrioritizedSegmentFetcher,
-  ISegmentFetcherCreatorBackoffOptions,
+  ISegmentQueueCreatorBackoffOptions,
+  SegmentQueue,
 };
-export { ManifestFetcher, SegmentFetcherCreator };
+export { ManifestFetcher, SegmentQueueCreator };

package/src/core/fetchers/segment/__tests__/task_prioritizer.test.ts

@@ -1,4 +1,5 @@
 import { describe, it, expect, vi } from "vitest";
+import noop from "../../../../utils/noop";
 import type {
   CancellationError,
   CancellationSignal,
@@ -7,13 +8,6 @@ import TaskCanceller from "../../../../utils/task_canceller";
 import type { ITaskFn } from "../task_prioritizer";
 import TaskPrioritizer from "../task_prioritizer";
 
-/* eslint-disable @typescript-eslint/no-floating-promises */
-
-// function assert(condition: boolean, msg?: string): asserts condition {
-//   if (!condition) {
-//     throw new Error(msg ?? "The asserted condition turned out to be false.");
-//   }
-// }
 function generateTaskFunction<T>(res: T): ITaskFn<T> {
   return (cancelSignal: CancellationSignal) => {
     return new Promise((resolve, reject) => {
@@ -112,7 +106,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(task1).toHaveBeenCalledTimes(1);
         expect(task2).toHaveBeenCalledTimes(1);
         expect(task3).toHaveBeenCalledTimes(1);
-      });
+      }, noop);
 
     prioritizer
       .create(
@@ -137,7 +131,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(task1).toHaveBeenCalledTimes(1);
         expect(task2).toHaveBeenCalledTimes(1);
         expect(task3).toHaveBeenCalledTimes(1);
-      });
+      }, noop);
 
     const prom = prioritizer
       .create(
@@ -207,7 +201,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(task1).toHaveBeenCalledTimes(1);
         expect(task2).toHaveBeenCalledTimes(1);
         expect(task3).toHaveBeenCalledTimes(1);
-      });
+      }, noop);
 
     prioritizer
       .create(
@@ -232,7 +226,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(task1).toHaveBeenCalledTimes(1);
         expect(task2).toHaveBeenCalledTimes(1);
         expect(task3).toHaveBeenCalledTimes(1);
-      });
+      }, noop);
 
     const prom = prioritizer
       .create(
@@ -302,7 +296,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(1);
         expect(was1Interrupted).toEqual(0);
         expect(was1Ended).toEqual(true);
-      });
+      }, noop);
 
     prioritizer
       .create(
@@ -327,7 +321,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(was1Ended).toEqual(true);
         expect(was2Interrupted).toEqual(0);
         expect(was2Ended).toEqual(true);
-      });
+      }, noop);
 
     const prom = prioritizer
       .create(
@@ -431,7 +425,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(2);
         expect(was2Interrupted).toEqual(0);
         expect(was2Ended).toEqual(true);
-      });
+      }, noop);
 
     prioritizer
       .create(
@@ -458,7 +452,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(3);
         expect(was3Interrupted).toEqual(0);
         expect(was3Ended).toEqual(true);
-      });
+      }, noop);
     expect(task1).toHaveBeenCalledTimes(1);
     expect(task2).toHaveBeenCalledTimes(1);
     expect(task3).toHaveBeenCalledTimes(0);
@@ -535,7 +529,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(2);
         expect(was2Interrupted).toEqual(0);
         expect(was2Ended).toEqual(true);
-      });
+      }, noop);
 
     prioritizer
       .create(
@@ -562,7 +556,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(3);
         expect(was3Interrupted).toEqual(0);
         expect(was3Ended).toEqual(true);
-      });
+      }, noop);
 
     expect(task1).toHaveBeenCalledTimes(1);
     expect(task2).toHaveBeenCalledTimes(0);
@@ -643,7 +637,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(2);
         expect(was2Interrupted).toEqual(0);
         expect(was2Ended).toEqual(true);
-      });
+      }, noop);
 
     prioritizer
       .create(
@@ -670,7 +664,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(3);
         expect(was3Interrupted).toEqual(0);
         expect(was3Ended).toEqual(true);
-      });
+      }, noop);
     expect(task1).toHaveBeenCalledTimes(2);
     expect(task2).toHaveBeenCalledTimes(1);
     expect(task3).toHaveBeenCalledTimes(0);
@@ -747,7 +741,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(2);
         expect(was2Interrupted).toEqual(1);
         expect(was2Ended).toEqual(true);
-      });
+      }, noop);
 
     prioritizer
       .create(
@@ -774,7 +768,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(3);
         expect(was3Interrupted).toEqual(0);
         expect(was3Ended).toEqual(true);
-      });
+      }, noop);
     expect(task1).toHaveBeenCalledTimes(2);
     expect(task2).toHaveBeenCalledTimes(1);
     expect(task3).toHaveBeenCalledTimes(0);
@@ -852,7 +846,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(2);
         expect(was2Interrupted).toEqual(0);
         expect(was2Ended).toEqual(true);
-      });
+      }, noop);
     expect(task1).toHaveBeenCalledTimes(1);
     expect(task2).toHaveBeenCalledTimes(1);
     expect(was1Interrupted).toEqual(0);
@@ -901,7 +895,7 @@ describe("SegmentFetchers TaskPrioritizer", () => {
         expect(val).toEqual(1);
         expect(was1Interrupted).toEqual(0);
         expect(was1Ended).toEqual(true);
-      });
+      }, noop);
 
     const prom = prioritizer
       .create(

package/src/core/fetchers/segment/index.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 
-import type { IPrioritizedSegmentFetcher } from "./prioritized_segment_fetcher";
-import type { ISegmentFetcherCreatorBackoffOptions } from "./segment_fetcher_creator";
-import SegmentFetcherCreator from "./segment_fetcher_creator";
+import type SegmentQueue from "./segment_queue";
+import type { ISegmentQueueContext } from "./segment_queue";
+import type { ISegmentQueueCreatorBackoffOptions } from "./segment_queue_creator";
+import SegmentQueueCreator from "./segment_queue_creator";
 
-export default SegmentFetcherCreator;
-export type { IPrioritizedSegmentFetcher, ISegmentFetcherCreatorBackoffOptions };
+export default SegmentQueueCreator;
+export type { SegmentQueue, ISegmentQueueCreatorBackoffOptions, ISegmentQueueContext };