@applicaster/quick-brick-player 15.1.10-rc.0 → 15.1.11-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/quick-brick-player",
-  "version": "15.1.10-rc.0",
+  "version": "15.1.11-rc.0",
   "description": "Quick Brick Player",
   "main": "./src/index.ts",
   "types": "index.d.ts",
@@ -37,9 +37,9 @@
   "dependencies": {
     "@applicaster/quick-brick-mobile-transport-controls": "15.1.9",
     "@applicaster/quick-brick-tv-transport-controls": "15.1.9",
-    "@applicaster/zapp-react-native-tvos-app": "15.1.10-rc.0",
-    "@applicaster/zapp-react-native-ui-components": "15.1.10-rc.0",
-    "@applicaster/zapp-react-native-utils": "15.1.10-rc.0",
+    "@applicaster/zapp-react-native-tvos-app": "15.1.11-rc.0",
+    "@applicaster/zapp-react-native-ui-components": "15.1.11-rc.0",
+    "@applicaster/zapp-react-native-utils": "15.1.11-rc.0",
     "query-string": "7.1.3",
     "shaka-player": "4.3.5",
     "typeface-montserrat": "^0.0.54",

package/src/Player/PlayerModal/VideoPlayerModal.tsx

@@ -12,6 +12,7 @@ import {
   VIDEO_TRANSITION_THRESHOLD,
 } from "./consts";
 import { useIsTablet } from "@applicaster/zapp-react-native-utils/reactHooks";
+import { useIsTabletLandscape } from "@applicaster/zapp-react-native-utils/reactHooks/device/useMemoizedIsTablet";
 import { PROGRESS_BAR_HEIGHT } from "@applicaster/zapp-react-native-ui-components/Components/VideoModal/ModalAnimation/utils";
 import {
   SafeAreaView,
@@ -100,7 +101,23 @@ export function VideoPlayerModal({
     fullscreen || pip
   );
 
+  /* Landscape is a tablet's regular orientation, so rotating it says nothing
+     about the modal mode. useOrientationEffect skips its orientation effects
+     for the same reason, via the same predicate. */
+  const skipOrientationEffects = useIsTabletLandscape();
+
+  /* Props are the only reconciliation left once the listener below is skipped,
+     and even where it runs, the mount value goes stale: remounting during
+     native fullscreen would otherwise strand the modal in that layout. Rotating
+     a tablet flips the predicate itself, so reconcile then too — the last
+     orientation event may have left the state behind. */
+  React.useEffect(() => {
+    setFullScreenMode(fullscreen || pip);
+  }, [fullscreen, pip, skipOrientationEffects]);
+
   React.useEffect(() => {
+    if (skipOrientationEffects) return;
+
     const listener = addOrientationChangeListener(({ toOrientation }) => {
       /* ignored in collapsed mode non-PiP player */
       if (collapsed && !pip) return;
@@ -110,7 +127,7 @@ export function VideoPlayerModal({
     return () => {
       listener.remove();
     };
-  }, [collapsed, pip]);
+  }, [collapsed, pip, skipOrientationEffects]);
 
   const isFullScreenOrPIP = isFullScreenMode;
 

package/src/Player/PlayerModal/__tests__/VideoPlayerModal.test.tsx

@@ -0,0 +1,160 @@
+import React from "react";
+import { Text } from "react-native";
+import { act, render, screen } from "@testing-library/react-native";
+
+/**
+ * The modal's fullscreen layout is not directly observable, but the collapsed
+ * bar is: it renders only while the modal is NOT in that layout. Every case
+ * below therefore reads `collapsedBarWrapper` as the proxy for the state under
+ * test.
+ *
+ * Why it matters: while the modal sits in the fullscreen layout, a drag still
+ * drives navigation to MINIMIZED, which docks the player and hides the native
+ * controls (see Player/index.tsx `shouldUseNativeControls`). If the layout
+ * cannot follow the mode back out, the modal is stranded on top of the tab bar
+ * with no controls and no way to restore them.
+ */
+
+let mockIsTabletLandscape = false;
+let orientationListener: ((event: any) => void) | null = null;
+const mockRemove = jest.fn();
+
+const mockAddOrientationChangeListener = jest.fn((cb) => {
+  orientationListener = cb;
+
+  return { remove: mockRemove };
+});
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/appUtils/orientationHelper",
+  () => ({
+    addOrientationChangeListener: (cb) => mockAddOrientationChangeListener(cb),
+  })
+);
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/reactHooks/device/useMemoizedIsTablet",
+  () => ({ useIsTabletLandscape: () => mockIsTabletLandscape })
+);
+
+jest.mock("@applicaster/zapp-react-native-utils/reactHooks", () => ({
+  useIsTablet: () => mockIsTabletLandscape,
+}));
+
+jest.mock(
+  "@applicaster/zapp-react-native-ui-components/Components/VideoModal/utils",
+  () => ({ useConfiguration: () => ({ minimised_height: 60 }) })
+);
+
+jest.mock(
+  "@applicaster/zapp-react-native-ui-components/Components/VideoModal/ModalAnimation/utils",
+  () => ({ PROGRESS_BAR_HEIGHT: 3 })
+);
+
+jest.mock("react-native-safe-area-context", () => {
+  const { View } = require("react-native");
+
+  return {
+    SafeAreaView: View,
+    useSafeAreaFrame: () => ({ x: 0, y: 0, width: 1024, height: 768 }),
+    useSafeAreaInsets: () => ({ top: 24, bottom: 34, left: 0, right: 0 }),
+  };
+});
+
+jest.mock("../GestureAnimatedScrollView", () => {
+  const { ScrollView } = require("react-native");
+
+  return { GestureAnimatedScrollView: ScrollView };
+});
+
+jest.mock("../styles", () => ({
+  useStyles: () => ({
+    modal: {},
+    modalWrapper: {},
+    collapsedModalBg: {},
+    modalContent: {},
+    modalContentPiP: {},
+    expandedContentContainer: {},
+    extraContentScrollView: {},
+    collapsedBarContainer: {},
+    collapsedBarWrapper: {},
+    flexNone: {},
+  }),
+}));
+
+jest.mock("../hooks", () => ({
+  useVideoModalState: () => ({
+    collapsed: false,
+    offset: { current: 700 },
+    gestureHandlerProps: {},
+    translateY: new (require("react-native").Animated.Value)(0),
+    expand: jest.fn(),
+  }),
+}));
+
+// eslint-disable-next-line import/first
+import { VideoPlayerModal } from "../VideoPlayerModal";
+
+const renderModal = (props = {}) =>
+  render(
+    <VideoPlayerModal
+      modal
+      content={<Text>content</Text>}
+      collapsedContent={<Text>collapsed</Text>}
+      style={{ width: 1024, height: 768, tabletLandscapeWidth: 600 }}
+      {...props}
+    />
+  );
+
+const collapsedBar = () => screen.queryByTestId("collapsedBarWrapper");
+
+beforeEach(() => {
+  jest.clearAllMocks();
+  orientationListener = null;
+  mockIsTabletLandscape = false;
+});
+
+describe("VideoPlayerModal fullscreen layout", () => {
+  describe("on a tablet in landscape", () => {
+    beforeEach(() => {
+      mockIsTabletLandscape = true;
+    });
+
+    it("leaves the orientation listener alone, since landscape is its regular orientation", () => {
+      renderModal();
+
+      expect(mockAddOrientationChangeListener).not.toHaveBeenCalled();
+    });
+
+    it("follows the mode back out of fullscreen", () => {
+      const { rerender } = renderModal({ fullscreen: true });
+
+      expect(collapsedBar()).toBeNull();
+
+      rerender(
+        <VideoPlayerModal
+          modal
+          fullscreen={false}
+          content={<Text>content</Text>}
+          collapsedContent={<Text>collapsed</Text>}
+          style={{ width: 1024, height: 768, tabletLandscapeWidth: 600 }}
+        />
+      );
+
+      expect(collapsedBar()).not.toBeNull();
+    });
+  });
+
+  describe("on a phone", () => {
+    it("still lets orientation drive the layout", () => {
+      renderModal();
+
+      expect(mockAddOrientationChangeListener).toHaveBeenCalled();
+      expect(collapsedBar()).not.toBeNull();
+
+      act(() => orientationListener?.({ toOrientation: 4 }));
+
+      expect(collapsedBar()).toBeNull();
+    });
+  });
+});

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

@@ -0,0 +1,192 @@
+import VideoPlayer from "../index";
+import { playerManager } from "@applicaster/zapp-react-native-utils/appUtils";
+
+/**
+ * Tests for the track-selection reconciliation logic in `onTracksChanged`.
+ *
+ * The handler uses `resolveReportedTrackId` to prevent an infinite feedback
+ * loop: a transient native "nothing selected" (reported id === undefined)
+ * must NOT clear controlled state when the previous track is still available,
+ * while genuine track changes must still propagate.
+ *
+ * Instances are constructed directly (no render) to keep these tests fast and
+ * focused on the instance method, mirroring the pattern used in
+ * `getNativeProps.test.ts`.
+ */
+
+jest.mock("@applicaster/zapp-react-native-utils/appUtils", () => ({
+  ...jest.requireActual("@applicaster/zapp-react-native-utils/appUtils"),
+  playerManager: {
+    getPlayerWithId: jest.fn(),
+  },
+}));
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/playerUtils/configurationUtils",
+  () => ({
+    parseLanguageTracks: jest.fn(),
+  })
+);
+
+import { parseLanguageTracks } from "@applicaster/zapp-react-native-utils/playerUtils/configurationUtils";
+
+const baseProps = {
+  entry: { id: "1", title: "Entry Title", summary: "Entry Summary" },
+  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 audioTrack = { id: "en-audio", type: "audio" };
+const textTrack = { id: "en-text", type: "text" };
+
+/** Helper: call onTracksChanged with a mocked parseLanguageTracks result. */
+function callOnTracksChanged(
+  instance: VideoPlayer,
+  parsed: {
+    audioTracks?: { id: string; type: string }[];
+    textTracks?: { id: string; type: string }[];
+    audioTrackId?: string | undefined;
+    textTrackId?: string | undefined;
+  }
+) {
+  (parseLanguageTracks as jest.Mock).mockReturnValue({
+    audioTracks: [],
+    textTracks: [],
+    audioTrackId: undefined,
+    textTrackId: undefined,
+    ...parsed,
+  });
+
+  instance.onTracksChanged({ nativeEvent: {} });
+}
+
+describe("onTracksChanged — resolveReportedTrackId reconciliation", () => {
+  beforeEach(() => {
+    (playerManager.getPlayerWithId as jest.Mock).mockReturnValue(null);
+  });
+
+  it("sets audioTrackId and textTrackId when native reports real selections", () => {
+    const instance = new VideoPlayer(baseProps);
+    const setState = jest.spyOn(instance, "setState");
+
+    callOnTracksChanged(instance, {
+      audioTracks: [audioTrack],
+      textTracks: [textTrack],
+      audioTrackId: audioTrack.id,
+      textTrackId: textTrack.id,
+    });
+
+    expect(setState).toHaveBeenCalledWith(
+      expect.objectContaining({
+        audioTrackId: audioTrack.id,
+        textTrackId: textTrack.id,
+      }),
+      expect.any(Function)
+    );
+  });
+
+  it("does NOT clear audioTrackId when native transiently reports undefined and the track is still in the list", () => {
+    const instance = new VideoPlayer(baseProps);
+    // Establish prior selection state without a React reconciler.
+    instance.state = { ...instance.state, audioTrackId: audioTrack.id };
+
+    const setState = jest.spyOn(instance, "setState");
+
+    callOnTracksChanged(instance, {
+      audioTracks: [audioTrack],
+      textTracks: [],
+      audioTrackId: undefined, // transient native blip — nothing selected
+      textTrackId: undefined,
+    });
+
+    // State must NOT change because the resolved id equals the current id.
+    expect(setState).not.toHaveBeenCalled();
+  });
+
+  it("does NOT clear textTrackId when native transiently reports undefined and the track is still in the list", () => {
+    const instance = new VideoPlayer(baseProps);
+    instance.state = { ...instance.state, textTrackId: textTrack.id };
+
+    const setState = jest.spyOn(instance, "setState");
+
+    callOnTracksChanged(instance, {
+      audioTracks: [],
+      textTracks: [textTrack],
+      audioTrackId: undefined,
+      textTrackId: undefined,
+    });
+
+    expect(setState).not.toHaveBeenCalled();
+  });
+
+  it("clears the id when the previously-selected track is no longer present in the list", () => {
+    const instance = new VideoPlayer(baseProps);
+    instance.state = { ...instance.state, audioTrackId: audioTrack.id };
+
+    const setState = jest.spyOn(instance, "setState");
+
+    // Track is gone from the available list.
+    callOnTracksChanged(instance, {
+      audioTracks: [], // track not available anymore
+      textTracks: [],
+      audioTrackId: undefined,
+      textTrackId: undefined,
+    });
+
+    expect(setState).toHaveBeenCalledWith(
+      expect.objectContaining({ audioTrackId: null }),
+      expect.any(Function)
+    );
+  });
+
+  it("propagates a genuine track change to a different id", () => {
+    const newTrack = { id: "fr-audio", type: "audio" };
+    const instance = new VideoPlayer(baseProps);
+    instance.state = { ...instance.state, audioTrackId: audioTrack.id };
+
+    const setState = jest.spyOn(instance, "setState");
+
+    callOnTracksChanged(instance, {
+      audioTracks: [audioTrack, newTrack],
+      textTracks: [],
+      audioTrackId: newTrack.id,
+      textTrackId: undefined,
+    });
+
+    expect(setState).toHaveBeenCalledWith(
+      expect.objectContaining({ audioTrackId: newTrack.id }),
+      expect.any(Function)
+    );
+  });
+
+  it("calls the listener with resolved ids even when state does not change", () => {
+    const instance = new VideoPlayer(baseProps);
+    instance.state = { ...instance.state, audioTrackId: audioTrack.id };
+
+    const onTracksChangedListener = jest.fn();
+
+    (instance as any).props = {
+      ...instance.props,
+      listener: { onTracksChanged: onTracksChangedListener },
+    };
+
+    callOnTracksChanged(instance, {
+      audioTracks: [audioTrack],
+      textTracks: [],
+      audioTrackId: undefined, // transient blip
+      textTrackId: undefined,
+    });
+
+    // notifyListener is called with the resolved (non-null) audioTrackId
+    expect(onTracksChangedListener).toHaveBeenCalledWith(
+      expect.objectContaining({ audioTrackId: audioTrack.id })
+    );
+  });
+});

package/src/Player/index.tsx

@@ -148,6 +148,38 @@ type VideoPlayerProps = QuickBrickPlayer.PlayerProps & {
   children?: React.ReactNode;
 };
 
+/**
+ * `textTrackId`/`audioTrackId` are both the value the native player *reports* as
+ * currently selected AND the *controlled prop* that drives native selection.
+ * Because of that dual role, reflecting a reported value straight back down turns
+ * a status update into a command.
+ *
+ * The native player can momentarily report "nothing selected" (index -1, which
+ * `parseLanguageTracks` maps to `undefined`) during normal fMP4/ABR segment
+ * transitions. Pushing that back down as a "disable"/"clear" command flips native
+ * state, which emits a fresh onTracksChanged, which we would echo again — an
+ * infinite feedback loop.
+ *
+ * Keep the current selection when the reported value is a transient drop and the
+ * chosen track is still available. A genuine user "Off"/change already updates the
+ * controlled state first, so this only ignores unsolicited native status blips.
+ */
+const resolveReportedTrackId = (
+  reportedId: string | null | undefined,
+  currentId: string | null,
+  tracks: { id: string }[] = []
+): string | null => {
+  if (reportedId) {
+    return reportedId;
+  }
+
+  if (currentId && tracks.some((track) => track?.id === currentId)) {
+    return currentId;
+  }
+
+  return null;
+};
+
 export default class VideoPlayer extends React.Component<
   VideoPlayerProps,
   QuickBrickPlayer.NativePlayerState & {
@@ -697,20 +729,50 @@ export default class VideoPlayer extends React.Component<
     const { textTracks, audioTracks, audioTrackId, textTrackId } =
       parseLanguageTracks(nativeEvent);
 
-    this.setState(
-      {
-        audioTrackId,
-        textTrackId,
-      },
-      () => {
-        this.props?.listener?.onTracksChanged?.({
-          textTracks,
-          audioTracks,
-          audioTrackId,
-          textTrackId,
-        });
-      }
+    // Resolve the reported selection against the current controlled state so a
+    // transient native "nothing selected" doesn't get echoed back as a command
+    // and re-trigger native selection (infinite loop, see resolveReportedTrackId).
+    const nextAudioTrackId = resolveReportedTrackId(
+      audioTrackId,
+      this.state.audioTrackId,
+      audioTracks
+    );
+
+    const nextTextTrackId = resolveReportedTrackId(
+      textTrackId,
+      this.state.textTrackId,
+      textTracks
     );
+
+    const notifyListener = () =>
+      this.props?.listener?.onTracksChanged?.({
+        textTracks,
+        audioTracks,
+        audioTrackId: nextAudioTrackId,
+        textTrackId: nextTextTrackId,
+      });
+
+    // Only update state (and thus re-send the controlled props) on a real change.
+    // Re-rendering with identical prop values would otherwise keep the native
+    // event/prop echo alive.
+    const stateChanges: {
+      audioTrackId?: string | null;
+      textTrackId?: string | null;
+    } = {};
+
+    if (nextAudioTrackId !== this.state.audioTrackId) {
+      stateChanges.audioTrackId = nextAudioTrackId;
+    }
+
+    if (nextTextTrackId !== this.state.textTrackId) {
+      stateChanges.textTrackId = nextTextTrackId;
+    }
+
+    if (Object.keys(stateChanges).length > 0) {
+      this.setState(stateChanges as any, notifyListener);
+    } else {
+      notifyListener();
+    }
   };
 
   onVideoProgress = ({ nativeEvent }) => {