Merge pull request #94889 from software-mansion-labs/merge-hr/daily-sync-limit

cristipaval · web-flow · commit 5b52fc0257a9 · 2026-07-10T15:31:10.000+03:00
[HR Import] Handle Merge daily sync limit error with popup
diff --git a/src/CONST/index.ts b/src/CONST/index.ts
@@ -3043,6 +3043,12 @@ const CONST = {
             AUTO: 'auto',
             WEBHOOK: 'webhook',
         },
+
+        /** Maximum number of manual syncs ("Sync now") allowed within the rolling window */
+        MANUAL_SYNC_LIMIT: 2,
+
+        /** Rolling window (in milliseconds) over which manual syncs are counted against MANUAL_SYNC_LIMIT (24 hours) */
+        MANUAL_SYNC_WINDOW_MS: 24 * 60 * 60 * 1000,
     },
 
     QUICKBOOKS_REIMBURSABLE_ACCOUNT_TYPE: {
diff --git a/src/languages/de.ts b/src/languages/de.ts
@@ -7945,6 +7945,7 @@ Fügen Sie weitere Ausgabelimits hinzu, um den Cashflow Ihres Unternehmens zu sc
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>Verbunden. ${setupLink ? `<a href="${setupLink}">Einrichtung abschließen</a>` : 'Einrichtung abschließen'} zum Importieren von Mitarbeitenden.</muted-text-label>`,
                 groups: {title: 'Gruppen', description: 'Wählen Sie die Mitarbeitergruppen aus, die Sie mit diesem Workspace synchronisieren möchten'},
+                syncLimitReached: {title: 'Versuchen Sie es morgen noch einmal', prompt: 'Sie haben Ihr Synchronisierungslimit für heute erreicht.'},
             },
             notSync: 'Nicht synchronisiert',
             authenticationError: (providerName: string) => `Verbindung mit ${providerName} aufgrund einer abgelaufenen Verknüpfung nicht möglich.`,
diff --git a/src/languages/en.ts b/src/languages/en.ts
@@ -7079,6 +7079,10 @@ const translations = {
                     title: 'Groups',
                     description: 'Choose the groups of employees you would like to sync with this workspace',
                 },
+                syncLimitReached: {
+                    title: 'Try again tomorrow',
+                    prompt: "You've reached your sync limit for the day.",
+                },
             },
         },
         export: {
diff --git a/src/languages/es.ts b/src/languages/es.ts
@@ -6810,6 +6810,7 @@ El plan Controlar empieza en 9 $ por miembro activo al mes.`,
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>Conectado. ${setupLink ? `<a href="${setupLink}">Completa la configuración</a>` : 'Completar configuración'} para importar empleados.</muted-text-label>`,
                 groups: {title: 'Grupos', description: 'Elige los grupos de empleados que te gustaría sincronizar con este espacio de trabajo'},
+                syncLimitReached: {title: 'Inténtalo de nuevo mañana', prompt: 'Has alcanzado tu límite de sincronización de hoy.'},
             },
             notSync: 'No sincronizado',
             authenticationError: (providerName: string) => `No se puede conectar a ${providerName} porque la conexión ha caducado.`,
diff --git a/src/languages/fr.ts b/src/languages/fr.ts
@@ -7980,6 +7980,7 @@ Ajoutez davantage de règles de dépenses pour protéger la trésorerie de l’e
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>Connecté. ${setupLink ? `<a href="${setupLink}">Terminer la configuration</a>` : 'Terminer la configuration'} pour importer les employés.</muted-text-label>`,
                 groups: {title: 'Groupes', description: 'Choisissez les groupes d’employés que vous souhaitez synchroniser avec cet espace de travail'},
+                syncLimitReached: {title: 'Réessayez demain', prompt: "Vous avez atteint votre limite de synchronisation pour aujourd'hui."},
             },
             notSync: 'Non synchronisé',
             authenticationError: (providerName: string) => `Connexion à ${providerName} impossible en raison d'une connexion expirée.`,
diff --git a/src/languages/it.ts b/src/languages/it.ts
@@ -7928,6 +7928,7 @@ Aggiungi altre regole di spesa per proteggere il flusso di cassa aziendale.`,
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>Connesso. ${setupLink ? `<a href="${setupLink}">Completa la configurazione</a>` : 'Completa configurazione'} per importare i dipendenti.</muted-text-label>`,
                 groups: {title: 'Gruppi', description: 'Scegli i gruppi di dipendenti che vuoi sincronizzare con questo spazio di lavoro'},
+                syncLimitReached: {title: 'Riprova domani', prompt: 'Hai raggiunto il limite di sincronizzazioni per oggi.'},
             },
             notSync: 'Non sincronizzato',
             authenticationError: (providerName: string) => `Impossibile connettersi a ${providerName} a causa di una connessione scaduta.`,
diff --git a/src/languages/ja.ts b/src/languages/ja.ts
@@ -7824,6 +7824,7 @@ ${reportName}`,
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>接続されました。従業員をインポートするには ${setupLink ? `<a href="${setupLink}">セットアップを完了</a>` : '設定を完了'} に接続してください。</muted-text-label>`,
                 groups: {title: 'グループ', description: 'このワークスペースと同期したい従業員グループを選択してください'},
+                syncLimitReached: {title: '明日もう一度お試しください', prompt: '本日の同期上限に達しました。'},
             },
             notSync: '未同期',
             authenticationError: (providerName: string) => `有効期限が切れた接続のため、${providerName} に接続できません。`,
diff --git a/src/languages/nl.ts b/src/languages/nl.ts
@@ -7906,6 +7906,7 @@ er bestedingsregels toe om de kasstroom van het bedrijf te beschermen.`,
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>Verbonden. ${setupLink ? `<a href="${setupLink}">Instellen voltooien</a>` : 'Configuratie voltooien'} om werknemers te importeren.</muted-text-label>`,
                 groups: {title: 'Groepen', description: 'Kies de groepen werknemers die je met deze workspace wilt synchroniseren'},
+                syncLimitReached: {title: 'Probeer het morgen opnieuw', prompt: 'Je hebt je synchronisatielimiet voor vandaag bereikt.'},
             },
             notSync: 'Niet gesynchroniseerd',
             authenticationError: (providerName: string) => `Kan geen verbinding maken met ${providerName} vanwege een verlopen koppeling.`,
diff --git a/src/languages/pl.ts b/src/languages/pl.ts
@@ -7885,6 +7885,7 @@ Dodaj więcej zasad wydatków, żeby chronić płynność finansową firmy.`,
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>Połączono. ${setupLink ? `<a href="${setupLink}">Zakończ konfigurację</a>` : 'Zakończ konfigurację'}, aby zaimportować pracowników.</muted-text-label>`,
                 groups: {title: 'Grupy', description: 'Wybierz grupy pracowników, które chcesz zsynchronizować z tą przestrzenią roboczą'},
+                syncLimitReached: {title: 'Spróbuj ponownie jutro', prompt: 'Osiągnąłeś dzienny limit synchronizacji.'},
             },
             notSync: 'Niesynchronizowane',
             authenticationError: (providerName: string) => `Nie można połączyć z ${providerName} z powodu wygasłego połączenia.`,
diff --git a/src/languages/pt-BR.ts b/src/languages/pt-BR.ts
@@ -7898,6 +7898,7 @@ Adicione mais regras de gasto para proteger o fluxo de caixa da empresa.`,
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>Conectado. ${setupLink ? `<a href="${setupLink}">Concluir configuração</a>` : 'Concluir configuração'} para importar funcionários.</muted-text-label>`,
                 groups: {title: 'Grupos', description: 'Escolha os grupos de funcionários que você gostaria de sincronizar com este workspace'},
+                syncLimitReached: {title: 'Tente novamente amanhã', prompt: 'Você atingiu o limite de sincronizações de hoje.'},
             },
             notSync: 'Não sincronizado',
             authenticationError: (providerName: string) => `Não é possível conectar a ${providerName} devido a uma conexão expirada.`,
diff --git a/src/languages/zh-hans.ts b/src/languages/zh-hans.ts
@@ -7665,6 +7665,7 @@ ${reportName}`,
                 setupIncomplete: (setupLink: string | undefined) =>
                     `<muted-text-label>已连接。${setupLink ? `<a href="${setupLink}">完成设置</a>` : '完成设置'} 用于导入员工。</muted-text-label>`,
                 groups: {title: '群组', description: '选择要与此工作区同步的员工分组'},
+                syncLimitReached: {title: '请明天再试', prompt: '您已达到今日的同步上限。'},
             },
             notSync: '未同步',
             authenticationError: (providerName: string) => `由于连接已过期，无法连接到 ${providerName}。`,
diff --git a/src/libs/HRUtils.ts b/src/libs/HRUtils.ts
@@ -1,3 +1,7 @@
+import type {LocaleContextProps} from '@components/LocaleContextProvider';
+
+import type useConfirmModal from '@hooks/useConfirmModal';
+
 import CONST from '@src/CONST';
 import MERGE_HR_PROVIDERS from '@src/CONST/MERGE_HR_PROVIDERS';
 import type {MergeHRProviderSlug} from '@src/CONST/MERGE_HR_PROVIDERS';
@@ -7,6 +11,7 @@ import type {OnyxEntry} from 'react-native-onyx';
 import type {TupleToUnion, ValueOf} from 'type-fest';
 
 import {hasSynchronizationErrorMessage} from './actions/connections';
+import DateUtils from './DateUtils';
 
 type HRConnectionName = TupleToUnion<typeof CONST.POLICY.CONNECTIONS.HR_CONNECTION_NAMES>;
 
@@ -50,6 +55,44 @@ function isMergeHRCompleteSetupNeeded(policy?: OnyxEntry<Policy>): boolean {
     return syncDone && hasGroups && !setupComplete;
 }
 
+/**
+ * Returns true when the user has already manually synced ("Sync now") the Merge HR connection the maximum number of
+ * times within the rolling window (e.g. 2 times in the last 24 hours).
+ */
+function isMergeHRManualSyncLimitReached(policy?: OnyxEntry<Policy>): boolean {
+    const manualSyncTimestamps = policy?.connections?.merge_hris?.lastSync?.manualSyncTimestamps;
+    if (!manualSyncTimestamps?.length) {
+        return false;
+    }
+
+    const windowStart = DateUtils.subtractMillisecondsFromDateTime(DateUtils.getDBTime(), CONST.MERGE_HR.MANUAL_SYNC_WINDOW_MS);
+    const syncsWithinWindow = manualSyncTimestamps.filter((timestamp) => timestamp > windowStart).length;
+    return syncsWithinWindow >= CONST.MERGE_HR.MANUAL_SYNC_LIMIT;
+}
+
+/**
+ * When a Merge HR manual sync is blocked because the daily limit has been reached,
+ * shows a confirm modal and returns `true`. Returns `false` when the sync is allowed.
+ */
+function showMergeHRManualSyncLimitModalIfReached(
+    policy: OnyxEntry<Policy>,
+    connectionName: HRConnectionName,
+    translate: LocaleContextProps['translate'],
+    showConfirmModal: ReturnType<typeof useConfirmModal>['showConfirmModal'],
+): boolean {
+    if (connectionName !== CONST.POLICY.CONNECTIONS.NAME.MERGE_HR || !isMergeHRManualSyncLimitReached(policy)) {
+        return false;
+    }
+
+    showConfirmModal({
+        title: translate('workspace.hr.mergeHR.syncLimitReached.title'),
+        prompt: translate('workspace.hr.mergeHR.syncLimitReached.prompt'),
+        confirmText: translate('common.buttonConfirm'),
+        shouldShowCancelButton: false,
+    });
+    return true;
+}
+
 /** Returns display info for the HR provider currently connected to the policy (Gusto, Zenefits, or Merge HR), or null if none are connected. */
 function getConnectedHRProvider(policy?: OnyxEntry<Policy>): HRProviderInfo | null {
     if (isGustoConnected(policy)) {
@@ -200,8 +243,10 @@ export {
     isHRAdvancedMode,
     isMergeHRCompleteSetupNeeded,
     isMergeHRConnected,
+    isMergeHRManualSyncLimitReached,
     isZenefitsConnected,
     shouldShowHRConnectionError,
+    showMergeHRManualSyncLimitModalIfReached,
 };
 
 export type {HRConnectionName};
diff --git a/src/libs/actions/connections/MergeHR.ts b/src/libs/actions/connections/MergeHR.ts
@@ -2,6 +2,7 @@ import {write} from '@libs/API';
 import type {ConnectPolicyToMergeParams} from '@libs/API/parameters';
 import {READ_COMMANDS, WRITE_COMMANDS} from '@libs/API/types';
 import {getCommandURL} from '@libs/ApiUtils';
+import DateUtils from '@libs/DateUtils';
 import {getMicroSecondOnyxErrorWithTranslationKey} from '@libs/ErrorUtils';
 
 import CONST from '@src/CONST';
@@ -40,11 +41,11 @@ function syncMergeHR(policy: OnyxEntry<Policy>) {
             key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
             value: {
                 connections: {
-                    // eslint-disable-next-line @typescript-eslint/naming-convention -- merge_hris is the API-defined connection key
-                    merge_hris: {
+                    [CONST.POLICY.CONNECTIONS.NAME.MERGE_HR]: {
                         lastSync: {
                             syncStatus: CONST.MERGE_HR.SYNC_STATUS.SYNCING,
                             syncType: CONST.MERGE_HR.SYNC_TYPE.MANUAL,
+                            manualSyncTimestamps: [DateUtils.getDBTime(), ...(previousLastSync?.manualSyncTimestamps ?? [])],
                         },
                     },
                 },
@@ -58,9 +59,12 @@ function syncMergeHR(policy: OnyxEntry<Policy>) {
             key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
             value: {
                 connections: {
-                    // eslint-disable-next-line @typescript-eslint/naming-convention -- merge_hris is the API-defined connection key
-                    merge_hris: {
-                        lastSync: previousLastSync ?? null,
+                    [CONST.POLICY.CONNECTIONS.NAME.MERGE_HR]: {
+                        lastSync: {
+                            syncStatus: CONST.MERGE_HR.SYNC_STATUS.FAILED,
+                            errorMessage: null,
+                            manualSyncTimestamps: previousLastSync?.manualSyncTimestamps ?? null,
+                        },
                     },
                 },
             },
diff --git a/src/pages/workspace/WorkspaceMembersPage.tsx b/src/pages/workspace/WorkspaceMembersPage.tsx
@@ -43,7 +43,7 @@ import {
 } from '@libs/actions/Policy/Member';
 import {removeApprovalWorkflow as removeApprovalWorkflowAction, updateApprovalWorkflow} from '@libs/actions/Workflow';
 import {getLatestErrorMessageField} from '@libs/ErrorUtils';
-import {getConnectedHRProvider} from '@libs/HRUtils';
+import {getConnectedHRProvider, showMergeHRManualSyncLimitModalIfReached} from '@libs/HRUtils';
 import Log from '@libs/Log';
 import createDynamicRoute from '@libs/Navigation/helpers/dynamicRoutesUtils/createDynamicRoute';
 import Navigation from '@libs/Navigation/Navigation';
@@ -674,6 +674,10 @@ function WorkspaceMembersPage({personalDetails, route, policy}: WorkspaceMembers
                         return;
                     }
 
+                    if (showMergeHRManualSyncLimitModalIfReached(policy, hrProvider.connectionName, translate, showConfirmModal)) {
+                        return;
+                    }
+
                     close(() => syncConnection(policy, hrProvider.connectionName));
                 },
                 value: CONST.POLICY.SECONDARY_ACTIONS.SYNC_WITH_HR,
@@ -693,6 +697,7 @@ function WorkspaceMembersPage({personalDetails, route, policy}: WorkspaceMembers
         policyID,
         showLockedAccountModal,
         showRequiresInternetModal,
+        showConfirmModal,
         isHRSyncInProgress,
         policy,
     ]);
diff --git a/src/pages/workspace/hr/HRProviderCard.tsx b/src/pages/workspace/hr/HRProviderCard.tsx
@@ -18,6 +18,7 @@ import useThemeStyles from '@hooks/useThemeStyles';
 
 import {removePolicyConnection, syncConnection} from '@libs/actions/connections';
 import {clearHRConnectionErrorField} from '@libs/actions/connections/MergeHR';
+import {showMergeHRManualSyncLimitModalIfReached} from '@libs/HRUtils';
 import Navigation from '@libs/Navigation/Navigation';
 
 import CONST from '@src/CONST';
@@ -115,8 +116,14 @@ function HRProviderCard({card, policy, handleConnect, canWriteMoreFeatures, show
         return {
             icon: icons.Sync,
             text: translate('workspace.hr.syncNow'),
-            onSelected: () => syncConnection(policy, card.connectionName),
+            onSelected: () => {
+                if (showMergeHRManualSyncLimitModalIfReached(policy, card.connectionName, translate, showConfirmModal)) {
+                    return;
+                }
+                syncConnection(policy, card.connectionName);
+            },
             disabled: isOffline,
+            shouldCallAfterModalHide: true,
         };
     };
 
diff --git a/src/types/onyx/Policy.ts b/src/types/onyx/Policy.ts
@@ -321,6 +321,9 @@ type MergeHRConnectionLastSync = ConnectionLastSync & {
 
     /** Status of the sync */
     syncStatus?: ValueOf<typeof CONST.MERGE_HR.SYNC_STATUS>;
+
+    /** Timestamps of the last few manual ("Sync now") syncs, used for blocking manual syncs client-side once the daily limit is reached */
+    manualSyncTimestamps?: string[];
 };
 
 /**
diff --git a/tests/unit/HrUtilsTest.ts b/tests/unit/HrUtilsTest.ts
@@ -8,6 +8,7 @@ import {
     isAnyHRReadOnlyWorkflowMode,
     isMergeHRCompleteSetupNeeded,
     isMergeHRConnected,
+    isMergeHRManualSyncLimitReached,
     shouldShowHRConnectionError,
 } from '@libs/HRUtils';
 
@@ -103,6 +104,7 @@ function makeMergeHRConnection({
             ...makeLastSync(lastSync),
             syncStatus: lastSync?.syncStatus,
             syncType: lastSync?.syncType,
+            manualSyncTimestamps: lastSync?.manualSyncTimestamps,
         },
     };
 }
@@ -467,6 +469,44 @@ describe('HRUtils', () => {
             expect(shouldShowHRConnectionError(policy, true, true)).toBe(false);
         });
     });
+
+    describe('isMergeHRManualSyncLimitReached', () => {
+        const dbTimeHoursAgo = (hoursAgo: number) => new Date(Date.now() - hoursAgo * 60 * 60 * 1000).toISOString().replace('T', ' ').slice(0, 19);
+
+        const makeMergePolicyWithSyncTimestamps = (manualSyncTimestamps?: string[]) =>
+            makePolicy({
+                connections: {[MERGE_HR]: makeMergeHRConnection({config: {integration: 'workday'}, lastSync: {manualSyncTimestamps}})},
+            });
+
+        it('returns false for undefined policy', () => {
+            expect(isMergeHRManualSyncLimitReached(undefined)).toBe(false);
+        });
+
+        it('returns false when there is no merge_hris connection', () => {
+            expect(isMergeHRManualSyncLimitReached(makePolicy())).toBe(false);
+        });
+
+        it('returns false when there are no manual sync timestamps', () => {
+            expect(isMergeHRManualSyncLimitReached(makeMergePolicyWithSyncTimestamps(undefined))).toBe(false);
+            expect(isMergeHRManualSyncLimitReached(makeMergePolicyWithSyncTimestamps([]))).toBe(false);
+        });
+
+        it('returns false when only one sync happened within the last 24 hours', () => {
+            expect(isMergeHRManualSyncLimitReached(makeMergePolicyWithSyncTimestamps([dbTimeHoursAgo(1)]))).toBe(false);
+        });
+
+        it('returns false when both syncs are older than 24 hours', () => {
+            expect(isMergeHRManualSyncLimitReached(makeMergePolicyWithSyncTimestamps([dbTimeHoursAgo(25), dbTimeHoursAgo(48)]))).toBe(false);
+        });
+
+        it('returns false when only one of the two syncs falls within the window', () => {
+            expect(isMergeHRManualSyncLimitReached(makeMergePolicyWithSyncTimestamps([dbTimeHoursAgo(2), dbTimeHoursAgo(30)]))).toBe(false);
+        });
+
+        it('returns true when two syncs happened within the last 24 hours', () => {
+            expect(isMergeHRManualSyncLimitReached(makeMergePolicyWithSyncTimestamps([dbTimeHoursAgo(1), dbTimeHoursAgo(10)]))).toBe(true);
+        });
+    });
 });
 
 describe('getHRCardState', () => {
