[Checklist and NewDot C+ payment][$500] Distance - Distance request briefly shows local currency instead of workspace currency after creating it #37643

lanitochka17 · 2024-03-01T21:00:31Z

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: 1.4.46-0
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:

Default workspace currency is different from local currency

Go to staging.new.expensify.com
Go to workspace chat
Go to + > Request money > Distance
Create a distance request

Expected Result:

The amount in distance request preview in the main chat will show default workspace currency

Actual Result:

The amount in distance request preview in the main chat briefly shows local currency

Workaround:

Unknown

Platforms:

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

Screenshots/Videos

Add any screenshot/video evidence

Bug6398768_1709324762143.bandicam_2024-03-02_03-27-34-243.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~010a112a7314639b9b
Upwork Job ID: 1765247495001948160
Last Price Increase: 2024-03-06
Automatic offers:

bernhardoj | Contributor | 0

Issue Owner

Current Issue Owner: @sobitneupane

melvin-bot · 2024-03-01T21:00:43Z

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

lanitochka17 · 2024-03-01T21:01:12Z

@kadiealexander FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

lanitochka17 · 2024-03-01T21:01:41Z

We think that this bug might be related to #wave5
CC @dylanexpensify

bernhardoj · 2024-03-02T08:45:34Z

Proposal

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

When creating a distance request, the user's local currency code is shown in the preview instead of the workspace currency.

What is the root cause of that problem?

When creating a distance request, we already calculate the distance amount and include the workspace currency here.

App/src/components/MoneyTemporaryForRefactorRequestConfirmationList.js

Lines 349 to 350 in af68510

    
           const amount = DistanceRequestUtils.getDistanceRequestAmount(distance, unit, rate); 
        
           IOU.setMoneyRequestAmount_temporaryForRefactor(transaction.transactionID, amount, currency);

The currency is taken from the workspace mileage rate.

App/src/components/MoneyTemporaryForRefactorRequestConfirmationList.js

Line 251 in af68510

const {unit, rate, currency} = mileageRate;

However, there are 2 places where the currency is overwritten with the local currency.

First, when we arrive at the distance confirmation page, the manual (amount) tab is unmounted. This will trigger this useEffect clean up which sets the transaction currency with the original currency. The original currency is the user local currency.

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

Lines 106 to 113 in af68510

    
               return () => { 
        
                   if (isSaveButtonPressed.current) { 
        
                       return; 
        
                   } 
        
                   IOU.setMoneyRequestCurrency_temporaryForRefactor(transactionID, originalCurrency.current, true); 
        
               }; 
        
               // eslint-disable-next-line react-hooks/exhaustive-deps 
        
           }, []);

Second, when the confirmation page is mounted, we check if the transaction contains an originalCurrency attribute, if yes, the transaction currency is set to originalCurrency.

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

Lines 111 to 118 in af68510

    
           useEffect(() => { 
        
               if (!transaction || !transaction.originalCurrency) { 
        
                   return; 
        
               } 
        
               // If user somehow lands on this page without the currency reset, then reset it here. 
        
               IOU.setMoneyRequestCurrency_temporaryForRefactor(transactionID, transaction.originalCurrency, true); 
        
               // eslint-disable-next-line react-hooks/exhaustive-deps 
        
           }, []);

They assume that when the user arrives, the originalCurrency is already removed from the transaction because we clear it when pressing the Next button, but only from the manual page/tab.

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

Line 136 in af68510

    
           IOU.setMoneyRequestAmount_temporaryForRefactor(transactionID, amountInSmallestCurrencyUnits, currency || CONST.CURRENCY.USD, true);

App/src/libs/actions/IOU.ts

Lines 294 to 296 in af68510

    
           function setMoneyRequestAmount_temporaryForRefactor(transactionID: string, amount: number, currency: string, removeOriginalCurrency = false) { 
        
               if (removeOriginalCurrency) { 
        
                   Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION_DRAFT}${transactionID}`, {amount, currency, originalCurrency: null});

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

Revert #34075 and fix the original issue, that is #33608. The issue is, let's say I set the currency to A. Then, on the edit amount page, I open the currency picker and select currency B. Then, I reopen the currency picker page, but it shows currency A as the selected currency and that's because the currency picker page shows the selected currency from the transaction object only, but when we select currency B, we haven't pressed the Save button yet.

To solve it, we can allow the currency picker page (IOURequestStepCurrency) to accept the currency from params and transaction object, similar to what we do in the old amount page.

To cover a case where the user pass an invalid currency params, we can check whether the currency is valid or not, just like we did here:

App/src/pages/iou/steps/NewRequestAmountPage.js

Line 70 in 1f3e31f

    
           const currency = CurrencyUtils.isValidCurrencyCode(currentCurrency) ? currentCurrency : iou.currency;

const currency = CurrencyUtils.isValidCurrencyCode(currencyFromParams) || currencyFromTransactionObject

What alternative solutions did you explore? (Optional)

First alternative:
The originalCurrency is basically being used to reset the transaction currency when the user cancels editing the amount, I don't see it being useful for the start page. So, we can ignore the originalCurrency effect when we are not editing amount.

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

Lines 99 to 113 in af68510

    
           useEffect(() => { 
        
               if (transaction.originalCurrency) { 
        
                   originalCurrency.current = transaction.originalCurrency; 
        
               } else { 
        
                   originalCurrency.current = currency; 
        
                   IOU.setMoneyRequestOriginalCurrency_temporaryForRefactor(transactionID, currency); 
        
               } 
        
               return () => { 
        
                   if (isSaveButtonPressed.current) { 
        
                       return; 
        
                   } 
        
                   IOU.setMoneyRequestCurrency_temporaryForRefactor(transactionID, originalCurrency.current, true); 
        
               }; 
        
               // eslint-disable-next-line react-hooks/exhaustive-deps 
        
           }, []);

Currently, we check for backTo params to check whether it's an amount edit page or not, so I'm gonna use that too for now.

useEffect(() => {
    if (!backTo) return;
    ...restOfTheCode
}, [])

Then, we don't need the changes on other pages anymore.

Second alternative:
I see that this originalCurrency logic is only being used for manual case because both scan and distance don't have an amount input, so it makes sense to check whether the request is manual or not before doing the cleanup. Also, we need to clear the originalCurrency when pressing the Next button in distance tab.

> IOURequestStepConfirmation
useEffect(() => {
    if (!transaction || !transaction.originalCurrency || requestType !== CONST.IOU.REQUEST_TYPE.MANUAL) {
        return;
    }
    // If user somehow lands on this page without the currency reset, then reset it here.
    IOU.setMoneyRequestCurrency_temporaryForRefactor(transactionID, transaction.originalCurrency, true);
}, []);

> IOURequestStepAmount
useEffect(() => (iouRequestTypeRef.current = iouRequestType), [iouRequestType]);

useEffect(() => {
    return () => {
        if (isSaveButtonPressed.current || iouRequestTypeRef.current !== CONST.IOU.REQUEST_TYPE.MANUAL) {
            return;
        }
        IOU.setMoneyRequestCurrency_temporaryForRefactor(transactionID, originalCurrency.current, true);
    };
}, []);

> IOURequestStepDistance
const navigateToNextStep = () =>
    IOU.setMoneyRequestOriginalCurrency_temporaryForRefactor(transactionID, null);

melvin-bot · 2024-03-05T15:23:44Z

@kadiealexander Whoops! This issue is 2 days overdue. Let's get this updated quick!

melvin-bot · 2024-03-05T19:19:28Z

@kadiealexander Whoops! This issue is 2 days overdue. Let's get this updated quick!

kadiealexander · 2024-03-06T05:26:05Z

Not overdue!

melvin-bot · 2024-03-06T05:26:16Z

Job added to Upwork: https://www.upwork.com/jobs/~010a112a7314639b9b

melvin-bot · 2024-03-06T05:26:21Z

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

kadiealexander · 2024-03-11T00:17:43Z

@sobitneupane please review the proposal from @bernhardoj.

sobitneupane · 2024-03-12T14:10:55Z

Thanks for the proposal @bernhardoj.

We can go with your alternative proposal. Let's define a variable isEditing and we can use it in

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

Line 166 in af68510

isEditing={Boolean(backTo)}

The code was introduced by #34075 to solve #33608 issue.

🎀 👀 🎀 C+ reviewed

melvin-bot · 2024-03-12T14:11:08Z

Triggered auto assignment to @roryabraham, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

roryabraham · 2024-03-12T22:10:32Z

neither proposal is very clear to me tbh, but that's probably my shortcoming. Bear with me here...

roryabraham · 2024-03-12T22:30:54Z

Ok, I think think is pretty confusing because there are so many places where data is being modified in useEffect callbacks. I also think checking for the presence of a backTo param to see if we're manually editing a field feels like a really convoluted approach that's very tightly coupled to our UI flows.

roryabraham · 2024-03-12T22:35:03Z

However, there are 2 places where the currency is overwritten with the local currency.

Can someone explain to me what would happen if we were to just remove these two effects completely?

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

Lines 99 to 113 in b051dc4

    
           useEffect(() => { 
        
               if (transaction.originalCurrency) { 
        
                   originalCurrency.current = transaction.originalCurrency; 
        
               } else { 
        
                   originalCurrency.current = currency; 
        
                   IOU.setMoneyRequestOriginalCurrency_temporaryForRefactor(transactionID, currency); 
        
               } 
        
               return () => { 
        
                   if (isSaveButtonPressed.current) { 
        
                       return; 
        
                   } 
        
                   IOU.setMoneyRequestCurrency_temporaryForRefactor(transactionID, originalCurrency.current, true); 
        
               }; 
        
               // eslint-disable-next-line react-hooks/exhaustive-deps 
        
           }, []);

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

Lines 111 to 118 in 005580d

    
           useEffect(() => { 
        
               if (!transaction || !transaction.originalCurrency) { 
        
                   return; 
        
               } 
        
               // If user somehow lands on this page without the currency reset, then reset it here. 
        
               IOU.setMoneyRequestCurrency_temporaryForRefactor(transactionID, transaction.originalCurrency, true); 
        
               // eslint-disable-next-line react-hooks/exhaustive-deps 
        
           }, []);

bernhardoj · 2024-03-13T05:57:32Z

@roryabraham

The first one is to revert the currency to the "draft" (original) currency.

Screen.Recording.2024-03-13.at.13.45.06.mov

If we remove it, then the currency will be updated even without pressing the Save button (on the edit page).

I believe the second one is to mimic the behavior of the previous version of the money request page. Currently, when we select a currency from the currency selection page, it will immediately be saved to the transaction draft.

If the user directly accesses the confirmation page (by changing the URL), the second useEffect will revert the currency to the "draft" (original) currency.

Open the money request page
Change the currency from A to B (originalCurrency is A, currency is B)
Change the URL to the confirmation page
The second useEffect will kick in and the currency shown will be currency A (originalCurrency)

Previously, the currency would only be saved when we pressed the Next button, so if the user directly accessed the page, the user would see the first currency.

Open the money request page
Change the currency from A to B (currency is A)
Change the URL to the confirmation page
The currency shown will be currency A (currency)

If we remove it, then we will see the updated currency on confirmation page.

Screen.Recording.2024-03-13.at.13.53.39.mov

bernhardoj · 2024-03-24T09:30:56Z

PR is ready

cc: @sobitneupane

melvin-bot · 2024-04-16T18:14:19Z

This issue has not been updated in over 15 days. @sobitneupane, @roryabraham, @bernhardoj, @kadiealexander eroding to Monthly issue.

P.S. Is everyone reading this sure this is really a near-term priority? Be brave: if you disagree, go ahead and close it out. If someone disagrees, they'll reopen it, and if they don't: one less thing to do!

roryabraham · 2024-04-16T18:26:21Z

PR was merged yesterday

melvin-bot · 2024-04-19T14:47:34Z

⚠️ 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.

melvin-bot · 2024-04-20T21:35:35Z

⚠️ 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.

s77rt · 2024-04-20T21:41:08Z

This one is a false alert #37643 (comment) sorry for that

roryabraham · 2024-04-27T18:12:22Z

@kadiealexander the PR was deployed to production on 2024-04-22, so the next step is to pay this out on Monday 2024-04-29

kadiealexander · 2024-04-30T05:40:34Z

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:

[@sobitneupane] The PR that introduced the bug has been identified. Link to the PR:
[@sobitneupane] 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:
[@sobitneupane] 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:
[@sobitneupane] Determine if we should create a regression test for this bug.
[@sobitneupane] 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.
[@kadiealexander] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

kadiealexander · 2024-04-30T05:42:55Z

Payment Summary

Contributor: @bernhardoj due $500 via Upwork
Reviewer: @sobitneupane owed $500 via NewDot

BugZero Checklist (@kadiealexander)

I have verified the correct assignees and roles are listed above and updated the neccesary manual offers
I have verified that there are no duplicate or incorrect contracts on Upwork for this job (https://www.upwork.com/ab/applicants//hired)
I have paid out the Upwork contracts or cancelled the ones that are incorrect
I have verified the payment summary above is correct

sobitneupane · 2024-05-07T10:00:08Z

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:

[@sobitneupane] The PR that introduced the bug has been identified. Link to the PR:

#34075

[@sobitneupane] 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:

#34075 (comment)

[@sobitneupane] 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:

[@sobitneupane] Determine if we should create a regression test for this bug.

Yes

[@sobitneupane] 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.

#37643 (comment)

sobitneupane · 2024-05-07T10:00:44Z

Regression Test Proposal

Prerequisite: Have a workspace with a currency set to different currency than your local currency

Open the workspace chat
Create a new distance request
Verify the distance request preview shows the workspace currency

Do we agree 👍 or 👎

sobitneupane · 2024-05-08T09:53:27Z

Requested payment in newDot.

kadiealexander · 2024-05-10T00:19:46Z

Regression test: https://github.com/Expensify/Expensify/issues/394860

JmillsExpensify · 2024-05-12T19:11:43Z

$500 approved for @sobitneupane

lanitochka17 added Daily KSv2 Bug Something is broken. Auto assigns a BugZero manager. labels Mar 1, 2024

melvin-bot bot assigned kadiealexander Mar 1, 2024

melvin-bot bot added the Overdue label Mar 4, 2024

melvin-bot bot removed the Overdue label Mar 6, 2024

kadiealexander added External Added to denote the issue can be worked on by a contributor Overdue labels Mar 6, 2024

melvin-bot bot changed the title ~~Distance - Distance request briefly shows local currency instead of workspace currency after creating it~~ [$500] Distance - Distance request briefly shows local currency instead of workspace currency after creating it Mar 6, 2024

melvin-bot bot added the Help Wanted Apply this label when an issue is open to proposals by contributors label Mar 6, 2024

melvin-bot bot assigned sobitneupane Mar 6, 2024

melvin-bot bot added Overdue and removed Overdue labels Mar 6, 2024

melvin-bot bot removed the Overdue label Mar 11, 2024

melvin-bot bot assigned roryabraham Mar 12, 2024

melvin-bot bot added the Weekly KSv2 label Mar 24, 2024

melvin-bot bot added Monthly KSv2 and removed Weekly KSv2 labels Apr 16, 2024

roryabraham added Weekly KSv2 Monthly KSv2 and removed Monthly KSv2 Reviewing Has a PR in review labels Apr 16, 2024

melvin-bot bot added the Overdue label Apr 24, 2024

roryabraham added Awaiting Payment Auto-added when associated PR is deployed to production and removed Monthly KSv2 labels Apr 27, 2024

melvin-bot bot removed the Overdue label Apr 27, 2024

melvin-bot bot added Daily KSv2 and removed Weekly KSv2 labels May 4, 2024

sobitneupane mentioned this issue May 7, 2024

Fixed currency selection on confirm step #34075

Merged

49 tasks

kadiealexander closed this as completed May 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Checklist and NewDot C+ payment][$500] Distance - Distance request briefly shows local currency instead of workspace currency after creating it #37643

[Checklist and NewDot C+ payment][$500] Distance - Distance request briefly shows local currency instead of workspace currency after creating it #37643

lanitochka17 commented Mar 1, 2024 •

edited by kadiealexander

Loading

melvin-bot bot commented Mar 1, 2024

lanitochka17 commented Mar 1, 2024

lanitochka17 commented Mar 1, 2024

bernhardoj commented Mar 2, 2024 •

edited

Loading

melvin-bot bot commented Mar 5, 2024

melvin-bot bot commented Mar 5, 2024

kadiealexander commented Mar 6, 2024

melvin-bot bot commented Mar 6, 2024

melvin-bot bot commented Mar 6, 2024

kadiealexander commented Mar 11, 2024

sobitneupane commented Mar 12, 2024

melvin-bot bot commented Mar 12, 2024

roryabraham commented Mar 12, 2024 •

edited

Loading

roryabraham commented Mar 12, 2024

roryabraham commented Mar 12, 2024 •

edited

Loading

bernhardoj commented Mar 13, 2024

bernhardoj commented Mar 24, 2024

melvin-bot bot commented Apr 16, 2024

roryabraham commented Apr 16, 2024

melvin-bot bot commented Apr 19, 2024

melvin-bot bot commented Apr 20, 2024

s77rt commented Apr 20, 2024

roryabraham commented Apr 27, 2024

kadiealexander commented Apr 30, 2024

kadiealexander commented Apr 30, 2024

sobitneupane commented May 7, 2024 •

edited

Loading

sobitneupane commented May 7, 2024

sobitneupane commented May 8, 2024

kadiealexander commented May 10, 2024

JmillsExpensify commented May 12, 2024

[Checklist and NewDot C+ payment][$500] Distance - Distance request briefly shows local currency instead of workspace currency after creating it #37643

[Checklist and NewDot C+ payment][$500] Distance - Distance request briefly shows local currency instead of workspace currency after creating it #37643

Comments

lanitochka17 commented Mar 1, 2024 • edited by kadiealexander Loading

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

melvin-bot bot commented Mar 1, 2024

lanitochka17 commented Mar 1, 2024

lanitochka17 commented Mar 1, 2024

bernhardoj commented Mar 2, 2024 • 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)

melvin-bot bot commented Mar 5, 2024

melvin-bot bot commented Mar 5, 2024

kadiealexander commented Mar 6, 2024

melvin-bot bot commented Mar 6, 2024

melvin-bot bot commented Mar 6, 2024

kadiealexander commented Mar 11, 2024

sobitneupane commented Mar 12, 2024

melvin-bot bot commented Mar 12, 2024

roryabraham commented Mar 12, 2024 • edited Loading

roryabraham commented Mar 12, 2024

roryabraham commented Mar 12, 2024 • edited Loading

bernhardoj commented Mar 13, 2024

bernhardoj commented Mar 24, 2024

melvin-bot bot commented Apr 16, 2024

roryabraham commented Apr 16, 2024

melvin-bot bot commented Apr 19, 2024

melvin-bot bot commented Apr 20, 2024

s77rt commented Apr 20, 2024

roryabraham commented Apr 27, 2024

kadiealexander commented Apr 30, 2024

kadiealexander commented Apr 30, 2024

Payment Summary

BugZero Checklist (@kadiealexander)

sobitneupane commented May 7, 2024 • edited Loading

sobitneupane commented May 7, 2024

sobitneupane commented May 8, 2024

kadiealexander commented May 10, 2024

JmillsExpensify commented May 12, 2024

lanitochka17 commented Mar 1, 2024 •

edited by kadiealexander

Loading

bernhardoj commented Mar 2, 2024 •

edited

Loading

roryabraham commented Mar 12, 2024 •

edited

Loading

roryabraham commented Mar 12, 2024 •

edited

Loading

sobitneupane commented May 7, 2024 •

edited

Loading