Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Associate crashes with user info #43063

Merged
merged 32 commits into from
Jul 31, 2024
Merged

Conversation

ShridharGoel
Copy link
Contributor

@ShridharGoel ShridharGoel commented Jun 4, 2024

Details

Associate crashes with user info.

Fixed Issues

$ #42651
PROPOSAL: #42651 (comment)

Testing

  1. Update firebase.json to set crashlytics_debug_enabled to true.

  2. Update platformSetup/index.native.ts to this:

import crashlytics from '@react-native-firebase/crashlytics';
import Performance from '@libs/Performance';

export default function () {
    crashlytics().setCrashlyticsCollectionEnabled(true);
    Performance.setupPerformanceObserver();
}
  1. Create a new Android build.
  2. Open the app on native Android.
  3. Go to troubleshoot menu.
  4. Click on "Test crash".
  5. Wait for few seconds, then open the app again.
  6. Leave the app open for 1 minute.
  7. Check on crashlytics dashboard.

Native crash would not work on iOS debug build because we are on an old version. See invertase/react-native-firebase#6226

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 />.
    • 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

@ShridharGoel ShridharGoel requested a review from a team as a code owner June 4, 2024 19:43
@melvin-bot melvin-bot bot requested review from getusha and removed request for a team June 4, 2024 19:43
Copy link

melvin-bot bot commented Jun 4, 2024

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

@getusha
Copy link
Contributor

getusha commented Jun 5, 2024

@ShridharGoel don't we need the crash buttons in Troubleshoot section to test it on staging?

@ShridharGoel
Copy link
Contributor Author

I've updated this locally, will update the PR once tested.

@ShridharGoel
Copy link
Contributor Author

@getusha Updated.

@roryabraham
Copy link
Contributor

@ShridharGoel you've got lint errors here

src/components/TestToolMenu.tsx Outdated Show resolved Hide resolved
src/components/TestToolMenu.tsx Outdated Show resolved Hide resolved
@getusha
Copy link
Contributor

getusha commented Jun 17, 2024

@ShridharGoel we have a couple of checks failing and a conflict!

@ShridharGoel ShridharGoel requested a review from a team as a code owner June 17, 2024 19:14
@ShridharGoel ShridharGoel marked this pull request as draft June 17, 2024 19:14
@ShridharGoel ShridharGoel marked this pull request as ready for review June 17, 2024 19:22
@roryabraham
Copy link
Contributor

@getusha thanks for your review. Looks like all your comments have been addressed and it's ready for another review

src/libs/setCrashlyticsUserId/types.ts Outdated Show resolved Hide resolved
src/libs/testCrash/index.ts Show resolved Hide resolved

return (
<View>
{isCrashlyticsDebugEnabled ? (
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want this button to show on staging?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will show in staging if crashlytics_debug_enabled is true.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will show in staging if crashlytics_debug_enabled is true.

So we don't need to set that in firebase.json for staging?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want to show this option only when a developer manually enables the crashlytics_debug_enabled flag. Do let me know your thoughts.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want to show this option only when a developer manually enables the crashlytics_debug_enabled flag. Do let me know your thoughts.

On staging how are we going to enable it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want this PR to work for both staging and production, but not for dev or AdHoc builds by default

Copy link
Contributor

@getusha getusha Jul 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ShridharGoel, the button will show for both staging and production, right? I don't see the changes to firebase.json in this PR

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user ID changes will work for staging and production. The testing button would show only when firebase.json is updated manually.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user ID changes will work for staging and production. The testing button would show only when firebase.json is updated manually.

Sorry i am confused here, then why not remove the testing button after confirming the data is being sent to firebase is correct? if it will only be visible only on dev (which i assume is the only way to update firebase.json)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having the button would help us in testing it if needed in the future. Though it wouldn't be needed by QA team.

@getusha
Copy link
Contributor

getusha commented Jul 13, 2024

Note that local logs will show what data is being sent to Firebase, we can use that to verify the changes.

@ShridharGoel i am not seeing any logs that shows the data being sent

Screen.Recording.2024-07-13.at.3.16.44.in.the.afternoon.mov

@getusha
Copy link
Contributor

getusha commented Jul 16, 2024

Bump @ShridharGoel

@ShridharGoel
Copy link
Contributor Author

ShridharGoel commented Jul 17, 2024

@getusha You need to check in Android Studio logcat.

@getusha
Copy link
Contributor

getusha commented Jul 18, 2024

@ShridharGoel i'll check it thanks, we have a couple of comments ^

@ShridharGoel ShridharGoel requested a review from getusha July 19, 2024 11:33
@getusha
Copy link
Contributor

getusha commented Jul 22, 2024

@ShridharGoel lets add steps for staging, otherwise mark this as No QA

@ShridharGoel ShridharGoel changed the title Associate crashes with user info [NoQA] Associate crashes with user info Jul 22, 2024
@ShridharGoel
Copy link
Contributor Author

Updated.

@muttmuure
Copy link
Contributor

@getusha can you take a look at @ShridharGoel's changes?

@getusha
Copy link
Contributor

getusha commented Jul 25, 2024

lgtm i will need to confirm the logs from logcat

Copy link
Contributor

@getusha getusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wasn't able to confirm the data being sent to Firebase, but the rest looks good to me.
https://expensify.slack.com/archives/C01GTK53T8Q/p1722351381164999?thread_ts=1722282113.203869&cid=C01GTK53T8Q

@getusha
Copy link
Contributor

getusha commented Jul 30, 2024

@ShridharGoel could you please update the PR description? thanks!

@ShridharGoel
Copy link
Contributor Author

Updated.

@ShridharGoel ShridharGoel changed the title [NoQA] Associate crashes with user info [InternalQA] Associate crashes with user info Jul 31, 2024
@roryabraham roryabraham added the InternalQA This pull request required internal QA label Jul 31, 2024
@roryabraham roryabraham changed the title [InternalQA] Associate crashes with user info Associate crashes with user info Jul 31, 2024
@roryabraham
Copy link
Contributor

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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@roryabraham roryabraham merged commit 3b7e02b into Expensify:main Jul 31, 2024
20 of 31 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.15-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 2, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.15-9 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
InternalQA This pull request required internal QA Ready To Build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants