@applicaster/quick-brick-core 13.0.0-rc.10 → 13.0.0-rc.100

package/App/NavigationProvider/NavigationProvider.tsx

@@ -49,6 +49,7 @@ import { coreAppLogger } from "../logger";
 import {
   getPlatform,
   isTV,
+  isVizioPlatform,
 } from "@applicaster/zapp-react-native-utils/reactUtils";
 import { useConnectionInfo } from "@applicaster/zapp-react-native-utils/reactHooks/connection";
 import {
@@ -57,15 +58,26 @@ import {
   legacyScreenData,
   openExternalUrl,
 } from "./utils";
-import { debounce } from "@applicaster/zapp-react-native-utils/functionUtils";
+import {
+  debounce,
+  getJsonReplacer,
+} from "@applicaster/zapp-react-native-utils/functionUtils";
 
 import { findParent } from "@applicaster/zapp-react-native-ui-components/Contexts/ZappPipesContext/ZappPipesEntryContext";
 import { ZappPipesEntryContext } from "@applicaster/zapp-react-native-ui-components/Contexts";
 import { PlayNextState } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/OverlayObserver/OverlaysObserver";
 import { inflateUrl } from "@applicaster/zapp-react-native-ui-components/Components/LinkHandler/LinkHandler";
-import { useModalStore } from "@applicaster/zapp-react-native-utils/modalState";
+import {
+  dismissModal,
+  modalStore,
+  openModal,
+} from "@applicaster/zapp-react-native-utils/modalState";
 import { useSubscriberFor } from "@applicaster/zapp-react-native-utils/reactHooks/useSubscriberFor";
 import { QBUIComponentEvents } from "@applicaster/zapp-react-native-ui-components/events";
+import { Hook } from "@applicaster/zapp-react-native-utils/appUtils/HooksManager/Hook";
+import { URLSchemeContext } from "../DeepLinking/URLSchemeListener/URLSchemeContextProvider";
+
+import { loadingOverlayManager } from "../LoadingOverlay";
 
 const logger = coreAppLogger.addSubsystem("Navigator");
 
@@ -75,17 +87,6 @@ type Props = {
   plugins?: QuickBrickPlugin[];
 };
 
-type EntryWithParent = ZappEntry & { parent?: EntryWithParent };
-
-type SingleEntry = {
-  data: EntryWithParent;
-  route: string;
-  id: string;
-  parentId?: string;
-};
-
-type EntryContextType = { [K in string]: SingleEntry };
-
 const navigationActions = {
   [ACTIONS.PUSH]: push,
   [ACTIONS.REPLACE]: replace,
@@ -96,6 +97,8 @@ const navigationActions = {
 const platform = getPlatform();
 
 export function NavigationProvider({ children }: Props) {
+  const { url: deepLinkURL } = React.useContext(URLSchemeContext);
+
   const {
     appData: { layoutVersion },
     rivers,
@@ -122,11 +125,7 @@ export function NavigationProvider({ children }: Props) {
   const pathname = state?.location?.pathname;
   const pathnameRef = React.useRef(pathname);
 
-  const { context }: EntryContextType = React.useContext(
-    ZappPipesEntryContext.Context
-  );
-
-  const { openModal, dismissModal } = useModalStore();
+  const { context } = React.useContext(ZappPipesEntryContext.Context);
 
   const playNextOverlayState = React.useRef();
 
@@ -153,7 +152,7 @@ export function NavigationProvider({ children }: Props) {
   );
 
   const getModalState: () => ModalState = () => {
-    const { modalState } = useModalStore.getState();
+    const { modalState } = modalStore.getState();
 
     return modalState;
   };
@@ -380,13 +379,24 @@ export function NavigationProvider({ children }: Props) {
     }
   };
 
-  const handleHookPresent = ({ hookPlugin, route, payload }, dispose) => {
+  const handleHookPresent = (
+    {
+      hookPlugin,
+      route,
+      payload,
+    }: {
+      hookPlugin: Hook;
+      route: string;
+      payload: object;
+    },
+    dispose
+  ) => {
     if (hookPlugin?.lastHook) {
       dispose();
     }
 
     if (hookPlugin.isModalHook()) {
-      navigator.openModal({
+      openModal({
         item: payload,
         props: { screenType: "hooks" },
         options: { ModalContainer: hookPlugin.getModalContainer() },
@@ -394,6 +404,8 @@ export function NavigationProvider({ children }: Props) {
     } else {
       dispatch(push(route, { entry: payload, screen: hookPlugin }));
     }
+
+    closeLoadingOverlay();
   };
 
   const handleHookError = ({ error, hookPlugin, callback }, dispose) => {
@@ -404,7 +416,7 @@ export function NavigationProvider({ children }: Props) {
     }
 
     if (hookPlugin.isModalHook()) {
-      navigator.dismissModal();
+      dismissModal();
     } else {
       goBack(true, true);
     }
@@ -412,9 +424,11 @@ export function NavigationProvider({ children }: Props) {
     if (callback && typeof callback === "function") {
       callback();
     }
+
+    closeLoadingOverlay();
   };
 
-  const handleHookCancel = ({ hookPlugin, callback }, dispose) => {
+  const handleHookCancel = ({ hookPlugin, callback, abort }, dispose) => {
     dispose();
     setStartUpHooks(false);
 
@@ -422,21 +436,29 @@ export function NavigationProvider({ children }: Props) {
       callback();
     }
 
-    if (hookPlugin.isModalHook()) {
-      navigator.dismissModal();
-    } else {
-      goBack(true, true);
+    if (!abort) {
+      if (hookPlugin.isModalHook()) {
+        dismissModal();
+      } else {
+        goBack(true, true);
+      }
     }
+
+    closeLoadingOverlay();
   };
 
   const handleHookSuccess = ({ hookPlugin, callback }) => {
     callback?.();
 
     if (hookPlugin.isModalHook()) {
-      navigator.dismissModal();
+      dismissModal();
     }
   };
 
+  const handleBackgroundHook = () => {
+    openLoadingOverlay();
+  };
+
   const checkStartUpHooks = React.useMemo(() => {
     if (!pluginConfigurations) return false;
 
@@ -498,8 +520,7 @@ export function NavigationProvider({ children }: Props) {
     ({ hookPlugin, payload, callback }, dispose) => {
       if (hookPlugin?.lastHook) {
         dispose({ disposeAll: true });
-
-        startUpHooks.current && setStartUpHooks(false);
+        currentStartUpHooks.current && setStartUpHooks(false);
       }
 
       dispatch(
@@ -507,6 +528,8 @@ export function NavigationProvider({ children }: Props) {
       );
 
       callback?.();
+
+      closeLoadingOverlay();
     };
 
   const offlinePlugin = React.useMemo(() => {
@@ -614,25 +637,37 @@ export function NavigationProvider({ children }: Props) {
           },
         };
 
-        HooksManager(hooksOptions)
+        const hooksManager = HooksManager(hooksOptions);
+
+        hooksManager.subscriber
           .on(HOOKS_EVENTS.PRESENT_SCREEN_HOOK, handleHookPresent)
           .on(HOOKS_EVENTS.ERROR, handleHookError)
           .on(HOOKS_EVENTS.CANCEL, handleHookCancel)
           .on(HOOKS_EVENTS.SUCCESS, handleHookSuccess)
+          .on(HOOKS_EVENTS.START_BACKGROUND_HOOK, handleBackgroundHook)
           .on(
             HOOKS_EVENTS.COMPLETE,
             handleHookComplete(navigationAction, targetRoute, {
               screen,
               options,
             })
-          )
-          .handleHooks(legacyScreenData({ entry, screen }));
+          );
+
+        hooksManager.handleHooks(legacyScreenData({ entry, screen }));
       } else {
         dispatch(navigationAction(targetRoute, { screen, entry, options }));
       }
     },
   });
 
+  const openLoadingOverlay = React.useCallback(() => {
+    deepLinkURL && isVizioPlatform() && loadingOverlayManager.show();
+  }, [deepLinkURL]);
+
+  const closeLoadingOverlay = React.useCallback(() => {
+    loadingOverlayManager.hide();
+  }, []);
+
   const openPiP = React.useCallback(() => {
     dispatch(setVideoPiP());
   }, []);
@@ -653,33 +688,6 @@ export function NavigationProvider({ children }: Props) {
     }
   }, [state?.options?.videoModal?.previousMode]);
 
-  const openModalBottomSheet = React.useCallback(
-    ({
-      ModalBottomSheetContent,
-      modalBottomSheetContentProps,
-      props = {},
-      options = {},
-    }) => {
-      openModal({
-        item: {
-          ModalBottomSheetContent,
-          modalBottomSheetContentProps,
-        },
-        props,
-        options: {
-          animationType: "none",
-          animated: false,
-          ...options,
-        },
-      });
-    },
-    [openModal]
-  );
-
-  const closeModalBottomSheet = React.useCallback(() => {
-    dismissModal();
-  }, [dismissModal]);
-
   const getNestedEntry = () => state?.location?.state?.nested?.entry ?? null;
 
   // It will only work for the regular stack and pathname, It won't work for modals
@@ -720,8 +728,6 @@ export function NavigationProvider({ children }: Props) {
       openModal,
       dismissModal,
       getModalState,
-      openModalBottomSheet,
-      closeModalBottomSheet,
       videoModalState: state.options.videoModal,
       openVideoModal,
       closeVideoModal,
@@ -738,7 +744,15 @@ export function NavigationProvider({ children }: Props) {
       getStackForPathname,
       mainStack: state.stack.mainStack,
     }),
-    [rivers, plugins, JSON.stringify(state), appLaunched, startUpHooks]
+    [
+      rivers,
+      plugins,
+      // TODO: Compare entire screen data from state must be removed
+      // State size could be large ~150kb and take 80ms on android tv on 8 rails
+      JSON.stringify(state, getJsonReplacer()),
+      appLaunched,
+      startUpHooks,
+    ]
   );
 
   // when running the tests, we pass the dispatch function

package/App/NavigationProvider/__tests__/navigationProvider.test.tsx

@@ -461,48 +461,4 @@ describe("<NavigationProvider />", () => {
       });
     });
   });
-
-  describe("modal feature", () => {
-    it("sets the modalState when opening a modal", () => {
-      act(() => {
-        wrapper = renderContextConsumer();
-      });
-
-      const view = getByTestId(wrapper, "WrapperView");
-      act(() => view.props.navigator.openModal({ item: rivers.A1234 }));
-      expect(view.props.navigator.get).toMatchSnapshot();
-    });
-
-    it("removes the visible flag when dismissing a modal", () => {
-      act(() => {
-        wrapper = renderContextConsumer();
-      });
-
-      const view = getByTestId(wrapper, "WrapperView");
-      act(() => view.props.navigator.openModal({ item: rivers.A1234 }));
-      expect(view.props.navigator.getModalState()).toMatchSnapshot();
-      act(() => view.props.navigator.dismissModal());
-      expect(view.props.navigator.getModalState().visible).toBeFalsy();
-      expect(view.props.navigator.getModalState()).toMatchSnapshot();
-    });
-
-    it("should reset state to initial when dismissing a modal ( closeModalBottomSheet ) opened by openModalBottomSheet", () => {
-      act(() => {
-        wrapper = renderContextConsumer();
-      });
-
-      const view = getByTestId(wrapper, "WrapperView");
-
-      act(() =>
-        view.props.navigator.openModalBottomSheet({
-          ModalBottomSheetContent: rivers.A1234,
-          modalBottomSheetContentProps: { some: "props" },
-        })
-      );
-
-      expect(view.props.navigator.getModalState()).toMatchSnapshot();
-      act(() => view.props.navigator.closeModalBottomSheet());
-      expect(view.props.navigator.getModalState()).toMatchSnapshot();
-    });
-  });
 });