Add GTM event tracking #51599

arosiclair · 2024-10-28T18:39:14Z

Details

Uses our new GoogleTagManager lib to track sign_up, workspace_created and paid_adoption events.

Fixed Issues

$ #50940

Tests

Add USE_THIRD_PARTY_SCRIPTS=true to your .env
Copy the contents of GoogleService-Info-DEV.plist to ios/GoogleService-Info.plist
Copy the contents of google-services-DEV.json to android/app/google-services.json
Turn off WARP
Do QA Steps on web AND native
- Paid adoption cannot be tested on native

QA Steps

Note: QA for web only

Sign Up

Sign out
Open NewDot
Enter an email address for a new account
Select Join
Verify
- Logged into a new account viewing the onboarding dialog
- There is a “[info] [GTM] event published - {"event":"sign_up","accountID":###}” log in the console

Create Workspace - Onboarding Flow

Sign into a new account
View the onboarding dialog
Select Manage my team’s expenses
Enter a business name
Verify
- A new collect workspace was created
- There is a “[info] [GTM] event published - {"event":"workspace_created","accountID":###}” log in the console

Create Workspace - Global create

Sign into a new account
View the onboarding dialog
Select Something else
Enter a first and last name
Go to Global create > New workspace
Verify
- A new collect workspace was created
- There is a “[info] [GTM] event published - {"event":"workspace_created","accountID":###}” log in the console

Create Workspace - Workspaces page

Sign into a new account
View the onboarding dialog
Select Something else
Enter a first and last name
Go to Avatar > Workspaces
Select New Workspace
Verify
- A new collect workspace was created
- There is a “[info] [GTM] event published - {"event":"workspace_created","accountID":###}” log in the console

Create Workspace - Categorize tracked expense

Sign into a new account
View the onboarding dialog
Select Track and budget expenses
Go to Global Create > Track Expense
Submit an expense
View the expense in the self DM
Select Categorize it
Select any category
Verify
- A new collect workspace was created
- There is a “[info] [GTM] event published - {"event":"workspace_created","accountID":###}” log in the console

Paid Adoption

Sign into NewDot with a new admin account
Go to Avatar > Subscription
Select Add payment card
Enter valid card details
Select Add payment card
Verify
- A new payment card is added
- There is a “[info] [GTM] event published - {"event":"paid_adoption","accountID":###}” log in the console

PR Author Checklist

Screenshots/Videos

Android: Native

iOS: Native

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-10-28T18:39:22Z

Hey, I noticed you changed some webpack configuration files. This can break production builds. Did you remember to run a production build locally to verify they still work?

OSBotify · 2024-10-28T19:33:05Z

A preview of your ExpensifyHelp changes have been deployed to https://1f93192b.helpdot.pages.dev ⚡️

…osiclair-gtm-events

melvin-bot · 2024-11-04T20:53:42Z

@getusha Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

…vents

getusha · 2024-11-06T08:50:44Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

N/a

iOS: Native

iOS: mWeb Safari

N/a

MacOS: Chrome / Safari

MacOS: Desktop

getusha · 2024-11-06T18:38:40Z

@arosiclair is the workspace_created event recorded only the first time? I am seeing the logs the first time only.

Screen.Recording.2024-11-06.at.9.36.51.at.night.mov

arosiclair · 2024-11-06T19:29:37Z

@arosiclair is the workspace_created event recorded only the first time? I am seeing the logs the first time only.

Yes we only publish workspace_created for their first workspace (test here). You have to do each test with a new account.

…vents

getusha · 2024-11-07T07:15:34Z

It's expected we publish paid_adoption whether the card is added successfully or not right?

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

getusha · 2024-11-07T07:19:45Z

Lint is failing

arosiclair · 2024-11-07T15:39:48Z

It's expected we publish paid_adoption whether the card is added successfully or not right?

Yes, we just assume the command succeeded in this case. It's fine if it fails and the event gets published.

Lets define this in CONST.ts

Done

mountiny

LGTM, the comments I made are NAB

mountiny · 2024-11-10T23:38:32Z

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

+    // Publish a sign_up event when we start the onboarding flow. This should track basic sign ups
+    // as well as Google and Apple SSO.
+    useEffect(() => {
+        if (!accountID) {
+            return;
+        }
+
+        GoogleTagManager.publishEvent(CONST.ANALYTICS.EVENT.SIGN_UP, accountID);
+    }, [accountID]);


Are there cases when this effect could run multiple times for the user? ie they will get to this point and close the app. They will come back to it later and we will again send the sign_up event. Not sure if its a problem though, just thought about it

Yeah if they restart/refresh the app during onboarding, this would get called again. Since it's kind of an edge case we're just ignoring that for now. Also it's not too big of a deal as long as it stays consistent between A/B tests.

mountiny · 2024-11-10T23:40:39Z

src/libs/actions/Policy/Policy.ts

@@ -1838,6 +1839,11 @@ function createWorkspace(policyOwnerEmail = '', makeMeAdmin = false, policyName
    const {optimisticData, failureData, successData, params} = buildPolicyData(policyOwnerEmail, makeMeAdmin, policyName, policyID, undefined, engagementChoice);
    API.write(WRITE_COMMANDS.CREATE_WORKSPACE, params, {optimisticData, successData, failureData});

+    // Publish a workspace created event if this is their first policy


NAB, I wonder if the events and should be called workspace or policy since we try to keep everything in the BE as policy. Also its weird to see both of them in the comment on one line :D

Suggested change

// Publish a workspace created event if this is their first policy

// Publish a workspace created event if this is their first workspace

OSBotify · 2024-11-10T23:54:46Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-11-11T18:39:29Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.60-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-11-13T00:42:58Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.60-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

arosiclair added 4 commits October 28, 2024 12:15

track sign ups

beead63

track created workspaces

a919b8f

track created workspaces from the categorize tracked expense flow

b9b26e4

track paid adoption

a633ea4

arosiclair self-assigned this Oct 28, 2024

arosiclair changed the base branch from main to arosiclair-gtm-lib October 28, 2024 18:39

arosiclair added 2 commits October 28, 2024 14:53

mock firebase analytics

2ac7699

replace withOnyx with useOnyx

13101ca

Merge branch 'arosiclair-gtm-lib' of github.com:Expensify/App into ar…

b05efd9

…osiclair-gtm-events

arosiclair force-pushed the arosiclair-gtm-events branch from 8bd621e to b05efd9 Compare October 28, 2024 19:34

arosiclair added 7 commits October 28, 2024 16:24

add sign_up test

4d135d4

add createWorkspace test

9f14812

add test for categorizing tracked expense

86a4dbe

add paid_adoption tests

45df579

simplify test names

c4727b0

share onyx state across tests

edada2d

filter out personal policies

e6fc1f0

arosiclair force-pushed the arosiclair-gtm-events branch from 78e2a82 to e6fc1f0 Compare October 31, 2024 16:55

Merge branch 'arosiclair-gtm-lib' into arosiclair-gtm-events

144ad9b

Base automatically changed from arosiclair-gtm-lib to main November 1, 2024 19:45

arosiclair marked this pull request as ready for review November 4, 2024 20:53

arosiclair requested a review from a team as a code owner November 4, 2024 20:53

melvin-bot bot requested review from getusha and removed request for a team November 4, 2024 20:53

Merge branch 'main' of github.com:Expensify/App into arosiclair-gtm-e…

51425d9

…vents

arosiclair added 2 commits November 6, 2024 16:49

load third party scripts in both staging and prod

117f6c0

Merge branch 'main' of github.com:Expensify/App into arosiclair-gtm-e…

c4822ca

…vents

getusha reviewed Nov 7, 2024

View reviewed changes

src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx Outdated Show resolved Hide resolved

arosiclair added 2 commits November 7, 2024 09:50

fix bad merge

d4e4e90

use consts for event names

447d06f

arosiclair requested a review from getusha November 7, 2024 15:39

getusha approved these changes Nov 7, 2024

View reviewed changes

melvin-bot bot requested a review from MarioExpensify November 7, 2024 15:42

This comment was marked as duplicate.

Sign in to view

mountiny approved these changes Nov 10, 2024

View reviewed changes

mountiny merged commit d688a59 into main Nov 10, 2024
18 checks passed

mountiny deleted the arosiclair-gtm-events branch November 10, 2024 23:44

github-actions bot mentioned this pull request Nov 11, 2024

[HOLD for payment 2024-11-21] Deploy Checklist: New Expensify 2024-11-11 #52320

Closed

95 tasks

melvin-bot bot mentioned this pull request Nov 13, 2024

[HOLD for payment 2024-11-20] Add Google Tag Manager event tracking #50940

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GTM event tracking #51599

Add GTM event tracking #51599

arosiclair commented Oct 28, 2024 •

edited

Loading

melvin-bot bot commented Oct 28, 2024

OSBotify commented Oct 28, 2024 •

edited

Loading

melvin-bot bot commented Nov 4, 2024

getusha commented Nov 6, 2024 •

edited

Loading

getusha commented Nov 6, 2024

arosiclair commented Nov 6, 2024 •

edited

Loading

getusha commented Nov 7, 2024

getusha commented Nov 7, 2024

arosiclair commented Nov 7, 2024

This comment was marked as duplicate.

mountiny left a comment

mountiny Nov 10, 2024

arosiclair Nov 11, 2024

mountiny Nov 10, 2024

OSBotify commented Nov 10, 2024

github-actions bot commented Nov 11, 2024

github-actions bot commented Nov 13, 2024

	// Publish a workspace created event if this is their first policy
	// Publish a workspace created event if this is their first workspace

Add GTM event tracking #51599

Add GTM event tracking #51599

Conversation

arosiclair commented Oct 28, 2024 • edited Loading

Details

Fixed Issues

Tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 28, 2024

OSBotify commented Oct 28, 2024 • edited Loading

melvin-bot bot commented Nov 4, 2024

getusha commented Nov 6, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

getusha commented Nov 6, 2024

arosiclair commented Nov 6, 2024 • edited Loading

getusha commented Nov 7, 2024

getusha commented Nov 7, 2024

arosiclair commented Nov 7, 2024

This comment was marked as duplicate.

mountiny left a comment

Choose a reason for hiding this comment

mountiny Nov 10, 2024

Choose a reason for hiding this comment

arosiclair Nov 11, 2024

Choose a reason for hiding this comment

mountiny Nov 10, 2024

Choose a reason for hiding this comment

OSBotify commented Nov 10, 2024

github-actions bot commented Nov 11, 2024

github-actions bot commented Nov 13, 2024

arosiclair commented Oct 28, 2024 •

edited

Loading

OSBotify commented Oct 28, 2024 •

edited

Loading

getusha commented Nov 6, 2024 •

edited

Loading

arosiclair commented Nov 6, 2024 •

edited

Loading