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

package/src/Player/__tests__/getNativeProps.test.ts

@@ -0,0 +1,115 @@
+import VideoPlayer from "../index";
+import { playerManager } from "@applicaster/zapp-react-native-utils/appUtils";
+
+/**
+ * Pins where `getNativeProps()`'s `metadata` object comes from: the player
+ * manager's content channel, looked up by `props.playerId`.
+ *
+ * This deliberately does NOT depend on tree position. An earlier version read
+ * the values from `PlayerContainerContext` via `static contextType`, which
+ * made native's props depend on `Player` being rendered inside
+ * `PlayerContainerContextProvider` - safe only as long as an exhaustive
+ * render-site search stayed true. Reading from the manager removes that whole
+ * class of fragility, so the tests below assert the value's source rather than
+ * a render-site invariant.
+ *
+ * Lookup is by id rather than `getActivePlayer()` because these props are
+ * handed to this component's own native view: they must describe that player
+ * even while a cast session is running.
+ *
+ * The instance is constructed directly (bypassing `render()`/mount) so this
+ * exercises the real `getNativeProps()` without paying for a full render of
+ * the ~37KB `VideoPlayer` class tree.
+ */
+
+jest.mock("@applicaster/zapp-react-native-utils/appUtils", () => ({
+  ...jest.requireActual("@applicaster/zapp-react-native-utils/appUtils"),
+  playerManager: {
+    getPlayerWithId: jest.fn(),
+  },
+}));
+
+const entry = {
+  id: "1",
+  title: "Entry Title",
+  summary: "Entry Summary",
+} as unknown as ZappEntry;
+
+const baseProps = {
+  entry,
+  pluginConfiguration: {},
+  docked: false,
+  fullscreen: false,
+  inline: false,
+  isModal: false,
+  isTabletPortrait: false,
+  muted: false,
+  playerId: "player-1",
+  PlayerComponent: "QuickBrickDefaultPlayerView",
+} as unknown as ConstructorParameters<typeof VideoPlayer>[0];
+
+const publishContent = (
+  content: {
+    title: Option<string | number>;
+    summary: Option<string | number>;
+  } | null
+) => {
+  (playerManager.getPlayerWithId as jest.Mock).mockReturnValue(
+    content ? { getContent: () => content } : null
+  );
+};
+
+describe("Player's getNativeProps() reading Title/Subtitle from the manager", () => {
+  it("sends the title/summary the player published", () => {
+    publishContent({
+      title: "Resolved Title",
+      summary: "Resolved Summary",
+    });
+
+    const nativeProps = new VideoPlayer(baseProps).getNativeProps();
+
+    expect(nativeProps.metadata.title).toBe("Resolved Title");
+    expect(nativeProps.metadata.subtitle).toBe("Resolved Summary");
+  });
+
+  it("looks the player up by its own id, not the active player", () => {
+    publishContent({ title: "Resolved Title", summary: "Resolved Summary" });
+
+    new VideoPlayer(baseProps).getNativeProps();
+
+    expect(playerManager.getPlayerWithId).toHaveBeenCalledWith("player-1");
+  });
+
+  it("sends undefined when the player published no text", () => {
+    publishContent({ title: null, summary: null });
+
+    const nativeProps = new VideoPlayer(baseProps).getNativeProps();
+
+    expect(nativeProps.metadata.title).toBeUndefined();
+    expect(nativeProps.metadata.subtitle).toBeUndefined();
+  });
+
+  it("sends undefined rather than crashing when no player is registered", () => {
+    publishContent(null);
+
+    const nativeProps = new VideoPlayer(baseProps).getNativeProps();
+
+    expect(nativeProps.metadata.title).toBeUndefined();
+    expect(nativeProps.metadata.subtitle).toBeUndefined();
+  });
+
+  it("does not fall back to entry.title/entry.summary itself - the resolver owns that fallback", () => {
+    // `entry.title`/`entry.summary` are "Entry Title"/"Entry Summary" (see
+    // `baseProps`); with nothing published, nativeProps must NOT silently pick
+    // those up as a second, redundant fallback layer inside `Player`. The
+    // entry-field fallback lives in `resolvePlayerContentText`, reached
+    // through the player's own `getContent()`.
+    publishContent({ title: null, summary: null });
+
+    const nativeProps = new VideoPlayer(baseProps).getNativeProps();
+
+    expect(nativeProps.metadata.title).not.toBe(entry.title);
+    expect(nativeProps.metadata.subtitle).not.toBe(entry.summary);
+    expect(nativeProps.entry).toBe(entry);
+  });
+});

package/src/Player/__tests__/toNativeMetadata.test.ts

@@ -0,0 +1,77 @@
+import { toNativeMetadata } from "../index";
+
+// `toNativeMetadata` used to be `resolveNativeTitleSubtitle`, which resolved
+// Title/Subtitle from `entry` + `pluginConfiguration` itself (the dot-path /
+// custom-key / fallback logic). That resolution now happens once in
+// `Player.getContent()` (via `resolvePlayerTitleSubtitle`, already covered by
+// `playerUtils/__tests__/resolvePlayerTitleSubtitle.test.ts` and
+// `playerUtils/__tests__/contentDataKeys.test.ts` - custom-key resolution,
+// fallback-when-unresolvable, and entry-non-mutation are all still asserted
+// there). `toNativeMetadata` only adapts the already-resolved
+// `player.getContent()` value into the `metadata` object the native bridge
+// receives, so this file only covers that adaptation: the shape coercion, and
+// the numeric coercion the native bridge specifically needs (it cannot render
+// a number the way `<Text>` can).
+describe("toNativeMetadata", () => {
+  it("returns undefined for both fields when title/summary are null (what the player publishes when there is nothing to show)", () => {
+    expect(toNativeMetadata({ title: null, summary: null })).toEqual({
+      title: undefined,
+      subtitle: undefined,
+    });
+  });
+
+  it("returns undefined for both fields when content itself is undefined", () => {
+    expect(toNativeMetadata(undefined)).toEqual({
+      title: undefined,
+      subtitle: undefined,
+    });
+  });
+
+  it("passes through string title/summary as-is", () => {
+    expect(
+      toNativeMetadata({
+        title: "Resolved Title",
+        summary: "Resolved Summary",
+      })
+    ).toEqual({
+      title: "Resolved Title",
+      subtitle: "Resolved Summary",
+    });
+  });
+
+  it("coerces a numeric title/summary to a string for the native bridge", () => {
+    expect(toNativeMetadata({ title: 0, summary: 42 })).toEqual({
+      title: "0",
+      subtitle: "42",
+    });
+  });
+
+  it("handles title and summary independently (one present, one absent)", () => {
+    expect(toNativeMetadata({ title: "Only Title", summary: null })).toEqual({
+      title: "Only Title",
+      subtitle: undefined,
+    });
+  });
+
+  it("passes the cover image url through", () => {
+    expect(
+      toNativeMetadata({
+        title: "A Title",
+        summary: "A Summary",
+        imageUrl: "https://img.test/base.jpg",
+      })
+    ).toEqual({
+      title: "A Title",
+      subtitle: "A Summary",
+      imageUrl: "https://img.test/base.jpg",
+    });
+  });
+
+  it("sends undefined rather than an empty string when there is no image", () => {
+    // Native treats an empty URI as a load attempt; `undefined` means "none".
+    expect(
+      toNativeMetadata({ title: "A Title", summary: null, imageUrl: null })
+        .imageUrl
+    ).toBeUndefined();
+  });
+});

package/src/Player/index.tsx

@@ -69,6 +69,60 @@ const styles = StyleSheet.create({
   flexImage: { height: "100%", aspectRatio: 1, flex: -1 },
 });
 
+/**
+ * Coerces the resolver's `Option<string | number>` result into what the
+ * native bridge expects: a string, or `undefined` when there is nothing to
+ * send.
+ */
+const toNativeTextProp = (
+  value: Option<string | number>
+): string | undefined =>
+  value === null || value === undefined ? undefined : String(value);
+
+export type NativePlayerMetadata = {
+  title: string | undefined;
+  subtitle: string | undefined;
+  imageUrl: string | undefined;
+};
+
+/**
+ * Adapts the player's resolved Title/Subtitle into the `metadata` object the
+ * *native* view receives.
+ *
+ * The resolution itself (dot-path / key-set logic, entry fallback) does not
+ * happen here - the player manager resolves it and publishes it on its content
+ * channel (`player.getContent()`). This function only coerces that value's
+ * `Option<string | number>` shape into what the native bridge needs: a string,
+ * or `undefined` when there is nothing to send.
+ *
+ * Travels as one `metadata` object rather than two flat props so native has a
+ * single place to look for player-facing text, and so adding a field later
+ * does not widen the bridge's prop surface again.
+ *
+ * This intentionally does not touch `entry` - analytics and the downloads
+ * feature read `entry.title` / `entry.summary` directly and must keep
+ * seeing the original feed values (the downloads feature requires the
+ * original entry title). The resolved (possibly customer-configured) text
+ * travels in `metadata` instead.
+ *
+ * Exported as a plain function (rather than inlined as a class method) so
+ * it can be unit tested directly without rendering the ~37KB `VideoPlayer`
+ * class component.
+ */
+export const toNativeMetadata = (
+  content: Option<{
+    title: Option<string | number>;
+    summary: Option<string | number>;
+    imageUrl?: Option<string>;
+  }>
+): NativePlayerMetadata => ({
+  title: toNativeTextProp(content?.title),
+  subtitle: toNativeTextProp(content?.summary),
+  // Already a string when present; coerced through the same helper so an
+  // empty or nullish value reaches native as `undefined` rather than "".
+  imageUrl: toNativeTextProp(content?.imageUrl),
+});
+
 type VideoPlayerProps = QuickBrickPlayer.PlayerProps & {
   isCasting?: boolean;
   playNextData?: PlayNextData;
@@ -1072,6 +1126,15 @@ export default class VideoPlayer extends React.Component<
     const liveCatchUpEnabled =
       this.props.pluginConfiguration?.liveCatchUpEnabled;
 
+    // Look the player up by id rather than using the active player: these
+    // props are handed to this component's own native player view, so they
+    // must describe that player's content even while a cast session is
+    // running (during which `usePlayer` swaps React consumers over to the
+    // casting receiver).
+    const metadata = toNativeMetadata(
+      playerManager.getPlayerWithId(this.props.playerId)?.getContent()
+    );
+
     const nativeProps = {
       rate: undefined,
       entry,
@@ -1090,6 +1153,7 @@ export default class VideoPlayer extends React.Component<
       liveCatchUpEnabled,
       playerId: this.props.playerId,
       pictureInPictureEnabled,
+      metadata,
       seekStep:
         (this.props.pluginConfiguration?.seek_duration || SEEK_TIME) * 1000,
       accessibilityProps: getAllAccessibilityProps(
@@ -1146,10 +1210,15 @@ export default class VideoPlayer extends React.Component<
       return null;
     }
 
-    const TransportControls = isTV()
+    const isTvPlatform = isTV();
+
+    const TransportControls = isTvPlatform
       ? TransportControlsTV
       : TransportControlsMobile;
 
+    // The mobile and TV transport controls read Title/Subtitle from the
+    // player manager's content channel (via `usePlayerContent`) instead of
+    // receiving them as props.
     const needToShowDefaultControls = !(
       (controls && !castAction?.state?.connected) ||
       this.getPlayNextData()