@applicaster/quick-brick-player 16.0.0-rc.10 → 16.0.0-rc.101

package/src/Player/AudioLayer/__tests__/usePlaylistNavigation.test.ts

@@ -0,0 +1,539 @@
+import { renderHook, act } from "@testing-library/react-native";
+import { useNavigation } from "@applicaster/zapp-react-native-utils/reactHooks";
+import { usePlayer } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/usePlayer";
+import { loadFeedEntry } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/OverlayObserver/utils";
+import { RemoteCommand } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/const";
+
+import {
+  getTransportControls,
+  usePlaylistNavigation,
+} from "../usePlaylistNavigation";
+
+jest.mock("@applicaster/zapp-react-native-utils/reactHooks", () => ({
+  useNavigation: jest.fn(),
+}));
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/appUtils/playerManager/usePlayer",
+  () => ({ usePlayer: jest.fn() })
+);
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/appUtils/playerManager/OverlayObserver/utils",
+  () => ({
+    loadFeedEntry: jest.fn(),
+    retrieveFeedUrl: async (entry) => entry?.extensions?.play_next_feed_url,
+    retrievePlayPreviousFeedUrl: (entry) =>
+      entry?.extensions?.play_previous_feed_url,
+  })
+);
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/appUtils/playerManager/playerNativeCommand",
+  () => ({
+    PlayerNativeCommandTypes: { setPlayerControls: "setPlayerControls" },
+  })
+);
+
+const useNavigationMock = useNavigation as jest.Mock;
+const loadFeedEntryMock = loadFeedEntry as jest.Mock;
+const usePlayerMock = usePlayer as jest.Mock;
+
+const NEXT_URL = "https://feeds/next.json";
+const PREV_URL = "https://feeds/prev.json";
+
+const entryWith = (extensions: Record<string, unknown>): ZappEntry =>
+  ({ id: "current", type: { value: "audio" }, extensions }) as ZappEntry;
+
+/** Seekable VOD by default; pass 0 for a live stream with no seek window. */
+const stateAt = (
+  currentTime: number,
+  seekableDuration = 600
+): QuickBrickPlayer.PlayerState =>
+  ({ currentTime, seekableDuration }) as QuickBrickPlayer.PlayerState;
+
+const NOT_SEEKABLE = 0;
+
+const renderPlaylistNavigation = async (
+  entry: ZappEntry,
+  playerState: QuickBrickPlayer.PlayerState
+) => {
+  const rendered = renderHook(() => usePlaylistNavigation(entry, playerState));
+
+  await act(async () => {});
+
+  return rendered;
+};
+
+describe("usePlaylistNavigation", () => {
+  let replaceTop: jest.Mock;
+  let seekTo: jest.Mock;
+
+  beforeEach(() => {
+    replaceTop = jest.fn();
+    seekTo = jest.fn();
+
+    useNavigationMock.mockReturnValue({ replaceTop });
+
+    usePlayerMock.mockReturnValue({ seekTo });
+
+    loadFeedEntryMock.mockReset();
+  });
+
+  describe("availability", () => {
+    it("reports both directions when both extensions are present", async () => {
+      const entry = entryWith({
+        play_next_feed_url: NEXT_URL,
+        play_previous_feed_url: PREV_URL,
+      });
+
+      const { result } = await renderPlaylistNavigation(entry, stateAt(0));
+
+      expect(result.current.hasNext).toBe(true);
+      expect(result.current.hasPrevious).toBe(true);
+    });
+
+    it("keeps previous available at the head of a chain when the track is seekable", async () => {
+      const entry = entryWith({ play_next_feed_url: NEXT_URL });
+
+      const { result } = await renderPlaylistNavigation(entry, stateAt(0));
+
+      expect(result.current.hasNext).toBe(true);
+      expect(result.current.hasPrevious).toBe(true);
+    });
+
+    it("reports no previous only when the track cannot seek either", async () => {
+      const entry = entryWith({ play_next_feed_url: NEXT_URL });
+
+      const { result } = await renderPlaylistNavigation(
+        entry,
+        stateAt(0, NOT_SEEKABLE)
+      );
+
+      expect(result.current.hasNext).toBe(true);
+      expect(result.current.hasPrevious).toBe(false);
+    });
+
+    it("reports neither direction for a non-seekable entry with no extensions", async () => {
+      const { result } = await renderPlaylistNavigation(
+        entryWith({}),
+        stateAt(0, NOT_SEEKABLE)
+      );
+
+      expect(result.current.hasNext).toBe(false);
+      expect(result.current.hasPrevious).toBe(false);
+    });
+  });
+
+  describe("goNext", () => {
+    it("plays the entry resolved from the next feed url", async () => {
+      const target = { id: "next" } as ZappEntry;
+      loadFeedEntryMock.mockResolvedValue(target);
+      const entry = entryWith({ play_next_feed_url: NEXT_URL });
+
+      const { result } = await renderPlaylistNavigation(entry, stateAt(0));
+
+      await act(async () => result.current.goNext());
+
+      expect(loadFeedEntryMock).toHaveBeenCalledWith(NEXT_URL, entry);
+      expect(replaceTop).toHaveBeenCalledWith(target);
+    });
+
+    it("does nothing when there is no next url", async () => {
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(entryWith({}), stateAt(0))
+      );
+
+      await act(async () => result.current.goNext());
+
+      expect(loadFeedEntryMock).not.toHaveBeenCalled();
+      expect(replaceTop).not.toHaveBeenCalled();
+    });
+
+    it("leaves playback untouched when the feed fails to load", async () => {
+      loadFeedEntryMock.mockRejectedValue(new Error("network down"));
+      const entry = entryWith({ play_next_feed_url: NEXT_URL });
+
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(entry, stateAt(0))
+      );
+
+      await act(async () => result.current.goNext());
+
+      expect(replaceTop).not.toHaveBeenCalled();
+    });
+  });
+
+  describe("goPrevious", () => {
+    it("restarts the current track when past the threshold", async () => {
+      const entry = entryWith({ play_previous_feed_url: PREV_URL });
+
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(entry, stateAt(10))
+      );
+
+      await act(async () => result.current.goPrevious());
+
+      expect(seekTo).toHaveBeenCalledWith(0);
+      expect(replaceTop).not.toHaveBeenCalled();
+    });
+
+    it("plays the previous entry when before the threshold", async () => {
+      const target = { id: "prev" } as ZappEntry;
+      loadFeedEntryMock.mockResolvedValue(target);
+      const entry = entryWith({ play_previous_feed_url: PREV_URL });
+
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(entry, stateAt(1))
+      );
+
+      await act(async () => result.current.goPrevious());
+
+      expect(seekTo).not.toHaveBeenCalled();
+      expect(replaceTop).toHaveBeenCalledWith(target);
+    });
+
+    it("restarts the track when there is no previous entry to move to", async () => {
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(
+          entryWith({ play_next_feed_url: NEXT_URL }),
+          stateAt(390)
+        )
+      );
+
+      await act(async () => result.current.goPrevious());
+
+      expect(seekTo).toHaveBeenCalledWith(0);
+      expect(replaceTop).not.toHaveBeenCalled();
+    });
+
+    it("restarts even before the threshold when there is no previous entry", async () => {
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(entryWith({}), stateAt(1))
+      );
+
+      await act(async () => result.current.goPrevious());
+
+      expect(seekTo).toHaveBeenCalledWith(0);
+      expect(replaceTop).not.toHaveBeenCalled();
+    });
+
+    // usePlayer, not playerManager.getActivePlayer — the latter is always the
+    // local player, so restarting would be lost while casting.
+    it("restarts through the player that owns playback, not the local one", async () => {
+      const receiverSeekTo = jest.fn();
+      usePlayerMock.mockReturnValue({ seekTo: receiverSeekTo });
+
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(
+          entryWith({ play_previous_feed_url: PREV_URL }),
+          stateAt(10)
+        )
+      );
+
+      await act(async () => result.current.goPrevious());
+
+      expect(receiverSeekTo).toHaveBeenCalledWith(0);
+    });
+
+    it("does nothing when there is neither a previous entry nor a seek window", async () => {
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(entryWith({}), stateAt(10, NOT_SEEKABLE))
+      );
+
+      await act(async () => result.current.goPrevious());
+
+      expect(seekTo).not.toHaveBeenCalled();
+      expect(replaceTop).not.toHaveBeenCalled();
+    });
+
+    it("navigates to the previous entry past the threshold when the stream cannot seek", async () => {
+      const target = { id: "prev" } as ZappEntry;
+      loadFeedEntryMock.mockResolvedValue(target);
+
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(
+          entryWith({ play_previous_feed_url: PREV_URL }),
+          stateAt(10, NOT_SEEKABLE)
+        )
+      );
+
+      await act(async () => result.current.goPrevious());
+
+      expect(seekTo).not.toHaveBeenCalled();
+      expect(replaceTop).toHaveBeenCalledWith(target);
+    });
+
+    it("restarts past the threshold when the stream is seekable", async () => {
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(
+          entryWith({ play_previous_feed_url: PREV_URL }),
+          stateAt(10)
+        )
+      );
+
+      await act(async () => result.current.goPrevious());
+
+      expect(seekTo).toHaveBeenCalledWith(0);
+      expect(replaceTop).not.toHaveBeenCalled();
+    });
+  });
+
+  describe("double tap guard", () => {
+    const bothDirections = {
+      play_next_feed_url: NEXT_URL,
+      play_previous_feed_url: PREV_URL,
+    };
+
+    /**
+     * Makes the next feed request hang until the returned function is called,
+     * so a test can fire a second tap while the first is still in flight.
+     */
+    const deferredFeed = () => {
+      const deferred: { complete?: (entry: ZappEntry) => void } = {};
+
+      loadFeedEntryMock.mockReturnValue(
+        new Promise<ZappEntry>((resolve) => {
+          deferred.complete = resolve;
+        })
+      );
+
+      return (entry: ZappEntry) => deferred.complete(entry);
+    };
+
+    it("ignores a second tap while the first request is still in flight", async () => {
+      const complete = deferredFeed();
+
+      const { result } = await renderPlaylistNavigation(
+        entryWith(bothDirections),
+        stateAt(0)
+      );
+
+      await act(async () => {
+        const first = result.current.goNext();
+        const second = result.current.goNext();
+
+        complete({ id: "next" } as ZappEntry);
+
+        await Promise.all([first, second]);
+      });
+
+      expect(loadFeedEntryMock).toHaveBeenCalledTimes(1);
+      expect(replaceTop).toHaveBeenCalledTimes(1);
+    });
+
+    it("stops Previous racing an in-flight Next", async () => {
+      const complete = deferredFeed();
+
+      const { result } = await renderPlaylistNavigation(
+        entryWith(bothDirections),
+        stateAt(0)
+      );
+
+      await act(async () => {
+        const next = result.current.goNext();
+        const previous = result.current.goPrevious();
+
+        complete({ id: "next" } as ZappEntry);
+
+        await Promise.all([next, previous]);
+      });
+
+      expect(loadFeedEntryMock).toHaveBeenCalledTimes(1);
+
+      expect(loadFeedEntryMock).toHaveBeenCalledWith(
+        NEXT_URL,
+        expect.anything()
+      );
+    });
+
+    it("allows a new navigation once the previous one has completed", async () => {
+      loadFeedEntryMock.mockResolvedValue({ id: "next" } as ZappEntry);
+
+      const { result } = await renderPlaylistNavigation(
+        entryWith(bothDirections),
+        stateAt(0)
+      );
+
+      await act(async () => result.current.goNext());
+      await act(async () => result.current.goNext());
+
+      expect(loadFeedEntryMock).toHaveBeenCalledTimes(2);
+      expect(replaceTop).toHaveBeenCalledTimes(2);
+    });
+
+    it("releases the guard after a failed request so the control can retry", async () => {
+      loadFeedEntryMock
+        .mockRejectedValueOnce(new Error("network down"))
+        .mockResolvedValueOnce({ id: "next" } as ZappEntry);
+
+      const { result } = await renderPlaylistNavigation(
+        entryWith(bothDirections),
+        stateAt(0)
+      );
+
+      await act(async () => result.current.goNext());
+
+      expect(replaceTop).not.toHaveBeenCalled();
+
+      await act(async () => result.current.goNext());
+
+      expect(replaceTop).toHaveBeenCalledTimes(1);
+    });
+
+    it("does not guard the Previous restart, which is local and instant", async () => {
+      loadFeedEntryMock.mockResolvedValue({ id: "prev" } as ZappEntry);
+
+      const { result } = renderHook(() =>
+        usePlaylistNavigation(entryWith(bothDirections), stateAt(10))
+      );
+
+      await act(async () => result.current.goPrevious());
+      await act(async () => result.current.goPrevious());
+
+      expect(seekTo).toHaveBeenCalledTimes(2);
+      expect(loadFeedEntryMock).not.toHaveBeenCalled();
+    });
+  });
+
+  describe("remote commands", () => {
+    let listeners: Record<string, QuickBrickPlayer.SharedPlayerCallBacks>;
+    const command = jest.fn();
+
+    const remote = (id: RemoteCommand) =>
+      act(async () => {
+        Object.values(listeners).forEach((l) => l.onRemoteCommand?.({ id }));
+      });
+
+    beforeEach(() => {
+      listeners = {};
+      command.mockClear();
+
+      usePlayerMock.mockReturnValue({
+        playerId: "player-1",
+        command,
+        seekTo,
+        addListener: ({ id, listener }) => {
+          listeners[id] = listener;
+
+          return () => delete listeners[id];
+        },
+      });
+    });
+
+    it("plays next when the lock screen / CarPlay next button is pressed", async () => {
+      const target = { id: "next" } as ZappEntry;
+      loadFeedEntryMock.mockResolvedValue(target);
+
+      await renderPlaylistNavigation(
+        entryWith({ play_next_feed_url: NEXT_URL }),
+        stateAt(0)
+      );
+
+      await remote(RemoteCommand.NextTrack);
+
+      expect(replaceTop).toHaveBeenCalledWith(target);
+    });
+
+    it("restarts the track on remote previous past the threshold", async () => {
+      await renderPlaylistNavigation(entryWith({}), stateAt(10));
+
+      await remote(RemoteCommand.PreviousTrack);
+
+      expect(seekTo).toHaveBeenCalledWith(0);
+    });
+
+    it("ignores commands native handles itself", async () => {
+      await renderPlaylistNavigation(
+        entryWith({ play_next_feed_url: NEXT_URL }),
+        stateAt(10)
+      );
+
+      await remote(RemoteCommand.Pause);
+
+      expect(replaceTop).not.toHaveBeenCalled();
+      expect(seekTo).not.toHaveBeenCalled();
+    });
+
+    it("sends native the controls snapshot to show", async () => {
+      await renderPlaylistNavigation(
+        entryWith({ play_next_feed_url: NEXT_URL }),
+        stateAt(0, NOT_SEEKABLE)
+      );
+
+      expect(command).toHaveBeenLastCalledWith("setPlayerControls", {
+        transport: [
+          RemoteCommand.Play,
+          RemoteCommand.Pause,
+          RemoteCommand.SkipBackward,
+          RemoteCommand.NextTrack,
+        ],
+      });
+    });
+
+    it("stops listening once unmounted", async () => {
+      const { unmount } = await renderPlaylistNavigation(
+        entryWith({ play_next_feed_url: NEXT_URL }),
+        stateAt(0)
+      );
+
+      unmount();
+
+      expect(listeners).toEqual({});
+    });
+  });
+});
+
+describe("getTransportControls", () => {
+  it("falls back to skip backward and leaves next out when there is no playlist", () => {
+    expect(
+      getTransportControls({
+        hasNext: false,
+        hasPrevious: false,
+        isLive: false,
+      })
+    ).toEqual([
+      RemoteCommand.Play,
+      RemoteCommand.Pause,
+      RemoteCommand.SkipBackward,
+    ]);
+  });
+
+  it("leaves next out without a next item, so it shows disabled", () => {
+    expect(
+      getTransportControls({ hasNext: false, hasPrevious: true, isLive: false })
+    ).toEqual([
+      RemoteCommand.Play,
+      RemoteCommand.Pause,
+      RemoteCommand.PreviousTrack,
+    ]);
+  });
+
+  it("puts track buttons in place of skip ones", () => {
+    expect(
+      getTransportControls({ hasNext: true, hasPrevious: true, isLive: false })
+    ).toEqual([
+      RemoteCommand.Play,
+      RemoteCommand.Pause,
+      RemoteCommand.PreviousTrack,
+      RemoteCommand.NextTrack,
+    ]);
+  });
+
+  it("uses stop and never skips on live", () => {
+    expect(
+      getTransportControls({ hasNext: false, hasPrevious: false, isLive: true })
+    ).toEqual([RemoteCommand.Play, RemoteCommand.Stop]);
+  });
+
+  it("keeps track buttons on live, e.g. a list of radio stations", () => {
+    expect(
+      getTransportControls({ hasNext: true, hasPrevious: true, isLive: true })
+    ).toEqual([
+      RemoteCommand.Play,
+      RemoteCommand.Stop,
+      RemoteCommand.PreviousTrack,
+      RemoteCommand.NextTrack,
+    ]);
+  });
+});