Log unhandled promise rejections to the server #46173

Kureev · 2024-07-25T09:30:41Z

Details

According to our conversation with @puneetlath here, I composed a small PR to add additional logging for unhandled promise rejections to the error boundary.

Tests

Manually tested that the unhandled promise rejection error is sent to the server:
Manually tested on iOS app
Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

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

github-actions · 2024-07-25T09:30:53Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

melvin-bot · 2024-07-25T09:31:10Z

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

Kureev · 2024-07-25T10:47:20Z

I have read the CLA Document and I hereby sign the CLA

puneetlath · 2024-07-25T14:36:00Z

@Kureev thanks for the PR! A few things:

You need to have signed commits
You have to fill out the author checklist on all PRs in this repo
Can we please test this on mobile as well to make sure it works there too?

Thanks!

hayata-suenaga

🟢

allgandalf · 2024-07-26T18:07:33Z

I will review this (slack)

allgandalf · 2024-07-26T18:09:34Z

@Kureev , can you read this slack convo about native platforms once you're online thanks! https://expensify.slack.com/archives/C02NK2DQWUX/p1722016873307739

allgandalf · 2024-07-26T18:10:14Z

@Kureev are there any testing steps involved?

Kureev · 2024-07-28T10:54:46Z

@Kureev , can you read this slack convo about native platforms once you're online thanks! https://expensify.slack.com/archives/C02NK2DQWUX/p1722016873307739

Unfortunately, I don't have access to this thread

@Kureev are there any testing steps involved?

Yes: as I mentioned in the PR description, I tested it on iOS device and in Chrome by throwing an unhandled rejection

allgandalf · 2024-07-29T04:19:15Z

Unfortunately, I don't have access to this thread

Oops my bad, I will post some comments from there:

Changes happened in this index.tsx file and we have a separate index.native.tsx file as well, which the current PR doesn't touch

Can you confirm whether the error is also handled in native platform as we have a different file altogether for it @Kureev

allgandalf · 2024-07-29T04:19:51Z

Yes: as I mentioned in the PR description, I tested it on iOS device and in Chrome by throwing an unhandled rejection

How should i do that? is there any change in code which i can make for the error to occur? asking cause i'm not really sure how we can make that error to occur

allgandalf · 2024-07-29T04:20:56Z

Also, @puneetlath can you ask for my review here, this is not in my K2 currently

Kureev · 2024-07-29T12:42:16Z

Would you like me to send the event to crashlytics on the native platform?

Kureev · 2024-07-29T12:43:21Z

How should i do that? is there any change in code which i can make for the error to occur? asking cause i'm not really sure how we can make that error to occur

new Promise((resolve, reject) => setTimeout(reject, 1000))

should do the trick

…form

puneetlath · 2024-07-29T16:39:47Z

@allgandalf were you able to get your questions answered and test the functionality? I cc'd you into the Slack thread, so you should have access to it now if needed.

allgandalf · 2024-07-29T16:45:09Z

yes @puneetlath , I did see the ping, having dinner, should be back in an hour to review this,we will get this checked and merged today for sure 🤝

allgandalf · 2024-07-29T17:49:50Z

testing now 🟢

allgandalf · 2024-07-29T17:50:04Z

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

allgandalf · 2024-07-29T18:45:13Z

src/components/ErrorBoundary/index.native.tsx

+        window.addEventListener('unhandledrejection', onUnhandledRejection);
+        return () => window.removeEventListener('unhandledrejection', onUnhandledRejection);


Android as well as iOS are not recognizing window:

Also if i build the apps, then they would build successfullly but do not open, they crash after sometime, can you reproduce that @Kureev ? let me know if you need any additional information thanks

Yeah, can reproduce it now (after adding code to the .native.tsx file), thank you for this report. Testing the fix atm. Will update this PR accordingly

so, there is a slight issue with the fix here. It isn't so trivial to handle unhandled promise rejections in RN. It seems that right now React Native uses https://www.npmjs.com/package/promise package and in particular onUnhandled to integrate unhandled promise rejections into the LogBox:

https://github.com/facebook/react-native/blob/bd51fcd58e19cf48f952c6ee6866d43ce438952b/packages/react-native/Libraries/Promise.js#L19

https://github.com/facebook/react-native/blob/bd51fcd58e19cf48f952c6ee6866d43ce438952b/packages/react-native/Libraries/promiseRejectionTrackingOptions.js#L4

That said, I can do the same, but it poses some risks if RN team changes the internal approach. Would you like me to go down this way?

We agreed to not to implement .native counterpart and keep the solution to web only: https://expensify.slack.com/archives/C05LX9D6E07/p1722343972517359?thread_ts=1721217121.843389&cid=C05LX9D6E07

allgandalf · 2024-07-29T18:45:51Z

Oh also, this works perfectly on Web:

allgandalf · 2024-07-30T12:57:31Z

Caution

To anyone in future looking to implement the same for native platforms, We didn't implement in the current PR because of the reason mentioned here, we came to the conclusion that we should not add this change to native based on the slack conversation of this thread. Hope we find a solution for this soon

allgandalf

Works well on web:

@puneetlath , as this is the first PR of the author the other workflows are not enabled for them, idr how we enable them, please don't merge yet as we need the pending tests to pass, thanks

melvin-bot · 2024-07-30T13:03:00Z

🎯 @allgandalf, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #46498.

OSBotify · 2024-07-30T13:39:38Z

✋ 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-07-31T19:31:52Z

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

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

puneetlath · 2024-07-31T19:47:03Z

Seems to work on staging:

allgandalf · 2024-08-01T06:32:55Z

you bet ! 😎

OSBotify · 2024-08-02T02:19:58Z

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

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

Kureev requested a review from a team as a code owner July 25, 2024 09:30

melvin-bot bot removed the request for review from a team July 25, 2024 09:31

melvin-bot bot requested a review from hayata-suenaga July 25, 2024 09:31

puneetlath self-requested a review July 25, 2024 14:36

hayata-suenaga previously approved these changes Jul 26, 2024

View reviewed changes

Log unhandled promise rejections to the server

4c8e2c2

Kureev force-pushed the kureev/log-unhandled-promise-rejections branch from 6245265 to 4c8e2c2 Compare July 26, 2024 17:57

Improve error handling experience and add handlers to the native plat…

a932817

…form

Kureev dismissed hayata-suenaga’s stale review via a932817 July 29, 2024 12:56

puneetlath requested a review from allgandalf July 29, 2024 14:15

allgandalf reviewed Jul 29, 2024

View reviewed changes

Revert ErrorBoundary .native counterpart

dafadb9

allgandalf approved these changes Jul 30, 2024

View reviewed changes

melvin-bot bot mentioned this pull request Jul 30, 2024

[AUG 08] Payment issue for E/App PR#46173 #46498

Closed

puneetlath approved these changes Jul 30, 2024

View reviewed changes

puneetlath merged commit e81223b into Expensify:main Jul 30, 2024
16 checks passed

Kureev deleted the kureev/log-unhandled-promise-rejections branch July 30, 2024 14:16

Kureev mentioned this pull request Jul 30, 2024

[$500] Android- Workspace- Unable to open workspaces that out of view after creating new workspace #45738

Closed

6 tasks

github-actions bot mentioned this pull request Jul 31, 2024

Deploy Checklist: New Expensify 2024-07-31 #46607

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Log unhandled promise rejections to the server #46173

Log unhandled promise rejections to the server #46173

Kureev commented Jul 25, 2024 •

edited by puneetlath

Loading

github-actions bot commented Jul 25, 2024 •

edited

Loading

melvin-bot bot commented Jul 25, 2024

Kureev commented Jul 25, 2024

puneetlath commented Jul 25, 2024

hayata-suenaga left a comment

allgandalf commented Jul 26, 2024

allgandalf commented Jul 26, 2024 •

edited

Loading

allgandalf commented Jul 26, 2024

Kureev commented Jul 28, 2024

allgandalf commented Jul 29, 2024

allgandalf commented Jul 29, 2024 •

edited

Loading

allgandalf commented Jul 29, 2024

Kureev commented Jul 29, 2024

Kureev commented Jul 29, 2024

puneetlath commented Jul 29, 2024

allgandalf commented Jul 29, 2024

allgandalf commented Jul 29, 2024

allgandalf commented Jul 29, 2024 •

edited

Loading

allgandalf Jul 29, 2024

Kureev Jul 30, 2024

Kureev Jul 30, 2024

Kureev Jul 30, 2024

allgandalf commented Jul 29, 2024

allgandalf commented Jul 30, 2024

allgandalf left a comment

melvin-bot bot commented Jul 30, 2024

OSBotify commented Jul 30, 2024

OSBotify commented Jul 31, 2024

puneetlath commented Jul 31, 2024

allgandalf commented Aug 1, 2024

OSBotify commented Aug 2, 2024

		window.addEventListener('unhandledrejection', onUnhandledRejection);
		return () => window.removeEventListener('unhandledrejection', onUnhandledRejection);

Log unhandled promise rejections to the server #46173

Log unhandled promise rejections to the server #46173

Conversation

Kureev commented Jul 25, 2024 • edited by puneetlath Loading

Details

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Jul 25, 2024 • edited Loading

melvin-bot bot commented Jul 25, 2024

Kureev commented Jul 25, 2024

puneetlath commented Jul 25, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

allgandalf commented Jul 26, 2024

allgandalf commented Jul 26, 2024 • edited Loading

allgandalf commented Jul 26, 2024

Kureev commented Jul 28, 2024

allgandalf commented Jul 29, 2024

allgandalf commented Jul 29, 2024 • edited Loading

allgandalf commented Jul 29, 2024

Kureev commented Jul 29, 2024

Kureev commented Jul 29, 2024

puneetlath commented Jul 29, 2024

allgandalf commented Jul 29, 2024

allgandalf commented Jul 29, 2024

allgandalf commented Jul 29, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allgandalf Jul 29, 2024

Choose a reason for hiding this comment

Kureev Jul 30, 2024

Choose a reason for hiding this comment

Kureev Jul 30, 2024

Choose a reason for hiding this comment

Kureev Jul 30, 2024

Choose a reason for hiding this comment

allgandalf commented Jul 29, 2024

allgandalf commented Jul 30, 2024

allgandalf left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jul 30, 2024

OSBotify commented Jul 30, 2024

OSBotify commented Jul 31, 2024

puneetlath commented Jul 31, 2024

allgandalf commented Aug 1, 2024

OSBotify commented Aug 2, 2024

Kureev commented Jul 25, 2024 •

edited by puneetlath

Loading

github-actions bot commented Jul 25, 2024 •

edited

Loading

allgandalf commented Jul 26, 2024 •

edited

Loading

allgandalf commented Jul 29, 2024 •

edited

Loading

allgandalf commented Jul 29, 2024 •

edited

Loading