@applicaster/zapp-react-native-ui-components 12.0.4-rc.0 → 12.0.4-rc.2

package/Components/VideoLive/LiveImageManager.ts

@@ -8,6 +8,8 @@ import { loggerLiveImageManager } from "./loggerHelper";
 import { isTV } from "@applicaster/zapp-react-native-utils/reactUtils";
 import { Component } from "react";
 
+const TIMEOUT_FOR_DELAY_CHECK_PLAYER_POSITION = 500; // ms
+
 const { log_debug, log_info, log_error } = loggerLiveImageManager;
 
 export type LiveImageManagerEvent =
@@ -62,6 +64,9 @@ export class LiveImageManager implements PlayerLifecycleListener {
   protected currentlyPlaying: LiveImage | null = null;
   protected primaryPlayer: Player | null = null;
 
+  private checkPlayerPositionTimeout: ReturnType<typeof setTimeout> | null =
+    null;
+
   protected listeners: Record<
     string,
     Record<LiveImageManagerEvent, (event?: Record<string, any>) => void>
@@ -118,6 +123,11 @@ export class LiveImageManager implements PlayerLifecycleListener {
     });
   };
 
+  private cancelCheckPlayerPositionTimeout = () => {
+    clearTimeout(this.checkPlayerPositionTimeout);
+    this.checkPlayerPositionTimeout = null;
+  };
+
   public onViewportEnter = (item: LiveImage) => {
     log_debug(
       `onViewportEnter: live-image ${playerInfo(
@@ -125,7 +135,21 @@ export class LiveImageManager implements PlayerLifecycleListener {
       )}, primary ${playerInfo(this.primaryPlayer)}`
     );
 
-    this.checkPlayerPosition(item);
+    if (!isTV()) {
+      // mobile only
+      // we have to delay running checkPlayerPosition, because sometimes on fast scrolling we get wrong order onEnter, then onLeave.
+      // which could cause select wrong item to play
+
+      this.cancelCheckPlayerPositionTimeout();
+
+      this.checkPlayerPositionTimeout = setTimeout(() => {
+        this.cancelCheckPlayerPositionTimeout();
+
+        this.checkPlayerPosition(item);
+      }, TIMEOUT_FOR_DELAY_CHECK_PLAYER_POSITION);
+    } else {
+      this.checkPlayerPosition(item);
+    }
   };
 
   public onViewportLeave = (item: LiveImage) => {
@@ -246,6 +270,8 @@ export class LiveImageManager implements PlayerLifecycleListener {
   };
 
   public checkPlayerPosition = (item: LiveImage) => {
+    this.cancelCheckPlayerPositionTimeout();
+
     log_debug(
       `checkPlayerPosition: live-image playerId: ${playerInfo(
         item.player

package/Components/VideoLive/PlayerLiveImageComponent.tsx

@@ -244,25 +244,27 @@ const PlayerLiveImageComponent = (props: Props) => {
   }, [item.id]);
 
   React.useEffect(() => {
-    if (playerManager) {
-      const isPlayerRegistered = playerManager.isPlayerRegistered(playerId);
+    if (isMeasurement(item) || !playerManager) {
+      return;
+    }
 
-      if (isPlayerRegistered) {
-        log_error(
-          `PlayerLiveImageComponent: player ${playerId} already registered`
-        );
-      } else {
-        playerManager.registerPlayer({
-          id: playerId,
-          playerController: controller,
-        });
+    const isPlayerRegistered = playerManager.isPlayerRegistered(playerId);
 
-        return () => {
-          playerManager.unregisterPlayer(playerId);
-        };
-      }
+    if (isPlayerRegistered) {
+      log_error(
+        `PlayerLiveImageComponent: player ${playerId} already registered`
+      );
+    } else {
+      playerManager.registerPlayer({
+        id: playerId,
+        playerController: controller,
+      });
+
+      return () => {
+        playerManager.unregisterPlayer(playerId);
+      };
     }
-  }, [liveImageItem, playerId, controller]);
+  }, [liveImageItem, playerId, controller, item.id]);
 
   const onPositionUpdated = React.useCallback(
     (data) => {

package/Components/VideoLive/__tests__/PlayerLiveImageComponent.test.tsx

@@ -1,10 +1,11 @@
 /* eslint-disable react/display-name */
 import * as React from "react";
-import { render } from "@testing-library/react-native";
+import { render, act } from "@testing-library/react-native";
 import * as PlayerFactory from "@applicaster/zapp-react-native-utils/appUtils/playerManager/playerFactory";
 import { Player } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/player";
 import { ThemeContext } from "@applicaster/zapp-react-native-utils/theme";
 import * as navigationHooks from "@applicaster/zapp-react-native-utils/reactHooks/navigation";
+import { playerManager } from "@applicaster/zapp-react-native-utils/appUtils/playerManager";
 
 import { PlayerLiveImage } from "../PlayerLiveImageComponent";
 import * as useNavigationHooks from "@applicaster/zapp-react-native-utils/reactHooks/navigation/useNavigation";
@@ -33,7 +34,7 @@ const mockStore = configureStore();
 
 const store = mockStore({ appData: {} });
 
-const Wrapper = ({ children }: { children: React.ReactChildren }) => (
+const Wrapper = ({ children }: { children: React.ReactNode }) => (
   /* @ts-ignore */
   <Provider store={store}>
     <ThemeContext.Provider
@@ -113,4 +114,53 @@ describe("PlayerLiveImageComponent", () => {
 
     // TODO: implement this test
   });
+
+  it("should register the player for normal item", () => {
+    render(
+      <Wrapper>
+        <PlayerLiveImage {...defaultProps} />
+      </Wrapper>
+    );
+
+    const isPlayerRegistered = playerManager.isPlayerRegistered(
+      defaultProps.playerId
+    );
+
+    expect(isPlayerRegistered).toBe(true);
+  });
+
+  it("should unregister the player for normal item", () => {
+    const component = render(
+      <Wrapper>
+        <PlayerLiveImage {...defaultProps} />
+      </Wrapper>
+    );
+
+    act(() => component.unmount());
+
+    const isPlayerRegistered = playerManager.isPlayerRegistered(
+      defaultProps.playerId
+    );
+
+    expect(isPlayerRegistered).toBe(false);
+  });
+
+  it("should not register the player for 'pre-measurement' item", () => {
+    const props = {
+      ...defaultProps,
+      item: {
+        ...defaultProps.item,
+        id: "pre-measurement-1",
+      },
+    };
+
+    render(
+      <Wrapper>
+        <PlayerLiveImage {...props} />
+      </Wrapper>
+    );
+
+    const isPlayerRegistered = playerManager.isPlayerRegistered(props.playerId);
+    expect(isPlayerRegistered).toBe(false);
+  });
 });

package/Components/VideoModal/OpaqueLayer.tsx

@@ -0,0 +1,33 @@
+import * as React from "react";
+import { StyleSheet, View } from "react-native";
+
+import { useTheme } from "@applicaster/zapp-react-native-utils/theme";
+
+import { Spinner } from "../Spinner";
+
+const styles = StyleSheet.create({
+  container: {
+    ...StyleSheet.absoluteFillObject,
+    alignItems: "center",
+    justifyContent: "center",
+  },
+});
+
+export const OpaqueLayer = () => {
+  const theme = useTheme();
+
+  return (
+    <View
+      style={[
+        styles.container,
+        {
+          // we assume that it's non-transparent and we could show spinner always until it will be covered by player
+          // this spinner hides all content under modal
+          backgroundColor: theme?.app_background_color,
+        },
+      ]}
+    >
+      <Spinner />
+    </View>
+  );
+};

package/Components/VideoModal/PlayerWrapper.tsx

@@ -10,7 +10,8 @@ import { Edge, SafeAreaView } from "react-native-safe-area-context";
 import { isTV } from "@applicaster/zapp-react-native-utils/reactUtils";
 import { useIsTablet } from "@applicaster/zapp-react-native-utils/reactHooks";
 import { PlayerDetails } from "./PlayerDetails";
-import { playerDimesionsHack } from "./utils";
+import { playerDimensionsHack } from "./utils";
+import { useDelayedPlayerDetails } from "./hooks";
 
 import {
   AnimatedScrollModal,
@@ -121,34 +122,6 @@ const getTabletWidth = (
   return Number(width) - sidebarWidth;
 };
 
-const showDetails = (
-  isMobile: boolean,
-  docked: boolean,
-  isInlineModal,
-  pip
-): boolean => {
-  if (pip) {
-    return false;
-  }
-
-  if (!isInlineModal) {
-    return false;
-  }
-
-  // for mobile we always show details. Mounting of it very heavy operation.
-  if (isMobile) {
-    return true;
-  }
-
-  // workaround for tablets we need to mount/unmount in order to avoid PlayerDetails content dissappearing
-  // FIXME - find out the reason of dissapearing of content
-  if (docked) {
-    return false;
-  }
-
-  return true;
-};
-
 const PlayerWrapperComponent = (props: Props) => {
   const {
     entry,
@@ -167,7 +140,15 @@ const PlayerWrapperComponent = (props: Props) => {
 
   const isInlineModal = inline && isModal;
 
-  // const style = getStyles(baseStyle, !isTablet, isInlineModal, pip);
+  // Mounting the PlayerDetails component is a resource-intensive process.
+  // Therefore, for performance reasons, we mount it with a delay to make the rotation process as smooth as possible.
+  // The flow is as follows: the rotation occurs first, and then, after a short delay, we mount the PlayerDetails component.
+  // This helps to avoid blocking the rotation and any animations related to the rotation.
+  const isShowPlayerDetails = useDelayedPlayerDetails({
+    isInline: isInlineModal,
+    isDocked: docked,
+    isPip: pip,
+  });
 
   const isTabletLandscape = !isTV() && isTablet && !isTabletPortrait;
 
@@ -203,8 +184,8 @@ const PlayerWrapperComponent = (props: Props) => {
   const WrapperView = React.useMemo(() => (isTV() ? View : SafeAreaView), []);
 
   const childrenStyles = React.useMemo(
-    () => ({ ...playerDimensions, ...playerDimesionsHack }),
-    [containerDimensions, playerDimesionsHack]
+    () => ({ ...playerDimensions, ...playerDimensionsHack }),
+    [containerDimensions, playerDimensionsHack]
   );
 
   return (
@@ -213,7 +194,7 @@ const PlayerWrapperComponent = (props: Props) => {
       style={[
         safeAreaStyles(configuration, isTablet),
         style,
-        playerDimesionsHack,
+        playerDimensionsHack,
       ]}
     >
       <AnimationComponent
@@ -227,7 +208,7 @@ const PlayerWrapperComponent = (props: Props) => {
             defaultStyles.playerContainer,
             containerDimensions,
             containerStyle,
-            playerDimesionsHack,
+            playerDimensionsHack,
           ]}
         >
           <AnimationComponent
@@ -246,7 +227,7 @@ const PlayerWrapperComponent = (props: Props) => {
         </View>
 
         <AnimatedScrollModal>
-          {showDetails(!isTablet, docked, isInlineModal, pip) && (
+          {isShowPlayerDetails && (
             <AnimationComponent
               animationType={ComponentAnimationType.componentFade}
               style={defaultStyles.flex}

package/Components/VideoModal/VideoModal.tsx

@@ -1,6 +1,6 @@
 import React from "react";
-import * as R from "ramda";
-import { StyleSheet, View, StatusBar } from "react-native";
+import { equals } from "ramda";
+import { StyleSheet, StatusBar } from "react-native";
 
 import { HandlePlayable } from "@applicaster/zapp-react-native-ui-components/Components/HandlePlayable";
 import {
@@ -17,17 +17,20 @@ import {
 import { useIsTablet } from "@applicaster/zapp-react-native-utils/reactHooks/device/useIsTablet";
 
 import { withModalNavigationContextProvider } from "../../Contexts/ModalNavigationContext";
-import { useModalSize } from "./hooks/useModalSize";
-import { useBackgroundColor } from "./hooks/useBackgroundColor";
-import { useInitialPlayerState } from "./hooks/useInitialPlayerState";
+import {
+  useModalSize,
+  useBackgroundColor,
+  useInitialPlayerState,
+} from "./hooks";
+
 import { APP_EVENTS } from "@applicaster/zapp-react-native-utils/appUtils/events";
-import { Spinner } from "../Spinner";
 import { PathnameContext } from "@applicaster/zapp-react-native-ui-components/Contexts/PathnameContext";
 import { ROUTE_TYPES } from "@applicaster/zapp-react-native-utils/navigationUtils/routeTypes";
 import { useSubscriberFor } from "@applicaster/zapp-react-native-utils/reactHooks/useSubscriberFor";
 import { requiresAuthentication } from "@applicaster/zapp-react-native-utils/configurationUtils";
 import { playerManager } from "@applicaster/zapp-react-native-utils/appUtils";
 import { ScreenContextProvider } from "../../Contexts/ScreenContext";
+import { OpaqueLayer } from "./OpaqueLayer";
 
 import { AnimatedPlayerModalWrapper } from "@applicaster/zapp-react-native-ui-components/Components/VideoModal/ModalAnimation";
 
@@ -39,17 +42,6 @@ const styles = StyleSheet.create({
     bottom: 0,
     position: "absolute",
   },
-  // eslint-disable-next-line react-native/no-color-literals
-  loaderContainer: {
-    top: 0,
-    left: 0,
-    right: 0,
-    bottom: 0,
-    position: "absolute",
-    alignItems: "center",
-    justifyContent: "center",
-    backgroundColor: "rgba(64,64,64,.5)",
-  },
 });
 
 const VideoModalComponent = () => {
@@ -100,7 +92,7 @@ const VideoModalComponent = () => {
 
   const onHooksSuccess = ({ payload }) => {
     // set new modified entry
-    if (!R.equals(payload, item)) {
+    if (!equals(payload, item)) {
       onVideoModalHookSuccessAnalyticsEvent();
       setVideoModalItem(payload);
     }
@@ -136,7 +128,10 @@ const VideoModalComponent = () => {
 
       <PathnameContext.Provider value={pathname}>
         <ScreenContextProvider pathname={pathname}>
-          {itemIdHooksFinished === item?.id ? (
+          {/* Hide content underneath when we switch to next video in fullscreen mode */}
+          {mode === "FULLSCREEN" && <OpaqueLayer />}
+
+          {itemIdHooksFinished === item?.id && (
             <AnimatedPlayerModalWrapper
               style={[
                 styles.container,
@@ -153,10 +148,6 @@ const VideoModalComponent = () => {
                 mode={mode}
               />
             </AnimatedPlayerModalWrapper>
-          ) : (
-            <View style={styles.loaderContainer}>
-              <Spinner />
-            </View>
           )}
         </ScreenContextProvider>
       </PathnameContext.Provider>

package/Components/VideoModal/__tests__/PlayerWrapper.test.tsx

@@ -59,7 +59,7 @@ jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation", () => ({
   })),
 }));
 
-jest.mock("../utils", () => ({ playerDimesionsHack: {} }));
+jest.mock("../utils", () => ({ playerDimensionsHack: {} }));
 
 const { PlayerWrapper } = require("../PlayerWrapper");
 

package/Components/VideoModal/__tests__/__snapshots__/PlayerWrapper.test.tsx.snap

@@ -71,36 +71,6 @@ exports[`PlayerWrapper renders inline 1`] = `
         }
         testID="test-player-container"
       />
-      <View
-        animationType="componentFade"
-        style={
-          Object {
-            "flex": 1,
-          }
-        }
-      >
-        <View
-          configuration={
-            Object {
-              "tablet_landscape_player_container_background_color": "red",
-              "tablet_landscape_sidebar_width": "35%",
-            }
-          }
-          entry={
-            Object {
-              "id": "test",
-            }
-          }
-          isTablet={false}
-          isTabletLandscape={false}
-          style={
-            Object {
-              "flex": 1,
-              "paddingTop": 20,
-            }
-          }
-        />
-      </View>
     </View>
   </RNCSafeAreaView>
 </RNCSafeAreaProvider>
@@ -177,36 +147,6 @@ exports[`PlayerWrapper renders inline and docked 1`] = `
         }
         testID="test-player-container"
       />
-      <View
-        animationType="componentFade"
-        style={
-          Object {
-            "flex": 1,
-          }
-        }
-      >
-        <View
-          configuration={
-            Object {
-              "tablet_landscape_player_container_background_color": "red",
-              "tablet_landscape_sidebar_width": "35%",
-            }
-          }
-          entry={
-            Object {
-              "id": "test",
-            }
-          }
-          isTablet={false}
-          isTabletLandscape={false}
-          style={
-            Object {
-              "flex": 1,
-              "paddingTop": 20,
-            }
-          }
-        />
-      </View>
     </View>
   </RNCSafeAreaView>
 </RNCSafeAreaProvider>
@@ -299,36 +239,6 @@ exports[`PlayerWrapper renders inline on tablet in landscape orientation 1`] = `
           }
         />
       </View>
-      <View
-        animationType="componentFade"
-        style={
-          Object {
-            "flex": 1,
-          }
-        }
-      >
-        <View
-          configuration={
-            Object {
-              "tablet_landscape_player_container_background_color": "red",
-              "tablet_landscape_sidebar_width": "35%",
-            }
-          }
-          entry={
-            Object {
-              "id": "test",
-            }
-          }
-          isTablet={true}
-          isTabletLandscape={true}
-          style={
-            Object {
-              "flex": 1,
-              "paddingTop": 20,
-            }
-          }
-        />
-      </View>
     </View>
   </RNCSafeAreaView>
 </RNCSafeAreaProvider>

package/Components/VideoModal/hooks/index.ts

@@ -0,0 +1,7 @@
+export { useBackgroundColor } from "./useBackgroundColor";
+
+export { useDelayedPlayerDetails } from "./useDelayedPlayerDetails";
+
+export { useInitialPlayerState } from "./useInitialPlayerState";
+
+export { useModalSize } from "./useModalSize";

package/Components/VideoModal/hooks/useDelayedPlayerDetails.ts

@@ -0,0 +1,49 @@
+import * as React from "react";
+import { useIsTablet } from "@applicaster/zapp-react-native-utils/reactHooks";
+import { withTimeout$ } from "@applicaster/zapp-react-native-utils/idleUtils";
+
+import { showDetails } from "./utils";
+
+const TIMEOUT = 100; // ms
+
+type Props = { isInline: boolean; isDocked: boolean; isPip: boolean };
+
+/**
+ * Custom hook to determine whether to show player details with a delay.
+ *
+ * @param {Object} params - The parameters object.
+ * @param {boolean} params.isInline - Indicates if the player is inline.
+ * @param {boolean} params.isDocked - Indicates if the player is docked.
+ * @param {boolean} params.isPip - Indicates if the player is in PIP mode.
+ * @returns {boolean} - Returns true if player details should be shown, otherwise false.
+ */
+export const useDelayedPlayerDetails = ({
+  isInline,
+  isDocked,
+  isPip,
+}: Props): boolean => {
+  const [shouldShowDetails, setShouldShowDetails] = React.useState(false);
+
+  const isTablet = useIsTablet();
+
+  React.useEffect(() => {
+    const subscription = withTimeout$(TIMEOUT).subscribe({
+      next: () => {
+        setShouldShowDetails(() => {
+          return showDetails({
+            isMobile: !isTablet,
+            isInline,
+            isDocked,
+            isPip,
+          });
+        });
+      },
+    });
+
+    return () => {
+      subscription.unsubscribe();
+    };
+  }, [isDocked, isTablet, isInline, isPip]);
+
+  return shouldShowDetails;
+};

package/Components/VideoModal/hooks/utils/__tests__/showDetails.test.ts

@@ -0,0 +1,91 @@
+import { showDetails } from "..";
+
+describe("showDetails", () => {
+  it("should return false if isPip is true", () => {
+    const result = showDetails({
+      isMobile: true,
+      isInline: true,
+      isDocked: false,
+      isPip: true,
+    });
+
+    expect(result).toBe(false);
+  });
+
+  it("should return false if isDocked is true", () => {
+    const result = showDetails({
+      isMobile: true,
+      isInline: true,
+      isDocked: true,
+      isPip: false,
+    });
+
+    expect(result).toBe(false);
+  });
+
+  it("should return true if isMobile is true and isInline is true", () => {
+    const result = showDetails({
+      isMobile: true,
+      isInline: true,
+      isDocked: false,
+      isPip: false,
+    });
+
+    expect(result).toBe(true);
+  });
+
+  it("should return false if isMobile is true and isInline is false", () => {
+    const result = showDetails({
+      isMobile: true,
+      isInline: false,
+      isDocked: false,
+      isPip: false,
+    });
+
+    expect(result).toBe(false);
+  });
+
+  it("should return true if isMobile is false", () => {
+    const result = showDetails({
+      isMobile: false,
+      isInline: true,
+      isDocked: false,
+      isPip: false,
+    });
+
+    expect(result).toBe(true);
+  });
+
+  it("should return true if isMobile is false and isInline is false", () => {
+    const result = showDetails({
+      isMobile: false,
+      isInline: false,
+      isDocked: false,
+      isPip: false,
+    });
+
+    expect(result).toBe(true);
+  });
+
+  it("should return false if all properties are false except isMobile", () => {
+    const result = showDetails({
+      isMobile: true,
+      isInline: false,
+      isDocked: false,
+      isPip: false,
+    });
+
+    expect(result).toBe(false);
+  });
+
+  it("should return true if all properties are false except isInline", () => {
+    const result = showDetails({
+      isMobile: false,
+      isInline: true,
+      isDocked: false,
+      isPip: false,
+    });
+
+    expect(result).toBe(true);
+  });
+});

package/Components/VideoModal/hooks/utils/index.ts

@@ -35,3 +35,36 @@ export const orientationWasChangedFromPortraitToLandscape = ({
     isOrientationLandscape(toOrientation)
   );
 };
+
+export const showDetails = ({
+  isMobile,
+  isInline,
+  isDocked,
+  isPip,
+}: {
+  isMobile: boolean;
+  isInline: boolean;
+  isDocked: boolean;
+  isPip: boolean;
+}): boolean => {
+  if (isPip) {
+    return false;
+  }
+
+  if (isDocked) {
+    return false;
+  }
+
+  // for mobile with inline mode(rotation is portrait) we always show details.
+  if (isMobile && isInline) {
+    return true;
+  }
+
+  // for mobile with landscape rotation(player is fullscreen) we always hide details. Mounting of it is very heavy operation.
+  if (isMobile && !isInline) {
+    return false;
+  }
+
+  // for tablets we always show details
+  return true;
+};

package/Components/VideoModal/utils.ts

@@ -54,7 +54,7 @@ const fullSize = {
   height: "100%",
 };
 
-export const playerDimesionsHack = platformSelect({
+export const playerDimensionsHack = platformSelect({
   android_tv: fullSize,
   amazon: fullSize,
   lg_tv: fullSize,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-ui-components",
-  "version": "12.0.4-rc.0",
+  "version": "12.0.4-rc.2",
   "description": "Applicaster Zapp React Native ui components for the Quick Brick App",
   "main": "index.js",
   "types": "index.d.ts",
@@ -34,10 +34,10 @@
     "redux-mock-store": "^1.5.3"
   },
   "dependencies": {
-    "@applicaster/applicaster-types": "12.0.4-rc.0",
-    "@applicaster/zapp-react-native-bridge": "12.0.4-rc.0",
-    "@applicaster/zapp-react-native-redux": "12.0.4-rc.0",
-    "@applicaster/zapp-react-native-utils": "12.0.4-rc.0",
+    "@applicaster/applicaster-types": "12.0.4-rc.2",
+    "@applicaster/zapp-react-native-bridge": "12.0.4-rc.2",
+    "@applicaster/zapp-react-native-redux": "12.0.4-rc.2",
+    "@applicaster/zapp-react-native-utils": "12.0.4-rc.2",
     "promise": "^8.3.0",
     "react-router-native": "^5.1.2",
     "url": "^0.11.0",