@magicpixel/rn-mp-client-sdk 0.6.2 → 0.7.0

package/src/index.tsx

@@ -16,6 +16,8 @@ import { NetworkService } from './common/network-service';
 import { EventBus } from './common/event-bus';
 import { VisitIdProcessor } from './processors/visit-id.processor';
 
+const DL_INIT_EVENT = 'page_load';
+
 class MagicPixelImpl {
   private static dl: MpDataLayerHelper;
   private static customerInfo: AppCustomerInfo;
@@ -23,7 +25,7 @@ class MagicPixelImpl {
   private static firstAppLaunch = true;
 
   static async init(options: SdkInitOptions): Promise<void> {
-    this.dl = new MpDataLayerHelper('mpDlEvent', 'manual', 'page_load');
+    this.dl = new MpDataLayerHelper('mpDlEvent', 'manual', DL_INIT_EVENT);
 
     await NetworkService.refreshClientSdkJson(options);
 
@@ -39,7 +41,9 @@ class MagicPixelImpl {
       DataStore.overrideDeviceType(options.device_type);
     }
 
-    await VisitIdProcessor.init();
+    this.setAppVersion(options.app_version);
+
+    await VisitIdProcessor.init(options?.orgId);
 
     const fbp = await VisitIdProcessor.getFacebookFBP();
     if (fbp) {
@@ -92,7 +96,11 @@ class MagicPixelImpl {
     this.dl.ready();
   }
 
-  static async checkAndFireTM(): Promise<void> {
+  static getDebugId(): string {
+    return DataStore.getDebugId();
+  }
+
+  private static async checkAndFireTM(): Promise<void> {
     try {
       if (!DataStore.isTagManagerProcessing()) {
         const item = DataStore.deQueueTMFire();
@@ -126,7 +134,7 @@ class MagicPixelImpl {
     }
   }
 
-  static async runTM(
+  private static async runTM(
     sseOnly: boolean,
     triggerName: string,
     evtName: string,
@@ -228,7 +236,23 @@ class MagicPixelImpl {
     }
   }
 
-  static _fireTM(
+  private static _fireTM(
+    envName: string,
+    envId: string,
+    evtName: string,
+    evtId: string
+  ): void {
+    // increment visit_depth if event name is page_load because that's the only way we can track page views in an app for now
+    if (evtName === DL_INIT_EVENT) {
+      VisitIdProcessor.incrementVisitDepth().finally(() => {
+        this._fireTMPrivate(envName, envId, evtName, evtId);
+      });
+    } else {
+      this._fireTMPrivate(envName, envId, evtName, evtId);
+    }
+  }
+
+  private static _fireTMPrivate(
     envName: string,
     envId: string,
     evtName: string,
@@ -259,6 +283,7 @@ class MagicPixelImpl {
 
   static setCustomerInfo(customerInfo: AppCustomerInfo): void {
     this.customerInfo = customerInfo;
+    this.recordEvent('idl_attribution_link', customerInfo);
   }
 
   static setFirebaseAppInstanceId(instanceId: string): void {
@@ -269,6 +294,12 @@ class MagicPixelImpl {
     this.customerIdentifiers.fbp = fbp;
   }
 
+  private static setAppVersion(appVersion?: string): void {
+    if (appVersion && appVersion?.trim()?.length > 0) {
+      this.customerIdentifiers.app_version = appVersion;
+    }
+  }
+
   static recordPageLoad(pageLoadInfo: AppPageLoad): void {
     pageLoadInfo.is_entry = this.firstAppLaunch ? 1 : 0;
     if (this.customerInfo) {

package/src/processors/tag.processor.ts

@@ -373,7 +373,7 @@ export class TagProcessor {
       }
     }
 
-    const op = Utils.unflattenObject(paramValueArray);
+    const op = Utils.unFlattenObject(paramValueArray);
 
     return {
       isInError: false,

package/src/processors/visit-id.processor.ts

@@ -5,74 +5,12 @@ import { Reporter } from '../common/reporter';
 import { NetworkService } from '../common/network-service';
 import type { VisitInfo, VisitorInfo } from '../common/app-types';
 import { Utils } from '../common/utils';
-import { EventBus } from '../common/event-bus';
 
 export class VisitIdProcessor {
-  static async init(): Promise<void> {
-    await this.initIdlEventListener();
-    await this.initDebugId();
+  static async init(orgId: string): Promise<void> {
+    await this.initDebugId(orgId);
     await this.setOrResetVisitorId();
-    await this.setOrResetVisitInfo();
-  }
-
-  static async initIdlEventListener(): Promise<void> {
-    EventBus.on(
-      'mp_idl_app_event',
-      (channelName: string, eventPayload: Record<string, string>) => {
-        try {
-          if (!channelName || !eventPayload) {
-            Logger.logError(
-              'Both event name and event payload is mandatory for processing idl events'
-            );
-            return;
-          }
-
-          const eventName = eventPayload.client_ev_name;
-          const attrInfoPayload: any = eventPayload.client_ev_payload ?? {};
-          const deepPayload: any = attrInfoPayload?.payload ?? {};
-
-          // is_entry, app_type,
-          try {
-            deepPayload['org_id'] = eventPayload?.org_id;
-            deepPayload['event_id'] = eventPayload?.event_id;
-            deepPayload['event_ts'] = eventPayload?.event_ts;
-          } catch (e) {
-            Logger.logError('Error enhancing internal attr payload');
-          }
-
-          const attrPayload: any = {
-            pu: attrInfoPayload?.page_url,
-            ru: attrInfoPayload?.campaign_ref,
-            pt: attrInfoPayload?.page_title,
-            en: attrInfoPayload.event_name,
-            cid: attrInfoPayload?.campaign_id,
-            rs: attrInfoPayload?.report_suite,
-            v: attrInfoPayload?.client_sdk_version,
-            vidl: attrInfoPayload?.idl_version,
-            ev: attrInfoPayload?.event_val,
-            ep: deepPayload,
-            at: attrInfoPayload?.app_type,
-            evId: attrInfoPayload?.event_id,
-            evTs: attrInfoPayload?.event_ts,
-            orgId: attrInfoPayload?.org_id,
-            _mp_vid: DataStore.visitInfoToString(),
-            _lmid: DataStore.getMpId(),
-            _ldid: DataStore.getDeviceId(),
-            _mpidl: JSON.stringify(DataStore.getVisitorInfoAsString()),
-            is_entry: attrInfoPayload.is_entry ?? 0,
-            app_type: attrInfoPayload.app_type,
-          };
-
-          if (eventName === 'al') {
-            attrPayload.pid = eventPayload?.profile_id;
-          }
-
-          Reporter.postAttrInfo(attrPayload);
-        } catch (err) {
-          Logger.logError('Error processing idl event: ', err);
-        }
-      }
-    );
+    await this.setOrResetVisitInfo(false);
   }
 
   static async getFacebookFBP(): Promise<string> {
@@ -84,6 +22,9 @@ export class VisitIdProcessor {
       }
 
       await DataStore.storeData(Constants.KEY_FBP, fbp);
+
+      DataStore.addCommonCookie('_fbp', fbp);
+
       return fbp;
     } catch (err) {
       Logger.logError('Error initializing debug id.', err);
@@ -91,14 +32,21 @@ export class VisitIdProcessor {
     return '';
   }
 
-  static async initDebugId(): Promise<void> {
+  static async initDebugId(orgId: string): Promise<void> {
     try {
       let debugId = await DataStore.getDataFromStorage<string>(
         Constants.KEY_MP_DEBUG_ID
       );
+
+      if (debugId && debugId.indexOf(orgId) !== 0) {
+        // re-generate debug id if it is not of the simple variety
+        debugId = undefined;
+      }
+
       if (!debugId) {
-        debugId = Utils.getUniqueID();
+        debugId = Utils.getSimpleDebugId(orgId);
       }
+
       await DataStore.storeData(Constants.KEY_MP_DEBUG_ID, debugId);
       DataStore.setDebugId(debugId);
     } catch (err) {
@@ -106,39 +54,37 @@ export class VisitIdProcessor {
     }
   }
 
-  static async setOrResetVisitInfo(): Promise<void> {
+  static async setOrResetVisitInfo(incrementDepth: boolean): Promise<void> {
     try {
-      const visitInfo: VisitInfo = await DataStore.getDataFromStorage(
+      let visitInfo: VisitInfo = await DataStore.getDataFromStorage(
         Constants.KEY_MP_IDL_VISIT_ID_INFO
       );
 
       if (!visitInfo) {
-        // may be first time visit, setup a new visit info object and return
-        const newVisitInfo: VisitInfo = {
+        // may be first time visit, set up a new visit info object and return
+        visitInfo = {
           visitId: Utils.getUniqueID(),
           visitCt: 1,
           visitDepth: 1,
           visitTs: Date.now(),
           visitVer: 1,
         };
-        DataStore.setVisitInfo(newVisitInfo);
-        await DataStore.storeData(
-          Constants.KEY_MP_IDL_VISIT_ID_INFO,
-          newVisitInfo
-        );
       } else {
         // reset visit id anyway, but retain the visitCt and depth setting
         visitInfo.visitId = Utils.getUniqueID();
-        visitInfo.visitCt = visitInfo.visitCt + 1;
-        visitInfo.visitDepth = 1;
+        if (incrementDepth) {
+          visitInfo.visitDepth = (visitInfo?.visitDepth ?? 0) + 1;
+        } else {
+          visitInfo.visitCt = visitInfo.visitCt + 1;
+          visitInfo.visitDepth = 1;
+        }
         visitInfo.visitTs = Date.now();
         visitInfo.visitVer = 1;
-        DataStore.setVisitInfo(visitInfo);
-        await DataStore.storeData(
-          Constants.KEY_MP_IDL_VISIT_ID_INFO,
-          visitInfo
-        );
       }
+
+      DataStore.setVisitInfo(visitInfo);
+      await DataStore.storeData(Constants.KEY_MP_IDL_VISIT_ID_INFO, visitInfo);
+      DataStore.addCommonCookie('_mp_vid', DataStore.visitInfoToString());
     } catch (err) {
       Logger.logError(err);
       DataStore.setVisitInfo(null);
@@ -146,30 +92,42 @@ export class VisitIdProcessor {
     }
   }
 
+  static async incrementVisitDepth(): Promise<void> {
+    return this.setOrResetVisitInfo(true);
+  }
+
   static async setOrResetVisitorId(): Promise<void> {
     try {
-      const visitorInfoData: VisitorInfo = await DataStore.getDataFromStorage(
+      let visitorInfoData: VisitorInfo = await DataStore.getDataFromStorage(
         Constants.KEY_MP_IDL_VISITOR_ID_INFO
       );
 
-      if (!visitorInfoData) {
+      if (
+        !visitorInfoData ||
+        (visitorInfoData && visitorInfoData?.mId.indexOf('-') === -1)
+      ) {
         Logger.logDbg('VisitorInfo not found. Refreshing from server');
         // get a new visit id and device id from server and store it in storage
-        const apiVisitInfo = await NetworkService.fetchIdlInfo(
+        visitorInfoData = await NetworkService.fetchIdlInfo(
           DataStore.getIdlUrl()
         );
-        if (!apiVisitInfo) {
-          return;
-        } else {
-          DataStore.setVisitorInfo(apiVisitInfo);
-          // store to db as well
-          await DataStore.storeData(
-            Constants.KEY_MP_IDL_VISITOR_ID_INFO,
-            apiVisitInfo
-          );
-        }
+      }
+
+      if (!visitorInfoData) {
+        return;
       } else {
         DataStore.setVisitorInfo(visitorInfoData);
+        // store to db as well
+        await DataStore.storeData(
+          Constants.KEY_MP_IDL_VISITOR_ID_INFO,
+          visitorInfoData
+        );
+
+        const cookieValue = encodeURIComponent(JSON.stringify(visitorInfoData));
+        DataStore.addCommonCookie('_mplidl', cookieValue);
+        DataStore.addCommonCookie('_mpidl', cookieValue);
+        DataStore.addCommonCookie('_lmid', visitorInfoData.mId);
+        DataStore.addCommonCookie('_ldid', visitorInfoData.dId);
       }
     } catch (err) {
       Logger.logError(err);