Skip to content
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

Use POST for SAML login #52658

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Use POST for SAML login #52658

wants to merge 26 commits into from

Conversation

NikkiWines
Copy link
Contributor

@NikkiWines NikkiWines commented Nov 16, 2024

Explanation of Change

Updates the SAML login flow to use a POST request instead of opening a user-modifiable URL

Dependant on https://github.com/Expensify/Web-Expensify/pull/44462

Fixed Issues

$ Tied to https://github.com/Expensify/Expensify/issues/424196
PROPOSAL: N/A

Tests

  • Verify that no errors appear in the JS console

*(Internal) *
Success Flow

  1. Follow steps here to get set up with SAML locally (it's so much simpler now!)
  2. Configure your account to have SAML enabled but not required in Expensify Classic
  3. Enter the email for your account in New Expensify
  4. Choose Use Single Sign On option
  5. Confirm you briefly see an interstitial page about launching your SSO provider's login portal
  6. Enter your SSO credentials
  7. Confirm you're redirected back to New Expensify and are logged into your account

Error Flow

  1. In Web-Expensify, add the following line right below the try{ here: throw new ExpException('An error occurred while loggin in, please try again.', 403);
  2. Enter the email for your account in New Expensify
  3. Choose Use Single Sign On option
  4. Confirm you briefly see an interstitial page
  5. Confirm you're dropped back on the sign in page and see the error An error occurred while loggin in, please try again.

Notes for dev testing:

For the newDot redirect to work locally you may need to hardcode the following value to true.

For mobile testing, you will need to change the url in OneLogin's Expensidev application to your ngrok url instead of https:://www.expensify.com.dev/ so that it loads correctly on the simulators. You can do that by loggin into OneLogin (using carlos@ or dbondy@ creds in 1Pass), going to Administration > Left Hamburger Menu > Applications > Applications > Expensidev Connection > Configuration and updating the urls in ACS (Consumer) URL Validator and ACS (Consumer) URL

Lastly, for Android mWeb, if you use 127.0.0.1:8082/ for your newDot URL, you'll need to update the usage of URL_TO_NEWDOT here to use that URL instead.

(External)

  1. Create an account with a validated domain on Expensify Classic
  2. Configure your account to have SAML enabled but not required in Expensify Classic (use an iDP of your choice, we tend to test with OneLogin)
  3. Enter the email for your account in New Expensify
  4. Confirm you see the option to choose to sign in with SAML or with a magic code
  5. Choose Use Single Sign On option
  6. Confirm you briefly see an interstitial page about launching your SSO provider's login portal
  7. Enter your SSO credentials
  8. Confirm you're redirected back to New Expensify and are logged into your account

Offline tests

N/A SAML is not supported offline

QA Steps

  • Verify that no errors appear in the JS console
  1. Log into New Expensify with the email [email protected]

  2. Choose Use Single Sign On option

  3. Confirm you briefly see an interstitial page about launching your SSO provider's login portal

  4. Enter the SSO credentials for [email protected] (in 1password under QA OneLogin)

  5. Confirm you're redirected back to New Expensify and are logged into your account

    • Note: You will be dropped back into new.expensify.com, not staging.new.expensify.com, this is known and expected because of how the SAML metadata is configured in Expensify Classic

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
    • MacOS: Desktop
  • 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 verified the translation was requested/reviewed 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.js 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 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.
  • 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

Error:

Screen.Recording.2024-11-28.at.18.19.42.mov

Success:

android.success.mov
Android: mWeb Chrome

Error:

mweb.android.failure.mov

Success:

android.mweb.success.mov
iOS: Native

Error:

ios.error.mp4

Success:

ios.success.mp4
iOS: mWeb Safari

Error:

ios.mweb.error.mp4

Success:

ios.mweb.success.mp4
MacOS: Chrome / Safari

Error:

web.error.mov

Success:

web.success.mov
MacOS: Desktop

Error:

desktop.error.mov

Success:

desktop.success.mov

@NikkiWines NikkiWines self-assigned this Nov 16, 2024
@NikkiWines NikkiWines changed the title Use POST for SAML login [HOLD] Use POST for SAML login Nov 28, 2024
@NikkiWines
Copy link
Contributor Author

Appears to be failing on an unrelated tyepscript check error - but should be ready for review

Error: src/pages/workspace/upgrade/UpgradeIntro.tsx(91,48): error TS2339: Property 'PLAN_TYPES_AND_PRICING_HELP_URL' does not exist on type '{ readonly HEIC_SIGNATURES: readonly ["6674797068656963", "6674797068656978", "6674797068657631", "667479706d696631"]; readonly RECENT_WAYPOINTS_NUMBER: 20; readonly DEFAULT_DB_NAME: "OnyxDB"; ... 491 more ...; readonly HYBRID_APP: { ...; }; }'.
Error: Process completed with exit code 2.

@NikkiWines NikkiWines marked this pull request as ready for review November 28, 2024 22:07
@NikkiWines NikkiWines requested a review from a team as a code owner November 28, 2024 22:07
@melvin-bot melvin-bot bot requested review from MariaHCD and removed request for a team November 28, 2024 22:08
Copy link

melvin-bot bot commented Nov 28, 2024

@MariaHCD 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
Contributor

@MariaHCD MariaHCD left a comment

Choose a reason for hiding this comment

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

Mostly have some questions / clarifications :)

}
return response.json() as Promise<Response>;
})
.then((response) => response);
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need this second .then()? Can we return the json in the previous .then() 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, at least from my testing we need both - I also followed the convention from here

src/pages/signin/SAMLSignInPage/index.native.tsx Outdated Show resolved Hide resolved
return fetch(CONFIG.EXPENSIFY.SAML_URL, {
method: CONST.NETWORK.METHOD.POST,
body,
credentials: 'omit',
Copy link
Contributor

Choose a reason for hiding this comment

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

Just curious - why are we setting credentials:omit here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Following the convention used here - I can test without it but figured it was safest to go with logic we already knew worked.

}

const body = new FormData();
body.append('email', credentials?.login ?? '');
Copy link
Contributor

Choose a reason for hiding this comment

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

What happens if email is set as an empty string?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think rn the iDP page fails to load so they get stuck on the loading screen, i'll update the logic to return early if there's no login to pass.

Navigation.navigate(ROUTES.HOME);

Navigation.isNavigationReady().then(() => {
// We must call goBack() to remove the /transition route from history
Copy link
Contributor

Choose a reason for hiding this comment

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

Just curious - where is this transition route set? Is it only from OldDot -> NewDot?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah OldDot -> NewDot - here

src/pages/signin/SAMLSignInPage/index.native.tsx Outdated Show resolved Hide resolved
src/pages/signin/SAMLSignInPage/index.tsx Outdated Show resolved Hide resolved
@MariaHCD MariaHCD requested a review from cead22 November 29, 2024 10:28
@NikkiWines
Copy link
Contributor Author

@MariaHCD @cead22 this one should be good for for review 🙇

@NikkiWines NikkiWines changed the title [HOLD] Use POST for SAML login Use POST for SAML login Dec 13, 2024
@NikkiWines
Copy link
Contributor Author

Off hold now that the corresponding Web-E PR is on prod!

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.

2 participants