@applicaster/zapp-react-native-utils 15.0.0-rc.14 → 15.0.0-rc.140

package/appUtils/HooksManager/__tests__/__snapshots__/hooksManager.test.js.snap

@@ -1,193 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`HooksManager when target route is playable executes the player hook 1`] = `
-[
-  {
-    "callback": [Function],
-    "hookPlugin": Hook {
-      "configuration": {
-        "config_field": "bar",
-      },
-      "identifier": "headless_player_hook",
-      "lastHook": true,
-      "manager": {
-        "executeHook": [Function],
-        "handleHooks": [Function],
-        "presentScreenHook": [Function],
-        "runInBackground": [Function],
-        "subscriber": {
-          "handlers": {
-            "complete": [
-              [MockFunction] {
-                "calls": [
-                  [
-                    {
-                      "callback": [Function],
-                      "hookPlugin": [Circular],
-                      "payload": {
-                        "foo": "bar",
-                      },
-                    },
-                    [Function],
-                  ],
-                ],
-                "results": [
-                  {
-                    "type": "return",
-                    "value": undefined,
-                  },
-                ],
-              },
-            ],
-            "presentScreenHook": [
-              [MockFunction],
-            ],
-            "success": [
-              [MockFunction] {
-                "calls": [
-                  [Circular],
-                ],
-                "results": [
-                  {
-                    "type": "return",
-                    "value": undefined,
-                  },
-                ],
-              },
-            ],
-          },
-          "invokeHandler": [Function],
-          "on": [Function],
-          "removeHandler": [Function],
-        },
-      },
-      "module": {
-        "hasPlayerHook": true,
-        "run": [MockFunction] {
-          "calls": [
-            [
-              {
-                "foo": "bar",
-              },
-              [Function],
-              {
-                "config_field": "bar",
-              },
-            ],
-          ],
-          "results": [
-            {
-              "type": "return",
-              "value": undefined,
-            },
-          ],
-        },
-      },
-      "state": 7,
-      "weight": 1,
-    },
-    "payload": {
-      "foo": "bar",
-    },
-  },
-  [Function],
-]
-`;
-
-exports[`HooksManager when target route is playable executes the player hook 2`] = `
-[
-  {
-    "callback": [Function],
-    "hookPlugin": Hook {
-      "configuration": {
-        "config_field": "bar",
-      },
-      "identifier": "headless_player_hook",
-      "lastHook": true,
-      "manager": {
-        "executeHook": [Function],
-        "handleHooks": [Function],
-        "presentScreenHook": [Function],
-        "runInBackground": [Function],
-        "subscriber": {
-          "handlers": {
-            "complete": [
-              [MockFunction] {
-                "calls": [
-                  [Circular],
-                ],
-                "results": [
-                  {
-                    "type": "return",
-                    "value": undefined,
-                  },
-                ],
-              },
-            ],
-            "presentScreenHook": [
-              [MockFunction],
-            ],
-            "success": [
-              [MockFunction] {
-                "calls": [
-                  [
-                    {
-                      "callback": [Function],
-                      "hookPlugin": [Circular],
-                      "payload": {
-                        "foo": "bar",
-                      },
-                    },
-                    [Function],
-                  ],
-                ],
-                "results": [
-                  {
-                    "type": "return",
-                    "value": undefined,
-                  },
-                ],
-              },
-            ],
-          },
-          "invokeHandler": [Function],
-          "on": [Function],
-          "removeHandler": [Function],
-        },
-      },
-      "module": {
-        "hasPlayerHook": true,
-        "run": [MockFunction] {
-          "calls": [
-            [
-              {
-                "foo": "bar",
-              },
-              [Function],
-              {
-                "config_field": "bar",
-              },
-            ],
-          ],
-          "results": [
-            {
-              "type": "return",
-              "value": undefined,
-            },
-          ],
-        },
-      },
-      "state": 7,
-      "weight": 1,
-    },
-    "payload": {
-      "foo": "bar",
-    },
-  },
-  [Function],
-]
-`;
-
 exports[`HooksManager when there are preload hooks hook with screen: executes 1`] = `
 [
   {

package/appUtils/HooksManager/__tests__/hooksManager.test.js

@@ -116,9 +116,23 @@ describe("HooksManager", () => {
         headlessPlayerHook.configuration
       );
 
-      expect(successHandler.mock.calls[0]).toMatchSnapshot();
+      expect(successHandler).toHaveBeenCalledTimes(1);
+      expect(successHandler.mock.calls[0][0].payload).toEqual(payload);
 
-      expect(completeHandler.mock.calls[0]).toMatchSnapshot();
+      expect(successHandler.mock.calls[0][0].hookPlugin.identifier).toBe(
+        "headless_player_hook"
+      );
+
+      expect(typeof successHandler.mock.calls[0][1]).toBe("function");
+
+      expect(completeHandler).toHaveBeenCalledTimes(1);
+      expect(completeHandler.mock.calls[0][0].payload).toEqual(payload);
+
+      expect(completeHandler.mock.calls[0][0].hookPlugin.identifier).toBe(
+        "headless_player_hook"
+      );
+
+      expect(typeof completeHandler.mock.calls[0][1]).toBe("function");
     });
   });
 

package/appUtils/HooksManager/index.ts

@@ -11,6 +11,10 @@ import { HOOKS_EVENTS, HOOKS_TYPE } from "./constants";
 
 import { hooksManagerLogger } from "./logger";
 import { HookManager, HookManagerArgs } from "./types";
+import {
+  actionExecutor,
+  ActionResult,
+} from "../../actionsExecutor/ActionExecutor";
 
 /**
  * orders the hooks according to their weight
@@ -230,7 +234,7 @@ export function HooksManager({
   function completeHook(hookPlugin, payload, callback) {
     logHookEvent(
       hooksManagerLogger.info,
-      `completeHook: hook sequence completed successfully: ${hookPlugin["identifier"]}`,
+      `completeHook: hook sequence completed successfully: ${hookPlugin.identifier}`,
       {
         payload,
         hook: hookPlugin,
@@ -276,10 +280,12 @@ export function HooksManager({
       if (hookPlugin.isCancelled()) {
         logHookEvent(
           hooksManagerLogger.info,
-          `hookCallback: hook was cancelled: ${hookPlugin["identifier"]}`,
+          `hookCallback: hook was cancelled: ${hookPlugin.identifier}`,
           {}
         );
 
+        actionExecutor.unregisterAction("finishHook");
+
         return;
       }
 
@@ -294,6 +300,8 @@ export function HooksManager({
           }
         );
 
+        actionExecutor.unregisterAction("finishHook");
+
         return hookPlugin.setStateAndNotify(HOOKS_EVENTS.ERROR, {
           error,
           hookPlugin,
@@ -305,7 +313,7 @@ export function HooksManager({
       if (!success) {
         logHookEvent(
           hooksManagerLogger.info,
-          `hookCallback: hook was cancelled: ${hookPlugin["identifier"]}`,
+          `hookCallback: hook was cancelled: ${hookPlugin.identifier}`,
           {
             payload,
             hook: hookPlugin,
@@ -316,6 +324,8 @@ export function HooksManager({
         // TODO: Temporary hack to pass getLoginProtocol to other plugins to refresh in case token expired, need be deleted later
         delete payload.getLoginProtocol;
 
+        actionExecutor.unregisterAction("finishHook");
+
         hookPlugin.setStateAndNotify(HOOKS_EVENTS.CANCEL, {
           hookPlugin,
           payload,
@@ -334,7 +344,7 @@ export function HooksManager({
         if (isHookInHomescreen && isHookFlowBlocker && cancelled) {
           logHookEvent(
             hooksManagerLogger.info,
-            `hookCallback: send app to background, cancelled flow blocker hook  ${hookPlugin["identifier"]} on home screen`,
+            `hookCallback: send app to background, cancelled flow blocker hook  ${hookPlugin.identifier} on home screen`,
             {
               payload,
               hook: hookPlugin,
@@ -349,7 +359,7 @@ export function HooksManager({
       } else {
         logHookEvent(
           hooksManagerLogger.info,
-          `hookCallback: hook successfully finished: ${hookPlugin["identifier"]}`,
+          `hookCallback: hook successfully finished: ${hookPlugin.identifier}`,
           {
             payload,
             hook: hookPlugin,
@@ -359,7 +369,7 @@ export function HooksManager({
         if (!callback) {
           logHookEvent(
             hooksManagerLogger.warn,
-            `hookCallback: ${hookPlugin["identifier"]} is missing \`callback\`, using hookCallback(default one)`,
+            `hookCallback: ${hookPlugin.identifier} is missing \`callback\`, using hookCallback(default one)`,
             {
               hookPlugin,
             }
@@ -381,6 +391,27 @@ export function HooksManager({
     };
   }
 
+  function registerFinishHookAction(payload, callback) {
+    // Ensure no stale finishHook remains (e.g. presentUI re-entry from runInBackground)
+    actionExecutor.unregisterAction("finishHook");
+
+    actionExecutor.registerAction("finishHook", async (action: ActionType) => {
+      const { success, errorMessage, abort } = action.options;
+
+      actionExecutor.unregisterAction("finishHook");
+
+      if (errorMessage) {
+        callback({ success, error: new Error(errorMessage), payload, abort });
+      } else {
+        callback({ success, error: null, payload, abort });
+      }
+
+      hooksManagerLogger.info("finishHook action executed, finishing flow");
+
+      return ActionResult.Success;
+    });
+  }
+
   /**
    * presents a screen hook by triggering an event invoking the handler with
    * the appropriate route & payload
@@ -401,13 +432,15 @@ export function HooksManager({
 
     logHookEvent(
       hooksManagerLogger.info,
-      `presentScreenHook: Presenting screen hook: ${hookPlugin["identifier"]}`,
+      `presentScreenHook: Presenting screen hook: ${hookPlugin.identifier}`,
       {
         hook: hookPlugin,
         payload,
       }
     );
 
+    registerFinishHookAction(payload, callback);
+
     hookPlugin.setStateAndNotify(HOOKS_EVENTS.PRESENT_SCREEN_HOOK, {
       hookPlugin,
       route: targetScreenRoute,
@@ -421,7 +454,7 @@ export function HooksManager({
   hooksManager.executeHook = function (hookPlugin, payload, callback) {
     logHookEvent(
       hooksManagerLogger.info,
-      `executeHook: ${hookPlugin["identifier"]}`,
+      `executeHook: ${hookPlugin.identifier}`,
       {
         hook: hookPlugin,
         payload,
@@ -433,7 +466,7 @@ export function HooksManager({
     } catch (error) {
       logHookEvent(
         hooksManagerLogger.error,
-        `executeHook: error executing hook: ${hookPlugin["identifier"]} error: ${error.message}`,
+        `executeHook: error executing hook: ${hookPlugin.identifier} error: ${error.message}`,
         {
           hook: hookPlugin,
           payload,
@@ -460,13 +493,15 @@ export function HooksManager({
     try {
       logHookEvent(
         hooksManagerLogger.info,
-        `runInBackground: Executing hook: ${hookPlugin["identifier"]}`,
+        `runInBackground: Executing hook: ${hookPlugin.identifier}`,
         {
           hook: hookPlugin,
           payload,
         }
       );
 
+      registerFinishHookAction(payload, callback);
+
       hookPlugin.module.runInBackground(
         payload,
         callback,

package/appUtils/RiverFocusManager/{index.js → index.ts}

@@ -1,11 +1,31 @@
-import * as R from "ramda";
-
-import { focusManager } from "../focusManager";
+import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager/index.ios";
+import { QUICK_BRICK_CONTENT } from "@applicaster/quick-brick-core/const";
+import { isNil, isEmpty } from "@applicaster/zapp-react-native-utils/utils";
+import { isNotNil } from "@applicaster/zapp-react-native-utils/reactUtils/helpers";
 
 let riverFocusData = {};
 let initialyPresentedScreenFocused = false;
 
 export const riverFocusManager = (function () {
+  /**
+   * Create unique key that will be used for save focused group data inside specific screen
+   * @param {{ screenId: string, isInsideContainer: boolean }}
+   * screenId Unique Id of the screen from layout.json
+   * isInsideContainer If this screen a screen picker child
+   *
+   */
+  function screenFocusableGroupId({
+    screenId,
+    isInsideContainer,
+  }: {
+    screenId: string;
+    isInsideContainer: Option<boolean>;
+  }) {
+    return `${QUICK_BRICK_CONTENT}-${screenId}${
+      isNil(isInsideContainer) ? "" : "-isInsideContainer"
+    }`;
+  }
+
   function setScreenFocusableData({
     screenFocusableGroupId,
     groupId,
@@ -78,8 +98,8 @@ export const riverFocusManager = (function () {
   }) {
     // Check if screen should be focused
     const shouldFocus =
-      (initialyPresentedScreenFocused === false && R.isEmpty(riverFocusData)) ||
-      R.compose(R.not, R.isNil)(riverFocusData[screenFocusableGroupId]) ||
+      (initialyPresentedScreenFocused === false && isEmpty(riverFocusData)) ||
+      isNotNil(riverFocusData[screenFocusableGroupId]) ||
       isDeepLink;
 
     // TODO: Uncommit it to start fixing bug where selection wrong item
@@ -118,19 +138,6 @@ export const riverFocusManager = (function () {
     }
   }
 
-  /**
-   * Create unique key that will be used for save focused group data inside specific screen
-   * @param {{ screenId: string, isInsideContainer: boolean }}
-   * screenId Unique Id of the screen from layout.json
-   * isInsideContainer If this screen a screen picker child
-   *
-   */
-  function screenFocusableGroupId({ screenId, isInsideContainer }) {
-    return `RiverFocusableGroup-${screenId}${
-      R.isNil(isInsideContainer) ? "" : "-isInsideContainer"
-    }`;
-  }
-
   return {
     setScreenFocusableData,
     clearAllScreensData,