Return early if policy doesn't have `customUnits` to prevent crash #10937

Beamanator · 2022-09-12T15:12:30Z

cc @Julesssss as this is intented to fix a crash blocking deploy

Implementing @tgolen 's proposed solution here: #10876 (comment)

Details

Fixed Issues

$ #10876

Tests

Having trouble reproducing in dev so not sure what test steps to provide :(

Verify that no errors appear in the JS console

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

QA Steps

Was very hard to reproduce the error, so just try creating a new Workspace & opening up the reimbursement page, rooting around, making sure there's no errors.

Note: This crash was specifically found on iOS & Android so best to test on those devices
Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

github-actions · 2022-09-12T15:15:36Z

⚠️ ⚠️ Heads up! This pull request has the CP Staging label. ⚠️ ⚠️
Merging it will cause it to be immediately deployed to staging, even if the open StagingDeployCash deploy checklist is locked.

src/pages/workspace/reimburse/WorkspaceReimburseView.js

Beamanator · 2022-09-12T15:19:52Z

Note: Checking off PR checklist b/c this is relatively time sensitive - I did test in Chrome but haven't tested on mobile devices, the changes are small enough I don't think it's necessary

Julesssss · 2022-09-12T15:31:02Z

PR 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 verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team on the original GH to get the correct copy.
- 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 */
- Any functional components have the displayName property
- 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 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(themeColors.componentBG)
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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Beamanator · 2022-09-12T15:35:42Z

@Julesssss tests now finally passing 😅

Julesssss

Tests well on web and Android when I manually set the object to undefined 👍

melvin-bot · 2022-09-12T15:58:56Z

@Julesssss looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

Julesssss · 2022-09-12T15:59:22Z

Bad Melvin, all tests had passed.

…Units Return early if policy doesn't have `customUnits` to prevent crash (cherry picked from commit 9b7ebed)

francoisl · 2022-09-13T01:06:07Z

I tested on Android and didn't get any crashes. Discussing with @mvtglobally in #qa to test on the iOS TestFlight build 1.1.99.4.

Julesssss · 2022-09-13T09:06:05Z

Same here, no crash on Android 1.1.99-4

OSBotify · 2022-09-13T15:18:36Z

🚀 Deployed to staging by @Julesssss in version: 1.2.0-0 🚀

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

tgolen · 2022-09-13T15:58:37Z

src/pages/workspace/reimburse/WorkspaceReimburseView.js

@@ -142,6 +143,12 @@ class WorkspaceReimburseView extends React.Component {
        }

        const distanceCustomUnit = _.find(lodashGet(this.props, 'policy.customUnits', {}), unit => unit.name === 'Distance');
+        if (!distanceCustomUnit) {
+            Log.warn('Policy has no customUnits, returning early.', {


Slight NAB, but this only indicates it doesn't have a customUnit named "Distance". It could be helpful to add the policy's customUnits property to the logs too (unless it's some huge object).

That seems like a good improvement! Orrrr updating the log to clarify there's no 'Distance' in the policy's customUnits 🤔

Return early if no custom units to prevent crash

a13d12c

Beamanator self-assigned this Sep 12, 2022

Beamanator requested a review from a team as a code owner September 12, 2022 15:12

Beamanator changed the title ~~Return early if no custom units to prevent crash~~ Return early if policy doesn't have customUnits to prevent crash Sep 12, 2022

melvin-bot bot requested review from cristipaval and removed request for a team September 12, 2022 15:12

Beamanator added the CP Staging label Sep 12, 2022

Julesssss reviewed Sep 12, 2022

View reviewed changes

src/pages/workspace/reimburse/WorkspaceReimburseView.js Show resolved Hide resolved

Beamanator requested a review from Julesssss September 12, 2022 15:20

Julesssss approved these changes Sep 12, 2022

View reviewed changes

Julesssss merged commit 9b7ebed into main Sep 12, 2022

Julesssss deleted the beaman-returnEarlyIfNoCustomUnits branch September 12, 2022 15:58

melvin-bot bot added the Emergency label Sep 12, 2022

Julesssss removed the Emergency label Sep 12, 2022

OSBotify pushed a commit that referenced this pull request Sep 12, 2022

Merge pull request #10937 from Expensify/beaman-returnEarlyIfNoCustom…

040940a

…Units Return early if policy doesn't have `customUnits` to prevent crash (cherry picked from commit 9b7ebed)

This was referenced Sep 12, 2022

🍒 Cherry pick PR #10937 to staging 🍒 #10941

Closed

Deploy Checklist: New Expensify 2022-09-09 #10916

Closed

0xmiros mentioned this pull request Sep 12, 2022

iOS - Workspace - App crashes when making changes to Track distance units in offline #10924

Closed

OSBotify mentioned this pull request Sep 13, 2022

Deploy Checklist: New Expensify 2022-09-13 #10958

Closed

30 tasks

tgolen reviewed Sep 13, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Return early if policy doesn't have `customUnits` to prevent crash #10937

Return early if policy doesn't have `customUnits` to prevent crash #10937

Beamanator commented Sep 12, 2022 •

edited

Loading

github-actions bot commented Sep 12, 2022

Beamanator commented Sep 12, 2022

Julesssss commented Sep 12, 2022

Beamanator commented Sep 12, 2022

Julesssss left a comment

melvin-bot bot commented Sep 12, 2022

Julesssss commented Sep 12, 2022

francoisl commented Sep 13, 2022

Julesssss commented Sep 13, 2022

OSBotify commented Sep 13, 2022

tgolen Sep 13, 2022

Beamanator Sep 15, 2022

Return early if policy doesn't have customUnits to prevent crash #10937

Return early if policy doesn't have customUnits to prevent crash #10937

Conversation

Beamanator commented Sep 12, 2022 • edited Loading

Details

Fixed Issues

Tests

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

QA Steps

Screenshots

Web

Mobile Web

Desktop

iOS

Android

github-actions bot commented Sep 12, 2022

Beamanator commented Sep 12, 2022

Julesssss commented Sep 12, 2022

PR Reviewer Checklist

Beamanator commented Sep 12, 2022

Julesssss left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 12, 2022

Julesssss commented Sep 12, 2022

francoisl commented Sep 13, 2022

Julesssss commented Sep 13, 2022

OSBotify commented Sep 13, 2022

tgolen Sep 13, 2022

Choose a reason for hiding this comment

Beamanator Sep 15, 2022

Choose a reason for hiding this comment

Return early if policy doesn't have `customUnits` to prevent crash #10937

Return early if policy doesn't have `customUnits` to prevent crash #10937

Beamanator commented Sep 12, 2022 •

edited

Loading