Add supportal navigation

src/CONST.ts

@@ -72,6 +72,11 @@ const CONST = {
         FAILED: 'failed',
     },
 
+    AUTH_TOKEN_TYPES: {
+        ANONYMOUS: 'anonymousAccount',
+        SUPPORT: 'support',
+    },
+
     AVATAR_MAX_ATTACHMENT_SIZE: 6291456,
 
     AVATAR_ALLOWED_EXTENSIONS: ['jpg', 'jpeg', 'png', 'gif', 'bmp', 'svg'],

src/libs/API/parameters/SignInWithSupportAuthTokenParams.ts

@@ -0,0 +1,5 @@
+type SignInWithSupportAuthTokenParams = {
+    authToken: string;
+};
+
+export default SignInWithSupportAuthTokenParams;

src/libs/API/parameters/index.ts

@@ -52,6 +52,7 @@ export type {default as SendPerformanceTimingParams} from './SendPerformanceTimi
 export type {default as SetContactMethodAsDefaultParams} from './SetContactMethodAsDefaultParams';
 export type {default as SignInUserWithLinkParams} from './SignInUserWithLinkParams';
 export type {default as SignInWithShortLivedAuthTokenParams} from './SignInWithShortLivedAuthTokenParams';
+export type {default as SignInWithSupportAuthTokenParams} from './SignInWithSupportAuthTokenParams';
 export type {default as UnlinkLoginParams} from './UnlinkLoginParams';
 export type {default as UpdateAutomaticTimezoneParams} from './UpdateAutomaticTimezoneParams';
 export type {default as UpdateChatPriorityModeParams} from './UpdateChatPriorityModeParams';

src/libs/API/types.ts

@@ -317,6 +317,7 @@ const READ_COMMANDS = {
     OPEN_ENABLE_PAYMENTS_PAGE: 'OpenEnablePaymentsPage',
     BEGIN_SIGNIN: 'BeginSignIn',
     SIGN_IN_WITH_SHORT_LIVED_AUTH_TOKEN: 'SignInWithShortLivedAuthToken',
+    SIGN_IN_WITH_SUPPORT_AUTH_TOKEN: 'SignInWithSupportAuthToken',
     OPEN_WORKSPACE_REIMBURSE_VIEW: 'OpenWorkspaceReimburseView',
     OPEN_WORKSPACE: 'OpenWorkspace',
     OPEN_WORKSPACE_MEMBERS_PAGE: 'OpenWorkspaceMembersPage',
@@ -351,6 +352,7 @@ type ReadCommandParameters = {
     [READ_COMMANDS.OPEN_ENABLE_PAYMENTS_PAGE]: EmptyObject;
     [READ_COMMANDS.BEGIN_SIGNIN]: Parameters.BeginSignInParams;
     [READ_COMMANDS.SIGN_IN_WITH_SHORT_LIVED_AUTH_TOKEN]: Parameters.SignInWithShortLivedAuthTokenParams;
+    [READ_COMMANDS.SIGN_IN_WITH_SUPPORT_AUTH_TOKEN]: Parameters.SignInWithSupportAuthTokenParams;
     [READ_COMMANDS.OPEN_WORKSPACE_REIMBURSE_VIEW]: Parameters.OpenWorkspaceReimburseViewParams;
     [READ_COMMANDS.OPEN_WORKSPACE]: Parameters.OpenWorkspaceParams;
     [READ_COMMANDS.OPEN_WORKSPACE_MEMBERS_PAGE]: Parameters.OpenWorkspaceMembersPageParams;

src/libs/Navigation/types.ts

@@ -460,20 +460,26 @@ type BottomTabNavigatorParamList = {
     [SCREENS.WORKSPACE.INITIAL]: undefined;
 };
 
-type PublicScreensParamList = {
+type SharedScreensParamList = {
     [NAVIGATORS.BOTTOM_TAB_NAVIGATOR]: NavigatorScreenParams<BottomTabNavigatorParamList>;
     [SCREENS.TRANSITION_BETWEEN_APPS]: {
-        email?: string;
+        email: string;
+        accountID: number;
         error?: string;
-        shortLivedAuthToken?: string;
-        shortLivedToken?: string;
+        supportAuthToken: string;
+        shortLivedAuthToken: string;
+        shortLivedToken: string;
         exitTo?: Routes | HybridAppRoute;
+        shouldForceLogin: string;
     };
     [SCREENS.VALIDATE_LOGIN]: {
         accountID: string;
         validateCode: string;
         exitTo?: Routes | HybridAppRoute;
     };
+};
+
+type PublicScreensParamList = SharedScreensParamList & {
     [SCREENS.UNLINK_LOGIN]: {
         accountID?: string;
         validateCode?: string;
@@ -483,19 +489,7 @@ type PublicScreensParamList = {
     [SCREENS.SAML_SIGN_IN]: undefined;
 };
 
-type AuthScreensParamList = {
-    [NAVIGATORS.BOTTOM_TAB_NAVIGATOR]: NavigatorScreenParams<BottomTabNavigatorParamList>;
-    [NAVIGATORS.CENTRAL_PANE_NAVIGATOR]: NavigatorScreenParams<CentralPaneNavigatorParamList>;
-    [SCREENS.VALIDATE_LOGIN]: {
-        accountID: string;
-        validateCode: string;
-    };
-    [SCREENS.TRANSITION_BETWEEN_APPS]: {
-        shouldForceLogin: string;
-        email: string;
-        shortLivedAuthToken: string;
-        exitTo: string;
-    };
+type AuthScreensParamList = SharedScreensParamList & {
     [SCREENS.CONCIERGE]: undefined;
     [SCREENS.REPORT_ATTACHMENTS]: {
         reportID: string;

src/libs/Network/NetworkStore.ts

@@ -1,11 +1,13 @@
 import Onyx from 'react-native-onyx';
+import type {ValueOf} from 'type-fest';
 import {READ_COMMANDS, SIDE_EFFECT_REQUEST_COMMANDS} from '@libs/API/types';
+import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import type Credentials from '@src/types/onyx/Credentials';
 
 let credentials: Credentials | null = null;
 let authToken: string | null = null;
-let supportAuthToken: string | null = null;
+let authTokenType: ValueOf<typeof CONST.AUTH_TOKEN_TYPES> | null;
 let currentUserEmail: string | null = null;
 let offline = false;
 let authenticating = false;
@@ -51,7 +53,7 @@ Onyx.connect({
     key: ONYXKEYS.SESSION,
     callback: (val) => {
         authToken = val?.authToken ?? null;
-        supportAuthToken = val?.supportAuthToken ?? null;
+        authTokenType = val?.authTokenType ?? null;
         currentUserEmail = val?.email ?? null;
         checkRequiredData();
     },
@@ -99,12 +101,8 @@ function isSupportRequest(command: string): boolean {
     return [READ_COMMANDS.OPEN_APP, SIDE_EFFECT_REQUEST_COMMANDS.RECONNECT_APP, SIDE_EFFECT_REQUEST_COMMANDS.OPEN_REPORT].some((cmd) => cmd === command);
 }
 
-function getSupportAuthToken(): string | null {
-    return supportAuthToken;
-}
-
-function setSupportAuthToken(newSupportAuthToken: string) {
-    supportAuthToken = newSupportAuthToken;
+function isSupportAuthToken(): boolean {
+    return authTokenType === CONST.AUTH_TOKEN_TYPES.SUPPORT;
 }
 
 function setAuthToken(newAuthToken: string | null) {
@@ -139,7 +137,6 @@ export {
     setIsAuthenticating,
     getCredentials,
     checkRequiredData,
-    getSupportAuthToken,
-    setSupportAuthToken,
+    isSupportAuthToken,
     isSupportRequest,
 };

src/libs/Network/enhanceParameters.ts

@@ -16,12 +16,8 @@ function isAuthTokenRequired(command: string): boolean {
 export default function enhanceParameters(command: string, parameters: Record<string, unknown>): Record<string, unknown> {
     const finalParameters = {...parameters};
 
-    if (isAuthTokenRequired(command)) {
-        if (NetworkStore.getSupportAuthToken() && NetworkStore.isSupportRequest(command)) {
-            finalParameters.authToken = NetworkStore.getSupportAuthToken();
-        } else if (!parameters.authToken) {
-            finalParameters.authToken = NetworkStore.getAuthToken();
-        }
+    if (isAuthTokenRequired(command) && ((NetworkStore.isSupportAuthToken() && NetworkStore.isSupportRequest(command)) || !parameters.authToken)) {
+        finalParameters.authToken = NetworkStore.getAuthToken();
     }
 
     finalParameters.referer = CONFIG.EXPENSIFY.EXPENSIFY_CASH_REFERER;

src/libs/ReportUtils.ts

@@ -436,7 +436,7 @@ Onyx.connect({
 
         currentUserEmail = value.email;
         currentUserAccountID = value.accountID;
-        isAnonymousUser = value.authTokenType === 'anonymousAccount';
+        isAnonymousUser = value.authTokenType === CONST.AUTH_TOKEN_TYPES.ANONYMOUS;
     },
 });
 

src/libs/Request.ts

@@ -12,7 +12,7 @@ function makeXHR(request: Request): Promise<Response | void> {
     return NetworkStore.hasReadRequiredDataFromStorage().then((): Promise<Response | void> => {
         // If we're using the Supportal token and this is not a Supportal request
         // let's just return a promise that will resolve itself.
-        if (NetworkStore.getSupportAuthToken() && !NetworkStore.isSupportRequest(request.command)) {
+        if (NetworkStore.isSupportAuthToken() && !NetworkStore.isSupportRequest(request.command)) {
             return new Promise<void>((resolve) => resolve());
         }
 

src/libs/actions/Session/index.ts

@@ -18,6 +18,7 @@ import type {
     RequestUnlinkValidationLinkParams,
     SignInUserWithLinkParams,
     SignInWithShortLivedAuthTokenParams,
+    SignInWithSupportAuthTokenParams,
     UnlinkLoginParams,
     ValidateTwoFactorAuthParams,
 } from '@libs/API/parameters';
@@ -52,7 +53,7 @@ import type Credentials from '@src/types/onyx/Credentials';
 import type {AutoAuthState} from '@src/types/onyx/Session';
 import clearCache from './clearCache';
 
-let sessionAuthTokenType: string | null = '';
+let sessionAuthTokenType: ValueOf<typeof CONST.AUTH_TOKEN_TYPES> | null = null;
 let sessionAuthToken: string | null = null;
 let authPromiseResolver: ((value: boolean) => void) | null = null;
 
@@ -81,22 +82,108 @@ Onyx.connect({
     callback: (val) => (preferredLocale = val),
 });
 
+function isSupportalToken(): boolean {
+    return sessionAuthTokenType === CONST.AUTH_TOKEN_TYPES.SUPPORT;
+}
+
+/**
+ * Sets the SupportToken. This method will only be used on dev.
+ */
+function setSupportAuthToken(supportAuthToken: string, email?: string, accountID?: number) {
+    if (supportAuthToken) {
+        Onyx.merge(ONYXKEYS.SESSION, {
+            authTokenType: CONST.AUTH_TOKEN_TYPES.SUPPORT,
+            authToken: supportAuthToken,
+            email,
+            accountID,
+        }).then(() => {
+            Log.info('[Supportal] Authtoken set');
+        });
+    }
+    Onyx.set(ONYXKEYS.LAST_VISITED_PATH, '');
+}
+
+function clearSupportAuthToken() {
+    Onyx.set(ONYXKEYS.SESSION, null).then(() => {
+        Log.info('[Supportal] Authtoken removed');
+    });
+    Onyx.set(ONYXKEYS.LAST_VISITED_PATH, null);
+}
+
+function getShortLivedLoginParams() {
+    const optimisticData: OnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: ONYXKEYS.ACCOUNT,
+            value: {
+                ...CONST.DEFAULT_ACCOUNT_DATA,
+                isLoading: true,
+            },
+        },
+        // We are making a temporary modification to 'signedInWithShortLivedAuthToken' to ensure that 'App.openApp' will be called at least once
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: ONYXKEYS.SESSION,
+            value: {
+                signedInWithShortLivedAuthToken: true,
+            },
+        },
+    ];
+
+    // Subsequently, we revert it back to the default value of 'signedInWithShortLivedAuthToken' in 'successData' or 'failureData' to ensure the user is logged out on refresh
+    // We are combining both success and failure data params into one const as they are identical
+    const finallyData: OnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: ONYXKEYS.ACCOUNT,
+            value: {
+                isLoading: false,
+            },
+        },
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: ONYXKEYS.SESSION,
+            value: {
+                signedInWithShortLivedAuthToken: null,
+            },
+        },
+    ];
+
+    return {optimisticData, finallyData};
+}
+
+/**
+ * This method should be used when we are being redirected from oldDot to NewDot on a supportal request
+ */
+function signInWithSupportAuthToken(authToken: string) {
+    const {optimisticData, finallyData} = getShortLivedLoginParams();
+    const params: SignInWithSupportAuthTokenParams = {authToken};
+    API.read(READ_COMMANDS.SIGN_IN_WITH_SUPPORT_AUTH_TOKEN, params, {optimisticData, finallyData});
+}
+
 /**
  * Clears the Onyx store and redirects user to the sign in page
  */
 function signOut() {
     Log.info('Flushing logs before signing out', true, {}, true);
 
-    const params: LogOutParams = {
-        // Send current authToken because we will immediately clear it once triggering this command
-        authToken: NetworkStore.getAuthToken(),
-        partnerUserID: credentials?.autoGeneratedLogin ?? '',
-        partnerName: CONFIG.EXPENSIFY.PARTNER_NAME,
-        partnerPassword: CONFIG.EXPENSIFY.PARTNER_PASSWORD,
-        shouldRetry: false,
-    };
+    // In case this is a supportal token, we won't have infinite sessions setup since the token will be
+    // short lived. So we can just remove the token and we can just skip calling logout.
+    if (isSupportalToken()) {
+        clearSupportAuthToken();
+    } else {
+        const params: LogOutParams = {
+            // Send current authToken because we will immediately clear it once triggering this command
+            authToken: NetworkStore.getAuthToken(),
+            partnerUserID: credentials?.autoGeneratedLogin ?? '',
+            partnerName: CONFIG.EXPENSIFY.PARTNER_NAME,
+            partnerPassword: CONFIG.EXPENSIFY.PARTNER_PASSWORD,
+            shouldRetry: false,
+        };
+
+        API.write(WRITE_COMMANDS.LOG_OUT, params);
+    }
 
-    API.write(WRITE_COMMANDS.LOG_OUT, params);
     clearCache().then(() => {
         Log.info('Cleared all cache data', true, {}, true);
     });
@@ -314,46 +401,7 @@ function beginGoogleSignIn(token: string | null) {
  * re-authenticating after an authToken expires.
  */
 function signInWithShortLivedAuthToken(email: string, authToken: string) {
-    const optimisticData: OnyxUpdate[] = [
-        {
-            onyxMethod: Onyx.METHOD.MERGE,
-            key: ONYXKEYS.ACCOUNT,
-            value: {
-                ...CONST.DEFAULT_ACCOUNT_DATA,
-                isLoading: true,
-            },
-        },
-        // We are making a temporary modification to 'signedInWithShortLivedAuthToken' to ensure that 'App.openApp' will be called at least once
-        {
-            onyxMethod: Onyx.METHOD.MERGE,
-            key: ONYXKEYS.SESSION,
-            value: {
-                signedInWithShortLivedAuthToken: true,
-            },
-        },
-    ];
-
-    // Subsequently, we revert it back to the default value of 'signedInWithShortLivedAuthToken' in 'successData' or 'failureData' to ensure the user is logged out on refresh
-    // We are combining both success and failure data params into one const as they are identical
-    const resolutionData: OnyxUpdate[] = [
-        {
-            onyxMethod: Onyx.METHOD.MERGE,
-            key: ONYXKEYS.ACCOUNT,
-            value: {
-                isLoading: false,
-            },
-        },
-        {
-            onyxMethod: Onyx.METHOD.MERGE,
-            key: ONYXKEYS.SESSION,
-            value: {
-                signedInWithShortLivedAuthToken: null,
-            },
-        },
-    ];
-
-    const successData = resolutionData;
-    const failureData = resolutionData;
+    const {optimisticData, finallyData} = getShortLivedLoginParams();
 
     // If the user is signing in with a different account from the current app, should not pass the auto-generated login as it may be tied to the old account.
     // scene 1: the user is transitioning to newDot from a different account on oldDot.
@@ -362,7 +410,7 @@ function signInWithShortLivedAuthToken(email: string, authToken: string) {
 
     const params: SignInWithShortLivedAuthTokenParams = {authToken, oldPartnerUserID, skipReauthentication: true};
 
-    API.read(READ_COMMANDS.SIGN_IN_WITH_SHORT_LIVED_AUTH_TOKEN, params, {optimisticData, successData, failureData});
+    API.read(READ_COMMANDS.SIGN_IN_WITH_SHORT_LIVED_AUTH_TOKEN, params, {optimisticData, finallyData});
 }
 
 /**
@@ -530,23 +578,6 @@ function invalidateAuthToken() {
     Onyx.merge(ONYXKEYS.SESSION, {authToken: 'pizza'});
 }
 
-/**
- * Sets the SupportToken
- */
-function setSupportAuthToken(supportAuthToken: string, email: string, accountID: number) {
-    if (supportAuthToken) {
-        Onyx.merge(ONYXKEYS.SESSION, {
-            authToken: '1',
-            supportAuthToken,
-            email,
-            accountID,
-        });
-    } else {
-        Onyx.set(ONYXKEYS.SESSION, {});
-    }
-    NetworkStore.setSupportAuthToken(supportAuthToken);
-}
-
 /**
  * Clear the credentials and partial sign in session so the user can taken back to first Login step
  */
@@ -929,4 +960,5 @@ export {
     validateTwoFactorAuth,
     waitForUserSignIn,
     canAccessRouteByAnonymousUser,
+    signInWithSupportAuthToken,
 };