@applicaster/zapp-react-native-utils 16.0.0-alpha.1042942411 → 16.0.0-alpha.1054344748

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__/playerFactory.test.ts

@@ -10,7 +10,7 @@ jest.mock("@applicaster/zapp-react-native-utils/pluginUtils", () => ({
     mockFindPluginByIdentifier(id, plugins),
 }));
 
-import { PlayerRole } from "../conts";
+import { PlayerRole } from "../const";
 import { playerFactory } from "../playerFactory";
 
 const fakeComponent = () => null;

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

@@ -0,0 +1,114 @@
+import { PlayerNative } from "../playerNative";
+
+const playerWithEntry = (entry: any) =>
+  new PlayerNative({
+    entry,
+    player: null as any,
+    playerId: "test-player",
+  });
+
+describe("PlayerNative.isAudioItem", () => {
+  it.each(["audio", "audio-player", "audio-detail", "audio-show", "audio-hub"])(
+    "treats the %s content type as audio",
+    (type) => {
+      expect(playerWithEntry({ type: { value: type } }).isAudioItem()).toBe(
+        true
+      );
+    }
+  );
+
+  it.each(["video", "video-detail", "comic-detail", "article-show"])(
+    "does not treat the %s content type as audio",
+    (type) => {
+      expect(playerWithEntry({ type: { value: type } }).isAudioItem()).toBe(
+        false
+      );
+    }
+  );
+
+  it("falls back to the media type when the content type says nothing", () => {
+    const entry = { content: { type: "audio/mpeg" }, type: { value: "link" } };
+
+    expect(playerWithEntry(entry).isAudioItem()).toBe(true);
+  });
+
+  it("returns false when there is no entry", () => {
+    expect(playerWithEntry(null).isAudioItem()).toBe(false);
+  });
+});
+
+describe("PlayerNative.command", () => {
+  it("invokes native function with playerId on iOS platform", () => {
+    const player = new PlayerNative({
+      entry: null,
+      player: { current: {} } as any,
+      playerId: "test-player",
+      playerPluginId: "QuickBrickPlayerPlugin",
+    });
+
+    const commandSpy = jest.fn();
+
+    jest.spyOn(player, "getPlayerModule").mockReturnValue({
+      command: commandSpy,
+    } as any);
+
+    player.command("setPlayerControls", { transport: ["play"] });
+
+    expect(commandSpy).toHaveBeenCalledWith(
+      "setPlayerControls",
+      "test-player",
+      {
+        transport: ["play"],
+      }
+    );
+  });
+
+  it("invokes native function with view tag on Android when method exists", () => {
+    const reactUtils = require("../../../reactUtils");
+    jest.spyOn(reactUtils, "isApplePlatform").mockReturnValue(false);
+
+    const player = new PlayerNative({
+      entry: null,
+      player: { current: {} } as any,
+      playerId: "test-player",
+      playerPluginId: "QuickBrickPlayerPlugin",
+    });
+
+    const commandSpy = jest.fn();
+
+    jest.spyOn(player, "getPlayerModule").mockReturnValue({
+      command: commandSpy,
+    } as any);
+
+    jest.spyOn(player, "getComponentNode").mockReturnValue(12345 as any);
+
+    player.command("setPlayerControls", { transport: ["play"] });
+
+    expect(commandSpy).toHaveBeenCalledWith(12345, "setPlayerControls", {
+      transport: ["play"],
+    });
+
+    (reactUtils.isApplePlatform as jest.Mock).mockRestore();
+  });
+
+  it("handles when native module does not have command method on Android", () => {
+    const reactUtils = require("../../../reactUtils");
+    jest.spyOn(reactUtils, "isApplePlatform").mockReturnValue(false);
+
+    const player = new PlayerNative({
+      entry: null,
+      player: { current: {} } as any,
+      playerId: "test-player",
+      playerPluginId: "KalturaPlayerPlugin",
+    });
+
+    jest.spyOn(player, "getPlayerModule").mockReturnValue({} as any);
+    jest.spyOn(player, "getComponentNode").mockReturnValue(12345 as any);
+
+    expect(() => {
+      player.command("setPlayerControls", { transport: ["play"] });
+    }).not.toThrow();
+
+    (reactUtils.isApplePlatform as jest.Mock).mockRestore();
+  });
+});

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

@@ -0,0 +1,62 @@
+import { NativeModules } from "react-native";
+import {
+  PlayerNativeCommandTypes,
+  PlayerNativeSendCommand,
+} from "../playerNativeCommand";
+
+describe("PlayerNativeSendCommand", () => {
+  const reactUtils = require("../../../reactUtils");
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it("calls NativeModules.PlayerModule.command on Apple platform with playerId", () => {
+    jest.spyOn(reactUtils, "isApplePlatform").mockReturnValue(true);
+
+    NativeModules.PlayerModule = {
+      command: jest.fn(),
+    };
+
+    PlayerNativeSendCommand(
+      PlayerNativeCommandTypes.setPlayerControls,
+      "player-123",
+      { transport: ["play"] }
+    );
+
+    expect(NativeModules.PlayerModule.command).toHaveBeenCalledWith(
+      "setPlayerControls",
+      "player-123",
+      { transport: ["play"] }
+    );
+  });
+
+  it("does not call NativeModules.PlayerModule.command on non-Apple platform", () => {
+    jest.spyOn(reactUtils, "isApplePlatform").mockReturnValue(false);
+
+    NativeModules.PlayerModule = {
+      command: jest.fn(),
+    };
+
+    PlayerNativeSendCommand(
+      PlayerNativeCommandTypes.setPlayerControls,
+      "player-123",
+      { transport: ["play"] }
+    );
+
+    expect(NativeModules.PlayerModule.command).not.toHaveBeenCalled();
+  });
+
+  it("does nothing when playerId or command is missing", () => {
+    jest.spyOn(reactUtils, "isApplePlatform").mockReturnValue(true);
+
+    NativeModules.PlayerModule = {
+      command: jest.fn(),
+    };
+
+    PlayerNativeSendCommand("", "player-123");
+    PlayerNativeSendCommand("setPlayerControls", "");
+
+    expect(NativeModules.PlayerModule.command).not.toHaveBeenCalled();
+  });
+});

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

@@ -0,0 +1,97 @@
+const mockRegister = jest.fn();
+let mockXray: Record<string, unknown> | null = {};
+
+jest.mock("../../../logger", () => ({
+  getXray: () => mockXray,
+}));
+
+const loadToolbox = () => {
+  let module;
+
+  jest.isolateModules(() => {
+    module = require("../playerToolbox");
+  });
+
+  return module as typeof import("../playerToolbox");
+};
+
+const player = (overrides = {}) => ({
+  getSeekableDuration: () => 100,
+  getContentPosition: () => 40,
+  seekTo: jest.fn(),
+  ...overrides,
+});
+
+const manager = (active) =>
+  ({ getActivePlayer: () => active, isCasting: () => false }) as any;
+
+const registeredTools = async (active) => {
+  mockRegister.mockResolvedValue(undefined);
+  mockXray = { registerReactToolbox: mockRegister };
+  await loadToolbox().registerPlayerToolbox(manager(active));
+
+  const { tools } = mockRegister.mock.calls[0][0];
+
+  return Object.fromEntries(tools.map((tool) => [tool.name, tool.handler]));
+};
+
+describe("playerToolbox", () => {
+  beforeEach(() => {
+    mockRegister.mockReset();
+  });
+
+  it("does nothing when X-Ray has no React toolbox API", async () => {
+    mockXray = {};
+
+    await expect(
+      loadToolbox().registerPlayerToolbox(manager(null))
+    ).resolves.toBeUndefined();
+  });
+
+  it("does nothing when getXray returns null", async () => {
+    mockXray = null;
+
+    await expect(
+      loadToolbox().registerPlayerToolbox(manager(null))
+    ).resolves.toBeUndefined();
+  });
+
+  it("swallows a failed registration", async () => {
+    mockRegister.mockRejectedValue(new Error("no native bridge"));
+    mockXray = { registerReactToolbox: mockRegister };
+
+    await expect(
+      loadToolbox().registerPlayerToolbox(manager(null))
+    ).resolves.toBeUndefined();
+  });
+
+  it("seeks to an absolute position, from the end when negative, clamped", async () => {
+    const active = player();
+    const tools = await registeredTools(active);
+
+    expect(tools.seek({ position: 30 })).toEqual({ position: 30 });
+    expect(tools.seek({ position: -10 })).toEqual({ position: 90 });
+    expect(tools.seek({ position: 500 })).toEqual({ position: 100 });
+    expect(tools.seek({ position: -500 })).toEqual({ position: 0 });
+    expect(active.seekTo.mock.calls).toEqual([[30], [90], [100], [0]]);
+  });
+
+  it("offsets from the current position and refuses zero", async () => {
+    const tools = await registeredTools(player());
+
+    expect(tools.offset({ seconds: 15 })).toEqual({ from: 40, position: 55 });
+    expect(tools.offset({ seconds: -60 })).toEqual({ from: 40, position: 0 });
+
+    expect(() => tools.offset({ seconds: 0 })).toThrow(
+      "Ignored zero relative seek"
+    );
+  });
+
+  it("refuses to seek a stream that is not seekable", async () => {
+    const tools = await registeredTools(
+      player({ getSeekableDuration: () => 0 })
+    );
+
+    expect(() => tools.seek({ position: 10 })).toThrow("Seek is not supported");
+  });
+});