[No QA][Internal] Set up firebase performance for web #47795

rinej · 2024-08-21T14:07:38Z

Details

Currently we use react-native-firebase for tracking performance issues on mobile, we need to add firebase web lib to support it on the WEB.

❗️ We will need someone from the internal team to create new Firebase Project and set the proper environmental variables so we can take it from ENV:

FB_API_KEY=YOUR_API_KEY
FB_APP_ID=YOUR_APP_ID
FB_PROJECT_ID=YOUR_PROJECT_ID

Fixed Issues

$ #47707
PROPOSAL: https://callstack-hq.slack.com/archives/C01GTK53T8Q/p1724785119841979

Tests

Offline tests

QA Steps

After setting up firebase config, go to firebase console -> Performance and verify that the data is being collected

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  -[x] 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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

rezkiy37

Left comments.

rezkiy37 · 2024-08-21T15:17:27Z

src/libs/Firebase/firebaseWebConfig.ts

+import {initializeApp} from 'firebase/app';
+import {getPerformance, initializePerformance} from 'firebase/performance';
+
+// TODO add newly created Firebase web project details before merging


Let's mention an issue or PR link.

Suggested change

// TODO add newly created Firebase web project details before merging

// TODO add newly created Firebase web project details before merging

rezkiy37 · 2024-08-21T15:17:55Z

src/libs/Firebase/firebaseWebConfig.ts

+    apiKey: 'YOUR_API_KEY',
+    authDomain: 'YOUR_AUTH_DOMAIN',
+    projectId: 'YOUR_PROJECT_ID',
+    storageBucket: 'YOUR_STORAGE_BUCKET',
+    messagingSenderId: 'YOUR_MESSAGING_SENDER_ID',
+    appId: 'YOUR_APP_ID',
+    measurementId: 'YOUR_MEASUREMENT_ID',


Should we import values from env?

rezkiy37 · 2024-08-21T15:18:10Z

src/libs/Firebase/firebaseWebConfig.ts

+    measurementId: 'YOUR_MEASUREMENT_ID',
+};
+
+// Initialize Firebase


It is clear here.

Suggested change

// Initialize Firebase

melvin-bot · 2024-09-02T12:12:57Z

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

hungvu193 · 2024-09-02T12:47:57Z

Not sure if this one need a C+

luacmartins · 2024-09-02T15:09:03Z

@hungvu193 I think we can skip C+ review on this one.

luacmartins · 2024-09-03T21:02:54Z

.env.example

+
+FB_API_KEY=YOUR_API_KEY
+FB_APP_ID=YOUR_APP_ID
+FB_PROJECT_ID=YOUR_PROJECT_ID


Can you add a new empty line at the end of the file please? This will help avoid lint warnings

Also are these public API keys?

luacmartins · 2024-09-03T21:11:07Z

Looking into setting up the new project and the keys

luacmartins · 2024-09-03T21:38:37Z

@rinej here's the firebase config file for the production App. Let me know if we also need projects for dev and adhoc builds:

const firebaseConfig = {
  apiKey: "AIzaSyDxzigVLZl4G8MP7jACQ0qpmADMzmrrON0",
  authDomain: "expensify-chat.firebaseapp.com",
  databaseURL: "https://expensify-chat.firebaseio.com",
  projectId: "expensify-chat",
  storageBucket: "expensify-chat.appspot.com",
  messagingSenderId: "921154746561",
  appId: "1:921154746561:web:1583e882584cf151027c40",
  measurementId: "G-BYLH4R6VZZ"
};

luacmartins · 2024-09-05T17:27:51Z

@rinej let me know if there's anything else you need from me at this point

rinej · 2024-09-10T12:59:52Z

I think it would best to have it in the env, to not to store in the public repo. Are we ok with storing it just in the repo? Or there is other way we can get it from config?

luacmartins · 2024-09-10T15:44:44Z

Those credentials are public so I think we can just store them in the .env file

rinej · 2024-09-11T12:31:43Z

ok, sounds good @luacmartins thanks!
Could you just create the new project for DEV?🙏 So we can have it for development and testing purpose? I think that would be all :)

luacmartins · 2024-09-12T18:47:25Z

@rinej here's the config for the dev project

const firebaseConfig = {
  apiKey: "AIzaSyDxzigVLZl4G8MP7jACQ0qpmADMzmrrON0",
  authDomain: "expensify-chat.firebaseapp.com",
  databaseURL: "https://expensify-chat.firebaseio.com",
  projectId: "expensify-chat",
  storageBucket: "expensify-chat.appspot.com",
  messagingSenderId: "921154746561",
  appId: "1:921154746561:web:7b8213357d07d6e4027c40",
  measurementId: "G-BL0ELBPMJJ"
};

rinej · 2024-09-13T11:33:50Z

Thank you! I added the changes, I added the Prod values in the env.production file and when empty we will use the dev values as default.
The PR is ready for the review :)

luacmartins

Just one minor comment

src/CONFIG.ts

luacmartins · 2024-09-16T22:15:19Z

@rinej is this ready for review again?

rinej · 2024-09-17T09:48:51Z

@luacmartins Yes, it's ready

luacmartins

LGTM

luacmartins · 2024-09-17T22:37:53Z

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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

N/A internal metric tracking only

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-09-17T22:50: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.

OSBotify · 2024-09-18T22:52:49Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.38-0 🚀

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

OSBotify · 2024-09-19T23:32:56Z

🚀 Deployed to production by https://github.com/grgia in version: 9.0.38-4 🚀

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

rinej added 2 commits August 21, 2024 16:04

add firebase performance for web

9d70fad

cleanup

41c36ae

rezkiy37 suggested changes Aug 21, 2024

View reviewed changes

rinej added 4 commits August 22, 2024 11:06

cleanup

a2863fe

add modular firebase packages

794956c

Merge branch 'main' into add-firebase-performance-for-web

bf2c838

add fb config

8650119

rinej mentioned this pull request Aug 30, 2024

[Internal] Research and Set up Firebase for Web #47707

Closed

luacmartins self-requested a review August 30, 2024 17:35

rinej added 6 commits September 2, 2024 12:35

add firebase config to env

a5ae1bd

Merge branch 'main' into add-firebase-performance-for-web

b699e4e

add lock after npm i

8e74e50

Merge branch 'main' into add-firebase-performance-for-web

c632f3c

remove dev comments

52a6908

fix types

5484dfe

rinej changed the title ~~add firebase performance for web~~ [Internal] Set up firebase performance for web Sep 2, 2024

rinej added 2 commits September 2, 2024 14:11

Merge branch 'main' into add-firebase-performance-for-web

ef36e7a

fixes after merge

cb5f76d

rinej marked this pull request as ready for review September 2, 2024 12:12

rinej requested a review from a team as a code owner September 2, 2024 12:12

melvin-bot bot requested review from hungvu193 and removed request for a team September 2, 2024 12:12

luacmartins removed the request for review from hungvu193 September 2, 2024 15:09

luacmartins reviewed Sep 3, 2024

View reviewed changes

luacmartins added ring0 and removed ring0 labels Sep 10, 2024

rinej added 3 commits September 11, 2024 14:35

uninstall dependencies

282f6b1

Merge branch 'main' into add-firebase-performance-for-web

9324bc7

install required dependencies

d5503af

rinej added 3 commits September 13, 2024 13:06

add prod api keys to firbase prod project

e3bb962

Merge branch 'main' into add-firebase-performance-for-web

7aefd6e

update package.json

9ab7722

luacmartins requested review from rezkiy37 and luacmartins September 13, 2024 13:59

luacmartins requested changes Sep 13, 2024

View reviewed changes

src/CONFIG.ts Outdated Show resolved Hide resolved

fix config, after merge conflicts

2d1aba9

luacmartins approved these changes Sep 17, 2024

View reviewed changes

luacmartins changed the title ~~[Internal] Set up firebase performance for web~~ [No QA][Internal] Set up firebase performance for web Sep 17, 2024

luacmartins merged commit 46270ca into Expensify:main Sep 17, 2024
18 of 19 checks passed

github-actions bot mentioned this pull request Sep 18, 2024

Deploy Checklist: New Expensify 2024-09-18 #49427

Closed

43 tasks

grgia mentioned this pull request Sep 19, 2024

Web - Console error shows up after loading staging ND #49443

Closed

6 tasks

adhorodyski deleted the add-firebase-performance-for-web branch September 26, 2024 14:08

rinej mentioned this pull request Oct 31, 2024

[NoQA] Setup Firebase for HybridApp #51753

Merged

47 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][Internal] Set up firebase performance for web #47795

[No QA][Internal] Set up firebase performance for web #47795

rinej commented Aug 21, 2024 •

edited

Loading

rezkiy37 left a comment

rezkiy37 Aug 21, 2024

rezkiy37 Aug 21, 2024

rezkiy37 Aug 21, 2024

melvin-bot bot commented Sep 2, 2024

hungvu193 commented Sep 2, 2024

luacmartins commented Sep 2, 2024

luacmartins Sep 3, 2024

luacmartins Sep 3, 2024

luacmartins commented Sep 3, 2024

luacmartins commented Sep 3, 2024

luacmartins commented Sep 5, 2024

rinej commented Sep 10, 2024

luacmartins commented Sep 10, 2024 •

edited

Loading

rinej commented Sep 11, 2024

luacmartins commented Sep 12, 2024

rinej commented Sep 13, 2024

luacmartins left a comment

luacmartins commented Sep 16, 2024

rinej commented Sep 17, 2024

luacmartins left a comment

luacmartins commented Sep 17, 2024 •

edited

Loading

OSBotify commented Sep 17, 2024

OSBotify commented Sep 18, 2024

OSBotify commented Sep 19, 2024

	// TODO add newly created Firebase web project details before merging
	// TODO add newly created Firebase web project details before merging

[No QA][Internal] Set up firebase performance for web #47795

[No QA][Internal] Set up firebase performance for web #47795

Conversation

rinej commented Aug 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 left a comment

Choose a reason for hiding this comment

rezkiy37 Aug 21, 2024

Choose a reason for hiding this comment

rezkiy37 Aug 21, 2024

Choose a reason for hiding this comment

rezkiy37 Aug 21, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Sep 2, 2024

hungvu193 commented Sep 2, 2024

luacmartins commented Sep 2, 2024

luacmartins Sep 3, 2024

Choose a reason for hiding this comment

luacmartins Sep 3, 2024

Choose a reason for hiding this comment

luacmartins commented Sep 3, 2024

luacmartins commented Sep 3, 2024

luacmartins commented Sep 5, 2024

rinej commented Sep 10, 2024

luacmartins commented Sep 10, 2024 • edited Loading

rinej commented Sep 11, 2024

luacmartins commented Sep 12, 2024

rinej commented Sep 13, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Sep 16, 2024

rinej commented Sep 17, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Sep 17, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Sep 17, 2024

OSBotify commented Sep 18, 2024

OSBotify commented Sep 19, 2024

rinej commented Aug 21, 2024 •

edited

Loading

luacmartins commented Sep 10, 2024 •

edited

Loading

luacmartins commented Sep 17, 2024 •

edited

Loading