[Part 2] Remove Onyx.connect(ONYXKEYS.SESSION) in /Session/index.ts: thread sesion through signOutAndRedirectToSignIn

src/components/AnonymousReportFooter.tsx

@@ -14,6 +14,7 @@ import ONYXKEYS from '@src/ONYXKEYS';
 
 import React from 'react';
 import {View} from 'react-native';
+import Onyx from 'react-native-onyx';
 
 import AvatarWithDisplayName from './AvatarWithDisplayName';
 import Button from './Button';
@@ -54,7 +55,7 @@ function AnonymousReportFooter({reportID}: AnonymousReportFooterProps) {
                         sentryLabel={CONST.SENTRY_LABEL.ANONYMOUS_REPORT_FOOTER.SIGN_IN_BUTTON}
                         variant={CONST.BUTTON_VARIANT.SUCCESS}
                         onPress={() => {
-                            signOutAndRedirectToSignIn();
+                            Onyx.get(ONYXKEYS.SESSION).then((session) => signOutAndRedirectToSignIn(session));
                         }}
                     >
                         <Button.Text>{translate('common.signIn')}</Button.Text>

src/components/Reactions/ReportActionItemEmojiReactions.tsx

@@ -97,7 +97,7 @@ function ReportActionItemEmojiReactions({reportAction, reportID, isEditingInline
 
             TransitionTracker.runAfterTransitions({
                 callback: () => {
-                    signOutAndRedirectToSignIn();
+                    signOutAndRedirectToSignIn(session);
                 },
             });
             return;

src/hooks/useSignOut.ts

@@ -20,6 +20,7 @@ import type GpsDraftDetails from '@src/types/onyx/GpsDraftDetails';
 import type {RefObject} from 'react';
 
 import {stopLocationUpdatesAsync} from 'expo-location';
+import Onyx from 'react-native-onyx';
 
 import useConfirmModal from './useConfirmModal';
 import useLocalize from './useLocalize';
@@ -62,7 +63,7 @@ function useSignOut() {
     };
 
     const signOutImmediately = () => {
-        signOutAndRedirectToSignIn();
+        Onyx.get(ONYXKEYS.SESSION).then((session) => signOutAndRedirectToSignIn(session));
     };
 
     const runSignOut = async ({shouldAlwaysConfirm = false}: SignOutOptions = {}) => {
@@ -71,7 +72,7 @@ function useSignOut() {
         const isOfflineReceiptsCase = isOffline && !isTrackingGPS && saveableReceipts.length > 0;
 
         if (!shouldAlwaysConfirm && !shouldWarnBeforeSignOut && saveableReceipts.length === 0) {
-            return signOutAndRedirectToSignIn();
+            return signOutAndRedirectToSignIn(await Onyx.get(ONYXKEYS.SESSION));
         }
 
         const confirmModalTitle = isTrackingGPS ? translate('gps.signOutWarningTripInProgress.title') : translate('common.areYouSure');
@@ -143,7 +144,7 @@ function useSignOut() {
             stopLocationUpdatesAsync(BACKGROUND_LOCATION_TRACKING_TASK_NAME).catch((error) => console.error('[GPS distance request] Failed to stop location tracking', error));
         }
 
-        return signOutAndRedirectToSignIn();
+        return signOutAndRedirectToSignIn(await Onyx.get(ONYXKEYS.SESSION));
     };
 
     const signOut = async ({shouldAlwaysConfirm = false}: SignOutOptions = {}) => {

src/libs/Middleware/HandleDeletedAccount.ts

@@ -2,6 +2,22 @@ import {signOutAndRedirectToSignIn} from '@libs/actions/Session';
 import type {Middleware} from '@libs/Request';
 
 import CONST from '@src/CONST';
+import ONYXKEYS from '@src/ONYXKEYS';
+import type {Session} from '@src/types/onyx';
+
+import type {OnyxEntry} from 'react-native-onyx';
+
+import Onyx from 'react-native-onyx';
+
+let session: OnyxEntry<Session>;
+
+// Use connectWithoutView since middleware runs outside React and needs the session when the deleted-account response arrives
+Onyx.connectWithoutView({
+    key: ONYXKEYS.SESSION,
+    callback: (value) => {
+        session = value;
+    },
+});
 
 /**
  * Handles the case when the user's copilot has been deleted.
@@ -14,7 +30,7 @@ const handleDeletedAccount: Middleware = (requestResponse) =>
         if (response?.jsonCode !== 408 || !response?.message?.includes('The account you are trying to use is deleted.')) {
             return response;
         }
-        signOutAndRedirectToSignIn(true, false, true, true, CONST.SIGN_OUT_REASON.ACCOUNT_DELETED);
+        signOutAndRedirectToSignIn(session, true, false, true, true, CONST.SIGN_OUT_REASON.ACCOUNT_DELETED);
     });
 
 export default handleDeletedAccount;

src/libs/Navigation/AppNavigator/AuthScreensInitHandler.tsx

@@ -177,7 +177,7 @@ function AuthScreensInitHandler() {
                 isDelegateSession: Session.isDelegateSession(session),
                 isSupportalTransition,
             });
-            Session.signOutAndRedirectToSignIn(false, isSupportalTransition, true, undefined, CONST.SIGN_OUT_REASON.LOGIN_AS_NEW_USER);
+            Session.signOutAndRedirectToSignIn(session, false, isSupportalTransition, true, undefined, CONST.SIGN_OUT_REASON.LOGIN_AS_NEW_USER);
             return () => {
                 Session.cleanupSession();
             };

src/libs/actions/Link.ts

@@ -47,6 +47,7 @@ import {canAnonymousUserAccessRoute, isAnonymousUser, signOutAndRedirectToSignIn
 import {setOnboardingErrorMessage} from './Welcome';
 
 let currentUserAccountID: number = CONST.DEFAULT_NUMBER_ID;
+let currentSession: OnyxEntry<Session>;
 const pendingDeepLinkCleanups = new Set<() => void>();
 
 registerSessionCleanupCallback(() => {
@@ -55,11 +56,13 @@ registerSessionCleanupCallback(() => {
     }
 });
 
-// Use connectWithoutView since this is to open an external link and doesn't affect any UI
+// Use connectWithoutView since this is to open an external link and doesn't affect any UI.
+// It also keeps the session live for deep links, which sign out after sign-in finishes, so a value captured when the link was opened would be stale.
 Onyx.connectWithoutView({
     key: ONYXKEYS.SESSION,
     callback: (value) => {
         currentUserAccountID = value?.accountID ?? CONST.DEFAULT_NUMBER_ID;
+        currentSession = value;
     },
 });
 
@@ -398,7 +401,7 @@ function openLink(href: string, environmentURL: string, isAttachment: boolean, s
 
     if (reportLinkRoute) {
         if (internalNewExpensifyPath && hasSameOrigin && isAnonymousUser(session) && !canAnonymousUserAccessRoute(internalNewExpensifyPath)) {
-            signOutAndRedirectToSignIn();
+            signOutAndRedirectToSignIn(session);
             return;
         }
         if (focusedSearchReportActionRoute && reportLinkRouteParams?.reportActionID) {
@@ -416,7 +419,7 @@ function openLink(href: string, environmentURL: string, isAttachment: boolean, s
     // instead of in a new tab or with a page refresh (which is the default behavior of an anchor tag)
     if (internalNewExpensifyPath && hasSameOrigin) {
         if (isAnonymousUser(session) && !canAnonymousUserAccessRoute(internalNewExpensifyPath)) {
-            signOutAndRedirectToSignIn();
+            signOutAndRedirectToSignIn(session);
             return;
         }
         if (shouldCloseRHP) {
@@ -527,7 +530,7 @@ function openReportFromDeepLink(
                 // (canAnonymousUserAccessRoute would allow it). Force a real sign-in first; the deep link is re-processed
                 // after sign-in. Without this the user lands on /r/:id?secureKey with no join, stuck loading/404.
                 if (isAnonymousUser()) {
-                    signOutAndRedirectToSignIn(true);
+                    signOutAndRedirectToSignIn(currentSession, true);
                     return;
                 }
                 // On cold launch the report is already the initial route; navigating again would stack a duplicate
@@ -585,7 +588,7 @@ function openReportFromDeepLink(
                     }
 
                     if (route && isAnonymousUser() && !canAnonymousUserAccessRoute(route)) {
-                        signOutAndRedirectToSignIn(true);
+                        signOutAndRedirectToSignIn(currentSession, true);
                         return;
                     }
 

src/libs/actions/Session/index.ts

@@ -373,6 +373,7 @@ const KEYS_TO_PRESERVE_SUPPORTAL = [
 ];
 
 function signOutAndRedirectToSignIn(
+    session: OnyxEntry<Session>,
     shouldResetToHome?: boolean,
     shouldStashSession?: boolean,
     shouldSignOutFromOldDot = true,
@@ -392,7 +393,7 @@ function signOutAndRedirectToSignIn(
         return;
     }
 
-    const isSupportal = isSupportAuthToken();
+    const isSupportal = isSupportAuthToken(session);
     const shouldRestoreStashedSession = isSupportal || shouldForceUseStashedSession;
 
     if (CONFIG.IS_HYBRID_APP && shouldSignOutFromOldDot) {
@@ -404,7 +405,7 @@ function signOutAndRedirectToSignIn(
     // session.
     const signOutPromise: Promise<void | Response<never>> =
         !shouldRestoreStashedSession && !shouldStashSession
-            ? signOut({autoGeneratedLogin: credentials?.autoGeneratedLogin, signedInWithSAML: !!deprecatedSession.signedInWithSAML, authToken: deprecatedSession.authToken})
+            ? signOut({autoGeneratedLogin: credentials?.autoGeneratedLogin, signedInWithSAML: !!session?.signedInWithSAML, authToken: deprecatedSession.authToken})
             : Promise.resolve();
 
     // The function redirectToSignIn will clear the whole storage, so let's create our onyx params
@@ -417,7 +418,7 @@ function signOutAndRedirectToSignIn(
     if (!isSupportal && shouldStashSession) {
         onyxSetParams = {
             [ONYXKEYS.STASHED_CREDENTIALS]: credentials,
-            [ONYXKEYS.STASHED_SESSION]: deprecatedSession,
+            [ONYXKEYS.STASHED_SESSION]: session,
         };
     }
 
@@ -439,7 +440,7 @@ function signOutAndRedirectToSignIn(
                 newDotCurrentAccountEmail: stashedSession.email ?? '',
                 authToken: stashedSession.authToken ?? '',
                 policyID: '',
-                accountID: deprecatedSession.accountID ? String(deprecatedSession.accountID) : '',
+                accountID: session?.accountID ? String(session.accountID) : '',
             });
             hasSwitchedAccountInHybridMode = true;
         }
@@ -546,7 +547,7 @@ function callIfAuthenticated<TCallback extends ((...args: any[]) => any) | void>
     if (isAnonymousUser(session)) {
         return () => {
             close(() => {
-                signOutAndRedirectToSignIn();
+                signOutAndRedirectToSignIn(session);
             });
         };
     }

src/libs/interceptAnonymousUser.ts

@@ -11,7 +11,7 @@ import * as Session from './actions/Session';
 const interceptAnonymousUser = (callback: () => void, session: OnyxEntry<SessionType>) => {
     const isAnonymousUser = Session.isAnonymousUser(session);
     if (isAnonymousUser) {
-        Session.signOutAndRedirectToSignIn();
+        Session.signOutAndRedirectToSignIn(session);
     } else {
         callback();
     }

src/pages/ErrorPage/GenericErrorPage.tsx

@@ -20,9 +20,11 @@ import variables from '@styles/variables';
 import {signOutAndRedirectToSignIn} from '@userActions/Session';
 
 import CONST from '@src/CONST';
+import ONYXKEYS from '@src/ONYXKEYS';
 
 import React from 'react';
 import {View} from 'react-native';
+import Onyx from 'react-native-onyx';
 
 import ErrorBodyText from './ErrorBodyText';
 
@@ -84,8 +86,10 @@ function GenericErrorPage({error}: {error?: Error}) {
                                         <Button
                                             sentryLabel={CONST.SENTRY_LABEL.ERROR_PAGE.SIGN_OUT}
                                             onPress={() => {
-                                                signOutAndRedirectToSignIn();
-                                                refreshPage();
+                                                Onyx.get(ONYXKEYS.SESSION).then((session) => {
+                                                    signOutAndRedirectToSignIn(session);
+                                                    refreshPage();
+                                                });
                                             }}
                                         >
                                             <Button.Text>{translate('initialSettingsPage.signOut')}</Button.Text>

src/pages/LogOutPreviousUserPage.tsx

@@ -48,7 +48,7 @@ function LogOutPreviousUserPage({route}: LogOutPreviousUserPageProps) {
                 isSupportalLogin,
             });
             // We don't want to close react-native app in this particular case.
-            signOutAndRedirectToSignIn(false, isSupportalLogin, true, undefined, CONST.SIGN_OUT_REASON.LOGIN_AS_NEW_USER);
+            signOutAndRedirectToSignIn(session, false, isSupportalLogin, true, undefined, CONST.SIGN_OUT_REASON.LOGIN_AS_NEW_USER);
             return;
         }
 

src/pages/inbox/report/ContextMenu/BaseReportActionContextMenu.tsx

@@ -352,7 +352,7 @@ function BaseReportActionContextMenu({
     const interceptAnonymousUser = (callback: () => void, isAnonymousAction = false) => {
         if (isAnonymousUser(session) && !isAnonymousAction) {
             hideContextMenu(false, () => {
-                signOutAndRedirectToSignIn();
+                signOutAndRedirectToSignIn(session);
             });
         } else {
             callback();

src/pages/inbox/sidebar/SignInButton.tsx

@@ -7,9 +7,11 @@ import useThemeStyles from '@hooks/useThemeStyles';
 import {signOutAndRedirectToSignIn} from '@userActions/Session';
 
 import CONST from '@src/CONST';
+import ONYXKEYS from '@src/ONYXKEYS';
 
 import React from 'react';
 import {View} from 'react-native';
+import Onyx from 'react-native-onyx';
 
 function SignInButton() {
     const styles = useThemeStyles();
@@ -19,15 +21,17 @@ function SignInButton() {
         <PressableWithoutFeedback
             accessibilityLabel={translate('sidebarScreen.buttonMySettings')}
             role={CONST.ROLE.BUTTON}
-            onPress={() => signOutAndRedirectToSignIn()}
+            onPress={() => {
+                Onyx.get(ONYXKEYS.SESSION).then((session) => signOutAndRedirectToSignIn(session));
+            }}
             sentryLabel={CONST.SENTRY_LABEL.SIDEBAR.SIGN_IN_BUTTON}
         >
             <View style={[styles.signInButtonAvatar, styles.ph2]}>
                 <Button
                     sentryLabel={CONST.SENTRY_LABEL.SIDEBAR.SIGN_IN_BUTTON}
                     variant={CONST.BUTTON_VARIANT.SUCCESS}
                     onPress={() => {
-                        signOutAndRedirectToSignIn();
+                        Onyx.get(ONYXKEYS.SESSION).then((session) => signOutAndRedirectToSignIn(session));
                     }}
                 >
                     <Button.Text>{translate('common.signIn')}</Button.Text>

tests/actions/SessionTest.ts

@@ -580,7 +580,7 @@ describe('Session', () => {
 
             const redirectToSignInSpy = jest.spyOn(SignInRedirect, 'default').mockImplementation(() => Promise.resolve());
 
-            signOutAndRedirectToSignIn();
+            signOutAndRedirectToSignIn(await Onyx.get(ONYXKEYS.SESSION));
 
             await waitForBatchedUpdates();
 
@@ -604,7 +604,7 @@ describe('Session', () => {
 
             const redirectToSignInSpy = jest.spyOn(SignInRedirect, 'default').mockImplementation(() => Promise.resolve());
 
-            signOutAndRedirectToSignIn();
+            signOutAndRedirectToSignIn(await Onyx.get(ONYXKEYS.SESSION));
 
             await waitForBatchedUpdates();
 
@@ -629,7 +629,7 @@ describe('Session', () => {
 
             await waitForBatchedUpdates();
 
-            signOutAndRedirectToSignIn(false, false, true, true);
+            signOutAndRedirectToSignIn(await Onyx.get(ONYXKEYS.SESSION), false, false, true, true);
 
             await waitForBatchedUpdates();
 
@@ -663,7 +663,7 @@ describe('Session', () => {
 
             const redirectToSignInSpy = jest.spyOn(SignInRedirect, 'default').mockImplementation(() => Promise.resolve());
 
-            signOutAndRedirectToSignIn(true, false, true, true);
+            signOutAndRedirectToSignIn(await Onyx.get(ONYXKEYS.SESSION), true, false, true, true);
 
             await waitForBatchedUpdates();
 

tests/ui/AuthScreensInitHandlerTest.tsx

@@ -277,7 +277,14 @@ describe('AuthScreensInitHandler', () => {
         renderAuthScreensInitHandler();
         await waitForBatchedUpdatesWithAct();
 
-        expect(signOutAndRedirectToSignIn).toHaveBeenCalledWith(false, false, true, undefined, CONST.SIGN_OUT_REASON.LOGIN_AS_NEW_USER);
+        expect(signOutAndRedirectToSignIn).toHaveBeenCalledWith(
+            expect.objectContaining({accountID: TEST_ACCOUNT_ID, email: 'test@test.com'}),
+            false,
+            false,
+            true,
+            undefined,
+            CONST.SIGN_OUT_REASON.LOGIN_AS_NEW_USER,
+        );
     });
 
     it('calls openApp when didUserLogInDuringSession returns true', async () => {

tests/unit/GenericErrorPageTest.tsx

@@ -1,5 +1,5 @@
 // Regression coverage for the error-page heading and its existing recovery actions.
-import {fireEvent, render, screen} from '@testing-library/react-native';
+import {fireEvent, render, screen, waitFor} from '@testing-library/react-native';
 
 import {LocaleContextProvider} from '@components/LocaleContextProvider';
 import ThemeProvider from '@components/ThemeProvider';
@@ -80,8 +80,8 @@ it('preserves authenticated sign-out and refresh', async () => {
     // When the user chooses Sign out
     fireEvent.press(screen.getByRole('button', {name: en.initialSettingsPage.signOut}));
 
-    // Then sign-out still runs and refresh does not request chunk-cache recovery
-    expect(signOutAndRedirectToSignIn).toHaveBeenCalledTimes(1);
+    // Then sign-out still runs once the session is read, and refresh does not request chunk-cache recovery
+    await waitFor(() => expect(signOutAndRedirectToSignIn).toHaveBeenCalledTimes(1));
     expect(refreshPage).toHaveBeenCalledTimes(1);
     expect(refreshPage).toHaveBeenCalledWith();
 });