@applicaster/zapp-react-native-utils 13.0.0-alpha.7210171818 → 13.0.0-alpha.7330390362

package/reactHooks/player/TVSeekControlller/TVSeekController.ts

@@ -1,12 +1,15 @@
 import { BehaviorSubject } from "rxjs";
 import { TapSeekController } from "./TapSeekController";
 import { LongPressSeekController } from "./LongPressSeekController";
-import { playerManager } from "../../../appUtils";
 import { SEEK_TYPE } from "../const";
 import { createLogger } from "../../../logger";
 import { Player } from "../../../appUtils/playerManager/player";
 import { SeekKeyHandlerListener } from "../../../appUtils/keyInputHandler/KeyInputHandler";
-import { ISeekController } from "./ISeekController";
+import {
+  ISeekController,
+  ISeekControllerDelegate,
+  SeekIncrementalBaseStrategy,
+} from "./ISeekController";
 
 export const { log_warning, log_debug, log_info, log_error, log_verbose } =
   createLogger({
@@ -19,70 +22,87 @@ export enum SEEK_STRATEGY {
   AUTO_SEEK = "AUTO_SEEK",
 }
 
-export class TVSeekController implements SeekKeyHandlerListener {
-  // -- SHARED STATE ACROSS STRATEGIES --
-  public currentSeekType: SEEK_TYPE | null = null;
-  public delayedSeekOffset: number | null = null;
-  private controller: Player;
+const CONFIG_TAP_SEEK = {
+  CLICKS_BEFORE_PAUSE: 0,
+};
+
+const CONFIG_LONG_PRESS = {
+  TIMER_INTERVAL_MS: 200,
+};
+
+const LONG_PRESS_THRESHOLD = 500;
+const SEEK_END_TIMEOUT_DURATION = 700;
+// prettier-ignore
+
+export class TVSeekController
+  implements SeekKeyHandlerListener, ISeekControllerDelegate {
+  public delayedSeekPosition: number | null = null;
+  private readonly playerController: Player;
   private delayedSeekProgressSubject = new BehaviorSubject<number | null>(null);
+  isPlayerInitiallyPaused: null | boolean = null;
+  currentSeekType: SEEK_TYPE | null = null;
 
   private currentSeekController: ISeekController;
-
-  // -- STRATEGY INSTANCES --
-  private tapSeekController: TapSeekController;
-  private longPressSeekController: LongPressSeekController;
+  private readonly tapSeekController: TapSeekController;
+  private readonly longPressSeekController: LongPressSeekController;
   private longPressThresholdTimeout: any | null = null;
+  private seekEndTimeout: any | null = null;
 
-  // Example config for long press
-  private config = {
-    LONG_PRESS_THRESHOLD: 500,
-    TIMER_INTERVAL_MS: 300,
-    SKIP_INCREMENT_STEP: 5,
-    MAX_SKIP_PER_TICK: 300,
-    INITIAL_SKIP_AMOUNT: 10,
-  };
+  constructor(playerController: Player) {
+    this.playerController = playerController;
 
-  constructor(controller: Player) {
-    this.controller = controller;
-    this.tapSeekController = new TapSeekController(this);
+    this.tapSeekController = new TapSeekController(
+      this,
+      new SeekIncrementalBaseStrategy(),
+      CONFIG_TAP_SEEK
+    );
 
     this.longPressSeekController = new LongPressSeekController(
       this,
-      this.config
+      new SeekIncrementalBaseStrategy(),
+      CONFIG_LONG_PRESS
     );
+
+    this.currentSeekController = this.tapSeekController;
   }
 
   getDelayedSeekProgressObservable = () => {
     return this.delayedSeekProgressSubject;
-  }
+  };
 
   setStrategy = (seekStrategy: SEEK_STRATEGY) => {
     switch (seekStrategy) {
       case SEEK_STRATEGY.TAP_SEEK:
-        clearTimeout(this.longPressThresholdTimeout);
-        this.longPressThresholdTimeout = null;
         this.currentSeekController = this.tapSeekController;
+        log_debug("TVSeekController: setStrategy - TAP_SEEK");
 
         break;
       case SEEK_STRATEGY.AUTO_SEEK:
-        this.currentSeekController.reset();
         this.currentSeekController = this.longPressSeekController;
+        log_debug("TVSeekController: setStrategy - AUTO_SEEK");
+
         break;
       default:
     }
-  }
+  };
 
   handleStartSeek = (seekType: SEEK_TYPE) => {
+    this.currentSeekType = seekType;
+
+    if (this.isPlayerInitiallyPaused === null) {
+      this.isPlayerInitiallyPaused = this.playerController.isPaused();
+    }
+
+    this.clearLongPressThresholdTimeout();
+    this.clearSeekCompleteTimeout();
     this.setStrategy(SEEK_STRATEGY.TAP_SEEK);
     this.currentSeekController.onStartSeek(seekType);
-    log_verbose(`handleStartSeek: TAP seekType: ${seekType}`);
 
     this.longPressThresholdTimeout = setTimeout(() => {
-      log_verbose(`handleStartSeek: longPressThresholdTimeout:  TIMEOUT, START AUTO_SEEK seekType: ${seekType}`);
-     this.setStrategy(SEEK_STRATEGY.AUTO_SEEK);
+      this.setStrategy(SEEK_STRATEGY.AUTO_SEEK);
       this.currentSeekController.onStartSeek(seekType);
-    }, this.config.LONG_PRESS_THRESHOLD);
-  }
+    }, LONG_PRESS_THRESHOLD);
+  };
 
   onForwardPress = (): boolean => {
     this.handleStartSeek(SEEK_TYPE.FORWARD);
@@ -97,103 +117,142 @@ export class TVSeekController implements SeekKeyHandlerListener {
   };
 
   onSeekEnd = () => {
+    this.clearLongPressThresholdTimeout();
     this.currentSeekController.onSeekEnd();
-    this.setStrategy(SEEK_STRATEGY.TAP_SEEK);
-  }
+  };
 
   onRewindPressOut = () => {
-    const isAutoSeek = this.currentSeekController === this.longPressSeekController;
-
-    log_verbose(`handleStartSeek: onRewindPressOut, isAutoSeek: ${isAutoSeek}`);
-
     this.onSeekEnd();
-  }
+  };
 
   onForwardPressOut = () => {
-    const isAutoSeek = this.currentSeekController === this.longPressSeekController;
-
-    log_verbose(`handleStartSeek: onForwardPressOut, isAutoSeek: ${isAutoSeek}`);
     this.onSeekEnd();
-  }
+  };
 
-  // ---------------------------
-  // SHARED METHODS
-  // ---------------------------
+  onVideoProgress = (position: number) => {
+    if (this.delayedSeekPosition !== null) {
+      return;
+    }
 
-  /** Called by either strategy to accumulate offset while paused. */
-  handleDelayedSeek(eventType: SEEK_TYPE, skipTime: number) {
-    const player = this.getPlayer();
-    if (!player) return;
+    this.delayedSeekProgressSubject.next(position);
+  };
 
-    // If not previously delayed, we pause the first time
-    if (this.delayedSeekOffset === null) {
-      this.pausePlayer();
-    }
+  handleDelayedSeek = (offset: number = 0) => {
+    this.handlePlayerPause();
+
+    const currentPos =
+      this.delayedSeekPosition === null
+        ? this.playerController.getPosition()
+        : this.delayedSeekPosition;
 
-    const newOffset = (this.delayedSeekOffset || 0) + skipTime;
-    const currentPos = player.getPosition();
     let targetPos = currentPos;
 
-    if (eventType === SEEK_TYPE.FORWARD) {
-      targetPos = Math.min(currentPos + newOffset, player.getDuration());
+    if (this.currentSeekType === SEEK_TYPE.FORWARD) {
+      targetPos = Math.min(
+        currentPos + offset,
+        this.playerController.getSeekableDuration()
+      );
+    } else if (this.currentSeekType === SEEK_TYPE.REWIND) {
+      targetPos = Math.max(0, currentPos - offset);
     } else {
-      targetPos = Math.max(0, currentPos - newOffset);
+      log_warning(
+        `TVSeekController: handleDelayedSeek - invalid seek type: ${this.currentSeekType}`
+      );
     }
 
-    this.delayedSeekOffset = newOffset;
-
     log_debug(
-      `TVSeekController: handleDelayedSeek - targetPos: ${targetPos}, offset: ${newOffset}, skipTime: ${skipTime}`
+      `TVSeekController: handleDelayedSeek - targetPos: ${targetPos}, skipTime: ${offset}`
     );
 
+    const prevValue = this.delayedSeekProgressSubject.getValue();
+
+    if (prevValue !== null) {
+      const delta = Math.abs(prevValue - targetPos);
+
+      if (delta < 1) {
+        return;
+      }
+    }
+
+    this.delayedSeekPosition = targetPos;
     this.delayedSeekProgressSubject.next(targetPos);
-  }
+  };
 
-  seekPlayer(offset: number) {
-    const player = this.getPlayer();
-    if (!player || !this.currentSeekType) return;
-    player[this.currentSeekType](offset);
-    this.playerPlay();
-  }
+  handleSeekTo = (newPosition: number) => {
+    this.playerController.seekTo(newPosition);
 
-  playerPlay() {
-    const player = this.getPlayer();
-    if (!player) return;
+    if (!this.isPlayerInitiallyPaused) {
+      this.playerController.play();
+    }
+  };
 
-    if (player.isPaused()) {
-      player.play();
+  handleSeek = (offset: number) => {
+    this.playerController[this.currentSeekType](offset);
+
+    if (!this.isPlayerInitiallyPaused) {
+      this.playerController.play();
     }
-  }
+  };
 
-  pausePlayer() {
-    const player = this.getPlayer();
-    if (!player) return;
-    player.pause();
-  }
+  handleSeekComplete = () => {
+    this.clearSeekCompleteTimeout();
+
+    this.seekEndTimeout = setTimeout(() => {
+      if (this.delayedSeekPosition !== null) {
+        this.handleSeekTo(this.delayedSeekPosition);
+      }
+
+      log_debug(
+        `handleSeekComplete: Seek finished, type: ${this.currentSeekController.title}, seekPosition: ${this.delayedSeekPosition}. Reset all states and seek position.`
+      );
+
+      this.resetAll();
+    }, SEEK_END_TIMEOUT_DURATION);
+  };
+
+  isSeeking = (): boolean => {
+    return this.delayedSeekPosition !== null;
+  };
+
+  handlePlayerPause = () => {
+    if (this.playerController.isPaused()) {
+      return;
+    }
+
+    this.playerController.pause();
+  };
+
+  clearSeekCompleteTimeout = () => {
+    if (this.seekEndTimeout === null) {
+      return;
+    }
+
+    clearTimeout(this.seekEndTimeout);
+    this.seekEndTimeout = null;
+  };
+
+  clearLongPressThresholdTimeout = () => {
+    if (this.longPressThresholdTimeout === null) {
+      return;
+    }
+
+    clearTimeout(this.longPressThresholdTimeout);
+    this.longPressThresholdTimeout = null;
+  };
 
-  /**
-   * Reset *all* relevant state and strategy controllers
-   */
   resetAll() {
     log_debug("TVSeekController: Reset all states");
     this.currentSeekType = null;
-    this.delayedSeekOffset = null;
 
-    this.delayedSeekProgressSubject.next(null);
+    this.delayedSeekPosition = null;
+    this.isPlayerInitiallyPaused = null;
+
+    this.clearSeekCompleteTimeout();
+    this.clearLongPressThresholdTimeout();
 
     this.tapSeekController.reset();
     this.longPressSeekController.reset();
 
     this.setStrategy(SEEK_STRATEGY.TAP_SEEK);
   }
-
-  private getPlayer() {
-    const player = playerManager.getInstanceController();
-
-    if (!player) {
-      log_warning("TVSeekController: No valid player controller found");
-    }
-
-    return player;
-  }
 }

package/reactHooks/player/TVSeekControlller/TapSeekController.ts

@@ -1,75 +1,53 @@
-import { ISeekController } from "./ISeekController";
-import { SEEK_TYPE, MAX_SEEK_TIME, SKIP_TIME_BASE } from "../const";
-import { log_debug, TVSeekController } from "./TVSeekController";
-
-const getSkipTime = (multiplier: number) =>
-  Math.min(MAX_SEEK_TIME, SKIP_TIME_BASE * multiplier);
+import {
+  ISeekController,
+  ISeekControllerDelegate,
+  SeekIncrementalBaseStrategy,
+} from "./ISeekController";
+import { SEEK_TYPE } from "../const";
+import { log_debug } from "./TVSeekController";
+
+interface TapPressConfig {
+  CLICKS_BEFORE_PAUSE: number;
+}
 
 export class TapSeekController implements ISeekController {
-  private tapSequenceTimeout: any | null = null;
-  private seekMultiplier = 1;
-  private readonly ON_PRESS_RESET_DURATION = 500; // ms
-
-  constructor(private parent: TVSeekController) {}
+  readonly title = "TapSeek";
+  constructor(
+    private seekControllerDelegate: ISeekControllerDelegate,
+    private seekIncrementalStrategy: SeekIncrementalBaseStrategy,
+    private config: TapPressConfig
+  ) {}
 
   onStartSeek = (seekType: SEEK_TYPE) => {
-    log_debug(`TapSeekController: start tap seek type: ${seekType}.`);
-
-    const prevSeekType = this.parent.currentSeekType;
-
-    if (prevSeekType !== seekType) {
-      this.reset();
-    }
-
-    this.parent.currentSeekType = seekType;
-
-    if (this.tapSequenceTimeout) {
-      clearTimeout(this.tapSequenceTimeout);
-      this.tapSequenceTimeout = null;
-    }
+    log_debug(`${this.title}: start tap seek type: ${seekType}.`);
 
-    const clicksBeforePause = 0;
-    const skipTime = getSkipTime(this.seekMultiplier);
+    const skipTime = this.seekIncrementalStrategy.getSkipTime();
+    const seekMultiplier = this.seekIncrementalStrategy.getSkipMultiplier();
 
-    if (this.seekMultiplier > clicksBeforePause) {
+    if (seekMultiplier > this.config.CLICKS_BEFORE_PAUSE) {
       log_debug(
-        `TapSeekController: handle delayed seek type:${seekType} - skipTime: ${skipTime}.`
+        `${this.title}: handle delayed seek type:${seekType} - skipTime: ${skipTime}, seekMultiplier: ${seekMultiplier}.`
       );
 
-      this.parent.handleDelayedSeek(seekType, skipTime);
+      this.seekControllerDelegate.handleDelayedSeek(skipTime);
     } else {
       log_debug(
-        `TapSeekController: handle seek type:${seekType} - skipTime: ${skipTime}.`
+        `${this.title}: handle seek type:${seekType} - skipTime: ${skipTime}.`
       );
 
-      this.parent.seekPlayer(skipTime);
+      this.seekControllerDelegate.handleSeek(skipTime);
     }
 
-    this.seekMultiplier++;
-  }
+    this.seekIncrementalStrategy.increment();
+  };
 
   onSeekEnd = () => {
-    this.tapSequenceTimeout = setTimeout(() => {
-      if (this.parent.delayedSeekOffset !== null) {
-        this.parent.seekPlayer(this.parent.delayedSeekOffset);
-      }
-
-      log_debug(
-        `TapSeekController: Tap sequence timeout fired, delayedSeekOffset: ${this.parent.delayedSeekOffset}.`
-      );
-
-      this.parent.resetAll();
-    }, this.ON_PRESS_RESET_DURATION);
+    this.seekControllerDelegate.handleSeekComplete();
   };
 
   reset = () => {
-    log_debug("TapSeekController: Reset states");
-
-    this.seekMultiplier = 1;
+    log_debug("{this.title}: Reset states");
 
-    if (this.tapSequenceTimeout) {
-      clearTimeout(this.tapSequenceTimeout);
-      this.tapSequenceTimeout = null;
-    }
-  }
+    this.seekIncrementalStrategy.reset();
+  };
 }

package/reactHooks/player/__tests__/useAutoSeek._test.tsx

@@ -0,0 +1,115 @@
+import { act, renderHook } from "@testing-library/react-hooks";
+import { playerManager } from "@applicaster/zapp-react-native-utils/appUtils/playerManager";
+
+import { ON_HOLD_INTERVAL, SEEK_TYPE, SKIP_TIME_BASE } from "../const";
+
+import { useAutoSeek } from "../useAutoSeek";
+
+jest.useFakeTimers({ legacyFakeTimers: true });
+
+const rewind = jest.fn();
+const forward = jest.fn();
+
+jest
+  .spyOn(playerManager, "getInstanceController")
+  .mockReturnValue({ rewind, forward });
+
+describe("useAutoSeek", () => {
+  beforeEach(() => {
+    rewind.mockReset();
+    forward.mockReset();
+  });
+
+  describe("autoSeekStart", () => {
+    it("should call forward method on playerInstance", () => {
+      const { result } = renderHook(() => useAutoSeek());
+
+      act(() => {
+        result.current.autoSeekStart(SEEK_TYPE.FORWARD);
+      });
+
+      expect(forward).toBeCalled();
+      result.current.autoSeekStop();
+    });
+
+    it("should call rewind method on playerManager", () => {
+      const { result } = renderHook(() => useAutoSeek());
+
+      act(() => {
+        result.current.autoSeekStart(SEEK_TYPE.REWIND);
+      });
+
+      expect(rewind).toBeCalled();
+      result.current.autoSeekStop();
+    });
+
+    it("should call rewind with default skip time", () => {
+      const { result } = renderHook(() => useAutoSeek());
+
+      act(() => {
+        result.current.autoSeekStart(SEEK_TYPE.REWIND);
+      });
+
+      expect(rewind).toBeCalledWith(SKIP_TIME_BASE);
+      result.current.autoSeekStop();
+    });
+
+    it("should call forward with default skip time", () => {
+      const { result } = renderHook(() => useAutoSeek());
+
+      act(() => {
+        result.current.autoSeekStart(SEEK_TYPE.FORWARD);
+      });
+
+      expect(forward).toBeCalledWith(SKIP_TIME_BASE);
+      result.current.autoSeekStop();
+    });
+
+    it("should call rewind in intervals set in configuration", () => {
+      const { result } = renderHook(() => useAutoSeek());
+
+      act(() => {
+        result.current.autoSeekStart(SEEK_TYPE.REWIND);
+      });
+
+      expect(rewind).toBeCalled();
+      jest.advanceTimersByTime(ON_HOLD_INTERVAL * 3);
+      expect(rewind).toBeCalledTimes(4);
+      result.current.autoSeekStop();
+    });
+
+    it("should call forward in intervals set in configuration", () => {
+      const { result } = renderHook(() => useAutoSeek());
+
+      act(() => {
+        result.current.autoSeekStart(SEEK_TYPE.FORWARD);
+      });
+
+      expect(forward).toBeCalled();
+      jest.advanceTimersByTime(ON_HOLD_INTERVAL * 3);
+      expect(forward).toBeCalledTimes(4);
+      result.current.autoSeekStop();
+    });
+  });
+
+  describe("autoSeekStop", () => {
+    it("should stop calling playerManager method after autoSeekStop is called", () => {
+      const { result } = renderHook(() => useAutoSeek());
+
+      act(() => {
+        result.current.autoSeekStart(SEEK_TYPE.FORWARD);
+      });
+
+      expect(forward).toBeCalled();
+      jest.advanceTimersByTime(ON_HOLD_INTERVAL * 3);
+      expect(forward).toBeCalledTimes(4);
+
+      act(() => {
+        result.current.autoSeekStop();
+      });
+
+      jest.advanceTimersByTime(ON_HOLD_INTERVAL * 3);
+      expect(forward).toBeCalledTimes(4);
+    });
+  });
+});

package/reactHooks/player/__tests__/useTapSeek._test.ts

@@ -0,0 +1,94 @@
+import { renderHook } from "@testing-library/react-hooks";
+import { playerManager } from "@applicaster/zapp-react-native-utils/appUtils/playerManager";
+import { useTapSeek } from "../useTapSeek";
+
+import { ON_PRESS_RESET_DURATION, SEEK_TYPE, SKIP_TIME_BASE } from "../const";
+
+const rewind = jest.fn();
+const forward = jest.fn();
+
+jest
+  .spyOn(playerManager, "getInstanceController")
+  // @ts-ignore
+  .mockImplementation(() => ({ rewind, forward }));
+
+describe("useTapSeek", () => {
+  beforeEach(() => {
+    rewind.mockReset();
+    forward.mockReset();
+  });
+
+  describe("forward", () => {
+    it("should call forward method on playerManager", () => {
+      const { result } = renderHook(() => useTapSeek());
+
+      result.current(SEEK_TYPE.FORWARD);
+      expect(forward).toBeCalled();
+    });
+
+    it("should call forward with default skip time", () => {
+      const { result } = renderHook(() => useTapSeek());
+
+      result.current(SEEK_TYPE.FORWARD);
+      expect(forward).toBeCalledWith(SKIP_TIME_BASE);
+    });
+
+    it("should multiply skip time for every call", async () => {
+      const { result } = renderHook(() => useTapSeek());
+
+      result.current(SEEK_TYPE.FORWARD);
+      expect(forward).toBeCalledWith(SKIP_TIME_BASE);
+      result.current(SEEK_TYPE.FORWARD);
+      expect(forward).toBeCalledWith(SKIP_TIME_BASE * 2);
+    });
+
+    it("should reset multiplier if waiting more then resetDuration between press actions", () => {
+      const { result, waitFor } = renderHook(() => useTapSeek());
+
+      result.current(SEEK_TYPE.FORWARD);
+      expect(forward).toBeCalledWith(SKIP_TIME_BASE);
+      waitFor(jest.fn(), { timeout: ON_PRESS_RESET_DURATION });
+      result.current(SEEK_TYPE.FORWARD);
+      expect(forward).toBeCalledWith(SKIP_TIME_BASE);
+    });
+  });
+
+  describe("rewind", () => {
+    it("should call rewind method on playerManager", () => {
+      const { result } = renderHook(() => useTapSeek());
+
+      result.current(SEEK_TYPE.REWIND);
+      expect(rewind).toBeCalled();
+    });
+
+    it("should call rewind with default skip time", () => {
+      const { result } = renderHook(() => useTapSeek());
+
+      result.current(SEEK_TYPE.REWIND);
+      expect(rewind).toBeCalledWith(SKIP_TIME_BASE);
+    });
+
+    it("should multiply skip time for every call", async () => {
+      const { result } = renderHook(() => useTapSeek());
+
+      result.current(SEEK_TYPE.REWIND);
+      expect(rewind).toBeCalledWith(SKIP_TIME_BASE);
+      result.current(SEEK_TYPE.REWIND);
+      expect(rewind).toBeCalledWith(SKIP_TIME_BASE * 2);
+    });
+  });
+
+  describe("mixed usage", () => {
+    it("should reset timer if different type of event is emitted", () => {
+      const { result } = renderHook(() => useTapSeek());
+      result.current(SEEK_TYPE.REWIND);
+      expect(rewind).toBeCalledWith(SKIP_TIME_BASE);
+
+      result.current(SEEK_TYPE.REWIND);
+      expect(rewind).toBeCalledWith(SKIP_TIME_BASE * 2);
+
+      result.current(SEEK_TYPE.FORWARD);
+      expect(forward).toBeCalledWith(SKIP_TIME_BASE);
+    });
+  });
+});

package/reactHooks/player/const.ts

@@ -1,10 +1,6 @@
 export const SKIP_TIME_BASE = 10;
 
-export const ON_PRESS_RESET_DURATION = 2000;
-
-export const ON_HOLD_INTERVAL = 500;
-
-export const MAX_SEEK_TIME = 60;
+export const MAX_SEEK_TIME = 600;
 
 export enum SEEK_TYPE {
   FORWARD = "forward",

package/reactHooks/state/useRefWithInitialValue.ts

@@ -0,0 +1,14 @@
+import React from "react";
+
+/**
+ * returns a ref with an initial value that is lazily evaluated once
+ * */
+export const useRefWithInitialValue = <T>(initialValueGetter: () => T) => {
+  const ref = React.useRef<T>(null);
+
+  if (ref.current === null) {
+    ref.current = initialValueGetter();
+  }
+
+  return ref;
+};