@applicaster/zapp-react-native-utils 15.0.0-rc.105 → 15.0.0-rc.106

package/README.md

@@ -245,12 +245,6 @@ const connectionType = useConnectionInfo(true);
 
 `@applicaster/zapp-react-native/reactHooks`
 
-- `useFeedRefresh: ({ reloadData: function, component: { id: boolean | string, rules: {enable_data_refreshing: boolean, refreshing_interval: number} } }) => void` - Hook will call `reloadData` function, in the specified intervals if `enable_data_refreshing` is set to true;
-
-```javascript
-useFeedRefresh({ reloadData, component });
-```
-
 - `useFeedLoader: ({ feedUrl: string, pipesOptions?: { clearCache?: boolean, loadLocalFavourites?: boolean, silentRefresh?: boolean} }) => ({data: ?ApplicasterFeed, loading: boolean, url: string, error: Error,reloadData: (silentRefresh?: boolean) => void, loadNext: () => void})` - Hook will load data to the redux store and return a feed for the provided DSP URL. If the data for the provided url was already loaded, it will return that value
 
 ```javascript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "15.0.0-rc.105",
+  "version": "15.0.0-rc.106",
   "description": "Applicaster Zapp React Native utilities package",
   "main": "index.js",
   "types": "index.d.ts",
@@ -27,7 +27,7 @@
   },
   "homepage": "https://github.com/applicaster/quickbrick#readme",
   "dependencies": {
-    "@applicaster/applicaster-types": "15.0.0-rc.105",
+    "@applicaster/applicaster-types": "15.0.0-rc.106",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "dayjs": "^1.11.10",

package/reactHooks/feed/index.ts

@@ -1,5 +1,3 @@
-export { useFeedRefresh, feedRefreshLogger } from "./useFeedRefresh";
-
 export { useFeedLoader } from "./useFeedLoader";
 
 export { getSearchContext, getInflatedDataSourceUrl } from "./useInflatedUrl";

package/refreshUtils/RefreshCoordinator/__tests__/refreshCoordinator.test.ts

@@ -0,0 +1,161 @@
+import { refreshCoordinator } from "..";
+import { getDataRefreshConfig } from "../utils";
+import { Subscription } from "rxjs";
+
+jest.mock("../utils", () => ({
+  getDataRefreshConfig: jest.fn(),
+}));
+
+describe("RefreshCoordinator", () => {
+  const component = { id: "c1" } as ZappUIComponent;
+  const screenId = "screen-1";
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    refreshCoordinator.clear();
+    jest.useFakeTimers();
+  });
+
+  afterEach(() => {
+    jest.runOnlyPendingTimers();
+    jest.useRealTimers();
+  });
+
+  // ----------------------------------------
+  // Singleton
+  // ----------------------------------------
+  it("returns the same instance via getInstance", () => {
+    const instance1 = refreshCoordinator;
+    const instance2 = (refreshCoordinator as any).constructor.getInstance();
+    expect(instance1).toBe(instance2);
+  });
+
+  // ----------------------------------------
+  // register & unregister
+  // ----------------------------------------
+  it("register starts a timer and returns an unregister function", () => {
+    (getDataRefreshConfig as jest.Mock).mockReturnValue({
+      refreshIntervalMs: 1000,
+      isRefreshingEnabled: true,
+    });
+
+    const unregister = refreshCoordinator.register(component, screenId);
+
+    expect(typeof unregister).toBe("function");
+    expect((refreshCoordinator as any).timers.size).toBe(1);
+
+    // Calling unregister should remove timer
+    unregister();
+    expect((refreshCoordinator as any).timers.size).toBe(0);
+  });
+
+  it("does not register if refreshing is disabled", () => {
+    (getDataRefreshConfig as jest.Mock).mockReturnValue({
+      refreshIntervalMs: 1000,
+      isRefreshingEnabled: false,
+    });
+
+    const unregister = refreshCoordinator.register(component, screenId);
+
+    expect(unregister).toBeInstanceOf(Function);
+    expect((refreshCoordinator as any).timers.size).toBe(0);
+  });
+
+  it("replaces existing timer if component is re-registered", () => {
+    (getDataRefreshConfig as jest.Mock).mockReturnValue({
+      refreshIntervalMs: 1000,
+      isRefreshingEnabled: true,
+    });
+
+    const unregister1 = refreshCoordinator.register(component, screenId);
+    const unregister2 = refreshCoordinator.register(component, screenId);
+
+    expect((refreshCoordinator as any).timers.size).toBe(1);
+    expect(unregister1).toBeInstanceOf(Function);
+    expect(unregister2).toBeInstanceOf(Function);
+  });
+
+  // ----------------------------------------
+  // subscribeTo
+  // ----------------------------------------
+  it("subscribeTo only triggers listener for matching component & screen", () => {
+    (getDataRefreshConfig as jest.Mock).mockReturnValue({
+      refreshIntervalMs: 1000,
+      isRefreshingEnabled: true,
+    });
+
+    const listener = jest.fn();
+    refreshCoordinator.register(component, screenId);
+    const sub = refreshCoordinator.subscribeTo(component, screenId, listener);
+
+    // Emit a refresh manually via private Subject
+    (refreshCoordinator as any).refresh$.next({ component, screenId });
+    expect(listener).toHaveBeenCalledTimes(1);
+
+    // Non-matching component should not call listener
+    (refreshCoordinator as any).refresh$.next({
+      component: { id: "other" } as ZappUIComponent,
+      screenId,
+    });
+
+    expect(listener).toHaveBeenCalledTimes(1);
+
+    sub.unsubscribe();
+  });
+
+  // ----------------------------------------
+  // subscribeToAny
+  // ----------------------------------------
+  it("subscribeToAny triggers listener with throttling and replaces previous listener", () => {
+    const listener1 = jest.fn();
+    const listener2 = jest.fn();
+
+    // First subscription
+    const sub1: Subscription = refreshCoordinator.subscribeToAny(listener1);
+    expect(sub1).toBeInstanceOf(Subscription);
+
+    // Second subscription replaces first
+    const sub2: Subscription = refreshCoordinator.subscribeToAny(listener2);
+    expect(sub2).toBeInstanceOf(Subscription);
+
+    // Emit multiple events quickly
+    (refreshCoordinator as any).refresh$.next({ component, screenId });
+    (refreshCoordinator as any).refresh$.next({ component, screenId });
+
+    // Because of throttleTime(500ms), fast events are ignored
+    jest.advanceTimersByTime(500);
+    expect(listener1).not.toHaveBeenCalled();
+    expect(listener2).toHaveBeenCalledTimes(1);
+
+    sub2.unsubscribe();
+  });
+
+  // ----------------------------------------
+  // clear
+  // ----------------------------------------
+  it("clear stops all timers, anyListener, and recreates subject", () => {
+    (getDataRefreshConfig as jest.Mock).mockReturnValue({
+      refreshIntervalMs: 1000,
+      isRefreshingEnabled: true,
+    });
+
+    const listener = jest.fn();
+    refreshCoordinator.register(component, screenId);
+    refreshCoordinator.subscribeToAny(listener);
+
+    expect((refreshCoordinator as any).timers.size).toBe(1);
+    expect((refreshCoordinator as any).anyListenerSubscription).toBeDefined();
+
+    refreshCoordinator.clear();
+
+    expect((refreshCoordinator as any).timers.size).toBe(0);
+    expect((refreshCoordinator as any).anyListenerSubscription).toBeUndefined();
+
+    // New events on new Subject still work
+    const newListener = jest.fn();
+    refreshCoordinator.subscribeToAny(newListener);
+    (refreshCoordinator as any).refresh$.next({ component, screenId });
+    jest.advanceTimersByTime(500);
+    expect(newListener).toHaveBeenCalled();
+  });
+});

package/refreshUtils/RefreshCoordinator/index.ts

@@ -0,0 +1,216 @@
+import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
+import { interval, Subject, Subscription } from "rxjs";
+import { map, filter, throttleTime } from "rxjs/operators";
+
+import { getDataRefreshConfig } from "./utils";
+
+export { getDataRefreshConfig, type RefreshConfig } from "./utils";
+
+const THROTTLE_TIMEOUT = 500; // ms
+
+type ComponentToRefresh = {
+  component: ZappUIComponent;
+  screenId: string;
+};
+
+/**
+ * Public contract for refresh coordination.
+ *
+ * register() → starts refresh timer for a component with screen context
+ * subscribeTo() → listen to refresh events for a specific component and screen
+ * subscribeToAny() → listen to all refresh events with throttling
+ */
+interface IRefreshCoordinator {
+  register(component: ZappUIComponent, screenId: string): () => void;
+  subscribeTo(
+    component: ZappUIComponent,
+    screenId: string,
+    listener: () => void
+  ): Subscription;
+  subscribeToAny(
+    listener: (componentToRefresh: ComponentToRefresh) => void
+  ): Subscription;
+}
+
+/**
+ * Singleton implementation of RefreshCoordinator.
+ *
+ * Design goals:
+ * - One shared coordinator across the app
+ * - Multiple components can register refresh timers with screen context
+ * - Multiple listeners can subscribe to refresh events
+ * - Safe cleanup of timers and subscriptions
+ */
+class RefreshCoordinator implements IRefreshCoordinator {
+  private static instance: RefreshCoordinator;
+
+  /**
+   * Active timers per component/screen pair ((componentId, screenId) → RxJS Subscription).
+   * Each entry is keyed by a composite of componentId and screenId (via getKey),
+   * and gets its own interval stream for periodic refresh.
+   */
+  private timers: Map<string, Subscription> = new Map();
+
+  /**
+   * Central event stream emitting components that need refresh.
+   * All component interval streams push into this Subject.
+   * Multiple listeners can subscribe to receive refresh events for specific components.
+   * This is the core stream that coordinates all refresh operations.
+   */
+  private refresh$ = new Subject<ComponentToRefresh>();
+
+  // Store the current single subscriber for subscribeToAny
+  private anyListenerSubscription?: Subscription;
+
+  private constructor() {}
+
+  public static getInstance(): RefreshCoordinator {
+    if (!RefreshCoordinator.instance) {
+      RefreshCoordinator.instance = new RefreshCoordinator();
+    }
+
+    return RefreshCoordinator.instance;
+  }
+
+  /**
+   * Registers a component for periodic refresh.
+   *
+   * Behavior:
+   * - If the component was previously registered, its timer is replaced.
+   * - If refreshing is disabled, nothing is scheduled.
+   * - Returns an unregister function for manual cleanup.
+   * - Each component gets its own interval stream for periodic refresh.
+   */
+  public register(component: ZappUIComponent, screenId: string): () => void {
+    const componentId: ZappUIComponent["id"] = component.id;
+
+    // Ensure no duplicate timer exists for this component
+    this.unregister(componentId, screenId);
+
+    const refreshConfig = getDataRefreshConfig(component);
+
+    // If refreshing disabled → do nothing
+    if (!refreshConfig.isRefreshingEnabled) {
+      return noop;
+    }
+
+    /**
+     * Create interval stream:
+     * - Emits every refreshIntervalMs
+     * - Maps emission to the ComponentToRefresh object
+     * - Pushes component into central refresh$ stream
+     */
+    const subscription: Subscription = interval(refreshConfig.refreshIntervalMs)
+      .pipe(
+        map(() => ({
+          component,
+          screenId,
+        }))
+      )
+      .subscribe(this.refresh$);
+
+    this.timers.set(this.getKey(componentId, screenId), subscription);
+
+    return (): void => this.unregister(componentId, screenId);
+  }
+
+  /**
+   * Stops and removes timer for a specific component.
+   * Cleans up the RxJS subscription for that component's interval stream.
+   */
+  private unregister(
+    componentId: ZappUIComponent["id"],
+    screenId: string
+  ): void {
+    const key = this.getKey(componentId, screenId);
+    const subscription: Subscription | undefined = this.timers.get(key);
+
+    if (subscription) {
+      subscription.unsubscribe();
+      this.timers.delete(key);
+    }
+  }
+
+  private getKey(componentId: ZappUIComponent["id"], screenId: string): string {
+    return `componentId:${componentId}___screenId:${screenId}`;
+  }
+
+  /**
+   * Subscribes to refresh events for a specific component.
+   *
+   * Each subscription is independent - multiple listeners can subscribe
+   * to the same component's refresh events.
+   */
+  public subscribeTo(
+    component: ZappUIComponent,
+    screenId: string,
+    listener: () => void
+  ): Subscription {
+    return this.refresh$
+      .pipe(
+        filter(
+          (componentToRefresh: ComponentToRefresh) =>
+            componentToRefresh.component.id === component.id &&
+            componentToRefresh.screenId === screenId
+        )
+      )
+      .subscribe(listener);
+  }
+
+  /**
+   * Subscribes a single global listener to all refresh events.
+   *
+   * Behavior:
+   * - Only one active listener exists at a time.
+   *   - If a previous listener was already subscribed, it is automatically unsubscribed.
+   * - Throttles refresh events to emit at most once per THROTTLE_TIMEOUT interval.
+   * - Useful for scenarios where you want a single handler to react
+   *   to any component refresh without having multiple active callbacks.
+   *
+   * @param listener - Callback to invoke whenever any component triggers a refresh
+   * @returns The RxJS Subscription object for this listener
+   */
+  public subscribeToAny(
+    listener: (componentToRefresh: ComponentToRefresh) => void
+  ): Subscription {
+    // Unsubscribe previous listener if present to enforce "single active listener" policy
+    if (this.anyListenerSubscription) {
+      this.anyListenerSubscription.unsubscribe();
+    }
+
+    // Create a new throttled subscription
+    this.anyListenerSubscription = this.refresh$
+      .pipe(throttleTime(THROTTLE_TIMEOUT))
+      .subscribe(listener);
+
+    return this.anyListenerSubscription;
+  }
+
+  /**
+   * Fully resets coordinator state.
+   *
+   * Clears:
+   * - All component timers
+   * - Any active "subscribeToAny" listener
+   * - Recreates internal Subject to allow fresh subscriptions
+   */
+  public clear(): void {
+    // Stop and remove all active timers
+    this.timers.forEach((sub: Subscription) => sub.unsubscribe());
+    this.timers.clear();
+
+    // Stop any active "subscribeToAny" subscription
+    if (this.anyListenerSubscription) {
+      this.anyListenerSubscription.unsubscribe();
+      this.anyListenerSubscription = undefined;
+    }
+
+    // Complete old Subject to release subscribers
+    this.refresh$.complete();
+
+    // Recreate Subject so coordinator can be reused
+    this.refresh$ = new Subject<ComponentToRefresh>();
+  }
+}
+
+export const refreshCoordinator = RefreshCoordinator.getInstance();

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/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]);
-};