Log unhandled promise rejections to the server

[Kureev]

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]

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

[melvin-bot]

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

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

[puneetlath]

@Kureev thanks for the PR! A few things:

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

Thanks!

[hayata-suenaga]

🟢

[allgandalf]

I will review this (slack)

[allgandalf]

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

[allgandalf]

@Kureev are there any testing steps involved?

[Kureev]

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

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]

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]

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

[Kureev]

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

[Kureev]

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

[puneetlath]

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

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]

testing now 🟢

[allgandalf]

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]

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

[Kureev]

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

[Kureev]

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?

[Kureev]

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]

Oh also, this works perfectly on Web:

[allgandalf]

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]

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

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

[OSBotify]

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

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

Seems to work on staging:

[allgandalf]

you bet ! 😎

[OSBotify]

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

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