Refactor a lot

Author: ShiningTrapez

src/bigscreenplayer.js

@@ -645,8 +645,7 @@ function BigscreenPlayer() {
      * @function
      * @returns {Promise<void>}
      */
-    setAudioDescribedEnabled: (enabled) =>
-      enabled ? playerComponent.setAudioDescribedOn() : playerComponent.setAudioDescribedOff(),
+    setAudioDescribed: (enabled) => playerComponent.setAudioDescribed(enabled),
 
     /**
      *
@@ -767,14 +766,6 @@ function BigscreenPlayer() {
     getInitialPlaybackTime,
     getTimeShiftBufferDepthInMilliseconds,
     getPresentationTimeOffsetInMilliseconds,
-
-    /**
-     * @function
-     * @param {Array} sources - Array of new media sources
-     */
-    replaceMediaSources: (sources) => {
-      playerComponent && playerComponent.replaceMediaSources(sources)
-    },
   }
 }
 

src/bigscreenplayer.test.js

@@ -113,11 +113,9 @@ describe("Bigscreen Player", () => {
       tearDown: jest.fn(),
       setPlaybackRate: jest.fn(),
       getPlaybackRate: jest.fn(),
-      replaceMediaSources: jest.fn(),
       isAudioDescribedAvailable: jest.fn(),
       isAudioDescribedEnabled: jest.fn(),
-      setAudioDescribedOn: jest.fn(),
-      setAudioDescribedOff: jest.fn(),
+      setAudioDescribed: jest.fn(),
     }
 
     jest.spyOn(PlayerComponent, "getLiveSupport").mockReturnValue(LiveSupport.SEEKABLE)
@@ -1534,23 +1532,25 @@ describe("Bigscreen Player", () => {
     })
   })
 
-  describe("setAudioDescribedEnabled", () => {
-    it("should turn Audio Described on/off when a value is passed in", async () => {
+  describe("setAudioDescribed", () => {
+    it("should call through to PlayerComponent.setAudioDescribed", async () => {
       await asyncInitialiseBigscreenPlayer(createPlaybackElement(), bigscreenPlayerData)
-      bigscreenPlayer.setAudioDescribedEnabled(true)
+      bigscreenPlayer.setAudioDescribed(true)
 
-      expect(mockPlayerComponentInstance.setAudioDescribedOn).toHaveBeenCalledTimes(1)
-      expect(mockPlayerComponentInstance.setAudioDescribedOff).toHaveBeenCalledTimes(0)
+      expect(mockPlayerComponentInstance.setAudioDescribed).toHaveBeenCalledTimes(1)
+      expect(mockPlayerComponentInstance.setAudioDescribed).toHaveBeenCalledWith(true)
+      expect(mockPlayerComponentInstance.setAudioDescribed).not.toHaveBeenCalledWith(false)
 
-      bigscreenPlayer.setAudioDescribedEnabled(false)
+      bigscreenPlayer.setAudioDescribed(false)
 
-      expect(mockPlayerComponentInstance.setAudioDescribedOn).toHaveBeenCalledTimes(1)
-      expect(mockPlayerComponentInstance.setAudioDescribedOff).toHaveBeenCalledTimes(1)
+      expect(mockPlayerComponentInstance.setAudioDescribed).toHaveBeenCalledTimes(2)
+      expect(mockPlayerComponentInstance.setAudioDescribed).toHaveBeenCalledWith(true)
+      expect(mockPlayerComponentInstance.setAudioDescribed).toHaveBeenCalledWith(false)
     })
   })
 
   describe("isAudioDescribedEnabled", () => {
-    it("calls through to playercomponent enabled when called", async () => {
+    it("calls through to PlayerComponent.isAudioDescribedEnabled", async () => {
       await asyncInitialiseBigscreenPlayer(createPlaybackElement(), bigscreenPlayerData)
 
       bigscreenPlayer.isAudioDescribedEnabled()
@@ -1560,7 +1560,7 @@ describe("Bigscreen Player", () => {
   })
 
   describe("isAudioDescribedAvailable", () => {
-    it("calls through to playercomponent available when called", async () => {
+    it("calls through to PlayerComponent.isAudioDescribedAvailable", async () => {
       await asyncInitialiseBigscreenPlayer(createPlaybackElement(), bigscreenPlayerData)
 
       bigscreenPlayer.isAudioDescribedAvailable()
@@ -1670,15 +1670,4 @@ describe("Bigscreen Player", () => {
       expect(DebugTool.getDebugLogs).toHaveBeenCalledTimes(1)
     })
   })
-
-  describe("replaceMediaSources", () => {
-    it("should call through to player component", async () => {
-      await asyncInitialiseBigscreenPlayer(createPlaybackElement(), bigscreenPlayerData)
-
-      const sources = "https://newsource.com"
-      bigscreenPlayer.replaceMediaSources(sources)
-
-      expect(mockPlayerComponentInstance.replaceMediaSources).toHaveBeenCalledWith(sources)
-    })
-  })
 })

src/mediasources.test.ts

@@ -6,9 +6,6 @@ import SourceLoader from "./manifest/sourceloader"
 import { ManifestType } from "./models/manifesttypes"
 import { TransferFormat } from "./models/transferformats"
 import getError from "./testutils/geterror"
-import DebugTool from "./debugger/debugtool"
-
-jest.mock("./debugger/debugtool")
 
 jest.mock("./manifest/sourceloader", () => ({
   default: {
@@ -575,34 +572,6 @@ describe("Media Sources", () => {
 
       expect(mediaSources.currentSource()).toBe("http://source2.com")
     })
-
-    it("fails over correctly after sources have been replaced", async () => {
-      testMedia.urls = [
-        { url: "http://source1.com", cdn: "http://cdn1.com" },
-        { url: "http://source2.com", cdn: "http://cdn2.com" },
-      ]
-
-      testMedia.audioDescribed = [
-        { url: "http://audiodescribedsource1.com", cdn: "http://audiodescribedcdn1.com" },
-        { url: "http://audiodescribedsource2.com", cdn: "http://audiodescribedcdn2.com" },
-      ]
-
-      const mediaSources = MediaSources()
-      await mediaSources.init(testMedia)
-
-      await mediaSources.failover({
-        isBufferingTimeoutError: true,
-        code: PluginEnums.ERROR_CODES.BUFFERING_TIMEOUT,
-        message: PluginEnums.ERROR_MESSAGES.BUFFERING_TIMEOUT,
-        duration: 100,
-        currentTime: 94,
-      })
-
-      await mediaSources.replace(mediaSources.getAudioDescribedSources())
-      await mediaSources.replace(mediaSources.getMainSources())
-
-      expect(mediaSources.currentSource()).toBe("http://source2.com")
-    })
   })
 
   describe("Subtitle Sources", () => {
@@ -828,67 +797,4 @@ describe("Media Sources", () => {
       expect(mediaSources.availableSources()).toEqual([])
     })
   })
-
-  describe("replace", () => {
-    beforeEach(() => {
-      jest.clearAllMocks()
-    })
-
-    it("replaces the media sources", async () => {
-      const cdn = "http://replacedcdn.com"
-      const url = "http://replacedurl.com/"
-
-      const mediaSources = MediaSources()
-      await mediaSources.init(testMedia)
-
-      await mediaSources.replace([{ cdn, url }])
-
-      expect(mediaSources.currentSource()).toBe(url)
-    })
-
-    it("updates debug output after a replace", async () => {
-      const cdn = "http://replacedcdn.com"
-      const url = "http://replacedurl.com/"
-
-      const mediaSources = MediaSources()
-      await mediaSources.init(testMedia)
-
-      await mediaSources.replace([{ cdn, url }])
-
-      expect(DebugTool.dynamicMetric).toHaveBeenCalledWith("cdns-available", [cdn])
-      expect(DebugTool.dynamicMetric).toHaveBeenCalledWith("current-url", url)
-    })
-
-    it("does not refresh the manifest if not needed", async () => {
-      const cdn = "http://replacedcdn.com"
-      const url = "http://replacedurl.com/"
-
-      const mediaSources = MediaSources()
-      await mediaSources.init(testMedia)
-
-      await mediaSources.replace([{ cdn, url }])
-      expect(SourceLoader.load).toHaveBeenCalledTimes(1)
-    })
-
-    it("refreshes the manifest if needed", async () => {
-      const cdn = "http://replacedcdn.com"
-      const url = "http://replacedurl.com/"
-
-      jest.mocked(SourceLoader.load).mockResolvedValueOnce({
-        time: {
-          manifestType: ManifestType.DYNAMIC,
-          presentationTimeOffsetInMilliseconds: 1731406718000,
-          availabilityStartTimeInMilliseconds: 1731406718000,
-          timeShiftBufferDepthInMilliseconds: 0,
-        },
-        transferFormat: TransferFormat.HLS,
-      })
-
-      const mediaSources = MediaSources()
-      await mediaSources.init(testMedia)
-
-      await mediaSources.replace([{ cdn, url }])
-      expect(SourceLoader.load).toHaveBeenCalledTimes(2)
-    })
-  })
 })