Refactor Policy_CustomUnit_Update

[amyevans]

Was held on the production deploy of the Web-E PR (https://github.com/Expensify/Web-Expensify/pull/34587), which has now been deployed.

Details

Refactor of Policy_CustomUnit_Update

Fixed Issues

https://github.com/Expensify/Expensify/issues/215182

Tests

Success case

• Click on user avatar > Workspace > Reimburse expenses > Track distance
• Update the Unit. Refresh the page
• Verify the unit option you set has persisted
• Log into your account in a separate incognito window
• Update the Unit again
• Verify the unit option you set is shown in the UI in your first tab as well as your incognito tab (without having to refresh)

Error case (with RBR)
This requires a bit of manual work for testing:

• In the console, paste something like Onyx.merge('policy_B7F58A2F61A9389C', {customUnits: {'628e77618f113': {errors: {1: "Your changes couldn't be saved. The workspace was modified while you were offline, please try again."}}}}); (where B7F58A2F61A9389C is the name of the policy you're testing and 628e77618f113 is the ID of the Distance custom unit - you can obtain these by going in Dev Tools to Application > Onyx > keyvaluepairs > find the policy data for the workspace ID that is in your URL)
• Verify you see the error under the custom unit area and the red brick road indicator dots
• Verify the dots and error are removed once you dismiss the error or submit a successful update of the unit

• Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed 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 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 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 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
• 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 author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

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

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

QA Steps

• Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

10374-desktop.mov

iOS

10374-ios.mp4

Android

10374-android.mov

[amyevans]

Updated and ready for re-reviews

[chiragsalian]

1. When i refresh and then open settings -> reimburse expenses i see this error which you might want to address.
   

2. Can you make a follow up to remove CustomUnit from onyx, this way we only keep CustomUnits. It can be confusing to have both.
   

3. There is problem with WorkspaceReimburseView render. So this is how i tested. I have one regular chrome window signed into my account. I have another incognito window signed into the same account. So now from my first window when i change some value i would expect the same update in the incognito window (because its a push notification to both accounts). So for the incognito window i see the onyx value updating which means web-e works well but the UI didn't update to match the same.
   
   (Notice attributes unit is "km" but in the UI its showing "miles")

[amyevans]

1. When i refresh and then open settings -> reimburse expenses i see this error which you might want to address.

Done! I had the wrong syntax for defining the customUnits prop types

2. Can you make a follow up to remove CustomUnit from onyx, this way we only keep CustomUnits. It can be confusing to have both.

Good idea - https://github.com/Expensify/Expensify/issues/224464

3. There is problem with WorkspaceReimburseView render.

Good catch. When I was initially testing, I noticed the API was being called twice so I put in

if (value === this.state.unitValue) {
  return;
}

to stop that from happening. However, I forgot that React double invokes functions in Strict Mode, so that is actually expected in local dev. So I've removed that early return and I'm seeing the UI update correctly now.

Ioni is OOO

[chiragsalian]

Code looks much better to me. One bug is pending.

[chiragsalian]

Talking about point 3 from your response

There is problem with WorkspaceReimburseView render.

Its still not resolved. I believe its because you have a state variable here. So when the value is updated in props the constructor is not rerun to update this unitValue.
Check out this video to see if it helps,
I have newDot open in two windows, i update the custom unit value in one window and while its onyx is updating in the second window its UI is not.

Screen.Recording.2022-08-24.at.11.05.03.AM.mov

I think you might need to use getDerivedStateFromProps for your usecase where you update this state value only if lodashGet(distanceCustomUnit, 'attributes.unit') has changed.

[amyevans]

Okay, got it for real for real this time. Thanks for explaining that further and pointing me in the right direction.

10374-custom-unit.mov

[chiragsalian]

Nice ✨

[chiragsalian]

LGTM and works well. Left one question for you.

[chiragsalian]

This !state.unitValue doesn't look right. How can state.unitValue not have a value? I don't think this is run before constructor but correct me if i'm mistaken.

[amyevans]

Mm yeah good callout. I was being overly cautious but yeah thinking about it further it isn't needed, as getDerivedStateFromProps runs before the render method, and we've got a fallback value for state.unitValue. I'll create a quick PR to remove it

[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 @chiragsalian in version: 1.1.92-0 🚀

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