Skip to content

Add NAVIGATORS.WORKSPACE_NAVIGATOR#86438

Open
WojtekBoman wants to merge 7 commits intoExpensify:mainfrom
software-mansion-labs:workspaces-navigator
Open

Add NAVIGATORS.WORKSPACE_NAVIGATOR#86438
WojtekBoman wants to merge 7 commits intoExpensify:mainfrom
software-mansion-labs:workspaces-navigator

Conversation

@WojtekBoman
Copy link
Copy Markdown
Contributor

@WojtekBoman WojtekBoman commented Mar 26, 2026

Explanation of Change

Previously, the Workspaces tab was modelled using three separate root-level screens/navigators pushed onto the root stack independently:

Old structure What it represents
SCREENS.WORKSPACES_LIST The workspace hub / list page
NAVIGATORS.WORKSPACE_SPLIT_NAVIGATOR A single workspace settings view
NAVIGATORS.DOMAIN_SPLIT_NAVIGATOR A single domain settings view

This caused a number of issues:

  • There was no genuine back stack: going from WorkspaceSplitNavigator → "back" to WorkspacesList required custom goBack logic, and on iOS the swipe gesture didn't work correctly because the list wasn't underneath the split navigator in the same stack.
  • Session-storage restoration of the last-visited tab route was fragile — it had to scan multiple disconnected routes to reconstruct context.
  • The entering animation of WorkspaceSplitNavigator was controlled by a mutable Set (workspaceOrDomainSplitsWithoutEnteringAnimation) which was shared global state and had to be cleaned up manually.
  • Deep-link / getAdaptedStateFromPath handling required special-cased logic to prepend WORKSPACES_LIST before workspace split navigators.

This PR introduces NAVIGATORS.WORKSPACE_NAVIGATOR, a dedicated persistent stack navigator that owns the full Workspaces tab hierarchy:

WorkspaceNavigator (root-level persistent screen)
  └── WorkspacesList          ← always at index 0 (back-stack base)
  └── WorkspaceSplitNavigator ← pushed when entering a specific workspace
  └── DomainSplitNavigator    ← pushed when entering a specific domain

This change is a prerequisite for #85234 — Root Tab Navigator, which introduces a bottom tab navigator for top-level navigation. Consolidating the Workspaces tab into a single persistent WorkspaceNavigator is a necessary step before that navigator can be treated as a first-class tab in the tab structure.

Fixed Issues

#85260 (partial)
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
Prerequisites
  • A test account with at least one workspace and one domain (or use the staging environment which has pre-configured workspaces).
1. Workspaces List page renders correctly
  1. Log in to the app.
  2. Click the Workspaces tab in the bottom/left navigation bar.
  3. Expected: The Workspaces List page loads and displays your workspaces.
  4. Check the URL (web): it should be /workspaces.

2. Navigating into a workspace and back
  1. On the Workspaces List page, tap/click any workspace row.
  2. Expected (wide screen): The workspace settings split view opens to the right of the list — no animation, list stays visible in the sidebar.
  3. Expected (narrow screen): The workspace settings screen slides in from the right with a SLIDE_FROM_RIGHT animation.
  4. Press the back button (or swipe from left edge on iOS).
  5. Expected: You are returned to the Workspaces List page.
  6. Check the URL (web, wide): it should change to e.g. /workspaces/:policyID/overview.

3. iOS swipe-back gesture from workspace to list
  1. On a narrow (mobile/iOS) screen, navigate into a workspace (step 2 above).
  2. Swipe from the left edge of the screen.
  3. Expected: The WorkspacesListPage is revealed underneath — the swipe gesture works correctly because the list is now part of the same stack.

4. Navigating into a domain and back
  1. On the Workspaces List page, tap a domain row (if available).
  2. Expected (narrow): Domain screen slides in from right.
  3. Press back.
  4. Expected: Returns to Workspaces List.

5. Tab switching preserves workspace state
  1. Navigate into a workspace (e.g., go to the Members screen).
  2. Switch to a different tab (e.g., Inbox).
  3. Switch back to the Workspaces tab.
  4. Expected: The same workspace screen (Members) is still visible — the navigator state is preserved.

6. Deep linking to a workspace screen
  1. Navigate directly to a workspace URL, e.g. /workspaces/:policyID/members.
  2. Expected: The app opens with WorkspaceNavigator on the stack, showing the Members screen, with WorkspacesList underneath in the back stack.
  3. Press back.
  4. Expected: Returns to WorkspacesList.

7. Deep linking to the workspaces list
  1. Navigate directly to /workspaces.
  2. Expected: The Workspaces List page is shown.
  3. No back button / no stale route underneath.

8. Session storage restoration after reload
  1. Navigate to a specific workspace screen (e.g., /workspaces/:policyID/tags).
  2. Hard-reload the page (web) or force-close and reopen the app (mobile).
  3. Expected: The app re-opens to the same workspace tags screen.
  4. Press back.
  5. Expected: Returns to WorkspacesList.

9. Tab bar highlight
  1. Navigate to the Workspaces tab.
  2. Open a specific workspace.
  3. Expected: The Workspaces icon in the bottom/left navigation tab bar remains highlighted/active throughout.

Offline tests

QA Steps

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 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
Screen.Recording.2026-03-27.at.10.16.17.mov
Android: mWeb Chrome
Screen.Recording.2026-03-27.at.11.11.14.mov
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2026-03-27.at.10.39.16.mov

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 26, 2026

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 Δ
...avigationTabBar/SCREENS_WITH_NAVIGATION_TAB_BAR.ts 100.00% <100.00%> (ø)
src/libs/Navigation/AppNavigator/AuthScreens.tsx 82.95% <100.00%> (+1.90%) ⬆️
...n/AppNavigator/Navigators/DomainSplitNavigator.tsx 0.00% <ø> (ø)
...ppNavigator/Navigators/WorkspaceSplitNavigator.tsx 0.00% <ø> (ø)
src/libs/Navigation/NavigationRoot.tsx 76.92% <100.00%> (ø)
...ibs/Navigation/helpers/navigateToWorkspacesPage.ts 80.00% <100.00%> (ø)
...ation/linkingConfig/RELATIONS/TAB_TO_FULLSCREEN.ts 100.00% <ø> (ø)
src/libs/Navigation/linkingConfig/config.ts 76.92% <ø> (ø)
src/pages/workspace/WorkspacesListPage.tsx 72.00% <ø> (-0.67%) ⬇️
...ion/AppNavigator/usePreloadFullScreenNavigators.ts 0.00% <0.00%> (-14.93%) ⬇️
... and 8 more
... and 226 files with indirect coverage changes

@WojtekBoman WojtekBoman force-pushed the workspaces-navigator branch from cb8cc63 to 1c3e00b Compare March 27, 2026 06:58
@WojtekBoman WojtekBoman force-pushed the workspaces-navigator branch from 1c3e00b to 9ab0bdb Compare March 27, 2026 08:15
Copy link
Copy Markdown
Contributor

@sumo-slonik sumo-slonik left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

if (lastFullScreenRoute?.key) {
// If the user opened the workspace/domain split navigator from a different tab, we don't want to animate the entering transition.
// To make it feel like bottom tab navigator.
workspaceOrDomainSplitsWithoutEnteringAnimation.add(lastFullScreenRoute.key);
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.

When entering the workspace from another screen, is the animation no longer shown? I think it should behave like the other tab navigators and not show it, but I just wanted to make sure

Copy link
Copy Markdown
Contributor Author

@WojtekBoman WojtekBoman Mar 27, 2026

Choose a reason for hiding this comment

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

Currently it's nested in WorkspaceNavigator so we simplified this logic a lot, a now this screen has its own animation, when we switch between tabs it's not animated as WorkspaceNavigator doesn't have an entering animation

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.

I think we no longer use this set

import SCREENS from '@src/SCREENS';

const FULL_SCREENS_SET = new Set([...Object.values(SIDEBAR_TO_SPLIT), NAVIGATORS.SEARCH_FULLSCREEN_NAVIGATOR, SCREENS.WORKSPACES_LIST, SCREENS.HOME]);
const FULL_SCREENS_SET = new Set([...Object.values(SIDEBAR_TO_SPLIT), NAVIGATORS.SEARCH_FULLSCREEN_NAVIGATOR, SCREENS.WORKSPACES_LIST, SCREENS.HOME, NAVIGATORS.WORKSPACE_NAVIGATOR]);
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.

do we need SCREENS.WORKSPACES_LIST int this place

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I believe we do! It's still a full screen page, but nested. We'll refactor it in #85234

}
navigation.preload(SCREENS.WORKSPACES_LIST, {});
}
// Currently the Account tab is preloaded, while Search and Inbox are not preloaded due to their potential complexity.
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.

I think we can just write that we simply preload the settings page, and the others are no longer needed due to updates and the architect, especially since the root tab navigator will be introduced soon.

@WojtekBoman WojtekBoman changed the title Workspaces navigator Add NAVIGATORS.WORKSPACE_NAVIGATOR Mar 27, 2026
@WojtekBoman WojtekBoman marked this pull request as ready for review March 27, 2026 13:49
@WojtekBoman WojtekBoman requested review from a team as code owners March 27, 2026 13:49
@melvin-bot melvin-bot bot requested review from Gonals and trjExpensify and removed request for a team March 27, 2026 13:50
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Mar 27, 2026

@Gonals 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]

Copy link
Copy Markdown

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

Choose a reason for hiding this comment

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

💡 Codex Review

const adjustedState = getStateWithFilteredPreloadedRoutes(state, navigatorName, targetScreen);
const stateWithNavigator = stackRouter.getStateForAction(adjustedState, action, configOptions);

P1 Badge Preserve WorkspacesList as base on generic workspace pushes

handlePushFullscreenAction() now forwards generic PUSH actions unchanged, so navigation paths like Navigation.navigate(ROUTES.WORKSPACE_INITIAL...) (for example from WorkspaceJoinUserPage) can create WORKSPACE_NAVIGATOR with only a split child and no SCREENS.WORKSPACES_LIST underneath. The new navigator design assumes the list is always the base route, and without it iOS back-swipe/back from workspace/domain screens can pop out of the tab instead of returning to Workspaces List. Please inject/rehydrate [WORKSPACES_LIST, <split>] for WORKSPACE_NAVIGATOR pushes, not only for OPEN_WORKSPACE_SPLIT / OPEN_DOMAIN_SPLIT and deep-link adaptation.

ℹ️ 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".

@luacmartins luacmartins requested review from ZhenjaHorbach and removed request for Gonals March 27, 2026 15:57
@ZhenjaHorbach
Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (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
    • 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 verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • 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
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • 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 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

@ZhenjaHorbach
Copy link
Copy Markdown
Contributor

Looks like it's related to our changes
But I have visual glitches after opening the domain screen

2026-03-27.17.20.30.mov

@ZhenjaHorbach
Copy link
Copy Markdown
Contributor

On the domain members screen
The back button doesn't work on iOS web

2026-03-27.17.37.18.mov

@ZhenjaHorbach
Copy link
Copy Markdown
Contributor

ZhenjaHorbach commented Mar 27, 2026

For some reason, the bottom menu appears with a delay after opening the create domain screen and returning back
And everything is good with staging

But with the create workspace screen is the same situation

2026-03-27.17.41.35.mov

@trjExpensify
Copy link
Copy Markdown
Contributor

PR doesn’t need product input as a refactor PR. Unassigning and unsubscribing myself.

@trjExpensify trjExpensify removed their request for review March 27, 2026 20:08
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.

4 participants