fix: apply 4 decimal values for distance rate display #52609

thelullabyy · 2024-11-15T08:17:26Z

Explanation of Change

This PR fixes the dividing problem of Javascript where sometimes the divided value is not correct.
Example:

Fixed Issues

$ #52342
$ #49929
PROPOSAL: #49929 (comment)

Tests

Add the distance rate to 4-digit decimal value (non-zero - example: 0.1111) and save it
Go to workspace chat
Submit a distance expense
Select Rate, select the 4-digit distance rate created in step 1
After submit, open transaction report of the expense
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

Same above

QA Steps

Add the distance rate to 4-digit decimal value (non-zero - example: 0.1111) and save it
Go to workspace chat
Submit a distance expense
Select Rate, select the 4-digit distance rate created in step 1
After submit, open transaction report of the expense
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

Screenshots/Videos

Android: Native

Screen.Recording.2024-11-15.at.16.44.58.mp4

Android: mWeb Chrome

Screen.Recording.2024-11-15.at.17.12.39.mp4

iOS: Native

Screen.Recording.2024-11-15.at.17.56.24.mp4

iOS: mWeb Safari

Screen.Recording.2024-11-15.at.17.30.58.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-15.at.15.13.27.mov

MacOS: Desktop

Screen.Recording.2024-11-15.at.18.04.56.mp4

melvin-bot · 2024-11-15T11:08:25Z

@allgandalf 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 · 2024-11-15T12:56:27Z

src/libs/PolicyUtils.ts

+    // Rounding to 4 decimal places
+    return parseFloat(numValue.toFixed(CONST.MAX_TAX_RATE_DECIMAL_PLACES));


for my understanding, can you explain why that regression happened and how will this change fix it ?

bump @thelullabyy

@allgandalf Due to the way Javascript store floating points number, some divisions could result in false value, example:

console.log(11.11/100) // expected: 0.1111 // actual: 0.11109999999999999

More info can be found in this SO

To fix this problem, we can:

Fix the result in some digits (4 in this PR)

Turn the divided number into integers by multiplying it with a big number (e.g. 10000) and perform devide after

In this PR I chose the first approach.

That makes sense to me, thanks a lot for the info and SO

@puneetlath , here's the fix and explanation for the last deploy blocker we faced

allgandalf · 2024-11-19T10:01:49Z

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 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-20.at.11.58.42.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-11-20.at.12.00.57.PM.mov

iOS: Native

Screen.Recording.2024-11-20.at.11.52.14.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-11-20.at.11.53.48.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-20.at.11.35.56.AM.mov

MacOS: Desktop

Screen.Recording.2024-11-20.at.11.38.58.AM.mov

allgandalf · 2024-11-20T06:34:46Z

@thelullabyy please remove this comment from the description:

Also update the offline steps

thelullabyy · 2024-11-20T07:21:13Z

@allgandalf I already updated

allgandalf

LGTM!

puneetlath

The changes seem fine to me. Do the unit tests cover the regression scenario that we saw?

allgandalf · 2024-11-21T12:27:17Z

I assume so, @thelullabyy can you confirm please

thelullabyy · 2024-11-22T07:22:47Z

@allgandalf @puneetlath The division is calculated in getUnitRateValue here, and currently in PolicyUtilsTest we only test for getRateDisplayValue

puneetlath · 2024-11-22T19:09:01Z

Ok so shall we add a unit test for getUnitRateValue then?

allgandalf · 2024-11-25T06:24:51Z

Ok so shall we add a unit test for getUnitRateValue then?

That's a good idea!, @thelullabyy can you please add one?

thelullabyy · 2024-11-25T17:11:47Z

@allgandalf I added the tests.

puneetlath · 2024-11-25T22:17:24Z

@allgandalf can you give it another review?

allgandalf

LGTM!

OSBotify · 2024-11-26T18:54:08Z

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

github-actions · 2024-11-28T14:47:27Z

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

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

github-actions · 2024-11-30T13:52:02Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.68-7 🚀

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

thelullabyy added 2 commits November 15, 2024 15:08

fix: apply 4 decimal values for distance rate display

067263a

fix: test

24b74bb

thelullabyy marked this pull request as ready for review November 15, 2024 11:08

thelullabyy requested a review from a team as a code owner November 15, 2024 11:08

melvin-bot bot requested review from allgandalf and removed request for a team November 15, 2024 11:08

thelullabyy mentioned this pull request Nov 15, 2024

[HOLD for payment 2024-12-07] [$250] Distance - Rate on confirmation page shows 3 decimal value for a 4-digit decimal value rate #49929

Closed

6 tasks

allgandalf reviewed Nov 15, 2024

View reviewed changes

allgandalf approved these changes Nov 20, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath November 20, 2024 07:38

puneetlath previously approved these changes Nov 20, 2024

View reviewed changes

feat: add unit test for PolicyUtils.getUnitRateValue

c8d7c57

thelullabyy dismissed puneetlath’s stale review via c8d7c57 November 25, 2024 17:07

puneetlath requested a review from allgandalf November 25, 2024 17:45

allgandalf approved these changes Nov 26, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath November 26, 2024 08:51

puneetlath approved these changes Nov 26, 2024

View reviewed changes

puneetlath merged commit 6e1855e into Expensify:main Nov 26, 2024
18 checks passed

github-actions bot mentioned this pull request Nov 28, 2024

Deploy Checklist: New Expensify 2024-11-28 #53245

Closed

72 tasks

melvin-bot bot mentioned this pull request Nov 30, 2024

[HOLD for payment 2024-12-07] [HOLD for payment 2024-11-20] Distance - Distance rate with 4 decimal values are not shown correctly in expense report #52342

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: apply 4 decimal values for distance rate display #52609

fix: apply 4 decimal values for distance rate display #52609

thelullabyy commented Nov 15, 2024 •

edited

Loading

melvin-bot bot commented Nov 15, 2024

allgandalf Nov 15, 2024

allgandalf Nov 17, 2024

thelullabyy Nov 18, 2024

allgandalf Nov 19, 2024

allgandalf Nov 20, 2024

allgandalf commented Nov 19, 2024 •

edited

Loading

allgandalf commented Nov 20, 2024 •

edited

Loading

thelullabyy commented Nov 20, 2024

allgandalf left a comment

puneetlath left a comment

allgandalf commented Nov 21, 2024

thelullabyy commented Nov 22, 2024

puneetlath commented Nov 22, 2024

allgandalf commented Nov 25, 2024

thelullabyy commented Nov 25, 2024

puneetlath commented Nov 25, 2024

allgandalf left a comment

OSBotify commented Nov 26, 2024

github-actions bot commented Nov 28, 2024

github-actions bot commented Nov 30, 2024

		// Rounding to 4 decimal places
		return parseFloat(numValue.toFixed(CONST.MAX_TAX_RATE_DECIMAL_PLACES));

fix: apply 4 decimal values for distance rate display #52609

fix: apply 4 decimal values for distance rate display #52609

Conversation

thelullabyy commented Nov 15, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 15, 2024

allgandalf Nov 15, 2024

Choose a reason for hiding this comment

allgandalf Nov 17, 2024

Choose a reason for hiding this comment

thelullabyy Nov 18, 2024

Choose a reason for hiding this comment

allgandalf Nov 19, 2024

Choose a reason for hiding this comment

allgandalf Nov 20, 2024

Choose a reason for hiding this comment

allgandalf commented Nov 19, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allgandalf commented Nov 20, 2024 • edited Loading

thelullabyy commented Nov 20, 2024

allgandalf left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

allgandalf commented Nov 21, 2024

thelullabyy commented Nov 22, 2024

puneetlath commented Nov 22, 2024

allgandalf commented Nov 25, 2024

thelullabyy commented Nov 25, 2024

puneetlath commented Nov 25, 2024

allgandalf left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 26, 2024

github-actions bot commented Nov 28, 2024

github-actions bot commented Nov 30, 2024

thelullabyy commented Nov 15, 2024 •

edited

Loading

allgandalf commented Nov 19, 2024 •

edited

Loading

allgandalf commented Nov 20, 2024 •

edited

Loading