Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 13 additions & 2 deletions src/libs/TransactionUtils/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2324,7 +2324,7 @@ function removeTransactionFromDuplicateTransactionViolation(
continue;
}

const optimisticViolations = duplicateTransactionViolations.filter((violation) => violation.name !== CONST.VIOLATIONS.DUPLICATED_TRANSACTION);
const optimisticViolations = duplicateViolations.filter((violation) => violation.name !== CONST.VIOLATIONS.DUPLICATED_TRANSACTION);

if (duplicateTransactionIDs.length > 0) {
optimisticViolations.push({
Expand All @@ -2336,10 +2336,21 @@ function removeTransactionFromDuplicateTransactionViolation(
});
}

const cleanedValue = optimisticViolations.length > 0 ? optimisticViolations : null;

onyxData.optimisticData?.push({
onyxMethod: Onyx.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${duplicateID}`,
value: optimisticViolations.length > 0 ? optimisticViolations : null,
value: cleanedValue,
});

// Re-apply the cleaned violations on success so that stale data from a
// queued command (e.g. OpenReport resolving between optimistic apply and
// the server response) doesn't re-introduce one-sided duplicate violations.
onyxData.successData?.push({
onyxMethod: Onyx.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${duplicateID}`,
value: cleanedValue,
});
Comment thread
mountiny marked this conversation as resolved.
Resolved

onyxData.failureData?.push({
Expand Down
8 changes: 7 additions & 1 deletion src/libs/actions/IOU/UpdateMoneyRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -922,7 +922,13 @@ function getUpdateMoneyRequestParams(params: GetUpdateMoneyRequestParamsType): U
>
> = [];
const successData: Array<
OnyxUpdate<typeof ONYXKEYS.COLLECTION.TRANSACTION_DRAFT | typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS | typeof ONYXKEYS.COLLECTION.REPORT | typeof ONYXKEYS.COLLECTION.TRANSACTION>
OnyxUpdate<
| typeof ONYXKEYS.COLLECTION.TRANSACTION_DRAFT
| typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS
| typeof ONYXKEYS.COLLECTION.REPORT
| typeof ONYXKEYS.COLLECTION.TRANSACTION
| typeof ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS
>
> = [];
const failureData: Array<
OnyxUpdate<
Expand Down
136 changes: 136 additions & 0 deletions tests/unit/TransactionTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import ONYXKEYS from '@src/ONYXKEYS';
import type {TransactionViolation} from '@src/types/onyx';
import type {Attendee} from '@src/types/onyx/IOU';
import type {ReportCollectionDataSet} from '@src/types/onyx/Report';
import type {OnyxData} from '@src/types/onyx/Request';
import type {UpdateMoneyRequestDataKeys} from '../../src/libs/actions/IOU/UpdateMoneyRequest';
import * as TransactionUtils from '../../src/libs/TransactionUtils';
import type {PersonalDetails, PolicyTagLists, RecentWaypoint, Report, ReportAction, ReportActions, Transaction} from '../../src/types/onyx';
import createRandomPolicy from '../utils/collections/policies';
Expand Down Expand Up @@ -1875,3 +1877,137 @@ describe('Transaction', () => {
});
});
});

describe('removeTransactionFromDuplicateTransactionViolation', () => {
const TXN_A = 'txn_a';
const TXN_B = 'txn_b';

function makeDuplicateViolation(duplicates: string[]): TransactionViolation {
return {
name: CONST.VIOLATIONS.DUPLICATED_TRANSACTION,
type: CONST.VIOLATION_TYPES.VIOLATION,
data: {duplicates},
};
}

function makeCategoryViolation(): TransactionViolation {
return {
name: CONST.VIOLATIONS.MISSING_CATEGORY,
type: CONST.VIOLATION_TYPES.VIOLATION,
};
}

function makeTransactionCollection(...ids: string[]) {
const collection: Record<string, Transaction> = {};
for (const id of ids) {
collection[`${ONYXKEYS.COLLECTION.TRANSACTION}${id}`] = {transactionID: id} as Transaction;
}
return collection;
}

it('should push successData that re-applies cleaned partner violations', () => {
const onyxData: OnyxData<UpdateMoneyRequestDataKeys> = {optimisticData: [], successData: [], failureData: []};

const TXN_C = 'txn_c';
const transactionViolations = {
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_A}`]: [makeDuplicateViolation([TXN_B])],
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_B}`]: [makeDuplicateViolation([TXN_A, TXN_C])],
};

TransactionUtils.removeTransactionFromDuplicateTransactionViolation(onyxData, TXN_A, makeTransactionCollection(TXN_A, TXN_B, TXN_C), transactionViolations);

expect(onyxData.successData?.length).toBe(1);
const successEntry = onyxData.successData?.at(0);
expect(successEntry?.key).toBe(`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_B}`);
expect(successEntry?.value).toEqual([
{
...makeDuplicateViolation([TXN_A, TXN_C]),
data: {duplicates: [TXN_C]},
},
]);
});

it('should have matching optimistic and success data values', () => {
const onyxData: OnyxData<UpdateMoneyRequestDataKeys> = {optimisticData: [], successData: [], failureData: []};

const transactionViolations = {
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_A}`]: [makeDuplicateViolation([TXN_B])],
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_B}`]: [makeDuplicateViolation([TXN_A])],
};

TransactionUtils.removeTransactionFromDuplicateTransactionViolation(onyxData, TXN_A, makeTransactionCollection(TXN_A, TXN_B), transactionViolations);

expect(onyxData.optimisticData?.length).toBe(1);
expect(onyxData.successData?.length).toBe(1);

const optimisticEntry = onyxData.optimisticData?.at(0);
const successEntry = onyxData.successData?.at(0);
expect(optimisticEntry?.key).toBe(successEntry?.key);
expect(optimisticEntry?.value).toEqual(successEntry?.value);
});

it('should set successData value to null when removing the last duplicate reference', () => {
const onyxData: OnyxData<UpdateMoneyRequestDataKeys> = {optimisticData: [], successData: [], failureData: []};

const transactionViolations = {
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_A}`]: [makeDuplicateViolation([TXN_B])],
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_B}`]: [makeDuplicateViolation([TXN_A])],
};

TransactionUtils.removeTransactionFromDuplicateTransactionViolation(onyxData, TXN_A, makeTransactionCollection(TXN_A, TXN_B), transactionViolations);

const successEntry = onyxData.successData?.at(0);
expect(successEntry?.value).toBeNull();
});

it('should preserve failureData for rollback with original violations', () => {
const onyxData: OnyxData<UpdateMoneyRequestDataKeys> = {optimisticData: [], successData: [], failureData: []};

const originalBViolations = [makeDuplicateViolation([TXN_A]), makeCategoryViolation()];
const transactionViolations = {
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_A}`]: [makeDuplicateViolation([TXN_B])],
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_B}`]: originalBViolations,
};

TransactionUtils.removeTransactionFromDuplicateTransactionViolation(onyxData, TXN_A, makeTransactionCollection(TXN_A, TXN_B), transactionViolations);

expect(onyxData.failureData?.length).toBe(1);
const failureEntry = onyxData.failureData?.at(0);
expect(failureEntry?.key).toBe(`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_B}`);
expect(failureEntry?.value).toEqual(originalBViolations);
});

it('should preserve non-duplicate violations on partner when cleaning duplicate reference', () => {
const onyxData: OnyxData<UpdateMoneyRequestDataKeys> = {optimisticData: [], successData: [], failureData: []};

const transactionViolations = {
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_A}`]: [makeDuplicateViolation([TXN_B])],
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_B}`]: [makeDuplicateViolation([TXN_A]), makeCategoryViolation()],
};

TransactionUtils.removeTransactionFromDuplicateTransactionViolation(onyxData, TXN_A, makeTransactionCollection(TXN_A, TXN_B), transactionViolations);

const successEntry = onyxData.successData?.at(0);
expect(successEntry?.value).toEqual([makeCategoryViolation()]);

const optimisticEntry = onyxData.optimisticData?.at(0);
expect(optimisticEntry?.value).toEqual([makeCategoryViolation()]);
});

it('should not push any data when successData array is undefined', () => {
const onyxData: OnyxData<UpdateMoneyRequestDataKeys> = {
optimisticData: [],
failureData: [],
};

const transactionViolations = {
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_A}`]: [makeDuplicateViolation([TXN_B])],
[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${TXN_B}`]: [makeDuplicateViolation([TXN_A])],
};

TransactionUtils.removeTransactionFromDuplicateTransactionViolation(onyxData, TXN_A, makeTransactionCollection(TXN_A, TXN_B), transactionViolations);

expect(onyxData.optimisticData?.length).toBe(1);
expect(onyxData.successData).toBeUndefined();
});
});
Loading