Repository navigation
Add a one-click deeplink that signs the user in and creates a Submit workspace #98887
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
72e106e
1bf9098
06e18f0
f843d86
8b21e71
3215c16
7fad41a
8bb0054
22db33d
f1887b4
fca471c
120ac22
a6e5615
418fd88
4273e1d
e83da96
b8a894a
d601473
dbf9613
520bc99
5c0c745
cc7a9a7
516d703
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| import {useInitialURLState} from '@components/InitialURLContextProvider'; | ||
|
|
||
| import getCurrentUrl from '@libs/Navigation/currentUrl'; | ||
| import {getRouteFromLink} from '@libs/ReportUtils'; | ||
| import {getSearchParamFromPath} from '@libs/Url'; | ||
|
|
||
| import type {OnboardingIntent} from '@src/CONST'; | ||
| import CONST from '@src/CONST'; | ||
| import ROUTES from '@src/ROUTES'; | ||
|
|
||
| import {useState} from 'react'; | ||
|
|
||
| function isOnboardingIntent(value: string | null): value is OnboardingIntent { | ||
| return !!value && Object.values<string>(CONST.ONBOARDING_INTENTS).includes(value); | ||
| } | ||
|
|
||
| // Matching on the boundary rather than the prefix keeps sibling routes like `onboarding/work-email` out. | ||
| function isOnboardingPath(path: string | null): path is string { | ||
| return path === ROUTES.ONBOARDING_ROOT.route || !!path?.startsWith(`${ROUTES.ONBOARDING_ROOT.route}?`); | ||
| } | ||
|
|
||
| /** | ||
| * Reads the `intent` param of the onboarding deeplink (e.g. `onboarding?intent=submit`). | ||
| * | ||
| * It arrives either directly, or nested in the `exitTo` of a transition or magic link. Nesting it in `exitTo` is what | ||
| * carries the intent across the logged-out to logged-in transition, since the deeplink outlives the sign-in itself. | ||
| */ | ||
| function getOnboardingIntentFromUrl(url: string | null | undefined): OnboardingIntent | undefined { | ||
| if (!url) { | ||
| return undefined; | ||
| } | ||
|
|
||
| // getRouteFromLink strips whichever linking-config prefix matched, so web URLs, the desktop `app://-/` origin and | ||
| // the native scheme all reduce to the same route. It leaves the leading slash on in-app paths. | ||
| const pathWithQuery = getRouteFromLink(url).replace(/^\/+/, ''); | ||
| const onboardingPathWithQuery = isOnboardingPath(pathWithQuery) ? pathWithQuery : getSearchParamFromPath(pathWithQuery, 'exitTo'); | ||
|
|
||
| if (!isOnboardingPath(onboardingPathWithQuery)) { | ||
| return undefined; | ||
| } | ||
|
|
||
| const intent = getSearchParamFromPath(onboardingPathWithQuery, 'intent'); | ||
| return isOnboardingIntent(intent) ? intent : undefined; | ||
| } | ||
|
|
||
| /** | ||
| * Resolves the onboarding outcome requested by the deeplink this session was opened with, e.g. `onboarding?intent=submit`. | ||
| * | ||
| * Two sources because neither covers both platforms. On web the link is in the address bar, but only until the app | ||
| * navigates and rewrites it, hence latching at mount. On native there is no address bar, so it arrives instead through | ||
| * the initial-URL context. Links opened while the app is already running reach neither, so they are not supported. | ||
| */ | ||
| function useOnboardingDeeplinkIntent(): OnboardingIntent | undefined { | ||
| const {initialURL} = useInitialURLState(); | ||
| const [urlAtMount] = useState(getCurrentUrl); | ||
|
|
||
| return getOnboardingIntentFromUrl(urlAtMount) ?? getOnboardingIntentFromUrl(initialURL); | ||
|
MelvinBot marked this conversation as resolved.
Resolved
abzokhattab marked this conversation as resolved.
Resolved
|
||
| } | ||
|
|
||
| export default useOnboardingDeeplinkIntent; | ||
| export {getOnboardingIntentFromUrl}; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| import useAutoCreateSubmitWorkspace from '@hooks/useAutoCreateSubmitWorkspace'; | ||
| import useCurrentUserPersonalDetails from '@hooks/useCurrentUserPersonalDetails'; | ||
| import useOnyx from '@hooks/useOnyx'; | ||
|
|
||
| import {releaseWelcomeModalForSubmitDeeplink, suppressWelcomeModalForSubmitDeeplink} from '@libs/Navigation/guards/SubmitPlanWelcomeModalGuard'; | ||
| import {getGroupPoliciesWhereReportCanBeCreated} from '@libs/PolicyUtils'; | ||
|
|
||
| import {setSubmitMigrationModalShown} from '@userActions/User'; | ||
|
|
||
| import ONYXKEYS from '@src/ONYXKEYS'; | ||
|
|
||
| import {hasCompletedGuidedSetupFlowSelector} from '@selectors/Onboarding'; | ||
| import {emailSelector, isSupportalSessionSelector} from '@selectors/Session'; | ||
| import {useEffect} from 'react'; | ||
|
|
||
| // Module scope rather than a ref so it survives a remount: the initial URL outlives sign-out, so signing into a second | ||
| // account would otherwise replay the intent and create that account a workspace it never asked for. | ||
| let hasAppliedIntent = false; | ||
|
|
||
| /** | ||
| * Creates the Submit workspace requested by an `intent=submit` onboarding deeplink. | ||
| * | ||
| * The link only goes to existing users, so it acts solely on recipients who have finished guided setup. Anyone who | ||
| * still has onboarding ahead of them is left to it, since that flow already offers the Submit outcome. | ||
| */ | ||
| function ApplySubmitOnboardingIntent() { | ||
| const {firstName, lastName} = useCurrentUserPersonalDetails(); | ||
| const autoCreateSubmitWorkspace = useAutoCreateSubmitWorkspace(); | ||
|
|
||
| // Waiting on HAS_LOADED_APP keeps the eligibility checks inside useAutoCreateSubmitWorkspace from running | ||
| // against a half-populated store, where they would miss an existing workspace and create a duplicate. | ||
| const [hasLoadedApp] = useOnyx(ONYXKEYS.HAS_LOADED_APP); | ||
| const [isOnboardingCompleted] = useOnyx(ONYXKEYS.NVP_ONBOARDING, {selector: hasCompletedGuidedSetupFlowSelector}); | ||
| const [isSupportalSession] = useOnyx(ONYXKEYS.SESSION, {selector: isSupportalSessionSelector}); | ||
| const [currentUserEmail] = useOnyx(ONYXKEYS.SESSION, {selector: emailSelector}); | ||
|
|
||
| // Plain membership counts here, unlike the admin-level check inside useAutoCreateSubmitWorkspace, which would | ||
| // hand a personal Submit workspace to someone who can already submit on their employer's. | ||
| const [belongsToWorkspaceForReports] = useOnyx(ONYXKEYS.COLLECTION.POLICY, { | ||
| selector: (policies) => getGroupPoliciesWhereReportCanBeCreated(policies, currentUserEmail).length > 0, | ||
| }); | ||
|
|
||
| // At mount, ahead of the work below that waits on HAS_LOADED_APP — the same signal that opens the guard's modal. | ||
| useEffect(() => { | ||
| suppressWelcomeModalForSubmitDeeplink(); | ||
| }, []); | ||
|
|
||
| useEffect(() => { | ||
| if (hasAppliedIntent || !hasLoadedApp || isOnboardingCompleted === undefined) { | ||
| return; | ||
| } | ||
| hasAppliedIntent = true; | ||
|
|
||
| // Marked applied above before these checks, since they are reasons to drop the intent rather than to wait for | ||
| // it to become actionable. Returning without consuming would leave it live for whoever signs in next. | ||
| if (!isOnboardingCompleted || isSupportalSession || belongsToWorkspaceForReports) { | ||
| releaseWelcomeModalForSubmitDeeplink(); | ||
| return; | ||
| } | ||
|
|
||
| // Persists the suppression applied above, so the modal stays away in later sessions too. | ||
| setSubmitMigrationModalShown(); | ||
|
|
||
| // `false` skips CompleteGuidedSetup, which is already done. | ||
| autoCreateSubmitWorkspace(firstName ?? '', lastName ?? '', false); | ||
|
abzokhattab marked this conversation as resolved.
Resolved
|
||
| }, [autoCreateSubmitWorkspace, belongsToWorkspaceForReports, firstName, hasLoadedApp, isOnboardingCompleted, isSupportalSession, lastName]); | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| export default ApplySubmitOnboardingIntent; | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,22 @@ | ||||||||||||||||||||||||||||||
| import useOnboardingDeeplinkIntent from '@hooks/useOnboardingDeeplinkIntent'; | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| import CONST from '@src/CONST'; | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| import React from 'react'; | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| import ApplySubmitOnboardingIntent from './ApplySubmitOnboardingIntent'; | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||||||||
| * Recognizes the `intent=submit` onboarding deeplink and hands off to the component that acts on it. | ||||||||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||||||||
| function SubmitIntentDeeplinkHandler() { | ||||||||||||||||||||||||||||||
| const onboardingDeeplinkIntent = useOnboardingDeeplinkIntent(); | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| if (onboardingDeeplinkIntent !== CONST.ONBOARDING_INTENTS.SUBMIT) { | ||||||||||||||||||||||||||||||
| return null; | ||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| return <ApplySubmitOnboardingIntent />; | ||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||
|
Comment on lines
+12
to
+20
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @MelvinBot What's the current logic to handle all deeplink nowaday in App? Do we really need to create a specific one here for submit?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Short answer: the component isn't bespoke — it's the fourth sibling of an established pattern. The URL is the problem. Current deeplink handling, in three layers
Why the PR couldn't just reuse oneI checked the four obvious candidates:
The one thing worth pushing on
The catch: the CONST comment says these values are "embedded in emails we can't redeploy". Two smaller notesThe component pattern is fine. Even if the route stays, the modal race can be fixed structurally. The Also worth knowing: guards only run on navigation actions, never on cold-start initial state, which is why both welcome-modal guards need a second Onyx-driven "proactive" path.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good question — the closest existing machinery is The bigger blocker is that Submit creation is a hook ( The split into two files is deliberate for the same reason: what do you think @MelvinBot
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. All four Your The split is mandatory, not stylistic. Rules of Hooks forbid conditional hook calls, so gating that hook tree requires a second component — the only real question is one file or two. And the cost avoided is bigger than "heavy": 23 transitive Correcting myself on the dedicated route. I oversold it. The deletion list is two files plus What I'd still put to you. Two of your last five commits are the argument I was reaching for: reverting warm-link support, and fixing So the deciding input is still the one from my last comment, and it's unanswered: is the emailed URL locked yet? If it isn't, there's a cheaper option nobody has costed — Claim-by-claim verification, plus one thing to check before merge
Worth checking before merge: |
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| export default SubmitIntentDeeplinkHandler; | ||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| import {getOnboardingIntentFromUrl} from '@hooks/useOnboardingDeeplinkIntent'; | ||
|
|
||
| import CONST from '@src/CONST'; | ||
|
|
||
| describe('getOnboardingIntentFromUrl', () => { | ||
| const encodedOnboardingRoute = encodeURIComponent('onboarding?intent=submit'); | ||
|
|
||
| it('reads the intent from a direct onboarding link', () => { | ||
| expect(getOnboardingIntentFromUrl('https://new.expensify.com/onboarding?intent=submit')).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it('reads the intent from a custom scheme link, where the route sits where a host would', () => { | ||
| expect(getOnboardingIntentFromUrl('new-expensify://onboarding?intent=submit')).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it('reads the intent from a custom scheme link with a placeholder host', () => { | ||
| expect(getOnboardingIntentFromUrl('app://-/onboarding?intent=submit')).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it('reads the intent from the exitTo of a custom scheme magic link', () => { | ||
| expect(getOnboardingIntentFromUrl(`new-expensify://v/12345/678910?exitTo=${encodedOnboardingRoute}`)).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it('reads the intent from a link served on a port, as the dev server does', () => { | ||
| expect(getOnboardingIntentFromUrl('https://dev.new.expensify.com:8082/onboarding?intent=submit')).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it('reads the intent from an in-app path without an origin', () => { | ||
| expect(getOnboardingIntentFromUrl('/onboarding?intent=submit')).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| // HybridApp hands NewDot the deeplink as a bare path rather than a full URL, which is the shape the emailed | ||
| // magic link arrives in on mobile. | ||
| it('reads the intent from the exitTo of a magic link passed as a bare path', () => { | ||
| expect(getOnboardingIntentFromUrl(`v/12345/678910?exitTo=${encodedOnboardingRoute}`)).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it('reads the intent from the exitTo of an OldDot transition link', () => { | ||
| const url = `https://new.expensify.com/transition?email=${encodeURIComponent('me@example.com')}&shortLivedAuthToken=abc123&exitTo=${encodedOnboardingRoute}`; | ||
|
|
||
| expect(getOnboardingIntentFromUrl(url)).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it('reads the intent from the exitTo of a magic link', () => { | ||
| const url = `https://new.expensify.com/v/12345/678910?exitTo=${encodedOnboardingRoute}`; | ||
|
|
||
| expect(getOnboardingIntentFromUrl(url)).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it('reads the intent from an unencoded exitTo, which OldDot mobile does not encode', () => { | ||
| const url = 'https://new.expensify.com/transition?shortLivedAuthToken=abc123&exitTo=onboarding?intent=submit'; | ||
|
|
||
| expect(getOnboardingIntentFromUrl(url)).toBe(CONST.ONBOARDING_INTENTS.SUBMIT); | ||
| }); | ||
|
|
||
| it.each([ | ||
| ['no url', undefined], | ||
| ['an empty url', ''], | ||
| ['an onboarding link without an intent', 'https://new.expensify.com/onboarding'], | ||
| ['an unknown intent value', 'https://new.expensify.com/onboarding?intent=notARealIntent'], | ||
| ['an intent on a non-onboarding route', 'https://new.expensify.com/settings/profile?intent=submit'], | ||
| ['an intent on a route that merely starts with onboarding', 'https://new.expensify.com/onboarding/work-email?intent=submit'], | ||
| ['an intent on a non-onboarding exitTo', `https://new.expensify.com/transition?exitTo=${encodeURIComponent('workspace/new?intent=submit')}`], | ||
| ])('returns undefined for %s', (_description, url) => { | ||
| expect(getOnboardingIntentFromUrl(url)).toBeUndefined(); | ||
| }); | ||
| }); |
Uh oh!
There was an error while loading. Please reload this page.