@applicaster/zapp-react-native-ui-components 15.0.0-rc.13 → 15.0.0-rc.132

package/Components/ScreenResolver/index.tsx

@@ -1,22 +1,17 @@
 import * as React from "react";
-import { path, prop } from "ramda";
-import {
-  findPluginByType,
-  findPluginByIdentifier,
-} from "@applicaster/zapp-react-native-utils/pluginUtils";
-import { HandlePlayable } from "../HandlePlayable";
-import { toPascalCase } from "@applicaster/zapp-react-native-utils/stringUtils";
-import { HookRenderer } from "../HookRenderer";
-import { LinkHandler } from "../LinkHandler";
-import { Favorites } from "../Favorites";
-import { ZappPipesScreenContext } from "../../Contexts";
+
 import { componentsLogger } from "../../Helpers/logger";
-import { usePickFromState } from "@applicaster/zapp-react-native-redux/hooks";
-import { useNavigation } from "@applicaster/zapp-react-native-utils/reactHooks";
+
 import { useScreenAnalytics } from "@applicaster/zapp-react-native-utils/analyticsUtils/helpers/hooks";
 
-import { useCallbackActions } from "@applicaster/zapp-react-native-utils/zappFrameworkUtils/HookCallback/useCallbackActions";
 import { ScreenResultCallback } from "@applicaster/zapp-react-native-utils/zappFrameworkUtils/HookCallback/callbackNavigationAction";
+import { useScreenComponentResolver } from "./hooks/useScreenComponentResolver";
+import { withDefaultScreenContext } from "./withDefaultScreenContext";
+
+export enum PresentationType {
+  Standalone = "Standalone",
+  Hook = "Hook",
+}
 
 const logger = componentsLogger.addSubsystem("ScreenResolver");
 
@@ -37,103 +32,14 @@ type Props = {
   groupId?: string;
 };
 
-export enum PresentationType {
-  Standalone = "Standalone",
-  Hook = "Hook",
-}
-
 export function ScreenResolverComponent(props: Props) {
-  useScreenAnalytics(props);
-
-  const { screenType, screenId, screenData, groupId } = props;
-
-  const { hookPlugin } = screenData || {};
-
-  const { components, plugins, rivers } = usePickFromState([
-    "components",
-    "plugins",
-    "rivers",
-  ]);
-
-  const {
-    videoModalState: { mode },
-  } = useNavigation();
+  const { screenType } = props;
+  const component = useScreenComponentResolver(screenType, props);
 
-  const [, setScreenContext] = ZappPipesScreenContext.useZappPipesContext();
-
-  React.useEffect(() => {
-    setScreenContext(rivers[screenId]);
-  }, [rivers, screenId, setScreenContext]);
-
-  const parentCallback = props.resultCallback;
-
-  const screenAction = useCallbackActions(
-    hookPlugin || screenData,
-    screenData.callback
-  );
-
-  const callbackAction = parentCallback || screenAction;
-
-  const ScreenPlugin =
-    findPluginByType(screenType, plugins, { skipWarning: true }) ||
-    findPluginByIdentifier(screenType, plugins) ||
-    findPluginByIdentifier(hookPlugin && hookPlugin.identifier, plugins) ||
-    components[toPascalCase(screenType)];
-
-  if (screenType === "favorites") {
-    return <Favorites screenData={screenData} />;
-  }
-
-  if (screenType === "link") {
-    return <LinkHandler screenData={screenData} />;
-  }
-
-  if (screenType === "playable") {
-    return (
-      // @ts-ignore
-      <HandlePlayable
-        item={screenData}
-        mode={mode === "PIP" ? "PIP" : "FULLSCREEN"}
-        isModal={false}
-        groupId={groupId}
-      />
-    );
-  }
-
-  if (hookPlugin || screenType === "hooks") {
-    return (
-      screenData && (
-        <HookRenderer
-          callback={callbackAction}
-          screenData={screenData}
-          focused={props.focused}
-          parentFocus={props.parentFocus as ParentFocus}
-        />
-      )
-    );
-  }
-
-  const ScreenComponent =
-    path(["module", "Component"], ScreenPlugin) ||
-    prop("module", ScreenPlugin) ||
-    prop("Component", ScreenPlugin) ||
-    ScreenPlugin;
-
-  const configuration =
-    prop("configuration", ScreenPlugin) ||
-    prop("__plugin_configuration", ScreenComponent);
+  useScreenAnalytics(props);
 
-  if (ScreenComponent) {
-    return (
-      <ScreenComponent
-        {...props}
-        callback={callbackAction}
-        screenId={screenId}
-        screenData={screenData}
-        configuration={configuration}
-        presentationType={PresentationType.Standalone}
-      />
-    );
+  if (component) {
+    return component;
   }
 
   logger.warning({
@@ -144,6 +50,4 @@ export function ScreenResolverComponent(props: Props) {
   return null;
 }
 
-export const ScreenResolver = ZappPipesScreenContext.withProvider(
-  ScreenResolverComponent
-);
+export const ScreenResolver = withDefaultScreenContext(ScreenResolverComponent);

package/Components/ScreenResolver/utils/__tests__/getScreenTypeProps.test.ts

@@ -0,0 +1,45 @@
+import { getScreenTypeProps } from "../getScreenTypeProps";
+
+const baseProps = {
+  screenData: { id: "entry-1" },
+  mode: "PIP",
+  screenId: "screen-1",
+  groupId: "group-1",
+  focused: true,
+  parentFocus: { nextFocusDown: { current: null } },
+  screenAction: jest.fn(),
+  resultCallback: null,
+};
+
+describe("getScreenTypeProps", () => {
+  it("returns props for favorites/link", () => {
+    expect(getScreenTypeProps("favorites", baseProps)).toEqual({
+      screenData: baseProps.screenData,
+    });
+
+    expect(getScreenTypeProps("link", baseProps)).toEqual({
+      screenData: baseProps.screenData,
+    });
+  });
+
+  it("returns props for playable", () => {
+    expect(getScreenTypeProps("playable", baseProps)).toEqual({
+      item: baseProps.screenData,
+      mode: "PIP",
+      isModal: false,
+      groupId: "group-1",
+    });
+  });
+
+  it("returns props for hooks", () => {
+    const result = getScreenTypeProps("hooks", baseProps);
+
+    expect(result).toMatchObject({
+      screenData: baseProps.screenData,
+      focused: true,
+      parentFocus: baseProps.parentFocus,
+    });
+
+    expect(result.callback).toBe(baseProps.screenAction);
+  });
+});

package/Components/ScreenResolver/utils/getScreenTypeProps.ts

@@ -0,0 +1,43 @@
+export const getScreenTypeProps = (
+  screenType: "favorites" | "link" | "playable" | "hooks",
+  props
+) => {
+  const {
+    screenData,
+    mode,
+    screenId,
+    groupId,
+    focused,
+    parentFocus,
+    screenAction,
+    resultCallback,
+  } = props;
+
+  switch (screenType) {
+    case "favorites":
+    case "link":
+      return {
+        screenData,
+      };
+    case "playable":
+      return {
+        item: screenData,
+        mode: mode === "PIP" ? "PIP" : "FULLSCREEN",
+        isModal: false,
+        groupId: groupId,
+      };
+    case "hooks":
+      return {
+        screenData,
+        callback: resultCallback || screenAction,
+        focused,
+        parentFocus: parentFocus as ParentFocus,
+      };
+    default:
+      return {
+        callback: resultCallback || screenAction,
+        screenId: screenId,
+        screenData,
+      };
+  }
+};

package/Components/ScreenResolver/utils/index.ts

@@ -0,0 +1 @@
+export { getScreenTypeProps } from "./getScreenTypeProps";

package/Components/ScreenResolver/withDefaultScreenContext.tsx

@@ -0,0 +1,16 @@
+import * as React from "react";
+import { useRivers } from "@applicaster/zapp-react-native-utils/reactHooks";
+import { ZappPipesScreenContext } from "../../Contexts";
+
+export function withDefaultScreenContext(Component: React.ComponentType<any>) {
+  return function WithDefaultScreenContext(props: any) {
+    const screenId = props.screenId;
+    const rivers = useRivers();
+
+    return (
+      <ZappPipesScreenContext.Provider initialContextValue={rivers[screenId]}>
+        <Component {...props} />
+      </ZappPipesScreenContext.Provider>
+    );
+  };
+}

package/Components/ScreenResolverFeedProvider/ScreenResolverFeedProvider.tsx

@@ -0,0 +1,25 @@
+import React from "react";
+import { ScreenFeedLoader } from "../ScreenFeedLoader/ScreenFeedLoader";
+
+/** Resolves screen-feed for a given screen `id` by using the provided `useFeedData` hook */
+export const ScreenResolverFeedProvider = ({
+  id,
+  children,
+  useFeedData,
+}: {
+  id: string;
+  children: React.ReactNode;
+  useFeedData: (id: string) => Option<ZappDataSource>;
+}) => {
+  const feedData = useFeedData(id);
+
+  if (feedData?.source) {
+    return (
+      <ScreenFeedLoader id={id} feedData={feedData}>
+        {children}
+      </ScreenFeedLoader>
+    );
+  } else {
+    return <>{children}</>;
+  }
+};

package/Components/ScreenResolverFeedProvider/__tests__/ScreenResolverFeedProvider.test.tsx

@@ -0,0 +1,44 @@
+import React from "react";
+import { Text } from "react-native";
+import { render } from "@testing-library/react-native";
+import { ScreenResolverFeedProvider } from "../ScreenResolverFeedProvider";
+
+jest.mock("../../ScreenFeedLoader/ScreenFeedLoader", () => ({
+  ScreenFeedLoader: ({ children }) => {
+    const React = require("react");
+    const { View } = require("react-native");
+
+    return <View testID="feed-loader">{children}</View>;
+  },
+}));
+
+describe("ScreenResolverFeedProvider", () => {
+  it("renders ScreenFeedLoader when screen feed source exists", () => {
+    const useFeedData = jest.fn(() => ({
+      source: "https://feed",
+      mapping: {},
+    }));
+
+    const { getByTestId, getByText } = render(
+      <ScreenResolverFeedProvider id="screen-1" useFeedData={useFeedData}>
+        <Text>content</Text>
+      </ScreenResolverFeedProvider>
+    );
+
+    expect(getByTestId("feed-loader")).toBeDefined();
+    expect(getByText("content")).toBeDefined();
+  });
+
+  it("renders children directly when screen feed source is missing", () => {
+    const useFeedData = jest.fn(() => ({}));
+
+    const { queryByTestId, getByText } = render(
+      <ScreenResolverFeedProvider id="screen-1" useFeedData={useFeedData}>
+        <Text>content</Text>
+      </ScreenResolverFeedProvider>
+    );
+
+    expect(queryByTestId("feed-loader")).toBeNull();
+    expect(getByText("content")).toBeDefined();
+  });
+});

package/Components/ScreenResolverFeedProvider/index.ts

@@ -0,0 +1 @@
+export { ScreenResolverFeedProvider } from "./ScreenResolverFeedProvider";

package/Components/ScreenRevealManager/ScreenRevealManager.ts

@@ -1,6 +1,11 @@
 import { makeListOf } from "@applicaster/zapp-react-native-utils/arrayUtils";
 import { isFirstComponentGallery } from "@applicaster/zapp-react-native-utils/componentsUtils";
-import { once } from "ramda";
+import { race, Subject, Subscription } from "rxjs";
+import { first } from "rxjs/operators";
+
+import { withTimeout$ } from "@applicaster/zapp-react-native-utils/idleUtils";
+
+const MAX_TIMEOUT_TO_WAIT_COMPONENTS_TO_LOAD = 2000; // 2 seconds
 
 const INITIAL_NUMBER_TO_LOAD = 3;
 
@@ -34,7 +39,8 @@ const getNumberOfComponentsWaitToLoadBeforePresent = (
 export class ScreenRevealManager {
   public numberOfComponentsWaitToLoadBeforePresent: number;
   private renderingState: Array<ComponentLoadingState>;
-  private callback: Callback;
+  private subject$ = new Subject<void>();
+  private subscription: Subscription;
 
   constructor(componentsToRender: ZappUIComponent[], callback: Callback) {
     this.numberOfComponentsWaitToLoadBeforePresent =
@@ -45,32 +51,58 @@ export class ScreenRevealManager {
       this.numberOfComponentsWaitToLoadBeforePresent
     );
 
-    this.callback = once(callback);
+    this.subscription = race(
+      withTimeout$(MAX_TIMEOUT_TO_WAIT_COMPONENTS_TO_LOAD),
+      this.subject$
+    )
+      .pipe(first())
+      .subscribe(callback);
   }
 
   onLoadFinished = (index: number): void => {
+    const currentState = this.renderingState[index];
+
+    if (
+      COMPONENT_LOADING_STATE.LOADED_WITH_SUCCESS === currentState ||
+      COMPONENT_LOADING_STATE.LOADED_WITH_FAILURE === currentState
+    ) {
+      return;
+    }
+
     this.renderingState[index] = COMPONENT_LOADING_STATE.LOADED_WITH_SUCCESS;
 
     if (
       getNumberOfLoaded(this.renderingState) >=
       this.numberOfComponentsWaitToLoadBeforePresent
     ) {
-      this.setIsReadyToShow();
+      this.subject$.next();
+      this.subject$.complete();
     }
   };
 
   onLoadFailed = (index: number): void => {
+    const currentState = this.renderingState[index];
+
+    if (
+      COMPONENT_LOADING_STATE.LOADED_WITH_SUCCESS === currentState ||
+      COMPONENT_LOADING_STATE.LOADED_WITH_FAILURE === currentState
+    ) {
+      return;
+    }
+
     this.renderingState[index] = COMPONENT_LOADING_STATE.LOADED_WITH_FAILURE;
 
     if (
       getNumberOfLoaded(this.renderingState) >=
       this.numberOfComponentsWaitToLoadBeforePresent
     ) {
-      this.setIsReadyToShow();
+      this.subject$.next();
+      this.subject$.complete();
     }
   };
 
-  setIsReadyToShow = (): void => {
-    this.callback();
-  };
+  dispose(): void {
+    this.subscription?.unsubscribe();
+    this.subject$.complete();
+  }
 }

package/Components/ScreenRevealManager/__tests__/ScreenRevealManager.test.ts

@@ -2,106 +2,123 @@ import {
   ScreenRevealManager,
   COMPONENT_LOADING_STATE,
 } from "../ScreenRevealManager";
+import { Subject } from "rxjs";
+
+jest.mock("@applicaster/zapp-react-native-utils/arrayUtils", () => ({
+  makeListOf: jest.fn((value: any, length: number) =>
+    Array(length).fill(value)
+  ),
+}));
+
+jest.mock("@applicaster/zapp-react-native-utils/componentsUtils", () => ({
+  isFirstComponentGallery: jest.fn(),
+}));
+
+jest.mock("@applicaster/zapp-react-native-utils/idleUtils", () => ({
+  withTimeout$: jest.fn(),
+}));
+
+import { makeListOf } from "@applicaster/zapp-react-native-utils/arrayUtils";
+import { isFirstComponentGallery } from "@applicaster/zapp-react-native-utils/componentsUtils";
+import { withTimeout$ } from "@applicaster/zapp-react-native-utils/idleUtils";
 
 describe("ScreenRevealManager", () => {
-  const mockCallback = jest.fn();
+  let mockCallback: jest.Mock;
+  let timeout$: Subject<void>;
 
   beforeEach(() => {
-    jest.clearAllMocks();
-  });
-
-  it("should initialize with the correct number of components to wait for", () => {
-    const componentsToRender: ZappUIComponent[] = [
-      { component_type: "component1" },
-      { component_type: "component2" },
-      { component_type: "component3" },
-    ];
+    jest.useFakeTimers();
+    mockCallback = jest.fn();
+    timeout$ = new Subject();
 
-    const manager = new ScreenRevealManager(componentsToRender, mockCallback);
+    (withTimeout$ as jest.Mock).mockReturnValue(timeout$);
+    (isFirstComponentGallery as jest.Mock).mockReturnValue(false);
 
-    expect(manager.numberOfComponentsWaitToLoadBeforePresent).toBe(3);
+    (makeListOf as jest.Mock).mockImplementation((value, length) =>
+      Array(length).fill(value)
+    );
+  });
 
-    expect(manager.renderingState).toEqual([
-      COMPONENT_LOADING_STATE.UNKNOWN,
-      COMPONENT_LOADING_STATE.UNKNOWN,
-      COMPONENT_LOADING_STATE.UNKNOWN,
-    ]);
+  afterEach(() => {
+    jest.clearAllTimers();
+    jest.useRealTimers();
+    jest.resetAllMocks();
   });
 
-  it("should call the callback when the required number of components are loaded successfully", () => {
-    const componentsToRender: ZappUIComponent[] = [
-      { component_type: "component1" },
-      { component_type: "component2" },
-      { component_type: "component3" },
-    ];
+  // ────────────────────────────────────────────────
+  it("should initialize with correct number of components and UNKNOWN state", () => {
+    const components = new Array(5).fill({});
+    const mgr = new ScreenRevealManager(components, mockCallback);
 
-    const manager = new ScreenRevealManager(componentsToRender, mockCallback);
+    expect(mgr.numberOfComponentsWaitToLoadBeforePresent).toBe(3);
+    expect(makeListOf).toHaveBeenCalledWith(COMPONENT_LOADING_STATE.UNKNOWN, 3);
+  });
 
-    manager.onLoadFinished(0);
-    manager.onLoadFinished(1);
-    manager.onLoadFinished(2);
+  // ────────────────────────────────────────────────
+  it("should set numberOfComponentsWaitToLoadBeforePresent to 1 if first component is gallery", () => {
+    (isFirstComponentGallery as jest.Mock).mockReturnValue(true);
 
-    expect(mockCallback).toHaveBeenCalledTimes(1);
+    const components = new Array(5).fill({});
+    const mgr = new ScreenRevealManager(components, mockCallback);
+
+    expect(mgr.numberOfComponentsWaitToLoadBeforePresent).toBe(1);
   });
 
-  it("should call the callback when the required number of components fail to load", () => {
-    const componentsToRender: ZappUIComponent[] = [
-      { component_type: "component1" },
-      { component_type: "component2" },
-      { component_type: "component3" },
-    ];
+  // ────────────────────────────────────────────────
+  it("should trigger callback after all components load successfully", () => {
+    const components = new Array(3).fill({});
+    const mgr = new ScreenRevealManager(components, mockCallback);
 
-    const manager = new ScreenRevealManager(componentsToRender, mockCallback);
+    mgr.onLoadFinished(0);
+    expect(mockCallback).not.toHaveBeenCalled();
 
-    manager.onLoadFailed(0);
-    manager.onLoadFailed(1);
-    manager.onLoadFailed(2);
+    mgr.onLoadFinished(1);
+    expect(mockCallback).not.toHaveBeenCalled();
 
+    mgr.onLoadFinished(2);
     expect(mockCallback).toHaveBeenCalledTimes(1);
   });
 
-  it("should call the callback when a mix of successful and failed loads meet the required number", () => {
-    const componentsToRender: ZappUIComponent[] = [
-      { component_type: "component1" },
-      { component_type: "component2" },
-      { component_type: "component3" },
-    ];
-
-    const manager = new ScreenRevealManager(componentsToRender, mockCallback);
+  // ────────────────────────────────────────────────
+  it("should trigger callback after some components fail to load but all finished", () => {
+    const components = new Array(3).fill({});
+    const mgr = new ScreenRevealManager(components, mockCallback);
 
-    manager.onLoadFinished(0);
-    manager.onLoadFailed(1);
-    manager.onLoadFinished(2);
+    mgr.onLoadFinished(0);
+    mgr.onLoadFailed(1);
+    mgr.onLoadFailed(2);
 
     expect(mockCallback).toHaveBeenCalledTimes(1);
   });
 
-  it("should not call the callback if the required number of components are not loaded", () => {
-    const componentsToRender: ZappUIComponent[] = [
-      { component_type: "component1" },
-      { component_type: "component2" },
-      { component_type: "component3" },
-    ];
-
-    const manager = new ScreenRevealManager(componentsToRender, mockCallback);
+  // ────────────────────────────────────────────────
+  it("should not trigger callback twice when same component finishes twice", () => {
+    const components = new Array(3).fill({});
+    const mgr = new ScreenRevealManager(components, mockCallback);
 
-    manager.onLoadFinished(0);
-    manager.onLoadFailed(1);
+    mgr.onLoadFinished(0);
+    mgr.onLoadFinished(0); // duplicate
+    mgr.onLoadFinished(1);
+    mgr.onLoadFinished(2);
 
-    expect(mockCallback).not.toHaveBeenCalled();
+    expect(mockCallback).toHaveBeenCalledTimes(1);
   });
 
-  it("should call the callback when the when first component is gallery and it was loaded successfully", () => {
-    const componentsToRender: ZappUIComponent[] = [
-      { component_type: "gallery-qb" },
-      { component_type: "component2" },
-      { component_type: "component3" },
-    ];
+  // ────────────────────────────────────────────────
+  it("should trigger callback when timeout$ emits before all loaded", () => {
+    const components = new Array(3).fill({});
+    new ScreenRevealManager(components, mockCallback);
 
-    const manager = new ScreenRevealManager(componentsToRender, mockCallback);
-
-    manager.onLoadFinished(0);
+    timeout$.next(); // simulate timeout event from withTimeout$
 
     expect(mockCallback).toHaveBeenCalledTimes(1);
   });
+
+  // ────────────────────────────────────────────────
+  it("should not call callback if nothing loads and no timeout emitted", () => {
+    const components = new Array(3).fill({});
+    new ScreenRevealManager(components, mockCallback);
+
+    expect(mockCallback).not.toHaveBeenCalled();
+  });
 });