[HOLD for payment 2024-02-19] [$500] Distance - Receipt shows original amount and distance instead of TBD when editing distance offline #33362

kbecciv · 2023-12-20T14:13:21Z

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

Version Number: v1.4.14-2
Reproducible in staging?: y
Reproducible in production?: y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: Applause - Internal Team
Slack conversation:

Action Performed:

Precondition: There is a distance expense request in the workspace chat.

Navigate to the workspace chat from the precondition.
Open the distance request details page.
Click on the receipt.
Close the receipt.
Go offline.
Click Distance.
Add a stop and save it.
Click on the receipt.

Expected Result:

The amount and distance will show TBD.

Actual Result:

The amount and distance are not showing TBD. The values are still showing the original value before edit.

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

Screenshots/Videos

Add any screenshot/video evidence

Bug6321335_1703081373259.bandicam_2023-12-15_03-44-39-835.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~01d635e8deae97ab55
Upwork Job ID: 1737476292940328960
Last Price Increase: 2024-01-03
Automatic offers:

paultsimura | Contributor | 28089473

Issue Owner

Current Issue Owner: @kevinksullivan

melvin-bot · 2023-12-20T14:13:25Z

Job added to Upwork: https://www.upwork.com/jobs/~01d635e8deae97ab55

melvin-bot · 2023-12-20T14:13:26Z

Triggered auto assignment to @kevinksullivan (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

melvin-bot · 2023-12-20T14:13:28Z

Bug0 Triage Checklist (Main S/O)

This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
This bug is not a duplicate report (check E/App issues and #expensify-bugs)
- If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
This bug is reproducible using the reproduction steps in the OP. S/O
- If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
- If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
This issue is filled out as thoroughly and clearly as possible
- Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

melvin-bot · 2023-12-20T14:13:30Z

Triggered auto assignment to Contributor-plus team member for initial proposal review - @parasharrajat (External)

dukenv0307 · 2023-12-20T14:16:42Z

Proposal

Please re-state the problem that we are trying to solve in this issue.

The amount and distance are not showing TBD. The values are still showing the original value before edit.

What is the root cause of that problem?

We don't use the same condition to show TDB as we do in MoneyRequestView. The same for merchant

App/src/components/DistanceEReceipt.js

Line 38 in 249096e

    
           const formattedTransactionAmount = transactionAmount ? CurrencyUtils.convertToDisplayString(transactionAmount, transactionCurrency) : translate('common.tbd');

App/src/components/ReportActionItem/MoneyRequestView.js

Lines 108 to 110 in 249096e

    
           if (isDistanceRequest && (!formattedTransactionAmount || hasPendingWaypoints)) { 
        
               formattedTransactionAmount = translate('common.tbd'); 
        
           }

What changes do you think we should make in order to solve the problem?

We should use the same condition to show the amount and merchant as we do in MoneyRequestView here

App/src/components/DistanceEReceipt.js

Line 38 in 249096e

    
           const formattedTransactionAmount = transactionAmount ? CurrencyUtils.convertToDisplayString(transactionAmount, transactionCurrency) : translate('common.tbd');

App/src/components/ReportActionItem/MoneyRequestView.js

Lines 108 to 110 in 249096e

    
           if (isDistanceRequest && (!formattedTransactionAmount || hasPendingWaypoints)) { 
        
               formattedTransactionAmount = translate('common.tbd'); 
        
           }

What alternative solutions did you explore? (Optional)

NA

paultsimura · 2023-12-20T14:16:58Z

Proposal

Please re-state the problem that we are trying to solve in this issue.

Amount and Distance are not replaced with TBD in the eReceipt.

What is the root cause of that problem?

We currently show TBD only if the request has no initial amount:

App/src/components/DistanceEReceipt.js

Line 38 in fa87f8b

    
           const formattedTransactionAmount = transactionAmount ? CurrencyUtils.convertToDisplayString(transactionAmount, transactionCurrency) : translate('common.tbd');

What changes do you think we should make in order to solve the problem?

We should add a check for transaction.isLoading, and show TBD in this case as well:

const formattedTransactionAmount = !transaction.isLoading && transactionAmount ? CurrencyUtils.convertToDisplayString(transactionAmount, transactionCurrency) : translate('common.tbd');
const formattedMerchant = transaction.isLoading ? transactionMerchant.replace(CONST.REGEX.FIRST_SPACE, translate('common.tbd')) : transactionMerchant;

And use this formattedMerchant instead of transactionMerchant here:

App/src/components/DistanceEReceipt.js

Line 77 in fa87f8b

<Text style={styles.eReceiptMerchant}>{transactionMerchant}</Text>

What alternative solutions did you explore? (Optional)

Instead of using transaction.isLoading, we can use the hasPendingWaypoints approach, but it was already discussed in a couple of places that we should move towards using transaction.isLoading instead of checking for pending waypoints, as it can be more dynamically controlled in one single place instead of later modifying the hasPendingWaypoints check in every single place where we use the TBD.

This transaction.isLoading is being set in one single place when modifying the transaction, so it should be relied on as the source of truth for the distance transaction being in pending status:

App/src/libs/actions/IOU.js

Lines 936 to 946 in 249096e

    
           // Optimistically modify the transaction 
        
           optimisticData.push({ 
        
               onyxMethod: Onyx.METHOD.MERGE, 
        
               key: `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, 
        
               value: { 
        
                   ...updatedTransaction, 
        
                   pendingFields, 
        
                   isLoading: _.has(transactionChanges, 'waypoints'), 
        
                   errorFields: null, 
        
               }, 
        
           });

kevinksullivan · 2023-12-22T17:54:49Z

Hi @parasharrajat please review the proposal!

parasharrajat · 2023-12-22T17:57:49Z

Checking this in 2 hours.

Tony-MK · 2023-12-24T23:37:41Z

Proposal

Please re-state the problem that we are trying to solve in this issue.

Distance - Receipt shows original amount and distance instead of TBD when editing distance offline

What is the root cause of that problem?

This issue was supposed to be part of PR #30232 but I was advised that it was out of scope. The root cause arises when the waypoints are changed and no condition or transaction flag is there to check whether the amount and distance have changed and are pending recalculation. The amount and merchant are not modified in the onyx until the user gets a stable internet connection. Hence, we show the previous amount and distance instead of TBD.

What changes do you think we should make in order to solve the problem?

Create a boolean variable called hasPendingWaypoints in DistanceEReceipt.js, borrowed from MoneyRequestView.js. For granularity, hasPendingWaypoints is solely used to check if the transaction has any changed waypoints. Hence, the amount and distance are wrong and need recalculation.

const hasPendingWaypoints = lodashGet(props.transaction, 'pendingFields.waypoints', false);

Set the formattedTransactionAmount string appropriately.

const formattedTransactionAmount = hasPendingWaypoints && transactionAmount ? CurrencyUtils.convertToDisplayString(transactionAmount, transactionCurrency) : translate('common.tbd');

Replace the distance substring in the merchant string with TBD.

<Text style={styles.eReceiptMerchant}>{hasPendingWaypoints ? requestMerchant.replace(CONST.REGEX.FIRST_SPACE, translate('common.tbd')) : requestMerchant}</Text>

Render PendingMapView because ReceiptUtils.getThumbnailAndImageURIs will return the default receipt thumbnail. Hence, if the user is offline, the default receipt thumbnail is displayed instead of the pending map thumbnail.

App/src/components/DistanceEReceipt.js

Line 67 in 7b836cf

{isOffline || !thumbnailSource ? (

isOffline || !thumbnailSource || hasPendingWaypoints

Result

Important Note
I discovered a couple of inconsistent components that don't appear as they should when a distance request is created offline. I believe we can address them because they were left out from PR #30232 To mention a few:

The amount field opacity should be dimmed when it shows TBD.
In MoneyRequestView, there are three components that should show TBD because the distance and amount have not been recalculated. We could also address this.

paultsimura · 2023-12-25T00:50:25Z

Regarding the notes from the proposal above:

Important Note
I discovered a couple of inconsistent components that don't appear as they should when a distance request is created offline. For example in MoneyRequestView, there are components that should show TBD because the distance and amount have not been recalculated. I believe we can also address this.

This should have been handled in #33060, but that was closed as not important at the moment. If it should still be fixed – the original issue should be reopened.

Render PendingMapView because ReceiptUtils.getThumbnailAndImageURIs will return the default receipt thumbnail. Hence, if the user is offline, the default receipt thumbnail is displayed instead of the pending map thumbnail.

This should be handled in #28965, where the green receipt thumbnail will be replaced by an actual map.

Besides these points, the rest is almost the same as in the first 2 proposals.

melvin-bot · 2023-12-26T11:48:11Z

@kevinksullivan, @parasharrajat Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

melvin-bot · 2023-12-27T16:01:37Z

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

parasharrajat · 2023-12-27T18:45:56Z

I will review this by tomorrow.

Tony-MK · 2023-12-27T20:35:49Z

@parasharrajat, would you know why we display the PendingMap instead of the actual map image in the DistanceEReceipt? Since the rest of the app displays the map image, it shouldn't be a caching problem. Even if the user is offline. Thank you 😄

App/src/components/DistanceEReceipt.js

Lines 67 to 70 in 7b836cf

    
           {isOffline || !thumbnailSource ? ( 
        
               <PendingMapView /> 
        
           ) : ( 
        
               <ThumbnailImage

Tony-MK · 2023-12-28T02:50:18Z

Thank you @paultsimura for your feedback on my proposal. After reading #28965, I would like to ask you a question.

This should be handled in #28965, where the green receipt thumbnail will be replaced by an actual map.

Depending on the user's internet connection, if the user changes the waypoints while the device is offline then the thumbnailSource will be the default receipt.

The default receipt will be displayed instead of the PendingMapView for some time until the updated map image is fetched.

Is this correct? Thank you 😄

parasharrajat · 2023-12-28T20:46:33Z

It's good to solve other inconsistencies but I will let @kevinksullivan decide those if they should be solved in this issue.

@kevinksullivan There are some suggestions from #33362 (comment) but the are out of scope of the expected behaviour of this issue. Should we pursue those as well?

Important Note
I discovered a couple of inconsistent components that don't appear as they should when a distance request is created offline. I believe we can address them because they were left out from #30232 To mention a few:

The amount field opacity should be dimmed when it shows TBD.
In MoneyRequestView, there are three components that should show TBD because the distance and amount have not been recalculated. We could also address this.

parasharrajat · 2023-12-28T20:47:13Z

but it was already discussed in a couple of places that we should move towards using transaction.isLoading instead of checking for pending waypoints

@paultsimura Can you please share the context where this was discussed?

paultsimura · 2023-12-29T10:31:29Z

Can you please share the context where this was discussed?

Sorry, I don't remember the exact issues as they were eventually closed (that's why we don't see transaction.isLoading being used for TBD yet).

I just remember the pro-points were:

Centralised control over the transaction's loading state in a single place instead of using _.has(transactionChanges, 'waypoints') in different places, as it is set here:

App/src/libs/actions/IOU.js

Lines 936 to 946 in 249096e

    
           // Optimistically modify the transaction 
        
           optimisticData.push({ 
        
               onyxMethod: Onyx.METHOD.MERGE, 
        
               key: `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, 
        
               value: { 
        
                   ...updatedTransaction, 
        
                   pendingFields, 
        
                   isLoading: _.has(transactionChanges, 'waypoints'), 
        
                   errorFields: null, 
        
               }, 
        
           });

It's already used here to handle the loading state of a Distance request:

App/src/pages/iou/request/step/IOURequestStepDistance.js

Line 67 in 5c5c862

const isLoading = lodashGet(transaction, 'isLoading', false);

parasharrajat · 2023-12-29T20:33:47Z

@kevinksullivan Can you please confirm this #33362 (comment)?

parasharrajat · 2024-01-02T12:03:40Z

We need to discuss the above point before moving forward. I am one step away from finalizing the review.

parasharrajat · 2024-01-09T08:18:11Z

Hmm, I don't have much idea of this part. I will let know after some testing.

Meanwhile, @Tony-MK Do you mind proposing the suggestions as problems following https://github.com/Expensify/App/blob/main/contributingGuides/HOW_TO_CREATE_A_PLAN.md#step-1-define-the-problem?

Why should we make these changes?

paultsimura · 2024-01-09T14:20:14Z

Thanks. The PR is ready for review: #34135

neil-marcellini · 2024-02-08T22:23:35Z

As I mentioned here, we need to update the regression tests for offline distance requests to match up with this change. @kevinksullivan would you please help out with that? The new expected results can be found in the QA/test steps on the PR.

melvin-bot · 2024-02-12T13:53:04Z

Reviewing label has been removed, please complete the "BugZero Checklist".

melvin-bot · 2024-02-12T13:53:08Z

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.4.39-8 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

fix: unify TBD-related logic for Distance requests #34135

If no regressions arise, payment will be issued on 2024-02-19. 🎊

For reference, here are some details about the assignees on this issue:

@paultsimura requires payment automatic offer (Contributor)
@parasharrajat requires payment through NewDot Manual Requests

melvin-bot · 2024-02-12T13:53:09Z

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

[@parasharrajat] The PR that introduced the bug has been identified. Link to the PR:
[@parasharrajat] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
[@parasharrajat] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
[@parasharrajat] Determine if we should create a regression test for this bug.
[@parasharrajat] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
[@kevinksullivan] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

melvin-bot · 2024-02-20T15:41:26Z

⚠️ Looks like this issue was linked to a Deploy Blocker here

If you are the assigned CME please investigate whether the linked PR caused a regression and leave a comment with the results.

If a regression has occurred and you are the assigned CM follow the instructions here.

If this regression could have been avoided please consider also proposing a recommendation to the PR checklist so that we can avoid it in the future.

paultsimura · 2024-02-20T15:43:56Z

False alert – I used this issue as a reference.

parasharrajat · 2024-02-20T16:29:52Z

I think the issue is eligible for a bonus due to the scope change on the PR. @paultsimura did great job in handling and managing the discussion till the end.

melvin-bot · 2024-02-21T15:02:46Z

@amyevans, @paultsimura, @kevinksullivan, @parasharrajat Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

kevinksullivan · 2024-02-22T17:28:51Z

Payment summary:

C+ @parasharrajat $500
Contributor @paultsimura $500

parasharrajat · 2024-05-13T06:36:33Z

Payment requested as per #33362 (comment)

JmillsExpensify · 2024-05-19T16:39:40Z

$500 approved for @parasharrajat

kbecciv added External Added to denote the issue can be worked on by a contributor Daily KSv2 Bug Something is broken. Auto assigns a BugZero manager. labels Dec 20, 2023

melvin-bot bot changed the title ~~Distance - Receipt shows original amount and distance instead of TBD when editing distance offline~~ [$500] Distance - Receipt shows original amount and distance instead of TBD when editing distance offline Dec 20, 2023

melvin-bot bot assigned kevinksullivan Dec 20, 2023

melvin-bot bot added the Help Wanted Apply this label when an issue is open to proposals by contributors label Dec 20, 2023

melvin-bot bot assigned parasharrajat Dec 20, 2023

melvin-bot bot added the Overdue label Dec 24, 2023

melvin-bot bot removed the Overdue label Dec 27, 2023

melvin-bot bot added the Overdue label Jan 1, 2024

paultsimura mentioned this issue Jan 9, 2024

fix: unify TBD-related logic for Distance requests #34135

Merged

62 tasks

melvin-bot bot added Reviewing Has a PR in review Weekly KSv2 and removed Daily KSv2 labels Jan 9, 2024

melvin-bot bot added Weekly KSv2 and removed Weekly KSv2 labels Jan 20, 2024

neil-marcellini mentioned this issue Feb 8, 2024

Web - IOU - Wrong values for Amount and Total fields in Offline #36184

Closed

6 tasks

melvin-bot bot added Weekly KSv2 Awaiting Payment Auto-added when associated PR is deployed to production and removed Weekly KSv2 labels Feb 12, 2024

melvin-bot bot changed the title ~~[$500] Distance - Receipt shows original amount and distance instead of TBD when editing distance offline~~ [HOLD for payment 2024-02-19] [$500] Distance - Receipt shows original amount and distance instead of TBD when editing distance offline Feb 12, 2024

melvin-bot bot removed the Reviewing Has a PR in review label Feb 12, 2024

melvin-bot bot added Daily KSv2 and removed Weekly KSv2 labels Feb 18, 2024

melvin-bot bot added the Overdue label Feb 20, 2024

melvin-bot bot removed the Overdue label Feb 22, 2024

kevinksullivan closed this as completed Feb 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HOLD for payment 2024-02-19] [$500] Distance - Receipt shows original amount and distance instead of TBD when editing distance offline #33362

[HOLD for payment 2024-02-19] [$500] Distance - Receipt shows original amount and distance instead of TBD when editing distance offline #33362

kbecciv commented Dec 20, 2023 •

edited by neil-marcellini

Loading

melvin-bot bot commented Dec 20, 2023

melvin-bot bot commented Dec 20, 2023

melvin-bot bot commented Dec 20, 2023

melvin-bot bot commented Dec 20, 2023

dukenv0307 commented Dec 20, 2023 •

edited

Loading

paultsimura commented Dec 20, 2023 •

edited

Loading

kevinksullivan commented Dec 22, 2023

parasharrajat commented Dec 22, 2023

Tony-MK commented Dec 24, 2023 •

edited

Loading

paultsimura commented Dec 25, 2023

melvin-bot bot commented Dec 26, 2023

melvin-bot bot commented Dec 27, 2023

parasharrajat commented Dec 27, 2023

Tony-MK commented Dec 27, 2023

Tony-MK commented Dec 28, 2023

parasharrajat commented Dec 28, 2023

parasharrajat commented Dec 28, 2023

paultsimura commented Dec 29, 2023

parasharrajat commented Dec 29, 2023

parasharrajat commented Jan 2, 2024

parasharrajat commented Jan 9, 2024 •

edited

Loading

paultsimura commented Jan 9, 2024

neil-marcellini commented Feb 8, 2024 •

edited

Loading

melvin-bot bot commented Feb 12, 2024

melvin-bot bot commented Feb 12, 2024

melvin-bot bot commented Feb 12, 2024

melvin-bot bot commented Feb 20, 2024

paultsimura commented Feb 20, 2024

parasharrajat commented Feb 20, 2024

melvin-bot bot commented Feb 21, 2024

kevinksullivan commented Feb 22, 2024

parasharrajat commented May 13, 2024

JmillsExpensify commented May 19, 2024

[HOLD for payment 2024-02-19] [$500] Distance - Receipt shows original amount and distance instead of TBD when editing distance offline #33362

[HOLD for payment 2024-02-19] [$500] Distance - Receipt shows original amount and distance instead of TBD when editing distance offline #33362

Comments

kbecciv commented Dec 20, 2023 • edited by neil-marcellini Loading

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

melvin-bot bot commented Dec 20, 2023

melvin-bot bot commented Dec 20, 2023

melvin-bot bot commented Dec 20, 2023

Bug0 Triage Checklist (Main S/O)

melvin-bot bot commented Dec 20, 2023

dukenv0307 commented Dec 20, 2023 • edited Loading

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

What alternative solutions did you explore? (Optional)

paultsimura commented Dec 20, 2023 • edited Loading

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

What alternative solutions did you explore? (Optional)

kevinksullivan commented Dec 22, 2023

parasharrajat commented Dec 22, 2023

Tony-MK commented Dec 24, 2023 • edited Loading

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

paultsimura commented Dec 25, 2023

melvin-bot bot commented Dec 26, 2023

melvin-bot bot commented Dec 27, 2023

parasharrajat commented Dec 27, 2023

Tony-MK commented Dec 27, 2023

Tony-MK commented Dec 28, 2023

parasharrajat commented Dec 28, 2023

parasharrajat commented Dec 28, 2023

paultsimura commented Dec 29, 2023

parasharrajat commented Dec 29, 2023

parasharrajat commented Jan 2, 2024

parasharrajat commented Jan 9, 2024 • edited Loading

paultsimura commented Jan 9, 2024

neil-marcellini commented Feb 8, 2024 • edited Loading

melvin-bot bot commented Feb 12, 2024

melvin-bot bot commented Feb 12, 2024

melvin-bot bot commented Feb 12, 2024

melvin-bot bot commented Feb 20, 2024

paultsimura commented Feb 20, 2024

parasharrajat commented Feb 20, 2024

melvin-bot bot commented Feb 21, 2024

kevinksullivan commented Feb 22, 2024

parasharrajat commented May 13, 2024

JmillsExpensify commented May 19, 2024

kbecciv commented Dec 20, 2023 •

edited by neil-marcellini

Loading

dukenv0307 commented Dec 20, 2023 •

edited

Loading

paultsimura commented Dec 20, 2023 •

edited

Loading

Tony-MK commented Dec 24, 2023 •

edited

Loading

parasharrajat commented Jan 9, 2024 •

edited

Loading

neil-marcellini commented Feb 8, 2024 •

edited

Loading