diff --git a/src/libs/TransactionUtils/index.ts b/src/libs/TransactionUtils/index.ts index a7d4a9d084ba..0bd20a153446 100644 --- a/src/libs/TransactionUtils/index.ts +++ b/src/libs/TransactionUtils/index.ts @@ -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({ @@ -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, }); onyxData.failureData?.push({ diff --git a/src/libs/actions/IOU/UpdateMoneyRequest.ts b/src/libs/actions/IOU/UpdateMoneyRequest.ts index e38eb67c73aa..e9c5677d32d5 100644 --- a/src/libs/actions/IOU/UpdateMoneyRequest.ts +++ b/src/libs/actions/IOU/UpdateMoneyRequest.ts @@ -922,7 +922,13 @@ function getUpdateMoneyRequestParams(params: GetUpdateMoneyRequestParamsType): U > > = []; const successData: Array< - OnyxUpdate + 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< diff --git a/tests/unit/TransactionTest.ts b/tests/unit/TransactionTest.ts index ecfc0699ba3e..b915b776f75e 100644 --- a/tests/unit/TransactionTest.ts +++ b/tests/unit/TransactionTest.ts @@ -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'; @@ -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 = {}; + 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 = {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 = {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 = {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 = {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 = {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 = { + 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(); + }); +});