Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix violation shows optimistically for a partial transaction #39034

Merged
merged 11 commits into from
Apr 1, 2024
Merged

Fix violation shows optimistically for a partial transaction #39034

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d65a8f3
don't optimistically add the violation if it's a partial transaction
bernhardoj Mar 27, 2024
f9fc96d
move the partial transaciton check to getViolationsOnyxData
bernhardoj Mar 27, 2024
bdcdc47
null safety
bernhardoj Mar 27, 2024
39b8c46
add test
bernhardoj Mar 27, 2024
cd2dcc2
Merge branch 'main' into fix/38131-optimsitic-violation-for-partial-t…
bernhardoj Mar 28, 2024
2c9efa0
update partial merchant condition
bernhardoj Mar 28, 2024
3a5827f
fix test case
bernhardoj Mar 28, 2024
0612ffd
return current violation if it's a partial transaction
bernhardoj Mar 29, 2024
3b43ff6
Merge branch 'main' into fix/38131-optimsitic-violation-for-partial-t…
bernhardoj Mar 30, 2024
9e7f5b7
update test
bernhardoj Mar 30, 2024
37a9a6a
prettier
bernhardoj Mar 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/libs/Violations/ViolationsUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import reject from 'lodash/reject';
import Onyx from 'react-native-onyx';
import type {OnyxUpdate} from 'react-native-onyx';
import type {Phrase, PhraseParameters} from '@libs/Localize';
import * as TransactionUtils from '@libs/TransactionUtils';
import CONST from '@src/CONST';
import type {TranslationPaths} from '@src/languages/types';
import ONYXKEYS from '@src/ONYXKEYS';
Expand Down Expand Up @@ -119,7 +120,12 @@ const ViolationsUtils = {
policyTagList: PolicyTagList,
policyRequiresCategories: boolean,
policyCategories: PolicyCategories,
): OnyxUpdate {
): OnyxUpdate | null {
const isPartialTransaction = TransactionUtils.isPartialMerchant(TransactionUtils.getMerchant(updatedTransaction)) && TransactionUtils.isAmountMissing(updatedTransaction);
if (isPartialTransaction) {
return null;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move this logic under let newTransactionViolations = [...transactionViolations]; and return the following if the transaction is partial? I think if we do that we don't need any of the other changes and the logic is simpler

        return {
            onyxMethod: Onyx.METHOD.SET,
            key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${updatedTransaction.transactionID}`,
            value: newTransactionViolations,
        };

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's nice. Updated. Btw, do you think we can just return an empty array instead? Is it possible a transaction already has a violation while it's still a partial transaction?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shouldn't, but the effect should be the same, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's not possible then yes, the effect is the same.

}

let newTransactionViolations = [...transactionViolations];

// Calculate client-side category violations
Expand Down
43 changes: 23 additions & 20 deletions src/libs/actions/IOU.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1700,21 +1700,22 @@ function getUpdateMoneyRequestParams(

if (policy && PolicyUtils.isPaidGroupPolicy(policy) && updatedTransaction) {
const currentTransactionViolations = allTransactionViolations[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`] ?? [];
optimisticData.push(
ViolationsUtils.getViolationsOnyxData(
updatedTransaction,
currentTransactionViolations,
!!policy.requiresTag,
policyTagList ?? {},
!!policy.requiresCategory,
policyCategories ?? {},
),
const updatedViolationsOnyxData = ViolationsUtils.getViolationsOnyxData(
updatedTransaction,
currentTransactionViolations,
!!policy.requiresTag,
policyTagList ?? {},
!!policy.requiresCategory,
policyCategories ?? {},
);
failureData.push({
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`,
value: currentTransactionViolations,
});
if (updatedViolationsOnyxData) {
optimisticData.push(updatedViolationsOnyxData);
failureData.push({
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`,
value: currentTransactionViolations,
});
}
}

// Reset the transaction thread to its original state
Expand Down Expand Up @@ -3505,12 +3506,14 @@ function editRegularMoneyRequest(
!!policy.requiresCategory,
policyCategories,
);
optimisticData.push(updatedViolationsOnyxData);
failureData.push({
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`,
value: currentTransactionViolations,
});
if (updatedViolationsOnyxData) {
optimisticData.push(updatedViolationsOnyxData);
failureData.push({
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`,
value: currentTransactionViolations,
});
}
}

// STEP 6: Call the API endpoint
Expand Down
51 changes: 31 additions & 20 deletions tests/unit/ViolationUtilsTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {beforeEach} from '@jest/globals';
import Onyx from 'react-native-onyx';
import ViolationsUtils from '@libs/Violations/ViolationsUtils';
import CONST from '@src/CONST';
import ONYXKEYS from '@src/ONYXKEYS';
import type {PolicyCategories, PolicyTagList, Transaction, TransactionViolation} from '@src/types/onyx';

Expand Down Expand Up @@ -57,7 +58,17 @@ describe('getViolationsOnyxData', () => {
{name: 'receiptRequired', type: 'violation'},
];
const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).toEqual(expect.arrayContaining(transactionViolations));
expect(result?.value).toEqual(expect.arrayContaining(transactionViolations));
});

it('should not add violation when the transaction is partial', () => {
const partialTransaction = {...transaction, amount: 0, merchant: CONST.TRANSACTION.PARTIAL_TRANSACTION_MERCHANT};
transactionViolations = [
{name: 'duplicatedTransaction', type: 'violation'},
{name: 'receiptRequired', type: 'violation'},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use consts for this. I think we need to add one for duplicatedTransaction

Suggested change
{name: 'receiptRequired', type: 'violation'},
{name: CONST.VIOLATIONS.RECEIPT_REQUIRED, type: 'violation'},

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the test to not have an existing violation for partial transaction anymore

];
const result = ViolationsUtils.getViolationsOnyxData(partialTransaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result).toBeNull();
});

describe('policyRequiresCategories', () => {
Expand All @@ -70,18 +81,18 @@ describe('getViolationsOnyxData', () => {
it('should add missingCategory violation if no category is included', () => {
transaction.category = undefined;
const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).toEqual(expect.arrayContaining([missingCategoryViolation, ...transactionViolations]));
expect(result?.value).toEqual(expect.arrayContaining([missingCategoryViolation, ...transactionViolations]));
});

it('should add categoryOutOfPolicy violation when category is not in policy', () => {
transaction.category = 'Bananas';
const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).toEqual(expect.arrayContaining([categoryOutOfPolicyViolation, ...transactionViolations]));
expect(result?.value).toEqual(expect.arrayContaining([categoryOutOfPolicyViolation, ...transactionViolations]));
});

it('should not include a categoryOutOfPolicy violation when category is in policy', () => {
const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).not.toContainEqual(categoryOutOfPolicyViolation);
expect(result?.value).not.toContainEqual(categoryOutOfPolicyViolation);
});

it('should add categoryOutOfPolicy violation to existing violations if they exist', () => {
Expand All @@ -93,7 +104,7 @@ describe('getViolationsOnyxData', () => {

const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).toEqual(expect.arrayContaining([categoryOutOfPolicyViolation, ...transactionViolations]));
expect(result?.value).toEqual(expect.arrayContaining([categoryOutOfPolicyViolation, ...transactionViolations]));
});

it('should add missingCategory violation to existing violations if they exist', () => {
Expand All @@ -105,7 +116,7 @@ describe('getViolationsOnyxData', () => {

const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).toEqual(expect.arrayContaining([missingCategoryViolation, ...transactionViolations]));
expect(result?.value).toEqual(expect.arrayContaining([missingCategoryViolation, ...transactionViolations]));
});
});

Expand All @@ -117,8 +128,8 @@ describe('getViolationsOnyxData', () => {
it('should not add any violations when categories are not required', () => {
const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).not.toContainEqual([categoryOutOfPolicyViolation]);
expect(result.value).not.toContainEqual([missingCategoryViolation]);
expect(result?.value).not.toContainEqual([categoryOutOfPolicyViolation]);
expect(result?.value).not.toContainEqual([missingCategoryViolation]);
});
});

Expand All @@ -142,23 +153,23 @@ describe('getViolationsOnyxData', () => {
it("shouldn't update the transactionViolations if the policy requires tags and the transaction has a tag from the policy", () => {
const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).toEqual(transactionViolations);
expect(result?.value).toEqual(transactionViolations);
});

it('should add a missingTag violation if none is provided and policy requires tags', () => {
transaction.tag = undefined;

const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).toEqual(expect.arrayContaining([{...missingTagViolation}]));
expect(result?.value).toEqual(expect.arrayContaining([{...missingTagViolation}]));
});

it('should add a tagOutOfPolicy violation when policy requires tags and tag is not in the policy', () => {
policyTags = {};

const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).toEqual([]);
expect(result?.value).toEqual([]);
});

it('should add tagOutOfPolicy violation to existing violations if transaction has tag that is not in the policy', () => {
Expand All @@ -170,7 +181,7 @@ describe('getViolationsOnyxData', () => {

const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).toEqual(expect.arrayContaining([{...tagOutOfPolicyViolation}, ...transactionViolations]));
expect(result?.value).toEqual(expect.arrayContaining([{...tagOutOfPolicyViolation}, ...transactionViolations]));
});

it('should add missingTag violation to existing violations if transaction does not have a tag', () => {
Expand All @@ -182,7 +193,7 @@ describe('getViolationsOnyxData', () => {

const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).toEqual(expect.arrayContaining([{...missingTagViolation}, ...transactionViolations]));
expect(result?.value).toEqual(expect.arrayContaining([{...missingTagViolation}, ...transactionViolations]));
});
});

Expand All @@ -194,8 +205,8 @@ describe('getViolationsOnyxData', () => {
it('should not add any violations when tags are not required', () => {
const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);

expect(result.value).not.toContainEqual([tagOutOfPolicyViolation]);
expect(result.value).not.toContainEqual([missingTagViolation]);
expect(result?.value).not.toContainEqual([tagOutOfPolicyViolation]);
expect(result?.value).not.toContainEqual([missingTagViolation]);
});
});
describe('policy has multi level tags', () => {
Expand Down Expand Up @@ -248,31 +259,31 @@ describe('getViolationsOnyxData', () => {

// Test case where transaction has no tags
let result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).toEqual([someTagLevelsRequiredViolation]);
expect(result?.value).toEqual([someTagLevelsRequiredViolation]);

// Test case where transaction has 1 tag
transaction.tag = 'Accounting';
someTagLevelsRequiredViolation.data = {errorIndexes: [1, 2]};
result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).toEqual([someTagLevelsRequiredViolation]);
expect(result?.value).toEqual([someTagLevelsRequiredViolation]);

// Test case where transaction has 2 tags
transaction.tag = 'Accounting::Project1';
someTagLevelsRequiredViolation.data = {errorIndexes: [1]};
result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).toEqual([someTagLevelsRequiredViolation]);
expect(result?.value).toEqual([someTagLevelsRequiredViolation]);

// Test case where transaction has all tags
transaction.tag = 'Accounting:Africa:Project1';
result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).toEqual([]);
expect(result?.value).toEqual([]);
});
it('should return tagOutOfPolicy when a tag is not enabled in the policy but is set in the transaction', () => {
policyTags.Department.tags.Accounting.enabled = false;
transaction.tag = 'Accounting:Africa:Project1';
const result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
const violation = {...tagOutOfPolicyViolation, data: {tagName: 'Department'}};
expect(result.value).toEqual([violation]);
expect(result?.value).toEqual([violation]);
});
});
});
Loading