@applicaster/zapp-react-native-ui-components 13.0.0-rc.11 → 13.0.0-rc.110

package/Components/River/ComponentsMap/hooks/useLoadingState.ts

@@ -1,50 +1,86 @@
 import * as React from "react";
-import * as R from "ramda";
-
-const allTrue = R.all(R.equals(true));
-const anyFalse = R.any(R.equals(false));
-const anyTrue = R.any(R.equals(true));
+import { isNil, set, lensIndex, T, slice } from "ramda";
+import { BehaviorSubject } from "rxjs";
+import { useRefWithInitialValue } from "@applicaster/zapp-react-native-utils/reactHooks/state/useRefWithInitialValue";
 
 const reducer = (state, { payload }) => {
-  if (!R.isNil(payload) && !state[payload]) {
-    return R.set(R.lensIndex(payload), true)(state);
+  if (!isNil(payload) && !state[payload]) {
+    return set(lensIndex(payload), true)(state);
   }
 
   return state;
 };
 
-type Return = {
-  isAnyLoading: boolean;
-  isAllLoaded: boolean;
+type LoadingState = {
+  index: number;
+  done: boolean;
   waitForAllComponents: boolean;
+};
+
+type Return = {
+  loadingState: BehaviorSubject<LoadingState>;
   onLoadFinished: (index: number) => void;
   onLoadFailed: ({ error, index }: { error: Error; index: number }) => void;
   shouldShowLoadingError: boolean;
-  isAnyLoaded: boolean;
   arePreviousComponentsLoaded: (index: number) => boolean;
 };
 
-type Action = { payload: { index: number } };
-
-type Loaded = true;
-type Loading = false;
-
-type LoadingState = Array<Loaded | Loading>;
-
 // TODO: Take this value from Zapp configuration, when feature is added to GeneralScreen
 const SHOULD_FAIL_ON_COMPONENT_LOADING = false;
 
-export const useLoadingState = (count: number): Return => {
+const createLoadingStateObservable = (count: number) =>
+  new BehaviorSubject<LoadingState>({
+    index: -1,
+    done: count === 0,
+    waitForAllComponents: SHOULD_FAIL_ON_COMPONENT_LOADING,
+  });
+
+export const useLoadingState = (
+  count: number,
+  onLoadDone: () => void
+): Return => {
+  const componentStateRef = React.useRef(new Array(count).fill(false));
   const [loadingError, setLoadingError] = React.useState(null);
 
-  const [componentsState, dispatch] = React.useReducer<
-    React.Reducer<LoadingState, Action>
-  >(reducer, new Array(count).fill(false));
+  const loadingState = useRefWithInitialValue<BehaviorSubject<LoadingState>>(
+    () => createLoadingStateObservable(count)
+  );
+
+  const arePreviousComponentsLoaded = React.useCallback((index) => {
+    if (index === 0) {
+      return true;
+    }
 
-  const handleComponentLoaded = React.useCallback((index) => {
-    dispatch({ payload: index });
+    const componentsBefore = slice(0, index, componentStateRef.current);
+
+    return componentsBefore.every(T);
   }, []);
 
+  const dispatch = React.useCallback(({ payload }) => {
+    const newState = reducer(componentStateRef.current, { payload });
+    componentStateRef.current = newState;
+    const isDone = arePreviousComponentsLoaded(count - 1);
+
+    const state = loadingState.current.getValue();
+
+    const newLoadingState = {
+      ...state,
+      index: state.index < payload ? payload : state.index,
+      done: isDone,
+    };
+
+    loadingState.current.next(newLoadingState);
+
+    if (isDone) {
+      onLoadDone();
+    }
+  }, []);
+
+  const handleComponentLoaded = React.useCallback(
+    (index) => dispatch({ payload: index }),
+    []
+  );
+
   const handleComponentLoadErrorWhenNeedToFail = React.useCallback(
     ({ error }) => {
       if (error !== loadingError) {
@@ -55,35 +91,26 @@ export const useLoadingState = (count: number): Return => {
   );
 
   const handleComponentLoadErrorWhenNoNeedToFail = React.useCallback(
-    ({ index }) => {
-      handleComponentLoaded(index);
-    },
+    ({ index }) => handleComponentLoaded(index),
     []
   );
 
-  const arePreviousComponentsLoaded = React.useCallback(
-    (index) => {
-      if (index === 0) {
-        return true;
-      }
-
-      const componentsBefore = R.slice(0, index, componentsState);
-
-      return allTrue(componentsBefore);
-    },
-    [componentsState]
+  return React.useMemo(
+    () => ({
+      loadingState: loadingState.current,
+      onLoadFinished: handleComponentLoaded,
+      onLoadFailed: SHOULD_FAIL_ON_COMPONENT_LOADING
+        ? handleComponentLoadErrorWhenNeedToFail
+        : handleComponentLoadErrorWhenNoNeedToFail,
+      shouldShowLoadingError: SHOULD_FAIL_ON_COMPONENT_LOADING && loadingError,
+      arePreviousComponentsLoaded,
+    }),
+    [
+      loadingError,
+      handleComponentLoaded,
+      handleComponentLoadErrorWhenNeedToFail,
+      handleComponentLoadErrorWhenNoNeedToFail,
+      arePreviousComponentsLoaded,
+    ]
   );
-
-  return {
-    isAnyLoading: anyFalse(componentsState),
-    isAllLoaded: allTrue(componentsState),
-    onLoadFinished: handleComponentLoaded,
-    onLoadFailed: SHOULD_FAIL_ON_COMPONENT_LOADING
-      ? handleComponentLoadErrorWhenNeedToFail
-      : handleComponentLoadErrorWhenNoNeedToFail,
-    shouldShowLoadingError: SHOULD_FAIL_ON_COMPONENT_LOADING && loadingError,
-    isAnyLoaded: anyTrue(componentsState),
-    waitForAllComponents: SHOULD_FAIL_ON_COMPONENT_LOADING,
-    arePreviousComponentsLoaded,
-  };
 };

package/Components/River/RefreshControl.tsx

@@ -9,7 +9,7 @@ import { useTheme } from "@applicaster/zapp-react-native-utils/theme";
 import { useLocalizedStrings } from "@applicaster/zapp-react-native-utils/localizationUtils";
 import { useAnalytics } from "@applicaster/zapp-react-native-utils/analyticsUtils";
 import { useSendAnalyticsEventWithFunction } from "@applicaster/zapp-react-native-utils/analyticsUtils/helpers/hooks";
-import { useCurrentScreenData } from "@applicaster/zapp-react-native-utils/reactHooks/screen";
+import { useCurrentScreenData } from "@applicaster/zapp-react-native-utils/reactHooks/screen/useCurrentScreenData";
 import { loadPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
 import { useDispatch } from "react-redux";
 import { useShallow } from "zustand/react/shallow";

package/Components/River/RiverFooter.tsx

@@ -1,11 +1,23 @@
-import React from "react";
+import React, { useCallback } from "react";
 import { StyleSheet, View } from "react-native";
 import { Spinner } from "@applicaster/zapp-react-native-ui-components/Components/Spinner";
+import type { Subject } from "rxjs";
+import { useStateFromSubscribe } from "@applicaster/zapp-react-native-utils/reactHooks/state/useStateFromSubscribe";
+
+type LoadingState = {
+  waitForAllComponents: boolean;
+  index: number;
+  done: boolean;
+};
+
+type State = {
+  visible: boolean;
+  isAnyLoaded: boolean;
+};
 
 type Props = {
-  visible?: boolean;
   flatListHeight?: number;
-  isAnyLoaded: boolean;
+  loadingState: Subject<LoadingState>;
 };
 
 const FOOTER_COMPONENT_HEIGHT = 200;
@@ -19,17 +31,35 @@ const footerStyles = StyleSheet.create({
 });
 
 function RiverFooterComponent(props: Props) {
-  const { visible = true, flatListHeight, isAnyLoaded } = props;
+  const { flatListHeight, loadingState } = props;
+
+  const { visible, isAnyLoaded } = useStateFromSubscribe<LoadingState, State>(
+    loadingState,
+    useCallback(
+      ({ index, done, waitForAllComponents }, setState) =>
+        setState(() => ({
+          visible: !done,
+          isAnyLoaded: index >= 0 || waitForAllComponents,
+        })),
+      []
+    ),
+    {
+      visible: true,
+      isAnyLoaded: false,
+    }
+  );
 
   if (!visible) return null;
 
   return (
     <View
-      renderToHardwareTextureAndroid={true}
-      style={{
-        ...footerStyles.container,
-        height: isAnyLoaded ? FOOTER_COMPONENT_HEIGHT : flatListHeight,
-      }}
+      renderToHardwareTextureAndroid
+      style={[
+        footerStyles.container,
+        {
+          height: isAnyLoaded ? FOOTER_COMPONENT_HEIGHT : flatListHeight,
+        },
+      ]}
     >
       <Spinner size={isAnyLoaded ? "small" : "large"} />
     </View>

package/Components/River/RiverItem.tsx

@@ -1,5 +1,6 @@
-import React from "react";
+import React, { useEffect } from "react";
 import * as R from "ramda";
+import { isGroup } from "@applicaster/zapp-react-native-utils/componentsUtils";
 
 import { applyDecorators } from "../../Decorators";
 
@@ -11,6 +12,7 @@ import {
 import { riverLogger } from "./logger";
 import { tvPluginsWithCellRenderer } from "../../const";
 import { isTV } from "@applicaster/zapp-react-native-utils/reactUtils";
+import type { BehaviorSubject } from "rxjs";
 
 export type RiverItemType = {
   item: ZappUIComponent;
@@ -24,6 +26,7 @@ export type RiverItemType = {
   getStaticComponentFeed: GeneralContentScreenProps["getStaticComponentFeed"];
   readyToBeDisplayed?: boolean;
   isLast: boolean;
+  loadingState: BehaviorSubject<{ index: number }>;
 };
 
 function getFeedUrl(feed: ZappFeed, index: number) {
@@ -36,6 +39,33 @@ function getFeedUrl(feed: ZappFeed, index: number) {
   }
 }
 
+/**
+ * useLoadingState for RiverItemComponent
+ * takes currentIndex and loadingState as arguments
+ **/
+const useLoadingState = (
+  currentIndex: number,
+  loadingState: RiverItemType["loadingState"]
+) => {
+  const [readyToBeDisplayed, setReadyToBeDisplayed] = React.useState(
+    loadingState.getValue().index + 1 === currentIndex
+  );
+
+  useEffect(() => {
+    const subscription = loadingState.subscribe(({ index }) => {
+      if (index + 1 === currentIndex) {
+        setReadyToBeDisplayed(true);
+      }
+    });
+
+    return () => {
+      subscription.unsubscribe();
+    };
+  }, [loadingState, currentIndex]);
+
+  return readyToBeDisplayed;
+};
+
 function RiverItemComponent(props: RiverItemType) {
   const {
     item,
@@ -47,10 +77,12 @@ function RiverItemComponent(props: RiverItemType) {
     onLoadFinished,
     onLoadFailed,
     getStaticComponentFeed,
-    readyToBeDisplayed,
     isLast,
+    loadingState,
   } = props;
 
+  const readyToBeDisplayed = useLoadingState(index, loadingState);
+
   const feedUrl = getFeedUrl(feed, index);
 
   const Component = useComponentResolver(
@@ -81,7 +113,7 @@ function RiverItemComponent(props: RiverItemType) {
       jsOnly: true,
     });
 
-    if (!CellRenderer && item.component_type !== "group-qb") {
+    if (!CellRenderer && !isGroup(item)) {
       riverLogger.warning({
         message: "Cell Renderer is null - will fallback to default cell",
         data: { item, CellRenderer },
@@ -90,6 +122,10 @@ function RiverItemComponent(props: RiverItemType) {
     }
   }, []);
 
+  if (!readyToBeDisplayed) {
+    return null;
+  }
+
   if (Component === null || typeof Component === "undefined") {
     riverLogger.warning({
       message: `Component ${item.component_type} is null - skipping rendering`,

package/Components/River/TV/index.tsx

@@ -1,4 +1,9 @@
+import { compose } from "ramda";
 import { River as RiverComponent } from "./River";
 import { withTvEventHandler } from "./withTVEventHandler";
+import { withComponentsMapOffsetContext } from "../../../Contexts/ComponentsMapOffsetContext";
 
-export const River = withTvEventHandler(RiverComponent);
+export const River = compose(
+  withTvEventHandler,
+  withComponentsMapOffsetContext
+)(RiverComponent);

package/Components/River/__tests__/__snapshots__/componentsMap.test.js.snap

@@ -3,7 +3,7 @@
 exports[`componentsMap renders renders components map correctly 1`] = `
 <View
   style={
-    Object {
+    {
       "flex": 1,
     }
   }
@@ -11,15 +11,98 @@ exports[`componentsMap renders renders components map correctly 1`] = `
   <View
     onLayout={[Function]}
     style={
-      Object {
+      {
         "flex": 1,
       }
     }
   >
     <RCTScrollView
-      ListFooterComponent={[Function]}
+      ListFooterComponent={
+        <Memo(RiverFooterComponent)
+          flatListHeight={null}
+          loadingState={
+            BehaviorSubject {
+              "_value": {
+                "done": false,
+                "index": -1,
+                "waitForAllComponents": false,
+              },
+              "closed": false,
+              "currentObservers": null,
+              "hasError": false,
+              "isStopped": false,
+              "observers": [
+                SafeSubscriber {
+                  "_finalizers": [
+                    Subscription {
+                      "_finalizers": null,
+                      "_parentage": [Circular],
+                      "closed": false,
+                      "initialTeardown": [Function],
+                    },
+                  ],
+                  "_parentage": null,
+                  "closed": false,
+                  "destination": ConsumerObserver {
+                    "partialObserver": {
+                      "complete": undefined,
+                      "error": undefined,
+                      "next": [Function],
+                    },
+                  },
+                  "initialTeardown": undefined,
+                  "isStopped": false,
+                },
+                SafeSubscriber {
+                  "_finalizers": [
+                    Subscription {
+                      "_finalizers": null,
+                      "_parentage": [Circular],
+                      "closed": false,
+                      "initialTeardown": [Function],
+                    },
+                  ],
+                  "_parentage": null,
+                  "closed": false,
+                  "destination": ConsumerObserver {
+                    "partialObserver": {
+                      "complete": undefined,
+                      "error": undefined,
+                      "next": [Function],
+                    },
+                  },
+                  "initialTeardown": undefined,
+                  "isStopped": false,
+                },
+                SafeSubscriber {
+                  "_finalizers": [
+                    Subscription {
+                      "_finalizers": null,
+                      "_parentage": [Circular],
+                      "closed": false,
+                      "initialTeardown": [Function],
+                    },
+                  ],
+                  "_parentage": null,
+                  "closed": false,
+                  "destination": ConsumerObserver {
+                    "partialObserver": {
+                      "complete": undefined,
+                      "error": undefined,
+                      "next": [Function],
+                    },
+                  },
+                  "initialTeardown": undefined,
+                  "isStopped": false,
+                },
+              ],
+              "thrownError": null,
+            }
+          }
+        />
+      }
       contentContainerStyle={
-        Object {
+        {
           "paddingBottom": undefined,
           "paddingLeft": undefined,
           "paddingRight": undefined,
@@ -27,22 +110,22 @@ exports[`componentsMap renders renders components map correctly 1`] = `
         }
       }
       data={
-        Array [
-          Object {
+        [
+          {
             "component_type": "hero",
             "id": "A1",
-            "styles": Object {
-              "cell_styles": Array [
+            "styles": {
+              "cell_styles": [
                 "some",
                 "obsolete",
                 "ids",
               ],
             },
           },
-          Object {
+          {
             "component_type": "grid",
             "id": "A2",
-            "styles": Object {
+            "styles": {
               "master_cell_id": "uuid-5678-B",
             },
           },
@@ -66,12 +149,12 @@ exports[`componentsMap renders renders components map correctly 1`] = `
       renderItem={[Function]}
       scrollEventThrottle={16}
       scrollIndicatorInsets={
-        Object {
+        {
           "right": 1,
         }
       }
-      stickyHeaderIndices={Array []}
-      viewabilityConfigCallbackPairs={Array []}
+      stickyHeaderIndices={[]}
+      viewabilityConfigCallbackPairs={[]}
       windowSize={12}
     >
       <View>
@@ -80,22 +163,14 @@ exports[`componentsMap renders renders components map correctly 1`] = `
           style={null}
         >
           <View
+            onLayout={[Function]}
             style={
-              Object {
-                "display": "flex",
+              {
+                "flex": 1,
               }
             }
           >
-            <View
-              onLayout={[Function]}
-              style={
-                Object {
-                  "flex": 1,
-                }
-              }
-            >
-              <View />
-            </View>
+            <View />
           </View>
         </View>
         <View
@@ -103,23 +178,13 @@ exports[`componentsMap renders renders components map correctly 1`] = `
           style={null}
         >
           <View
+            onLayout={[Function]}
             style={
-              Object {
-                "display": "none",
+              {
+                "flex": 1,
               }
             }
-          >
-            <View
-              onLayout={[Function]}
-              style={
-                Object {
-                  "flex": 1,
-                }
-              }
-            >
-              <View />
-            </View>
-          </View>
+          />
         </View>
         <View
           onLayout={[Function]}
@@ -127,12 +192,16 @@ exports[`componentsMap renders renders components map correctly 1`] = `
           <View
             renderToHardwareTextureAndroid={true}
             style={
-              Object {
-                "alignItems": "center",
-                "height": null,
-                "justifyContent": "center",
-                "width": "100%",
-              }
+              [
+                {
+                  "alignItems": "center",
+                  "justifyContent": "center",
+                  "width": "100%",
+                },
+                {
+                  "height": null,
+                },
+              ]
             }
           >
             <ActivityIndicator

package/Components/River/__tests__/__snapshots__/river.test.js.snap

@@ -1,89 +1,27 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`When River has a general_content type <River /> renders correctly 1`] = `
-<ContextProvider
-  value={null}
->
-  <RiverWithData
-    appData={
-      Object {
-        "layoutVersion": "v1",
-      }
-    }
-    dispatch={[Function]}
-    rivers={
-      Object {
-        "A1234": Object {
-          "home": true,
-          "id": "A1234",
-          "name": "foo",
-          "type": "general_content",
-          "ui_components": Array [
-            Object {
-              "component_type": "hero",
-            },
-            Object {
-              "component_type": "grid",
-            },
-          ],
-        },
-        "B4567": Object {
-          "id": "B4567",
-        },
-        "C0987": Object {
-          "home": false,
-          "id": "C0987",
-          "name": "Some-Screen-Plugin",
-          "type": "some-screen-plugin",
-          "ui_components": Array [],
-        },
-      }
-    }
-    screenId="A1234"
-    store={
-      Object {
-        "clearActions": [Function],
-        "dispatch": [Function],
-        "getActions": [Function],
-        "getState": [Function],
-        "replaceReducer": [Function],
-        "subscribe": [Function],
-      }
-    }
-  />
-</ContextProvider>
-`;
-
-exports[`When River has a general_content type <RiverComponent /> renders correctly 1`] = `
-<GeneralContentScreen
-  groupId="ZF-C4"
-  screenId="A1234"
-/>
-`;
-
-exports[`When River has any other type other than general_content <RiverComponent /> renders correctly 1`] = `
-<WithProvider
-  screenData={
-    Object {
-      "groupId": undefined,
-      "home": false,
-      "id": "C0987",
-      "name": "Some-Screen-Plugin",
-      "type": "some-screen-plugin",
-      "ui_components": Array [],
+exports[`When River has a general_content type renders River component correctly 1`] = `
+<View
+  onLayout={[Function]}
+  style={
+    {
+      "flex": 1,
     }
   }
-  screenId="C0987"
-  screenType="some-screen-plugin"
-/>
-`;
-
-exports[`When River has feed url <RiverComponent /> renders correctly 1`] = `
-<Connect(FeedLoaderComponent)
-  feedUrl="https://some-feed-url.net"
-  refreshCallback={[Function]}
-  refreshing={false}
+  testID="on-layout-view"
 >
-  <Component />
-</Connect(FeedLoaderComponent)>
+  <View
+    style={
+      {
+        "display": "none",
+        "flex": 1,
+      }
+    }
+  >
+    <View
+      screenId="A1234"
+      testID="general-content-screen"
+    />
+  </View>
+</View>
 `;