[Due for payment 2025-03-13] [$250] Track tax - RHP opens tax settings instead of distance rate after selecting the same tax rate

@bfitzexpensify

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: 9.1.3-0
Reproducible in staging?: Yes
Reproducible in production?: Yes
If this was caught during regression testing, add the test name, ID and link from TestRail: Exp
Email or phone of affected tester (no customers): applausetester+sj9032@applause.expensifail.com
Issue reported by: Applause Internal Team
Device used: Mac 15.0 / Chrome
App Component: Workspace Settings

Action Performed:

Precondition:

Distance rates and tax features are enabled.

Go to staging.new.expensify.com
Go to workspace settings > Distance rates.
Click Settings.
Enable Track tax.
Close the RHP.
Open any distance rate.
Click Tax rate.
Select a tax rate.
Click Tax rate.
Click on the already selected tax rate.

Expected Result:

RHP will return to distance rate page.

Actual Result:

RHP opens tax settings page.

Workaround:

Unknown

Platforms:

Screenshots/Videos

Bug6749810_1740123564296.20250221_152838.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~021892975947202280745
Upwork Job ID: 1892975947202280745
Last Price Increase: 2025-02-21
Automatic offers:

daledah | Contributor | 106307625

Issue Owner

Current Issue Owner: @bfitzexpensify

@bfitzexpensify

Triggered auto assignment to @bfitzexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

🚨 Edited by proposal-police: This proposal was edited at 2025-02-21 08:38:35 UTC.

Proposal

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

RHP opens tax settings page.

What is the root cause of that problem?

When we click the item again we call onDismiss function

App/src/components/TaxPicker.tsx

Lines 101 to 106 in 9d8eef2

    
           const handleSelectRow = useCallback( 
        
               (newSelectedOption: TaxOptionsListUtils.TaxRatesOption) => { 
        
                   if (selectedOptionKey === newSelectedOption.keyForList) { 
        
                       onDismiss(); 
        
                       return; 
        
                   }

We should navigate to WORKSPACE_TAXES_SETTINGS route

App/src/pages/workspace/distanceRates/PolicyDistanceRateTaxRateEditPage.tsx

Lines 53 to 55 in 9d8eef2

    
           const dismiss = () => { 
        
               Navigation.goBack(ROUTES.WORKSPACE_TAXES_SETTINGS.getRoute(policyID)); 
        
           };

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

We are navigating to WORKSPACE_DISTANCE_RATE_DETAILS route when dismissing

    const dismiss = () => {
        Navigation.goBack(ROUTES.WORKSPACE_DISTANCE_RATE_DETAILS.getRoute(policyID, rateID));
    };

App/src/pages/workspace/distanceRates/PolicyDistanceRateTaxRateEditPage.tsx

Lines 53 to 55 in 9d8eef2

    
           const dismiss = () => { 
        
               Navigation.goBack(ROUTES.WORKSPACE_TAXES_SETTINGS.getRoute(policyID)); 
        
           };

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

None

What alternative solutions did you explore? (Optional)

Reminder: Please use plain English, be brief and avoid jargon. Feel free to use images, charts or pseudo-code if necessary. Do not post large multi-line diffs or write walls of text. Do not create PRs unless you have been hired for this job.

Proposal

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

RHP opens tax settings instead of distance rate after selecting the same tax rate

What is the root cause of that problem?

 The implementation of PolicyDistanceRateTaxRateEditPage is totally wrong here.   The current bug happens because when we select the same option we call dismiss function:  

App/src/pages/workspace/distanceRates/PolicyDistanceRateTaxRateEditPage.tsx

Lines 53 to 55 in 9d8eef2

    
           const dismiss = () => { 
        
               Navigation.goBack(ROUTES.WORKSPACE_TAXES_SETTINGS.getRoute(policyID)); 
        
           };

This leads us to the WORKSPACE_TAXES_SETTINGS page.  
This is the RCA, now there is not need to call the dismiss function here, we already handle the logic to navigate back in the onTaxRateChange function: 

App/src/pages/workspace/distanceRates/PolicyDistanceRateTaxRateEditPage.tsx

Lines 33 to 37 in 9d8eef2

    
           const onTaxRateChange = (newTaxRate: TaxOptionsListUtils.TaxRatesOption) => { 
        
               if (taxRateExternalID === newTaxRate.code) { 
        
                   Navigation.goBack(); 
        
                   return; 
        
               }

 So the use of dismiss was introduced in  

fix: [Track tax] Disabled tax rate can be selected. #44046

But the implementation was not rightly done leading to this bug, that PR added the filter logic correctly but pretty badly affected the navigation logic.

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

Remove the use of OnDismiss from the parent TaxPicker, ie. remove the handleSelectRow function:

App/src/components/TaxPicker.tsx

Lines 101 to 110 in bf50378

    
           const handleSelectRow = useCallback( 
        
               (newSelectedOption: TaxOptionsListUtils.TaxRatesOption) => { 
        
                   if (selectedOptionKey === newSelectedOption.keyForList) { 
        
                       onDismiss(); 
        
                       return; 
        
                   } 
        
                   onSubmit(newSelectedOption); 
        
               }, 
        
               [onSubmit, onDismiss, selectedOptionKey], 
        
           );

Replace the usage of handleSelectRow with onSubmit as that is what is done when we select the row:

App/src/components/TaxPicker.tsx

Line 119 in bf50378

onSelectRow={handleSelectRow}

Remove onDismiss function in PolicyDistanceRateTaxRateEditPage:

App/src/pages/workspace/distanceRates/PolicyDistanceRateTaxRateEditPage.tsx

Lines 53 to 56 in 9d8eef2

    
           const dismiss = () => { 
        
               Navigation.goBack(ROUTES.WORKSPACE_TAXES_SETTINGS.getRoute(policyID)); 
        
           };

The case when we select the same key is already taken care of here:

App/src/pages/workspace/distanceRates/PolicyDistanceRateTaxRateEditPage.tsx

Lines 33 to 36 in 9d8eef2

    
           const onTaxRateChange = (newTaxRate: TaxOptionsListUtils.TaxRatesOption) => { 
        
               if (taxRateExternalID === newTaxRate.code) { 
        
                   Navigation.goBack(); 
        
                   return;

So we don't need to introduce any new thing. We also need to update a few places where TaxPicker is used, but this is the clean approach to solve this bug as we do not need OnDismiss and handleSelectRow can directly have the function onSubmit which simplifies logic handling
 

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

N/A this is a navigation bug

What alternative solutions did you explore? (Optional)

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

@ishpaul777

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

@ishpaul777

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

@ishpaul777

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

fix: incorrect navigate when dismissing tax picker #57555

If no regressions arise, payment will be issued on 2025-03-13. 🎊

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

@ishpaul777 requires payment through NewDot Manual Requests
@daledah requires payment automatic offer (Contributor)

@ishpaul777

@ishpaul777 @bfitzexpensify @ishpaul777 The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed. Please copy/paste the BugZero Checklist from here into a new comment on this GH and complete it. If you have the K2 extension, you can simply click: [this button]

@daledah

Payment complete to @daledah

@ishpaul777, please complete the BZ checklist

BugZero Checklist:

[Contributor] Classify the bug:

Bug classification

Source of bug:

1a. Result of the original design (eg. a case wasn't considered)
1b. Mistake during implementation
1c. Backend bug
1z. Other:

Where bug was reported:

2a. Reported on production (eg. bug slipped through the normal regression and PR testing process on staging)
2b. Reported on staging (eg. found during regression or PR testing)
2d. Reported on a PR
2z. Other:

Who reported the bug:

[Contributor] 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: https://github.com/Expensify/App/pull/44046/files#r1993944642
[Contributor] If the regression was CRITICAL (e.g. interrupts a core flow) A discussion in #expensify-open-source 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: no need simple navigation issue does not block any functionality
[Contributor] If it was decided to create a regression test for the bug, please propose the regression test steps using the template below to ensure the same bug will not reach production again. - no need simple navigation issue does not block any functionality

@bfitzexpensify

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

@ishpaul777

Payment summary:

@ishpaul777 due $250 via NewDot manual request for C+ work

@ishpaul777

$250 approved for @ishpaul777

Navigation Menu

Repository navigation

[Due for payment 2025-03-13] [$250] Track tax - RHP opens tax settings instead of distance rate after selecting the same tax rate #57233

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

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 specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

What alternative solutions did you explore? (Optional)

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 specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

What alternative solutions did you explore? (Optional)

23 remaining items

BugZero Checklist:

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	const handleSelectRow = useCallback(
	(newSelectedOption: TaxOptionsListUtils.TaxRatesOption) => {
	if (selectedOptionKey === newSelectedOption.keyForList) {
	onDismiss();
	return;
	}

	const dismiss = () => {
	Navigation.goBack(ROUTES.WORKSPACE_TAXES_SETTINGS.getRoute(policyID));
	};

	const onTaxRateChange = (newTaxRate: TaxOptionsListUtils.TaxRatesOption) => {
	if (taxRateExternalID === newTaxRate.code) {
	Navigation.goBack();
	return;
	}

[Due for payment 2025-03-13] [$250] Track tax - RHP opens tax settings instead of distance rate after selecting the same tax rate #57233

Description

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Activity

melvin-bot commented on Feb 21, 2025

daledah commented on Feb 21, 2025

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 specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

What alternative solutions did you explore? (Optional)

twilight2294 commented on Feb 21, 2025

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 specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

What alternative solutions did you explore? (Optional)

melvin-bot commented on Feb 21, 2025

melvin-bot commented on Feb 21, 2025

melvin-bot commented on Feb 25, 2025

23 remaining items

melvin-bot commented on Mar 6, 2025

melvin-bot commented on Mar 6, 2025

bfitzexpensify commented on Mar 13, 2025

ishpaul777 commented on Mar 13, 2025

BugZero Checklist:

melvin-bot commented on Mar 17, 2025

bfitzexpensify commented on Mar 18, 2025

garrettmknight commented on Mar 24, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions