Skip to content

Create navigation guards + implement Onboarding Guard#79898

Merged
mjasikowski merged 60 commits into
Expensify:mainfrom
callstack-internal:navigation-guards
Feb 3, 2026
Merged

Create navigation guards + implement Onboarding Guard#79898
mjasikowski merged 60 commits into
Expensify:mainfrom
callstack-internal:navigation-guards

Conversation

@TMisiukiewicz

@TMisiukiewicz TMisiukiewicz commented Jan 19, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Fixed Issues

$ #79974
PROPOSAL:

Tests

  1. Create fresh account
  2. Verify you are navigated to onboarding
  3. Go through entire onboarding
  4. Verify the test drive modal appears

  1. Create fresh account
  2. Verify you are navigated to onboarding
  3. Close the app
  4. Web: Open https://dev.new.expensify.com:8082/workspaces
  5. iOS: run xcrun simctl openurl booted "new-expensify://workspaces" in terminal
  6. Android: run adb shell am start -W -a android.intent.action.VIEW -d "new-expensify://workspaces"
  7. Verify you are redirected to the onboarding

  1. Create fresh account
  2. Verify you are navigated to onboarding
  3. Do the first step of the onboarding
  4. Close the app
  5. Web: Open https://dev.new.expensify.com:8082/workspaces
  6. iOS: run xcrun simctl openurl booted "new-expensify://workspaces" in terminal
  7. Android: run adb shell am start -W -a android.intent.action.VIEW -d "new-expensify://workspaces"
  8. Verify you are redirected to the last visited onboarding step

  1. Create fresh account
  2. Verify you are navigated to onboarding
  3. Do the first step of the onboarding
  4. Close the app
  5. Web: Open https://dev.new.expensify.com:8082/onboarding/purpose
  6. iOS: run xcrun simctl openurl booted "new-expensify://onboarding/purpose" in terminal
  7. Android: run adb shell am start -W -a android.intent.action.VIEW -d "new-expensify://onboarding/purpose"
  8. Verify you are redirected to the personal details step

  1. Create fresh account
  2. Verify you are navigated to onboarding
  3. Go through entire onboarding
  4. In the console:
Onyx.set("nvp_tryNewDot", {classicRedirect: {dismissed: false}, nudgeMigration: {timestamp: 
"2025-12-10 01:35:12", cohort: "test"}});
  1. Reopen the app
  2. Verify you are navigated to "Welcome to New Expensify" modal
  • Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
Same as tests

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
android.mov
Android: mWeb Chrome
iOS: Native
ios.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari
web.mov

@codecov

codecov Bot commented Jan 19, 2026

Copy link
Copy Markdown

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/hooks/useOnboardingFlow.ts 88.00% <100.00%> (+0.90%) ⬆️
src/libs/Navigation/NavigationRoot.tsx 79.54% <ø> (-0.67%) ⬇️
src/libs/Navigation/guards/OnboardingGuard.ts 100.00% <100.00%> (ø)
src/libs/Navigation/guards/index.ts 100.00% <100.00%> (ø)
src/libs/actions/Link.ts 22.70% <100.00%> (-0.62%) ⬇️
src/libs/actions/Welcome/index.ts 40.67% <ø> (-1.75%) ⬇️
src/Expensify.tsx 84.40% <50.00%> (-0.41%) ⬇️
...igator/createRootStackNavigator/RootStackRouter.ts 73.68% <47.05%> (-5.17%) ⬇️
... and 11 files with indirect coverage changes

Comment thread src/libs/Navigation/guards/TwoFactorAuthGuard.ts Outdated
@TMisiukiewicz TMisiukiewicz marked this pull request as ready for review January 21, 2026 13:34
@TMisiukiewicz TMisiukiewicz requested review from a team as code owners January 21, 2026 13:34
@melvin-bot melvin-bot Bot requested review from eh2077 and joekaufmanexpensify and removed request for a team January 21, 2026 13:34
@melvin-bot

melvin-bot Bot commented Jan 21, 2026

Copy link
Copy Markdown

@eh2077 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

Comment thread src/hooks/useGuardedNavigationState.ts Outdated
Comment thread src/libs/Navigation/guards/TwoFactorAuthGuard.ts Outdated
Comment thread src/libs/Navigation/guards/index.ts
@mountiny

mountiny commented Feb 2, 2026

Copy link
Copy Markdown
Contributor

@TMisiukiewicz conflicts

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 282d6fff38

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/libs/Navigation/guards/OnboardingGuard.ts
@mountiny

mountiny commented Feb 2, 2026

Copy link
Copy Markdown
Contributor

Code Review Summary

I've done a thorough review of this PR. The Navigation Guards architecture is well-designed and provides a clean, extensible pattern. Here are the key issues I identified:


Critical Issues

1. Missing Authentication Check in OnboardingGuard

The guard doesn't check context.isAuthenticated before deciding to redirect to onboarding:

const shouldSkipOnboarding = context.isLoading || isTransitioning || isOnboardingCompleted || isMigratedUser || isSingleEntry || needsExplanationModal || isInvitedOrGroupMember;

The original code in NavigationRoot.tsx had an authenticated check:

if (!CONFIG.IS_HYBRID_APP && !hasNonPersonalPolicy && !isOnboardingCompleted && !wasInvitedToNewDot && authenticated) {

Risk: Unauthenticated users could potentially be redirected to onboarding screens.

Recommendation: Add !context.isAuthenticated to shouldSkipOnboarding conditions.


2. Test Drive Modal Deep Link Bypass

The OnboardingGuard only checks hasCompletedGuidedSetupFlowSelector, which returns true even when testDriveModalDismissed === false.

The temporary workaround in useOnboardingFlow.ts handles this for normal app flow:

// Temporary solution to navigate to onboarding when trying to access the app
// Should be removed once Test Drive modal route has its own navigation guard
if (hasCompletedGuidedSetupFlowSelector(onboardingValues) && onboardingValues?.testDriveModalDismissed === false) {

Risk: Users who completed onboarding but haven't dismissed the test drive modal could bypass it via deep links that don't go through useOnboardingFlow.

Recommendation: Either factor testDriveModalDismissed into the guard's completion check, or ensure the Test Drive Modal guard is implemented before this PR merges.


3. Verify BLOCK Result Works with syncBrowserHistory

The shouldPreventReset function now returns a BLOCK result which triggers syncBrowserHistory(state). This was originally introduced in PR #50719 to handle browser back button behavior on onboarding screens.

Recommendation: Manually verify the test plan from #50719 still works:

  1. Start onboarding flow
  2. Navigate to purpose selection
  3. Press browser back button
  4. Should show error toast and stay on onboarding (not navigate away)

Overall Assessment

The architecture is solid and will make it easier to add future navigation guards. The code reduction (~100+ lines removed) and centralization of logic is a clear improvement. The issues above should be addressed before merge to prevent regressions.

@TMisiukiewicz

Copy link
Copy Markdown
Contributor Author

The guard doesn't check context.isAuthenticated before deciding to redirect to onboarding:

No need to do that because guards are being called in AuthScreens, which are conditionally rendered inside AppNavigator only when user is authenticated

The OnboardingGuard only checks hasCompletedGuidedSetupFlowSelector, which returns true even when testDriveModalDismissed === false.

test drive modal will be a separate guard (next one right after merging that). This PR covers the temporary logic to display it, tested above

The shouldPreventReset function now returns a BLOCK result which triggers syncBrowserHistory(state). This was originally introduced in PR #50719 to handle browser back button behavior on onboarding screens.

Verified it, works fine

conflicts resolved ✅

@eh2077

eh2077 commented Feb 2, 2026

Copy link
Copy Markdown
Contributor

nice! reviewing this, will update in an hour or two

@eh2077

eh2077 commented Feb 2, 2026

Copy link
Copy Markdown
Contributor

Bug: onboarding step test-drive isn't guarded

  1. login with new account
  2. complete onboarding and stop at the last step, /onboarding/test-drive
  3. navigate to https://dev.new.expensify.com:8082/workspaces
  4. app navigates to workspace page instead of redirecting to onboarding test-drive

@TMisiukiewicz hmm, it works on web but native app

Screen.Recording.2026-02-02.at.6.08.59.PM.mov

@eh2077

eh2077 commented Feb 2, 2026

Copy link
Copy Markdown
Contributor

Bug: mobile browser - test-drive modal pops up twice when redirect from workspaces page

  1. login with a new account
  2. complete onboarding step till test-drive
  3. navigate to workspaces by editing url
  4. the page is redirect to test-drive but it shows up twice
This PR Staging
Screen.Recording.2026-02-02.at.6.22.40.PM.mov
Screen.Recording.2026-02-02.at.6.24.54.PM.mov

@TMisiukiewicz

Copy link
Copy Markdown
Contributor Author

@TMisiukiewicz hmm, it works on web but native app

hmm looks like the same thing happens on main 👀

Screen.Recording.2026-02-02.at.11.35.15.mov

@TMisiukiewicz

Copy link
Copy Markdown
Contributor Author

Bug: mobile browser - test-drive modal pops up twice when redirect from workspaces page

  1. login with a new account
  2. complete onboarding step till test-drive
  3. navigate to workspaces by editing url
  4. the page is redirect to test-drive but it shows up twice

Hmm interesting, I tried a couple of times but I couldn't reproduce it 👀

ios.res.mov

@eh2077

eh2077 commented Feb 2, 2026

Copy link
Copy Markdown
Contributor

I see, I can't reproduce either.

Screen.Recording.2026-02-02.at.7.04.35.PM.mov

@eh2077 eh2077 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from #79898 (comment), then all good!

@melvin-bot melvin-bot Bot requested a review from mjasikowski February 2, 2026 11:11
@mjasikowski

Copy link
Copy Markdown
Contributor

Since the bug mentioned doesn't seem to be strictly related to this PR, I'll continue with merging

@mjasikowski mjasikowski merged commit bcfa7b4 into Expensify:main Feb 3, 2026
31 checks passed
@OSBotify

OSBotify commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify

OSBotify commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mjasikowski in version: 9.3.11-25 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 failure ❌
🍎 iOS 🍎 success ✅

@m-natarajan

Copy link
Copy Markdown

@mjasikowski @TMisiukiewicz Could this please be tested internally? The QA team is unable to validate it on native devices, as it requires running logs in the terminal or any workaround for this?

@TMisiukiewicz

Copy link
Copy Markdown
Contributor Author

@m-natarajan yup I think it might be difficult to test deep link scenarios for QAs unless they have Android and iOS environment set up and able to connect the native devices with macbook

@OSBotify

OSBotify commented Feb 5, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.3.12-1 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 failure ❌

@sobitneupane

Copy link
Copy Markdown
Contributor

This PR introduced the following issue:

The problem occurs because this PR adds an onboarding guard, which unintentionally blocks the deeplink navigation during login

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.