Fix - Distance Request Optimistic Data (26518) #26536

jeet-dhandha · 2023-09-01T22:40:28Z

Details

Wrong optimistic data was sent.

Fixed Issues

$ #26518
PROPOSAL: #26518 (comment)

Tests

Request money for a distance request.
After adding all the necessary data and confirming the request.
Verify that Amount is displayed in Message instead of "0.00".

Verify that no errors appear in the JS console

Offline tests

Request money for a distance request.
After adding all the necessary data and confirming the request.
In offline data is not shown for the users. As map service is not available in offline so all the data will update after user gets online.

QA Steps

Request money for a distance request.
After adding all the necessary data and confirming the request.
Verify that Amount is displayed in Message instead of "0.00".

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review 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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

DistanceRequset-OptimisticData-WEb.mp4

Mobile Web - Chrome

DistanceRequset-OptimisticData-Mobile-Chrome.mp4

Mobile Web - Safari

DistanceRequset-OptimisticData-Mobile-Safari.mp4

Desktop

DistanceRequset-OptimisticData-Desktop.mp4

iOS

DistanceRequset-OptimisticData-iOS.mp4

Android

DistanceRequset-OptimisticData-Android.mp4

melvin-bot · 2023-09-01T23:11:24Z

@Santhosh-Sellavel 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]

allroundexperts · 2023-09-01T23:34:49Z

src/components/MoneyRequestConfirmationList.js

@@ -337,10 +339,10 @@ function MoneyRequestConfirmationList(props) {
                Log.info(`[IOU] Sending money via: ${paymentMethod}`);
                onSendMoney(paymentMethod);
            } else {
-                onConfirm(selectedParticipants);
+                onConfirm(selectedParticipants, distanceMerchant);


I don't like this approach of passing the merchant to the onConfirm method. Why can't we set it like we're setting the amount here?

Let me check that too 👍

Updated code for this to use the existing IOU.setMoneyRequestMerchant.

src/libs/TransactionUtils.js

hayata-suenaga · 2023-09-01T23:54:22Z

ops don't merge I accidentally approved 😨

jeet-dhandha · 2023-09-01T23:54:26Z

App/src/components/ReportActionItem/ReportPreview.js

Line 115 in 8fbe6aa

    
           const transactionsWithReceipts = ReportUtils.getTransactionsWithReceipts(props.iouReportID);

@hayata-suenaga Here getTransactionsWithReceipts uses internally.

hayata-suenaga · 2023-09-02T00:08:05Z

Transaction's reportID was set as number and due to which the filter was not working. As passed id was a string type.

@jeet-dhandha

which reportID is compared to which reportID. What are data sources being compared?

jeet-dhandha · 2023-09-02T00:09:30Z

Report ID of IOU and the report id available in transactions.

jeet-dhandha · 2023-09-02T00:10:41Z

@hayata-suenaga can you suggest me a faster way to build android ?

hayata-suenaga · 2023-09-02T00:13:44Z

Let's fix the root cause and make sure reportID on the transaction is set as a string. All reportIDs should be strings.

@jeet-dhandha can you actually make sure that reportID on the transaction is stored as a number?

hayata-suenaga · 2023-09-02T00:14:14Z

@hayata-suenaga can you suggest me a faster way to build android ?

Let me try test build. Are you on beta for the distance request feature?

hayata-suenaga · 2023-09-02T00:15:38Z

@jeet-dhandha test build in process here...

by the way, thank you for sticking with us. I know it's late over there

jeet-dhandha · 2023-09-02T00:23:08Z

Please check the screen shot.

allroundexperts · 2023-09-02T00:24:15Z

src/pages/iou/steps/MoneyRequestConfirmPage.js

+                props.iou.transactionID,
+                props.iou.amount,
+                props.iou.currency,
+                props.iou.merchat,


Is this a typo? It should be props.iou.merchant?

Yes 🙇 . Sorry for that.

allroundexperts · 2023-09-02T00:24:26Z

src/pages/iou/steps/MoneyRequestConfirmPage.js

        },
-        [props.report, props.iou.created, props.iou.transactionID],
+        [props.report, props.iou.created, props.iou.transactionID, props.iou.amount, props.iou.currency, props.iou.merchat],


Slip of hand 🥲

hayata-suenaga · 2023-09-02T00:24:49Z

Please check the screen shot.

@jeet-dhandha thank you for the screenshot. I can see that reportID is stored as a string.

Are these transactions that has reportID as a string all coming from the distance request or are they generally stored as a string?

allroundexperts · 2023-09-02T00:25:40Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review 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 */
- 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(themeColors.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 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

Web

Screen.Recording.2023-09-02.at.2.01.41.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-09-02.at.2.09.15.PM.mov

Mobile Web - Safari

Screen.Recording.2023-09-02.at.2.07.03.PM.mov

Desktop

Screen.Recording.2023-09-02.at.2.04.58.PM.mov

iOS

Screen.Recording.2023-09-02.at.2.07.58.PM.mov

Android

Screen.Recording.2023-09-02.at.2.10.11.PM.mov

jeet-dhandha · 2023-09-02T00:31:58Z

'

@hayata-suenaga CreateDistanceRequest api returns this in response.

This should be handled in back-end so should i remove the code i did in TransactionUtils ?

jeet-dhandha · 2023-09-02T00:33:55Z

I have updated videos and code please check and get back.

neil-marcellini · 2023-09-02T00:45:26Z

@jeet-dhandha I will fix the backend to return reportID as a string, but it won't be deployed for a while. So please leave the handling to turn it into a string and a comment explaining that we will fix it on the backend. I will create a follow up issue.

jeet-dhandha · 2023-09-02T00:51:34Z

Added comment

allroundexperts · 2023-09-02T00:53:10Z

Not sure if its related or not, but currency seems to be playing funny. Check the screenshot below. Currency in merchant is $ while in the description at top it says PKR.

allroundexperts · 2023-09-02T00:55:17Z

It's not calculating the merchant / price correctly. It was 0.65$ per mile previously. Now its showing 0.65PKR per mile (which is impossible).

jeet-dhandha · 2023-09-02T00:59:18Z

It looks like a default rate.

jeet-dhandha · 2023-09-02T01:01:41Z

You can update that from workspace settings > reimbursement > track distance

allroundexperts · 2023-09-02T01:03:43Z

@hayata-suenaga Is this expected or is it a bug?

neil-marcellini · 2023-09-02T01:06:10Z

Distance requests use the workspace default rate. When you change the workspace currency under workspace settings it changes the currency in the rate. We want to use the currency in the rate.

If the rate is 0.625 USD and you change the currency to PKR we don't convert the rate, it's correctly 0.625 PKR.

jeet-dhandha · 2023-09-02T01:17:48Z

@allroundexperts Please ping if anything needed.

hayata-suenaga · 2023-09-02T01:21:54Z

@allroundexperts please proceed with the rest of the checklist 🙇

allroundexperts · 2023-09-02T08:09:40Z

@allroundexperts please proceed with the rest of the checklist 🙇

On it!

allroundexperts

Looks good!

hayata-suenaga · 2023-09-02T19:18:37Z

src/components/MoneyRequestConfirmationList.js

+    const distanceMerchant = useMemo(() => DistanceRequestUtils.getDistanceMerchant(distance, unit, rate, currency, translate), [distance, unit, rate, currency, translate]);
+
+    useEffect(() => {
+        IOU.setMoneyRequestMerchant(distanceMerchant);


I don't like this pattern though.

We should get the distance request merchant string and set the string in IOU at the same place.

We can put the following code inside useEffect with the dependency array.

const distanceMerchant = DistanceRequestUtils.getDistanceMerchant(distance, unit, rate, currency, translate) IOU.setMoneyRequestMerchant(distanceMerchant);

And for the title of MenuItemWithTopDescription, we can pass iou.merchant instead.

I gonna approve this PR right now, but please make a follow up PR @jeet-dhandha for the cleanup 🙇

We consider the issue to be complete after the follow-up PR is merged 👍

@hayata-suenaga Okay.

OSBotify · 2023-09-02T19:24:58Z

✋ 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 · 2023-09-04T16:50:25Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.63-0 🚀

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

OSBotify · 2023-09-05T18:43:00Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.63-2 🚀

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

OSBotify · 2023-09-05T19:13:32Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.64-0 🚀

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

OSBotify · 2023-09-06T18:56:07Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.64-2 🚀

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

rayane-djouah · 2024-03-07T16:31:17Z

src/libs/TransactionUtils.js

+    // `reportID` from the `/CreateDistanceRequest` endpoint return's number instead of string for created `transaction`.
+    // For reference, https://github.com/Expensify/App/pull/26536#issuecomment-1703573277.
+    // We will update this in a follow-up Issue. According to this comment: https://github.com/Expensify/App/pull/26536#issuecomment-1703591019.
+    return _.filter(allTransactions, (transaction) => `${transaction.reportID}` === `${reportID}`);


Do we still need this change ?

You can test it out and see. Hopefully it has been fixed.

jeet-dhandha added 2 commits September 2, 2023 04:05

updated amount, merchant, currency for distance request

6f5aa5f

fix: checking of report id as sometimes its coming in number type

208c222

jeet-dhandha marked this pull request as ready for review September 1, 2023 23:11

jeet-dhandha requested a review from a team as a code owner September 1, 2023 23:11

melvin-bot bot removed the request for review from a team September 1, 2023 23:11

melvin-bot bot requested a review from Santhosh-Sellavel September 1, 2023 23:11

allroundexperts reviewed Sep 1, 2023

View reviewed changes

hayata-suenaga reviewed Sep 1, 2023

View reviewed changes

src/libs/TransactionUtils.js Show resolved Hide resolved

hayata-suenaga previously approved these changes Sep 1, 2023

View reviewed changes

updated distant merchat to use IOU's set merchant function

78fcfcd

jeet-dhandha dismissed hayata-suenaga’s stale review via 78fcfcd September 2, 2023 00:14

hayata-suenaga added the Ready To Build label Sep 2, 2023

allroundexperts reviewed Sep 2, 2023

View reviewed changes

update merchant

dc7e128

hayata-suenaga approved these changes Sep 2, 2023

View reviewed changes

Merge branch 'main' into fix-26518

3712c95

allroundexperts approved these changes Sep 2, 2023

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga September 2, 2023 09:14

hayata-suenaga approved these changes Sep 2, 2023

View reviewed changes

hayata-suenaga reviewed Sep 2, 2023

View reviewed changes

hayata-suenaga merged commit 7e3e760 into Expensify:main Sep 2, 2023

hayata-suenaga mentioned this pull request Sep 2, 2023

[HOLD for regression test] [$1000] Fix optimistic data for distance requests #26518

Closed

6 tasks

mountiny mentioned this pull request Sep 3, 2023

Fix the merchant being overwritten with distance merchant #26601

Merged

59 tasks

BhuvaneshPatil mentioned this pull request Sep 3, 2023

[HOLD for payment 2023-09-12] [$500] DEV: Distance merchant being applied to any kind of request #26600

Closed

6 tasks

jeet-dhandha mentioned this pull request Sep 3, 2023

Fix - Distance Optimistic Data - follow up PR #26618

Merged

59 tasks

OSBotify mentioned this pull request Sep 4, 2023

Deploy Checklist: New Expensify 2023-09-04 #26686

Closed

35 tasks

lanitochka17 mentioned this pull request Sep 5, 2023

[Distance] - Amount/Cash is not updating when editing the Merchant field #26765

Closed

6 tasks

OSBotify mentioned this pull request Sep 5, 2023

Deploy Checklist: New Expensify 2023-09-05 #26820

Closed

48 tasks

rayane-djouah reviewed Mar 7, 2024

View reviewed changes

Fix - Distance Request Optimistic Data (26518) #26536

Fix - Distance Request Optimistic Data (26518) #26536

Conversation

jeet-dhandha commented Sep 1, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hayata-suenaga commented Sep 1, 2023

jeet-dhandha commented Sep 1, 2023

hayata-suenaga commented Sep 2, 2023

jeet-dhandha commented Sep 2, 2023

jeet-dhandha commented Sep 2, 2023

hayata-suenaga commented Sep 2, 2023

hayata-suenaga commented Sep 2, 2023

hayata-suenaga commented Sep 2, 2023

jeet-dhandha commented Sep 2, 2023

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

hayata-suenaga commented Sep 2, 2023

allroundexperts commented Sep 2, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

jeet-dhandha commented Sep 2, 2023 • edited Loading

jeet-dhandha commented Sep 2, 2023

neil-marcellini commented Sep 2, 2023

jeet-dhandha commented Sep 2, 2023

allroundexperts commented Sep 2, 2023

allroundexperts commented Sep 2, 2023

jeet-dhandha commented Sep 2, 2023

jeet-dhandha commented Sep 2, 2023

allroundexperts commented Sep 2, 2023

neil-marcellini commented Sep 2, 2023

jeet-dhandha commented Sep 2, 2023

hayata-suenaga commented Sep 2, 2023

allroundexperts commented Sep 2, 2023

allroundexperts left a comment

Choose a reason for hiding this comment

hayata-suenaga Sep 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Sep 2, 2023

OSBotify commented Sep 4, 2023

OSBotify commented Sep 5, 2023

OSBotify commented Sep 5, 2023

OSBotify commented Sep 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeet-dhandha commented Sep 1, 2023 •

edited

Loading

allroundexperts commented Sep 2, 2023 •

edited

Loading

jeet-dhandha commented Sep 2, 2023 •

edited

Loading

hayata-suenaga Sep 2, 2023 •

edited

Loading