rx-player 3.25.2 → 3.26.3-dev.2022021400

package/src/core/eme/get_media_keys.ts

@@ -14,15 +14,13 @@
  * limitations under the License.
  */
 
-import {
-  Observable,
-  of as observableOf,
-} from "rxjs";
 import {
   catchError,
   map,
   mergeMap,
-} from "rxjs/operators";
+  Observable,
+  of as observableOf,
+} from "rxjs";
 import {
   ICustomMediaKeys,
   ICustomMediaKeySystemAccess,
@@ -112,7 +110,7 @@ export default function getMediaKeysInfos(
       }
 
       return createMediaKeys(mediaKeySystemAccess).pipe(map((mediaKeys) => {
-        log.info("EME: MediaKeys created with success", mediaKeys);
+        log.info("EME: MediaKeys created with success");
         const loadedSessionsStore = new LoadedSessionsStore(mediaKeys);
         return { mediaKeys,
                  mediaKeySystemAccess,

package/src/core/eme/get_session.ts

@@ -17,13 +17,11 @@
 import {
   concat as observableConcat,
   defer as observableDefer,
+  map,
+  mergeMap,
   Observable,
   of as observableOf,
 } from "rxjs";
-import {
-  map,
-  mergeMap,
-} from "rxjs/operators";
 import { ICustomMediaKeySession } from "../../compat";
 import log from "../../log";
 import cleanOldLoadedSessions, {

package/src/core/eme/init_media_keys.ts

@@ -15,18 +15,17 @@
  */
 
 import {
-  Observable,
-  of as observableOf,
-  ReplaySubject,
-} from "rxjs";
-import {
+  filter,
   mapTo,
   mergeMap,
+  Observable,
+  of as observableOf,
   startWith,
   take,
-} from "rxjs/operators";
+} from "rxjs";
 import log from "../../log";
 import isNullOrUndefined from "../../utils/is_null_or_undefined";
+import createSharedReference from "../../utils/reference";
 import attachMediaKeys, {
   disableMediaKeys,
 } from "./attach_media_keys";
@@ -67,7 +66,7 @@ export default function initMediaKeys(
         initializationDataSystemId = getDrmSystemId(mediaKeySystemAccess.keySystem);
       }
 
-      const attachMediaKeys$ = new ReplaySubject<void>(1);
+      const canAttachMediaKeys = createSharedReference(false);
       const shouldDisableOldMediaKeys =
         mediaElement.mediaKeys !== null &&
         mediaElement.mediaKeys !== undefined &&
@@ -81,7 +80,8 @@ export default function initMediaKeys(
       return disableOldMediaKeys$.pipe(
         mergeMap(() => {
           log.debug("EME: Attaching current MediaKeys");
-          return attachMediaKeys$.pipe(
+          return canAttachMediaKeys.asObservable().pipe(
+            filter(canAttach => canAttach),
             mergeMap(() => {
               const stateToAttatch = { loadedSessionsStore: stores.loadedSessionsStore,
                                        mediaKeySystemAccess,
@@ -98,7 +98,7 @@ export default function initMediaKeys(
                                  mediaKeys,
                                  stores,
                                  options,
-                                 attachMediaKeys$ } })
+                                 canAttachMediaKeys } })
           );
         })
       );

package/src/core/eme/session_events_listener.ts

@@ -15,27 +15,24 @@
  */
 
 import {
+  catchError,
   concat as observableConcat,
+  concatMap,
   defer as observableDefer,
   EMPTY,
   identity,
+  map,
   merge as observableMerge,
+  mergeMap,
   Observable,
   of as observableOf,
-  Subject,
-  TimeoutError,
-} from "rxjs";
-import {
-  catchError,
-  concatMap,
-  map,
-  mapTo,
-  mergeMap,
   startWith,
+  Subject,
   takeUntil,
   tap,
   timeout,
-} from "rxjs/operators";
+  TimeoutError,
+} from "rxjs";
 import {
   events,
   ICustomMediaKeySession,
@@ -109,7 +106,7 @@ export default function SessionEventsListener(
                IKeysUpdateEvent |
                ISessionUpdatedEvent>
 {
-  log.info("EME: Binding session events", session);
+  log.info("EME: Binding session events", session.sessionId);
   const sessionWarningSubject$ = new Subject<IEMEWarningEvent>();
   const { getLicenseConfig = {} } = keySystemOptions;
 
@@ -132,13 +129,15 @@ export default function SessionEventsListener(
         messageEvent.messageType :
         "license-request";
 
-      log.info(`EME: Received message event, type ${messageType}`, session, messageEvent);
+      log.info(`EME: Received message event, type ${messageType}`,
+               session.sessionId,
+               messageEvent);
       const getLicense$ = observableDefer(() => {
         const getLicense = keySystemOptions.getLicense(message, messageType);
         const getLicenseTimeout = isNullOrUndefined(getLicenseConfig.timeout) ?
           10 * 1000 :
           getLicenseConfig.timeout;
-        return (castToObservable(getLicense) as Observable<BufferSource|null>)
+        return castToObservable(getLicense)
           .pipe(getLicenseTimeout >= 0 ? timeout(getLicenseTimeout) :
                                          identity /* noop */);
       });
@@ -199,7 +198,11 @@ export default function SessionEventsListener(
     sessionWarningSubject$);
 
   return !isNullOrUndefined(session.closed) ?
-           sessionEvents.pipe(takeUntil(castToObservable(session.closed))) :
+           sessionEvents
+              // TODO There is a subtle TypeScript issue there that made casting
+              // to a type-compatible type mandatory. If a more elegant solution
+              // can be found, it should be preffered.
+             .pipe(takeUntil(castToObservable(session.closed as Promise<unknown>))) :
            sessionEvents;
 }
 
@@ -285,8 +288,8 @@ function updateSessionWithMessage(
       throw new EncryptedMediaError("KEY_UPDATE_ERROR", reason);
     }),
     tap(() => { log.info("EME: MediaKeySession update succeeded."); }),
-    mapTo({ type: "session-updated" as const,
-            value: { session, license: message, initializationData } })
+    map(() => ({ type: "session-updated" as const,
+                 value: { session, license: message, initializationData } }))
   );
 }
 
@@ -302,7 +305,7 @@ function handleKeyStatusesChangeEvent(
   keySystem : string,
   keyStatusesEvent : Event
 ) : Observable<IKeyStatusChangeHandledEvent | IKeysUpdateEvent | IEMEWarningEvent> {
-  log.info("EME: keystatuseschange event received", session, keyStatusesEvent);
+  log.info("EME: keystatuseschange event received", session.sessionId);
   const callback$ = observableDefer(() => {
     return tryCatch(() => {
       if (typeof keySystemOptions.onKeyStatusesChange !== "function") {
@@ -310,7 +313,7 @@ function handleKeyStatusesChangeEvent(
       }
       return castToObservable(keySystemOptions.onKeyStatusesChange(keyStatusesEvent,
                                                                    session));
-    }, undefined) as Observable< BufferSource | null >;
+    }, undefined);
   }).pipe(
     map(licenseObject => ({ type: "key-status-change-handled" as const,
                             value : { session, license: licenseObject } })),

package/src/core/eme/set_server_certificate.ts

@@ -15,16 +15,14 @@
  */
 
 import {
+  catchError,
   defer as observableDefer,
   EMPTY,
+  ignoreElements,
+  tap,
   Observable,
   of as observableOf,
 } from "rxjs";
-import {
-  catchError,
-  ignoreElements,
-  tap,
-} from "rxjs/operators";
 import { ICustomMediaKeys } from "../../compat";
 import { EncryptedMediaError } from "../../errors";
 import log from "../../log";
@@ -96,6 +94,12 @@ export default function trySettingServerCertificate(
     ServerCertificateStore.prepare(mediaKeys);
     return setServerCertificate(mediaKeys, serverCertificate).pipe(
       tap(() => { ServerCertificateStore.set(mediaKeys, serverCertificate); }),
+
+      // NOTE As of now (RxJS 7.4.0), RxJS defines `ignoreElements` default
+      // first type parameter as `any` instead of the perfectly fine `unknown`,
+      // leading to linter issues, as it forbids the usage of `any`.
+      // This is why we're disabling the eslint rule.
+      /* eslint-disable @typescript-eslint/no-unsafe-argument */
       ignoreElements(),
       catchError(error => observableOf({
         type: "warning" as const,

package/src/core/eme/types.ts

@@ -14,13 +14,13 @@
  * limitations under the License.
  */
 
-import { Subject } from "rxjs";
 import {
   ICustomMediaKeys,
   ICustomMediaKeySession,
   ICustomMediaKeySystemAccess,
 } from "../../compat";
 import { ICustomError } from "../../errors";
+import { ISharedReference } from "../../utils/reference";
 import LoadedSessionsStore from "./utils/loaded_sessions_store";
 import PersistentSessionsStore from "./utils/persistent_sessions_store";
 
@@ -40,7 +40,7 @@ export interface IInitializationDataInfo {
    * `undefined` when not known (different from an empty array - which would
    * just mean that there's no key id involved).
    */
-  keyIds? : Uint8Array[];
+  keyIds? : Uint8Array[] | undefined;
   /** Every initialization data for that type. */
   values: Array<{
     /**
@@ -78,8 +78,10 @@ export interface IEncryptedEvent { type: "encrypted-event-received";
  * current content.
  * This is necessary before creating a MediaKeySession which will allow
  * encryption keys to be communicated.
- * It carries a subject (attachMediaKeys$) that will be used by the init to
- * ask the EME to attach the mediakeys.
+ *
+ * It carries a shared reference (`canAttachMediaKeys`) that should be setted to
+ * `true` to indicate that RxPlayer's EME logic can start to attach the
+ * `MediaKeys` instance to the HTMLMediaElement.
  */
 export interface ICreatedMediaKeysEvent {
   type: "created-media-keys";
@@ -115,9 +117,18 @@ export interface ICreatedMediaKeysEvent {
     /** The MediaKeys instance. */
     mediaKeys : MediaKeys |
                 ICustomMediaKeys;
+
+    /** Stores allowing to cache MediaKeySession instances. */
     stores : IMediaKeySessionStores;
+
+    /** key system options considered. */
     options : IKeySystemOption;
-    attachMediaKeys$: Subject<void>;
+
+    /**
+     * Shared reference that should be set to `true` once the `MediaKeys`
+     * instance can be attached to the HTMLMediaElement.
+     */
+    canAttachMediaKeys: ISharedReference<boolean>;
   };
 }
 
@@ -287,7 +298,7 @@ export interface IContentProtection {
    * `undefined` when not known (different from an empty array - which would
    * just mean that there's no key id involved).
    */
-  keyIds? : Uint8Array[];
+  keyIds? : Uint8Array[] | undefined;
   /** Every initialization data for that type. */
   values: Array<{
     /**

package/src/core/eme/utils/close_session.ts

@@ -15,17 +15,15 @@
  */
 
 import {
+  catchError,
+  mergeMap,
   Observable,
   of as observableOf,
+  take,
+  tap,
   timer,
   race as observableRace,
 } from "rxjs";
-import {
-  catchError,
-  mergeMap,
-  take,
-  tap,
-} from "rxjs/operators";
 import {
   closeSession,
   ICustomMediaKeySession,
@@ -62,7 +60,9 @@ export default function safelyCloseMediaKeySession(
   function recursivelyTryToCloseMediaKeySession(
     retryNb : number
   ) : Observable<unknown> {
-    log.debug("EME: Trying to close a MediaKeySession", mediaKeySession, retryNb);
+    log.debug("EME: Trying to close a MediaKeySession",
+              mediaKeySession.sessionId,
+              retryNb);
     return closeSession(mediaKeySession).pipe(
       tap(() => { log.debug("EME: Succeeded to close MediaKeySession"); }),
       catchError((err : unknown) => {

package/src/core/eme/utils/is_session_usable.ts

@@ -41,7 +41,7 @@ export default function isSessionUsable(
 
   if (keyStatuses.length <= 0) {
     log.debug("EME: isSessionUsable: MediaKeySession given has an empty keyStatuses",
-              loadedSession);
+              loadedSession.sessionId);
     return false;
   }
 

package/src/core/eme/utils/loaded_sessions_store.ts

@@ -18,11 +18,11 @@ import {
   concat as observableConcat,
   defer as observableDefer,
   EMPTY,
+  ignoreElements,
   merge as observableMerge,
   Observable,
   of as observableOf,
 } from "rxjs";
-import { ignoreElements } from "rxjs/operators";
 import {
   ICustomMediaKeys,
   ICustomMediaKeySession,
@@ -167,7 +167,7 @@ export default class LoadedSessionsStore {
         });
     }
 
-    log.debug("EME-LSS: Add MediaKeySession", entry);
+    log.debug("EME-LSS: Add MediaKeySession", entry.sessionType);
     this._storage.store(initializationData, entry);
     return mediaKeySession;
   }

package/src/core/eme/utils/persistent_sessions_store.ts

@@ -183,7 +183,7 @@ export default class PersistentSessionsStore {
       this.delete(initData);
     }
 
-    log.info("EME-PSS: Add new session", sessionId, session);
+    log.info("EME-PSS: Add new session", sessionId);
 
     this._entries.push({ version: 3,
                          sessionId,
@@ -205,7 +205,7 @@ export default class PersistentSessionsStore {
       return;
     }
     const entry = this._entries[index];
-    log.warn("EME-PSS: Delete session from store", entry);
+    log.warn("EME-PSS: Delete session from store", entry.sessionId);
     this._entries.splice(index, 1);
     this._save();
   }

package/src/core/fetchers/index.ts

@@ -26,7 +26,7 @@ import SegmentFetcherCreator, {
   ISegmentFetcherChunkEvent,
   ISegmentFetcherCreatorBackoffOptions,
   ISegmentFetcherEvent,
-  ISegmentFetcherWarning,
+  ISegmentFetcherRetry,
 } from "./segment";
 
 export {
@@ -46,5 +46,5 @@ export {
 
   ISegmentFetcherChunkEvent,
   ISegmentFetcherChunkCompleteEvent,
-  ISegmentFetcherWarning,
+  ISegmentFetcherRetry,
 };