Cleanup code and include event IDs

Author: youssef-lr

src/CONST/index.ts

@@ -8573,20 +8573,25 @@ const CONST = {
 
     ANALYTICS: {
         EVENT: {
-            SIGN_UP: 'sign_up',
-            WORKSPACE_CREATED: 'workspace_created',
-            PAID_ADOPTION: 'paid_adoption',
+            SIGN_UP: {
+                NAME: 'sign_up',
+                REDDIT: 'SignUp',
+                LINKEDIN: 507587661,
+            },
+            WORKSPACE_CREATED: {
+                NAME: 'workspace_created',
+                REDDIT: 'Lead',
+                LINKEDIN: 25474804,
+            },
+            PAID_ADOPTION: {
+                NAME: 'paid_adoption',
+                REDDIT: 'Purchase',
+                LINKEDIN: 25474820,
+            },
             PRODUCT_TRAINING_SCAN_TEST_TOOLTIP_SHOWN: 'training_scan_test_tooltip_shown',
             PRODUCT_TRAINING_SCAN_TEST_TOOLTIP_DISMISSED: 'training_scan_test_tooltip_dismissed',
             PRODUCT_TRAINING_SCAN_TEST_TOOLTIP_CONFIRMED: 'training_scan_test_tooltip_confirmed',
         },
-        // LinkedIn uses numeric conversion IDs instead of named events
-        LINKEDIN_SIGN_UP_CONVERSION_ID: 507587661,
-        LINKEDIN_WORKSPACE_CREATED_CONVERSION_ID: 25474804,
-        LINKEDIN_PAID_ADOPTION_CONVERSION_ID: 25474820,
-        REDDIT_SIGN_UP_CONVERSION_ID: 'SignUp',
-        REDDIT_WORKSPACE_CREATED_CONVERSION_ID: 'Lead',
-        REDDIT_PAID_ADOPTION_CONVERSION_ID: 'Purchase',
         NVP: {
             META_CLICK_ID: 'expensify_leadFbclid',
             GOOGLE_CLICK_ID: 'expensify_leadGclid',

src/libs/GoogleTagManager/index.ts

@@ -1,8 +1,6 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import Onyx from 'react-native-onyx';
 import Log from '@libs/Log';
 import CONST from '@src/CONST';
-import ONYXKEYS from '@src/ONYXKEYS';
 import type {GoogleTagManagerEvent} from './types';
 import type GoogleTagManagerModule from './types';
 
@@ -23,51 +21,31 @@ type DataLayerPushParams = {
     event: GoogleTagManagerEvent;
     user_id: number;
     user_data: {email: string};
-    gclid?: string;
 };
 
 declare const window: WindowWithPixels;
 
-const PIXEL_EVENTS = new Set<GoogleTagManagerEvent>([CONST.ANALYTICS.EVENT.SIGN_UP, CONST.ANALYTICS.EVENT.WORKSPACE_CREATED, CONST.ANALYTICS.EVENT.PAID_ADOPTION]);
-
-const LINKEDIN_CONVERSION_IDS: Partial<Record<GoogleTagManagerEvent, number>> = {
-    [CONST.ANALYTICS.EVENT.SIGN_UP]: CONST.ANALYTICS.LINKEDIN_SIGN_UP_CONVERSION_ID,
-    [CONST.ANALYTICS.EVENT.WORKSPACE_CREATED]: CONST.ANALYTICS.LINKEDIN_WORKSPACE_CREATED_CONVERSION_ID,
-    [CONST.ANALYTICS.EVENT.PAID_ADOPTION]: CONST.ANALYTICS.LINKEDIN_PAID_ADOPTION_CONVERSION_ID,
-};
-
-const REDDIT_CONVERSION_IDS: Partial<Record<GoogleTagManagerEvent, string>> = {
-    [CONST.ANALYTICS.EVENT.SIGN_UP]: CONST.ANALYTICS.REDDIT_SIGN_UP_CONVERSION_ID,
-    [CONST.ANALYTICS.EVENT.WORKSPACE_CREATED]: CONST.ANALYTICS.REDDIT_WORKSPACE_CREATED_CONVERSION_ID,
-    [CONST.ANALYTICS.EVENT.PAID_ADOPTION]: CONST.ANALYTICS.REDDIT_PAID_ADOPTION_CONVERSION_ID,
-};
-
-let googleClickId: string | null | undefined;
-Onyx.connectWithoutView({
-    key: ONYXKEYS.NVP_GOOGLE_CLICK_ID,
-    callback: (value) => {
-        googleClickId = value;
-    },
-});
+const PIXEL_EVENTS = [CONST.ANALYTICS.EVENT.SIGN_UP, CONST.ANALYTICS.EVENT.WORKSPACE_CREATED, CONST.ANALYTICS.EVENT.PAID_ADOPTION] as const;
 
 function publishEvent(event: GoogleTagManagerEvent, accountID: number, email: string) {
     if (!window.dataLayer) {
         return;
     }
 
-    const params = {event, user_id: accountID, user_data: {email}, gclid: googleClickId ?? undefined};
+    const params = {event, user_id: accountID, user_data: {email}};
 
     // Pass a copy of params here since the dataLayer modifies the object
     window.dataLayer.push({...params});
 
     Log.info('[GTM] event published', false, params);
 
-    if (!PIXEL_EVENTS.has(event)) {
+    const pixelEvent = PIXEL_EVENTS.find((e) => e.NAME === event);
+    if (!pixelEvent) {
         return;
     }
 
     // Events in Meta & Reddit are currently being set in CamelCase from OldDot
-    const pixelEventName = (event as string)
+    const pixelEventName = event
         .split('_')
         .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
         .join('');
@@ -80,19 +58,17 @@ function publishEvent(event: GoogleTagManagerEvent, accountID: number, email: st
     }
 
     // Reddit
-    const redditConversionID = REDDIT_CONVERSION_IDS[event];
-    if (typeof window.rdt === 'function' && redditConversionID) {
-        window.rdt('track', redditConversionID, {
+    if (typeof window.rdt === 'function') {
+        window.rdt('track', pixelEvent.REDDIT, {
             conversionId: eventID,
             email,
         });
     }
 
     // LinkedIn (uses numeric conversion IDs instead of named events)
-    const linkedInConversionID = LINKEDIN_CONVERSION_IDS[event];
-    if (typeof window.lintrk === 'function' && linkedInConversionID) {
+    if (typeof window.lintrk === 'function') {
         window.lintrk('setUserData', {email});
-        window.lintrk('track', {conversion_id: linkedInConversionID});
+        window.lintrk('track', {conversion_id: pixelEvent.LINKEDIN, event_id: eventID});
     }
 }
 

src/libs/GoogleTagManager/types.ts

@@ -5,7 +5,8 @@ import type CONST from '@src/CONST';
  * An event that can be published to Google Tag Manager. New events must be configured in GTM before they can be used
  * in the app.
  */
-type GoogleTagManagerEvent = ValueOf<typeof CONST.ANALYTICS.EVENT>;
+type ExtractEventName<T> = T extends {NAME: infer N extends string} ? N : T extends string ? T : never;
+type GoogleTagManagerEvent = ExtractEventName<ValueOf<typeof CONST.ANALYTICS.EVENT>>;
 
 type GoogleTagManagerModule = {
     publishEvent: (event: GoogleTagManagerEvent, accountID: number, email: string) => void;

src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx

@@ -79,7 +79,7 @@ function OnboardingModalNavigator() {
         }
 
         signUpEventPublishedForAccountID = accountID;
-        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.SIGN_UP, accountID, email ?? '');
+        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.SIGN_UP.NAME, accountID, email ?? '');
     }, [accountID]);
 
     const handleOuterClick = useCallback(() => {

src/libs/actions/IOU/TrackExpense.ts

@@ -2126,7 +2126,7 @@ function categorizeTrackedExpense(trackedExpenseParams: TrackedExpenseParams) {
     // If a draft policy was used, then the CategorizeTrackedExpense command will create a real one
     // so let's track that conversion here
     if (isDraftPolicy) {
-        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.WORKSPACE_CREATED, getUserAccountID(), getCurrentUserEmail());
+        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.WORKSPACE_CREATED.NAME, getUserAccountID(), getCurrentUserEmail());
     }
 }
 

src/libs/actions/PaymentMethods.ts

@@ -207,7 +207,7 @@ function addPaymentCard(accountID: number, params: PaymentCardParams) {
         failureData,
     });
 
-    GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.PAID_ADOPTION, accountID, getCurrentUserEmail() ?? '');
+    GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.PAID_ADOPTION.NAME, accountID, getCurrentUserEmail() ?? '');
 }
 
 /**
@@ -276,9 +276,9 @@ function addSubscriptionPaymentCard(
         });
     }
     if (getCardForSubscriptionBilling(fundList)) {
-        Log.info(`[GTM] Not logging ${CONST.ANALYTICS.EVENT.PAID_ADOPTION} because a card was already added`);
+        Log.info(`[GTM] Not logging ${CONST.ANALYTICS.EVENT.PAID_ADOPTION.NAME} because a card was already added`);
     } else {
-        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.PAID_ADOPTION, accountID, getCurrentUserEmail() ?? '');
+        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.PAID_ADOPTION.NAME, accountID, getCurrentUserEmail() ?? '');
     }
 }
 

src/libs/actions/Policy/Policy.ts

@@ -2975,7 +2975,7 @@ function createWorkspace(options: CreateWorkspaceDataOptions): CreateWorkspacePa
 
     // Publish a workspace created event if this is their first policy
     if (!options.hasActiveAdminPolicies) {
-        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.WORKSPACE_CREATED, options.currentUserAccountIDParam ?? CONST.DEFAULT_NUMBER_ID, options.currentUserEmailParam);
+        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.WORKSPACE_CREATED.NAME, options.currentUserAccountIDParam ?? CONST.DEFAULT_NUMBER_ID, options.currentUserEmailParam);
     }
 
     return params;