rx-player 3.27.0-dev.2022032100 → 3.27.0-dev.2022032500

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## v3.27.0-dev.2022032100 (2022-03-21)
+## v3.27.0-dev.2022032500 (2022-03-25)
 
 ### Features
 
@@ -19,6 +19,7 @@
   - avoid unnecessary warning logs when loading some initialization segments [#1049]
   - TypeScript: Add forgotten TypeScript types in the exposed segment and manifest loader APIs [#1057]
   - DRM: Avoid decryption issues when a license is persisted in a `singleLicensePer` `"init-data"` mode but loaded in a `"content"` mode [#1031, #1042]
+  - DRM: Totally avoid the theoretical possibility of leaking MediaKeySessions when a `generateRequest` or `load` call takes multiple seconds [#1093]
 
 ### Other improvements
 
@@ -27,6 +28,7 @@
   - DASH: Prioritize selectionPriority attribute over a "main" Role when ordering AdaptationSets [#1082]
   - directfile/Safari: use the `getStartDate` method in `getWallClockTime` when available to obtain true offseted times when playing HLS contents on Safari [#1055]
   - DRM: Improve DRM Session caches performance when `singleLicensePer` is set to `"content"`
+  - DRM: Stop retrying closing MediaKeySessions multiple times when it fails, instead doing it only once when it should work [#1093]
   - TypeScript: Add IBitrateEstimate, IPositionUpdate and IPlayerState types to the exported types [#1084]
   - Remove dependency on pinkie's promise ponyfill [#1058, #1090]
   - tests: add performance tests, to better catch and avoid performance regressions [#1053, #1062]

package/VERSION

@@ -1 +1 @@
-3.27.0-dev.2022032100
+3.27.0-dev.2022032500

package/dist/_esm5.processed/compat/eme/custom_media_keys/old_webkit_media_keys.js

@@ -56,16 +56,20 @@ var OldWebkitMediaKeySession = /** @class */ (function (_super) {
         _this._key = keySystem;
         _this.sessionId = "";
         _this._closeSession = noop; // Just here to make TypeScript happy
-        _this.closed = new Promise(function (resolve) {
-            _this._closeSession = resolve;
-        });
         _this.keyStatuses = new Map();
         _this.expiration = NaN;
-        _this._onSessionRelatedEvent = function (evt) {
+        var onSessionRelatedEvent = function (evt) {
             _this.trigger(evt.type, evt);
         };
+        _this.closed = new Promise(function (resolve) {
+            _this._closeSession = function () {
+                ["keymessage", "message", "keyadded", "ready", "keyerror", "error"]
+                    .forEach(function (evt) { return mediaElement.removeEventListener(evt, onSessionRelatedEvent); });
+                resolve();
+            };
+        });
         ["keymessage", "message", "keyadded", "ready", "keyerror", "error"]
-            .forEach(function (evt) { return mediaElement.addEventListener(evt, _this._onSessionRelatedEvent); });
+            .forEach(function (evt) { return mediaElement.addEventListener(evt, onSessionRelatedEvent); });
         return _this;
     }
     OldWebkitMediaKeySession.prototype.update = function (license) {
@@ -105,7 +109,6 @@ var OldWebkitMediaKeySession = /** @class */ (function (_super) {
     OldWebkitMediaKeySession.prototype.close = function () {
         var _this = this;
         return new Promise(function (resolve) {
-            _this._unbindSession();
             _this._closeSession();
             resolve();
         });
@@ -122,11 +125,6 @@ var OldWebkitMediaKeySession = /** @class */ (function (_super) {
     OldWebkitMediaKeySession.prototype.remove = function () {
         return Promise.resolve();
     };
-    OldWebkitMediaKeySession.prototype._unbindSession = function () {
-        var _this = this;
-        ["keymessage", "message", "keyadded", "ready", "keyerror", "error"]
-            .forEach(function (evt) { return _this._vid.removeEventListener(evt, _this._onSessionRelatedEvent); });
-    };
     return OldWebkitMediaKeySession;
 }(EventEmitter));
 var OldWebKitCustomMediaKeys = /** @class */ (function () {

package/dist/_esm5.processed/compat/eme/custom_media_keys/webkit_media_keys.js

@@ -81,9 +81,6 @@ var WebkitMediaKeySession = /** @class */ (function (_super) {
         });
         _this.keyStatuses = new Map();
         _this.expiration = NaN;
-        _this._onEvent = function (evt) {
-            _this.trigger(evt.type, evt);
-        };
         return _this;
     }
     WebkitMediaKeySession.prototype.update = function (license) {
@@ -96,9 +93,19 @@ var WebkitMediaKeySession = /** @class */ (function (_super) {
                 return reject("Unavailable WebKit key session.");
             }
             try {
+                var uInt8Arraylicense = void 0;
+                if (license instanceof ArrayBuffer) {
+                    uInt8Arraylicense = new Uint8Array(license);
+                }
+                else if (license instanceof Uint8Array) {
+                    uInt8Arraylicense = license;
+                }
+                else {
+                    uInt8Arraylicense = new Uint8Array(license.buffer);
+                }
                 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-                resolve(_this._nativeSession.update(license));
+                resolve(_this._nativeSession.update(uInt8Arraylicense));
                 /* eslint-enable @typescript-eslint/no-unsafe-member-access */
             }
             catch (err) {
@@ -171,14 +178,17 @@ var WebkitMediaKeySession = /** @class */ (function (_super) {
     WebkitMediaKeySession.prototype._listenEvent = function (session) {
         var _this = this;
         this._unbindSession(); // If previous session was linked
+        var onEvent = function (evt) {
+            _this.trigger(evt.type, evt);
+        };
         /* eslint-disable @typescript-eslint/no-unsafe-call */
         /* eslint-disable @typescript-eslint/no-unsafe-member-access */
         /* eslint-disable @typescript-eslint/no-unsafe-return */
         ["keymessage", "message", "keyadded", "ready", "keyerror", "error"]
-            .forEach(function (evt) { return session.addEventListener(evt, _this._onEvent); });
+            .forEach(function (evt) { return session.addEventListener(evt, onEvent); });
         this._unbindSession = function () {
             ["keymessage", "message", "keyadded", "ready", "keyerror", "error"]
-                .forEach(function (evt) { return session.removeEventListener(evt, _this._onEvent); });
+                .forEach(function (evt) { return session.removeEventListener(evt, onEvent); });
         };
         /* eslint-disable @typescript-eslint/no-unsafe-return */
         /* eslint-disable @typescript-eslint/no-unsafe-member-access */

package/dist/_esm5.processed/compat/eme/generate_key_request.d.ts

@@ -45,12 +45,10 @@ export declare function patchInitData(initData: Uint8Array): Uint8Array;
  * Generate a request from session.
  * @param {MediaKeySession} session - MediaKeySession on which the request will
  * be done.
- * @param {Uint8Array} initData - Initialization data given e.g. by the
- * "encrypted" event for the corresponding request.
- * @param {string} initDataType - Initialization data type given e.g. by the
- * "encrypted" event for the corresponding request.
- * @param {string} sessionType - Type of session you want to generate. Consult
- * EME Specification for more information on session types.
+ * @param {string} initializationDataType - Initialization data type given e.g.
+ * by the "encrypted" event for the corresponding request.
+ * @param {Uint8Array} initializationData - Initialization data given e.g. by
+ * the "encrypted" event for the corresponding request.
  * @returns {Promise} - Emit when done. Errors if fails.
  */
 export default function generateKeyRequest(session: MediaKeySession | ICustomMediaKeySession, initializationDataType: string | undefined, initializationData: Uint8Array): Promise<unknown>;

package/dist/_esm5.processed/compat/eme/generate_key_request.js

@@ -114,12 +114,10 @@ export function patchInitData(initData) {
  * Generate a request from session.
  * @param {MediaKeySession} session - MediaKeySession on which the request will
  * be done.
- * @param {Uint8Array} initData - Initialization data given e.g. by the
- * "encrypted" event for the corresponding request.
- * @param {string} initDataType - Initialization data type given e.g. by the
- * "encrypted" event for the corresponding request.
- * @param {string} sessionType - Type of session you want to generate. Consult
- * EME Specification for more information on session types.
+ * @param {string} initializationDataType - Initialization data type given e.g.
+ * by the "encrypted" event for the corresponding request.
+ * @param {Uint8Array} initializationData - Initialization data given e.g. by
+ * the "encrypted" event for the corresponding request.
  * @returns {Promise} - Emit when done. Errors if fails.
  */
 export default function generateKeyRequest(session, initializationDataType, initializationData) {

package/dist/_esm5.processed/config.d.ts

@@ -145,9 +145,6 @@ declare class ConfigHandler {
         DASH_FALLBACK_LIFETIME_WHEN_MINIMUM_UPDATE_PERIOD_EQUAL_0: number;
         EME_DEFAULT_MAX_SIMULTANEOUS_MEDIA_KEY_SESSIONS: number;
         EME_MAX_STORED_PERSISTENT_SESSION_INFORMATION: number;
-        EME_SESSION_CLOSING_MAX_RETRY: number;
-        EME_SESSION_CLOSING_INITIAL_DELAY: number;
-        EME_SESSION_CLOSING_MAX_DELAY: number;
         EME_WAITING_DELAY_LOADED_SESSION_EMPTY_KEYSTATUSES: number;
         FORCED_ENDED_THRESHOLD: number;
         ADAPTATION_SWITCH_BUFFER_PADDINGS: {

package/dist/_esm5.processed/core/api/public_api.js

@@ -87,7 +87,7 @@ var Player = /** @class */ (function (_super) {
         // Workaround to support Firefox autoplay on FF 42.
         // See: https://bugzilla.mozilla.org/show_bug.cgi?id=1194624
         videoElement.preload = "auto";
-        _this.version = /* PLAYER_VERSION */ "3.27.0-dev.2022032100";
+        _this.version = /* PLAYER_VERSION */ "3.27.0-dev.2022032500";
         _this.log = log;
         _this.state = "STOPPED";
         _this.videoElement = videoElement;
@@ -2302,5 +2302,5 @@ var Player = /** @class */ (function (_super) {
     };
     return Player;
 }(EventEmitter));
-Player.version = /* PLAYER_VERSION */ "3.27.0-dev.2022032100";
+Player.version = /* PLAYER_VERSION */ "3.27.0-dev.2022032500";
 export default Player;

package/dist/_esm5.processed/core/decrypt/content_decryptor.js

@@ -84,7 +84,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
     return to.concat(ar || Array.prototype.slice.call(from));
 };
-import { events, generateKeyRequest, getInitData, } from "../../compat/";
+import { events, getInitData, } from "../../compat/";
 import config from "../../config";
 import { EncryptedMediaError, OtherError, } from "../../errors";
 import log from "../../log";
@@ -318,7 +318,7 @@ var ContentDecryptor = /** @class */ (function (_super) {
      */
     ContentDecryptor.prototype._processInitializationData = function (initializationData, mediaKeysData) {
         return __awaiter(this, void 0, void 0, function () {
-            var mediaKeySystemAccess, stores, options, firstCreatedSession, keyIds, hexKids, period, createdSessions, periodKeys, _i, createdSessions_1, createdSess, periodKeysArr, _a, periodKeysArr_1, kid, _b, periodKeysArr_2, innerKid, wantedSessionType, _c, EME_DEFAULT_MAX_SIMULTANEOUS_MEDIA_KEY_SESSIONS, EME_MAX_STORED_PERSISTENT_SESSION_INFORMATION, maxSessionCacheSize, sessionRes, sessionInfo, _d, mediaKeySession, sessionType, isSessionPersisted, sub, requestData, error_1;
+            var mediaKeySystemAccess, stores, options, firstCreatedSession, keyIds, hexKids, period, createdSessions, periodKeys, _i, createdSessions_1, createdSess, periodKeysArr, _a, periodKeysArr_1, kid, _b, periodKeysArr_2, innerKid, wantedSessionType, _c, EME_DEFAULT_MAX_SIMULTANEOUS_MEDIA_KEY_SESSIONS, EME_MAX_STORED_PERSISTENT_SESSION_INFORMATION, maxSessionCacheSize, sessionRes, sessionInfo, _d, mediaKeySession, sessionType, isSessionPersisted, sub, requestData, error_1, entry, indexInCurrent;
             var _this = this;
             return __generator(this, function (_e) {
                 switch (_e.label) {
@@ -486,12 +486,20 @@ var ContentDecryptor = /** @class */ (function (_super) {
                         _e.label = 2;
                     case 2:
                         _e.trys.push([2, 4, , 5]);
-                        return [4 /*yield*/, generateKeyRequest(mediaKeySession, initializationData.type, requestData)];
+                        return [4 /*yield*/, stores.loadedSessionsStore.generateLicenseRequest(mediaKeySession, initializationData.type, requestData)];
                     case 3:
                         _e.sent();
                         return [3 /*break*/, 5];
                     case 4:
                         error_1 = _e.sent();
+                        entry = stores.loadedSessionsStore.getEntryForSession(mediaKeySession);
+                        if (entry === null || entry.closingStatus.type !== "none") {
+                            indexInCurrent = this._currentSessions.indexOf(sessionInfo);
+                            if (indexInCurrent >= 0) {
+                                this._currentSessions.splice(indexInCurrent, 1);
+                            }
+                            return [2 /*return*/, Promise.resolve()];
+                        }
                         throw new EncryptedMediaError("KEY_GENERATE_REQUEST_ERROR", error_1 instanceof Error ? error_1.toString() :
                             "Unknown error");
                     case 5: return [2 /*return*/, Promise.resolve()];

package/dist/_esm5.processed/core/decrypt/create_or_load_session.js

@@ -111,7 +111,7 @@ export default function createOrLoadSession(initializationData, stores, wantedSe
                     if (cancelSignal.cancellationError !== null) {
                         throw cancelSignal.cancellationError; // stop here if cancelled since
                     }
-                    return [4 /*yield*/, createSession(stores, initializationData, wantedSessionType)];
+                    return [4 /*yield*/, createSession(stores, initializationData, wantedSessionType, cancelSignal)];
                 case 4:
                     evt = _a.sent();
                     return [2 /*return*/, { type: evt.type,

package/dist/_esm5.processed/core/decrypt/create_session.d.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import { ICustomMediaKeySession } from "../../compat";
+import { CancellationSignal } from "../../utils/task_canceller";
 import { IProcessedProtectionData, IMediaKeySessionStores, MediaKeySessionLoadingType } from "./types";
 import KeySessionRecord from "./utils/key_session_record";
 /**
@@ -29,9 +30,10 @@ import KeySessionRecord from "./utils/key_session_record";
  * @param {Object} stores
  * @param {Object} initData
  * @param {string} wantedSessionType
+ * @param {Object} cancelSignal
  * @returns {Promise}
  */
-export default function createSession(stores: IMediaKeySessionStores, initData: IProcessedProtectionData, wantedSessionType: MediaKeySessionType): Promise<ICreateSessionEvent>;
+export default function createSession(stores: IMediaKeySessionStores, initData: IProcessedProtectionData, wantedSessionType: MediaKeySessionType, cancelSignal: CancellationSignal): Promise<ICreateSessionEvent>;
 export interface INewSessionCreatedEvent {
     type: MediaKeySessionLoadingType.Created;
     value: {

package/dist/_esm5.processed/core/decrypt/create_session.js

@@ -49,7 +49,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { loadSession, } from "../../compat";
 import log from "../../log";
 import isSessionUsable from "./utils/is_session_usable";
 /**
@@ -65,9 +64,10 @@ import isSessionUsable from "./utils/is_session_usable";
  * @param {Object} stores
  * @param {Object} initData
  * @param {string} wantedSessionType
+ * @param {Object} cancelSignal
  * @returns {Promise}
  */
-export default function createSession(stores, initData, wantedSessionType) {
+export default function createSession(stores, initData, wantedSessionType, cancelSignal) {
     var loadedSessionsStore = stores.loadedSessionsStore, persistentSessionsStore = stores.persistentSessionsStore;
     if (wantedSessionType === "temporary") {
         return createTemporarySession(loadedSessionsStore, initData);
@@ -77,7 +77,7 @@ export default function createSession(stores, initData, wantedSessionType) {
             "PersistentSessionsStore not created.");
         return createTemporarySession(loadedSessionsStore, initData);
     }
-    return createAndTryToRetrievePersistentSession(loadedSessionsStore, persistentSessionsStore, initData);
+    return createAndTryToRetrievePersistentSession(loadedSessionsStore, persistentSessionsStore, initData, cancelSignal);
 }
 /**
  * Create a new temporary MediaKeySession linked to the given initData and
@@ -98,9 +98,10 @@ function createTemporarySession(loadedSessionsStore, initData) {
  * @param {Object} loadedSessionsStore
  * @param {Object} persistentSessionsStore
  * @param {Object} initData
+ * @param {Object} cancelSignal
  * @returns {Promise}
  */
-function createAndTryToRetrievePersistentSession(loadedSessionsStore, persistentSessionsStore, initData) {
+function createAndTryToRetrievePersistentSession(loadedSessionsStore, persistentSessionsStore, initData, cancelSignal) {
     return __awaiter(this, void 0, void 0, function () {
         /**
          * Helper function to close and restart the current persistent session
@@ -113,6 +114,9 @@ function createAndTryToRetrievePersistentSession(loadedSessionsStore, persistent
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
+                            if (cancelSignal.cancellationError !== null) {
+                                throw cancelSignal.cancellationError;
+                            }
                             log.info("DRM: Removing previous persistent session.");
                             persistentEntry = persistentSessionsStore.get(initData);
                             if (persistentEntry !== null) {
@@ -121,6 +125,9 @@ function createAndTryToRetrievePersistentSession(loadedSessionsStore, persistent
                             return [4 /*yield*/, loadedSessionsStore.closeSession(entry.mediaKeySession)];
                         case 1:
                             _a.sent();
+                            if (cancelSignal.cancellationError !== null) {
+                                throw cancelSignal.cancellationError;
+                            }
                             newEntry = loadedSessionsStore.createSession(initData, "persistent-license");
                             return [2 /*return*/, { type: "created-session" /* Created */,
                                     value: newEntry }];
@@ -132,6 +139,9 @@ function createAndTryToRetrievePersistentSession(loadedSessionsStore, persistent
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
+                    if (cancelSignal.cancellationError !== null) {
+                        throw cancelSignal.cancellationError;
+                    }
                     log.info("DRM: Creating persistent MediaKeySession");
                     entry = loadedSessionsStore.createSession(initData, "persistent-license");
                     storedEntry = persistentSessionsStore.getAndReuse(initData);
@@ -142,7 +152,7 @@ function createAndTryToRetrievePersistentSession(loadedSessionsStore, persistent
                     _a.label = 1;
                 case 1:
                     _a.trys.push([1, 3, , 4]);
-                    return [4 /*yield*/, loadSession(entry.mediaKeySession, storedEntry.sessionId)];
+                    return [4 /*yield*/, loadedSessionsStore.loadPersistentSession(entry.mediaKeySession, storedEntry.sessionId)];
                 case 2:
                     hasLoadedSession = _a.sent();
                     if (!hasLoadedSession) {

package/dist/_esm5.processed/core/decrypt/utils/loaded_sessions_store.d.ts

@@ -37,7 +37,7 @@ export default class LoadedSessionsStore {
     constructor(mediaKeys: MediaKeys | ICustomMediaKeys);
     /**
      * Create a new MediaKeySession and store it in this store.
-     * @param {Object} initializationData
+     * @param {Object} initData
      * @param {string} sessionType
      * @returns {Object}
      */
@@ -55,6 +55,32 @@ export default class LoadedSessionsStore {
      * @returns {Object|null}
      */
     reuse(initializationData: IProcessedProtectionData): IStoredSessionEntry | null;
+    /**
+     * Get `LoadedSessionsStore`'s entry for a given MediaKeySession.
+     * Returns `null` if the given MediaKeySession is not stored in the
+     * `LoadedSessionsStore`.
+     * @param {MediaKeySession} mediaKeySession
+     * @returns {Object|null}
+     */
+    getEntryForSession(mediaKeySession: MediaKeySession | ICustomMediaKeySession): IStoredSessionEntry | null;
+    /**
+     * Generate a license request on the given MediaKeySession, while indicating
+     * to the LoadedSessionsStore that a license-request is pending so
+     * session-closing orders are properly scheduled after it is done.
+     * @param {Object} mediaKeySession
+     * @param {string} initializationDataType - Initialization data type given
+     * e.g. by the "encrypted" event for the corresponding request.
+     * @param {Uint8Array} initializationData - Initialization data given e.g. by
+     * the "encrypted" event for the corresponding request.
+     * @returns {Promise}
+     */
+    generateLicenseRequest(mediaKeySession: MediaKeySession | ICustomMediaKeySession, initializationDataType: string | undefined, initializationData: Uint8Array): Promise<unknown>;
+    /**
+     * @param {Object} mediaKeySession
+     * @param {string} sessionId
+     * @returns {Promise}
+     */
+    loadPersistentSession(mediaKeySession: MediaKeySession | ICustomMediaKeySession, sessionId: string): Promise<boolean>;
     /**
      * Close a MediaKeySession and remove its related stored information from the
      * `LoadedSessionsStore`.
@@ -80,7 +106,23 @@ export default class LoadedSessionsStore {
      * @returns {Promise}
      */
     closeAllSessions(): Promise<void>;
+    /**
+     * Get the index of a stored MediaKeySession entry based on its
+     * `KeySessionRecord`.
+     * Returns -1 if not found.
+     * @param {Object} record
+     * @returns {number}
+     */
     private getIndex;
+    /**
+     * Prepare the closure of a `MediaKeySession` stored as an entry of the
+     * `LoadedSessionsStore`.
+     * Allows to postpone the closure action if another MediaKeySession action
+     * is already pending.
+     * @param {Object} entry
+     * @returns {Promise.<boolean>}
+     */
+    private _closeEntry;
 }
 /** Information linked to a `MediaKeySession` created by the `LoadedSessionsStore`. */
 export interface IStoredSessionEntry {
@@ -105,4 +147,55 @@ export interface IStoredSessionEntry {
      * which the MediaKeySession was created.
      */
     sessionType: MediaKeySessionType;
+    /**
+     * Set to `true` while a `generateRequest` call is pending.
+     * This information might be useful as it is one of the operation we have to
+     * wait for before closing a MediaKeySession.
+     */
+    isGeneratingRequest: boolean;
+    /**
+     * Set to `true` while a `load` call is pending.
+     * This information might be useful as it is one of the operation we have to
+     * wait for before closing a MediaKeySession.
+     */
+    isLoadingPersistentSession: boolean;
+    /**
+     * The status of a potential `MediaKeySession`'s close request.
+     * Closing a MediaKeySession could be made complex as it normally cannot
+     * happen until `generateRequest` or `load` has been called.
+     *
+     * To avoid problems while still staying compatible to the most devices
+     * possible - which may have strange implementation of the specification -
+     * we're adding the `closingStatus` property allowing to perform multiple
+     * type of interaction while a close operation is either pending or is
+     * awaited.
+     */
+    closingStatus: 
+    /** Status when the MediaKeySession is currently being closed. */
+    {
+        type: "pending";
+    } | 
+    /** Status when the MediaKeySession has been closed. */
+    {
+        type: "done";
+    } | 
+    /** Status when the MediaKeySession failed to close. */
+    {
+        type: "failed";
+    } | 
+    /**
+     * Status when a close order has been received for this MediaKeySession
+     * while some sensitive operation (examples are `generateRequest` and `load`
+     * calls).
+     * The `LoadedSessionsStore` should call `start` once it has finished those
+     * operations.
+     */
+    {
+        type: "awaiting";
+        start: () => void;
+    } | 
+    /** Status when the MediaKeySession failed to close. */
+    {
+        type: "none";
+    };
 }