@applicaster/quick-brick-player 16.0.0-rc.59 → 16.0.0-rc.60

package/src/Player/AudioLayer/__tests__/AudioPlayerWrapper.test.tsx

@@ -0,0 +1,130 @@
+import React from "react";
+import { render } from "@testing-library/react-native";
+
+/**
+ * Covers AudioPlayerWrapper's remaining Title/Subtitle responsibility, which is
+ * only lifecycle: keep the manager's live-content polling running while this
+ * player is mounted. It carries neither the text (consumers read it from the
+ * player manager via `usePlayerContent`) nor any decision about the polling -
+ * whether the content is live, where the channel's programme feed lives and
+ * how often to poll are all `OverlaysObserver`'s.
+ *
+ * The rest of the chain is covered where each link lives:
+ *   - is-live / feed url / interval           OverlayObserver/__tests__/liveContent.test.ts
+ *   - polling -> `observer.liveEntry`         OverlayObserver/__tests__/liveContent.test.ts
+ *   - liveEntry -> published content          playerManager/__tests__/playerContent.test.ts
+ *   - published content -> rendered text      AudioLayer/__tests__/AudioDescription.test.tsx
+ */
+
+const mockStartLiveContentUpdates = jest.fn();
+const mockStopLiveContentUpdates = jest.fn();
+
+const mockPlayer = {
+  getOverlayObservable: () => ({
+    startLiveContentUpdates: mockStartLiveContentUpdates,
+    stopLiveContentUpdates: mockStopLiveContentUpdates,
+  }),
+  addListener: jest.fn(() => jest.fn()),
+  play: jest.fn(),
+  pause: jest.fn(),
+  rewind: jest.fn(),
+  forward: jest.fn(),
+};
+
+let mockIsLive = false;
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/appUtils/playerManager/usePlayer",
+  () => ({ usePlayer: () => mockPlayer })
+);
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/appUtils/playerManager/usePlayerState",
+  () => ({
+    usePlayerState: () => ({
+      isLive: mockIsLive,
+      seekableDuration: 0,
+      isReadyToPlay: false,
+      isBuffering: false,
+      isPaused: false,
+    }),
+  })
+);
+
+jest.mock("@applicaster/zapp-react-native-utils/appUtils", () => ({
+  playerManager: {
+    close: jest.fn(),
+    isCasting: jest.fn(() => false),
+  },
+}));
+
+jest.mock("@applicaster/zapp-react-native-utils/reactHooks", () => ({
+  useNavigation: jest.fn(() => ({ maximiseVideoModal: jest.fn() })),
+}));
+
+jest.mock("@applicaster/zapp-react-native-utils/modalState", () => ({
+  useModalStoreState: jest.fn(() => ({ visible: false })),
+  dismissModal: jest.fn(),
+  openBottomSheetModal: jest.fn(),
+}));
+
+jest.mock("../Layout", () => ({
+  __esModule: true,
+  default: () => null,
+}));
+
+import { AudioPlayerWrapper } from "../AudioPlayerWrapper";
+
+const LIVE_ENTRY = {
+  id: "entry-1",
+  title: "Channel Title",
+  summary: "Channel Summary",
+  extensions: {
+    live: { channel_src: "https://feed.test/subClass/audio" },
+  },
+} as any;
+
+const baseProps = {
+  configuration: { audio_live_player_update_interval: 30 },
+  style: { width: 100, height: 100 } as any,
+  entry: LIVE_ENTRY,
+  layoutState: { inline: false, docked: false, isModal: false, pip: false },
+  playNextData: null,
+  children: null,
+};
+
+describe("AudioPlayerWrapper live content polling", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mockIsLive = true;
+  });
+
+  it("asks the observer to keep live content fresh while mounted", () => {
+    render(<AudioPlayerWrapper {...baseProps} />);
+
+    expect(mockStartLiveContentUpdates).toHaveBeenCalled();
+  });
+
+  it("stops polling on unmount", () => {
+    const { unmount } = render(<AudioPlayerWrapper {...baseProps} />);
+
+    unmount();
+
+    expect(mockStopLiveContentUpdates).toHaveBeenCalled();
+  });
+
+  it("re-evaluates when the player reports the content is live", () => {
+    // `isLive` is unknown until the player loads, so the effect has to run
+    // again once it settles - the observer decides what to do with it.
+    mockIsLive = false;
+
+    const { rerender } = render(<AudioPlayerWrapper {...baseProps} />);
+
+    mockStartLiveContentUpdates.mockClear();
+    mockIsLive = true;
+
+    rerender(<AudioPlayerWrapper {...baseProps} />);
+
+    expect(mockStartLiveContentUpdates).toHaveBeenCalled();
+  });
+});

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

@@ -0,0 +1,387 @@
+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 { 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,
+  })
+);
+
+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();
+    });
+  });
+});

package/src/Player/AudioLayer/usePlaylistNavigation.ts

@@ -0,0 +1,134 @@
+import * as React from "react";
+
+import { useNavigation } from "@applicaster/zapp-react-native-utils/reactHooks";
+import { usePlayer } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/usePlayer";
+import {
+  loadFeedEntry,
+  retrieveFeedUrl,
+  retrievePlayPreviousFeedUrl,
+} from "@applicaster/zapp-react-native-utils/appUtils/playerManager/OverlayObserver/utils";
+import { createLogger } from "@applicaster/zapp-react-native-utils/logger";
+
+const { log_error, log_info } = createLogger({
+  subsystem: "Player",
+  category: "usePlaylistNavigation",
+});
+
+const RESTART_THRESHOLD_SECONDS = 3;
+
+export type PlaylistNavigation = {
+  hasNext: boolean;
+  hasPrevious: boolean;
+  goNext: () => Promise<void>;
+  goPrevious: () => Promise<void>;
+};
+
+/**
+ * Each entry points at the feed holding its neighbour, so the chain walks
+ * itself and needs no client-side queue.
+ */
+export const usePlaylistNavigation = (
+  entry: ZappEntry,
+  playerState: QuickBrickPlayer.PlayerState
+): PlaylistNavigation => {
+  const navigator = useNavigation();
+  // Not playerManager.getActivePlayer(): that is always the local player, so
+  // seeking would miss the receiver while casting.
+  const player = usePlayer();
+
+  const [nextUrl, setNextUrl] = React.useState<string | null>(null);
+
+  React.useEffect(() => {
+    let cancelled = false;
+
+    retrieveFeedUrl(entry)
+      .then((url) => {
+        if (!cancelled) {
+          setNextUrl(url ?? null);
+        }
+      })
+      .catch((error) => {
+        log_error(
+          "usePlaylistNavigation: could not resolve the next feed url",
+          { error }
+        );
+
+        if (!cancelled) {
+          setNextUrl(null);
+        }
+      });
+
+    return () => {
+      cancelled = true;
+    };
+  }, [entry]);
+
+  const previousUrl = retrievePlayPreviousFeedUrl(entry);
+  const currentTime = playerState?.currentTime ?? 0;
+
+  const canRestart = (playerState?.seekableDuration ?? 0) > 0;
+
+  const isNavigatingRef = React.useRef(false);
+
+  const navigateTo = React.useCallback(
+    async (feedUrl: string) => {
+      // A second tap mid-flight resolves to the same target, since `entry` has
+      // not been replaced yet.
+      if (isNavigatingRef.current) {
+        return;
+      }
+
+      isNavigatingRef.current = true;
+
+      try {
+        const target = await loadFeedEntry(feedUrl, entry);
+
+        log_info(`navigateTo: playing "${target.title}", id: ${target.id}`, {
+          feedUrl,
+          targetId: target.id,
+        });
+
+        navigator.replaceTop(target);
+      } catch (error) {
+        log_error("navigateTo: could not play the neighbouring entry", {
+          error,
+          feedUrl,
+        });
+      } finally {
+        // Released on failure too, so one bad request cannot latch the control.
+        isNavigatingRef.current = false;
+      }
+    },
+    [entry, navigator]
+  );
+
+  const goNext = React.useCallback(async () => {
+    if (!nextUrl) return;
+
+    await navigateTo(nextUrl);
+  }, [nextUrl, navigateTo]);
+
+  const goPrevious = React.useCallback(async () => {
+    // Restarting belongs to the stream, not the chain — so it stays available
+    // at the head, where there is nothing to step back to.
+    const shouldRestart =
+      canRestart && (currentTime > RESTART_THRESHOLD_SECONDS || !previousUrl);
+
+    if (shouldRestart) {
+      player?.seekTo(0);
+
+      return;
+    }
+
+    if (!previousUrl) return;
+
+    await navigateTo(previousUrl);
+  }, [previousUrl, currentTime, canRestart, navigateTo, player]);
+
+  return {
+    hasNext: Boolean(nextUrl),
+    hasPrevious: Boolean(previousUrl) || canRestart,
+    goNext,
+    goPrevious,
+  };
+};