Include branch ref params in metrics (#4595)

src/App.js

@@ -82,6 +82,7 @@ import { migrate } from '@/migrations';
 import { initListeners as initWalletConnectListeners } from '@/utils/walletConnect';
 import { getExperimetalFlag, WC_V2 } from '@/config/experimental';
 import { saveFCMToken } from '@/notifications/tokens';
+import branch from 'react-native-branch';
 
 const FedoraToastRef = createRef();
 
@@ -129,7 +130,7 @@ class OldApp extends Component {
     AppState.addEventListener('change', this.handleAppStateChange);
     rainbowTokenList.on('update', this.handleTokenListUpdate);
     appEvents.on('transactionConfirmed', this.handleTransactionConfirmed);
-    this.branchListener = branchListener(this.handleOpenLinkingURL);
+    this.branchListener = await branchListener(this.handleOpenLinkingURL);
     // Walletconnect uses direct deeplinks
     if (android) {
       try {

src/analytics/userProperties.ts

@@ -28,6 +28,11 @@ export interface UserProperties {
   screenWidth?: number;
   screenScale?: number;
 
+  // branch
+  branchCampaign?: string;
+  branchReferrer?: string;
+  branchReferringLink?: string;
+
   // to be deprecated
   assets_value?: number;
   borrowed_value?: number;

src/storage/schema.ts

@@ -11,4 +11,10 @@ export type Device = {
    * already opened the app at least once.
    */
   isReturningUser: boolean;
+
+  /**
+   * Undefined when branch referring params have not been attempted to be set in
+   * the past. We set this to `true` immediately after checking.
+   */
+  branchFirstReferringParamsSet: boolean;
 };

src/utils/branch.ts

@@ -3,12 +3,16 @@ import pako from 'pako';
 import qs from 'qs';
 import branch from 'react-native-branch';
 import { IS_TESTING } from 'react-native-dotenv';
-import logger from '@/utils/logger';
+import { analyticsV2 } from '@/analytics';
+import * as ls from '@/storage';
+import { logger, RainbowError } from '@/logger';
 
-export const branchListener = (handleOpenLinkingURL: (url: any) => void) =>
-  branch.subscribe(({ error, params, uri }) => {
+export const branchListener = async (
+  handleOpenLinkingURL: (url: any) => void
+) => {
+  const unsubscribe = branch.subscribe(({ error, params, uri }) => {
     if (error) {
-      logger.error('Error from Branch: ' + error);
+      logger.error(new RainbowError('Error from Branch'), { error });
     }
 
     if (!params && uri) {
@@ -56,6 +60,34 @@ export const branchListener = (handleOpenLinkingURL: (url: any) => void) =>
     }
   });
 
+  // getFirstReferringParams must be called after branch.subscribe()
+  const branchFirstReferringParamsSet = ls.device.get([
+    'branchFirstReferringParamsSet',
+  ]);
+  if (!branchFirstReferringParamsSet) {
+    const branchParams = await branch
+      .getFirstReferringParams()
+      .then(branchParams => branchParams)
+      .catch(e => {
+        logger.error(
+          new RainbowError('error calling branch.getFirstReferringParams()'),
+          e
+        );
+        return null;
+      });
+    if (branchParams) {
+      analyticsV2.identify({
+        branchCampaign: branchParams['~campaign'],
+        branchReferrer: branchParams['+referrer'],
+        branchReferringLink: branchParams['~referring_link'],
+      });
+    }
+    ls.device.set(['branchFirstReferringParamsSet'], true);
+  }
+
+  return unsubscribe;
+};
+
 /**
  * Sometimes branch deeplinks have the following form:
  * rainbow://open?_branch_referrer=a&link_click_id=b