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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/quick-brick-player",
-  "version": "15.1.10-rc.0",
+  "version": "15.1.11-alpha.7557142055",
   "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-alpha.7557142055",
+    "@applicaster/zapp-react-native-ui-components": "15.1.11-alpha.7557142055",
+    "@applicaster/zapp-react-native-utils": "15.1.11-alpha.7557142055",
     "query-string": "7.1.3",
     "shaka-player": "4.3.5",
     "typeface-montserrat": "^0.0.54",

package/src/Player/AudioLayer/AudioPlayerWrapper.tsx

@@ -12,23 +12,18 @@ import { useNavigation } from "@applicaster/zapp-react-native-utils/reactHooks";
 import { createLogger } from "@applicaster/zapp-react-native-utils/logger";
 import { PlayNextData } from "@applicaster/zapp-react-native-ui-components/Components/PlayerContainer/PlayerContainer";
 import { formatSpeed } from "./utils";
-import {
-  getBottomSheetModalDefaultItemIcon,
-  getBottomSheetModalIconProps,
-  getBottomSheetModalItemProps,
-  getBottomSheetModalLabelProps,
-  getBottomSheetModalSelectedItemIcon,
-} from "../Utils";
 
 import { toNumberWithDefault } from "@applicaster/zapp-react-native-utils/numberUtils";
-
 import { DEFAULT_SPEED, PlaybackSpeed, SpeedController } from "./SpeedManager";
 import {
   dismissModal as dismissBottomSheetModal,
-  openBottomSheetModal,
   useModalStoreState,
 } from "@applicaster/zapp-react-native-utils/modalState";
-import { speedOptions } from "../Const/speedOptions";
+import { uiActionsRegistry } from "@applicaster/zapp-react-native-utils/uiActionsRegistrator";
+import {
+  PLAYER_ACTION_IDENTIFIERS,
+  registerPlayerActions,
+} from "./playerActions";
 
 const { log_debug } = createLogger({
   subsystem: "UIComponent",
@@ -118,6 +113,14 @@ export const AudioPlayerWrapper: React.FC<Props> = (props: Props) => {
     setSpeedManager(player ? new SpeedController(player) : null);
   }, [player]);
 
+  useEffect(() => {
+    if (!speedManager || playerState.isLive) {
+      return;
+    }
+
+    return registerPlayerActions({ speedController: speedManager });
+  }, [speedManager, playerState.isLive]);
+
   useEffect(() => {
     if (!player) return;
 
@@ -216,36 +219,11 @@ export const AudioPlayerWrapper: React.FC<Props> = (props: Props) => {
     player?.forward(seekDuration);
   }, [seekDuration, player]);
 
-  const onSpeedSelect = React.useCallback(
-    async (item) => {
-      await speedManager?.setPlaybackSpeed(item);
-    },
-    [speedManager]
-  );
-
   const onSpeedButtonPress = React.useCallback(() => {
-    openBottomSheetModal({
-      modalBottomSheetContentProps: {
-        items: speedOptions,
-        current_selection: playbackSpeed,
-        onPress: onSpeedSelect,
-        title: configuration.playback_speed_title,
-        itemProps: getBottomSheetModalItemProps,
-        iconProps: getBottomSheetModalIconProps,
-        labelProps: getBottomSheetModalLabelProps,
-        getSelectedItemIcon: getBottomSheetModalSelectedItemIcon,
-        getDefaultItemIcon: getBottomSheetModalDefaultItemIcon,
-        iconPlacement: "right",
-      },
-      options: {
-        supportedOrientations: [
-          "portrait",
-          "landscape",
-          "portrait-upside-down",
-        ],
-      },
-    });
-  }, [playbackSpeed, onSpeedSelect, configuration.playback_speed_title]);
+    uiActionsRegistry
+      .getAction(PLAYER_ACTION_IDENTIFIERS.PLAYBACK_SPEED)
+      ?.invokeAction(entry);
+  }, [entry]);
 
   const onPlayerSeek = React.useCallback(
     (targetTime: number) => {

package/src/Player/AudioLayer/Layout/Controls/index.tsx

@@ -2,10 +2,7 @@ import * as React from "react";
 import { StyleSheet, View } from "react-native";
 
 import { dayjs } from "@applicaster/zapp-react-native-utils/dateUtils";
-import {
-  useIsTablet,
-  useZStore,
-} from "@applicaster/zapp-react-native-utils/reactHooks";
+import { useIsTablet } from "@applicaster/zapp-react-native-utils/reactHooks";
 import {
   Controls as MobileTransportControls,
   ProgressBar,
@@ -100,11 +97,8 @@ export const Controls = (props: Props) => {
     maxWidth = 320,
   } = props;
 
-  const configuration = useZStore("playerConfiguration");
-
   const { sleepTimerState, onSleepButtonPress } = useSleepTimerModal(
-    playerManager.getActivePlayer(),
-    configuration
+    playerManager.getActivePlayer()
   );
 
   const { hasNext, hasPrevious, goNext, goPrevious } = usePlaylistNavigation(

package/src/Player/AudioLayer/SleepTimerManager.ts

@@ -41,6 +41,10 @@ export class SleepTimerController {
     return this.sleepTimerStateSubject.asObservable();
   }
 
+  get currentState(): SleepTimerState {
+    return this.sleepTimerStateSubject.getValue();
+  }
+
   private async scheduleSleep(sleepDate): Promise<boolean> {
     log_debug(`Setting sleep interval to ${sleepDate}`);
 
@@ -118,7 +122,7 @@ export class SleepTimerController {
 
     log_debug("Sleep state restored");
 
-    this.setSleepTimer(item as SleepTimer, futureSleepDate);
+    await this.setSleepTimer(item as SleepTimer, futureSleepDate);
   }
 
   // Will be called if user closed the player explicitly.

package/src/Player/AudioLayer/SpeedManager.ts

@@ -33,6 +33,10 @@ export class SpeedController {
     return this.playbackSpeedSubject.asObservable();
   }
 
+  get currentSpeed(): PlaybackSpeed {
+    return this.playbackSpeedSubject.getValue();
+  }
+
   async loadSpeed() {
     const speed = await localStorage.getItem(SPEED_PREFERENCE_KEY, NAMESPACE);
 

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

@@ -0,0 +1,78 @@
+import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
+import { SLEEP_TIMER_OFF, SleepTimerController } from "../SleepTimerManager";
+
+jest.mock(
+  "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage",
+  () => ({
+    localStorage: {
+      getItem: jest.fn(),
+      setItem: jest.fn(),
+      removeItem: jest.fn(),
+    },
+  })
+);
+
+describe("SleepTimerController", () => {
+  const player = {
+    startSleepTimer: jest.fn(),
+    cancelSleepTimer: jest.fn(),
+  };
+
+  let sleepController: SleepTimerController;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    (localStorage.setItem as jest.Mock).mockResolvedValue(undefined);
+    (localStorage.removeItem as jest.Mock).mockResolvedValue(undefined);
+    (localStorage.getItem as jest.Mock).mockResolvedValue(undefined);
+    sleepController = new SleepTimerController(player as any);
+  });
+
+  it("starts from the off state", () => {
+    expect(sleepController.currentState.timer).toEqual(SLEEP_TIMER_OFF);
+  });
+
+  it("starts a sleep timer on the constructed player", async () => {
+    await sleepController.setSleepTimer({
+      label: "15 minutes",
+      value: 15,
+    });
+
+    expect(player.cancelSleepTimer).toHaveBeenCalled();
+    expect(player.startSleepTimer).toHaveBeenCalled();
+    expect(sleepController.currentState.timer.value).toBe(15);
+  });
+
+  it("loadSleep restores an unexpired timer", async () => {
+    const futureSleepDate = Date.now() + 60 * 1000;
+
+    (localStorage.getItem as jest.Mock).mockResolvedValue({
+      label: "15 minutes",
+      value: 15,
+      futureSleepDate,
+    });
+
+    player.startSleepTimer.mockClear();
+
+    await sleepController.loadSleep();
+
+    expect(player.startSleepTimer).toHaveBeenCalledWith(futureSleepDate);
+    expect(sleepController.currentState.timer.value).toBe(15);
+  });
+
+  it("loadSleep drops an expired timer without starting a native timer", async () => {
+    (localStorage.getItem as jest.Mock).mockResolvedValue({
+      label: "15 minutes",
+      value: 15,
+      futureSleepDate: Date.now() - 1000,
+    });
+
+    player.startSleepTimer.mockClear();
+
+    await sleepController.loadSleep();
+
+    expect(player.startSleepTimer).not.toHaveBeenCalled();
+    expect(localStorage.removeItem).toHaveBeenCalled();
+    expect(sleepController.currentState.timer).toEqual(SLEEP_TIMER_OFF);
+  });
+});

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

@@ -0,0 +1,57 @@
+import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
+import { DEFAULT_SPEED, SpeedController } from "../SpeedManager";
+
+jest.mock(
+  "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage",
+  () => ({
+    localStorage: {
+      getItem: jest.fn(),
+      setItem: jest.fn(),
+      removeItem: jest.fn(),
+    },
+  })
+);
+
+describe("SpeedController", () => {
+  const player = { setPlaybackRate: jest.fn() };
+  let speedController: SpeedController;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    (localStorage.setItem as jest.Mock).mockResolvedValue(undefined);
+    (localStorage.getItem as jest.Mock).mockResolvedValue(undefined);
+    speedController = new SpeedController(player as any);
+  });
+
+  it("requires a player in the constructor", () => {
+    expect(speedController.currentSpeed).toEqual(DEFAULT_SPEED);
+  });
+
+  it("applies playback speed on the constructed player", async () => {
+    await speedController.setPlaybackSpeed({
+      asset: "speed_1_5",
+      value: 1.5,
+    });
+
+    expect(player.setPlaybackRate).toHaveBeenCalledWith(1.5);
+
+    expect(speedController.currentSpeed).toEqual({
+      asset: "speed_1_5",
+      value: 1.5,
+    });
+  });
+
+  it("loadSpeed restores a stored rate onto the player", async () => {
+    (localStorage.getItem as jest.Mock).mockResolvedValue({
+      asset: "speed_1_5",
+      value: 1.5,
+    });
+
+    player.setPlaybackRate.mockClear();
+
+    await speedController.loadSpeed();
+
+    expect(player.setPlaybackRate).toHaveBeenCalledWith(1.5);
+    expect(speedController.currentSpeed.value).toBe(1.5);
+  });
+});

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

@@ -0,0 +1,342 @@
+import { playerManager } from "@applicaster/zapp-react-native-utils/appUtils";
+import {
+  actionExecutor,
+  ActionResult,
+} from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutor";
+import { uiActionsRegistry } from "@applicaster/zapp-react-native-utils/uiActionsRegistrator";
+import { modalOrchestrator } from "@applicaster/zapp-react-native-utils/modalState/ModalOrchestrator";
+import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
+import { firstValueFrom } from "rxjs";
+
+import {
+  PLAYER_ACTION_IDENTIFIERS,
+  PLAYER_ACTION_TYPES,
+  registerPlayerActions,
+} from "../playerActions";
+import { SpeedController } from "../SpeedManager";
+import { SleepTimerController } from "../SleepTimerManager";
+
+jest.mock("../../Const/sleepTimerOptions", () => ({
+  getSleepTimerOptions: (offLabel: string, sleepTimerValue: number | null) => [
+    sleepTimerValue ? { label: offLabel, value: 0 } : null,
+    { label: "5 minutes", value: 5 },
+    { label: "15 minutes", value: 15 },
+  ],
+}));
+
+jest.mock("@applicaster/zapp-react-native-utils/appUtils", () => ({
+  playerManager: {
+    getActivePlayer: jest.fn(),
+  },
+}));
+
+jest.mock(
+  "@applicaster/zapp-react-native-utils/modalState/ModalOrchestrator",
+  () => ({
+    modalOrchestrator: {
+      close: jest.fn(),
+      stackSize: 0,
+    },
+  })
+);
+
+jest.mock(
+  "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage",
+  () => ({
+    localStorage: {
+      getItem: jest.fn(),
+      setItem: jest.fn(),
+      removeItem: jest.fn(),
+    },
+  })
+);
+
+describe("playerActions", () => {
+  const openedSheets: ActionType[] = [];
+
+  let player: {
+    getConfig: () => Record<string, string>;
+    setPlaybackRate: jest.Mock;
+    startSleepTimer: jest.Mock;
+    cancelSleepTimer: jest.Mock;
+  };
+
+  let speedController: SpeedController;
+  let sleepController: SleepTimerController;
+  let unregisterPlayerActions: () => void;
+
+  beforeEach(() => {
+    openedSheets.length = 0;
+    jest.clearAllMocks();
+    (localStorage.setItem as jest.Mock).mockResolvedValue(undefined);
+    (localStorage.removeItem as jest.Mock).mockResolvedValue(undefined);
+
+    player = {
+      getConfig: () => ({
+        playback_speed_title: "Playback Speed",
+        playback_sleep_title: "Sleep Timer",
+        playback_sleep_off_label: "Off",
+        sleep_timer: "sleep_timer",
+        sleep_timer_active: "sleep_timer_active",
+      }),
+      setPlaybackRate: jest.fn(),
+      startSleepTimer: jest.fn(),
+      cancelSleepTimer: jest.fn(),
+    };
+
+    (playerManager.getActivePlayer as jest.Mock).mockReturnValue(player);
+    speedController = new SpeedController(player as any);
+    sleepController = new SleepTimerController(player as any);
+
+    [
+      "openBottomSheet",
+      PLAYER_ACTION_TYPES.OPEN_PLAYBACK_SPEED,
+      PLAYER_ACTION_TYPES.OPEN_SLEEP_TIMER,
+      PLAYER_ACTION_TYPES.SET_PLAYBACK_SPEED,
+      PLAYER_ACTION_TYPES.SET_SLEEP_TIMER,
+    ].forEach((type) => actionExecutor.unregisterAction(type));
+
+    actionExecutor.registerAction("openBottomSheet", async (action) => {
+      openedSheets.push(action);
+
+      return ActionResult.Success;
+    });
+
+    unregisterPlayerActions = registerPlayerActions({
+      speedController,
+      sleepController,
+    });
+  });
+
+  afterEach(() => {
+    unregisterPlayerActions?.();
+  });
+
+  it("does not register actions until a player controller is provided", async () => {
+    unregisterPlayerActions();
+    unregisterPlayerActions = registerPlayerActions({});
+
+    const result = await actionExecutor.handleAction({
+      type: PLAYER_ACTION_TYPES.SET_PLAYBACK_SPEED,
+      options: { value: 1.5, dismissSheet: true },
+    });
+
+    expect(result).toBeUndefined();
+    expect(player.setPlaybackRate).not.toHaveBeenCalled();
+
+    expect(
+      uiActionsRegistry.getAction(PLAYER_ACTION_IDENTIFIERS.PLAYBACK_SPEED)
+    ).toBeUndefined();
+
+    expect(
+      uiActionsRegistry.getAction(PLAYER_ACTION_IDENTIFIERS.SLEEP_TIMER)
+    ).toBeUndefined();
+  });
+
+  it("unregisters player actions when the player goes away", async () => {
+    unregisterPlayerActions();
+
+    expect(
+      uiActionsRegistry.getAction(PLAYER_ACTION_IDENTIFIERS.PLAYBACK_SPEED)
+    ).toBeUndefined();
+
+    const result = await actionExecutor.handleAction({
+      type: PLAYER_ACTION_TYPES.SET_PLAYBACK_SPEED,
+      options: { value: 1.5 },
+    });
+
+    expect(result).toBeUndefined();
+    expect(player.setPlaybackRate).not.toHaveBeenCalled();
+  });
+
+  it("opens playback speed through openBottomSheet with the current speed selected", async () => {
+    await speedController.setPlaybackSpeed({
+      asset: "speed_1",
+      value: 1,
+    });
+
+    const result = await actionExecutor.handleAction({
+      type: PLAYER_ACTION_TYPES.OPEN_PLAYBACK_SPEED,
+    });
+
+    expect(result).toBe(ActionResult.Success);
+
+    const sheet = openedSheets[0];
+
+    expect(sheet.options.replace).toBe(true);
+    expect(sheet.options.header.title).toBe("Playback Speed");
+    expect(sheet.options.content.role).toBe("collection_selector");
+    expect(sheet.options.content.behavior.currentSelection).toEqual(["1"]);
+
+    expect(sheet.options.content.items.map((item) => item.title)).toEqual([
+      "0.8x",
+      "1x",
+      "1.2x",
+      "1.5x",
+      "2x",
+    ]);
+
+    expect(
+      sheet.options.content.items[0].extensions.tap_actions.actions[0].options
+        .dismissSheet
+    ).toBe(true);
+  });
+
+  it("opens sleep timer with the ticking countdown header", async () => {
+    const timerDate = Date.now() + 15 * 60 * 1000;
+
+    await sleepController.setSleepTimer(
+      { label: "15 minutes", value: 15 },
+      timerDate
+    );
+
+    const result = await actionExecutor.handleAction({
+      type: PLAYER_ACTION_TYPES.OPEN_SLEEP_TIMER,
+    });
+
+    expect(result).toBe(ActionResult.Success);
+
+    const sheet = openedSheets[0];
+
+    expect(sheet.options.replace).toBe(true);
+    expect(sheet.options.header.title).toBe("Sleep Timer");
+    expect(sheet.options.header.subtitle).toBeUndefined();
+    expect(sheet.options.content.behavior.currentSelection).toEqual(["15"]);
+
+    expect(
+      sheet.options.content.items[0].extensions.tap_actions.actions[0].type
+    ).toBe(PLAYER_ACTION_TYPES.SET_SLEEP_TIMER);
+  });
+
+  it("setPlaybackSpeed applies the rate and closes the sheet when opened from the picker", async () => {
+    const result = await actionExecutor.handleAction({
+      type: PLAYER_ACTION_TYPES.SET_PLAYBACK_SPEED,
+      options: { value: 1.5, dismissSheet: true },
+    });
+
+    expect(result).toBe(ActionResult.Success);
+    expect(player.setPlaybackRate).toHaveBeenCalledWith(1.5);
+    expect(localStorage.setItem).toHaveBeenCalled();
+    expect(modalOrchestrator.close).toHaveBeenCalled();
+  });
+
+  it("setSleepTimer starts the timer, writes storage, and closes the sheet", async () => {
+    const result = await actionExecutor.handleAction({
+      type: PLAYER_ACTION_TYPES.SET_SLEEP_TIMER,
+      options: { value: 15, label: "15 minutes", dismissSheet: true },
+    });
+
+    expect(result).toBe(ActionResult.Success);
+    expect(player.startSleepTimer).toHaveBeenCalled();
+    expect(localStorage.setItem).toHaveBeenCalled();
+    expect(modalOrchestrator.close).toHaveBeenCalled();
+    expect(sleepController.currentState.timer.value).toBe(15);
+  });
+
+  it("setSleepTimer with value 0 cancels the timer", async () => {
+    await sleepController.setSleepTimer({
+      label: "15 minutes",
+      value: 15,
+    });
+
+    player.cancelSleepTimer.mockClear();
+    (localStorage.removeItem as jest.Mock).mockClear();
+    (modalOrchestrator.close as jest.Mock).mockClear();
+
+    const result = await actionExecutor.handleAction({
+      type: PLAYER_ACTION_TYPES.SET_SLEEP_TIMER,
+      options: { value: 0, label: "Off", dismissSheet: true },
+    });
+
+    expect(result).toBe(ActionResult.Success);
+    expect(player.cancelSleepTimer).toHaveBeenCalled();
+    expect(localStorage.removeItem).toHaveBeenCalled();
+    expect(sleepController.currentState.timer.value).toBe(0);
+    expect(modalOrchestrator.close).toHaveBeenCalled();
+  });
+
+  it.each([undefined, "foo"])(
+    "rejects invalid setPlaybackSpeed value %p",
+    async (value) => {
+      player.setPlaybackRate.mockClear();
+      (localStorage.setItem as jest.Mock).mockClear();
+
+      const result = await actionExecutor.handleAction({
+        type: PLAYER_ACTION_TYPES.SET_PLAYBACK_SPEED,
+        options: { value, dismissSheet: true },
+      });
+
+      expect(result).toBe(ActionResult.Error);
+      expect(player.setPlaybackRate).not.toHaveBeenCalled();
+      expect(localStorage.setItem).not.toHaveBeenCalled();
+      expect(modalOrchestrator.close).not.toHaveBeenCalled();
+    }
+  );
+
+  it.each([undefined, "foo"])(
+    "rejects invalid setSleepTimer value %p",
+    async (value) => {
+      const result = await actionExecutor.handleAction({
+        type: PLAYER_ACTION_TYPES.SET_SLEEP_TIMER,
+        options: { value, dismissSheet: true },
+      });
+
+      expect(result).toBe(ActionResult.Error);
+      expect(player.startSleepTimer).not.toHaveBeenCalled();
+      expect(localStorage.setItem).not.toHaveBeenCalled();
+      expect(modalOrchestrator.close).not.toHaveBeenCalled();
+    }
+  );
+
+  it("does not close an unrelated sheet when setPlaybackSpeed is invoked standalone", async () => {
+    const result = await actionExecutor.handleAction({
+      type: PLAYER_ACTION_TYPES.SET_PLAYBACK_SPEED,
+      options: { value: 1.5 },
+    });
+
+    expect(result).toBe(ActionResult.Success);
+    expect(player.setPlaybackRate).toHaveBeenCalledWith(1.5);
+    expect(modalOrchestrator.close).not.toHaveBeenCalled();
+  });
+
+  it("initialEntryState for sleep-timer reflects an active timer", async () => {
+    await sleepController.setSleepTimer({
+      label: "15 minutes",
+      value: 15,
+    });
+
+    const action = uiActionsRegistry.getAction(
+      PLAYER_ACTION_IDENTIFIERS.SLEEP_TIMER
+    );
+
+    expect(action.initialEntryState({} as ZappEntry)).toMatchObject({
+      state: 1,
+      asset: "sleep_timer_active",
+      label: "Sleep Timer",
+    });
+
+    const observed = await firstValueFrom(
+      action.observeEntryState({} as ZappEntry)
+    );
+
+    expect(observed).toMatchObject({
+      state: 1,
+      asset: "sleep_timer_active",
+    });
+  });
+
+  it("registers UI action identifiers that open the matching sheets", async () => {
+    await uiActionsRegistry
+      .getAction(PLAYER_ACTION_IDENTIFIERS.PLAYBACK_SPEED)
+      .invokeAction({} as ZappEntry);
+
+    await uiActionsRegistry
+      .getAction(PLAYER_ACTION_IDENTIFIERS.SLEEP_TIMER)
+      .invokeAction({} as ZappEntry);
+
+    expect(openedSheets.map((action) => action.options.header.title)).toEqual([
+      "Playback Speed",
+      "Sleep Timer",
+    ]);
+  });
+});