@gcorevideo/player 2.28.35 → 2.28.36

package/src/plugins/subtitles/__tests__/ClosedCaptions.test.ts

@@ -16,6 +16,7 @@ describe('ClosedCaptions', () => {
   let mediaControl: any
   let cc: ClosedCaptions
   beforeEach(() => {
+    vi.useFakeTimers()
     core = createMockCore()
     mediaControl = createMockMediaControl(core)
     mediaControl.getAvailablePopupHeight = vi.fn().mockReturnValue(211)
@@ -27,8 +28,12 @@ describe('ClosedCaptions', () => {
     })
     cc = new ClosedCaptions(core)
   })
+  afterEach(() => {
+    vi.useRealTimers()
+  })
   describe('basically', () => {
     beforeEach(() => {
+      core.options.cc = { language: 'none' }
       core.emit(Events.CORE_READY)
       core.activePlayback.el = document.createElement('video')
       core.emit(Events.CORE_ACTIVE_CONTAINER_CHANGED, core.activeContainer)
@@ -53,6 +58,7 @@ describe('ClosedCaptions', () => {
     describe("when subtitle tracks are available", () => {
       beforeEach(() => {
         emitSubtitleAvailable(core)
+        vi.advanceTimersByTime(1)
       })
       it('should render', () => {
         expect(cc.el.innerHTML).toMatchSnapshot()
@@ -64,7 +70,6 @@ describe('ClosedCaptions', () => {
             width: 320,
             height: 260,
           })
-          // core.emit(Events.CORE_RESIZE, { width: 320, height: 260 })
         })
         it('should clamp popup height', () => {
           expect(cc.$el.find('#gplayer-cc-menu').css('max-height')).toBe('197px')
@@ -131,9 +136,9 @@ describe('ClosedCaptions', () => {
         })
       })
       describe('when subtitle is changed', () => {
-        beforeEach(async () => {
+        beforeEach(() => {
           cc.$el.find('#gplayer-cc-button').click()
-          await new Promise((resolve) => setTimeout(resolve, 100))
+          vi.advanceTimersByTime(100)
           core.activePlayback.getCurrentTime = vi.fn().mockReturnValue(7)
           core.activeContainer.getCurrentTime = vi.fn().mockReturnValue(7)
           core.activePlayback.closedCaptionsTracks[1].track.cues = [
@@ -169,10 +174,10 @@ describe('ClosedCaptions', () => {
             },
           ]
           cc.$el.find('#gplayer-cc-menu li:nth-child(2) a').click()
-          await new Promise((resolve) => setTimeout(resolve, 100))
+          vi.advanceTimersByTime(100)
           // TODO test explicitly that PLAYBACK_SUBTITLE_CHANGED event does not cause track switch
           core.activePlayback.emit(Events.PLAYBACK_SUBTITLE_CHANGED, { id: 2 })
-          await new Promise((resolve) => setTimeout(resolve, 100))
+          vi.advanceTimersByTime(100)
         })
         it('should activate selected track', () => {
           expect(core.activePlayback.closedCaptionsTracks[1].track.mode).toBe(
@@ -193,7 +198,8 @@ describe('ClosedCaptions', () => {
           cc.$el.find('#gplayer-cc-menu li:nth-child(2) a').click()
         })
         it('should activate native subtitles track', () => {
-          expect(core.activePlayback.closedCaptionsTrackId).toEqual(2)
+          expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(1)
+          expect(core.activePlayback.closedCaptionsTrackId).toEqual(1)
         })
         it('should highlight selected menu item', () => {
           expect(
@@ -257,7 +263,6 @@ describe('ClosedCaptions', () => {
     describe('when language is configured', () => {
       describe("and is set to 'none'", () => {
         beforeEach(() => {
-          vi.useFakeTimers()
           core.options.cc = { language: 'none' }
           emitSubtitleAvailable(core)
           vi.advanceTimersByTime(1)
@@ -281,47 +286,37 @@ describe('ClosedCaptions', () => {
         })
       })
       describe('when language is undefined', () => {
-        // let spyClosedCaptionsTrackId: any // TODO
         beforeEach(() => {
-          // spyClosedCaptionsTrackId = vi.spyOn(core.activePlayback, 'closedCaptionsTrackId')
           core.options.cc = {}
           core.activePlayback.closedCaptionsTrackId = undefined
           emitSubtitleAvailable(core, 1)
+          vi.advanceTimersByTime(1)
         })
         // The native engine will decide
         it('should not automatically select any track', () => {
           expect(core.activePlayback.closedCaptionsTrackId).toEqual(undefined)
+          expect(core.activePlayback.setTextTrack).not.toHaveBeenCalled()
         })
-        it('should not activate any tracks', () => {
-          expect(core.activePlayback.closedCaptionsTracks[0].track.mode).toBe(
-            'hidden', // showing is reset to hidden since the plugin manages rendition
-          )
-          expect(core.activePlayback.closedCaptionsTracks[1].track.mode).toBe(
-            'hidden',
-          )
+        it('should not touch any tracks', () => {
+          expect(core.activePlayback.el.textTracks[0].mode).toBe('hidden')
+          // Track #1 is set active (as if selected by the engine), @see {emitSubtitleAvailable}()
+          expect(core.activePlayback.el.textTracks[1].mode).toBe('showing')
         })
       })
       describe('when language matches a track', () => {
         beforeEach(() => {
-          vi.useFakeTimers()
           core.options.cc = { language: 'en' }
           emitSubtitleAvailable(core)
           vi.advanceTimersByTime(1)
         })
-        // afterEach(() => {
-        //   vi.useRealTimers()
-        // })
         it('should activate the matching track', () => {
-          expect(core.activePlayback.closedCaptionsTrackId).toEqual(1)
+          expect(core.activePlayback.closedCaptionsTrackId).toEqual(0)
+          expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(0)
         })
+        // TODO with options.cc.mode='native' the selected track's mode should be 'showing'
         it('should set the matching track mode appropriately', () => {
-          // The matching track should be activated
-          expect(core.activePlayback.closedCaptionsTracks[0].track.mode).toBe(
-            'hidden',
-          )
-          expect(core.activePlayback.closedCaptionsTracks[1].track.mode).toBe(
-            'disabled',
-          )
+          expect(core.activePlayback.el.textTracks[0].mode).toBe('hidden')
+          expect(core.activePlayback.el.textTracks[1].mode).toBe('disabled')
         })
         it('should highlight the matching track in menu', () => {
           expect(
@@ -331,18 +326,13 @@ describe('ClosedCaptions', () => {
       })
       describe('when language does not match any track', () => {
         beforeEach(() => {
-          vi.useFakeTimers()
           core.options.cc = { language: 'fr' }
-          cc = new ClosedCaptions(core)
           core.emit(Events.CORE_READY)
           core.activePlayback.el = document.createElement('video')
           core.emit(Events.CORE_ACTIVE_CONTAINER_CHANGED, core.activeContainer)
           emitSubtitleAvailable(core)
           vi.advanceTimersByTime(1)
         })
-        afterEach(() => {
-          vi.useRealTimers()
-        })
         it('should disable subtitles', () => {
           expect(core.activePlayback.closedCaptionsTrackId).toEqual(-1)
         })
@@ -364,7 +354,6 @@ describe('ClosedCaptions', () => {
     describe('when subtitle available event occurs after user selection', () => {
       describe('if user selected track before event', () => {
         beforeEach(() => {
-          vi.useFakeTimers()
           core.options.cc = { language: 'en' }
           // First subtitle available event
           emitSubtitleAvailable(core)
@@ -382,12 +371,10 @@ describe('ClosedCaptions', () => {
           emitSubtitleAvailable(core)
           vi.advanceTimersByTime(1)
         })
-        afterEach(() => {
-          vi.useRealTimers()
-        })
         it('should run preselected language matching algorithm', () => {
           // Should activate track selected by user
-          expect(core.activePlayback.closedCaptionsTrackId).toEqual(2)
+          expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(1)
+          expect(core.activePlayback.closedCaptionsTrackId).toEqual(1)
         })
         it('should select track based on configured language', () => {
           expect(
@@ -406,18 +393,10 @@ describe('ClosedCaptions', () => {
       })
       describe('when multiple subtitle available events occur', () => {
         beforeEach(() => {
-          vi.useFakeTimers()
           core.options.cc = { language: 'en' }
-          // cc = new ClosedCaptions(core)
-          // core.emit(Events.CORE_READY)
-          // core.activePlayback.el = document.createElement('video')
-          // core.emit(Events.CORE_ACTIVE_CONTAINER_CHANGED, core.activeContainer)
           // First subtitle available event
           emitSubtitleAvailable(core)
           vi.advanceTimersByTime(1)
-          // User changes selection
-          // cc.$el.find('#gplayer-cc-menu li:nth-child(2) a').click()
-          // Container changed (simulating source switch)
           core.emit(Events.CORE_ACTIVE_CONTAINER_CHANGED, core.activeContainer)
           vi.advanceTimersByTime(1)
           core.activePlayback.closedCaptionsTrackId = undefined
@@ -425,68 +404,59 @@ describe('ClosedCaptions', () => {
           emitSubtitleAvailable(core)
           vi.advanceTimersByTime(1)
         })
-        afterEach(() => {
-          vi.useRealTimers()
-        })
-        it('should reapply preselected language matching', () => {
-          expect(core.activePlayback.closedCaptionsTrackId).toEqual(1)
-          // Should select English track based on configured language
+        it('should reapply preselected language matching and activate the matching track', () => {
+          expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(0)
+          expect(core.activePlayback.closedCaptionsTrackId).toEqual(0)
           expect(
             cc.$el.find('#gplayer-cc-menu li:nth-child(1)').hasClass('current'),
           ).toBe(true)
         })
         it('should activate the matching track', () => {
-          expect(core.activePlayback.closedCaptionsTracks[0].track.mode).toBe(
+          expect(core.activePlayback.el.textTracks[0].mode).toBe(
             'hidden',
           )
-          expect(core.activePlayback.closedCaptionsTracks[1].track.mode).toBe(
+          expect(core.activePlayback.el.textTracks[1].mode).toBe(
             'disabled',
           )
         })
       })
     })
-    describe.each(['dash', 'hls'] as const)(
+    describe.each([['html5_video', false], ['dash', false], ['hls', true]] as const)(
       'when playback engine is %s',
-      (playbackEngine) => {
+      (playbackEngine, isManaged) => {
         beforeEach(() => {
-          // core.emit(Events.CORE_READY)
           core.activePlayback.el = document.createElement('video')
           core.activePlayback.name = playbackEngine
-          core.activePlayback.setTextTrack = vi.fn()
-          // core.emit(Events.CORE_ACTIVE_CONTAINER_CHANGED, core.activeContainer)
         })
         describe('when language is configured and matches a track', () => {
           beforeEach(() => {
-            vi.useFakeTimers()
             core.options.cc = { language: 'en' }
-            // cc = new ClosedCaptions(core)
-            // core.emit(Events.CORE_READY)
-            // core.activePlayback.el = document.createElement('video')
-            // core.activePlayback.name = playbackEngine
-            // core.activePlayback.setTextTrack = vi.fn()
-            // core.emit(Events.CORE_ACTIVE_CONTAINER_CHANGED, core.activeContainer)
             emitSubtitleAvailable(core)
             vi.advanceTimersByTime(1)
           })
-          afterEach(() => {
-            vi.useRealTimers()
-          })
           it('should call setTextTrack with matching track id', () => {
-            expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(1)
+            expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(0)
           })
           it('should set closedCaptionsTrackId to matching track id', () => {
-            expect(core.activePlayback.closedCaptionsTrackId).toEqual(1)
-          })
-          it('should not touch native tracks', () => {
-            expect(core.activePlayback.closedCaptionsTracks[0].track.mode).toBe('hidden')
-            expect(core.activePlayback.closedCaptionsTracks[1].track.mode).toBe('hidden')
+            expect(core.activePlayback.closedCaptionsTrackId).toEqual(0)
           })
+          if (isManaged) {
+            it('should not touch native tracks', () => {
+              expect(core.activePlayback.el.textTracks[0].mode).toBe('hidden')
+              expect(core.activePlayback.el.textTracks[1].mode).toBe('hidden')
+            })
+          } else {
+            it('should disable inactive native track', () => {
+              expect(core.activePlayback.el.textTracks[1].mode).toBe('disabled')
+            })
+            it('should keep active native track hidden', () => {
+              expect(core.activePlayback.el.textTracks[0].mode).toBe('hidden')
+            })
+          }
         })
         describe('when language is configured but does not match any track', () => {
           beforeEach(() => {
-            vi.useFakeTimers()
             core.options.cc = { language: 'fr' }
-            cc = new ClosedCaptions(core)
             core.emit(Events.CORE_READY)
             core.activePlayback.el = document.createElement('video')
             core.activePlayback.name = playbackEngine
@@ -495,9 +465,6 @@ describe('ClosedCaptions', () => {
             emitSubtitleAvailable(core)
             vi.advanceTimersByTime(1)
           })
-          afterEach(() => {
-            vi.useRealTimers()
-          })
           it('should disable subtitles', () => {
             expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(-1)
             expect(core.activePlayback.closedCaptionsTrackId).toEqual(-1)
@@ -507,22 +474,20 @@ describe('ClosedCaptions', () => {
           beforeEach(() => {
             core.activePlayback.setTextTrack = vi.fn()
             emitSubtitleAvailable(core)
+            vi.advanceTimersByTime(1)
             cc.$el.find('#gplayer-cc-menu li:nth-child(2) a').click()
+            vi.advanceTimersByTime(1)
           })
           it('should call setTextTrack with selected track id', () => {
-            // TODO: Implement assertion
-            // expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(2)
+            expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(1)
           })
           it('should update closedCaptionsTrackId', () => {
-            // TODO: Implement assertion
-            // expect(core.activePlayback.closedCaptionsTrackId).toEqual(2)
+            expect(core.activePlayback.closedCaptionsTrackId).toEqual(1)
           })
         })
         describe('when language is set to none', () => {
           beforeEach(() => {
-            vi.useFakeTimers()
             core.options.cc = { language: 'none' }
-            cc = new ClosedCaptions(core)
             core.emit(Events.CORE_READY)
             core.activePlayback.el = document.createElement('video')
             core.activePlayback.name = playbackEngine
@@ -531,12 +496,8 @@ describe('ClosedCaptions', () => {
             emitSubtitleAvailable(core)
             vi.advanceTimersByTime(1)
           })
-          afterEach(() => {
-            vi.useRealTimers()
-          })
-          it('should call setTextTrack with -1 to disable subtitles', () => {
-            // TODO: Implement assertion
-            // expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(-1)
+          it('should disable subtitles', () => {
+            expect(core.activePlayback.setTextTrack).toHaveBeenCalledWith(-1)
           })
         })
       },
@@ -545,30 +506,30 @@ describe('ClosedCaptions', () => {
 })
 
 function emitSubtitleAvailable(core: any, selectedTrackId?: number) {
-  core.activePlayback.closedCaptionsTracks = [
+  const domTracks = [
     {
-      id: 1,
-      name: 'English',
-      track: {
-        language: 'en',
-        kind: 'subtitles',
-        label: 'English',
-        mode: selectedTrackId === 1 ? 'showing' : 'hidden',
-        cues: [],
-      },
+      language: 'en',
+      kind: 'subtitles',
+      label: 'English',
+      mode: selectedTrackId === 0 ? 'showing' : 'hidden',
+      cues: [],
+      id: "01en"
     },
     {
-      id: 2,
-      name: 'Spanish',
-      track: {
-        language: 'es',
-        kind: 'subtitles',
-        label: 'Español',
-        mode: selectedTrackId === 2 ? 'showing' : 'hidden',
-        cues: [],
-      },
-    },
+      language: 'es',
+      kind: 'subtitles',
+      label: 'Español',
+      mode: selectedTrackId === 1 ? 'showing' : 'hidden',
+      cues: [],
+      id: "02es"
+    }
   ]
+  core.activePlayback.closedCaptionsTracks = domTracks.map((t, index) => ({
+    id: index,
+    name: t.label,
+    track: t,
+  }))
+  vi.spyOn(core.activePlayback.el, 'textTracks', 'get').mockReturnValue(domTracks)
   core.activePlayback.emit(Events.PLAYBACK_SUBTITLE_AVAILABLE)
   core.activeContainer.emit(Events.CONTAINER_SUBTITLE_AVAILABLE)
 }

package/src/plugins/subtitles/__tests__/__snapshots__/ClosedCaptions.test.ts.snap

@@ -6,14 +6,14 @@ exports[`ClosedCaptions > basically > when subtitle tracks are available > shoul
 <ul class="gcore-skin-bg-color media-control-dd__popup" id="gplayer-cc-menu" role="menu" style="display: none; max-height: 211px;">
     
         <li class="">
-            <a href="#" class="gcore-skin-text-color" data-item="1" role="menuitemradio" aria-checked="false">
+            <a href="#" class="gcore-skin-text-color" data-item="0" role="menuitemradio" aria-checked="false">
                 English
             </a>
         </li>
     
         <li class="">
-            <a href="#" class="gcore-skin-text-color" data-item="2" role="menuitemradio" aria-checked="false">
-                Spanish
+            <a href="#" class="gcore-skin-text-color" data-item="1" role="menuitemradio" aria-checked="false">
+                Español
             </a>
         </li>
     

package/src/testUtils.ts

@@ -81,6 +81,7 @@ export function createMockPlayback(
     canAutoPlay: vi.fn().mockImplementation(() => true),
     onResize: vi.fn().mockImplementation(() => true),
     setPlaybackRate: vi.fn(),
+    setTextTrack: vi.fn(),
     switchAudioTrack: vi.fn(),
     trigger: emitter.emit,
   })
@@ -139,6 +140,8 @@ export function createMockMediaControl(core: any) {
   // @ts-ignore
   mediaControl.getAvailablePopupHeight = vi.fn().mockReturnValue(286)
   // @ts-ignore
+  mediaControl.isVisible = vi.fn().mockReturnValue(true)
+  // @ts-ignore
   mediaControl.toggleElement = vi.fn()
   // @ts-ignore
   mediaControl.setKeepVisible = vi.fn()