@gcorevideo/player 2.24.0 → 2.24.1

package/lib/plugins/cmcd-config/CmcdConfig.js

@@ -1,5 +1,7 @@
-import { CorePlugin, Events, } from '@clappr/core';
-import { generateContentId, generateSessionId } from './utils';
+import { $, CorePlugin, Events } from '@clappr/core';
+// import { trace } from '@gcorevideo/utils'
+import { generateSessionId } from './utils';
+import { CLAPPR_VERSION } from '../../build.js';
 const CMCD_KEYS = [
     'br',
     'd',
@@ -20,6 +22,7 @@ const CMCD_KEYS = [
     'st',
     'v',
 ];
+// const T = 'plugins.cmcd'
 /**
  * A `PLUGIN` that configures CMCD for playback
  * @beta
@@ -36,56 +39,62 @@ export class CmcdConfig extends CorePlugin {
     get name() {
         return 'cmcd';
     }
+    get version() {
+        return '0.1.0';
+    }
+    get supportedVersion() {
+        return CLAPPR_VERSION;
+    }
     constructor(core) {
         super(core);
         this.sid = this.options.cmcd?.sessionId ?? generateSessionId();
+        this.cid = this.options.cmcd?.contentId ?? this.generateContentId();
     }
     /**
      * @inheritdocs
      */
     bindEvents() {
-        this.listenTo(this.core, Events.CORE_ACTIVE_CONTAINER_CHANGED, () => this.updateSettings());
+        this.listenTo(this.core, Events.CORE_CONTAINERS_CREATED, () => this.updateSettings(this.core.containers[0]));
     }
-    async getIds() {
+    exportIds() {
         return {
             sid: this.sid,
-            cid: await this.ensureContentId(),
+            cid: this.cid,
         };
     }
-    updateSettings() {
-        switch (this.core.activeContainer.playback.name) {
+    async updateSettings(container) {
+        switch (container.playback.name) {
             case 'dash':
-                this.updateDashjsSettings();
+                $.extend(true, container.playback.options, {
+                    dash: {
+                        cmcd: {
+                            enabled: true,
+                            enabledKeys: CMCD_KEYS,
+                            sid: this.sid,
+                            cid: this.cid,
+                        },
+                    },
+                });
                 break;
             case 'hls':
-                this.updateHlsjsSettings();
+                $.extend(true, container.playback.options, {
+                    playback: {
+                        hlsjsConfig: {
+                            cmcd: {
+                                includeKeys: CMCD_KEYS,
+                                sessionId: this.sid,
+                                contentId: this.cid,
+                            },
+                        },
+                    },
+                });
                 break;
         }
     }
-    async updateDashjsSettings() {
-        const { cid, sid } = await this.getIds();
-        const options = this.core.activePlayback.options;
-        this.core.activePlayback.options = {
-            ...options,
-            dash: {
-                ...(options.dash ?? {}),
-                cmcd: {
-                    enabled: true,
-                    enabledKeys: CMCD_KEYS,
-                    sid,
-                    cid,
-                },
-            },
-        };
-    }
-    async updateHlsjsSettings() {
-        const { cid, sid } = await this.getIds();
-        const options = this.core.activePlayback.options;
-        this.core.activePlayback.options = {
-            ...options,
+    updateHlsjsSettings(options, { cid, sid }) {
+        $.extend(true, options, {
             playback: {
                 hlsjsConfig: {
-                    ...(options.playback?.hlsjsConfig ?? {}),
                     cmcd: {
                         includeKeys: CMCD_KEYS,
                         sessionId: sid,
@@ -93,22 +102,9 @@ export class CmcdConfig extends CorePlugin {
                     },
                 },
             },
-        };
-    }
-    async ensureContentId() {
-        if (!this.cid) {
-            this.cid = await this.evalContentId();
-        }
-        return this.cid;
+        });
     }
-    async evalContentId() {
-        if (!this.core.activeContainer.options.cmcd?.contentId) {
-            return generateContentId(this.core.activePlayback.options.src);
-        }
-        const contentId = this.core.activeContainer.options.cmcd.contentId;
-        if (typeof contentId === 'string') {
-            return contentId;
-        }
-        return Promise.resolve(contentId(this.core.activePlayback.options.src));
+    generateContentId() {
+        return new URL(this.core.options.source ?? this.core.options.sources[0].source).pathname.slice(0, 64);
     }
 }

package/lib/plugins/cmcd-config/utils.d.ts

@@ -1,3 +1,2 @@
 export declare function generateSessionId(): string;
-export declare function generateContentId(sourceUrl: string): Promise<string>;
 //# sourceMappingURL=utils.d.ts.map

package/lib/plugins/cmcd-config/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/plugins/cmcd-config/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAQpE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/plugins/cmcd-config/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C"}

package/lib/plugins/cmcd-config/utils.js

@@ -1,12 +1,3 @@
 export function generateSessionId() {
     return window.crypto.randomUUID();
 }
-export function generateContentId(sourceUrl) {
-    return window.crypto.subtle.digest('SHA-1', new TextEncoder().encode(sourceUrl))
-        .then(buffer => {
-        const hex = Array.from(new Uint8Array(buffer))
-            .map(b => b.toString(16).padStart(2, '0'))
-            .join('');
-        return hex;
-    });
-}

package/lib/testUtils.d.ts

@@ -5,6 +5,7 @@ export declare function createMockCore(options?: Record<string, unknown>, contai
     $el: any;
     activePlayback: any;
     activeContainer: any;
+    containers: any[];
     i18n: {
         t: import("vitest").Mock<(...args: any[]) => any>;
     };

package/lib/testUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAK,YAAY,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,MAAM,MAAM,eAAe,CAAA;AAGlC,wBAAgB,cAAc,CAC5B,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACrC,SAAS,GAAE,GAAkC;;;;;;;;;;;;;;;;EAqB9C;AAED,wBAAgB,gBAAgB;;;EAK/B;AAED,wBAAgB,mBAAmB;;;;;;EAKlC;AAED,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoCtF;AAED,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACrC,QAAQ,GAAE,GAAgD;;;;;;;;;;;;;;;;;;;;;;;;EA6B3D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,GAAG,gBAiB/C;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,GAAG,OAe7C"}
+{"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAK,YAAY,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,MAAM,MAAM,eAAe,CAAA;AAGlC,wBAAgB,cAAc,CAC5B,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACrC,SAAS,GAAE,GAAkC;;;;;;;;;;;;;;;;;EAsB9C;AAED,wBAAgB,gBAAgB;;;EAK/B;AAED,wBAAgB,mBAAmB;;;;;;EAKlC;AAED,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoCtF;AAED,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACrC,QAAQ,GAAE,GAAgD;;;;;;;;;;;;;;;;;;;;;;;;EA6B3D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,GAAG,gBAiB/C;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,GAAG,OAe7C"}

package/lib/testUtils.js

@@ -9,6 +9,7 @@ export function createMockCore(options = {}, container = createMockContainer(opt
         $el: $(el),
         activePlayback: container.playback,
         activeContainer: container,
+        containers: [container],
         i18n: {
             t: vi.fn().mockImplementation((key) => key),
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gcorevideo/player",
-  "version": "2.24.0",
+  "version": "2.24.1",
   "description": "Gcore JavaScript video player",
   "main": "dist/index.js",
   "type": "module",

package/src/plugins/cmcd-config/CmcdConfig.ts

@@ -1,10 +1,10 @@
-import {
-  Core,
-  CorePlugin,
-  Events,
-} from '@clappr/core'
+import { $, Container, Core, CorePlugin, Events } from '@clappr/core'
 
-import { generateContentId, generateSessionId } from './utils'
+// import { trace } from '@gcorevideo/utils'
+
+import { generateSessionId } from './utils'
+import { CLAPPR_VERSION } from '../../build.js'
+import { CoreOptions } from 'src/internal.types'
 
 const CMCD_KEYS = [
   'br',
@@ -36,12 +36,14 @@ export type CmcdConfigPluginSettings = {
    */
   sessionId: string
   /**
-   * Content ID, either constant or derived from current source.
-   * If ommitted, a SHA-1 hash of current source URL will be used
+   * Content ID,
+   * If ommitted, the pathname part of the first source URL will be used
    */
-  contentId?: string | ((sourceUrl: string, mimeType?: string) => (string | Promise<string>))
+  contentId?: string
 }
 
+// const T = 'plugins.cmcd'
+
 /**
  * A `PLUGIN` that configures CMCD for playback
  * @beta
@@ -61,63 +63,73 @@ export class CmcdConfig extends CorePlugin {
     return 'cmcd'
   }
 
+  get version() {
+    return '0.1.0'
+  }
+
+  get supportedVersion() {
+    return CLAPPR_VERSION
+  }
+
   constructor(core: Core) {
     super(core)
     this.sid = this.options.cmcd?.sessionId ?? generateSessionId()
+    this.cid = this.options.cmcd?.contentId ?? this.generateContentId()
   }
 
   /**
    * @inheritdocs
    */
   override bindEvents() {
-    this.listenTo(this.core, Events.CORE_ACTIVE_CONTAINER_CHANGED, () =>
-      this.updateSettings(),
+    this.listenTo(this.core, Events.CORE_CONTAINERS_CREATED, () =>
+      this.updateSettings(this.core.containers[0]),
     )
   }
 
-  async getIds(): Promise<{ sid: string; cid: string }> {
+  exportIds(): { sid: string; cid: string } {
     return {
       sid: this.sid,
-      cid: await this.ensureContentId(),
+      cid: this.cid,
     }
   }
 
-  private updateSettings() {
-    switch (this.core.activeContainer.playback.name) {
+  private async updateSettings(container: Container) {
+    switch (container.playback.name) {
       case 'dash':
-        this.updateDashjsSettings()
+        $.extend(true, container.playback.options, {
+          dash: {
+            cmcd: {
+              enabled: true,
+              enabledKeys: CMCD_KEYS,
+              sid: this.sid,
+              cid: this.cid,
+            },
+          },
+        })
         break
       case 'hls':
-        this.updateHlsjsSettings()
+        $.extend(true, container.playback.options, {
+          playback: {
+            hlsjsConfig: {
+              cmcd: {
+                includeKeys: CMCD_KEYS,
+                sessionId: this.sid,
+                contentId: this.cid,
+              },
+            },
+          },
+        })
         break
     }
   }
 
-  private async updateDashjsSettings() {
-    const {cid, sid} = await this.getIds()
-    const options = this.core.activePlayback.options
-    this.core.activePlayback.options = {
-      ...options,
-      dash: {
-        ...(options.dash ?? {}),
-        cmcd: {
-          enabled: true,
-          enabledKeys: CMCD_KEYS,
-          sid,
-          cid,
-        },
-      },
-    }
-  }
-
-  private async updateHlsjsSettings() {
-    const { cid, sid } = await this.getIds()
-    const options = this.core.activePlayback.options
-    this.core.activePlayback.options = {
-      ...options,
+  private updateHlsjsSettings(
+    options: CoreOptions,
+    { cid, sid }: { cid: string; sid: string },
+  ) {
+    $.extend(true, options, {
       playback: {
         hlsjsConfig: {
-          ...(options.playback?.hlsjsConfig ?? {}),
           cmcd: {
             includeKeys: CMCD_KEYS,
             sessionId: sid,
@@ -125,24 +137,12 @@ export class CmcdConfig extends CorePlugin {
           },
         },
       },
-    }
+    })
   }
 
-  private async ensureContentId(): Promise<string> {
-    if (!this.cid) {
-      this.cid = await this.evalContentId()
-    }
-    return this.cid
-  }
-
-  private async evalContentId(): Promise<string> {
-    if (!this.core.activeContainer.options.cmcd?.contentId) {
-      return generateContentId(this.core.activePlayback.options.src)
-    }
-    const contentId = this.core.activeContainer.options.cmcd.contentId
-    if (typeof contentId === 'string') {
-      return contentId
-    }
-    return Promise.resolve(contentId(this.core.activePlayback.options.src))
+  private generateContentId() {
+    return new URL(
+      this.core.options.source ?? this.core.options.sources[0].source,
+    ).pathname.slice(0, 64)
   }
 }

package/src/plugins/cmcd-config/__tests__/CmcdConfig.test.ts

@@ -3,13 +3,9 @@ import { beforeEach, describe, expect, it, vi } from 'vitest'
 import { CmcdConfig } from '../CmcdConfig'
 import { createMockCore } from '../../../testUtils'
 import { Events } from '@clappr/core'
-import { generateContentId } from '../utils'
-
-import { createHash } from 'node:crypto'
 
 vi.mock('../utils', () => ({
   generateSessionId: vi.fn().mockReturnValue('123'),
-  generateContentId: vi.fn().mockResolvedValue('deadbeef'),
 }))
 
 const CMCD_KEYS = [
@@ -38,69 +34,78 @@ describe('CmcdConfig', () => {
   let plugin: CmcdConfig
   describe('basically', () => {
     beforeEach(() => {
-      core = createMockCore({})
+      core = createMockCore({
+        sources: [
+          {
+            source: 'https://zulu.com/123.mpd',
+            mimeType: 'application/dash+xml',
+          },
+        ],
+      })
     })
-    describe('when active container is changed', () => {
+    describe('when container is created', () => {
       describe('dash.js', () => {
         beforeEach(async () => {
-          core.activeContainer.playback.name = 'dash'
-          core.activeContainer.playback.options.src = 'https://123.mpd'
+          core.containers[0].playback.name = 'dash'
           plugin = new CmcdConfig(core)
-          core.trigger(Events.CORE_ACTIVE_CONTAINER_CHANGED)
-          await new Promise(resolve => setTimeout(resolve, 0))
+          core.trigger(Events.CORE_CONTAINERS_CREATED)
+          await new Promise((resolve) => setTimeout(resolve, 0))
         })
         it('should update DASH.js CMCD settings', () => {
-          expect(core.activePlayback.options).toEqual(expect.objectContaining({
-            dash: expect.objectContaining({
-              cmcd: expect.objectContaining({
-                enabled: true,
-                enabledKeys: CMCD_KEYS,
-              })
-            })
-          }))
+          expect(core.containers[0].playback.options).toEqual(
+            expect.objectContaining({
+              dash: expect.objectContaining({
+                cmcd: expect.objectContaining({
+                  enabled: true,
+                  enabledKeys: CMCD_KEYS,
+                }),
+              }),
+            }),
+          )
         })
         it('should generate unique session ID', () => {
-          expect(core.activePlayback.options).toEqual(expect.objectContaining({
-            dash: expect.objectContaining({
-              cmcd: expect.objectContaining({
-                sid: '123',
-              })
-            })
-          }))
+          expect(core.containers[0].playback.options).toEqual(
+            expect.objectContaining({
+              dash: expect.objectContaining({
+                cmcd: expect.objectContaining({
+                  sid: '123',
+                }),
+              }),
+            }),
+          )
         })
         it('should compute content ID from source URL', () => {
-          expect(generateContentId).toHaveBeenCalledWith('https://123.mpd')
-          expect(core.activePlayback.options).toEqual(expect.objectContaining({
-            dash: expect.objectContaining({
-              cmcd: expect.objectContaining({
-                cid: 'deadbeef',
-              })
-            })
-          }))
+          expect(core.containers[0].playback.options).toEqual(
+            expect.objectContaining({
+              dash: expect.objectContaining({
+                cmcd: expect.objectContaining({
+                  cid: '/123.mpd',
+                }),
+              }),
+            }),
+          )
         })
       })
       describe('hls.js', () => {
         beforeEach(async () => {
-          core.activeContainer.playback.name = 'hls'
-          core.activeContainer.playback.options.src = 'https://123.m3u8'
+          core.containers[0].playback.name = 'hls'
           plugin = new CmcdConfig(core)
-          await new Promise(resolve => setTimeout(resolve, 0))
-          core.trigger(Events.CORE_ACTIVE_CONTAINER_CHANGED)
-          await new Promise(resolve => setTimeout(resolve, 0))
+          core.trigger(Events.CORE_CONTAINERS_CREATED)
         })
         it('should update HLS.js CMCD settings', () => {
-          expect(core.activePlayback.options).toEqual(expect.objectContaining({
-            playback: expect.objectContaining({
-              hlsjsConfig: expect.objectContaining({
-                cmcd: expect.objectContaining({
-                  includeKeys: CMCD_KEYS,
-                  contentId: 'deadbeef',
-                  sessionId: '123',
-                })
-              })
-            })
-          }))
-          expect(generateContentId).toHaveBeenCalledWith('https://123.m3u8')
+          expect(core.containers[0].playback.options).toEqual(
+            expect.objectContaining({
+              playback: expect.objectContaining({
+                hlsjsConfig: expect.objectContaining({
+                  cmcd: expect.objectContaining({
+                    includeKeys: CMCD_KEYS,
+                    contentId: '/123.mpd',
+                    sessionId: '123',
+                  }),
+                }),
+              }),
+            }),
+          )
         })
       })
     })
@@ -109,54 +114,61 @@ describe('CmcdConfig', () => {
     beforeEach(async () => {
       core = createMockCore({
         cmcd: {
-          contentId: (src: string) => new Promise(resolve => {
-            const h = createHash('sha256')
-            h.on('readable', () => {
-              const data = h.read()
-              if (data) {
-                resolve(data.toString('hex'))
-              }
-            })
-            h.update(Buffer.from('1$' + src))
-            h.end()
-          }),
-        }
+          contentId:
+            'e287ea99b57c09b7a185aaaf36e075f2c0b346ce90aeced72976b1732678a8c6',
+        },
+        sources: [
+          {
+            source: 'https://zulu.com/123.mpd',
+            mimeType: 'application/dash+xml',
+          },
+        ],
       })
-      core.activePlayback.name = 'dash'
-      core.activePlayback.options.src = 'https://123.mpd'
+      core.containers[0].playback.name = 'dash'
+      core.containers[0].playback.options.src = 'https://123.mpd'
       plugin = new CmcdConfig(core)
-      core.trigger(Events.CORE_ACTIVE_CONTAINER_CHANGED)
-      await new Promise(resolve => setTimeout(resolve, 0))
+      core.trigger(Events.CORE_CONTAINERS_CREATED)
+      await new Promise((resolve) => setTimeout(resolve, 0))
     })
     it('should use custom content ID', () => {
-      expect(core.activePlayback.options).toEqual(expect.objectContaining({
-        dash: expect.objectContaining({
-          cmcd: expect.objectContaining({
-            cid: 'e287ea99b57c09b7a185aaaf36e075f2c0b346ce90aeced72976b1732678a8c6',
-          })
-        })
-      }))
+      expect(core.containers[0].playback.options).toEqual(
+        expect.objectContaining({
+          dash: expect.objectContaining({
+            cmcd: expect.objectContaining({
+              cid: 'e287ea99b57c09b7a185aaaf36e075f2c0b346ce90aeced72976b1732678a8c6',
+            }),
+          }),
+        }),
+      )
     })
   })
   describe('custom session ID', () => {
     beforeEach(async () => {
       core = createMockCore({
         cmcd: { sessionId: '456' },
+        sources: [
+          {
+            source: 'https://zulu.com/123.mpd',
+            mimeType: 'application/dash+xml',
+          },
+        ],
       })
-      core.activePlayback.name = 'dash'
-      core.activePlayback.options.src = 'https://123.mpd'
+      core.containers[0].playback.name = 'dash'
+      core.containers[0].playback.options.src = 'https://123.mpd'
       plugin = new CmcdConfig(core)
-      core.trigger(Events.CORE_ACTIVE_CONTAINER_CHANGED)
-      await new Promise(resolve => setTimeout(resolve, 0))
+      core.trigger(Events.CORE_CONTAINERS_CREATED)
+      await new Promise((resolve) => setTimeout(resolve, 0))
     })
     it('should use custom session ID', () => {
-      expect(core.activePlayback.options).toEqual(expect.objectContaining({
-        dash: expect.objectContaining({
-          cmcd: expect.objectContaining({
-            sid: '456',
-          })
-        })
-      }))
+      expect(core.containers[0].playback.options).toEqual(
+        expect.objectContaining({
+          dash: expect.objectContaining({
+            cmcd: expect.objectContaining({
+              sid: '456',
+            }),
+          }),
+        }),
+      )
     })
   })
 })

package/src/plugins/cmcd-config/utils.ts

@@ -1,13 +1,3 @@
 export function generateSessionId(): string {
   return window.crypto.randomUUID()
 }
-
-export function generateContentId(sourceUrl: string): Promise<string> {
-  return window.crypto.subtle.digest('SHA-1', new TextEncoder().encode(sourceUrl))
-    .then(buffer => {
-      const hex = Array.from(new Uint8Array(buffer))
-        .map(b => b.toString(16).padStart(2, '0'))
-        .join('')
-      return hex
-    })
-}

package/src/testUtils.ts

@@ -13,6 +13,7 @@ export function createMockCore(
     $el: $(el),
     activePlayback: container.playback,
     activeContainer: container,
+    containers: [container],
     i18n: {
       t: vi.fn().mockImplementation((key: string) => key),
     },