@applicaster/zapp-react-native-utils 15.0.0-alpha.4435057569 → 15.0.0-alpha.4789154469

package/refreshUtils/RefreshCoordinator/utils/__tests__/getDataRefreshConfig.test.ts

@@ -0,0 +1,104 @@
+import {
+  getDataRefreshConfig,
+  MINIMUM_REFRESHING_INTERVAL_IN_SECONDS,
+  DEFAULT_REFRESHING_INTERVAL_IN_SECONDS,
+} from "..";
+
+describe("getDataRefreshConfig", () => {
+  it("returns correct values when rules are defined", () => {
+    const component = {
+      rules: {
+        enable_data_refreshing: true,
+        refreshing_interval: 30,
+      },
+    } as any;
+
+    const result = getDataRefreshConfig(component);
+
+    expect(result).toEqual({
+      isRefreshingEnabled: true,
+      refreshIntervalMs: 30 * 1000,
+    });
+  });
+
+  it("returns false for isRefreshingEnabled if rules flag is false", () => {
+    const component = {
+      rules: {
+        enable_data_refreshing: false,
+        refreshing_interval: 45,
+      },
+    } as any;
+
+    const result = getDataRefreshConfig(component);
+
+    expect(result).toEqual({
+      isRefreshingEnabled: false,
+      refreshIntervalMs: 45 * 1000,
+    });
+  });
+
+  it("applies minimum interval if given interval is too low", () => {
+    const component = {
+      rules: {
+        enable_data_refreshing: true,
+        refreshing_interval: 2,
+      },
+    } as any;
+
+    const result = getDataRefreshConfig(component);
+
+    expect(result.refreshIntervalMs).toBe(
+      MINIMUM_REFRESHING_INTERVAL_IN_SECONDS * 1000
+    );
+  });
+
+  it("uses default interval when rules.refreshing_interval is undefined", () => {
+    const component = {
+      rules: {
+        enable_data_refreshing: true,
+      },
+    } as any;
+
+    const result = getDataRefreshConfig(component);
+
+    expect(result.refreshIntervalMs).toBe(
+      DEFAULT_REFRESHING_INTERVAL_IN_SECONDS * 1000
+    );
+  });
+
+  it("handles missing rules gracefully", () => {
+    const component = {} as any;
+
+    const result = getDataRefreshConfig(component);
+
+    expect(result).toEqual({
+      isRefreshingEnabled: false,
+      refreshIntervalMs: DEFAULT_REFRESHING_INTERVAL_IN_SECONDS * 1000,
+    });
+  });
+
+  it("handles null component gracefully", () => {
+    const result = getDataRefreshConfig(null as any);
+
+    expect(result).toEqual({
+      isRefreshingEnabled: false,
+      refreshIntervalMs: DEFAULT_REFRESHING_INTERVAL_IN_SECONDS * 1000,
+    });
+  });
+
+  it("handles string values for rules correctly", () => {
+    const component = {
+      rules: {
+        enable_data_refreshing: "true",
+        refreshing_interval: "25",
+      },
+    } as any;
+
+    const result = getDataRefreshConfig(component);
+
+    expect(result).toEqual({
+      isRefreshingEnabled: true,
+      refreshIntervalMs: 25 * 1000,
+    });
+  });
+});

package/refreshUtils/RefreshCoordinator/utils/index.ts

@@ -0,0 +1,29 @@
+import { isTrue } from "@applicaster/zapp-react-native-utils/booleanUtils";
+import { toNumberWithDefault } from "@applicaster/zapp-react-native-utils/numberUtils";
+
+export const MINIMUM_REFRESHING_INTERVAL_IN_SECONDS = 5; // 5 seconds
+
+export const DEFAULT_REFRESHING_INTERVAL_IN_SECONDS = 60; // 1 minute
+
+export type RefreshConfig = {
+  isRefreshingEnabled: boolean;
+  refreshIntervalMs: number;
+};
+
+export const getDataRefreshConfig = (
+  component: ZappUIComponent
+): RefreshConfig => {
+  const isRefreshingEnabled = isTrue(component?.rules?.enable_data_refreshing);
+
+  const refreshing_interval = toNumberWithDefault(
+    DEFAULT_REFRESHING_INTERVAL_IN_SECONDS,
+    component?.rules?.refreshing_interval
+  );
+
+  return {
+    isRefreshingEnabled,
+    refreshIntervalMs:
+      Math.max(refreshing_interval, MINIMUM_REFRESHING_INTERVAL_IN_SECONDS) *
+      1000,
+  };
+};

package/screenPickerUtils/index.ts

@@ -1,3 +1,5 @@
+import { endsWith } from "@applicaster/zapp-react-native-utils/utils";
+
 export const getFocusableId = (id) => `PickerItem.${id}`;
 
 export const getPickerSelectorId = (id) => `PickerSelector.${id}`;
@@ -11,3 +13,6 @@ export const getScreenPickerSelectorContainerId = (id) =>
 
 export const getScreenPickerContentContainerId = (id) =>
   `${getScreenPickerId(id)}-screen-container`;
+
+export const isTabsScreenContentContainerId = (id) =>
+  endsWith("-screen-container", id);

package/screenUtils/index.ts

@@ -0,0 +1,3 @@
+export const TV_SCREEN_HEIGHT = 1080;
+
+export const TV_SCREEN_WIDTH = 1920;

package/utils/__tests__/path.test.ts

@@ -31,3 +31,10 @@ test("example 4", () => {
 
   expect(path(route, xs)).toBeUndefined();
 });
+
+test("example 5", () => {
+  const route = ["a", "b", 0];
+  const xs = { a: { b: [1, 2, 3] } };
+
+  expect(path(route, xs)).toBe(1);
+});

package/reactHooks/feed/__tests__/useFeedRefresh.test.tsx

@@ -1,75 +0,0 @@
-import { renderHook } from "@testing-library/react-native";
-
-jest.useFakeTimers();
-
-jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation", () => ({
-  useIsScreenActive: () => true,
-}));
-
-const { useFeedRefresh, feedRefreshLogger } = require("..");
-
-describe("useFeedRefresh", () => {
-  const reloadData = jest.fn();
-
-  const component = {
-    id: "foo",
-    rules: { enable_data_refreshing: true, refreshing_interval: 61 },
-  };
-
-  it("Calls reloadData after passed time lapses", () => {
-    renderHook(() => useFeedRefresh({ reloadData, component }));
-
-    expect(reloadData).not.toBeCalled();
-    jest.runOnlyPendingTimers();
-    expect(reloadData).toBeCalled();
-  });
-
-  it("Logs warning message if refresh time set below minimum value", () => {
-    const loggerSpy = jest.spyOn(feedRefreshLogger, "warning");
-
-    renderHook(() =>
-      useFeedRefresh({
-        reloadData,
-        component: {
-          ...component,
-          rules: { enable_data_refreshing: true, refreshing_interval: 2 },
-        },
-      })
-    );
-
-    expect(loggerSpy).toBeCalled();
-  });
-
-  it("Calls reloadData on a Component that had a timer setup and was re-mounted", () => {
-    reloadData.mockReset();
-
-    // it is not called before rendering hook"
-    expect(reloadData).not.toBeCalled();
-
-    // it is not called when rendering new component (Not previously rendered)
-    renderHook(() =>
-      useFeedRefresh({ reloadData, component: { ...component, id: "bar" } })
-    );
-
-    expect(reloadData).not.toBeCalled();
-
-    // it is called when rendering previously rendered component",
-    renderHook(() => useFeedRefresh({ reloadData, component }));
-    expect(reloadData).toBeCalled();
-  });
-
-  it("Doesn't refresh data when enable_data_refreshing if false", () => {
-    reloadData.mockReset();
-
-    renderHook(() =>
-      useFeedRefresh({
-        reloadData,
-        component: { ...component, rules: { enable_data_refreshing: false } },
-      })
-    );
-
-    jest.runOnlyPendingTimers();
-
-    expect(reloadData).not.toBeCalled();
-  });
-});

package/reactHooks/feed/useFeedRefresh.tsx

@@ -1,65 +0,0 @@
-import * as React from "react";
-import { path, max } from "ramda";
-import { isTrue } from "@applicaster/zapp-react-native-utils/booleanUtils";
-import { toNumberWithDefault } from "@applicaster/zapp-react-native-utils/numberUtils";
-import { useIsScreenActive } from "@applicaster/zapp-react-native-utils/reactHooks/navigation";
-
-import { reactHooksLogger } from "../logger";
-import { ReloadDataFunction } from "./useFeedLoader";
-
-export const feedRefreshLogger = reactHooksLogger.addSubsystem("feed-refresh");
-
-type Props = {
-  reloadData?: ReloadDataFunction;
-  component: ZappUIComponent;
-};
-
-const previousTimersMap = {};
-const minimumRefreshingInterval = 5;
-const defaultRefreshInterval = 60;
-
-export const useFeedRefresh = ({ reloadData, component }: Props): void => {
-  const isDataRefreshingEnabled = isTrue(
-    path(["rules", "enable_data_refreshing"], component)
-  );
-
-  const refreshing_interval = toNumberWithDefault(
-    defaultRefreshInterval,
-    component?.rules?.refreshing_interval
-  );
-
-  const refreshingIntervalInMilliseconds =
-    max(refreshing_interval, minimumRefreshingInterval) * 1000;
-
-  const isScreenActive = useIsScreenActive();
-
-  React.useEffect(() => {
-    if (isDataRefreshingEnabled && refreshing_interval && isScreenActive) {
-      if (refreshing_interval < minimumRefreshingInterval) {
-        feedRefreshLogger.warning({
-          message: `You set your feed refresh interval to ${refreshing_interval} when minimum value is ${minimumRefreshingInterval}seconds.Your feed will refresh after ${minimumRefreshingInterval}seconds.`,
-        });
-      }
-
-      if (!reloadData || typeof reloadData !== "function") {
-        feedRefreshLogger.warning({
-          message:
-            "reloadData function is undefined, feed refresh feature won't work properly",
-        });
-      }
-
-      if (previousTimersMap[component?.id]) {
-        reloadData?.();
-      }
-
-      const refreshInterval = setInterval(() => {
-        reloadData?.();
-      }, refreshingIntervalInMilliseconds);
-
-      return () => {
-        previousTimersMap[component?.id] = true;
-        clearInterval(refreshInterval);
-      };
-    }
-  }, [reloadData, isScreenActive]);
-};