fix: support check persistent-license to remove the mediakeysession (#7050)

Authored-by: Huan Pu <[email protected]>

Author: JackPu

src/controller/eme-controller.ts

@@ -12,6 +12,7 @@ import { Logger } from '../utils/logger';
 import {
   getKeySystemsForConfig,
   getSupportedMediaKeySystemConfigurations,
+  isPersistentSessionType,
   keySystemFormatToKeySystemDomain,
   keySystemIdToKeySystemDomain,
   KeySystems,
@@ -1409,8 +1410,17 @@ class EMEController extends Logger implements ComponentAPI {
       if (index > -1) {
         this.mediaKeySessions.splice(index, 1);
       }
-      return mediaKeysSession
-        .remove()
+      const { drmSystemOptions } = this.config;
+      const removePromise = isPersistentSessionType(drmSystemOptions)
+        ? new Promise((resolve, reject) => {
+            self.setTimeout(
+              () => reject(new Error(`MediaKeySession.remove() timeout`)),
+              8000,
+            );
+            mediaKeysSession.remove().then(resolve);
+          })
+        : Promise.resolve();
+      return removePromise
         .catch((error) => {
           this.log(`Could not remove session: ${error}`);
           this.hls?.trigger(Events.ERROR, {

src/utils/mediakeys-helper.ts

@@ -166,6 +166,17 @@ function createMediaKeySystemConfigurations(
   return [baseConfig];
 }
 
+export function isPersistentSessionType(
+  drmSystemOptions: DRMSystemOptions,
+): boolean {
+  return (
+    drmSystemOptions.sessionType === 'persistent-license' ||
+    !!drmSystemOptions.sessionTypes?.some(
+      (type) => type === 'persistent-license',
+    )
+  );
+}
+
 export function parsePlayReadyWRM(keyBytes: Uint8Array) {
   const keyBytesUtf16 = new Uint16Array(
     keyBytes.buffer,

tests/unit/controller/eme-controller.ts

@@ -691,10 +691,63 @@ describe('EMEController', function () {
       return;
     }
     return EMEController.CDMCleanupPromise.then(() => {
-      expect(keySessionRemoveSpy).callCount(1);
       expect(keySessionCloseSpy).callCount(1);
       expect(emeController.mediaKeySessions.length).to.equal(0);
       expect(media.setMediaKeys).calledWith(null);
     });
   });
+
+  it('should remove all media key sessions and remove all media key sessions when call destroy with persistent-license session type', function () {
+    const reqMediaKsAccessSpy = sinon.spy(function () {
+      return Promise.resolve({
+        // Media-keys mock
+        keySystem: 'com.apple.fps',
+        createMediaKeys: sinon.spy(() =>
+          Promise.resolve({
+            setServerCertificate: () => Promise.resolve(),
+            createSession: () => ({
+              addEventListener: () => {},
+              removeEventListener: () => {},
+              generateRequest: () => Promise.resolve(),
+              remove: () => Promise.resolve(),
+              update: () => Promise.resolve(),
+              keyStatuses: new Map(),
+            }),
+          }),
+        ),
+      });
+    });
+    const keySessionRemoveSpy = sinon.spy(() => Promise.resolve());
+    const keySessionCloseSpy = sinon.spy(() => Promise.resolve());
+
+    setupEach({
+      emeEnabled: true,
+      requestMediaKeySystemAccessFunc: reqMediaKsAccessSpy,
+      drmSystemOptions: {
+        sessionType: 'persistent-license',
+      },
+    });
+
+    emeController.onMediaAttached(Events.MEDIA_ATTACHED, {
+      media: media as any as HTMLMediaElement,
+    });
+    emeController.mediaKeySessions = [
+      {
+        mediaKeysSession: {
+          remove: keySessionRemoveSpy,
+          close: keySessionCloseSpy,
+        },
+      } as any,
+    ];
+    emeController.destroy();
+
+    expect(EMEController.CDMCleanupPromise).to.be.a('Promise');
+    if (!EMEController.CDMCleanupPromise) {
+      return;
+    }
+    return EMEController.CDMCleanupPromise.then(() => {
+      expect(keySessionCloseSpy).callCount(1);
+      expect(emeController.mediaKeySessions.length).to.equal(0);
+    });
+  });
 });