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

fix: unify distance rates display #50783

Merged

Conversation

thelullabyy
Copy link
Contributor

@thelullabyy thelullabyy commented Oct 15, 2024

Details

Fixed Issues

$ #49929
PROPOSAL: #49929 (comment)

Tests

  1. Add the distance rate to 4-digit decimal value (non-zero) and save it
  2. Go to workspace chat
  3. Submit a distance expense
  4. Select Rate, select the 4-digit distance rate created in step 1
  5. After submit, open transaction report of the expense
  6. Verify that: on step 4 and 5, the rate is displayed in 4-digit value.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Add the distance rate to 4-digit decimal value (non-zero) and save it
  2. Go to workspace chat
  3. Submit a distance expense
  4. Select Rate, select the 4-digit distance rate created in step 1
  5. After submit, open transaction report of the expense
  6. Verify that: on step 4 and 5, the rate is displayed in 4-digit value.
  • 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
Screen.Recording.2024-10-15.at.16.53.37.mp4
Android: mWeb Chrome
Screen.Recording.2024-10-15.at.17.03.49.mp4
iOS: Native
Screen.Recording.2024-10-15.at.17.15.13.mp4
iOS: mWeb Safari
Screen.Recording.2024-10-15.at.17.18.39.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-15.at.15.20.42.mp4
MacOS: Desktop
Screen.Recording.2024-10-15.at.17.24.09.mp4

@thelullabyy thelullabyy marked this pull request as ready for review October 15, 2024 10:27
@thelullabyy thelullabyy requested a review from a team as a code owner October 15, 2024 10:27
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team October 15, 2024 10:28
Copy link

melvin-bot bot commented Oct 15, 2024

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

@allgandalf
Copy link
Contributor

allgandalf commented Oct 18, 2024

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
Screen.Recording.2024-11-08.at.5.05.26.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-11-08.at.5.07.21.PM.mov
iOS: Native
Screen.Recording.2024-11-08.at.5.17.30.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-11-08.at.5.20.00.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-08.at.4.48.11.PM.mov
MacOS: Desktop
Screen.Recording.2024-11-08.at.4.53.05.PM.mov

@allgandalf
Copy link
Contributor

@thelullabyy can you update test step 1 to : Add the distance rate to 4-digit decimal value (non-zero) and save it

@allgandalf
Copy link
Contributor

Bug, in the distance field, we see 4 decimal zeros:

Current PR:
Screenshot 2024-10-21 at 6 56 58 PM

Staging:

Screenshot 2024-10-21 at 6 57 44 PM

@puneetlath Correct me if this is expected, we only intend to fix the case where decimals are present right? When we do not have decimal values we should not show those 4 zeros right?

@puneetlath
Copy link
Contributor

@puneetlath Correct me if this is expected, we only intend to fix the case where decimals are present right? When we do not have decimal values we should not show those 4 zeros right?

Yes, I agree with this.

@allgandalf
Copy link
Contributor

@thelullabyy can you please update your PR according to ^

@allgandalf
Copy link
Contributor

Also please merge main, perf tests are failing on your branch

@thelullabyy
Copy link
Contributor Author

@allgandalf I'll update soon.

@thelullabyy
Copy link
Contributor Author

@allgandalf I updated.

src/libs/PolicyUtils.ts Outdated Show resolved Hide resolved
@allgandalf
Copy link
Contributor

There is a failing jest test @thelullabyy

@thelullabyy
Copy link
Contributor Author

@allgandalf Should I update the tests to match with expected behavior? OD behavior is to set the fraction digits between 2 to 4.

@allgandalf
Copy link
Contributor

OD behavior is to set the fraction digits between 2 to 4.

what do you mean ? can you attach video to what you are referencing ?

@allgandalf
Copy link
Contributor

bump @thelullabyy

@thelullabyy
Copy link
Contributor Author

@allgandalf Sorry for the late reply. Here's the behavior in OD:

Screen.Recording.2024-10-29.at.00.38.08.mov

@thelullabyy
Copy link
Contributor Author

@allgandalf Friendly bump on #50783 (comment) in case you missed.

@allgandalf
Copy link
Contributor

I will review tomorrow

@allgandalf
Copy link
Contributor

@thelullabyy jest tests are failing, also please merge main

@thelullabyy
Copy link
Contributor Author

@allgandalf I asked about what to do with the failed test in #50783 (comment) and #50783 (comment), can you take a look?

@allgandalf
Copy link
Contributor

Screenshot 2024-11-06 at 1 19 59 AM

@thelullabyy I meant the failing CI check for jest, you can get the logs in the run, the two comments you attached aren't related to the failing jest test :)

@allgandalf
Copy link
Contributor

Also please merge main 😄

@thelullabyy
Copy link
Contributor Author

@allgandalf I merged main. Also, the comments I mentioned are the explanation of why the test failed.

Test expected: round all numbers into three digits

1.12345 -> 1.123

OD Behavior: round numbers into four digits

1.12345 -> 1.1235

I'm asking if we should update the tests to be consistent with OD behavior.

@allgandalf
Copy link
Contributor

yes please !

@thelullabyy
Copy link
Contributor Author

@allgandalf I updated.

Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

Changes LGTM, all yours @puneetlath

@melvin-bot melvin-bot bot requested a review from puneetlath November 8, 2024 11:50
@puneetlath puneetlath merged commit a7b1553 into Expensify:main Nov 8, 2024
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Nov 8, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

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

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

@luacmartins
Copy link
Contributor

This PR might be the cause of this blocker. @thelullabyy @allgandalf @puneetlath could you please take a look?

Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.60-3 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄 skipped 🚫

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.

5 participants