Fix: prevent signing in to wrong account in the desktop app via magic link by JKobrynski · Pull Request #24207 · Expensify/App

JKobrynski · 2023-08-07T12:18:36Z

Details

Fixed Issues

Tests

Make sure you have two accounts with different emails (accounts A and B)
Confirm you have the Desktop app installed and user is signed out
Log into account A in the web app
Start logging into account B on the desktop app (on the same device) so a magic link is sent to your email
Open the magic link in new tab (if you are testing locally, you need to replace new.expensify.com with localhost: in the link)
Click on "Allow" in prompt to open the link in desktop app
Once the desktop app is launched, you should be logged into account B

Disclaimer

This is a desktop only issue that is not reproductible on mobile, therefore there are no testing steps or screen recordings on mobile.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as "Tests" section above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web + desktop

desktop3-compressed.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

s77rt · 2023-08-09T14:21:06Z


 function beginDeepLinkRedirect() {
+    // Match any magic link (/v/<account id>/<6 digit code>)
+    const isMagicLink = /\/v\/\w+\/[0-9]{6}/.test(window.location.pathname)


Can we use CONST.REGEX.ROUTES.VALIDATE_LOGIN?

Sure, done!

melvin-bot · 2023-08-11T08:14:02Z

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

JKobrynski · 2023-08-11T08:17:51Z

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 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 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 + desktop

desktop3-compressed.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

dangrous

One minor change apart from what @s77rt pointed out

dangrous · 2023-08-14T15:50:17Z

Lost a couple comments when we moved that line, so @JKobrynski take a look at #24207 (comment) (though I don't know if we need to do that?).

As for the window thing, I think we're probably fine? Do we have other examples in the code of using that - or similar - functions only on web, without adding an index.native.js, etc.?

s77rt · 2023-08-16T12:42:10Z

+ * @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates wheather default authentication method (shortLivedAuthToken) should be used
+ */
+function beginDeepLinkRedirectAfterTransition(shouldAuthenticateWithCurrentAccount = true) {
+    waitForSignOnTransitionToFinish().then(beginDeepLinkRedirect(shouldAuthenticateWithCurrentAccount));


Suggested change

waitForSignOnTransitionToFinish().then(beginDeepLinkRedirect(shouldAuthenticateWithCurrentAccount));

waitForSignOnTransitionToFinish().then(() => beginDeepLinkRedirect(shouldAuthenticateWithCurrentAccount));

s77rt · 2023-08-16T13:01:34Z

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 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 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mp4

iOS

Android

s77rt · 2023-08-16T13:01:54Z

@JKobrynski Please complete the checklist (the author checklist)

s77rt

LGTM! 🚀

melvin-bot · 2023-08-16T13:15:24Z

🎯 @s77rt, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #24626.

dangrous

Sorry one typo, then good to go!

dangrous · 2023-08-16T15:31:37Z

-function beginDeepLinkRedirectAfterTransition() {
-    waitForSignOnTransitionToFinish().then(beginDeepLinkRedirect);
+/**
+ * @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates wheather default authentication method (shortLivedAuthToken) should be used


Suggested change

* @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates wheather default authentication method (shortLivedAuthToken) should be used

* @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates whether default authentication method (shortLivedAuthToken) should be used

dangrous · 2023-08-16T15:31:49Z


-function beginDeepLinkRedirect() {
+/**
+ * @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates wheather default authentication method (shortLivedAuthToken) should be used


Suggested change

* @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates wheather default authentication method (shortLivedAuthToken) should be used

* @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates whether default authentication method (shortLivedAuthToken) should be used

dangrous · 2023-08-16T15:32:48Z

Oh and please run npm run prettier as well!

And is there a way to sign your commits? I confess I don't fully know what that means haha; maybe @s77rt has an idea?

s77rt · 2023-08-16T18:19:51Z

@dangrous Signed commits are just to prove that you are the real person who made those commits as I think it's pretty easy to impersonate others.

JKobrynski · 2023-08-17T07:00:34Z

Addressed the newest comments, signed the latest commits

dangrous · 2023-08-17T17:11:17Z

Code looks good! It's still having trouble with some of the commits; is there a way to go back and sign these? The two you just pushed seem okay, but the ones before.

["91998d1b10bda97cb185d2d93cee70925ee7bc67","7df8b5fe4f477b861f2e65b5d5b2f0e70877791f","c9e6c0777e8a75e60f251c5f7e645b4da108e431","4763486e35a8a8f3080dd7be2ea31515e227796b","71ecf5fdd9c04b7537c6b187e255722afbd0fb40","bf3ddf4c2dbcd791e7570583cdc9302b6c1d9d16","fbbf3ff1ad6e2217aa82d023cb1b04199c2bccc3","b178ace212b990d030e7bd25d7eed16229714720","9e4c1121c983ed0b9019ba285b5d252acadfcf1c","2a921d351c45b855afcf54c2604a7c96cfd75a5e","d8fcf2a0444487c03e1bcb9ca3bcfc1afbeb9379"]

Looks like there are a couple resources online that explain how to do this. Sorry for the trouble!

…nction

JKobrynski · 2023-08-18T11:24:23Z

@dangrous commits have been signed!

dangrous

Thank you for getting that sorted!

OSBotify · 2023-08-18T16:04:46Z

✋ 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 · 2023-08-21T22:24:34Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.56-0 🚀

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

OSBotify · 2023-08-24T03:07:35Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

JKobrynski changed the title ~~add magic link condition to openRouteInDesktopApp function~~ Fix: prevent signing in to wrong account in the desktop app via magic link Aug 7, 2023

s77rt suggested changes Aug 9, 2023

View reviewed changes

JKobrynski marked this pull request as ready for review August 11, 2023 08:13

JKobrynski requested a review from a team as a code owner August 11, 2023 08:13

JKobrynski mentioned this pull request Aug 11, 2023

[$1000] Login - User logged in with account A via magic link for account B if A logged in Web #23409

Closed

6 tasks

melvin-bot Bot requested review from dangrous and removed request for a team August 11, 2023 08:14

JKobrynski requested a review from s77rt August 11, 2023 08:19

s77rt suggested changes Aug 11, 2023

View reviewed changes

Comment thread src/libs/actions/App.js Outdated

dangrous suggested changes Aug 11, 2023

View reviewed changes

Comment thread src/libs/actions/App.js Outdated

JKobrynski requested review from dangrous and s77rt August 12, 2023 19:45

s77rt suggested changes Aug 13, 2023

View reviewed changes

Comment thread src/libs/actions/App.js Outdated

JKobrynski requested a review from s77rt August 16, 2023 07:45

s77rt suggested changes Aug 16, 2023

View reviewed changes

JKobrynski requested a review from s77rt August 16, 2023 12:48

s77rt reviewed Aug 16, 2023

View reviewed changes

Comment thread src/components/DeeplinkWrapper/index.website.js Outdated

JKobrynski requested a review from s77rt August 16, 2023 13:12

s77rt approved these changes Aug 16, 2023

View reviewed changes

melvin-bot Bot mentioned this pull request Aug 16, 2023

Payment issue for E/App PR#24207 #24626

Closed

dangrous suggested changes Aug 16, 2023

View reviewed changes

JKobrynski requested a review from dangrous August 17, 2023 07:09

dangrous previously approved these changes Aug 17, 2023

View reviewed changes

JKobrynski added 13 commits August 18, 2023 12:54

add magic link condition to openRouteInDesktopApp function

b89dff9

prevent shortLivedAuthToken and email from being passed to browser fu…

49d2d37

…nction

revert DeeplinkWrapper changes

bb4c809

remove newline from Browser

d6c86b2

replace custom regex with predefined one

1d2e89b

remove unnecessary comment

bbc8d2d

move isMagicLink assignment below anonymous user condition

b3ab2dc

move magic link logic to DeepLinkWrapper

67e27bf

Merge branch 'main' into fixMagicLinkSignIn

ff9a780

fix chained function call

1cb533a

move isMagicLink below conditional

6ae1796

fix typo

e99fe7c

run npm run prettier

08447b8

JKobrynski force-pushed the fixMagicLinkSignIn branch from 2e67fc2 to 08447b8 Compare August 18, 2023 11:06

Merge branch 'main' into fixMagicLinkSignIn

757c562

JKobrynski dismissed dangrous’s stale review via 757c562 August 18, 2023 11:23

JKobrynski requested a review from dangrous August 18, 2023 11:24

dangrous approved these changes Aug 18, 2023

View reviewed changes

dangrous merged commit f64cdbd into Expensify:main Aug 18, 2023

OSBotify mentioned this pull request Aug 21, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

	waitForSignOnTransitionToFinish().then(beginDeepLinkRedirect(shouldAuthenticateWithCurrentAccount));
	waitForSignOnTransitionToFinish().then(() => beginDeepLinkRedirect(shouldAuthenticateWithCurrentAccount));

	* @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates wheather default authentication method (shortLivedAuthToken) should be used
	* @param {boolean} shouldAuthenticateWithCurrentAccount Optional, indicates whether default authentication method (shortLivedAuthToken) should be used

Uh oh!

Conversation

JKobrynski commented Aug 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Disclaimer

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Aug 11, 2023

Uh oh!

JKobrynski commented Aug 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

dangrous left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dangrous commented Aug 14, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s77rt commented Aug 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

s77rt commented Aug 16, 2023

Uh oh!

Uh oh!

s77rt left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Aug 16, 2023

Uh oh!

dangrous left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dangrous commented Aug 16, 2023

Uh oh!

s77rt commented Aug 16, 2023

Uh oh!

JKobrynski commented Aug 17, 2023

Uh oh!

dangrous commented Aug 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JKobrynski commented Aug 18, 2023

Uh oh!

dangrous left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Aug 18, 2023

Uh oh!

OSBotify commented Aug 21, 2023

Uh oh!

OSBotify commented Aug 24, 2023

Uh oh!

JKobrynski commented Aug 7, 2023 •

edited

Loading

JKobrynski commented Aug 11, 2023 •

edited

Loading

s77rt commented Aug 16, 2023 •

edited

Loading

dangrous commented Aug 17, 2023 •

edited

Loading