Generalize seed-full-reconnect helper across Onyx clear flows

Author: TMisiukiewicz

src/libs/actions/App.ts

@@ -25,6 +25,7 @@ import ROUTES from '@src/ROUTES';
 import type * as OnyxTypes from '@src/types/onyx';
 import type Locale from '@src/types/onyx/Locale';
 import type {OnyxData} from '@src/types/onyx/Request';
+import clearOnyxAndSeedFullReconnect from './clearOnyxAndSeedFullReconnect';
 import {setShouldForceOffline} from './Network';
 import {getAll, rollbackOngoingRequest, save} from './PersistedRequests';
 import {createDraftInitialWorkspace, createWorkspace, generateDefaultWorkspaceName, generatePolicyID} from './Policy/Policy';
@@ -849,7 +850,9 @@ function clearOnyxAndResetApp(shouldNavigateToHomepage?: boolean) {
     const sequentialQueue = getAll();
 
     Navigation.clearPreloadedRoutes();
-    const resetPromise = Onyx.clear(KEYS_TO_PRESERVE)
+    // Seed LAST_FULL_RECONNECT_TIME so subscribeToFullReconnect doesn't fire a duplicate
+    // ReconnectApp once the openApp() below lands NVP_RECONNECT_APP_IF_FULL_RECONNECT_BEFORE.
+    const resetPromise = clearOnyxAndSeedFullReconnect(KEYS_TO_PRESERVE)
         .then(() => {
             // Network key is preserved, so when exiting imported state, we should:
             // 1. Stop forcing offline mode so the app can reconnect

src/libs/actions/Delegate.ts

@@ -4,7 +4,6 @@ import type {OnyxEntry, OnyxKey, OnyxUpdate} from 'react-native-onyx';
 import * as API from '@libs/API';
 import type {AddDelegateParams as APIAddDelegateParams, RemoveDelegateParams as APIRemoveDelegateParams, UpdateDelegateRoleParams as APIUpdateDelegateRoleParams} from '@libs/API/parameters';
 import {READ_COMMANDS, SIDE_EFFECT_REQUEST_COMMANDS, WRITE_COMMANDS} from '@libs/API/types';
-import DateUtils from '@libs/DateUtils';
 import * as ErrorUtils from '@libs/ErrorUtils';
 import Log from '@libs/Log';
 import {clearPreservedSearchNavigatorStates} from '@libs/Navigation/AppNavigator/createSplitNavigator/usePreserveNavigatorState';
@@ -18,6 +17,7 @@ import type Credentials from '@src/types/onyx/Credentials';
 import type Response from '@src/types/onyx/Response';
 import type Session from '@src/types/onyx/Session';
 import {confirmReadyToOpenApp, openApp} from './App';
+import clearOnyxAndSeedFullReconnect from './clearOnyxAndSeedFullReconnect';
 import updateSessionAuthTokens from './Session/updateSessionAuthTokens';
 import updateSessionUser from './Session/updateSessionUser';
 
@@ -43,25 +43,17 @@ const KEYS_TO_PRESERVE_DELEGATE_ACCESS = [
 ];
 
 /**
- * Atomically reset Onyx for a delegate-access transition while seeding two values that
- * subscribers would otherwise misinterpret on the post-clear state and double up calls
- * the caller is about to make explicitly:
+ * Atomically reset Onyx for a delegate-access transition. The IS_LOADING_APP=true
+ * seed is delegate-specific: without it, consumers observe HAS_LOADED_APP=true and
+ * IS_LOADING_APP=undefined together, which looks like a stuck app and triggers
+ * DelegateAccessHandler's recovery effect, queueing a duplicate openApp.
  *
- * - IS_LOADING_APP=true: without it, consumers observe HAS_LOADED_APP=true and
- *   IS_LOADING_APP=undefined together, which looks like a stuck app and triggers
- *   DelegateAccessHandler's recovery effect, queueing a duplicate openApp.
- * - LAST_FULL_RECONNECT_TIME=now: subscribeToFullReconnect compares this against the
- *   server-supplied NVP_RECONNECT_APP_IF_FULL_RECONNECT_BEFORE that lands in OpenApp's
- *   response.onyxData. Because applyHTTPSOnyxUpdates applies response.onyxData before
- *   successData, the timestamp would still be empty when the comparison runs, falsely
- *   triggering a duplicate ReconnectApp. Seeding to `now` short-circuits the subscriber
- *   until OpenApp's successData refreshes it.
+ * The reconnect-time seed is handled by clearOnyxAndSeedFullReconnect.
  */
 function clearOnyxForDelegateTransition(): Promise<void> {
-    return Onyx.multiSet({
+    return clearOnyxAndSeedFullReconnect(KEYS_TO_PRESERVE_DELEGATE_ACCESS, {
         [ONYXKEYS.IS_LOADING_APP]: true,
-        [ONYXKEYS.LAST_FULL_RECONNECT_TIME]: DateUtils.getDBTime(),
-    }).then(() => Onyx.clear([...KEYS_TO_PRESERVE_DELEGATE_ACCESS, ONYXKEYS.IS_LOADING_APP, ONYXKEYS.LAST_FULL_RECONNECT_TIME]));
+    });
 }
 
 type WithDelegatedAccess = {

src/libs/actions/Session/index.ts

@@ -51,6 +51,7 @@ import Timers from '@libs/Timers';
 import {hideContextMenu} from '@pages/inbox/report/ContextMenu/ReportActionContextMenu';
 import {confirmReadyToOpenApp, KEYS_TO_PRESERVE, openApp} from '@userActions/App';
 import {clearCachedAttachments} from '@userActions/Attachment';
+import clearOnyxAndSeedFullReconnect from '@userActions/clearOnyxAndSeedFullReconnect';
 import {clearOnyxForDelegateTransition} from '@userActions/Delegate';
 import * as Device from '@userActions/Device';
 import type HybridAppSettings from '@userActions/HybridApp/types';
@@ -448,7 +449,9 @@ function signOutAndRedirectToSignIn(shouldResetToHome?: boolean, shouldStashSess
                 });
             } else if (shouldRestoreStashedSession && !shouldStashSession && hasStashedSession(stashedSession, stashedCredentials)) {
                 // Preserve SESSION during clear to avoid a login page flash, then restore the stashed session.
-                Onyx.clear(KEYS_TO_PRESERVE_SUPPORTAL).then(() => {
+                // Seed LAST_FULL_RECONNECT_TIME so subscribeToFullReconnect doesn't fire a duplicate
+                // ReconnectApp once the openApp() below lands NVP_RECONNECT_APP_IF_FULL_RECONNECT_BEFORE.
+                clearOnyxAndSeedFullReconnect(KEYS_TO_PRESERVE_SUPPORTAL).then(() => {
                     Onyx.multiSet(onyxSetParams).then(() => {
                         Onyx.set(ONYXKEYS.STASHED_CREDENTIALS, {});
                         Onyx.set(ONYXKEYS.STASHED_SESSION, {});

src/libs/actions/clearOnyxAndSeedFullReconnect.ts

@@ -0,0 +1,27 @@
+import Onyx from 'react-native-onyx';
+import type {OnyxKey} from 'react-native-onyx';
+import type {OnyxMultiSetInput} from 'react-native-onyx/dist/types';
+import DateUtils from '@libs/DateUtils';
+import ONYXKEYS from '@src/ONYXKEYS';
+
+/**
+ * Atomically clears Onyx while seeding LAST_FULL_RECONNECT_TIME=now so that
+ * subscribeToFullReconnect doesn't fire a redundant ReconnectApp when the caller
+ * runs an OpenApp right after the clear: OpenApp's response.onyxData carries
+ * NVP_RECONNECT_APP_IF_FULL_RECONNECT_BEFORE and applyHTTPSOnyxUpdates applies
+ * response.onyxData before successData, so without the seed the timestamp would
+ * still be empty when the comparison runs and trigger a duplicate reconnect.
+ *
+ * Pass `extraSeeds` to seed additional keys atomically with the timestamp (e.g.
+ * IS_LOADING_APP=true for delegate transitions). Seeded keys are appended to the
+ * preserve list automatically so they survive the clear.
+ */
+function clearOnyxAndSeedFullReconnect(keysToPreserve: OnyxKey[], extraSeeds?: OnyxMultiSetInput): Promise<void> {
+    const seeds: OnyxMultiSetInput = {
+        ...extraSeeds,
+        [ONYXKEYS.LAST_FULL_RECONNECT_TIME]: DateUtils.getDBTime(),
+    };
+    return Onyx.multiSet(seeds).then(() => Onyx.clear([...keysToPreserve, ...(Object.keys(seeds) as OnyxKey[])]));
+}
+
+export default clearOnyxAndSeedFullReconnect;