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

Add unlink secondary login flow #15811

Merged
merged 27 commits into from
May 5, 2023
Merged

Add unlink secondary login flow #15811

merged 27 commits into from
May 5, 2023

Conversation

NikkiWines
Copy link
Contributor

@NikkiWines NikkiWines commented Mar 10, 2023

Details

Adds the ability to unlink claimed but unvalidated secondary logins, inline with what we do on oldDot

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/268314

Tests

  1. Log into an account (loginA) on oldDot or newDot and add (but do not validate) a secondary login (loginB)
  2. Log out of the account and navigate to the newDot sign in page
  3. Try to sign in loginB and confirm you're directed to a view that says you'd need to validate that login from the account settings on loginA. Confirm there is an Unlink button that you can press to unlink the two logins.
  4. Press Unlink and confirm that you see the text Link sent! appear on the page
  5. Confirm you receive a notification (to loginB) with a link to unlink your logins
  6. Copy the validation link but modify the validationCode so that it's no longer a valid code
  7. Go to that link and confirm that you see an error message notifying you that your link is invalid or expired.
    • Note: On Web, if you open the link in the same session, you'll see the unlink page because we'll have stored the credentials and know which view to display. If you open the link in a new session (i.e. in an incognito window) the error message will display on the main sign in view because we won't have the login stored.
  8. Click Unlink again to get a new link
  9. Click the link in the notification and confirm you're directed to the sign in page with a success message saying that your secondary login has been successfully unlinked.
  • Verify that no errors appear in the JS console

Offline tests

While online

  1. Log into an account (loginA) on oldDot or newDot and add (but do not validate) a secondary login (loginB)
  2. Log out of the account and navigate to the newDot sign in page
  3. Try to sign in loginB and confirm you're directed to a view that says you'd need to validate that login from the account settings on loginA.
  4. Go offline
  5. Confirm there is an Unlink button, but that it is disabled and you cannot press it
  6. Confirm that you see the offline indicator at the bottom of the page.

offline

QA Steps

  1. Log into an account (loginA) on oldDot or newDot and add (but do not validate) a secondary login (loginB)
  2. Log out of the account and navigate to the newDot sign in page
  3. Try to sign in loginB and confirm you're directed to a view that says you'd need to validate that login from the account settings on loginA. Confirm there is an Unlink button that you can press to unlink the two logins.
  4. Press Unlink and confirm that you see the text Link sent! appear on the page
  5. Confirm you receive a notification (to loginB) with a link to unlink your logins
  6. Copy the validation link but modify the validationCode so that it's no longer a valid code
  7. Go to that link and confirm that you see an error message notifying you that your link is invalid or expired.
    • Note: On Web, if you open the link in the same session, you'll see the unlink page because we'll have stored the credentials and know which view to display. If you open the link in a new session (i.e. in an incognito window) the error message will display on the main sign in view because we won't have the login stored.
  8. Click Unlink again to get a new link
  9. Click the link in the notification and confirm you're directed to the sign in page with a success message saying that your secondary login has been successfully unlinked.
  • 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 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 correct English and 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
    • 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 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
web.mov
Mobile Web - Chrome
Screen.Recording.2023-04-21.at.14.52.44.mov
Mobile Web - Safari
mweb-safari.mp4
Desktop
desktop.mov
iOS (unable to test link redirecting but can show the updated UI)
ios.mp4
Android (unable to test link redirecting but can show the updated UI)

@MelvinBot

This comment was marked as outdated.

@NikkiWines NikkiWines self-assigned this Mar 13, 2023
@NikkiWines NikkiWines changed the title Add unlink secondary login flow [HOLD] Add unlink secondary login flow Apr 10, 2023
@NikkiWines
Copy link
Contributor Author

NikkiWines commented Apr 10, 2023

Been fighting with my android emulator for the past 48 hours but this is otherwise ready for review. It's on hold for the corresponding (internal) Web-E PR though because it adds the necessary API commands.

cc: @Gonals as you're assigned to the Web-E PR

@NikkiWines NikkiWines marked this pull request as ready for review April 10, 2023 23:41
@NikkiWines NikkiWines requested a review from a team as a code owner April 10, 2023 23:41
@melvin-bot melvin-bot bot requested review from mananjadhav and MonilBhavsar and removed request for a team April 10, 2023 23:41
@MelvinBot
Copy link

@mananjadhav @MonilBhavsar 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]

@mananjadhav
Copy link
Collaborator

@NikkiWines Is this ready for review because the title says [Hold]?

@NikkiWines
Copy link
Contributor Author

Ah, yeah @mananjadhav you won't be able to review this yet because it's dependent on an internal PR that's in review. I can unassign you for now and re-assign once this isn't on hold any more if you'd like!

@mananjadhav
Copy link
Collaborator

I think you can keep me assigned and I can get to it once the internal PR is through. I just clarified because the title said HOLD.

@NikkiWines NikkiWines changed the title [HOLD] Add unlink secondary login flow Add unlink secondary login flow Apr 14, 2023
@NikkiWines
Copy link
Contributor Author

Internal PR is on prod! Taking this off hold 🎊

@NikkiWines
Copy link
Contributor Author

Sorry @mananjadhav I got pulled into some other work today and didn't have a chance to take a further look into this. Will prioritize this tomorrow

@NikkiWines
Copy link
Contributor Author

Ok, still unable to reproduce but @mananjadhav I pushed a small change that I suspect might resolve the issue. Could you retry your steps once more to see if you still encounter the error? Thank you 🙌

@mananjadhav
Copy link
Collaborator

Thanks @NikkiWines I think the last change worked. I was able to successfully test this on Web. I am now going to test this on other platforms.

@mananjadhav
Copy link
Collaborator

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
web-unlink-secondary-link.mov
web-unlink-secondary-link-error
Mobile Web - Chrome
mweb-chrome-unlink-secondary-link.mov
Mobile Web - Safari
mweb-safari-unlink-secondary-link.mov
Desktop
desktop-unlink-secondary-link.mov
iOS
ios-unlink-secondary-link.mov
Android
android-unlink-secondary-link.mov

Thanks for the patience here @NikkiWines @MonilBhavsar. As I mentioned, I was finally able to test without issues. @MonilBhavsar All yours.

mananjadhav
mananjadhav previously approved these changes May 4, 2023
@melvin-bot
Copy link

melvin-bot bot commented May 4, 2023

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

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

MonilBhavsar
MonilBhavsar previously approved these changes May 5, 2023
Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Some NAB's, else looks good 👍

@@ -187,6 +187,8 @@ function beginSignIn(login) {
value: {
...CONST.DEFAULT_ACCOUNT_DATA,
isLoading: true,
errors: null,
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, errors is already null in the default data, may be we just need message field

const propTypes = {
/** The accountID and validateCode are passed via the URL */
route: validateLinkPropTypes,

Copy link
Contributor

Choose a reason for hiding this comment

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

NAB, empty line

@@ -28,6 +29,9 @@ const propTypes = {

/** Whether the account is validated */
validated: PropTypes.bool,

/** The primaryLogin associated with the account */
primaryLogin: PropTypes.string,
Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I think there was a lint rule that required default props or the prop to be required. Looks like it is not working lately.

@NikkiWines NikkiWines dismissed stale reviews from MonilBhavsar and mananjadhav via 93cf44c May 5, 2023 08:42
@NikkiWines
Copy link
Contributor Author

woo thank you @MonilBhavsar and @mananjadhav 🙌 updated once more

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good

@MonilBhavsar MonilBhavsar merged commit 7e957af into main May 5, 2023
@MonilBhavsar MonilBhavsar deleted the nikki-unlink-login branch May 5, 2023 11:20
@OSBotify
Copy link
Contributor

OSBotify commented May 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 May 5, 2023

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.11-0 🚀

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

*/
function requestUnlinkValidationLink() {
const optimisticData = [{
onyxMethod: CONST.ONYX.METHOD.MERGE,
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI this just got removed! And it was replaced with Onyx.METHOD.MERGE, where Onyx is imported from react-native-onyx.

I can spin up a fix for this real quick

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh I guess this was found in this bug report: #18526

@OSBotify
Copy link
Contributor

OSBotify commented May 9, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

@@ -143,6 +164,7 @@ class SignInPage extends Component {
<PasswordForm isVisible={showPasswordForm} />
)}
{showResendValidationForm && <ResendValidationForm />}
{showUnlinkLoginForm && <UnlinkLoginForm />}
Copy link
Contributor

Choose a reason for hiding this comment

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

This line caused console error as showUnlinkLoginForm can be string value. More details - #19202 (comment)

New checklist item added to prevent such bugs:

  • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.

key: ONYXKEYS.ACCOUNT,
value: {
isLoading: false,
message: Localize.translateLocal('unlinkLoginForm.linkSent'),
Copy link
Member

Choose a reason for hiding this comment

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

Because this will return a static value, it will not translate on runtime when the use changes the language after the message is shown to the user which caused #18827

key: ONYXKEYS.ACCOUNT,
value: {
isLoading: false,
message: Localize.translateLocal('unlinkLoginForm.succesfullyUnlinkedLogin'),
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi ✋ Coming from #22934

We should return the message as the phrase key instead to get the dynamic message based on the language.

Copy link
Collaborator

Choose a reason for hiding this comment

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

thanks for highlighting this.

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.

9 participants