Act on the Submit deeplink only for users who already onboarded

The link is scoped to existing users with an intent already set, so anyone who
still has guided setup ahead of them is left to the normal onboarding flow,
which already offers the Submit outcome. That removes the need to suppress
onboarding at all, so the router, the navigation guard and the shared
workspace-creation hook go back to their original behaviour.

Also corrects a stale comment describing the post-creation destination as
Categories; the shared helper navigates to Spend with #admins in the side panel.

Author: abzokhattab

src/ONYXKEYS.ts

@@ -1,7 +1,7 @@
 import type {ValueOf} from 'type-fest';
 
 import type CONST from './CONST';
-import type {OnboardingAccounting, OnboardingIntent} from './CONST';
+import type {OnboardingAccounting} from './CONST';
 import type {TranslationPaths} from './languages/types';
 import type {OnboardingFeatureMapItem} from './libs/actions/Welcome/OnboardingFeatures';
 import type {OnboardingCompanySize} from './libs/actions/Welcome/OnboardingFlow';
@@ -548,9 +548,6 @@ const ONYXKEYS = {
     /** Onboarding customized choices to display to the user based on their profile when signing up */
     ONBOARDING_CUSTOM_CHOICES: 'onboardingCustomChoices',
 
-    /** Onboarding outcome requested by the deeplink this session was opened with, e.g. `onboarding?intent=submit` */
-    ONBOARDING_DEEPLINK_INTENT: 'onboardingDeeplinkIntent',
-
     /** Onboarding error message translation key to be displayed to the user */
     ONBOARDING_ERROR_MESSAGE_TRANSLATION_KEY: 'onboardingErrorMessageTranslationKey',
 
@@ -1713,7 +1710,6 @@ type OnyxValuesMapping = {
     [ONYXKEYS.ONBOARDING_COMPANY_SIZE]: OnboardingCompanySize;
     [ONYXKEYS.ONBOARDING_PERSONAL_TRACK_GOAL]: string;
     [ONYXKEYS.ONBOARDING_CUSTOM_CHOICES]: OnyxTypes.OnboardingPurpose[] | [];
-    [ONYXKEYS.ONBOARDING_DEEPLINK_INTENT]: OnboardingIntent;
     [ONYXKEYS.ONBOARDING_ERROR_MESSAGE_TRANSLATION_KEY]: TranslationPaths;
     [ONYXKEYS.ONBOARDING_POLICY_ID]: string;
     [ONYXKEYS.ONBOARDING_ADMINS_CHAT_REPORT_ID]: string;

src/components/SubmitPlanWelcomeModal.tsx

@@ -49,8 +49,8 @@ function SubmitPlanWelcomeModal() {
 
     const handleConfirm = () => {
         // The user has already completed onboarding, so we skip CompleteGuidedSetup and just create the
-        // Submit workspace. autoCreateSubmitWorkspace then dismisses this modal and navigates to Categories
-        // with #admins in the RHP, which triggers the useBeforeRemove persistence above.
+        // Submit workspace. autoCreateSubmitWorkspace then dismisses this modal and navigates to Spend
+        // with #admins in the side panel, which triggers the useBeforeRemove persistence above.
         autoCreateSubmitWorkspace(firstName ?? '', lastName ?? '', false);
     };
 

src/hooks/useAutoCreateSubmitWorkspace.ts

@@ -5,7 +5,7 @@ import {canEditWorkspaceSettings, isGroupPolicy, isSubmitPolicy} from '@libs/Pol
 
 import {createWorkspace, generateDefaultWorkspaceName, generatePolicyID} from '@userActions/Policy/Policy';
 import {completeOnboarding} from '@userActions/Report';
-import {setOnboardingAdminsChatReportID, setOnboardingDeeplinkIntent, setOnboardingPolicyID} from '@userActions/Welcome';
+import {setOnboardingAdminsChatReportID, setOnboardingPolicyID} from '@userActions/Welcome';
 
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
@@ -116,9 +116,6 @@ function useAutoCreateSubmitWorkspace() {
 
             setOnboardingAdminsChatReportID();
             setOnboardingPolicyID();
-            // Both deeplink paths (the onboarding flow and the already-onboarded handler) end up here, so this is the
-            // one place that reliably retires a Submit deeplink intent once it has been honoured.
-            setOnboardingDeeplinkIntent(null);
 
             // Already-onboarded callers (the Submit plan welcome modal) can reach this point with no workspace
             // created and no onboarding policy ID when an editable Submit workspace already exists. Navigate to

src/hooks/useOnboardingDeeplinkIntent.ts

@@ -4,26 +4,21 @@ import getOnboardingIntentFromUrl from '@libs/getOnboardingIntentFromUrl';
 import getCurrentUrl from '@libs/Navigation/currentUrl';
 
 import type {OnboardingIntent} from '@src/CONST';
-import ONYXKEYS from '@src/ONYXKEYS';
 
 import {useState} from 'react';
 
-import useOnyx from './useOnyx';
-
 /**
  * Resolves the onboarding outcome requested by the deeplink this session was opened with, e.g. `onboarding?intent=submit`.
  *
- * All three sources are needed. The stored copy is the durable one but is written asynchronously, so it is absent
- * during the first render, which is exactly when the onboarding navigator picks its entry step. The browser URL covers
- * that first render but is rewritten as soon as the flow navigates, hence the mount-time latch. The initial URL is the
- * only source on native, where the browser URL is empty and the deeplink resolves asynchronously.
+ * The URL is latched at mount because the app rewrites it as soon as it navigates, which happens well before the
+ * intent has been acted on. The initial URL is the only source on native, where the browser URL is empty and the
+ * deeplink resolves asynchronously.
  */
 function useOnboardingDeeplinkIntent(): OnboardingIntent | undefined {
     const {initialURL} = useInitialURLState();
     const [urlAtMount] = useState(getCurrentUrl);
-    const [storedIntent] = useOnyx(ONYXKEYS.ONBOARDING_DEEPLINK_INTENT);
 
-    return storedIntent ?? getOnboardingIntentFromUrl(urlAtMount) ?? getOnboardingIntentFromUrl(initialURL);
+    return getOnboardingIntentFromUrl(urlAtMount) ?? getOnboardingIntentFromUrl(initialURL);
 }
 
 export default useOnboardingDeeplinkIntent;

src/hooks/useOnboardingFlow.ts

@@ -10,7 +10,6 @@ import {completeHybridAppOnboarding} from '@userActions/Welcome';
 import {startOnboardingFlow} from '@userActions/Welcome/OnboardingFlow';
 
 import CONFIG from '@src/CONFIG';
-import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import ROUTES from '@src/ROUTES';
 import isLoadingOnyxValue from '@src/types/utils/isLoadingOnyxValue';
@@ -20,7 +19,6 @@ import {hasCompletedGuidedSetupFlowSelector, tryNewDotOnyxSelector, wasInvitedTo
 import {emailSelector} from '@selectors/Session';
 import {useCallback, useEffect} from 'react';
 
-import useOnboardingDeeplinkIntent from './useOnboardingDeeplinkIntent';
 import useOnyx from './useOnyx';
 import useShouldSuppressPromotionalUI from './useShouldSuppressPromotionalUI';
 
@@ -55,8 +53,6 @@ function useOnboardingFlowRouter() {
     const [onboardingPurposeSelected] = useOnyx(ONYXKEYS.ONBOARDING_PURPOSE_SELECTED);
     const [onboardingCompanySize] = useOnyx(ONYXKEYS.ONBOARDING_COMPANY_SIZE);
     const [onboardingInitialPath] = useOnyx(ONYXKEYS.ONBOARDING_LAST_VISITED_PATH);
-    // A Submit deeplink creates the workspace outright, so there is nothing left for onboarding to ask.
-    const hasSubmitDeeplinkIntent = useOnboardingDeeplinkIntent() === CONST.ONBOARDING_INTENTS.SUBMIT;
     const [hasNonPersonalPolicy] = useOnyx(ONYXKEYS.HAS_NON_PERSONAL_POLICY);
     const [introSelected] = useOnyx(ONYXKEYS.NVP_INTRO_SELECTED);
     const wasInvitedToNewDot = wasInvitedToNewDotSelector(introSelected);
@@ -82,10 +78,6 @@ function useOnboardingFlowRouter() {
                     return;
                 }
 
-                if (hasSubmitDeeplinkIntent) {
-                    return;
-                }
-
                 if (isLoadingApp !== false || isOnboardingLoading) {
                     return;
                 }
@@ -166,7 +158,6 @@ function useOnboardingFlowRouter() {
         onboardingCompanySize,
         onboardingPurposeSelected,
         onboardingInitialPath,
-        hasSubmitDeeplinkIntent,
         hasBeenAddedToNudgeMigration,
         hasNonPersonalPolicy,
         wasInvitedToNewDot,
@@ -176,9 +167,8 @@ function useOnboardingFlowRouter() {
     ]);
 
     return {
-        // Treat the flow as completed for secure-link visitors so the onboarding modal is not mounted over the report,
-        // and for Submit deeplink visitors so it is not mounted over the workspace being created for them.
-        isOnboardingCompleted: isVisitingSecureLink || hasSubmitDeeplinkIntent ? true : hasCompletedGuidedSetupFlowSelector(onboardingValues),
+        // Treat the flow as completed for secure-link visitors so the onboarding modal is not mounted over the report.
+        isOnboardingCompleted: isVisitingSecureLink ? true : hasCompletedGuidedSetupFlowSelector(onboardingValues),
         isHybridAppOnboardingCompleted,
         isOnboardingLoading: !!onboardingValues?.isLoading,
     };

src/libs/Navigation/AppNavigator/SubmitIntentDeeplinkHandler/ApplySubmitOnboardingIntent.tsx

@@ -3,9 +3,7 @@ import useCurrentUserPersonalDetails from '@hooks/useCurrentUserPersonalDetails'
 import useOnyx from '@hooks/useOnyx';
 
 import {setSubmitMigrationModalShown} from '@userActions/User';
-import {setOnboardingDeeplinkIntent} from '@userActions/Welcome';
 
-import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 
 import {hasCompletedGuidedSetupFlowSelector} from '@selectors/Onboarding';
@@ -15,10 +13,10 @@ import {useEffect, useRef} from 'react';
 /**
  * Creates the Submit workspace requested by an `intent=submit` onboarding deeplink.
  *
- * The link is sent to existing users, so it deliberately skips the onboarding UI entirely rather than pre-answering
- * its questions: the workspace is created outright and the user lands wherever the "Submit to my employer" flow
- * normally leaves them. Onboarding is suppressed for the whole session by useOnboardingFlowRouter and OnboardingGuard,
- * both of which read the intent recorded here.
+ * The link is only sent to existing users, so it acts solely on recipients who have already been through guided
+ * setup: for them the workspace is created outright and they land wherever the "Submit to my employer" flow normally
+ * leaves them. Anyone who still has onboarding ahead of them is left to it untouched, since that flow already offers
+ * the Submit outcome.
  *
  * Only rendered once the deeplink has been recognised, so the Onyx subscriptions behind `useAutoCreateSubmitWorkspace`
  * are never set up for ordinary sessions.
@@ -34,30 +32,28 @@ function ApplySubmitOnboardingIntent() {
     const [isOnboardingCompleted] = useOnyx(ONYXKEYS.NVP_ONBOARDING, {selector: hasCompletedGuidedSetupFlowSelector});
     const [isSupportalSession] = useOnyx(ONYXKEYS.SESSION, {selector: isSupportalSessionSelector});
 
-    const hasCreatedWorkspace = useRef(false);
+    const hasRun = useRef(false);
 
     useEffect(() => {
-        if (isSupportalSession) {
+        if (hasRun.current || !hasLoadedApp || isOnboardingCompleted === undefined || isSupportalSession) {
             return;
         }
-        setOnboardingDeeplinkIntent(CONST.ONBOARDING_INTENTS.SUBMIT);
-    }, [isSupportalSession]);
+        hasRun.current = true;
 
-    useEffect(() => {
-        if (hasCreatedWorkspace.current || !hasLoadedApp || isOnboardingCompleted === undefined || isSupportalSession) {
+        // Recipients who never finished guided setup are left to the normal onboarding flow, which already offers
+        // the Submit outcome.
+        if (!isOnboardingCompleted) {
             return;
         }
-        hasCreatedWorkspace.current = true;
 
         // The deeplink delivers the same outcome as the Submit plan welcome modal, so record the modal as seen to
         // stop it from opening on top of the workspace we're about to create.
         setSubmitMigrationModalShown();
 
-        // Recipients who never finished guided setup still need it marked complete, otherwise they would be pulled
-        // into onboarding on their next sign-in. When the user already owns a Submit workspace,
+        // Guided setup is already done, so it must not run again. When the user already owns a Submit workspace,
         // useAutoCreateSubmitWorkspace skips creation and navigates to that workspace instead, which is what makes
         // repeat clicks of the link idempotent.
-        autoCreateSubmitWorkspace(firstName ?? '', lastName ?? '', !isOnboardingCompleted);
+        autoCreateSubmitWorkspace(firstName ?? '', lastName ?? '', false);
     }, [autoCreateSubmitWorkspace, firstName, hasLoadedApp, isOnboardingCompleted, isSupportalSession, lastName]);
 
     return null;

src/libs/Navigation/guards/OnboardingGuard.ts

@@ -5,7 +5,6 @@ import {isOnboardingFlowName} from '@libs/Navigation/helpers/isNavigatorName';
 import {getOnboardingInitialPath} from '@userActions/Welcome/OnboardingFlow';
 
 import CONFIG from '@src/CONFIG';
-import type {OnboardingIntent} from '@src/CONST';
 import CONST from '@src/CONST';
 import NAVIGATORS from '@src/NAVIGATORS';
 import ONYXKEYS from '@src/ONYXKEYS';
@@ -39,7 +38,6 @@ let hybridApp: {isSingleNewDotEntry?: boolean} | undefined;
 let onboardingPurposeSelected: OnyxEntry<OnboardingPurpose>;
 let onboardingCompanySize: OnyxEntry<OnboardingCompanySize>;
 let onboardingInitialPath: OnyxEntry<string>;
-let onboardingDeeplinkIntent: OnyxEntry<OnboardingIntent>;
 let hasNonPersonalPolicy: OnyxEntry<boolean>;
 let wasInvitedToNewDot: boolean | undefined;
 
@@ -92,14 +90,6 @@ Onyx.connectWithoutView({
     },
 });
 
-// A Submit deeplink creates the workspace outright, so the guard must not pull the user into onboarding on the way.
-Onyx.connectWithoutView({
-    key: ONYXKEYS.ONBOARDING_DEEPLINK_INTENT,
-    callback: (value) => {
-        onboardingDeeplinkIntent = value;
-    },
-});
-
 Onyx.connectWithoutView({
     key: ONYXKEYS.HAS_NON_PERSONAL_POLICY,
     callback: (value) => {
@@ -186,7 +176,6 @@ const OnboardingGuard: NavigationGuard = {
         const isMigratedUser = tryNewDot?.hasBeenAddedToNudgeMigration ?? false;
         const isSingleEntry = hybridApp?.isSingleNewDotEntry ?? false;
         const isFirstTimeHybridAppTransition = (CONFIG.IS_HYBRID_APP && tryNewDot?.isHybridAppOnboardingCompleted !== true) ?? false;
-        const hasSubmitDeeplinkIntent = onboardingDeeplinkIntent === CONST.ONBOARDING_INTENTS.SUBMIT;
         // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
         const isInvitedOrGroupMember = (hasNonPersonalPolicy || wasInvitedToNewDot) ?? false;
 
@@ -220,7 +209,6 @@ const OnboardingGuard: NavigationGuard = {
             isSingleEntry ||
             isFirstTimeHybridAppTransition ||
             isNavigatingWithReplace ||
-            hasSubmitDeeplinkIntent ||
             context.isSupportalSession ||
             // Copilots should not be pushed through onboarding on behalf of the account they are accessing
             isActingAsDelegateSelector(account);
@@ -251,7 +239,6 @@ const OnboardingGuard: NavigationGuard = {
             isFirstTimeHybridAppTransition,
             isInvitedOrGroupMember,
             isNavigatingWithReplace,
-            hasSubmitDeeplinkIntent,
         });
 
         return {

src/libs/actions/Welcome/index.ts

@@ -6,7 +6,7 @@ import Log from '@libs/Log';
 import Navigation from '@libs/Navigation/Navigation';
 
 import CONFIG from '@src/CONFIG';
-import type {OnboardingAccounting, OnboardingIntent} from '@src/CONST';
+import type {OnboardingAccounting} from '@src/CONST';
 import type {TranslationPaths} from '@src/languages/types';
 import ONYXKEYS from '@src/ONYXKEYS';
 import ROUTES from '@src/ROUTES';
@@ -52,14 +52,6 @@ function setOnboardingPurposeSelected(value: OnboardingPurpose) {
     Onyx.set(ONYXKEYS.ONBOARDING_PURPOSE_SELECTED, value ?? null);
 }
 
-/**
- * Records the onboarding outcome requested by the deeplink this session was opened with, so the onboarding flow can
- * route straight to it. Cleared once acted on, and by the Onyx wipe on sign-out.
- */
-function setOnboardingDeeplinkIntent(value: OnboardingIntent | null) {
-    Onyx.set(ONYXKEYS.ONBOARDING_DEEPLINK_INTENT, value);
-}
-
 function setOnboardingCompanySize(value: OnboardingCompanySize) {
     Onyx.set(ONYXKEYS.ONBOARDING_COMPANY_SIZE, value);
 }
@@ -225,7 +217,6 @@ export {
     onServerDataReady,
     dismissProductTraining,
     setOnboardingPurposeSelected,
-    setOnboardingDeeplinkIntent,
     updateOnboardingLastVisitedPath,
     resetAllChecks,
     setOnboardingAdminsChatReportID,