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

Refactor custom unit rate update #10557

Merged
merged 38 commits into from
Sep 6, 2022

Conversation

jasperhuangg
Copy link
Contributor

@jasperhuangg jasperhuangg commented Aug 25, 2022

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/215183

Tests

  1. Navigate to or create a workspace > "Reimburse expenses".
  2. Under "Track Distance", change the rate. Wait a bit for the debounced update to apply. Then reload the page to verify that the change is persisted.
  3. Now go offline. Change the rate again and wait a bit for the debounced update to apply. The input should be greyed out like so:
    Screen Shot 2022-08-30 at 11 53 01 AM
  4. Then, go back online and reload the page to verify that the change is persisted.
  5. Now, to test error displaying, add the following line here at the top of PolicyAPI::setWorkspaceCustomUnitRate to simulate throwing an error:
    $e = new Exception('This is a test error message. It should display correctly.');
    Onyx::handleException($e, '547A3D0D-D802-487F-981B-88539C523F6A', ONYXKEYS::COLLECTION_POLICY.$policyID, ['customUnits', $customUnitID, 'rates', $customUnitRateData['customUnitRateID'], 'errors']);
    
  6. Now update the rate again. The error message should display like so:
    Screen Shot 2022-08-30 at 11 57 09 AM
  • 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

Identical to testing steps (see above)

  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

@jasperhuangg jasperhuangg changed the title Refactor custom unit rate update [HOLD Web-Expensify #34640 App #10374] Refactor custom unit rate update Aug 25, 2022
@jasperhuangg jasperhuangg self-assigned this Aug 25, 2022
@jasperhuangg jasperhuangg changed the title [HOLD Web-Expensify #34640 App #10374] Refactor custom unit rate update [HOLD Web-Expensify #34640, App #10374] Refactor custom unit rate update Aug 25, 2022
@jasperhuangg jasperhuangg changed the title [HOLD Web-Expensify #34640, App #10374] Refactor custom unit rate update [HOLD Web-Expensify #34640] Refactor custom unit rate update Aug 29, 2022
@jasperhuangg jasperhuangg changed the title [HOLD Web-Expensify #34640] Refactor custom unit rate update Refactor custom unit rate update Aug 29, 2022
@jasperhuangg jasperhuangg marked this pull request as ready for review August 30, 2022 03:47
@jasperhuangg jasperhuangg requested a review from a team as a code owner August 30, 2022 03:47
@melvin-bot melvin-bot bot removed the request for review from a team August 30, 2022 03:47
@jasperhuangg jasperhuangg changed the title Refactor custom unit rate update [HOLD Web-Expensify 34720] Refactor custom unit rate update Aug 30, 2022
@melvin-bot melvin-bot bot requested a review from deetergp August 30, 2022 03:47
@jasperhuangg jasperhuangg marked this pull request as draft August 30, 2022 03:48
@jasperhuangg jasperhuangg marked this pull request as ready for review August 30, 2022 03:59
@jasperhuangg
Copy link
Contributor Author

jasperhuangg commented Sep 6, 2022

@jasperhuangg Can you merge main into this and fix the conflicts so that we can cherry pick this to resolve #10821?

@amyevans Hmm looks like there weren't any conflicts but merged main anyways, thanks for the heads up! I'll ping ya when the tests are done.

@jasperhuangg jasperhuangg changed the title [HOLD Web-Expensify #34720 + #34752] Refactor custom unit rate update Refactor custom unit rate update Sep 6, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 6, 2022

⚠️ ⚠️ 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.

@amyevans
Copy link
Contributor

amyevans commented Sep 6, 2022

Oh weird, maybe I was looking at an older copy of the branch locally 🤔 Thanks for hopping on that!

@jasperhuangg
Copy link
Contributor Author

jasperhuangg commented Sep 6, 2022

@amyevans Tests passing, feel free to merge if everything checks out!

Copy link
Contributor

@amyevans amyevans left a comment

Choose a reason for hiding this comment

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

Looks good to me and tested again locally 👍

@amyevans amyevans merged commit 29c0e21 into main Sep 6, 2022
@amyevans amyevans deleted the jasper-refactorPolicyCustomUnitRateUpdate branch September 6, 2022 12:26
@melvin-bot melvin-bot bot added the Emergency label Sep 6, 2022
@melvin-bot
Copy link

melvin-bot bot commented Sep 6, 2022

@amyevans 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.

@amyevans
Copy link
Contributor

amyevans commented Sep 6, 2022

Tests were passing Melv

@Julesssss
Copy link
Contributor

I expected to find a failed CP run for this, but I can't see it here 😕

OSBotify pushed a commit that referenced this pull request Sep 7, 2022
…nitRateUpdate

Refactor custom unit rate update

(cherry picked from commit 29c0e21)
OSBotify added a commit that referenced this pull request Sep 7, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Sep 7, 2022

🚀 Cherry-picked to staging by @amyevans in version: 1.1.97-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

OSBotify commented Sep 7, 2022

🚀 Cherry-picked to staging by @amyevans in version: 1.1.97-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

OSBotify commented Sep 7, 2022

🚀 Cherry-picked to staging by @amyevans in version: 1.1.97-7 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

API.write('UpdateWorkspaceCustomUnitRate', {
policyID,
customUnitID,
customUnitRate: JSON.stringify(newCustomUnitRate),
Copy link
Contributor

Choose a reason for hiding this comment

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

This caused a regression #26676. Previously the custom unit rate was simplified to only include relevant data that should be sent. Now we are sending the data from Onyx which may include client-only fields such as pendingAction and errors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants