@applicaster/quick-brick-core 11.0.0-rc.99 → 12.0.0-rc.1

package/App/ActionsProvider/{ActionsProvider.js → ActionsProvider.tsx}

@@ -1,4 +1,3 @@
-// @flow
 import * as React from "react";
 import * as R from "ramda";
 
@@ -6,21 +5,18 @@ import { ActionsContext } from "@applicaster/zapp-react-native-ui-components/Con
 import { isNilOrEmpty } from "@applicaster/zapp-react-native-utils/reactUtils/helpers";
 
 type Props = {
-  children: React.Node,
-  rivers: { [string]: {} },
-  plugins: [{}],
-  useLocation: () => {},
-  useHistory: () => {},
+  children: React.ReactNode;
+  rivers: Record<string, any>;
+  plugins: {}[];
+  useLocation: () => {};
+  useHistory: () => {};
 };
 
-type Plugin = {
-  [any]: any,
-  identifier: string,
+type Plugin = Record<string, any> & {
+  identifier: string;
 };
 
-type PluginsIdMap = {
-  [any]: Plugin,
-};
+type PluginsIdMap = Record<string, Plugin>;
 
 const getActionPlugins = (plugins) =>
   R.filter(R.path(["module", "actionName"]))(plugins);
@@ -28,10 +24,9 @@ const getActionPlugins = (plugins) =>
 /**
  * this functions translates array of objects,
  * to object of keys create from original object.identifier
- * @param {Array} actionPlugins
  */
 
-const abstractIdentifier = (actionPlugins: [Plugin]): PluginsIdMap =>
+const abstractIdentifier = (actionPlugins: Plugin[]): PluginsIdMap =>
   R.compose(
     R.mergeAll,
     R.map((plugin) => ({ [plugin.identifier]: plugin }))
@@ -40,25 +35,26 @@ const abstractIdentifier = (actionPlugins: [Plugin]): PluginsIdMap =>
 /**
  * Component returning children.
  * Can be used to create Component from children
- * @param {React.Children} props.children
  */
-const ChildrenWrapper = ({ children }: { children: React.Element<any> }) => {
+const ChildrenWrapper = ({
+  children,
+}: {
+  children: React.ReactElement<any>;
+}) => {
   return children;
 };
 
 /**
  * It wraps children in multiple context providers
- * @param {Array} context - Array of React Context Providers
+ * @param contexts - Array of React Context Providers
  */
-const contextComposer = (contexts: [Plugin] | []): React.ComponentType<any> =>
+const contextComposer = (contexts: Plugin[]): React.ExoticComponent =>
   R.compose(...contexts)(ChildrenWrapper);
 
 /**
  * ActionsProvider is a React Context Provider for a ActionPlugins
- * @param {*} props
- * @param {React.Children} props.children - React children
- * @param {Array} props.plugins - list of app plugins
- * @return {React.Node} - Returns Children wrapped in the Action providers
+ * @param props.plugins - list of app plugins
+ * @return  Returns Children wrapped in the Action providers
  */
 export function ActionsProvider(props: Props) {
   const { children, plugins } = props;

package/App/AssetCache/CacheManager.ts

@@ -8,7 +8,7 @@ import {
   getNativeRootPath,
 } from "@applicaster/zapp-react-native-bridge/OfflineAssets";
 
-import { logger } from "./logger";
+import { log_verbose } from "./logger";
 
 type LayoutCacheStorageData = { id: string; files: FilesList };
 
@@ -17,6 +17,7 @@ type AssetCacheDataStorageData = {
 };
 
 const CACHE_DATA_KEY = "APP_ASSETS_CACHE_DATA_KEY";
+const CACHE_NAMESPACE = "offline_mode";
 const ASSET_FOLDERS = ["rivers", "plugins", "cellStyles"];
 
 const getAssetsProps = (assets) => {
@@ -49,24 +50,25 @@ export class CacheManager {
   async getFilesToCache(
     layoutId: string,
     assetFiles: FilesList
-  ): Promise<{ removedFiles: FilesList; newFiles: FilesList }> {
-    if (isTV()) return { removedFiles: [], newFiles: [] };
-
+  ): Promise<{
+    removedFiles: FilesList;
+    newFiles: FilesList;
+    unchangedFiles: FilesList;
+  }> {
+    if (isTV()) return { removedFiles: [], newFiles: [], unchangedFiles: [] };
     await this.getCacheData(layoutId);
 
     if (layoutId !== this._layoutId) {
-      logger.log({
-        message: "caching new layout id",
-        data: {
-          previousLayout: this._layoutId,
-          requestedLayout: layoutId,
-          numberOfAssets: assetFiles?.length,
-        },
+      log_verbose("getFilesToCache: caching new layout id", {
+        previousLayout: this._layoutId,
+        requestedLayout: layoutId,
+        numberOfAssets: assetFiles?.length,
       });
 
       return {
         removedFiles: this._files || [],
         newFiles: assetFiles,
+        unchangedFiles: [],
       };
     }
 
@@ -75,57 +77,52 @@ export class CacheManager {
     const files = getAssetsProps(assetFiles);
     const removedFiles = diff(this._files, files);
     const newFiles = diff(files, this._files);
-
+    const unchangedFiles = diff(diff(files, removedFiles), newFiles);
     const time = performance.now() - start;
 
-    logger.log({
-      message: `getting cache diff for current layout, took ${time} ms`,
-      data: {
+    log_verbose(
+      `getFilesToCache: getting cache diff for current layout, took ${time} ms`,
+      {
         layoutId,
         removedFiles,
         newFiles,
-      },
-    });
+      }
+    );
 
-    return { removedFiles, newFiles };
+    return { removedFiles, newFiles, unchangedFiles };
   }
 
   async clearCache(removedFiles: FilesList) {
     const folders = removedFiles.map((fileObj) => fileObj.file);
 
     if (folders && folders?.length > 0) {
-      logger.log({
-        message: "clearing asset cache folders",
-        data: { folders },
-      });
+      log_verbose("getFilesToCache: clearing asset cache folders", { folders });
 
       await deleteFolders(folders);
 
       return;
     }
 
-    logger.log("no assets to remove from cache");
+    log_verbose("getFilesToCache: no assets to remove from cache");
   }
 
   async saveCacheData(layoutId: string, assetFiles: FilesList) {
     const files = getAssetsProps(assetFiles);
 
-    logger.log({
-      message: "saving cache data",
-      data: {
-        layoutId,
-        files,
-      },
-    });
+    log_verbose("getFilesToCache: saving cache data", { layoutId, files });
 
-    await localStorage.setItem(CACHE_DATA_KEY, {
-      [layoutId]: { id: layoutId, files },
-    });
+    await localStorage.setItem(
+      CACHE_DATA_KEY,
+      {
+        [layoutId]: { id: layoutId, files },
+      },
+      CACHE_NAMESPACE
+    );
   }
 
-  private async getCacheData(layoutId: string) {
+  async getCacheData(layoutId: string) {
     const cacheData: Maybe<AssetCacheDataStorageData> =
-      await localStorage.getItem(CACHE_DATA_KEY);
+      await localStorage.getItem(CACHE_DATA_KEY, CACHE_NAMESPACE);
 
     const layoutCacheData: Maybe<LayoutCacheStorageData> =
       cacheData?.[layoutId] || {};
@@ -141,7 +138,7 @@ export class CacheManager {
       ASSET_FOLDERS
     );
 
-    await localStorage.removeItem(CACHE_DATA_KEY);
+    await localStorage.removeItem(CACHE_DATA_KEY, CACHE_NAMESPACE);
 
     return deleteFolders(assetfolders);
   }

package/App/AssetCache/__tests__/__snapshots__/assetCache.test.ts.snap

@@ -270,7 +270,8 @@ Object {
     Object {
       "file": "/path/rivers/bcfa75eacd166d575dee8da3c1d7b2f1.png",
       "path": Array [
-        "screen3",
+        "screens",
+        2,
         "styles",
         "failing_asset",
       ],
@@ -280,7 +281,8 @@ Object {
     Object {
       "file": "/path/rivers/f717cc29f30fb8376953a5cdb4666501.png",
       "path": Array [
-        "screen2",
+        "screens",
+        1,
         "navigations",
         0,
         "nav_items",
@@ -293,7 +295,8 @@ Object {
     Object {
       "file": "/path/rivers/fca006fff4ecd7d607e11be81e5d681c.png",
       "path": Array [
-        "screen1",
+        "screens",
+        0,
         "general",
         "icon",
       ],
@@ -314,33 +317,23 @@ Object {
       "url": "http://img.com/cell_asset.png",
     },
   ],
-  "pluginAssets": Array [
+  "layoutAssets": Array [
     Object {
-      "file": "/path/plugins/beeef54b948ce2a8f5b376f8033a720e.png",
+      "file": "/path/rivers/fca006fff4ecd7d607e11be81e5d681c.png",
       "path": Array [
+        "screens",
         0,
-        "configuration_json",
-        "plugin_asset",
-      ],
-      "source": "plugins",
-      "url": "http://img.com/plugin_asset.png",
-    },
-  ],
-  "screenAssets": Array [
-    Object {
-      "file": "/path/rivers/bcfa75eacd166d575dee8da3c1d7b2f1.png",
-      "path": Array [
-        "screen3",
-        "styles",
-        "failing_asset",
+        "general",
+        "icon",
       ],
       "source": "rivers",
-      "url": "http://img.com/failing_asset.png",
+      "url": "http://img.com/icon.png",
     },
     Object {
       "file": "/path/rivers/f717cc29f30fb8376953a5cdb4666501.png",
       "path": Array [
-        "screen2",
+        "screens",
+        1,
         "navigations",
         0,
         "nav_items",
@@ -351,14 +344,27 @@ Object {
       "url": "http://img.com/tab_asset.png",
     },
     Object {
-      "file": "/path/rivers/fca006fff4ecd7d607e11be81e5d681c.png",
+      "file": "/path/rivers/bcfa75eacd166d575dee8da3c1d7b2f1.png",
       "path": Array [
-        "screen1",
-        "general",
-        "icon",
+        "screens",
+        2,
+        "styles",
+        "failing_asset",
       ],
       "source": "rivers",
-      "url": "http://img.com/icon.png",
+      "url": "http://img.com/failing_asset.png",
+    },
+  ],
+  "pluginAssets": Array [
+    Object {
+      "file": "/path/plugins/beeef54b948ce2a8f5b376f8033a720e.png",
+      "path": Array [
+        0,
+        "configuration_json",
+        "plugin_asset",
+      ],
+      "source": "plugins",
+      "url": "http://img.com/plugin_asset.png",
     },
   ],
 }

package/App/AssetCache/__tests__/assetCache.test.ts

@@ -131,10 +131,8 @@ function clearMocks() {
 
 describe("getLayoutAssets", () => {
   it("returns the list of assets in the layout", async () => {
-    const { screens } = layout;
-
     await expect(
-      getLayoutAssets({ screens, pluginConfigurations, cellStyles })
+      getLayoutAssets({ layout, pluginConfigurations, cellStyles })
     ).resolves.toMatchSnapshot();
   });
 });
@@ -210,7 +208,7 @@ describe("asset cache", () => {
       clearMocks();
 
       const { assetFiles: newFiles } = await getLayoutAssets({
-        screens: layout.screens,
+        layout,
         pluginConfigurations,
         cellStyles,
       });
@@ -219,6 +217,7 @@ describe("asset cache", () => {
         Promise.resolve({
           removedFiles,
           newFiles,
+          unchangedFiles: [],
         })
       );
     });
@@ -230,15 +229,13 @@ describe("asset cache", () => {
         cellStyles,
       });
 
-      const { screens } = layout;
-
       const { assetFiles } = await getLayoutAssets({
-        screens,
+        layout,
         pluginConfigurations,
         cellStyles,
       });
 
-      expect(clearCache).toHaveBeenCalledWith(removedFiles);
+      expect(clearCache).not.toHaveBeenCalled();
       expect(storeFiles).toHaveBeenCalledWith(assetFiles);
 
       expect(saveCacheData).toHaveBeenCalledWith(
@@ -266,6 +263,7 @@ describe("asset cache", () => {
         Promise.resolve({
           removedFiles: [],
           newFiles: [],
+          unchangedFiles: [],
         })
       );
     });
@@ -288,7 +286,7 @@ describe("asset cache", () => {
       clearMocks();
 
       const { assetFiles } = await getLayoutAssets({
-        screens: layout.screens,
+        layout,
         pluginConfigurations,
         cellStyles,
       });
@@ -297,8 +295,9 @@ describe("asset cache", () => {
 
       getFilesToCache.mockImplementation(() =>
         Promise.resolve({
-          removedFiles,
+          removedFiles: [removedFiles],
           newFiles,
+          unchangedFiles: [],
         })
       );
     });
@@ -310,23 +309,21 @@ describe("asset cache", () => {
         cellStyles,
       });
 
-      const { screens } = layout;
-
       const { assetFiles } = await getLayoutAssets({
-        screens,
+        layout,
         pluginConfigurations,
         cellStyles,
       });
 
       const [removedFiles, ...newFiles] = assetFiles;
 
-      expect(clearCache).toHaveBeenCalledWith(removedFiles);
+      expect(clearCache).toHaveBeenCalledWith([removedFiles]);
 
       expect(storeFiles).toHaveBeenCalledWith(newFiles);
 
       expect(saveCacheData).toHaveBeenCalledWith(
         layoutId,
-        newFiles.filter(({ url }) => !url.includes("fail"))
+        newFiles.filter(({ url }) => !url.includes("fail")),
       );
     });
 

package/App/AssetCache/__tests__/cacheManager.test.ts

@@ -136,7 +136,8 @@ describe("CacheManager", () => {
             id: layoutId,
             files: assetFiles,
           },
-        })
+        }),
+        "offline_mode"
       );
     });
   });

package/App/AssetCache/index.ts

@@ -1,6 +1,6 @@
 /// <reference types="../../" />
 import * as R from "ramda";
-import { logger } from "./logger";
+import { log_debug, log_warning } from "./logger";
 import { CacheManager } from "./CacheManager";
 
 import {
@@ -14,20 +14,17 @@ import {
 import { isTV } from "@applicaster/zapp-react-native-utils/reactUtils";
 
 export async function getLayoutAssets({
-  screens,
+  layout,
   pluginConfigurations,
   cellStyles,
 }) {
   const nativeRootPath = await getNativeRootPath();
 
-  const screenAssets: FilesList = R.reduce(
-    (assetsList, screen) =>
-      R.concat(
-        collectAssets(screen, nativeRootPath, "rivers", [screen.id]),
-        assetsList
-      ),
-    [],
-    screens
+  const layoutAssets: FilesList = collectAssets(
+    layout,
+    nativeRootPath,
+    "rivers",
+    []
   );
 
   const pluginAssets: FilesList = collectAssets(
@@ -51,9 +48,9 @@ export async function getLayoutAssets({
     // @ts-ignore
     R.flatten
     // @ts-ignore
-  )([screenAssets, pluginAssets, cellAssets]);
+  )([layoutAssets, pluginAssets, cellAssets]);
 
-  return { assetFiles, screenAssets, pluginAssets, cellAssets };
+  return { assetFiles, layoutAssets, pluginAssets, cellAssets };
 }
 
 export async function cacheAssets({
@@ -62,6 +59,12 @@ export async function cacheAssets({
   cellStyles,
 }: CacheAssetsArgs) {
   if (!isAssetCacheEnabled() || isTV()) {
+    log_debug(
+      "cacheAssets:" + !isAssetCacheEnabled()
+        ? "Asset caching is disabled"
+        : "Running on TV platform" + "skipping asset caching"
+    );
+
     return {
       layout,
       pluginConfigurations,
@@ -69,10 +72,10 @@ export async function cacheAssets({
     };
   }
 
-  const { screens, id: layoutId } = layout;
+  const layoutId = layout?.id;
 
   if (!layoutId) {
-    logger.warn("layout id is undefined, cannot cache assets");
+    log_warning("cacheAssets: layout id is undefined, cannot cache assets");
 
     return {
       layout,
@@ -82,46 +85,83 @@ export async function cacheAssets({
   }
 
   try {
-    const { assetFiles, screenAssets, cellAssets, pluginAssets } =
+    const { assetFiles, cellAssets, pluginAssets, layoutAssets } =
       await getLayoutAssets({
-        screens,
+        layout,
         pluginConfigurations,
         cellStyles,
       });
 
-    const { removedFiles, newFiles } =
+    log_debug(`cacheAssets: getting layout assets: 
+     assetFilesCount: ${assetFiles.length},
+     cellAssets: ${cellAssets.length},
+     pluginAssets: ${pluginAssets.length},
+     layoutAssets: ${layoutAssets?.length}`);
+
+    const { removedFiles, newFiles, unchangedFiles } =
       await CacheManager.instance.getFilesToCache(layoutId, assetFiles);
 
-    let result: StoredFilesResult = {};
+    log_debug(`cacheAssets: getting files to cache for layoutId: ${layoutId},
+     removedFiles: ${removedFiles?.length}, 
+     newFiles: ${newFiles.length},
+     unchangedFiles: ${unchangedFiles.length}`);
 
-    if (newFiles?.length > 0) {
+    const needsCacheUpdate = removedFiles?.length > 0 || newFiles?.length > 0;
+    let newCacheState = unchangedFiles;
+
+    if (removedFiles?.length > 0) {
       await CacheManager.instance.clearCache(removedFiles);
-      result = await storeFiles(newFiles);
+
+      log_debug(`cacheAssets: removed files: ${removedFiles.length}`);
+    }
+
+    if (newFiles?.length > 0) {
+      // TODO: Check that we are online
+
+      const result: StoredFilesResult = await storeFiles(newFiles);
+
       const cachedFiles = R.filter(fileIsSaved(result), assetFiles);
-      await CacheManager.instance.saveCacheData(layoutId, cachedFiles);
+
+      newCacheState = cachedFiles.concat(unchangedFiles);
+
+      log_debug(
+        `cacheAssets: saved new files, cashedFiles: ${cachedFiles.length}`
+      );
     }
 
-    const updatedRivers = remapAssetPath(
-      screenAssets,
-      R.zipObj(R.map(R.prop("id"), screens), screens),
-      result
-    );
+    if (needsCacheUpdate && newCacheState) {
+      await CacheManager.instance.saveCacheData(layoutId, newCacheState);
+
+      log_debug(
+        `cacheAssets: saving caching data for layoutId: ${layoutId}, cashedFiles: ${newCacheState.length}`
+      );
+    }
+
+    const urlFileMap: { [key: string]: string } = {};
+
+    newCacheState.forEach(({ file, url }) => (urlFileMap[url] = file));
+
+    const updatedLayout = remapAssetPath(layoutAssets, layout, urlFileMap);
 
     const updatedPluginConfigurations = remapAssetPath(
       pluginAssets,
       pluginConfigurations,
-      result
+      urlFileMap
     );
 
-    const updatedCellStyles = remapAssetPath(cellAssets, cellStyles, result);
+    const updatedCellStyles = remapAssetPath(
+      cellAssets,
+      cellStyles,
+      urlFileMap
+    );
 
     return {
-      layout: { ...layout, screens: R.values(updatedRivers) },
+      layout: updatedLayout,
       pluginConfigurations: updatedPluginConfigurations,
       cellStyles: updatedCellStyles,
     };
-  } catch (e) {
-    logger.warn(e.message);
+  } catch (error) {
+    log_warning(`cacheAssets: Error caching assets, message: ${error.message}`);
 
     return { layout, pluginConfigurations, cellStyles };
   }

package/App/AssetCache/logger.ts

@@ -1,3 +1,10 @@
+import { createLogger } from "@applicaster/zapp-react-native-utils/logger";
+
 import { coreAppLogger } from "../logger";
 
-export const logger = coreAppLogger.addSubsystem("AssetCache");
+export const { log_verbose, log_debug, log_warning, log_info, log_error } =
+  createLogger({
+    category: "AssetCache",
+    subsystem: "quick-brick-core",
+    parent: coreAppLogger,
+  });

package/App/DeepLinking/URLSchemeHandler/SchemeHandlerHooks/__tests__/useOpenSchemeHandler.test.tsx

@@ -1,7 +1,7 @@
 /* eslint-disable max-len */
 import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
 import * as feedLoader from "@applicaster/zapp-react-native-utils/reactHooks/feed/useFeedLoader";
-import * as navigationHooks from "@applicaster/zapp-react-native-utils/reactHooks/navigation";
+import * as useNavigationHooks from "@applicaster/zapp-react-native-utils/reactHooks/navigation/useNavigation";
 import { cleanup, renderHook } from "@testing-library/react-hooks";
 import nock from "nock";
 import * as R from "ramda";
@@ -58,7 +58,7 @@ const navigator = {
 const mockStore = configureStore();
 
 jest
-  .spyOn(navigationHooks, "useNavigation")
+  .spyOn(useNavigationHooks, "useNavigation")
   .mockImplementation(() => navigator);
 
 const helperSpy = jest.spyOn(helpers, "handlePresentNavigation");

package/App/DeepLinking/URLSchemeHandler/SchemeHandlerHooks/__tests__/usePresentSchemeHandler.test.tsx

@@ -6,7 +6,7 @@ import { sessionStorage } from "@applicaster/zapp-react-native-bridge/ZappStorag
 import * as zappRedux from "@applicaster/zapp-react-native-redux";
 import * as helpers from "../../../helpers";
 import * as feedLoader from "@applicaster/zapp-react-native-utils/reactHooks/feed/useFeedLoader";
-import * as navigationHooks from "@applicaster/zapp-react-native-utils/reactHooks/navigation";
+import * as useNavigationHooks from "@applicaster/zapp-react-native-utils/reactHooks/navigation/useNavigation";
 
 import { Provider } from "react-redux";
 import configureStore from "redux-mock-store";
@@ -25,7 +25,7 @@ const navigator = {
 const mockStore = configureStore();
 
 jest
-  .spyOn(navigationHooks, "useNavigation")
+  .spyOn(useNavigationHooks, "useNavigation")
   .mockImplementation(() => navigator);
 
 const helperSpy = jest.spyOn(helpers, "handlePresentNavigation");