@applicaster/zapp-react-native-ui-components 13.0.0-alpha.4936752427 → 13.0.0-alpha.4958485095

package/Components/Cell/CellWithFocusable.ios.tsx

@@ -0,0 +1,126 @@
+/** TODO: Remove this file when tvos FocusableGroup
+ * behaviour is aligned to the web one
+ * FocusableGroup should only send onFocus and onBlur events when
+ * Focus enters and leaves the Focusables inside the branch
+ */
+import * as React from "react";
+
+import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
+import * as FOCUS_EVENTS from "@applicaster/zapp-react-native-utils/appUtils/focusManager/events";
+import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
+import { toBooleanWithDefaultFalse } from "@applicaster/zapp-react-native-utils/booleanUtils";
+
+import { isAppleTV } from "../../Helpers/Platform";
+import { useCellState } from "../MasterCell/utils";
+
+const useCellFocusedState = (
+  skipFocusManagerRegistration: boolean,
+  groupId: string,
+  id: string
+) => {
+  const [currentCellFocused, setCurrentCellFocused] = React.useState(false);
+
+  React.useEffect(() => {
+    const isGroupItemFocused = () => {
+      if (!skipFocusManagerRegistration) {
+        const isFocused = focusManager.isGroupItemFocused(groupId, id);
+        setCurrentCellFocused(isFocused);
+      }
+    };
+
+    const handler = () => {
+      // tvOS hack for properly checking focus
+      if (isAppleTV()) {
+        setTimeout(() => {
+          isGroupItemFocused();
+        }, 0);
+      } else {
+        isGroupItemFocused();
+      }
+    };
+
+    focusManager.on(FOCUS_EVENTS.FOCUS, handler);
+
+    return () => {
+      focusManager.removeHandler(FOCUS_EVENTS.FOCUS, handler);
+    };
+  }, [groupId, skipFocusManagerRegistration]);
+
+  return currentCellFocused;
+};
+
+type Props = {
+  item: ZappEntry;
+  CellRenderer: React.FunctionComponent<any>;
+  id: string;
+  groupId: string;
+  onFocus: Function;
+  index: number;
+  scrollTo: Function;
+  preferredFocus?: boolean;
+  skipFocusManagerRegistration?: boolean;
+  isFocusable?: boolean;
+  behavior: Behavior;
+  focused?: boolean;
+};
+
+export function CellWithFocusable(props: Props) {
+  const {
+    index,
+    item,
+    CellRenderer,
+    id,
+    groupId,
+    onFocus,
+    scrollTo = noop,
+    preferredFocus,
+    skipFocusManagerRegistration,
+    isFocusable,
+    behavior,
+    focused,
+  } = props;
+
+  const isFocused = useCellFocusedState(
+    skipFocusManagerRegistration,
+    groupId,
+    id
+  );
+
+  const state = useCellState({
+    id: item.id,
+    behavior,
+    focused: isFocused || toBooleanWithDefaultFalse(focused),
+  });
+
+  const [focusedButtonId, setFocusedButtonId] = React.useState(undefined);
+
+  // for horizontal scrolling
+  React.useEffect(() => {
+    if (focusedButtonId) {
+      scrollTo(index);
+    }
+  }, [focusedButtonId]);
+
+  const handleToggleFocus = (value) => {
+    setFocusedButtonId(value.focusedButtonId);
+
+    if (value.focusable) {
+      onFocus(value.focusable, value.mouse);
+    }
+  };
+
+  return (
+    <CellRenderer
+      item={item}
+      groupId={groupId}
+      onToggleFocus={handleToggleFocus}
+      state={state}
+      prefixId={id}
+      focusedButtonId={focusedButtonId}
+      preferredFocus={preferredFocus}
+      skipFocusManagerRegistration={skipFocusManagerRegistration}
+      isFocusable={isFocusable}
+      focused={focused}
+    />
+  );
+}

package/Components/Cell/CellWithFocusable.tsx

@@ -1,48 +1,10 @@
 import * as React from "react";
 
-import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
-import * as FOCUS_EVENTS from "@applicaster/zapp-react-native-utils/appUtils/focusManager/events";
 import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
 import { toBooleanWithDefaultFalse } from "@applicaster/zapp-react-native-utils/booleanUtils";
 
-import { isAppleTV } from "../../Helpers/Platform";
 import { useCellState } from "../MasterCell/utils";
-
-const useCellFocusedState = (
-  skipFocusManagerRegistration: boolean,
-  groupId: string,
-  id: string
-) => {
-  const [currentCellFocused, setCurrentCellFocused] = React.useState(false);
-
-  React.useEffect(() => {
-    const isGroupItemFocused = () => {
-      if (!skipFocusManagerRegistration) {
-        const isFocused = focusManager.isGroupItemFocused(groupId, id);
-        setCurrentCellFocused(isFocused);
-      }
-    };
-
-    const handler = () => {
-      // tvOS hack for properly checking focus
-      if (isAppleTV()) {
-        setTimeout(() => {
-          isGroupItemFocused();
-        }, 0);
-      } else {
-        isGroupItemFocused();
-      }
-    };
-
-    focusManager.on(FOCUS_EVENTS.FOCUS, handler);
-
-    return () => {
-      focusManager.removeHandler(FOCUS_EVENTS.FOCUS, handler);
-    };
-  }, [groupId, skipFocusManagerRegistration]);
-
-  return currentCellFocused;
-};
+import { FocusableGroup } from "../FocusableGroup";
 
 type Props = {
   item: ZappEntry;
@@ -75,11 +37,7 @@ export function CellWithFocusable(props: Props) {
     focused,
   } = props;
 
-  const isFocused = useCellFocusedState(
-    skipFocusManagerRegistration,
-    groupId,
-    id
-  );
+  const [isFocused, setIsFocused] = React.useState(false);
 
   const state = useCellState({
     id: item.id,
@@ -96,26 +54,52 @@ export function CellWithFocusable(props: Props) {
     }
   }, [focusedButtonId]);
 
-  const handleToggleFocus = (value) => {
-    setFocusedButtonId(value.focusedButtonId);
+  const handleToggleFocus = React.useCallback(
+    (value) => {
+      setFocusedButtonId(value.focusedButtonId);
+
+      if (value.focusable) {
+        onFocus(value.focusable, value.mouse);
+      }
+    },
+    [onFocus]
+  );
+
+  const onGroupFocus = React.useCallback(() => {
+    if (!skipFocusManagerRegistration) {
+      setIsFocused(true);
+    }
+  }, [skipFocusManagerRegistration]);
 
-    if (value.focusable) {
-      onFocus(value.focusable, value.mouse);
+  const onGroupBlur = React.useCallback(() => {
+    if (!skipFocusManagerRegistration) {
+      setIsFocused(false);
     }
-  };
+  }, [skipFocusManagerRegistration]);
 
   return (
-    <CellRenderer
-      item={item}
+    <FocusableGroup
+      id={`focusable-cell-wrapper-${id}`}
+      testID={"cell-with-focusable-cell-renderer-focusable-group"}
       groupId={groupId}
-      onToggleFocus={handleToggleFocus}
-      state={state}
-      prefixId={id}
-      focusedButtonId={focusedButtonId}
       preferredFocus={preferredFocus}
-      skipFocusManagerRegistration={skipFocusManagerRegistration}
-      isFocusable={isFocusable}
-      focused={focused}
-    />
+      shouldUsePreferredFocus
+      onFocus={onGroupFocus}
+      onBlur={onGroupBlur}
+    >
+      <CellRenderer
+        testID={"cell-with-focusable-cell-renderer"}
+        item={item}
+        groupId={`focusable-cell-wrapper-${id}`}
+        onToggleFocus={handleToggleFocus}
+        state={state}
+        prefixId={id}
+        focusedButtonId={focusedButtonId}
+        preferredFocus={true}
+        skipFocusManagerRegistration={skipFocusManagerRegistration}
+        isFocusable={isFocusable}
+        focused={focused}
+      />
+    </FocusableGroup>
   );
 }

package/Components/Cell/__tests__/CellWIthFocusable.test.js

@@ -1,7 +1,7 @@
 import { View } from "react-native";
 import React from "react";
 import { act, render } from "@testing-library/react-native";
-import { CellWithFocusable } from "../CellWithFocusable";
+import { CellWithFocusable } from "../CellWithFocusable.tsx";
 
 import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
 
@@ -23,7 +23,9 @@ describe("CellWithFocusable", () => {
 
     const wrapper = renderWith(props);
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("default");
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
+
+    expect(element.props.state).toBe("default");
   });
 
   it("should render in default state", () => {
@@ -40,8 +42,9 @@ describe("CellWithFocusable", () => {
     focusManager.isGroupItemFocused = jest.fn(() => true);
 
     const wrapper = renderWith(props);
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("default");
+    expect(element.props.state).toBe("default");
   });
 
   it("should render in focused state", () => {
@@ -55,13 +58,17 @@ describe("CellWithFocusable", () => {
       scrollTo: jest.fn(),
     };
 
-    focusManager.isGroupItemFocused = jest.fn(() => true);
     const wrapper = renderWith(props);
 
+    const focusableGroupComponent = wrapper.getByTestId(
+      "cell-with-focusable-cell-renderer-focusable-group"
+    );
+
     act(() => {
-      focusManager.on.mock.calls[focusManager.on.mock.calls.length - 1][1]();
+      focusableGroupComponent.props.onFocus();
     });
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("focused");
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
+    expect(element.props.state).toBe("focused");
   });
 });

package/Components/MasterCell/hooks/useAsyncRendering/MasterCellAsyncRenderManager.ts

@@ -16,13 +16,13 @@ export class MasterCellAsyncRenderManager {
   }
 
   public emitAsyncElementRegistrate = () => {
-    this.asyncElementRegistrate$.next();
+    this.asyncElementRegistrate$.next(null);
 
     return this.decrementAsyncElementRegistrationCount;
   };
 
   public emitAsyncElementLayout = () => {
-    this.asyncElementLayout$.next();
+    this.asyncElementLayout$.next(null);
   };
 
   public decrementAsyncElementRegistrationCount = () => {

package/Components/River/ComponentsMap/ComponentsMap.tsx

@@ -70,21 +70,6 @@ function ComponentsMapComponent(props: Props) {
 
   const [flatListHeight, setFlatListHeight] = React.useState(null);
 
-  const {
-    isAnyLoading,
-    isAllLoaded,
-    waitForAllComponents,
-    onLoadFinished,
-    onLoadFailed,
-    shouldShowLoadingError,
-    isAnyLoaded,
-    arePreviousComponentsLoaded,
-  } = useLoadingState(feed?.entry?.length || components.length);
-
-  const theme = useTheme();
-
-  const logTimestamp = useProfilerLogging();
-
   const riverComponents = React.useMemo(() => {
     if (feed?.entry?.length < components.length) {
       return R.slice(0, feed?.entry?.length, components);
@@ -93,55 +78,42 @@ function ComponentsMapComponent(props: Props) {
     return components;
   }, [components, feed]);
 
+  const logTimestamp = useProfilerLogging();
+
+  const onLoadDone = React.useCallback(() => {
+    logTimestamp(riverId?.toString());
+  }, [logTimestamp]);
+
+  const { loadingState, onLoadFinished, onLoadFailed, shouldShowLoadingError } =
+    useLoadingState(riverComponents.length, onLoadDone);
+
+  const theme = useTheme();
+
   const renderRiverItem = React.useCallback(
     ({ item, index }) => {
-      const readyToBeDisplayed = arePreviousComponentsLoaded(index);
-
-      const styles = {
-        display: !readyToBeDisplayed ? "none" : ("flex" as "none" | "flex"),
+      const riverItemProps = {
+        riverId,
+        item,
+        index,
+        isScreenWrappedInContainer,
+        feed,
+        groupId,
+        onLoadFailed,
+        onLoadFinished,
+        getStaticComponentFeed,
+        isLast: isLast(index, riverComponents.length),
+        loadingState,
       };
 
       return (
-        <View style={styles}>
-          <ScreenLoadingMeasurementsListItemWrapper index={index}>
-            <RiverItem
-              {...{
-                readyToBeDisplayed,
-                riverId,
-                item,
-                index,
-                isScreenWrappedInContainer,
-                feed,
-                groupId,
-                onLoadFailed,
-                onLoadFinished,
-                getStaticComponentFeed,
-                isLast: isLast(index, riverComponents.length),
-              }}
-            />
-          </ScreenLoadingMeasurementsListItemWrapper>
-        </View>
+        <ScreenLoadingMeasurementsListItemWrapper index={index}>
+          <RiverItem {...riverItemProps} />
+        </ScreenLoadingMeasurementsListItemWrapper>
       );
     },
-    [
-      feed,
-      getStaticComponentFeed,
-      arePreviousComponentsLoaded,
-      onLoadFailed,
-      onLoadFinished,
-    ]
+    [feed, getStaticComponentFeed, onLoadFailed, onLoadFinished]
   );
 
-  const renderFooter = React.useCallback(() => {
-    return (
-      <RiverFooter
-        visible={isAnyLoading}
-        flatListHeight={flatListHeight}
-        isAnyLoaded={isAnyLoaded || waitForAllComponents}
-      />
-    );
-  }, [flatListHeight, isAnyLoading, isAnyLoaded]);
-
   const screenStyle = React.useMemo(
     () => ({
       paddingTop: ifEmptyUseFallback(
@@ -179,12 +151,6 @@ function ComponentsMapComponent(props: Props) {
 
   usePipesCacheReset(riverId, riverComponents);
 
-  React.useEffect(() => {
-    if (isAllLoaded) {
-      logTimestamp(riverId?.toString());
-    }
-  }, [isAllLoaded]);
-
   const refreshControl = React.useMemo(
     () =>
       pullToRefreshEnabled ? (
@@ -280,6 +246,11 @@ function ComponentsMapComponent(props: Props) {
     }
   }, []);
 
+  const contentContainerStyle = React.useMemo(
+    () => (isScreenWrappedInContainer ? {} : screenStyle),
+    [isScreenWrappedInContainer, screenStyle]
+  );
+
   if (shouldShowLoadingError) {
     return <RiverError />;
   }
@@ -291,7 +262,7 @@ function ComponentsMapComponent(props: Props) {
     <View style={styles.container}>
       <ScreenLoadingMeasurements
         riverId={riverId}
-        numberOfComponents={feed?.entry?.length || components.length}
+        numberOfComponents={riverComponents.length}
       >
         <ViewportTracker>
           <FlatList
@@ -312,10 +283,13 @@ function ComponentsMapComponent(props: Props) {
             keyExtractor={keyExtractor}
             renderItem={renderRiverItem}
             data={riverComponents}
-            contentContainerStyle={
-              isScreenWrappedInContainer ? {} : screenStyle
+            contentContainerStyle={contentContainerStyle}
+            ListFooterComponent={
+              <RiverFooter
+                flatListHeight={flatListHeight}
+                loadingState={loadingState}
+              />
             }
-            ListFooterComponent={renderFooter}
             refreshControl={refreshControl}
             onScrollBeginDrag={onScrollBeginDrag}
             onScroll={onScroll}

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 = () =>
+  new BehaviorSubject<LoadingState>({
+    index: -1,
+    done: false,
+    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
+  );
+
+  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,
-  };
 };