Skip to content

Fix SAML cancel leaving sign-in page without email field#88760

Merged
grgia merged 6 commits intomainfrom
claude-fixSAMLCancelSignInState
Apr 28, 2026
Merged

Fix SAML cancel leaving sign-in page without email field#88760
grgia merged 6 commits intomainfrom
claude-fixSAMLCancelSignInState

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

@MelvinBot MelvinBot commented Apr 25, 2026

Explanation of Change

When a SAML-required user closes the browser without completing login, the app navigates back to SignInPage but shows only the background animation with no email field. This happens because the cancel and error paths in SAMLSignInPage/index.native.tsx call Navigation.goBack() without first clearing sign-in data, leaving credentials.login set and preventing any form from rendering.

This fix adds clearSignInData() before Navigation.goBack() in both the cancel path (response.type !== 'success') and the .catch handler, matching the existing back button and error handler patterns already in the same file. Also wraps Navigation.goBack() in Navigation.isNavigationReady().then() for consistency with those same patterns.

Fixed Issues

$ #88206
PROPOSAL: #88206 (comment)

Tests

Precondition: SAML requirement for login is enabled on OD.

  1. Launch Expensify app.
  2. Enter applausetester@applause.expensifail.com on email field.
  3. Tap Continue.
  4. Tap close button on the browser.
  5. Verify the app returns to the login page with the email field visible.
  6. Verify that no errors appear in the JS console.

Offline tests

N/A - This fix addresses SAML sign-in browser cancellation, which requires an active network connection to initiate.

QA Steps

Precondition: SAML requirement for login is enabled on OD.

  1. Launch Expensify app.
  2. Enter applausetester@applause.expensifail.com on email field.
  3. Tap Continue.
  4. Tap close button on the browser.
  5. Verify the app returns to the login page with the email field visible.
  6. 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

When a SAML-required user closes the browser without completing login,
the cancel and error paths now call clearSignInData() before navigating
back, matching the existing back button behavior. This ensures
SignInPage correctly shows the email field instead of a blank page.

Co-authored-by: Vinh Hoang <hoangzinh@users.noreply.github.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 25, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/pages/signin/SAMLSignInPage/index.native.tsx 0.00% <0.00%> (ø)
... and 203 files with indirect coverage changes

@hoangzinh
Copy link
Copy Markdown
Contributor

@MelvinBot make this PR ready

@hoangzinh
Copy link
Copy Markdown
Contributor

@MelvinBot copy this into QA tests

Precondition:

SAML requirement for login is enabled on OD.

  1. Launch Expensify app.
  2. Enter applausetester@applause.expensifail.com on email field
  3. Tap Continue.
  4. Tap close button on the browser.
  5. App will return to login page with email field.

@hoangzinh
Copy link
Copy Markdown
Contributor

@MelvinBot can you check off all PR author Checklist. I will ensure to all of them are checked

@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 I've updated the PR body with the test steps:

  • Tests and QA Steps: Filled in with the SAML cancel flow steps you provided.
  • Offline tests: Marked as N/A since SAML sign-in requires an active network connection.
  • Checklist items: Checked off the testing steps checkboxes.

Please mark this PR as "Ready for review" when you're ready — I wasn't able to do it automatically.

@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 Done — all PR Author Checklist items are now checked off.

@hoangzinh
Copy link
Copy Markdown
Contributor

@MelvinBot please mark this PR ready for review

@MelvinBot MelvinBot marked this pull request as ready for review April 27, 2026 07:14
@MelvinBot MelvinBot requested a review from a team as a code owner April 27, 2026 07:14
@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 Done! This PR has been marked as ready for review.

@melvin-bot melvin-bot Bot requested review from hoangzinh and joekaufmanexpensify and removed request for a team April 27, 2026 07:14
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 27, 2026

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

@melvin-bot melvin-bot Bot removed the request for review from a team April 27, 2026 07:14
.then((response: WebBrowserAuthSessionResult) => {
if (response.type !== 'success') {
Navigation.goBack();
clearSignInData();
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.

❌ CONSISTENCY-3 (docs)

The clearSignInData() + Navigation.isNavigationReady().then(() => Navigation.goBack()) block is duplicated three times in this file: in the cancel path (response.type !== 'success'), in the .catch handler, and in the onBackButtonPress callback. This increases maintenance overhead -- if the cleanup logic changes, all three sites must be updated.

Extract a helper function to eliminate the duplication:

const handleExitSAMLFlow = useCallback(() => {
    clearSignInData();
    Navigation.isNavigationReady().then(() => {
        Navigation.goBack();
    });
}, []);

Then use handleExitSAMLFlow() in all three locations (cancel path, catch handler, and onBackButtonPress).


Reviewed at: 0b70b7b | Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

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.

@MelvinBot what do you think about this feedback?

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.

The suggestion is valid. The clearSignInData() + Navigation.isNavigationReady().then(() => Navigation.goBack()) block is identical in all three places (cancel path, catch handler, and onBackButtonPress). Extracting a handleExitSAMLFlow callback would reduce duplication with no behavioral change.

Note: the pattern in handleNavigationStateChange (line 63-69) is intentionally different — it also calls setAccountError and navigates to ROUTES.HOME, so it should NOT be folded in.

Want me to implement this refactor?

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.

@MelvinBot yes please implement

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.

@MelvinBot please implement

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.

Done — extracted a handleExitSAMLFlow callback that's now used in all three places (cancel path, catch handler, and back button press).

@hoangzinh
Copy link
Copy Markdown
Contributor

@MelvinBot I faced the same bug in web

Screen.Recording.2026-04-27.at.14.22.38.mov

When a SAML-required user browser-backs from the IdP on web,
credentials.login is still set in Onyx but clearSignInData() is async.
This caused a blank SignInPage with no form visible until the Onyx
update propagated. Now shouldShowLoginForm is true immediately when
the SAML-reload guard fires.

Co-authored-by: Vinh Hoang <hoangzinh@users.noreply.github.com>
@MelvinBot MelvinBot requested a review from a team as a code owner April 27, 2026 07:33
@melvin-bot melvin-bot Bot requested a review from grgia April 27, 2026 07:33
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 27, 2026

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

@melvin-bot melvin-bot Bot removed the request for review from a team April 27, 2026 07:33
@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 Pushed a fix for the web SAML cancel bug.

Root cause: When a SAML-required user browser-backs from the IdP on web, credentials.login is still persisted in Onyx but account.isLoading is falsy. The guard in SignInPage.tsx:109 correctly calls clearSignInData(), but since that's an async Onyx.multiSet, the current render cycle still has hasLogin=true — making shouldShowLoginForm=false and no other form matches either (isSAMLRequired excludes the validate code form). Result: blank page with no form visible.

Fix: SignInPage.tsx:117 — when the SAML-reload guard fires, shouldShowLoginForm is now immediately set to true so the login form renders without waiting for the async Onyx clear.

@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 This PR is already fully set up:

  • ✅ All PR Author Checklist items are checked off
  • ✅ PR is marked as ready for review
  • ✅ All CI checks pass
  • ✅ Web SAML cancel fix has been pushed

If there's something specific you'd like me to implement, please let me know what it is!

Extract the repeated clearSignInData() + Navigation.isNavigationReady().then(goBack)
pattern into a single handleExitSAMLFlow useCallback, used by the cancel path,
catch handler, and back button press.

Co-authored-by: Vinh Hoang <hoangzinh@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@joekaufmanexpensify joekaufmanexpensify left a comment

Choose a reason for hiding this comment

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

Gotta make sure we keep that email field to sign in! 😄

@hoangzinh
Copy link
Copy Markdown
Contributor

🤖 Pushed a fix for the web SAML cancel bug.

Root cause: When a SAML-required user browser-backs from the IdP on web, credentials.login is still persisted in Onyx but account.isLoading is falsy. The guard in SignInPage.tsx:109 correctly calls clearSignInData(), but since that's an async Onyx.multiSet, the current render cycle still has hasLogin=true — making shouldShowLoginForm=false and no other form matches either (isSAMLRequired excludes the validate code form). Result: blank page with no form visible.

Fix: SignInPage.tsx:117 — when the SAML-reload guard fires, shouldShowLoginForm is now immediately set to true so the login form renders without waiting for the async Onyx clear.

@MelvinBot it seems doesn't work to me on web

On web, SAMLSignInPage uses window.location.replace() to redirect to the
IdP, which causes a full page reload on browser-back. The React state
hasInitiatedSAMLLogin resets to false, and depending on account.isLoading
during Onyx hydration, shouldInitiateSAMLLogin may fire again (re-redirecting
to IdP) before isClearingSAMLSignInData gets a chance to clear credentials.

Fix: use sessionStorage to persist the SAML initiation flag across page
reloads. SignInPage reads and clears this flag on mount, preventing
re-initiation and forcing the sign-in data clear path regardless of
account.isLoading timing.

Co-authored-by: Vinh Hoang <hoangzinh@users.noreply.github.com>
@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 Pushed a fix for the web SAML cancel issue.

Root cause: On web, SAMLSignInPage/index.tsx uses window.location.replace() to redirect to the IdP, which leaves the React app entirely. When the user browser-backs, the app does a full page reload. The React state hasInitiatedSAMLLogin resets to false, and depending on account.isLoading during Onyx hydration, shouldInitiateSAMLLogin may fire again — re-redirecting to the IdP before isClearingSAMLSignInData gets a chance to clear credentials.

Fix: Use sessionStorage to persist the SAML initiation flag across page reloads. SAMLSignInPage/index.tsx:30-32 sets the flag before the redirect. SignInPage.tsx:180-190 reads and clears it on mount, preventing SAML re-initiation and forcing the data-clear path regardless of account.isLoading timing.

@hoangzinh
Copy link
Copy Markdown
Contributor

@MelvinBot can you revert those commits

I tested on a wrong account

@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 Reverted both commits as requested:

  • 452c858 — "Fix web SAML cancel not showing login form on browser-back"
  • eac87f2 — "Show login form immediately when clearing stale SAML sign-in data on web"

@hoangzinh
Copy link
Copy Markdown
Contributor

hoangzinh commented Apr 28, 2026

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
Screen.Recording.2026-04-28.at.17.14.21.mov
Android: mWeb Chrome
Screen.Recording.2026-04-28.at.18.17.07.mov
iOS: HybridApp
Screen.Recording.2026-04-28.at.20.16.50.mov
iOS: mWeb Safari
Screen.Recording.2026-04-28.at.20.18.03.mov
MacOS: Chrome / Safari
Screen.Recording.2026-04-28.at.18.13.09.mov

@hoangzinh
Copy link
Copy Markdown
Contributor

@grgia all yours

@grgia grgia merged commit 3f9b2dd into main Apr 28, 2026
42 checks passed
@grgia grgia deleted the claude-fixSAMLCancelSignInState branch April 28, 2026 14:41
@OSBotify
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.

@github-actions
Copy link
Copy Markdown
Contributor

🚧 @grgia has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 9.3.65-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor Author

No help site changes required. This PR fixes an internal app navigation bug (blank screen after canceling the SAML browser on native). The existing SAML help articles (Set-Up-SAML-SSO, Troubleshoot-SAML-SSO-Login) cover server-side configuration and error messages — none of that is affected by this code change.

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.

5 participants