[Due for payment 2025-02-27] [$250] Taxes - App crashes when trying to disable tax rate.

@abekkala

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.0.93-1
Reproducible in staging?: Yes
Reproducible in production?: Yes
If this was caught on HybridApp, is this reproducible on New Expensify Standalone?: Yes, repro on both
If this was caught during regression testing, add the test name, ID and link from TestRail: #55192
Email or phone of affected tester (no customers): applausetester+bm456@applause.expensifail.com
Issue reported by: Applause Internal Team
Device used: Android and IOS
App Component: Workspace Settings

Action Performed:

Open the app
Create a workspace
Go to more features and enable taxes
Go to taxes and disable Tax Rate 1

Expected Result:

App shouldn't crash

Actual Result:

App crashes

Workaround:

Unknown

Platforms:

Screenshots/Videos

https://github.com/user-attachments/assets/0d63e0eb-d327-432e-a895-46c35a23bcce
Bug6729510_1738324887963!log.txt

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~021889364840283872581
Upwork Job ID: 1889364840283872581
Last Price Increase: 2025-02-11

Issue Owner

Current Issue Owner: @abekkala

@abekkala

Triggered auto assignment to @abekkala (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.

Proposal

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

App crashes

What is the root cause of that problem?

In native, after we reload the app and the first time we call setPolicyTaxesEnabled, allPolicies is undefined because the callback here isn't triggered before. So originalTaxes is an empty object

App/src/libs/actions/TaxRate.ts

Line 212 in f60c647

const originalTaxes = {...policy?.taxRates?.taxes};

Then the app crashes here

App/src/libs/actions/TaxRate.ts

Line 256 in f60c647

isDisabled: !!originalTaxes[taxID].isDisabled,

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

We should get the isDisabled safer

isDisabled: !!originalTaxes[taxID]?.isDisabled,

App/src/libs/actions/TaxRate.ts

Line 256 in f60c647

isDisabled: !!originalTaxes[taxID].isDisabled,

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)

NA

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.

@abekkala

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

@abekkala

@abekkala Huh... This is 4 days overdue. Who can take care of this?

@abekkala

@abekkala Now this issue is 8 days overdue. Are you sure this should be a Daily? Feel free to change it!

Proposal

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

App crashes when trying to disable tax rate after creating a new workspace.

What is the root cause of that problem?

This only happens when we open the tax rate page for the first time. No need to create a new workspace. When we toggle the tax, the policy here is undefined, so the taxes is undefined too.

App/src/libs/actions/TaxRate.ts

Lines 210 to 213 in 48520ec

    
           function setPolicyTaxesEnabled(policyID: string, taxesIDsToUpdate: string[], isEnabled: boolean) { 
        
               const policy = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`]; 
        
               const originalTaxes = {...policy?.taxRates?.taxes};

So, when we try to access the tax isDisabled here, it will crash.

App/src/libs/actions/TaxRate.ts

Line 256 in 48520ec

isDisabled: !!originalTaxes[taxID].isDisabled,

It's undefined because allPolicies is also undefined. This all happens after #53852. In #53852, we enable inlineRequires, so this top level code is not immediately evaluated when we named import it.

App/src/pages/workspace/taxes/WorkspaceTaxesPage.tsx

Line 31 in 48520ec

    
           import {clearTaxRateError, deletePolicyTaxes, setPolicyTaxesEnabled} from '@libs/actions/TaxRate';

App/src/libs/actions/TaxRate.ts

Lines 28 to 33 in 48520ec

    
           let allPolicies: OnyxCollection<Policy>; 
        
           Onyx.connect({ 
        
               key: ONYXKEYS.COLLECTION.POLICY, 
        
               waitForCollectionCallback: true, 
        
               callback: (value) => (allPolicies = value), 
        
           });

It will only be evaluated when the imported function is called (doc). But when setPolicyTaxesEnabled is called, the onyx callback hasn't completed yet.

App/src/libs/actions/TaxRate.ts

Lines 210 to 211 in 48520ec

    
           function setPolicyTaxesEnabled(policyID: string, taxesIDsToUpdate: string[], isEnabled: boolean) { 
        
               const policy = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`];

This is one of the pitfall described on the doc linked above.

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

We have a few options.

First, instead of relying the policy data from Onyx.connect, we can pass the policy from the component because it's already available anyway.

// policy instead of policyID
function setPolicyTaxesEnabled(policy: OnyxEntry<Policy>

// update all usages of policyID with policy.id

Then pass the policy from the component.

App/src/pages/workspace/taxes/WorkspaceTaxesPage.tsx

Line 121 in 48520ec

setPolicyTaxesEnabled(policyID, [taxID], value);

OR

We can disable inline requires in WorkspaceTaxesPage, but that means other import inline requires are also disabled.

OR

Import TaxRate without any module.

import '@libs/actions/TaxRate'

OR

Create a file that contains the common onyx connection such as policy, import it like above in App.tsx and TaxRate can get the all policies data from that file. or we can get the policy data from PolicyUtils

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

N/A

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

@parasharrajat

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

Fix crash when disabling tax rate #56994

If no regressions arise, payment will be issued on 2025-02-27. 🎊

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

@parasharrajat requires payment through NewDot Manual Requests
@bernhardoj requires payment through NewDot Manual Requests

@parasharrajat

@parasharrajat @abekkala @parasharrajat 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]

@bernhardoj

PAYMENT SUMMARY FOR FEB 27

Fix: @bernhardoj [$250, if no regressions] Payment via NewDot
PR Review: @parasharrajat [$250, if no regressions] Payment via NewDot
please complete checklist

@parasharrajat

Payment Summary

Upwork Job

Reviewer: @parasharrajat owed $250 via NewDot
Reviewer: @bernhardoj owed $250 via NewDot

BugZero Checklist (@abekkala)

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/1889364840283872581/hired)
I have paid out the Upwork contracts or cancelled the ones that are incorrect
I have verified the payment summary above is correct

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: Issue from migration

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: Fix cycle dependencies in metro console #53852 (comment)
[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: https://expensify.slack.com/archives/C01GTK53T8Q/p1739629404707799
[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.
[BugZero Assignee] Create a GH issue for creating/updating the regression test once above steps have been agreed upon.

Link to issue: https://github.com/Expensify/Expensify/issues/474914

Regression Test Proposal

Test:

Create a workspace if you don't have one
Open the workspace
Enable tax if it's not enabled yet
Open the tax page
Toggle one of the tax
Verify the page doesn't crash

Do we agree 👍 or 👎

Requested in ND.

@bernhardoj

posting again for better visibility for payee:

PAYMENT SUMMARY FOR FEB 27

Fix: @bernhardoj [$250] Payment via NewDot
PR Review: @parasharrajat [$250] Payment via NewDot

Thank you! 🎉

Payment requested as per #56158 (comment)

@parasharrajat

$250 approved for @parasharrajat

@bernhardoj

$250 approved for @bernhardoj

Navigation Menu

Repository navigation

[Due for payment 2025-02-27] [$250] Taxes - App crashes when trying to disable tax rate. #56158

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?

29 remaining items

PAYMENT SUMMARY FOR FEB 27

Payment Summary

BugZero Checklist (@abekkala)

BugZero Checklist:

Regression Test Proposal

Test:

PAYMENT SUMMARY FOR FEB 27

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	function setPolicyTaxesEnabled(policyID: string, taxesIDsToUpdate: string[], isEnabled: boolean) {
	const policy = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`];
	const originalTaxes = {...policy?.taxRates?.taxes};

	let allPolicies: OnyxCollection<Policy>;
	Onyx.connect({
	key: ONYXKEYS.COLLECTION.POLICY,
	waitForCollectionCallback: true,
	callback: (value) => (allPolicies = value),
	});

[Due for payment 2025-02-27] [$250] Taxes - App crashes when trying to disable tax rate. #56158

Description

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Activity

melvin-bot commented on Jan 31, 2025

nkdengineer commented on Feb 3, 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 4, 2025

melvin-bot commented on Feb 6, 2025

melvin-bot commented on Feb 10, 2025

bernhardoj commented on Feb 11, 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?

melvin-bot commented on Feb 11, 2025

29 remaining items

melvin-bot commented on Feb 20, 2025

melvin-bot commented on Feb 20, 2025

abekkala commented on Feb 20, 2025

PAYMENT SUMMARY FOR FEB 27

melvin-bot commented on Feb 27, 2025

Payment Summary

BugZero Checklist (@abekkala)

parasharrajat commented on Feb 27, 2025

BugZero Checklist:

Regression Test Proposal

Test:

bernhardoj commented on Feb 27, 2025

abekkala commented on Feb 27, 2025

PAYMENT SUMMARY FOR FEB 27

parasharrajat commented on Mar 1, 2025

JmillsExpensify commented on Mar 3, 2025

JmillsExpensify commented on Mar 3, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions