fix: [P2P Distance] - Distance unit in the system message changes from miles to mi after changing rate. #47605

Krishna2323 · 2024-08-17T21:18:27Z

Details

Fixed Issues

$ #46873
PROPOSAL: #46873 (comment)

Tests

Go to workspace chat.
Submit a distance expense.
Go to transaction thread.
Go offline
Click Rate.
Select a different rate.
Verify the distance unit in the system message is "mi" after changing distance rate.
Go online > Verify the system message does not change.

Verify that no errors appear in the JS console

Offline tests

Go to workspace chat.
Submit a distance expense.
Go to transaction thread.
Go offline
Click Rate.
Select a different rate.
Verify the distance unit in the system message is "mi" after changing distance rate.
Go online > Verify the system message does not change.

QA Steps

Go to workspace chat.
Submit a distance expense.
Go to transaction thread.
Go offline
Click Rate.
Select a different rate.
Verify the distance unit in the system message is "mi" after changing distance rate.
Go online > Verify the system message does not change.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_native.mp4

Android: mWeb Chrome

android_chrome.mp4

iOS: Native

ios_native.mp4

iOS: mWeb Safari

ios_safari.mp4

MacOS: Chrome / Safari

web_chrome.mp4

MacOS: Desktop

desktop_app.mp4

…m miles to mi after changing rate. Signed-off-by: krishna2323 <[email protected]>

melvin-bot · 2024-08-17T21:18:32Z

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

Signed-off-by: krishna2323 <[email protected]>

paultsimura

A couple of small notes.

paultsimura · 2024-08-20T17:04:27Z

src/libs/DistanceRequestUtils.ts

@@ -171,7 +179,7 @@ function getDistanceForDisplay(hasRoute: boolean, distanceInMeters: number, unit
    const singularDistanceUnit = unit === CONST.CUSTOM_UNITS.DISTANCE_UNIT_MILES ? translate('common.mile') : translate('common.kilometer');
    const unitString = distanceInUnits === '1' ? singularDistanceUnit : distanceUnit;

-    return `${distanceInUnits} ${unitString}`;
+    return `${distanceInUnits} ${useShortFormUnit ? unit : unitString}`;


Let's avoid all the unnecessary unitString calculations by returning early if useShortFormUnit:

if (!hasRoute || !rate || !unit || !distanceInMeters) { return translate('iou.fieldPending'); } const distanceInUnits = getRoundedDistanceInUnits(distanceInMeters, unit); if (useShortFormUnit) { return `${distanceInUnits} ${unit}`; } const distanceUnit = unit === CONST.CUSTOM_UNITS.DISTANCE_UNIT_MILES ? translate('common.miles') : translate('common.kilometers'); const singularDistanceUnit = unit === CONST.CUSTOM_UNITS.DISTANCE_UNIT_MILES ? translate('common.mile') : translate('common.kilometer'); const unitString = distanceInUnits === '1' ? singularDistanceUnit : distanceUnit; return `${distanceInUnits} ${unitString}`; }

This should work, right?

This should work, right?

yes, updating...

paultsimura · 2024-08-20T17:04:45Z

src/libs/DistanceRequestUtils.ts

+    unit: Unit | undefined,
+    rate: number | undefined,
+    translate: LocaleContextProps['translate'],
+    useShortFormUnit?: boolean,


Please add it to JsDoc.

paultsimura · 2024-08-20T17:04:51Z

src/libs/DistanceRequestUtils.ts

@@ -137,6 +137,7 @@ function getRateForDisplay(
    translate: LocaleContextProps['translate'],
    toLocaleDigit: LocaleContextProps['toLocaleDigit'],
    isOffline?: boolean,
+    useShortFormUnit?: boolean,


Please add it to JsDoc.

paultsimura · 2024-08-20T17:08:05Z

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

2024-08-20.-.20.36.-.android.mp4

Android: mWeb Chrome

2024-08-20.-.20.36.-.chrome.mp4

iOS: Native

2024-08-20.-.20.36.-.Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-08-20.at.20.32.43.mp4

iOS: mWeb Safari

2024-08-20.-.20.36.-.Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-08-20.at.20.35.45.mp4

MacOS: Chrome / Safari

2024-08-20.-.20.36.-.Screen.Recording.2024-08-20.at.19.57.35.mp4

MacOS: Desktop

2024-08-20.-.20.36.-.Screen.Recording.2024-08-20.at.20.02.35.mp4

paultsimura · 2024-08-20T18:39:13Z

src/libs/DistanceRequestUtils.ts

@@ -192,13 +200,14 @@ function getDistanceMerchant(
    currency: string,
    translate: LocaleContextProps['translate'],
    toLocaleDigit: LocaleContextProps['toLocaleDigit'],
+    useShortFormUnit?: boolean,


We are now always building the merchant with the short unit form.
So we can remove this param and just call both getDistanceForDisplay and getRateForDisplay with useShortFormUnit: true

paultsimura · 2024-08-20T18:41:33Z

@Krishna2323 the PR tests good in general, thanks. There are a couple of things to change though.

Signed-off-by: krishna2323 <[email protected]>

paultsimura · 2024-08-21T09:27:16Z

src/libs/PolicyUtils.ts

+    if (!Number.isNaN(Number(numValue)) && withDecimals) {
+        return Number(numValue).toFixed(2).toString().replace('.', toLocaleDigit('.'));
+    }


There is an issue with this approach.

When the rate is with decimals, it uses 3 digits after a comma, and here you cut it to fixed 2, which leads to a discrepancy with the BE merchant:

App/src/CONST.ts

Line 2221 in c0a9cbf

RATE_DECIMALS: 3,

We want to build the following logic:

If the value has 3 decimals, leave them as is

If it has less than 2 decimals, add trailing zeros to have 2 after comma

A potential solution would be to round to 3 decimals by default and cut the last one off if it's a 0.

Also, since we perform this check and return early:

App/src/libs/PolicyUtils.ts

Lines 142 to 144 in 4daf8df

if (Number.isNaN(numValue)) {

return '';

}

Do you think the !Number.isNaN(Number(numValue)) check is necessary here?
Can't we use just if (withDecimals) assuming that !Number.isNaN(Number(numValue)) would have caused the early return?

Let's handle this properly:

Rewrite this function to handle the digits correctly.

Add PolicyUtils unit tests to cover the getRateDisplayValue function with different params.

I will start updating accordingly in few hours.

@paultsimura, can you please check the updated code?

Signed-off-by: krishna2323 <[email protected]>

paultsimura · 2024-08-22T08:10:36Z

Thanks @Krishna2323, this tests well. Please add the unit test – PolicyUtilsTest. You can use this code – I used it for testing locally:

import * as PolicyUtils from '../../src/libs/PolicyUtils';

function toLocaleDigitMock(dot: string): string {
    return dot;
}

describe('PolicyUtils', () => {
    describe('getRateDisplayValue', () => {
        it('should return an empty string for NaN', () => {
            const rate = PolicyUtils.getRateDisplayValue('invalid' as unknown as number, toLocaleDigitMock);
            expect(rate).toEqual('');
        });

        describe('withDecimals = false', () => {
            it('should return integer value as is', () => {
                const rate = PolicyUtils.getRateDisplayValue(100, toLocaleDigitMock);
                expect(rate).toEqual('100');
            });

            it('should return non-integer value as is', () => {
                const rate = PolicyUtils.getRateDisplayValue(10.5, toLocaleDigitMock);
                expect(rate).toEqual('10.5');
            });
        });

        describe('withDecimals = true', () => {
            it('should return integer value with 2 trailing zeros', () => {
                const rate = PolicyUtils.getRateDisplayValue(10, toLocaleDigitMock, true);
                expect(rate).toEqual('10.00');
            });

            it('should return non-integer value with up to 2 trailing zeros', () => {
                const rate = PolicyUtils.getRateDisplayValue(10.5, toLocaleDigitMock, true);
                expect(rate).toEqual('10.50');
            });

            it('should return non-integer value with 3 decimals as is', () => {
                const rate = PolicyUtils.getRateDisplayValue(10.531, toLocaleDigitMock, true);
                expect(rate).toEqual('10.531');
            });

            it('should return non-integer value with 3+ decimals cut to 3', () => {
                const rate = PolicyUtils.getRateDisplayValue(10.531345, toLocaleDigitMock, true);
                expect(rate).toEqual('10.531');
            });
        });
    });
});

Signed-off-by: krishna2323 <[email protected]>

Krishna2323 · 2024-08-23T11:22:49Z

@paultsimura, unit test added.

paultsimura

Solid work done here, thanks ✔️

OSBotify · 2024-08-27T21:09:49Z

✋ 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 · 2024-08-28T21:44:24Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.26-1 🚀

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

OSBotify · 2024-08-30T18:32:52Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.26-6 🚀

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

fix: [P2P Distance] - Distance unit in the system message changes fro…

4e2234a

…m miles to mi after changing rate. Signed-off-by: krishna2323 <[email protected]>

Krishna2323 requested a review from a team as a code owner August 17, 2024 21:18

melvin-bot bot requested review from paultsimura and removed request for a team August 17, 2024 21:18

Krishna2323 marked this pull request as draft August 17, 2024 21:18

Krishna2323 added 2 commits August 20, 2024 04:07

Merge branch 'Expensify:main' into krishna2323/issue/46873

5be6b94

fix: use shortform for unit in money request preview.

b8e14c9

Signed-off-by: krishna2323 <[email protected]>

Krishna2323 marked this pull request as ready for review August 20, 2024 00:20

paultsimura reviewed Aug 20, 2024

View reviewed changes

Krishna2323 added 3 commits August 21, 2024 03:57

add suggested changes.

2151608

Signed-off-by: krishna2323 <[email protected]>

minor spacing fix.

3962b7d

Signed-off-by: krishna2323 <[email protected]>

minor fix.

4daf8df

Signed-off-by: krishna2323 <[email protected]>

paultsimura suggested changes Aug 21, 2024

View reviewed changes

update getRateDisplayValue to return correct decimal points.

f2da0ae

Signed-off-by: krishna2323 <[email protected]>

add test for PolicyUtils.

fdd5fc7

Signed-off-by: krishna2323 <[email protected]>

paultsimura approved these changes Aug 23, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath August 23, 2024 11:39

puneetlath approved these changes Aug 27, 2024

View reviewed changes

puneetlath merged commit f60b8f1 into Expensify:main Aug 27, 2024
16 checks passed

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

Deploy Checklist: New Expensify 2024-08-28 #48221

Closed

93 tasks

paultsimura mentioned this pull request Aug 30, 2024

[$250][P2P Distance] - Distance unit in the system message changes from "miles" to "mi" after changing rate #46873

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: [P2P Distance] - Distance unit in the system message changes from miles to mi after changing rate. #47605

fix: [P2P Distance] - Distance unit in the system message changes from miles to mi after changing rate. #47605

Krishna2323 commented Aug 17, 2024 •

edited

Loading

melvin-bot bot commented Aug 17, 2024

paultsimura left a comment

paultsimura Aug 20, 2024

Krishna2323 Aug 20, 2024

Krishna2323 Aug 20, 2024

paultsimura Aug 20, 2024

Krishna2323 Aug 20, 2024

paultsimura Aug 20, 2024

Krishna2323 Aug 20, 2024

paultsimura commented Aug 20, 2024 •

edited

Loading

paultsimura Aug 20, 2024 •

edited

Loading

paultsimura commented Aug 20, 2024

paultsimura Aug 21, 2024

paultsimura Aug 21, 2024 •

edited

Loading

paultsimura Aug 21, 2024

Krishna2323 Aug 21, 2024

Krishna2323 Aug 22, 2024

paultsimura commented Aug 22, 2024

Krishna2323 commented Aug 23, 2024

paultsimura left a comment

OSBotify commented Aug 27, 2024

OSBotify commented Aug 28, 2024

OSBotify commented Aug 30, 2024

fix: [P2P Distance] - Distance unit in the system message changes from miles to mi after changing rate. #47605

fix: [P2P Distance] - Distance unit in the system message changes from miles to mi after changing rate. #47605

Conversation

Krishna2323 commented Aug 17, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 17, 2024

paultsimura left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paultsimura commented Aug 20, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

paultsimura Aug 20, 2024 • edited Loading

Choose a reason for hiding this comment

paultsimura commented Aug 20, 2024

Choose a reason for hiding this comment

paultsimura Aug 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paultsimura commented Aug 22, 2024

Krishna2323 commented Aug 23, 2024

paultsimura left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 27, 2024

OSBotify commented Aug 28, 2024

OSBotify commented Aug 30, 2024

Krishna2323 commented Aug 17, 2024 •

edited

Loading

paultsimura commented Aug 20, 2024 •

edited

Loading

paultsimura Aug 20, 2024 •

edited

Loading

paultsimura Aug 21, 2024 •

edited

Loading