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

Handle magic links for fresh sessions #19819

Merged
merged 3 commits into from
Jun 5, 2023

Conversation

jjcoffee
Copy link
Contributor

@jjcoffee jjcoffee commented May 30, 2023

Details

On web we have the logic to sign in on a fresh session/different device with a "just sign in here" link, but with fresh sessions we don't have the user's permissions to the passwordless beta available, so opening magic links will always run the legacy validation (for the password-based flow) which breaks logging in for passwordless users.

This PR modifies this behaviour so that on web, the legacy validation only runs if the user credentials have been loaded (which indicates the betas will also be available).

Fixed Issues

$ #19214
PROPOSAL: #19214 (comment)

Tests

On web and mobile web only (which tests the actual change):

  1. Open newDot and start login process to generate a magic link email
  2. Open the magic link in the email in a fresh session (e.g. in incognito mode) (make sure to change the URL from "new.expensify.com" to your local test URL)
  3. Click the "sign in here" link
  4. Verify that you are signed in

For native and desktop apps, you can also verify that the normal sign in flow still works:

  1. Open newDot app, start sign-in
  2. Enter the magic code in the app
  3. Verify that you are signed in normally
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as above.

  • 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 / Chrome
    • iOS / native
    • iOS / 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 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
    • [ x 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(themeColors.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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
19214-magic-link-fresh-session-desktop-chrome.mp4
Mobile Web - Chrome
19214-magic-link-fresh-session-android-chrome.mp4
Mobile Web - Safari
19214-magic-link-fresh-session-ios-safari.mp4
Desktop
19214-magic-link-fresh-session-macos-desktop.mp4
iOS
19214-magic-link-fresh-session-ios-native.mp4
Android
19214-magic-link-fresh-session-android-native.mp4

@jjcoffee jjcoffee requested a review from a team as a code owner May 30, 2023 14:36
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and hayata-suenaga and removed request for a team May 30, 2023 14:36
@melvin-bot
Copy link

melvin-bot bot commented May 30, 2023

@hayata-suenaga @abdulrahuman5196 One of you needs to 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]

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented May 30, 2023

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 tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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.js 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(themeColors.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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Untitled.39.mp4
Mobile Web - Chrome
az_recorder_20230602_005517_edited.mp4
Mobile Web - Safari
ScreenRecording.mov
Desktop
Untitled.40.mp4
iOS
Untitled.38.mp4
Android
az_recorder_20230602_004432.mp4

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented May 31, 2023

@jjcoffee For me in native android, its still going to password screen if I directly use the magic link without entering the email id in mobile app.
Steps:
Go to web and trigger magic link
Deeplink fresh local android build with this PR (command npx uri-scheme open new-expensify://v/14797372/605518 --android)
It goes to password page and not directly logging in

@jjcoffee
Copy link
Contributor Author

jjcoffee commented Jun 1, 2023

@abdulrahuman5196 I am aware of that, that's why the testing steps are different for mobile - this is a web-only change (as proposed). I don't think there's a strong case for opening a magic link on mobile with a signed-out user on the app? Especially since there is no existing support for displaying the "just sign in here" link on native mobile apps (the interstitial screen doesn't display at all), so it doesn't seem to be supported behaviour.

It is possible to adjust the native behaviour to apply the same fix, but it would not display an interstitial (with the "just sign in here" link), just immediately log in. What do you think?

@jjcoffee
Copy link
Contributor Author

jjcoffee commented Jun 1, 2023

@abdulrahuman5196 Just to clarify in case you want to test, if we want to adjust the native behaviour, we'd need to update the check here:

https://github.com/jjcoffee/expensify-app/blob/004d49196cc78b6e3267ab8d8cc2597bb47a4a69/src/pages/ValidateLoginPage/index.js#L46

To this: if (!login || Permissions.canUsePasswordlessLogins(this.props.betas)) {

We need to add the credentials to the withOnyx call: credentials: {key: ONYXKEYS.CREDENTIALS},, then we grab the login from it const login = lodashGet(this.props, 'credentials.login', null);.

Let me know what you think!

@abdulrahuman5196
Copy link
Contributor

@jjcoffee #19819 (comment)
Are you saying this will fix native behaviour or for testing?

@jjcoffee
Copy link
Contributor Author

jjcoffee commented Jun 1, 2023

@abdulrahuman5196 Yes it will fix the native behaviour you described. I wasn't sure if you want to apply the fix since the original proposal was only for web behaviour. Shall I just push the fix do you think?

@jjcoffee
Copy link
Contributor Author

jjcoffee commented Jun 1, 2023

@abdulrahuman5196 I've just pushed the fix for native behaviour, hope that's okay!

@abdulrahuman5196
Copy link
Contributor

Thanks @jjcoffee, had a quick check and it seems to work. Could you update your author's checklist native platform videos on the same. I will continue review in one hour.

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jun 1, 2023

@jjcoffee Can you update the test in author checklist to reflect the mobile native fix as well?

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

Changes look's good and works well. Added Reviewers checklist as well.

All yours
@hayata-suenaga

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jun 2, 2023

@hayata-suenaga Gentle Ping. Pending on your review

@jjcoffee
Copy link
Contributor Author

jjcoffee commented Jun 2, 2023

@abdulrahuman5196 Wasn't sure if it was still needed, but I've retested and updated the native videos now. Sorry for the delay!

@abdulrahuman5196
Copy link
Contributor

@jjcoffee Meanwhile could you update the comments as alone

hayata-suenaga
hayata-suenaga previously approved these changes Jun 4, 2023
Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

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

LGTM as long as @abdulrahuman5196's suggestions are addressed 👍

src/pages/ValidateLoginPage/index.website.js Show resolved Hide resolved
@abdulrahuman5196
Copy link
Contributor

@jjcoffee Could you address the comment suggestions? We can close this out then?

@jjcoffee
Copy link
Contributor Author

jjcoffee commented Jun 5, 2023

@hayata-suenaga Comments addressed!

@hayata-suenaga hayata-suenaga self-requested a review June 5, 2023 13:23
Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

@hayata-suenaga I think you should be good to merge

@hayata-suenaga hayata-suenaga merged commit 8a376c8 into Expensify:main Jun 5, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Jun 5, 2023

✋ 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
Copy link
Contributor

OSBotify commented Jun 6, 2023

🚀 Cherry-picked to staging by https://github.com/hayata-suenaga in version: 1.3.24-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

OSBotify commented Jun 7, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jun 7, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 cancelled 🔪
🍎 iOS 🍎 cancelled 🔪
🕸 web 🕸 success ✅

@jjcoffee jjcoffee deleted the fix-19214 branch March 27, 2024 10:41
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