diff --git a/src/libs/API/index.ts b/src/libs/API/index.ts index 92f23260cc19..8badd28edb3c 100644 --- a/src/libs/API/index.ts +++ b/src/libs/API/index.ts @@ -36,6 +36,8 @@ use(Pagination); // middlewares after this, because the SequentialQueue depends on the result of this middleware to pause the queue (if needed) to bring the app to an up-to-date state. use(SaveResponseInOnyx); +let requestIndex = 0; + type OnyxData = { optimisticData?: OnyxUpdate[]; successData?: OnyxUpdate[]; @@ -78,6 +80,7 @@ function prepareRequest( command, data, initiatedOffline: isOffline(), + requestID: requestIndex++, ...onyxDataWithoutOptimisticData, ...conflictResolver, }; diff --git a/src/libs/actions/Policy/Category.ts b/src/libs/actions/Policy/Category.ts index 5613209b9a0d..b7637c0caba3 100644 --- a/src/libs/actions/Policy/Category.ts +++ b/src/libs/actions/Policy/Category.ts @@ -30,6 +30,7 @@ import enhanceParameters from '@libs/Network/enhanceParameters'; import {hasEnabledOptions} from '@libs/OptionsListUtils'; import {getPolicy, goBackWhenEnableFeature} from '@libs/PolicyUtils'; import {getAllPolicyReports} from '@libs/ReportUtils'; +import {resolveEnableFeatureConflicts} from '@userActions/RequestConflictUtils'; import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import type {Policy, PolicyCategories, PolicyCategory, RecentlyUsedCategories, Report} from '@src/types/onyx'; @@ -1107,7 +1108,9 @@ function enablePolicyCategories(policyID: string, enabled: boolean, shouldGoBack const parameters: EnablePolicyCategoriesParams = {policyID, enabled}; - API.write(WRITE_COMMANDS.ENABLE_POLICY_CATEGORIES, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_CATEGORIES, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_CATEGORIES, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout() && shouldGoBack) { goBackWhenEnableFeature(policyID); diff --git a/src/libs/actions/Policy/DistanceRate.ts b/src/libs/actions/Policy/DistanceRate.ts index a56cc3d576e9..a9b00be5e646 100644 --- a/src/libs/actions/Policy/DistanceRate.ts +++ b/src/libs/actions/Policy/DistanceRate.ts @@ -15,6 +15,7 @@ import * as ErrorUtils from '@libs/ErrorUtils'; import getIsNarrowLayout from '@libs/getIsNarrowLayout'; import {getDistanceRateCustomUnit, goBackWhenEnableFeature, removePendingFieldsFromCustomUnit} from '@libs/PolicyUtils'; import * as ReportUtils from '@libs/ReportUtils'; +import {resolveEnableFeatureConflicts} from '@userActions/RequestConflictUtils'; import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import type {Policy, Report} from '@src/types/onyx'; @@ -163,7 +164,9 @@ function enablePolicyDistanceRates(policyID: string, enabled: boolean) { const parameters: EnablePolicyDistanceRatesParams = {policyID, enabled}; - API.write(WRITE_COMMANDS.ENABLE_POLICY_DISTANCE_RATES, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_DISTANCE_RATES, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_DISTANCE_RATES, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout()) { goBackWhenEnableFeature(policyID); diff --git a/src/libs/actions/Policy/Policy.ts b/src/libs/actions/Policy/Policy.ts index 23aa853e7183..b5f2e1ff3117 100644 --- a/src/libs/actions/Policy/Policy.ts +++ b/src/libs/actions/Policy/Policy.ts @@ -78,6 +78,7 @@ import * as ReportUtils from '@libs/ReportUtils'; import type {PolicySelector} from '@pages/home/sidebar/FloatingActionButtonAndPopover'; import * as PaymentMethods from '@userActions/PaymentMethods'; import * as PersistedRequests from '@userActions/PersistedRequests'; +import {resolveEnableFeatureConflicts} from '@userActions/RequestConflictUtils'; import type {OnboardingPurpose} from '@src/CONST'; import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; @@ -2859,7 +2860,9 @@ function enablePolicyConnections(policyID: string, enabled: boolean) { const parameters: EnablePolicyConnectionsParams = {policyID, enabled}; - API.write(WRITE_COMMANDS.ENABLE_POLICY_CONNECTIONS, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_CONNECTIONS, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_CONNECTIONS, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout()) { goBackWhenEnableFeature(policyID); @@ -2916,7 +2919,9 @@ function enableExpensifyCard(policyID: string, enabled: boolean, shouldNavigateT const parameters: EnablePolicyExpensifyCardsParams = {authToken, policyID, enabled}; - API.write(WRITE_COMMANDS.ENABLE_POLICY_EXPENSIFY_CARDS, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_EXPENSIFY_CARDS, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_EXPENSIFY_CARDS, persistedRequests, parameters), + }); if (enabled && shouldNavigateToExpensifyCardPage) { navigateToExpensifyCardPage(policyID); @@ -2971,7 +2976,9 @@ function enableCompanyCards(policyID: string, enabled: boolean, shouldGoBack = t const parameters: EnablePolicyCompanyCardsParams = {authToken, policyID, enabled}; - API.write(WRITE_COMMANDS.ENABLE_POLICY_COMPANY_CARDS, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_COMPANY_CARDS, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_COMPANY_CARDS, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout() && shouldGoBack) { goBackWhenEnableFeature(policyID); @@ -3019,7 +3026,9 @@ function enablePolicyReportFields(policyID: string, enabled: boolean, shouldGoBa const parameters: EnablePolicyReportFieldsParams = {policyID, enabled}; - API.write(WRITE_COMMANDS.ENABLE_POLICY_REPORT_FIELDS, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_REPORT_FIELDS, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_REPORT_FIELDS, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout() && shouldGoBack) { goBackWhenEnableFeature(policyID); @@ -3133,7 +3142,9 @@ function enablePolicyTaxes(policyID: string, enabled: boolean) { if (shouldAddDefaultTaxRatesData) { parameters.taxFields = JSON.stringify(defaultTaxRates); } - API.write(WRITE_COMMANDS.ENABLE_POLICY_TAXES, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_TAXES, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_TAXES, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout()) { goBackWhenEnableFeature(policyID); @@ -3233,7 +3244,9 @@ function enablePolicyWorkflows(policyID: string, enabled: boolean) { setWorkspaceAutoReportingFrequency(policyID, CONST.POLICY.AUTO_REPORTING_FREQUENCIES.INSTANT); } - API.write(WRITE_COMMANDS.ENABLE_POLICY_WORKFLOWS, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_WORKFLOWS, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_WORKFLOWS, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout()) { goBackWhenEnableFeature(policyID); @@ -3297,7 +3310,9 @@ function enablePolicyRules(policyID: string, enabled: boolean, shouldGoBack = tr }; const parameters: SetPolicyRulesEnabledParams = {policyID, enabled}; - API.write(WRITE_COMMANDS.SET_POLICY_RULES_ENABLED, parameters, onyxData); + API.write(WRITE_COMMANDS.SET_POLICY_RULES_ENABLED, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.SET_POLICY_RULES_ENABLED, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout() && shouldGoBack) { goBackWhenEnableFeature(policyID); @@ -3408,7 +3423,9 @@ function enablePolicyInvoicing(policyID: string, enabled: boolean) { const parameters: EnablePolicyInvoicingParams = {policyID, enabled}; - API.write(WRITE_COMMANDS.ENABLE_POLICY_INVOICING, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_INVOICING, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_INVOICING, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout()) { goBackWhenEnableFeature(policyID); diff --git a/src/libs/actions/Policy/Tag.ts b/src/libs/actions/Policy/Tag.ts index c22a5922d0dd..d792d9625b04 100644 --- a/src/libs/actions/Policy/Tag.ts +++ b/src/libs/actions/Policy/Tag.ts @@ -26,6 +26,7 @@ import {goBackWhenEnableFeature} from '@libs/PolicyUtils'; import * as ReportUtils from '@libs/ReportUtils'; import {getTagArrayFromName} from '@libs/TransactionUtils'; import type {PolicyTagList} from '@pages/workspace/tags/types'; +import {resolveEnableFeatureConflicts} from '@userActions/RequestConflictUtils'; import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import type {Policy, PolicyTag, PolicyTagLists, PolicyTags, RecentlyUsedTags, Report} from '@src/types/onyx'; @@ -689,7 +690,9 @@ function enablePolicyTags(policyID: string, enabled: boolean) { const parameters: EnablePolicyTagsParams = {policyID, enabled}; - API.write(WRITE_COMMANDS.ENABLE_POLICY_TAGS, parameters, onyxData); + API.write(WRITE_COMMANDS.ENABLE_POLICY_TAGS, parameters, onyxData, { + checkAndFixConflictingRequest: (persistedRequests) => resolveEnableFeatureConflicts(WRITE_COMMANDS.ENABLE_POLICY_TAGS, persistedRequests, parameters), + }); if (enabled && getIsNarrowLayout()) { goBackWhenEnableFeature(policyID); diff --git a/src/libs/actions/RequestConflictUtils.ts b/src/libs/actions/RequestConflictUtils.ts index 7e1092016e28..0fc423d84e61 100644 --- a/src/libs/actions/RequestConflictUtils.ts +++ b/src/libs/actions/RequestConflictUtils.ts @@ -1,7 +1,9 @@ import type {OnyxUpdate} from 'react-native-onyx'; import Onyx from 'react-native-onyx'; +import type {TupleToUnion} from 'type-fest'; import type {OpenReportParams, UpdateCommentParams} from '@libs/API/parameters'; import {WRITE_COMMANDS} from '@libs/API/types'; +import type {ApiRequestCommandParameters} from '@libs/API/types'; import ONYXKEYS from '@src/ONYXKEYS'; import type OnyxRequest from '@src/types/onyx/Request'; import type {ConflictActionData} from '@src/types/onyx/Request'; @@ -19,6 +21,22 @@ const commentsToBeDeleted = new Set([ WRITE_COMMANDS.REMOVE_EMOJI_REACTION, ]); +const enablePolicyFeatureCommand = [ + WRITE_COMMANDS.ENABLE_POLICY_DISTANCE_RATES, + WRITE_COMMANDS.ENABLE_POLICY_EXPENSIFY_CARDS, + WRITE_COMMANDS.ENABLE_POLICY_COMPANY_CARDS, + WRITE_COMMANDS.ENABLE_POLICY_CONNECTIONS, + WRITE_COMMANDS.ENABLE_POLICY_CATEGORIES, + WRITE_COMMANDS.ENABLE_POLICY_TAGS, + WRITE_COMMANDS.ENABLE_POLICY_TAXES, + WRITE_COMMANDS.ENABLE_POLICY_REPORT_FIELDS, + WRITE_COMMANDS.ENABLE_POLICY_WORKFLOWS, + WRITE_COMMANDS.SET_POLICY_RULES_ENABLED, + WRITE_COMMANDS.ENABLE_POLICY_INVOICING, +] as const; + +type EnablePolicyFeatureCommand = TupleToUnion; + function createUpdateCommentMatcher(reportActionID: string) { return function (request: OnyxRequest) { return request.command === WRITE_COMMANDS.UPDATE_COMMENT && request.data?.reportActionID === reportActionID; @@ -175,10 +193,38 @@ function resolveEditCommentWithNewAddCommentRequest(persistedRequests: OnyxReque } as ConflictActionData; } +function resolveEnableFeatureConflicts( + command: EnablePolicyFeatureCommand, + persistedRequests: OnyxRequest[], + parameters: ApiRequestCommandParameters[EnablePolicyFeatureCommand], +): ConflictActionData { + const deleteRequestIndex = persistedRequests.findIndex( + (request) => request.command === command && request.data?.policyID === parameters.policyID && request.data?.enabled !== parameters.enabled, + ); + + if (deleteRequestIndex === -1) { + return { + conflictAction: { + type: 'push', + }, + }; + } + + return { + conflictAction: { + type: 'delete', + indices: [deleteRequestIndex], + pushNewRequest: false, + }, + }; +} + export { resolveDuplicationConflictAction, resolveOpenReportDuplicationConflictAction, resolveCommentDeletionConflicts, resolveEditCommentWithNewAddCommentRequest, createUpdateCommentMatcher, + resolveEnableFeatureConflicts, + enablePolicyFeatureCommand, }; diff --git a/src/types/onyx/Request.ts b/src/types/onyx/Request.ts index ffbd7f858caa..b0dcc043a5bf 100644 --- a/src/types/onyx/Request.ts +++ b/src/types/onyx/Request.ts @@ -63,6 +63,9 @@ type RequestData = { * More info https://github.com/Expensify/App/issues/51761 */ initiatedOffline?: boolean; + + /** The unique ID of the request */ + requestID?: number; }; /** diff --git a/tests/unit/APITest.ts b/tests/unit/APITest.ts index 7c7182059bec..8cda88e64a15 100644 --- a/tests/unit/APITest.ts +++ b/tests/unit/APITest.ts @@ -581,6 +581,33 @@ describe('APITests', () => { }); }); + test('All write requests are in the queue should be called even some of them are the same', () => { + // Given offline state where all requests will eventualy succeed without issue + const xhr = jest.spyOn(HttpUtils, 'xhr').mockResolvedValue({jsonCode: CONST.JSON_CODE.SUCCESS}); + return Onyx.multiSet({ + [ONYXKEYS.SESSION]: {authToken: 'anyToken'}, + [ONYXKEYS.NETWORK]: {isOffline: true}, + [ONYXKEYS.CREDENTIALS]: {autoGeneratedLogin: 'test_user', autoGeneratedPassword: 'psswd'}, + }) + .then(() => { + // When we queue 3 persistable commands and two of them are the same + API.write('MockCommand' as WriteCommand, {content: 'value1'} as ApiRequestCommandParameters[WriteCommand]); + API.write('MockCommand' as WriteCommand, {content: 'value2'} as ApiRequestCommandParameters[WriteCommand]); + API.write('MockCommand' as WriteCommand, {content: 'value1'} as ApiRequestCommandParameters[WriteCommand]); + + return waitForBatchedUpdates(); + }) + .then(() => Onyx.set(ONYXKEYS.NETWORK, {isOffline: false})) + .then(waitForBatchedUpdates) + .then(() => { + // Then expect all 3 calls to have been made and for the Writes to be made in the order that we made them + expect(xhr.mock.calls.length).toBe(3); + expect(xhr.mock.calls.at(0)?.[1].content).toBe('value1'); + expect(xhr.mock.calls.at(1)?.[1].content).toBe('value2'); + expect(xhr.mock.calls.at(2)?.[1].content).toBe('value1'); + }); + }); + test('Read request should not stuck when SequentialQueue is paused and resumed', async () => { // Given 2 WRITE requests and 1 READ request where the first write request pauses the SequentialQueue const xhr = jest.spyOn(HttpUtils, 'xhr').mockResolvedValueOnce({previousUpdateID: 1}); diff --git a/tests/unit/PersistedRequests.ts b/tests/unit/PersistedRequests.ts index c488b36013ad..321b0af3ad41 100644 --- a/tests/unit/PersistedRequests.ts +++ b/tests/unit/PersistedRequests.ts @@ -9,6 +9,7 @@ const request: Request = { command: 'OpenReport', successData: [{key: 'reportMetadata_1', onyxMethod: 'merge', value: {}}], failureData: [{key: 'reportMetadata_2', onyxMethod: 'merge', value: {}}], + requestID: 1, }; beforeAll(() => @@ -52,6 +53,7 @@ describe('PersistedRequests', () => { command: 'AddComment', successData: [{key: 'reportMetadata_3', onyxMethod: 'merge', value: {}}], failureData: [{key: 'reportMetadata_4', onyxMethod: 'merge', value: {}}], + requestID: 2, }; PersistedRequests.save(request2); PersistedRequests.processNextRequest(); @@ -66,6 +68,7 @@ describe('PersistedRequests', () => { command: 'OpenReport', successData: [{key: 'reportMetadata_1', onyxMethod: 'set', value: {}}], failureData: [{key: 'reportMetadata_2', onyxMethod: 'set', value: {}}], + requestID: 3, }; PersistedRequests.update(0, newRequest); expect(PersistedRequests.getAll().at(0)).toEqual(newRequest); @@ -76,6 +79,7 @@ describe('PersistedRequests', () => { command: 'OpenReport', successData: [{key: 'reportMetadata_1', onyxMethod: 'set', value: {}}], failureData: [{key: 'reportMetadata_2', onyxMethod: 'set', value: {}}], + requestID: 4, }; PersistedRequests.updateOngoingRequest(newRequest); expect(PersistedRequests.getOngoingRequest()).toEqual(newRequest); diff --git a/tests/unit/RequestConflictUtilsTest.ts b/tests/unit/RequestConflictUtilsTest.ts index c290940289d8..1d8dac8a6fd1 100644 --- a/tests/unit/RequestConflictUtilsTest.ts +++ b/tests/unit/RequestConflictUtilsTest.ts @@ -1,5 +1,11 @@ import Onyx from 'react-native-onyx'; -import {resolveCommentDeletionConflicts, resolveDuplicationConflictAction, resolveEditCommentWithNewAddCommentRequest} from '@libs/actions/RequestConflictUtils'; +import { + enablePolicyFeatureCommand, + resolveCommentDeletionConflicts, + resolveDuplicationConflictAction, + resolveEditCommentWithNewAddCommentRequest, + resolveEnableFeatureConflicts, +} from '@libs/actions/RequestConflictUtils'; import type {WriteCommand} from '@libs/API/types'; describe('RequestConflictUtils', () => { @@ -134,4 +140,24 @@ describe('RequestConflictUtils', () => { }, }); }); + + it.each(enablePolicyFeatureCommand)('resolveEnableFeatureConflicts should return push when the same enable feature API is not found', (commandName) => { + const persistedRequests = [{command: commandName, data: {policyID: '1', enabled: true}}]; + const parameters = {policyID: '2', enabled: false}; + const result = resolveEnableFeatureConflicts(commandName, persistedRequests, parameters); + expect(result).toEqual({conflictAction: {type: 'push'}}); + }); + + it.each(enablePolicyFeatureCommand)('resolveEnableFeatureConflicts should return delete when the same enable feature API is found', (commandName) => { + const persistedRequests = [{command: commandName, data: {policyID: '1', enabled: true}}]; + const parameters = {policyID: '1', enabled: false}; + const result = resolveEnableFeatureConflicts(commandName, persistedRequests, parameters); + expect(result).toEqual({ + conflictAction: { + type: 'delete', + indices: [0], + pushNewRequest: false, + }, + }); + }); });