@applicaster/zapp-react-native-utils 12.0.0-rc.99 → 12.0.2-alpha.1558929238

package/playerUtils/configurationGenerator.ts

@@ -1798,6 +1798,30 @@ function getPlayerConfiguration({ platform }) {
             key: "menu_header_samsung_letter_spacing",
             initial_value: 0,
           },
+          {
+            type: "vizio_font_selector",
+            label: "Vizio Font Family",
+            key: "menu_header_vizio_font_family",
+            initial_value: "Ubuntu-Bold",
+          },
+          {
+            type: "number_input",
+            label: "Vizio Font Size",
+            key: "menu_header_vizio_font_size",
+            initial_value: 30,
+          },
+          {
+            type: "number_input",
+            label: "Vizio Line Height",
+            key: "menu_header_vizio_line_height",
+            initial_value: 60,
+          },
+          {
+            type: "number_input",
+            label: "Vizio Letter Spacing",
+            key: "menu_header_vizio_letter_spacing",
+            initial_value: 0,
+          },
         ]
       ),
       // Captions Menu - Item Text Label
@@ -1877,6 +1901,30 @@ function getPlayerConfiguration({ platform }) {
             key: "menu_item_samsung_letter_spacing",
             initial_value: 0,
           },
+          {
+            type: "vizio_font_selector",
+            label: "Vizio Font Family",
+            key: "menu_item_vizio_font_family",
+            initial_value: "Ubuntu-Medium",
+          },
+          {
+            type: "number_input",
+            label: "Vizio Font Size",
+            key: "menu_item_vizio_font_size",
+            initial_value: 25,
+          },
+          {
+            type: "number_input",
+            label: "Vizio Line Height",
+            key: "menu_item_vizio_line_height",
+            initial_value: 40,
+          },
+          {
+            type: "number_input",
+            label: "Vizio Letter Spacing",
+            key: "menu_item_vizio_letter_spacing",
+            initial_value: 0,
+          },
         ]
       ),
       // Captions Menu - Item Border
@@ -2020,6 +2068,18 @@ function getPlayerConfiguration({ platform }) {
             key: "samsung_tv_video_player_title_font_size",
             initial_value: 58,
           },
+          {
+            type: "vizio_font_selector",
+            label: "Vizio Font Family",
+            key: "vizio_video_player_title_font_family",
+            initial_value: "Ubuntu-Bold",
+          },
+          {
+            type: "number_input",
+            label: "Vizio Font Size",
+            key: "vizio_video_player_title_font_size",
+            initial_value: 58,
+          },
           {
             type: "tvos_font_selector",
             label: "tvOS Font Family",
@@ -2093,6 +2153,18 @@ function getPlayerConfiguration({ platform }) {
             key: "samsung_tv_video_player_summary_font_size",
             initial_value: 30,
           },
+          {
+            type: "vizio_font_selector",
+            label: "Vizio Font Family",
+            key: "vizio_video_player_summary_font_family",
+            initial_value: "Ubuntu-Medium",
+          },
+          {
+            type: "number_input",
+            label: "Vizio Font Size",
+            key: "vizio_video_player_summary_font_size",
+            initial_value: 30,
+          },
           {
             type: "tvos_font_selector",
             label: "tvOS Font Family",
@@ -2160,6 +2232,18 @@ function getPlayerConfiguration({ platform }) {
             key: "samsung_tv_audio_player_title_font_size",
             initial_value: 40,
           },
+          {
+            type: "vizio_font_selector",
+            label: "Vizio Font Family",
+            key: "vizio_audio_player_title_font_family",
+            initial_value: "Ubuntu-Bold",
+          },
+          {
+            type: "number_input",
+            label: "Vizio Font Size",
+            key: "vizio_audio_player_title_font_size",
+            initial_value: 40,
+          },
           {
             type: "tvos_font_selector",
             label: "tvOS Font Family",
@@ -2215,6 +2299,18 @@ function getPlayerConfiguration({ platform }) {
             key: "samsung_tv_audio_player_summary_font_size",
             initial_value: 22,
           },
+          {
+            type: "vizio_font_selector",
+            label: "Vizio Font Family",
+            key: "vizio_audio_player_summary_font_family",
+            initial_value: "Ubuntu-Medium",
+          },
+          {
+            type: "number_input",
+            label: "Vizio Font Size",
+            key: "vizio_audio_player_summary_font_size",
+            initial_value: 22,
+          },
           {
             type: "tvos_font_selector",
             label: "tvOS Font Family",
@@ -2270,6 +2366,18 @@ function getPlayerConfiguration({ platform }) {
             key: "samsung_tv_player_time_font_size",
             initial_value: 20,
           },
+          {
+            type: "vizio_font_selector",
+            label: "Vizio Font Family",
+            key: "vizio_player_time_font_family",
+            initial_value: "Ubuntu-Medium",
+          },
+          {
+            type: "number_input",
+            label: "Vizio Font Size",
+            key: "vizio_player_time_font_size",
+            initial_value: 20,
+          },
           {
             type: "android_font_selector",
             label: "Android TV Font Family",
@@ -2325,6 +2433,18 @@ function getPlayerConfiguration({ platform }) {
             key: "samsung_tv_audio_player_run_time_font_size",
             initial_value: 20,
           },
+          {
+            type: "vizio_font_selector",
+            label: "Vizio Font Family",
+            key: "vizio_audio_player_run_time_font_family",
+            initial_value: "Ubuntu-Medium",
+          },
+          {
+            type: "number_input",
+            label: "Vizio Font Size",
+            key: "vizio_audio_player_run_time_font_size",
+            initial_value: 20,
+          },
           {
             type: "tvos_font_selector",
             label: "tvOS Font Family",

package/playerUtils/imaScriptDom.ts

@@ -0,0 +1,59 @@
+import { createLogger } from "../logger";
+
+export const logger = createLogger({
+  category: "ImaDomUtils",
+  subsystem: "Player/ImaDomUtils",
+});
+
+const { log_debug, log_error, log_verbose } = logger;
+
+const removeElement = (node) => {
+  if (node) {
+    const parentNode = node.parentNode;
+
+    if (parentNode) {
+      parentNode.removeChild(node);
+    }
+  }
+};
+
+// TODO: This should probably be loaded to root of project before player init
+export const loadIMAScript = async () => {
+  return new Promise((resolve) => {
+    // If ima script is already loaded, resolve
+    const imaScript = document.getElementById("ima-script");
+
+    if (imaScript) {
+      log_verbose("loadIMAScript: IMA script already loaded");
+
+      return resolve(true);
+    }
+
+    const script = document.createElement("script");
+
+    if (__DEV__) {
+      script.src = "https://imasdk.googleapis.com/js/sdkloader/ima3_debug.js";
+    } else {
+      script.src = "https://imasdk.googleapis.com/js/sdkloader/ima3.js";
+    }
+
+    script.async = true;
+    script.id = "ima-script";
+
+    script.onload = () => {
+      removeElement(script);
+      log_debug("loadIMAScript: Loaded ima script", script.src);
+      resolve(true);
+    };
+
+    script.onerror = (_e) => {
+      removeElement(script);
+      log_error("loadIMAScript: Failed to load ima script", script.src);
+      resolve(false);
+    };
+
+    if (document.head) {
+      document.head.appendChild(script);
+    }
+  });
+};

package/reactHooks/cell-click/index.ts

@@ -30,7 +30,15 @@ type Props = {
   zappPipesData?: ZappPipesData;
 };
 
-export const useCellClick = ({ component, zappPipesData, item }: Props) => {
+type onPressReturnFn =
+  | ((_item?: ZappEntry | any, _index?: number) => Promise<void>)
+  | (() => void);
+
+export const useCellClick = ({
+  component,
+  zappPipesData,
+  item,
+}: Props): onPressReturnFn => {
   const { push, currentRoute } = useNavigation();
   const { pathname } = useRoute();
 
@@ -106,9 +114,15 @@ export const useCellClick = ({ component, zappPipesData, item }: Props) => {
     ]
   );
 
+  const onPressRef = React.useRef<onPressReturnFn>();
+
   if (!cellSelectable) {
-    return noop;
+    // update ref with dummy function
+    onPressRef.current = noop;
+  } else {
+    // update ref with the latest onPress function
+    onPressRef.current = onPress;
   }
 
-  return onPress;
+  return React.useCallback(onPressRef.current, []);
 };

package/reactHooks/debugging/__tests__/index.test.js

@@ -4,38 +4,77 @@ import {
   timers,
 } from "@applicaster/zapp-react-native-utils/reactHooks/debugging";
 
-jest.useFakeTimers();
-
 describe("Debug utils", () => {
+  let performanceNowMock;
+
+  beforeEach(() => {
+    jest.useFakeTimers();
+    // Clear the timers object
+    Object.keys(timers).forEach((key) => delete timers[key]);
+
+    // Mock performance.now()
+    // eslint-disable-next-line no-undef
+    performanceNowMock = jest.spyOn(performance, "now");
+    performanceNowMock.mockReturnValue(0); // Initial value
+  });
+
+  afterEach(() => {
+    jest.useRealTimers();
+    jest.restoreAllMocks();
+    performanceNowMock.mockRestore();
+  });
+
   describe("Unit Test: time", () => {
     it("should create new timer if timer with a label does not exist", () => {
+      performanceNowMock.mockReturnValue(1000);
       time("timer1");
       expect(timers["timer1"]).toBeDefined();
+      expect(timers["timer1"].startTime).toBe(1000);
     });
 
     it("should update start time of timer if timer with a label exists", () => {
+      // First call to time()
+      performanceNowMock.mockReturnValue(1000);
+      time("timer1");
       const previousStartTime = timers["timer1"].startTime;
-      jest.advanceTimersByTime(1000);
+
+      // Second call to time()
+      performanceNowMock.mockReturnValue(2000);
       time("timer1");
       const currentStartTime = timers["timer1"].startTime;
-      expect(previousStartTime).not.toEqual(currentStartTime);
+
+      expect(previousStartTime).toBe(1000);
+      expect(currentStartTime).toBe(2000);
     });
   });
 
   describe("Unit Test: timeEnd", () => {
-    beforeEach(() => jest.resetAllMocks());
+    beforeEach(() => {
+      jest.spyOn(console, "log").mockImplementation(() => {});
+    });
 
     it("should log elapsed time", () => {
       const logSpy = jest.spyOn(console, "log");
 
+      performanceNowMock.mockReturnValue(1000);
+      time("timer1");
+
+      performanceNowMock.mockReturnValue(2000);
       timeEnd("timer1");
 
-      expect(logSpy).toHaveBeenCalled();
+      expect(logSpy).toHaveBeenCalledWith(
+        "timer1: 1000.000ms 2",
+        expect.any(Object)
+      );
     });
 
     it("should not log elapsed time if accumulative: true in settings", () => {
       const logSpy = jest.spyOn(console, "log");
 
+      performanceNowMock.mockReturnValue(1000);
+      time("timer1");
+
+      performanceNowMock.mockReturnValue(2000);
       timeEnd("timer1", { accumulative: true });
 
       expect(logSpy).not.toHaveBeenCalled();
@@ -43,21 +82,52 @@ describe("Debug utils", () => {
   });
 
   describe("Integration Test: time and timeEnd", () => {
-    beforeEach(() => jest.resetAllMocks());
+    beforeEach(() => {
+      jest.spyOn(console, "log").mockImplementation(() => {});
+    });
 
     it("should log elapsed time on timeEnd call", () => {
       const logSpy = jest.spyOn(console, "log");
+
+      performanceNowMock.mockReturnValue(1000);
       time("timer1");
+
+      performanceNowMock.mockReturnValue(2000);
       timeEnd("timer1");
-      expect(logSpy).toHaveBeenCalled();
+
+      expect(logSpy).toHaveBeenCalledWith(
+        "timer1: 1000.000ms 2",
+        expect.objectContaining({
+          label: "timer1",
+          settings: undefined,
+        })
+      );
     });
 
-    it("should log total and average time on timeEnd call without accumulative option", () => {
+    it("should log total and average time when accumulative timing is complete", () => {
       const logSpy = jest.spyOn(console, "log");
+
+      // First timing
+      performanceNowMock.mockReturnValue(1000);
       time("timer2");
+
+      performanceNowMock.mockReturnValue(2000);
       timeEnd("timer2", { accumulative: true });
-      timeEnd("timer2");
-      expect(logSpy).toHaveBeenCalled();
+
+      // Second timing
+      performanceNowMock.mockReturnValue(3000);
+      time("timer2");
+
+      performanceNowMock.mockReturnValue(5000);
+      timeEnd("timer2"); // This will log because timer is accumulative (callCount > 1)
+
+      expect(logSpy).toHaveBeenCalledWith(
+        "timer2: 2000.000ms 2",
+        expect.objectContaining({
+          label: "timer2",
+          settings: undefined,
+        })
+      );
     });
   });
 });

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

@@ -77,8 +77,6 @@ describe("useBatchLoading", () => {
 
     const actions = store.getActions();
 
-    expect(useDispatchSpy).toBeCalledTimes(1);
-
     expect(actions).toHaveLength(2);
 
     expect(actions[0]).toMatchObject({
@@ -129,6 +127,8 @@ describe("useBatchLoading", () => {
       // ... more items
     ];
 
+    expect(useDispatchSpy).toBeCalledTimes(0);
+
     renderHook(() => useBatchLoading(data, { initialBatchSize, riverId }), {
       wrapper,
       initialProps: { store },
@@ -136,8 +136,6 @@ describe("useBatchLoading", () => {
 
     const actions = store.getActions();
 
-    expect(useDispatchSpy).toBeCalledTimes(1);
-
     expect(actions).toHaveLength(1);
 
     expect(actions[0]).toMatchObject({
@@ -172,8 +170,6 @@ describe("useBatchLoading", () => {
       initialProps: { store },
     });
 
-    expect(useDispatchSpy).toBeCalledTimes(1);
-
     const actions = store.getActions();
 
     expect(actions).toHaveLength(3);
@@ -218,6 +214,73 @@ describe("useBatchLoading", () => {
 
     expect(result.current).toBe(true);
   });
+
+  it("gallery-qb: loadPipesData should be called only once for first component in the gallery", () => {
+    const store = mockStore({
+      zappPipes: {},
+      test: "true",
+    });
+
+    useDispatchSpy.mockReturnValue(store.dispatch);
+
+    const initialBatchSize = 3;
+    const riverId = "123";
+
+    const data = [
+      {
+        component_type: "gallery-qb",
+        ui_components: [{ data: { source: "url1" } }],
+      },
+      { data: { source: "url2" } },
+      { data: { source: "url3" } },
+      { data: { source: "url4" } },
+      { data: { source: "url5" } },
+      { data: { source: "url6" } },
+      // ... more items
+    ];
+
+    renderHook(() => useBatchLoading(data, { initialBatchSize, riverId }), {
+      wrapper,
+      initialProps: { store },
+    });
+
+    const actions = store.getActions();
+
+    expect(actions).toHaveLength(1);
+  });
+
+  it("gallery-qb: initial batch ready when all initial items loaded", () => {
+    const store = mockStore({
+      zappPipes: {
+        url1: {
+          loading: false,
+          error: false,
+          data: {},
+        },
+      },
+    });
+
+    useDispatchSpy.mockReturnValue(store.dispatch);
+
+    const initialBatchSize = 3;
+    const riverId = "123";
+
+    const data: Partial<ZappUIComponent>[] = [
+      {
+        component_type: "gallery-qb",
+        ui_components: [{ data: { source: "url1" } }],
+      },
+      { data: { source: "url2" } },
+      { data: { source: "url3" } },
+    ];
+
+    const { result } = renderHook(
+      () => useBatchLoading(data, { initialBatchSize, riverId }),
+      { wrapper, initialProps: { store } }
+    );
+
+    expect(result.current).toBe(true);
+  });
 });
 
 describe("allFeedsIsReady", () => {

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

@@ -135,7 +135,11 @@ describe("useFeedLoader", () => {
       );
 
       expect(result.current.data).toBeNull();
-      expect(loadPipesDataSpy).toBeCalledWith(feedUrl, {});
+
+      expect(loadPipesDataSpy).toBeCalledWith(feedUrl, {
+        clearCache: true,
+        riverId: undefined,
+      });
 
       const store2 = mockStore({
         plugins: [],
@@ -172,7 +176,11 @@ describe("useFeedLoader", () => {
       );
 
       expect(result.current.data).toBeNull();
-      expect(loadPipesDataSpy).toBeCalledWith(feedUrl, {});
+
+      expect(loadPipesDataSpy).toBeCalledWith(feedUrl, {
+        clearCache: true,
+        riverId: undefined,
+      });
 
       const store2 = mockStore({
         plugins: [],

package/reactHooks/feed/useBatchLoading.ts

@@ -45,19 +45,23 @@ const filterEmptyData = (data) => {
   return true;
 };
 
-const extractData = compose(uniq, map(dataOf));
+const getData = (rawData) =>
+  rawData.component_type === "gallery-qb"
+    ? rawData.ui_components[0].data
+    : rawData.data;
+
+const extractData = compose(uniq, map(getData));
 
 export const allFeedsIsReady = (
   feeds: ZappPipesCollection,
   urls: (ZappDataSourceSource | null)[]
 ): boolean =>
-  urls
-    .filter(complement(isNil))
-    .map((url) => (url ? checkFeedIsReady(feeds[url]) : false))
-    .every(Boolean);
+  urls.every((url) =>
+    isNil(url) ? true : url && feeds[url] ? checkFeedIsReady(feeds[url]) : false
+  );
 
 export const useBatchLoading = (
-  data: { data?: ZappDataSource }[],
+  componentsToRender: { data?: ZappDataSource; component_type: string }[],
   options: Options
 ) => {
   const dispatch = useDispatch();
@@ -65,10 +69,18 @@ export const useBatchLoading = (
   const [searchContext] = ZappPipesSearchContext.useZappPipesContext();
   const [hasEverBeenReady, setHasEverBeenReady] = React.useState(false);
 
-  const takeBatchSize = take(
-    min(options.initialBatchSize ?? DEFAULT_BATCH_SIZE, data.length)
-  );
+  // if first component is gallery-qb, take only one component for initial load
+  const takeSize =
+    componentsToRender?.[0]?.component_type === "gallery-qb"
+      ? 1
+      : min(
+          options.initialBatchSize ?? DEFAULT_BATCH_SIZE,
+          componentsToRender.length
+        );
+
+  const takeBatchSize = React.useCallback(take(takeSize), [takeSize]);
 
+  // Prepare inflated url for datasource
   const getUrl = React.useCallback(
     (data) => {
       const mappedFeed = data.mapping
@@ -88,13 +100,16 @@ export const useBatchLoading = (
     [entryContext, screenContext, searchContext]
   );
 
-  const batchData = takeBatchSize(data);
+  // components for initial load
+  const batchComponents = takeBatchSize(componentsToRender);
 
+  // contains datasources from batch components loading
   const feedData: ZappDataSource[] = React.useMemo(
-    () => extractData(batchData).filter(filterEmptyData),
-    [batchData]
+    () => extractData(batchComponents).filter(filterEmptyData),
+    [batchComponents]
   );
 
+  // contains inflated urls from batch components loading
   const feedUrls: ZappDataSourceSource[] = React.useMemo(
     () =>
       feedData.map((data) => {
@@ -102,34 +117,43 @@ export const useBatchLoading = (
 
         return mappedFeedUrl;
       }),
-    [] // No watchers as batch loaders is used only for initial load
+    []
   );
 
   const feeds = useZappPipesFeeds(feedUrls);
 
-  React.useEffect(() => {
-    const datasources = map(dataOf, batchData)
-      .filter(filterEmptyData)
-      .filter((data) => {
-        const feed = feeds[data.source];
+  // dispatch loadPipesData for each feed that is not loaded
+  const runBatchLoading = React.useCallback(() => {
+    batchComponents.forEach((rawData: any) => {
+      // 1. get data (dataOf)
 
-        if (!feed) return true;
+      const data = getData(rawData);
 
-        return !feedHasData(feed) && !feedIsLoading(feed);
-      });
+      // 2. filter out empty data filterEmptyData
+      if (!filterEmptyData(data)) return false;
 
-    datasources.forEach((data) => {
-      const mappedFeedUrl = getUrl(data);
+      // 3. filter out data that is already loaded (feeds[data.source]) &  !feedHasData(feed) && !feedIsLoading(feed);
+      const feed = feeds[data?.source];
 
-      if (mappedFeedUrl) {
-        return dispatch(
-          loadPipesData(mappedFeedUrl, { riverId: options.riverId })
-        );
+      if (!feed || (!feedHasData(feed) && !feedIsLoading(feed))) {
+        const mappedFeedUrl = getUrl(data);
+
+        if (mappedFeedUrl) {
+          // 4. load data
+          return dispatch(
+            loadPipesData(mappedFeedUrl, { riverId: options.riverId })
+          );
+        }
       }
     });
-  }, []); // No watchers as batch loaders is used only for initial load
+  }, [feedUrls]);
+
+  React.useEffect(() => {
+    runBatchLoading();
+  }, []);
 
   React.useEffect(() => {
+    // check if all feeds are ready and set hasEverBeenReady to true
     if (allFeedsIsReady(feeds, feedUrls) && !hasEverBeenReady) {
       setHasEverBeenReady(true);
     }