App icon indicating copy to clipboard operation
App copied to clipboard
verified publisher icon Expensify

Clear login state when account.primaryLogin changes

Open roryabraham opened this issue 2 years ago • 19 comments

Details

Clears out the LoginPage state when the primaryLogin of the account in Onyx changes. This happens when you click on Create New Account or Log In in the footer of any of the public pages.

Fixed Issues

$ https://github.com/Expensify/App/issues/17811

Tests

  1. On the sign in page, enter an email, then click continue.
  2. Scroll down and click Log In.
  3. Verify that you are taken to the previous form page, scrolled to the top, and the form field is emptied.
  4. Enter an email, then click continue.
  5. Scroll down and click Create New Account.
  6. Verify that you are taken to the previous form page, scrolled to the top, and the form field is emptied.
  • [x] Verify that no errors appear in the JS console

Offline tests

n/a because the login flow uses the blocking form pattern.

QA Steps

Same as tests.

  • [ ] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android / native
    • [x] Android / Chrome
    • [x] iOS / native
    • [x] iOS / Safari
    • [x] MacOS / Chrome / Safari
    • [x] MacOS / Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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.
  • [x] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

https://user-images.githubusercontent.com/47436092/233742325-603f52fc-98e9-49db-8956-dd7e0b9d80da.mov

Mobile Web - Chrome

https://user-images.githubusercontent.com/47436092/233742360-f1f5a4f2-de83-433a-be34-59aedf559c16.mov

Mobile Web - Safari

https://user-images.githubusercontent.com/47436092/233742415-cf45e276-8f00-47bd-8d86-7f37d16f8beb.mov

Desktop

https://user-images.githubusercontent.com/47436092/233742438-6a0fc9f0-337f-4e8d-9575-4358c188f1e3.mov

iOS

https://user-images.githubusercontent.com/47436092/233742471-db74dff1-d1a8-45fe-987e-37630bbe27e2.mov

Android

https://user-images.githubusercontent.com/47436092/233742482-b55f422c-8323-48b1-a613-a7c7ae1756aa.mov

roryabraham avatar Apr 21 '23 21:04 roryabraham

@fedirjh @aldo-expensify 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]

MelvinBot avatar Apr 21 '23 22:04 MelvinBot

@mananjadhav @aldo-expensify 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]

MelvinBot avatar Apr 21 '23 22:04 MelvinBot

On it now

Santhosh-Sellavel avatar Apr 21 '23 22:04 Santhosh-Sellavel

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [ ] Android / native
    • [ ] Android / Chrome
    • [ ] iOS / native
    • [ ] iOS / Safari
    • [ ] MacOS / Chrome / Safari
    • [ ] MacOS / Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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.
  • [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web & Desktop

https://user-images.githubusercontent.com/85645967/233747635-1fd3456d-622a-4c9a-8149-2c2c392d85f2.mov

Mobile Web - Chrome
Mobile Web - Safari
iOS

https://user-images.githubusercontent.com/85645967/233749118-109fb215-3a1b-4884-b548-480d67d05319.mp4

Android

https://user-images.githubusercontent.com/85645967/233749104-993a5911-bf8a-4acb-a118-7b1eac0d5cb2.mov

Santhosh-Sellavel avatar Apr 21 '23 22:04 Santhosh-Sellavel

@roryabraham Earlier we would reset the email for when we do the same on Login Page also. But now it's persisted

Before

https://user-images.githubusercontent.com/85645967/233745240-f3bb7f5c-a13a-4db8-a9a3-e8c1bebce134.MP4

Now

https://user-images.githubusercontent.com/85645967/233745202-00985698-232f-45f0-96c2-0d2ef3bbd7d5.mp4

Santhosh-Sellavel avatar Apr 21 '23 22:04 Santhosh-Sellavel

@Santhosh-Sellavel I kind of think the new behavior is better, if you're still on the same screen you were on before and just scroll up, I'm not sure why it would be expected that the login you just entered clears.

roryabraham avatar Apr 21 '23 23:04 roryabraham

Thanks for confirming, makes sense to me as well!

Santhosh-Sellavel avatar Apr 21 '23 23:04 Santhosh-Sellavel

@roryabraham This didn't reset the first time (when users signup) alone.

https://user-images.githubusercontent.com/85645967/233749820-e4689100-2b2a-4001-85ed-79e07d40f063.mp4

Santhosh-Sellavel avatar Apr 21 '23 23:04 Santhosh-Sellavel

@Santhosh-Sellavel I'm not able to reproduce that

roryabraham avatar Apr 22 '23 14:04 roryabraham

@roryabraham an new test account on login for signup. It occurs only first time when it happens.

PrimaryLogin is empty in both prevprops & this.props

Santhosh-Sellavel avatar Apr 22 '23 14:04 Santhosh-Sellavel

I am able to reproduce an unrelated error (not sure if it will happen w/o our internal back-end dev environment)

Steps to reproduce:

  1. Enter an email you've never used before.

  2. Get a Too many writes error modal:

    image

  3. Click Ok

  4. See an error on the next page (probably indicating that account.primaryLogin wasn't correctly updated in Onyx:

    image

  5. Go back, and the email is still present (b/c account.primaryLogin wasn't cleared in Onyx, which is what triggers the form to clear).

roryabraham avatar Apr 22 '23 14:04 roryabraham

I am able to reproduce an unrelated error (not sure if it will happen w/o our internal back-end dev environment)

Interesting, yeah It might due to internal dev.

Santhosh-Sellavel avatar Apr 22 '23 16:04 Santhosh-Sellavel

Here is a recording this should help @roryabraham

https://user-images.githubusercontent.com/85645967/233796727-3ba1dff5-a628-4896-8a35-e7ebf87badea.mov

Santhosh-Sellavel avatar Apr 22 '23 16:04 Santhosh-Sellavel

I am able to reproduce an unrelated error (not sure if it will happen w/o our internal back-end dev environment)

@roryabraham yeah, I think when the backend sends that "too many writes" error the response comes with an error code or something, so the UI sometimes shows and error that is not real :/. This confused me while testing another flow too.

aldo-expensify avatar Apr 24 '23 09:04 aldo-expensify

Okay, after resolving the dev auth write issue, I was still able to reproduce the bug @Santhosh-Sellavel found. Looking for a solution now.

roryabraham avatar Apr 25 '23 18:04 roryabraham

@Santhosh-Sellavel @aldo-expensify fixed:

https://user-images.githubusercontent.com/47436092/234365047-0117bf23-a144-4bbe-b48f-bd59a186d819.mov

roryabraham avatar Apr 25 '23 18:04 roryabraham

@roryabraham

on pressing Go back also now email gets reset now.

https://user-images.githubusercontent.com/85645967/234668315-72ca5854-ca5d-4f13-85df-ed1a9dd77c6b.mov

Santhosh-Sellavel avatar Apr 26 '23 18:04 Santhosh-Sellavel

@Santhosh-Sellavel thanks for your thorough testing. I'd again say the new behavior is better / expected. After all, the link you just clicked said Not <old email>? Go back. So when you click Go back it would make sense that we clear that old email.

roryabraham avatar Apr 26 '23 23:04 roryabraham

@Santhosh-Sellavel thanks for your thorough testing. I'd again say the new behavior is better / expected. After all, the link you just clicked said Not <old email>? Go back. So when you click Go back` it would make sense that we clear that old email.

Some time ago we made it intentional as there may be a little typo, so allowing users to correct mistakes. Can you check this internally to confirm, so this does not come as a regression again?

Santhosh-Sellavel avatar Apr 27 '23 16:04 Santhosh-Sellavel

Thanks for the context, @Santhosh-Sellavel. I've updated this to preserve the existing behavior for Go back

roryabraham avatar Apr 27 '23 19:04 roryabraham

Thanks, @roryabraham. The login gets cleared again when we get server errors.

This build

https://user-images.githubusercontent.com/85645967/234983149-85ff71d1-8688-4766-aa3a-0fb5f126664f.mov

https://user-images.githubusercontent.com/85645967/234983110-d43a0c1f-ac8c-4bb0-a38c-e963da8e6790.mp4

On Staging same errors login is persisted

https://user-images.githubusercontent.com/85645967/234983589-6feb2e53-8188-44a7-8371-0aaadbe19cc0.mov

Sorry, couldn't catch this sooner!

Santhosh-Sellavel avatar Apr 27 '23 20:04 Santhosh-Sellavel

np, fixed

roryabraham avatar Apr 27 '23 22:04 roryabraham

@roryabraham

This PR looks so simple but ends up being a much-complicated one. We are just running into regressions back and forth. Before moving we must just discuss and reach a consensus before move this forward.

When should we clear & when should we persist the login details? IMO

  • We should clear Login when we press Login/Create Account from the Footer
  • On All other cases we should persist and leave it as it was earlier.

I performed the following steps and attached the video below

  1. Entered email in the login field
  2. Scroll down and click Login/Create New Account
  3. Login Filed is persisted. We are okay with New behavior. ✅
  4. Click continue
  5. Go back
  6. Login Filed is persisted. ✅
  7. Repeat step 2
  8. Login field is cleared ❌ (Inconsistent)
  9. Now entered email which would trigger a server error
  10. Repeat step 2
  11. Login field is cleared ❌ (Inconsistent)
  12. Enter a new account for signup
  13. Go back
  14. Login field is cleared ❌ (Inconsistent Go back not working while signup)
  15. Enter existing account
  16. Go back
  17. Login Filed is persisted. ✅

https://user-images.githubusercontent.com/85645967/235239606-501ec3c6-442c-4949-9da5-d30f0ec5554e.mov

Santhosh-Sellavel avatar Apr 28 '23 19:04 Santhosh-Sellavel

You make a good point about how this is inconsistent. Maybe we should just say that for the sake of consistency, and for the same reasons listed here, we should never clear the login. So just close this PR and the linked issue

roryabraham avatar May 03 '23 19:05 roryabraham

I thought about auto-selecting the previous login as a convenience in case the user wants to totally change it, but that doesn't work because you can't setSelection on an email input. So I guess we should just :donothing:

roryabraham avatar May 03 '23 19:05 roryabraham

Alright, let's close this one, thanks, everyone!

Santhosh-Sellavel avatar May 03 '23 19:05 Santhosh-Sellavel