[No QA] Add GoogleTagManger libs by arosiclair · Pull Request #51201 · Expensify/App

arosiclair · 2024-10-21T19:55:46Z

Details

Adds GoogleTagManager libs that we'll start using to publish analytics events. The web lib uses a third party google script we embed in the app and the native lib uses react-native-firebase to publish the same events.

Fixed Issues

$ #50938

Tests

Note: No mWeb tests since we need to view console/logs

GTM lib

Add USE_THIRD_PARTY_SCRIPTS=true to your .env
Disable WARP
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
Add the following to OnboardingModalNavigator

useEffect(() => {
    GoogleTagManager.publishEvent('sign_up', 123456);
}, []);

Sign up with a new account
View onboarding modal
Verify there is a [GTM] event published log

Production build

Run npm run build
Verify
- The build succeeds
- dist/index.html contains <script async="" src="thirdPartyScripts.js">

Offline tests

None

QA Steps

None

PR Author Checklist

Screenshots/Videos

Android: Native

iOS: Native

MacOS: Chrome / Safari

MacOS: Desktop

arosiclair · 2024-10-22T20:13:44Z

This firebase upgrade requires use_frameworks which seems to not be compatible with some of our packages and the new fabric architecture.

We're using react-native v0.75, but it's not 100% clear if use_frameworks works yet
I attempted to set it up but get a 'react_native_plaid_link_sdk-Swift.h' file not found build error.

I'm going to try to move forward without a firebase upgrade and see if it still works in the DebugView.

This reverts commit 99c1ee6.

This reverts commit 7d29053.

arosiclair · 2024-10-23T21:09:17Z

I'm having Android build issues, but I can successfully build iOS without react-native-firebase upgrades. Unfortunately, I see no events in the DebugView which I think would be fixed by the upgrade.

I managed to fix the plaid error by defining the USE_FRAMEWORKS macro that enables our patch-package fixes. However, now I'm getting a new error 'react/renderer/consistency/ShadowTreeRevisionConsistencyManager.h' file not found which looks consistent with others having this issue here. I'm not sure how to workaround that atm.

arosiclair · 2024-10-24T14:56:49Z

Alright I've split this into two PR's. This one just adds the GTM library with no firebase upgrade. #51413 does both.

Good news is I got the DebugView to work on iOS!

I needed to add both -FIRDebugEnabled and -FIRAnalyticsDebugEnabled as launch options.
I also needed to disable WARP before launching the app to fix this SSL issue:

Task <4437D34D-9C89-4E5D-8BF9-79F390C7C655>.<1> finished with error [-1200] Error Domain=NSURLErrorDomain Code=-1200 "An SSL error has occurred and a secure connection to the server cannot be made." UserInfo={NSLocalizedRecoverySuggestion=Would you like to connect to the server anyway?, _kCFStreamErrorDomainKey=3, NSErrorPeerCertificateChainKey=(
    "<cert(0x15f437000) s: firebaselogging-pa.googleapis.com i: Gateway Intermediate ECC Certificate Authority>",
    "<cert(0x113042a00) s: Gateway Intermediate ECC Certificate Authority i: Cloudflare for Teams ECC Certificate Authority>"
), NSErrorClientCertificateStateKey=0, NSErrorFailingURLKey=https://firebaselogging-pa.googleapis.com/v1/firelog/legacy/batchlog, NSErrorFailingURLStringKey=https://firebaselogging-pa.googleapis.com/v1/firelog/legacy/batchlog, NSUnderlyingError=0x600000f6f660 {Error Domain=kCFErrorDomainCFNetwork Code=-1200 "(null)" UserInfo={_kCFStreamPropertySSLClientCertificateState=0, kCFStreamPropertySSLPeerTrust=<SecTrustRef: 0x6000075213f0>, _kCFNetworkCFStreamSSLErrorOriginalValue=-9802, _kCFStreamErrorDomainKey=3, _kCFStreamErrorCodeKey=-9802, kCFStreamPropertySSLPeerCertificates=(
    "<cert(0x15f437000) s: firebaselogging-pa.googleapis.com i: Gateway Intermediate ECC Certificate Authority>",
    "<cert(0x113042a00) s: Gateway Intermediate ECC Certificate Authority i: Cloudflare for Teams ECC Certificate Authority>"
)}}, _NSURLErrorRelatedURLSessionTaskErrorKey=(
    "LocalDataTask <4437D34D-9C89-4E5D-8BF9-79F390C7C655>.<1>"
), _kCFStreamErrorCodeKey=-9802, _NSURLErrorFailingURLSessionTaskErrorKey=LocalDataTask <4437D34D-9C89-4E5D-8BF9-79F390C7C655>.<1>, NSURLErrorFailingURLPeerTrustErrorKey=<SecTrustRef: 0x6000075213f0>, NSLocalizedDescription=An SSL error has occurred and a secure connection to the server cannot be made.}

melvin-bot · 2024-10-24T20:50:20Z

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?

arosiclair · 2024-10-24T21:13:01Z

Alright this is code complete and testing well. We'll move forward without upgrading Firebase for now.

melvin-bot · 2024-10-31T18:02:15Z

@allroundexperts 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]

allroundexperts · 2024-10-31T19:10:22Z

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

Screen.Recording.2024-11-01.at.3.39.49.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-11-01.at.3.38.23.AM.mov

iOS: Native

Screen.Recording.2024-11-01.at.3.36.14.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-11-01.at.3.32.47.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-01.at.3.27.59.AM.mov

MacOS: Desktop

Screen.Recording.2024-11-01.at.3.30.29.AM.mov

allroundexperts

Works good!

melvin-bot · 2024-10-31T22:42:31Z

@neil-marcellini 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]

neil-marcellini

Looks good thank you. I left some NABs.

neil-marcellini

Thanks for the updates

OSBotify · 2024-11-01T19:58:22Z

✋ 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-04T14:38:34Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.57-0 🚀

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

github-actions · 2024-11-06T00:02:07Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.57-10 🚀

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

arosiclair added 4 commits October 21, 2024 15:30

add GTM lib for web

8f1dd31

add doc

5025a7b

upgrade react-native-firebase packages

99c1ee6

update patches

7d29053

arosiclair self-assigned this Oct 21, 2024

arosiclair added 3 commits October 21, 2024 16:10

add GoogleTagManagerModule type

411de42

add GTM lib for native

4e8fdc7

add doc

f5cc230

arosiclair added 5 commits October 22, 2024 16:28

Revert "upgrade react-native-firebase packages"

e6fd09e

This reverts commit 99c1ee6.

Revert "update patches"

049dbfa

This reverts commit 7d29053.

enable firebase debug mode in dev scheme

5fe33c2

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

0988a70

use googleService-Info.plist from firebase

92c5442

arosiclair force-pushed the arosiclair-gtm-lib branch from de0db37 to 92c5442 Compare October 24, 2024 13:56

arosiclair changed the title ~~Add GTM libs~~ Add GoogleTagManger libs Oct 24, 2024

arosiclair added 2 commits October 24, 2024 10:05

add -FIRAnalyticsDebugEnabled argument

5763e7c

add dev plist

77aadf1

arosiclair added 4 commits October 24, 2024 11:02

add google-services.json for dev

f6faa94

enable IS_ANALYTICS_ENABLED

d4c3df2

add USE_THIRD_PARTY_SCRIPTS env variable for testing

f1ff0dd

check for dataLayer

91b9349

arosiclair added 2 commits October 24, 2024 17:33

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

4bdc074

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

34dab29

arosiclair changed the title ~~Add GoogleTagManger libs~~ [No QA] Add GoogleTagManger libs Oct 30, 2024

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

7eb2b61

arosiclair marked this pull request as ready for review October 31, 2024 18:02

arosiclair requested a review from a team as a code owner October 31, 2024 18:02

melvin-bot Bot requested a review from allroundexperts October 31, 2024 18:02

melvin-bot Bot removed the request for review from a team October 31, 2024 18:02

arosiclair mentioned this pull request Oct 31, 2024

[HOLD for payment 2024-11-13] Implement Google Tag Manager libs in NewDot #50938

Closed

allroundexperts approved these changes Oct 31, 2024

View reviewed changes

melvin-bot Bot requested a review from neil-marcellini October 31, 2024 22:42

neil-marcellini previously approved these changes Nov 1, 2024

View reviewed changes

Comment thread src/libs/GoogleTagManager/index.ts

Comment thread src/libs/GoogleTagManager/index.ts

Comment thread ios/GoogleService-Info-DEV.plist Outdated

Comment thread android/app/google-services-DEV.json

arosiclair added 2 commits November 1, 2024 14:59

add USE_THIRD_PARTY_SCRIPTS example

bac72c5

EOF new lines

d7afd75

arosiclair dismissed neil-marcellini’s stale review via d7afd75 November 1, 2024 19:04

neil-marcellini approved these changes Nov 1, 2024

View reviewed changes

neil-marcellini merged commit 20fadd7 into main Nov 1, 2024

neil-marcellini deleted the arosiclair-gtm-lib branch November 1, 2024 19:45

github-actions Bot mentioned this pull request Nov 4, 2024

Deploy Checklist: New Expensify 2024-11-04 #51953

Closed

63 tasks

Uh oh!

Conversation

arosiclair commented Oct 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

arosiclair commented Oct 22, 2024

Uh oh!

arosiclair commented Oct 23, 2024

Uh oh!

arosiclair commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

melvin-bot Bot commented Oct 24, 2024

Uh oh!

arosiclair commented Oct 24, 2024

Uh oh!

melvin-bot Bot commented Oct 31, 2024

Uh oh!

allroundexperts commented Oct 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Oct 31, 2024

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 1, 2024

Uh oh!

github-actions Bot commented Nov 4, 2024

Uh oh!

github-actions Bot commented Nov 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

arosiclair commented Oct 21, 2024 •

edited

Loading

arosiclair commented Oct 24, 2024 •

edited

Loading

allroundexperts commented Oct 31, 2024 •

edited

Loading