@applicaster/zapp-react-native-utils 16.0.0-rc.1 → 16.0.0-rc.100

package/analyticsUtils/AnalyticsEvents/sendMenuClickEvent.ts

@@ -6,9 +6,9 @@ import { postAnalyticEvent } from "../manager";
 import { ANALYTICS_CORE_EVENTS } from "../events";
 
 type AnalyticsDefaultHelperProperties = {
-  analyticsScreenData: AnalyticsScreenProperties;
+  analyticsScreenData?: AnalyticsScreenProperties;
   extraProps: any;
-  props;
+  props?: any;
 };
 
 export const sendMenuClickEvent = ({

package/analyticsUtils/PlayerAnalyticsManager.ts

@@ -8,7 +8,7 @@ import {
 } from "../appUtils/playerManager";
 import { Player } from "../appUtils/playerManager/player";
 import { AnalyticPlayerListener } from "./AnalyticPlayerListener";
-import { PlayerRole } from "../appUtils/playerManager/conts";
+import { PlayerRole } from "../appUtils/playerManager/const";
 
 enum PlayerAnalyticsTrackerType {
   PlayerAnalyticsTracker = "PlayerAnalyticsTracker",
@@ -23,6 +23,15 @@ class PlayerAnalyticsTrackerFactory {
         return new PlayerAnalyticsTracker();
     }
   }
+
+  onPlayerRegistered(tracker: PlayerAnalyticsTrackerI, player: Player) {
+    tracker.setPlayer(player);
+    tracker.onPlayerPresented();
+  }
+
+  onPlayerUnRegistered(tracker?: PlayerAnalyticsTrackerI) {
+    tracker?.onPlayerClosed();
+  }
 }
 
 export class PlayerAnalyticsManager implements PlayerLifecycleListener {
@@ -70,7 +79,7 @@ export class PlayerAnalyticsManager implements PlayerLifecycleListener {
     }
 
     const tracker = this.getTracker(player.playerId);
-    tracker.setPlayer(player);
+    this.trackerFactory.onPlayerRegistered(tracker, player);
 
     const analyticsListener = new AnalyticPlayerListener({
       analyticsTracker: tracker,
@@ -84,6 +93,7 @@ export class PlayerAnalyticsManager implements PlayerLifecycleListener {
   };
 
   onUnRegistered = (player: Player) => {
+    this.trackerFactory.onPlayerUnRegistered(this.trackers[player.playerId]);
     player.removeListener(AnalyticPlayerListener.analyticsListenerID);
     delete this.trackers[player.playerId];
   };

package/analyticsUtils/__tests__/analyticsMapper.test.ts

@@ -74,4 +74,39 @@ describe("Analytics Mapper", () => {
     const rules = fixtures.ACPEventRules;
     await setConfigRunMapTest(rules, fixtures.ACPEventEvents);
   });
+
+  it("Does not let an ignore rule short-circuit later events", async () => {
+    await setConfigRunMapTest(
+      fixtures.ignoreOrderingRules,
+      fixtures.ignoreOrderingEvents
+    );
+  });
+
+  it("Keeps the original name when rename is empty", async () => {
+    await setConfigRunMapTest(
+      fixtures.emptyRenameRules,
+      fixtures.emptyRenameEvents
+    );
+  });
+
+  it("Renames via a regex with no named groups", async () => {
+    await setConfigRunMapTest(
+      fixtures.regexNonNamedFullMatchRules,
+      fixtures.regexNonNamedFullMatchEvents
+    );
+  });
+
+  it("Substitutes every named group in a regex rename", async () => {
+    await setConfigRunMapTest(
+      fixtures.regexMultiGroupRenameRules,
+      fixtures.regexMultiGroupRenameEvents
+    );
+  });
+
+  it("Does not fall back to event match when a regex rule does not match", async () => {
+    await setConfigRunMapTest(
+      fixtures.regexEventNoFallbackRules,
+      fixtures.regexEventNoFallbackEvents
+    );
+  });
 });

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testACP_events.json

@@ -23,7 +23,7 @@
     "second": {
       "name": "EventName",
       "params": {
-        "acp": 1
+        "acp": "1"
       }
     }
   }

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testBlockUnlistedParams_rules.json

@@ -12,4 +12,4 @@
     }
   ],
   "strategy": "allowUnlisted"
-}
+}

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testEmptyRenameKeepsName_events.json

@@ -0,0 +1,4 @@
+[
+  { "first": { "name": "keep_me", "params": {} },
+    "second": { "name": "keep_me", "params": {} } }
+]

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testEmptyRenameKeepsName_rules.json

@@ -0,0 +1,6 @@
+{
+  "rules": [
+    { "event": "keep_me", "ignore": false, "rename": "", "strategy": "allowUnlisted" }
+  ],
+  "strategy": "allowUnlisted"
+}

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testEventRegex_events.json

@@ -2,17 +2,11 @@
   {
     "first": {
       "name": "Screen viewed: Ads & redirects",
-      "params": {
-        "ignored_param": "removed_value",
-        "kept_param": "kept_value"
-      }
+      "params": {}
     },
     "second": {
       "name": "Screen Ads & redirects",
-      "params": {
-        "ignored_param": "removed_value",
-        "kept_param": "kept_value"
-      }
+      "params": {}
     }
   }
-]
+]

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testIgnoreOrdering_events.json

@@ -0,0 +1,18 @@
+[
+  {
+    "first": {
+      "name": "screen_view",
+      "params": {}
+    },
+    "second": {
+      "name": "page_view",
+      "params": {}
+    }
+  },
+  {
+    "first": {
+      "name": "player_presented",
+      "params": {}
+    }
+  }
+]

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testIgnoreOrdering_rules.json

@@ -0,0 +1,16 @@
+{
+  "rules": [
+    {
+      "event": "player_presented",
+      "ignore": true,
+      "strategy": "allowUnlisted"
+    },
+    {
+      "event": "screen_view",
+      "ignore": false,
+      "rename": "page_view",
+      "strategy": "allowUnlisted"
+    }
+  ],
+  "strategy": "allowUnlisted"
+}

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexEventNoFallback_events.json

@@ -0,0 +1,4 @@
+[
+  { "first": { "name": "my_event", "params": {} },
+    "second": { "name": "my_event", "params": {} } }
+]

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexEventNoFallback_rules.json

@@ -0,0 +1,6 @@
+{
+  "rules": [
+    { "event": "my_event", "ignore": false, "rename": "should_not_apply", "regex": "wont_match_.*", "strategy": "allowUnlisted" }
+  ],
+  "strategy": "allowUnlisted"
+}

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexMultiGroupRename_events.json

@@ -0,0 +1,4 @@
+[
+  { "first": { "name": "play-video", "params": {} },
+    "second": { "name": "play_video", "params": {} } }
+]

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexMultiGroupRename_rules.json

@@ -0,0 +1,6 @@
+{
+  "rules": [
+    { "ignore": false, "rename": "$<first>_$<second>", "regex": "(?<first>[a-z]+)-(?<second>[a-z]+)", "strategy": "allowUnlisted" }
+  ],
+  "strategy": "allowUnlisted"
+}

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexNonNamedFullMatch_events.json

@@ -0,0 +1,4 @@
+[
+  { "first": { "name": "screen_view", "params": {} },
+    "second": { "name": "renamed", "params": {} } }
+]

package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexNonNamedFullMatch_rules.json

@@ -0,0 +1,6 @@
+{
+  "rules": [
+    { "ignore": false, "rename": "renamed", "regex": "screen_view", "strategy": "allowUnlisted" }
+  ],
+  "strategy": "allowUnlisted"
+}

package/analyticsUtils/__tests__/fixtures/index.js

@@ -14,6 +14,16 @@ import blockUnlistedEventEvents from "./analytics_mapper_testBlockUnlistedEvents
 import blockUnlistedEventRules from "./analytics_mapper_testBlockUnlistedEvents_rules.json";
 import ACPEventEvents from "./analytics_mapper_testACP_events.json";
 import ACPEventRules from "./analytics_mapper_testACP_rules.json";
+import emptyRenameRules from "./analytics_mapper_testEmptyRenameKeepsName_rules.json";
+import emptyRenameEvents from "./analytics_mapper_testEmptyRenameKeepsName_events.json";
+import ignoreOrderingRules from "./analytics_mapper_testIgnoreOrdering_rules.json";
+import ignoreOrderingEvents from "./analytics_mapper_testIgnoreOrdering_events.json";
+import regexEventNoFallbackRules from "./analytics_mapper_testRegexEventNoFallback_rules.json";
+import regexEventNoFallbackEvents from "./analytics_mapper_testRegexEventNoFallback_events.json";
+import regexMultiGroupRenameRules from "./analytics_mapper_testRegexMultiGroupRename_rules.json";
+import regexMultiGroupRenameEvents from "./analytics_mapper_testRegexMultiGroupRename_events.json";
+import regexNonNamedFullMatchRules from "./analytics_mapper_testRegexNonNamedFullMatch_rules.json";
+import regexNonNamedFullMatchEvents from "./analytics_mapper_testRegexNonNamedFullMatch_events.json";
 
 export const fixtures = {
   renameRules,
@@ -32,4 +42,14 @@ export const fixtures = {
   blockUnlistedEventRules,
   ACPEventEvents,
   ACPEventRules,
+  emptyRenameRules,
+  emptyRenameEvents,
+  ignoreOrderingRules,
+  ignoreOrderingEvents,
+  regexEventNoFallbackRules,
+  regexEventNoFallbackEvents,
+  regexMultiGroupRenameRules,
+  regexMultiGroupRenameEvents,
+  regexNonNamedFullMatchRules,
+  regexNonNamedFullMatchEvents,
 };

package/analyticsUtils/analyticsMapper.ts

@@ -76,7 +76,10 @@ class StateHolder {
       delete this.pluckedParams[prefix];
     }
 
-    return this._cap?.[suffix];
+    // Stringify so values match the native iOS/Android mappers (which coerce
+    // analyticsCustomProperties values to strings) — keeps GA4 data consistent
+    // across web/LG/Samsung and native platforms.
+    return this._cap?.[suffix]?.toString() ?? null;
   }
 
   private async getFromLocalAndSession(

package/analyticsUtils/playerAnalyticsTracker.ts

@@ -4,8 +4,14 @@ import { isTrue } from "@applicaster/zapp-react-native-utils/booleanUtils";
 import { postAnalyticEvent } from "./manager";
 import { isLive } from "../playerUtils";
 import { extensionsEvents } from "./AnalyticsEvents/helper";
-import { AD_EVENT, EVENT_TYPES, PLAYER_DISPLAY_STATES } from "./events";
+import {
+  AD_EVENT,
+  EVENT_TYPES,
+  GENERAL_EVENT,
+  PLAYER_DISPLAY_STATES,
+} from "./events";
 import { Player } from "../appUtils/playerManager/player";
+import { isNil } from "@applicaster/zapp-react-native-utils/utils";
 
 export interface PlayerAnalyticsTrackerI {
   handleAnalyticEvent(
@@ -13,6 +19,8 @@ export interface PlayerAnalyticsTrackerI {
     eventData?: QuickBrickPlayer.EventData
   ): void;
   setPlayer(player: Player): void;
+  onPlayerPresented(): void;
+  onPlayerClosed(): void;
 }
 
 export class PlayerAnalyticsTracker implements PlayerAnalyticsTrackerI {
@@ -26,6 +34,15 @@ export class PlayerAnalyticsTracker implements PlayerAnalyticsTrackerI {
     this.player = player;
   }
 
+  onPlayerPresented() {
+    this.handleAnalyticEvent(GENERAL_EVENT.player_presented);
+  }
+
+  onPlayerClosed() {
+    this.handleAnalyticEvent(GENERAL_EVENT.session_end);
+    this.handleAnalyticEvent(GENERAL_EVENT.player_closed);
+  }
+
   isAdBreak(event: string): boolean {
     const adBreakEvents = [
       AD_EVENT.ad_break_start,
@@ -180,7 +197,8 @@ export class PlayerAnalyticsTracker implements PlayerAnalyticsTrackerI {
       this.entry?.extensions?.free || this.entry?.extensions?.isFree;
 
     const title = this.entry?.title;
-    const streamType = isLive(this.entry) ? "live" : "vod"; // Todo: determine other types, channel, podcast, aod
+    const isStreamLive = isLive(this.entry);
+    const streamType = isStreamLive ? "live" : "vod"; // Todo: determine other types, channel, podcast, aod
 
     const currentPosition = this.getCurrentPosition(
       event,
@@ -201,6 +219,7 @@ export class PlayerAnalyticsTracker implements PlayerAnalyticsTrackerI {
     );
 
     const playerState = this.getPlayerState();
+    const playerType = this.player?.playerPluginId;
 
     const analyticsCustomProperties = extensionsEvents(this.entry?.extensions);
 
@@ -210,7 +229,11 @@ export class PlayerAnalyticsTracker implements PlayerAnalyticsTrackerI {
       name: title,
       media_type: mediaType,
       stream_type: streamType,
-      duration: mediaDuration,
+      player_type: playerType,
+      // We do not pass duration for live streams anymore (it's now seekableDuration),
+      //  but we can't mark it as optional in Analytics Mapper yet,
+      //  so we set it to -1 for live streams
+      duration: isStreamLive && isNil(mediaDuration) ? -1 : mediaDuration,
       current_position: currentPosition,
       player_state: playerState,
       stream_format: contentType,

package/appUtils/HooksManager/index.ts

@@ -1,14 +1,11 @@
 import * as R from "ramda";
 
 import { subscriber } from "@applicaster/zapp-react-native-utils/functionUtils";
-import {
-  QUICK_BRICK_EVENTS,
-  sendQuickBrickEvent,
-} from "@applicaster/zapp-react-native-bridge/QuickBrick";
-
 import { Hook } from "./Hook";
 import { HOOKS_EVENTS, HOOKS_TYPE } from "./constants";
 
+import { platformToBackground } from "../platform";
+
 import { hooksManagerLogger } from "./logger";
 import { HookManager, HookManagerArgs } from "./types";
 import {
@@ -90,7 +87,7 @@ export function HooksManager({
 }: HookManagerArgs): HookManager {
   hooksManagerLogger.addContext({ targetScreenId: targetScreen.id });
 
-  function logHookEvent(func, message, data) {
+  function logHookEvent(func, message, data = {}) {
     func({
       message,
       data: __DEV__ ? data : null,
@@ -347,14 +344,10 @@ export function HooksManager({
             `hookCallback: send app to background, cancelled flow blocker hook  ${hookPlugin.identifier} on home screen`,
             {
               payload,
-              hook: hookPlugin,
             }
           );
 
-          // TODO: Add this logic to platformBack and rename platformBack to platformToBackground for all platforms
-          sendQuickBrickEvent(QUICK_BRICK_EVENTS.MOVE_APP_TO_BACKGROUND, {
-            MOVE_APP_TO_BACKGROUND: true,
-          });
+          platformToBackground();
         }
       } else {
         logHookEvent(
@@ -362,17 +355,13 @@ export function HooksManager({
           `hookCallback: hook successfully finished: ${hookPlugin.identifier}`,
           {
             payload,
-            hook: hookPlugin,
           }
         );
 
         if (!callback) {
           logHookEvent(
-            hooksManagerLogger.warn,
-            `hookCallback: ${hookPlugin.identifier} is missing \`callback\`, using hookCallback(default one)`,
-            {
-              hookPlugin,
-            }
+            hooksManagerLogger.debug,
+            `hookCallback: ${hookPlugin.identifier} is missing \`callback\`, using hookCallback(default one)`
           );
 
           callback = hookCallback;
@@ -509,6 +498,15 @@ export function HooksManager({
         presentUI
       );
     } catch (e) {
+      // Without this the failure is invisible: the hook stops right after the
+      // "Executing hook" line, with nothing in the log explaining why and no
+      // remaining hook ever running.
+      logHookEvent(
+        hooksManagerLogger.error,
+        `runInBackground: hook ${hookPlugin.identifier} threw: ${e?.message}`,
+        { hook: hookPlugin, payload, error: e, stack: e?.stack }
+      );
+
       hookPlugin.setStateAndNotify(HOOKS_EVENTS.ERROR, {
         error: e,
         hookPlugin,

package/appUtils/contextKeysManager/__tests__/getKey/failure.test.ts

@@ -46,7 +46,7 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key: invalidKey },
     });
 

package/appUtils/contextKeysManager/__tests__/removeKey/failure.test.ts

@@ -47,7 +47,7 @@ describe("Context Keys Manager - removeKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 

package/appUtils/contextKeysManager/__tests__/setKey/failure/invalidKey.test.ts

@@ -48,7 +48,7 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 
@@ -105,7 +105,7 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 
@@ -162,7 +162,7 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 
@@ -217,7 +217,7 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 

package/appUtils/contextKeysManager/index.ts

@@ -109,7 +109,7 @@ export class ContextKeysManager {
     if (!keyIsValid(parsedKey)) {
       this._logger.warn({
         message:
-          "Provided key is not valid - expecing an object with namespace and key properties",
+          "Provided key is not valid - expecting an object with namespace and key properties",
         data: { key },
       });
 

package/appUtils/contextKeysManager/utils/index.ts

@@ -1,40 +1,53 @@
-import * as R from "ramda";
 import { DEFAULT_NAMESPACE } from "../consts";
 import { KeyName, KeyNameObj } from "../index";
 
-const lastDotRegex = /\.([^.]+)$/;
-const splitByLastDot = R.compose(R.init, R.split(lastDotRegex));
-
 export function getNamespaceAndKey(namespacedKey: KeyName): KeyNameObj {
   if (typeof namespacedKey !== "string") return namespacedKey;
 
-  const namespacedKeyProps = namespacedKey.includes(".")
-    ? splitByLastDot(namespacedKey)
-    : [DEFAULT_NAMESPACE, namespacedKey];
+  if (!namespacedKey.includes(".")) {
+    return { namespace: DEFAULT_NAMESPACE, key: namespacedKey };
+  }
+
+  // split on the last dot - the namespace itself may contain dots
+  const lastDotIndex = namespacedKey.lastIndexOf(".");
 
-  return R.zipObj(["namespace", "key"], namespacedKeyProps);
+  return {
+    namespace: namespacedKey.slice(0, lastDotIndex),
+    key: namespacedKey.slice(lastDotIndex + 1),
+  };
 }
 
-const propIsNotNullOrUndefined = (prop) =>
-  R.compose(R.not, R.isNil, R.prop(prop));
+const hasOwn = (obj: object, prop: string): boolean =>
+  Object.prototype.hasOwnProperty.call(obj, prop);
+
+const isEmpty = (value: unknown): boolean => {
+  if (typeof value === "string" || Array.isArray(value)) {
+    return value.length === 0;
+  }
+
+  if (value !== null && typeof value === "object") {
+    return Object.keys(value).length === 0;
+  }
+
+  return false;
+};
+
+export const keyIsValid = (parsedKey: unknown): boolean => {
+  if (parsedKey == null) return false;
+  if (typeof parsedKey === "string") return false;
+  if (Array.isArray(parsedKey)) return false;
 
-const propIsNotEmpty = (prop) => R.compose(R.not, R.isEmpty, R.prop(prop));
+  const obj = parsedKey as Record<string, unknown>;
 
-export const keyIsValid = R.allPass([
-  R.compose(R.not, R.isNil),
-  R.compose(R.not, R.is(String)),
-  R.compose(R.not, R.is(Array)),
-  R.has("key"),
-  R.has("namespace"),
-  propIsNotNullOrUndefined("key"),
-  propIsNotNullOrUndefined("namespace"),
-  propIsNotEmpty("key"),
-  propIsNotEmpty("namespace"),
-]);
+  if (!hasOwn(obj, "key") || !hasOwn(obj, "namespace")) return false;
+  if (obj.key == null || obj.namespace == null) return false;
+  if (isEmpty(obj.key) || isEmpty(obj.namespace)) return false;
+
+  return true;
+};
 
 export const buildNamespaceKey = (key: string, namespace: string) =>
   `${namespace}.${key}`;
 
-export const savingResultIsSuccess = (result: unknown): boolean => {
-  return R.is(Boolean, result) && !!result;
-};
+export const savingResultIsSuccess = (result: unknown): boolean =>
+  typeof result === "boolean" && result === true;

package/appUtils/platform/platformUtils.ts

@@ -1,6 +1,11 @@
 import { BehaviorSubject } from "rxjs";
 
 import { sessionStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/SessionStorage";
+import {
+  QUICK_BRICK_EVENTS,
+  sendQuickBrickEvent,
+} from "@applicaster/zapp-react-native-bridge/QuickBrick";
+
 import {
   isLgPlatform,
   isSamsungPlatform,
@@ -18,6 +23,12 @@ const { log_debug } = createLogger({
   parent: utilsLogger,
 });
 
+export const platformToBackground = () => {
+  sendQuickBrickEvent(QUICK_BRICK_EVENTS.MOVE_APP_TO_BACKGROUND, {
+    MOVE_APP_TO_BACKGROUND: true,
+  });
+};
+
 export const getZappPlatform = (): ZappPlatform => {
   const platform = appStore.get("appData")?.platform;