@applicaster/zapp-react-native-utils 15.1.7 → 15.1.9-alpha.3547421944

package/appUtils/playerManager/OverlayObserver/__tests__/liveContent.test.ts

@@ -0,0 +1,205 @@
+import { OverlaysObserver } from "../OverlaysObserver";
+import { loadFeedEntry } from "../utils";
+
+jest.mock("../utils", () => ({
+  ...jest.requireActual("../utils"),
+  loadFeedEntry: jest.fn(),
+}));
+
+const FEED_ENTRY = { title: "Programme One" } as unknown as ZappEntry;
+
+const CHANNEL_ENTRY = {
+  title: "Channel",
+  extensions: { live: { channel_src: "https://feed.test/subClass/audio" } },
+} as unknown as ZappEntry;
+
+const makePlayer = ({
+  isLive = true,
+  entry = CHANNEL_ENTRY,
+  configuration = { audio_live_player_update_interval: 30 },
+}: {
+  isLive?: boolean;
+  entry?: ZappEntry;
+  configuration?: Record<string, any>;
+} = {}) => ({
+  isLive: () => isLive,
+  getEntry: () => entry,
+  getPluginConfiguration: () => configuration,
+  publishContent: jest.fn(),
+  addListener: jest.fn(() => () => {}),
+  removeListener: jest.fn(),
+});
+
+describe("OverlaysObserver live content", () => {
+  beforeEach(() => {
+    jest.useFakeTimers();
+    (loadFeedEntry as jest.Mock).mockReset();
+    (loadFeedEntry as jest.Mock).mockResolvedValue(FEED_ENTRY);
+  });
+
+  afterEach(() => {
+    jest.useRealTimers();
+  });
+
+  it("stores the loaded programme and asks the player to republish", async () => {
+    const player = makePlayer();
+    const observer = new OverlaysObserver({ player } as any);
+
+    observer.startLiveContentUpdates();
+
+    await Promise.resolve();
+    await Promise.resolve();
+
+    expect(observer.liveEntry).toBe(FEED_ENTRY);
+    expect(player.publishContent).toHaveBeenCalled();
+
+    observer.stopLiveContentUpdates();
+  });
+
+  it("clears the stored programme on clearLiveEntry", async () => {
+    const player = makePlayer();
+    const observer = new OverlaysObserver({ player } as any);
+
+    observer.startLiveContentUpdates();
+
+    await Promise.resolve();
+    await Promise.resolve();
+
+    observer.clearLiveEntry();
+
+    expect(observer.liveEntry).toBeNull();
+
+    observer.stopLiveContentUpdates();
+  });
+
+  it("reloads on the configured interval", async () => {
+    const player = makePlayer();
+    const observer = new OverlaysObserver({ player } as any);
+
+    observer.startLiveContentUpdates();
+
+    await Promise.resolve();
+
+    (loadFeedEntry as jest.Mock).mockClear();
+
+    jest.advanceTimersByTime(30_000);
+
+    expect(loadFeedEntry).toHaveBeenCalledTimes(1);
+
+    observer.stopLiveContentUpdates();
+  });
+
+  it("stops polling after stopLiveContentUpdates", async () => {
+    const player = makePlayer();
+    const observer = new OverlaysObserver({ player } as any);
+
+    observer.startLiveContentUpdates();
+
+    await Promise.resolve();
+
+    observer.stopLiveContentUpdates();
+
+    (loadFeedEntry as jest.Mock).mockClear();
+
+    jest.advanceTimersByTime(90_000);
+
+    expect(loadFeedEntry).not.toHaveBeenCalled();
+  });
+
+  it("keeps the previous content when a poll fails", async () => {
+    const player = makePlayer();
+    const observer = new OverlaysObserver({ player } as any);
+
+    (loadFeedEntry as jest.Mock).mockRejectedValue(new Error("network"));
+
+    observer.startLiveContentUpdates();
+
+    await Promise.resolve();
+    await Promise.resolve();
+
+    expect(observer.liveEntry).toBeNull();
+    expect(player.publishContent).not.toHaveBeenCalled();
+
+    observer.stopLiveContentUpdates();
+  });
+
+  it("drops a response that arrives after polling was stopped", async () => {
+    const player = makePlayer();
+    const observer = new OverlaysObserver({ player } as any);
+
+    let resolveLoad: (entry: ZappEntry) => void;
+
+    (loadFeedEntry as jest.Mock).mockReturnValue(
+      new Promise<ZappEntry>((resolve) => {
+        resolveLoad = resolve;
+      })
+    );
+
+    observer.startLiveContentUpdates();
+    observer.stopLiveContentUpdates();
+
+    // The request was already in flight when polling stopped: clearing the
+    // interval cannot cancel it, so its result must be ignored rather than
+    // published over whatever is playing now.
+    resolveLoad(FEED_ENTRY);
+
+    await Promise.resolve();
+    await Promise.resolve();
+
+    expect(observer.liveEntry).toBeNull();
+    expect(player.publishContent).not.toHaveBeenCalled();
+  });
+
+  it("does not start polling when the entry carries no live channel feed", () => {
+    const player = makePlayer({ entry: { title: "No Feed" } as ZappEntry });
+    const observer = new OverlaysObserver({ player } as any);
+
+    observer.startLiveContentUpdates();
+
+    expect(loadFeedEntry).not.toHaveBeenCalled();
+  });
+
+  it("does not start polling for on-demand content", () => {
+    const player = makePlayer({ isLive: false });
+    const observer = new OverlaysObserver({ player } as any);
+
+    observer.startLiveContentUpdates();
+
+    expect(loadFeedEntry).not.toHaveBeenCalled();
+  });
+
+  it("rewrites the channel url to reach the programme feed", () => {
+    const player = makePlayer();
+    const observer = new OverlaysObserver({ player } as any);
+
+    observer.startLiveContentUpdates();
+
+    expect(loadFeedEntry).toHaveBeenCalledWith(
+      "https://feed.test/livePage/audio",
+      expect.anything()
+    );
+
+    observer.stopLiveContentUpdates();
+  });
+
+  it("falls back to the manifest default interval when none is configured", async () => {
+    // An unset value would make `intervalSeconds * 1000` NaN, and setInterval
+    // treats NaN as 0 - a tight loop hammering the feed.
+    const player = makePlayer({ configuration: {} });
+    const observer = new OverlaysObserver({ player } as any);
+
+    observer.startLiveContentUpdates();
+
+    await Promise.resolve();
+
+    (loadFeedEntry as jest.Mock).mockClear();
+
+    jest.advanceTimersByTime(59_000);
+    expect(loadFeedEntry).not.toHaveBeenCalled();
+
+    jest.advanceTimersByTime(1_000);
+    expect(loadFeedEntry).toHaveBeenCalledTimes(1);
+
+    observer.stopLiveContentUpdates();
+  });
+});

package/appUtils/playerManager/__tests__/playerContent.test.ts

@@ -0,0 +1,403 @@
+import { Player } from "../player";
+import { isTV } from "../../../reactUtils";
+
+jest.mock("../../../reactUtils", () => ({
+  ...jest.requireActual("../../../reactUtils"),
+  isTV: jest.fn(() => false),
+}));
+
+const mockIsTV = isTV as jest.Mock;
+
+const ENTRY = {
+  title: "Entry Title",
+  summary: "Entry Summary",
+  extensions: { programme: "Programme Title" },
+} as unknown as ZappEntry;
+
+const LIVE_ENTRY = {
+  title: "Live Title",
+  summary: "Live Summary",
+} as unknown as ZappEntry;
+
+const makePlayer = (configuration: Record<string, any> | null = null) => {
+  const player = new Player({ playerId: "test-player" });
+
+  player.getPluginConfiguration = () => configuration;
+
+  return player;
+};
+
+describe("Player content channel", () => {
+  beforeEach(() => {
+    mockIsTV.mockReturnValue(false);
+  });
+
+  it("resolves the entry fields when nothing is configured", () => {
+    const player = makePlayer();
+
+    player.entry = ENTRY;
+
+    expect(player.getContent()).toEqual({
+      title: "Entry Title",
+      summary: "Entry Summary",
+    });
+  });
+
+  it("resolves a configured custom data key", () => {
+    const player = makePlayer({
+      title_data_key_source: "other",
+      title_custom_data_key: "extensions.programme",
+    });
+
+    player.entry = ENTRY;
+
+    expect(player.getContent().title).toBe("Programme Title");
+  });
+
+  it("falls back to the entry field when the configured key is unresolvable", () => {
+    const player = makePlayer({
+      title_data_key_source: "other",
+      title_custom_data_key: "extensions.nope",
+    });
+
+    player.entry = ENTRY;
+
+    expect(player.getContent().title).toBe("Entry Title");
+  });
+
+  it("emits the resolved content to subscribers when the entry changes", () => {
+    const player = makePlayer();
+    const received: any[] = [];
+
+    player
+      .getContentObservable()
+      .subscribe((content) => received.push(content));
+
+    player.entry = ENTRY;
+
+    expect(received[received.length - 1]).toEqual({
+      title: "Entry Title",
+      summary: "Entry Summary",
+    });
+  });
+
+  it("seeds subscribers with resolved content, never the raw entry", () => {
+    const player = makePlayer({
+      title_data_key_source: "other",
+      title_custom_data_key: "extensions.programme",
+    });
+
+    player.entry = ENTRY;
+
+    const received: any[] = [];
+
+    player
+      .getContentObservable()
+      .subscribe((content) => received.push(content));
+
+    expect(received[0].title).toBe("Programme Title");
+  });
+
+  // The live entry lives on `OverlaysObserver`, not on the player, so these
+  // stub the observer rather than constructing a real one (whose constructor
+  // pulls in chapter markers, play-next and the plugin store). What is under
+  // test here is only how `getContent` and the `entry` setter treat it; the
+  // observer's own side - loading the feed and storing the result - is
+  // covered in `OverlayObserver/__tests__/liveContent.test.ts`.
+  const withLiveEntry = (player: Player, liveEntry: ZappEntry | null) => {
+    (player as any).overlaysObserver = {
+      liveEntry,
+      clearLiveEntry() {
+        this.liveEntry = null;
+      },
+    };
+  };
+
+  it("prefers the observer's live entry over the player entry", () => {
+    const player = makePlayer();
+
+    player.entry = ENTRY;
+    withLiveEntry(player, LIVE_ENTRY);
+
+    expect(player.getContent()).toEqual({
+      title: "Live Title",
+      summary: "Live Summary",
+    });
+  });
+
+  it("clears the live entry when a new entry is set", () => {
+    const player = makePlayer();
+
+    player.entry = ENTRY;
+    withLiveEntry(player, LIVE_ENTRY);
+    player.entry = ENTRY;
+
+    expect(player.getContent().title).toBe("Entry Title");
+  });
+
+  it("falls through to the player entry when there is no observer at all", () => {
+    const player = makePlayer();
+
+    player.entry = ENTRY;
+
+    expect((player as any).overlaysObserver).toBeFalsy();
+    expect(player.getContent().title).toBe("Entry Title");
+  });
+
+  it("resolves the cover image from the entry's media group", () => {
+    const player = makePlayer();
+
+    player.entry = {
+      title: "Entry Title",
+      media_group: [
+        {
+          type: "image",
+          media_item: [
+            { key: "image_other", src: "https://img.test/other.jpg" },
+            { key: "image_base", src: "https://img.test/base.jpg" },
+          ],
+        },
+      ],
+    } as unknown as ZappEntry;
+
+    expect(player.getContent().imageUrl).toBe("https://img.test/base.jpg");
+  });
+
+  it("falls back to the first media item when there is no image_base", () => {
+    const player = makePlayer();
+
+    player.entry = {
+      title: "Entry Title",
+      media_group: [
+        {
+          type: "image",
+          media_item: [
+            { key: "image_other", src: "https://img.test/other.jpg" },
+          ],
+        },
+      ],
+    } as unknown as ZappEntry;
+
+    expect(player.getContent().imageUrl).toBe("https://img.test/other.jpg");
+  });
+
+  it("has no image when the entry carries no media group", () => {
+    const player = makePlayer();
+
+    player.entry = ENTRY;
+
+    expect(player.getContent().imageUrl).toBeUndefined();
+  });
+
+  it("takes the cover image from the live entry, not the channel", () => {
+    // The programme's own artwork has to travel with its title - otherwise the
+    // lock screen would keep showing the channel's cover all day.
+    const player = makePlayer();
+
+    player.entry = {
+      title: "Channel",
+      media_group: [
+        {
+          type: "image",
+          media_item: [
+            { key: "image_base", src: "https://img.test/channel.jpg" },
+          ],
+        },
+      ],
+    } as unknown as ZappEntry;
+
+    withLiveEntry(player, {
+      title: "Programme",
+      media_group: [
+        {
+          type: "image",
+          media_item: [
+            { key: "image_base", src: "https://img.test/programme.jpg" },
+          ],
+        },
+      ],
+    } as unknown as ZappEntry);
+
+    expect(player.getContent().imageUrl).toBe("https://img.test/programme.jpg");
+  });
+
+  it("publishes the observer's live entry to subscribers", () => {
+    const player = makePlayer();
+    const received: any[] = [];
+
+    player.entry = ENTRY;
+
+    player
+      .getContentObservable()
+      .subscribe((content) => received.push(content));
+
+    withLiveEntry(player, LIVE_ENTRY);
+    player.publishContent();
+
+    expect(received[received.length - 1].title).toBe("Live Title");
+  });
+
+  it("does not resolve while no subscriber exists", () => {
+    const player = makePlayer();
+    const getConfiguration = jest.fn(() => null);
+
+    player.getPluginConfiguration = getConfiguration;
+    player.entry = ENTRY;
+
+    expect(getConfiguration).not.toHaveBeenCalled();
+  });
+});
+
+/**
+ * Which Studio key set backs the resolution is decided inside `getContent()`
+ * (via `getPlayerContentDataKeys`). Getting it wrong would make one platform
+ * or content type read another's Studio configuration, so each combination is
+ * pinned here - including the negative cases that prove the sets never cross.
+ *
+ * These moved here from `PlayerContainer.test.tsx` when the resolution moved
+ * out of the React tree and into the player; the assertions are unchanged.
+ */
+describe("Player content channel: key-set selection", () => {
+  const VIDEO_ENTRY = {
+    id: "video-entry",
+    title: "Entry Title",
+    summary: "Entry Summary",
+    content: { src: "https://example.com/video.m3u8" },
+    extensions: { customTitleKey: "Custom Title From Extensions" },
+  } as unknown as ZappEntry;
+
+  const AUDIO_ENTRY = {
+    id: "audio-entry",
+    title: "Entry Title",
+    summary: "Entry Summary",
+    content: { type: "audio", src: "https://example.com/audio.m3u8" },
+    extensions: { customTitleKey: "Custom Audio Title From Extensions" },
+  } as unknown as ZappEntry;
+
+  const contentFor = (
+    entry: ZappEntry,
+    configuration: Record<string, any> | null
+  ) => {
+    const player = makePlayer(configuration);
+
+    player.entry = entry;
+
+    return player.getContent();
+  };
+
+  describe("TV video", () => {
+    beforeEach(() => mockIsTV.mockReturnValue(true));
+
+    it("resolves the TV video override to the configured extensions key", () => {
+      const content = contentFor(VIDEO_ENTRY, {
+        video_player_title_data_key_source: "other",
+        video_player_title_custom_data_key: "extensions.customTitleKey",
+      });
+
+      expect(content.title).toBe("Custom Title From Extensions");
+      // summary was not overridden, so it keeps falling back to entry.summary.
+      expect(content.summary).toBe("Entry Summary");
+    });
+
+    it("falls back to the entry title when the configured key does not resolve", () => {
+      const content = contentFor(VIDEO_ENTRY, {
+        video_player_title_data_key_source: "other",
+        video_player_title_custom_data_key: "extensions.doesNotExist",
+      });
+
+      expect(content.title).toBe("Entry Title");
+    });
+
+    it("ignores mobile configuration", () => {
+      const content = contentFor(VIDEO_ENTRY, {
+        title_data_key_source: "other",
+        title_custom_data_key: "extensions.customTitleKey",
+      });
+
+      expect(content.title).toBe("Entry Title");
+    });
+
+    it("reads the TV video key set, not the mobile one, when both are configured", () => {
+      const content = contentFor(VIDEO_ENTRY, {
+        video_player_title_data_key_source: "other",
+        video_player_title_custom_data_key: "extensions.customTitleKey",
+        // A mobile key is also configured, to prove the TV branch ignores it.
+        title_data_key_source: "other",
+        title_custom_data_key: "extensions.doesNotExist",
+      });
+
+      expect(content.title).toBe("Custom Title From Extensions");
+    });
+
+    it("passes the entry fields through when nothing is configured", () => {
+      const content = contentFor(VIDEO_ENTRY, {});
+
+      expect(content.title).toBe("Entry Title");
+      expect(content.summary).toBe("Entry Summary");
+    });
+  });
+
+  describe("TV audio", () => {
+    beforeEach(() => mockIsTV.mockReturnValue(true));
+
+    it("reads the TV audio key set, not the TV video one", () => {
+      const content = contentFor(AUDIO_ENTRY, {
+        audio_player_title_data_key_source: "other",
+        audio_player_title_custom_data_key: "extensions.customTitleKey",
+        // Configuring the TV *video* key too, to prove TV audio content reads
+        // its own key family instead.
+        video_player_title_data_key_source: "other",
+        video_player_title_custom_data_key: "extensions.doesNotExist",
+      });
+
+      expect(content.title).toBe("Custom Audio Title From Extensions");
+    });
+
+    it("falls back to the entry fields when nothing is configured", () => {
+      const content = contentFor(AUDIO_ENTRY, {});
+
+      expect(content.title).toBe("Entry Title");
+      expect(content.summary).toBe("Entry Summary");
+    });
+  });
+
+  describe("mobile", () => {
+    beforeEach(() => mockIsTV.mockReturnValue(false));
+
+    it("resolves the default (mobile) key set", () => {
+      const content = contentFor(VIDEO_ENTRY, {
+        title_data_key_source: "other",
+        title_custom_data_key: "extensions.customTitleKey",
+      });
+
+      expect(content.title).toBe("Custom Title From Extensions");
+    });
+
+    it("ignores TV video configuration", () => {
+      const content = contentFor(VIDEO_ENTRY, {
+        video_player_title_data_key_source: "other",
+        video_player_title_custom_data_key: "extensions.customTitleKey",
+      });
+
+      expect(content.title).toBe("Entry Title");
+    });
+
+    it("shares one key set between video and audio", () => {
+      const content = contentFor(AUDIO_ENTRY, {
+        title_data_key_source: "other",
+        title_custom_data_key: "extensions.customTitleKey",
+      });
+
+      expect(content.title).toBe("Custom Audio Title From Extensions");
+    });
+
+    it("ignores TV audio configuration for mobile audio", () => {
+      const content = contentFor(AUDIO_ENTRY, {
+        audio_player_title_data_key_source: "other",
+        audio_player_title_custom_data_key: "extensions.customTitleKey",
+      });
+
+      expect(content.title).toBe("Entry Title");
+    });
+  });
+});

package/appUtils/playerManager/__tests__/usePlayerContent.test.tsx

@@ -0,0 +1,64 @@
+import { renderHook, act } from "@testing-library/react-native";
+import { BehaviorSubject } from "rxjs";
+
+import { usePlayerContent } from "../usePlayerContent";
+
+const mockPlayer: any = {
+  subject: null as BehaviorSubject<any> | null,
+  getContent: jest.fn(),
+  getContentObservable: jest.fn(),
+};
+
+jest.mock("../usePlayer", () => ({
+  usePlayer: () => mockPlayer,
+}));
+
+describe("usePlayerContent", () => {
+  beforeEach(() => {
+    mockPlayer.subject = new BehaviorSubject({
+      title: "First Title",
+      summary: "First Summary",
+    });
+
+    mockPlayer.getContent = jest.fn(() => mockPlayer.subject.getValue());
+
+    mockPlayer.getContentObservable = jest.fn(() =>
+      mockPlayer.subject.asObservable()
+    );
+  });
+
+  it("returns the player's current content", () => {
+    const { result } = renderHook(() => usePlayerContent());
+
+    expect(result.current).toEqual({
+      title: "First Title",
+      summary: "First Summary",
+    });
+  });
+
+  it("re-renders when the player publishes new content", () => {
+    const { result } = renderHook(() => usePlayerContent());
+
+    act(() => {
+      mockPlayer.subject.next({
+        title: "Second Title",
+        summary: "Second Summary",
+      });
+    });
+
+    expect(result.current).toEqual({
+      title: "Second Title",
+      summary: "Second Summary",
+    });
+  });
+
+  it("unsubscribes on unmount", () => {
+    const { unmount } = renderHook(() => usePlayerContent());
+
+    expect(mockPlayer.subject.observed).toBe(true);
+
+    unmount();
+
+    expect(mockPlayer.subject.observed).toBe(false);
+  });
+});