@applicaster/zapp-react-native-utils 13.0.0-alpha.3592223128 → 13.0.0-alpha.3755455151

package/reactHooks/player/TVSeekControlller/TVSeekController.ts

@@ -0,0 +1,258 @@
+import { BehaviorSubject } from "rxjs";
+import { TapSeekController } from "./TapSeekController";
+import { LongPressSeekController } from "./LongPressSeekController";
+import { SEEK_TYPE } from "../const";
+import { createLogger } from "../../../logger";
+import { Player } from "../../../appUtils/playerManager/player";
+import { SeekKeyHandlerListener } from "../../../appUtils/keyInputHandler/KeyInputHandler";
+import {
+  ISeekController,
+  ISeekControllerDelegate,
+  SeekIncrementalBaseStrategy,
+} from "./ISeekController";
+
+export const { log_warning, log_debug, log_info, log_error, log_verbose } =
+  createLogger({
+    category: "General",
+    subsystem: "TVSeekController",
+  });
+
+export enum SEEK_STRATEGY {
+  TAP_SEEK = "TAP_SEEK",
+  AUTO_SEEK = "AUTO_SEEK",
+}
+
+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;
+  private readonly tapSeekController: TapSeekController;
+  private readonly longPressSeekController: LongPressSeekController;
+  private longPressThresholdTimeout: any | null = null;
+  private seekEndTimeout: any | null = null;
+
+  constructor(playerController: Player) {
+    this.playerController = playerController;
+
+    this.tapSeekController = new TapSeekController(
+      this,
+      new SeekIncrementalBaseStrategy(),
+      CONFIG_TAP_SEEK
+    );
+
+    this.longPressSeekController = new LongPressSeekController(
+      this,
+      new SeekIncrementalBaseStrategy(),
+      CONFIG_LONG_PRESS
+    );
+
+    this.currentSeekController = this.tapSeekController;
+  }
+
+  getDelayedSeekProgressObservable = () => {
+    return this.delayedSeekProgressSubject;
+  };
+
+  setStrategy = (seekStrategy: SEEK_STRATEGY) => {
+    switch (seekStrategy) {
+      case SEEK_STRATEGY.TAP_SEEK:
+        this.currentSeekController = this.tapSeekController;
+        log_debug("TVSeekController: setStrategy - TAP_SEEK");
+
+        break;
+      case SEEK_STRATEGY.AUTO_SEEK:
+        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);
+
+    this.longPressThresholdTimeout = setTimeout(() => {
+      this.setStrategy(SEEK_STRATEGY.AUTO_SEEK);
+      this.currentSeekController.onStartSeek(seekType);
+    }, LONG_PRESS_THRESHOLD);
+  };
+
+  onForwardPress = (): boolean => {
+    this.handleStartSeek(SEEK_TYPE.FORWARD);
+
+    return true;
+  };
+
+  onRewindPress = (): boolean => {
+    this.handleStartSeek(SEEK_TYPE.REWIND);
+
+    return true;
+  };
+
+  onSeekEnd = () => {
+    this.clearLongPressThresholdTimeout();
+    this.currentSeekController.onSeekEnd();
+  };
+
+  onRewindPressOut = () => {
+    this.onSeekEnd();
+  };
+
+  onForwardPressOut = () => {
+    this.onSeekEnd();
+  };
+
+  onVideoProgress = (position: number) => {
+    if (this.delayedSeekPosition !== null) {
+      return;
+    }
+
+    this.delayedSeekProgressSubject.next(position);
+  };
+
+  handleDelayedSeek = (offset: number = 0) => {
+    this.handlePlayerPause();
+
+    const currentPos =
+      this.delayedSeekPosition === null
+        ? this.playerController.getPosition()
+        : this.delayedSeekPosition;
+
+    let targetPos = currentPos;
+
+    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 {
+      log_warning(
+        `TVSeekController: handleDelayedSeek - invalid seek type: ${this.currentSeekType}`
+      );
+    }
+
+    log_debug(
+      `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);
+  };
+
+  handleSeekTo = (newPosition: number) => {
+    this.playerController.seekTo(newPosition);
+
+    if (!this.isPlayerInitiallyPaused) {
+      this.playerController.play();
+    }
+  };
+
+  handleSeek = (offset: number) => {
+    this.playerController[this.currentSeekType](offset);
+
+    if (!this.isPlayerInitiallyPaused) {
+      this.playerController.play();
+    }
+  };
+
+  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;
+  };
+
+  resetAll() {
+    log_debug("TVSeekController: Reset all states");
+    this.currentSeekType = null;
+
+    this.delayedSeekPosition = null;
+    this.isPlayerInitiallyPaused = null;
+
+    this.clearSeekCompleteTimeout();
+    this.clearLongPressThresholdTimeout();
+
+    this.tapSeekController.reset();
+    this.longPressSeekController.reset();
+
+    this.setStrategy(SEEK_STRATEGY.TAP_SEEK);
+  }
+}

package/reactHooks/player/TVSeekControlller/TapSeekController.ts

@@ -0,0 +1,53 @@
+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 {
+  readonly title = "TapSeek";
+  constructor(
+    private seekControllerDelegate: ISeekControllerDelegate,
+    private seekIncrementalStrategy: SeekIncrementalBaseStrategy,
+    private config: TapPressConfig
+  ) {}
+
+  onStartSeek = (seekType: SEEK_TYPE) => {
+    log_debug(`${this.title}: start tap seek type: ${seekType}.`);
+
+    const skipTime = this.seekIncrementalStrategy.getSkipTime();
+    const seekMultiplier = this.seekIncrementalStrategy.getSkipMultiplier();
+
+    if (seekMultiplier > this.config.CLICKS_BEFORE_PAUSE) {
+      log_debug(
+        `${this.title}: handle delayed seek type:${seekType} - skipTime: ${skipTime}, seekMultiplier: ${seekMultiplier}.`
+      );
+
+      this.seekControllerDelegate.handleDelayedSeek(skipTime);
+    } else {
+      log_debug(
+        `${this.title}: handle seek type:${seekType} - skipTime: ${skipTime}.`
+      );
+
+      this.seekControllerDelegate.handleSeek(skipTime);
+    }
+
+    this.seekIncrementalStrategy.increment();
+  };
+
+  onSeekEnd = () => {
+    this.seekControllerDelegate.handleSeekComplete();
+  };
+
+  reset = () => {
+    log_debug("{this.title}: Reset states");
+
+    this.seekIncrementalStrategy.reset();
+  };
+}

package/reactHooks/player/__tests__/{useAutoSeek.test.tsx → useAutoSeek._test.tsx}

@@ -5,15 +5,14 @@ import { ON_HOLD_INTERVAL, SEEK_TYPE, SKIP_TIME_BASE } from "../const";
 
 import { useAutoSeek } from "../useAutoSeek";
 
-jest.useFakeTimers();
+jest.useFakeTimers({ legacyFakeTimers: true });
 
 const rewind = jest.fn();
 const forward = jest.fn();
 
 jest
   .spyOn(playerManager, "getInstanceController")
-  // @ts-ignore
-  .mockImplementation(() => ({ rewind, forward }));
+  .mockReturnValue({ rewind, forward });
 
 describe("useAutoSeek", () => {
   beforeEach(() => {

package/reactHooks/player/const.ts

@@ -1,9 +1,5 @@
 export const SKIP_TIME_BASE = 10;
 
-export const ON_PRESS_RESET_DURATION = 2000;
-
-export const ON_HOLD_INTERVAL = 500;
-
 export const MAX_SEEK_TIME = 600;
 
 export enum SEEK_TYPE {

package/reactHooks/player/index.ts

@@ -1,7 +1 @@
 export { useLanguageData } from "./useLanguageData";
-
-export { useAutoSeek } from "./useAutoSeek";
-
-export { useTapSeek } from "./useTapSeek";
-
-export { useSeek, withUseSeek } from "./useSeek";

package/reactHooks/utils/index.ts

@@ -33,7 +33,7 @@ export const useIsInitialRender = (): boolean => {
 
 export const checkIsLocalFeed = (feedUrl) => feedUrl?.startsWith("pipesv2://");
 
-export const shouldUseCachedData = (
+export const shouldDispatchData = (
   url: string,
   feed: ZappPipesData | null,
   clearCache: boolean

package/reactUtils/__tests__/reactUtils.test.js

@@ -1,4 +1,3 @@
-jest.mock("create-react-ref/lib/createRef", () => jest.fn());
 import * as React from "react";
 import * as helpers from "../helpers";
 
@@ -8,13 +7,7 @@ import {
   componentDidMount,
 } from "./fixtures";
 
-const {
-  attachLifeCycleMethods,
-  createReactRef,
-  mergeChildrenProps,
-} = require("../index");
-
-const createRef = require("create-react-ref/lib/createRef");
+import { attachLifeCycleMethods, createReactRef, mergeChildrenProps } from "..";
 
 describe("attachLifeCycleMethods", () => {
   let addLifeCycleMethodsSpy;
@@ -50,30 +43,19 @@ describe("attachLifeCycleMethods", () => {
 
 describe("createReactRef", () => {
   it("calls the React.createRef function if it exists", () => {
-    jest.resetModules();
-
-    jest.doMock("react", () => ({
-      ...jest.requireActual("react"),
-      createRef: jest.fn(),
-    }));
-
-    const React = require("react");
+    jest.clearAllMocks();
 
-    createReactRef();
-    expect(React.createRef).toHaveBeenCalled();
-    expect(createRef).not.toHaveBeenCalled();
+    const ref = createReactRef();
+    expect(ref).toHaveProperty("current");
   });
 
   it("calls the polyfill if React.createRef doesn't exist", () => {
-    jest.resetModules();
-
-    jest.doMock("react", () => ({
-      ...jest.requireActual("react"),
-      createRef: undefined,
-    }));
-
-    createReactRef();
-    expect(createRef).toHaveBeenCalled();
+    jest.clearAllMocks();
+    const originalCreateRef = React.createRef;
+    React.createRef = undefined;
+    const ref = createReactRef();
+    expect(ref).toHaveProperty("current");
+    React.createRef = originalCreateRef;
   });
 });
 

package/reactUtils/createContext/__tests__/__snapshots__/helpers.test.js.snap

@@ -1,104 +1,104 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`createContextSetters when no state validator is provided calls setState when the setters are called, no matter what the value is 1`] = `
-Object {
+{
   "bar": "bar",
   "foo": "foo",
 }
 `;
 
 exports[`createContextSetters when no state validator is provided calls setState when the setters are called, no matter what the value is 2`] = `
-Object {
+{
   "bar": "bar",
   "foo": "invalid foo",
 }
 `;
 
 exports[`createContextSetters when no state validator is provided calls setState when the setters are called, no matter what the value is 3`] = `
-Object {
+{
   "bar": "invalid bar",
   "foo": "invalid foo",
 }
 `;
 
 exports[`createContextSetters when no state validator is provided calls setState when the setters are called, no matter what the value is 4`] = `
-Array [
-  Array [
+[
+  [
     [Function],
   ],
-  Array [
+  [
     [Function],
   ],
 ]
 `;
 
 exports[`createContextSetters when state validator is provided calls setState when the setters are called & the validator passes 1`] = `
-Object {
+{
   "bar": "bar",
   "foo": "foo",
 }
 `;
 
 exports[`createContextSetters when state validator is provided calls setState when the setters are called & the validator passes 2`] = `
-Object {
+{
   "bar": "bar",
   "foo": "new foo",
 }
 `;
 
 exports[`createContextSetters when state validator is provided calls setState when the setters are called & the validator passes 3`] = `
-Object {
+{
   "bar": "new bar",
   "foo": "new foo",
 }
 `;
 
 exports[`createContextSetters when state validator is provided calls setState when the setters are called & the validator passes 4`] = `
-Array [
-  Array [
+[
+  [
     [Function],
   ],
-  Array [
+  [
     [Function],
   ],
 ]
 `;
 
 exports[`createContextSetters when state validator is provided skips the update if the new value is the same as the previous one 1`] = `
-Object {
+{
   "bar": "bar",
   "foo": "new foo",
 }
 `;
 
 exports[`createContextSetters when state validator is provided skips the update if the state validator doesn't pass 1`] = `
-Object {
+{
   "bar": "bar",
   "foo": "foo",
 }
 `;
 
 exports[`createContextSetters when state validator is provided skips the update if the state validator doesn't pass 2`] = `
-Object {
+{
   "bar": "bar",
   "foo": "foo",
 }
 `;
 
 exports[`createContextSetters when state validator is provided skips the update if the state validator doesn't pass 3`] = `
-Object {
+{
   "bar": "bar",
   "foo": "foo",
 }
 `;
 
 exports[`createContextSetters when state validator is provided skips the update if the state validator doesn't pass 4`] = `
-Array [
-  Array [
+[
+  [
     "trying to invoke setFoo with invalid foo - but it was rejected by the state validator
           skipping context update",
   ],
-  Array [
+  [
     "trying to invoke setBar with invalid bar - but it was rejected by the state validator
           skipping context update",
   ],

package/reactUtils/createContext/__tests__/__snapshots__/index.test.js.snap

@@ -1,10 +1,10 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`createContext - when React has the new context API returns the components and the decorators 1`] = `
-Object {
+{
   "Consumer": [MockFunction],
   "Provider": [MockFunction],
-  "ReactContext": Object {
+  "ReactContext": {
     "Consumer": [MockFunction],
     "Provider": [MockFunction],
   },

package/reactUtils/createContext/__tests__/__snapshots__/provider.test.js.snap

@@ -3,7 +3,7 @@
 exports[`createProvider creates a context Provider component 1`] = `
 <mockConstructor
   value={
-    Object {
+    {
       "context": "initialValue",
       "otherContext": "otherValue",
       "setContext": [Function],
@@ -18,11 +18,11 @@ exports[`createProvider creates a context Provider component 1`] = `
 `;
 
 exports[`createProvider creates a context Provider component 2`] = `
-Object {
+{
   "children": <MockChild
     context="context"
   />,
-  "value": Object {
+  "value": {
     "context": "initialValue",
     "otherContext": "otherValue",
     "setContext": [Function],

package/reactUtils/createContext/__tests__/helpers.test.js

@@ -9,13 +9,13 @@ function stateValidator({ property, value }) {
   );
 }
 
-const logger = {
+const mockLogger = {
   warning: jest.fn(),
 };
 
 jest.mock("../../logger", () => ({
   reactUtilsLogger: {
-    addSubsystem: jest.fn(() => logger),
+    addSubsystem: jest.fn(() => mockLogger),
   },
 }));
 
@@ -62,7 +62,7 @@ describe("createContextSetters", () => {
     beforeEach(() => {
       instance.resetInitialState();
       setStateSpy.mockClear();
-      logger.warning.mockClear();
+      mockLogger.warning.mockClear();
     });
 
     it("adds all properties and setters to the component", () => {
@@ -83,7 +83,7 @@ describe("createContextSetters", () => {
 
       expect(setStateSpy).toHaveBeenCalledTimes(2);
       expect(setStateSpy.mock.calls).toMatchSnapshot();
-      expect(logger.warning).not.toHaveBeenCalled();
+      expect(mockLogger.warning).not.toHaveBeenCalled();
     });
 
     it("skips the update if the state validator doesn't pass", () => {
@@ -96,8 +96,8 @@ describe("createContextSetters", () => {
       expect(instance.state).toMatchSnapshot();
 
       expect(setStateSpy).not.toHaveBeenCalled();
-      expect(logger.warning).toHaveBeenCalledTimes(2);
-      expect(logger.warning.mock.calls).toMatchSnapshot();
+      expect(mockLogger.warning).toHaveBeenCalledTimes(2);
+      expect(mockLogger.warning.mock.calls).toMatchSnapshot();
     });
 
     it("skips the update if the new value is the same as the previous one", () => {
@@ -131,7 +131,7 @@ describe("createContextSetters", () => {
 
     afterEach(() => {
       setStateSpy.mockClear();
-      logger.warning.mockClear();
+      mockLogger.warning.mockClear();
     });
 
     it("adds all properties and setters to the component", () => {
@@ -152,7 +152,7 @@ describe("createContextSetters", () => {
 
       expect(setStateSpy).toHaveBeenCalledTimes(2);
       expect(setStateSpy.mock.calls).toMatchSnapshot();
-      expect(logger.warning).not.toHaveBeenCalled();
+      expect(mockLogger.warning).not.toHaveBeenCalled();
     });
   });
 });

package/reactUtils/index.ts

@@ -109,20 +109,6 @@ export const isTvOSPlatform = () => getPlatform() === "tvos";
 
 export const isAndroidTVPlatform = () => getPlatform() === "android_tv";
 
-declare global {
-  interface Window {
-    VIZIO?: {
-      Chromevox: {
-        play: (text: string) => void;
-      };
-      exitApplication: () => void;
-      setClosedCaptionHandler: (
-        callback: (isCCEnabled: boolean) => void
-      ) => void;
-    };
-  }
-}
-
 /**
  * Platforms found in userAgent string, please note that simulators
  * might not have the same agents that the devices have

package/theme/__mocks__/index.ts

@@ -1,3 +1,5 @@
+import React from "react";
+
 export const themeMock = {
   screen_padding_top: 20,
   screen_padding_bottom: 48,
@@ -17,3 +19,5 @@ export const themeMock = {
 };
 
 export const useTheme = jest.fn().mockReturnValue(themeMock);
+
+export const ThemeContext = React.createContext(themeMock);