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

Blur login page input only when transitioned to magic link page #13265

Merged

Conversation

huzaifa-99
Copy link
Contributor

@huzaifa-99 huzaifa-99 commented Dec 2, 2022

Details

Fixed Issues

$ #13044
PROPOSAL: #13044 (comment)

Tests

Test with an existing account

  1. Go to login page
  2. Enter Email
  3. Click Continue (You should be redirected to Password Screen)
  4. Verify that the keyboard does not close and there is no jerk effect

Test with a new account

  1. Go to login page
  2. Enter email that is not yet registered
  3. Click Continue (You should be redirected to Magic Link Screen)
  4. Verify that the keyboard should dismiss

Test keyboard dismiss

  1. Go to login page
  2. Click on the input field (the virtual keyboard should open)
  3. Click outside the input field other than the continue button (the virtual keyboard should dismiss)
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Test with an existing account

  1. Go to login page
  2. Enter Email
  3. Click Continue (You should be redirected to Password Screen)
  4. Verify that the keyboard does not close and there is no jerk effect

Test with a new account

  1. Go to login page
  2. Enter email that is not yet registered
  3. Click Continue (You should be redirected to Magic Link Screen)
  4. Verify that the keyboard should dismiss

Test keyboard dismiss

  1. Go to login page
  2. Click on the input field (the virtual keyboard should open)
  3. Click outside the input field other than the continue button (the virtual keyboard should dismiss)
  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Safari
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Safari

Web.Safari.mp4

Chrome

Web.Chrome.mp4
Mobile Web - Chrome
Mobile.Chrome.mp4
Mobile Web - Safari
Mobile.Safari.mp4
Desktop
Desktop.mp4
iOS
IOS.mp4
Android
fix.hidden.keyboard.android.mp4

@huzaifa-99 huzaifa-99 requested a review from a team as a code owner December 2, 2022 06:39
@melvin-bot melvin-bot bot requested review from pecanoro and rushatgabhane and removed request for a team December 2, 2022 06:39
@melvin-bot
Copy link

melvin-bot bot commented Dec 2, 2022

@pecanoro @rushatgabhane 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]

@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2022

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@huzaifa-99
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@rushatgabhane
Copy link
Member

@huzaifa-99 wohoo! you've submitted your first PR 🎉
hoping to see you fix more issues

@huzaifa-99
Copy link
Contributor Author

@huzaifa-99 wohoo! you've submitted your first PR 🎉 hoping to see you fix more issues

Thanks, I also hope to fix more bugs 😉

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

Reviewer Checklist

@pecanoro LGTM!

  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2022-12-02.at.1.10.11.PM.mov
Mobile Web - Chrome
Screen.Recording.2022-12-02.at.1.02.58.PM.mov
Mobile Web - Safari
Screen.Recording.2022-12-02.at.1.06.58.PM.mov
Desktop
Screen.Recording.2022-12-02.at.12.55.19.PM.mov
iOS
Screen.Recording.2022-12-02.at.12.54.31.PM.mov
Android
Screen.Recording.2022-12-02.at.12.53.40.PM.mov

@tgolen
Copy link
Contributor

tgolen commented Dec 2, 2022

@huzaifa-99 Can you also please add to your tests to be sure that tapping outside of the email or password input allows the keyboard to be dismissed? We need to ensure that behavior doesn't regress at all.

I just tested it out, and it looks like tapping outside of the inputs to blur them still works, so that's good 👍

However, while testing it, I found that the original issue is still there if:

  • You press [Enter]
  • You press the [Return] button on the soft keyboard

It only appears to me like the issue is solved if you tap on the Continue button. I see that the original issue only mentions tapping on the Continue button, but should we also cover these other cases?

@huzaifa-99
Copy link
Contributor Author

huzaifa-99 commented Dec 2, 2022

Hi @tgolen, thanks for the feedback.

Can you also please add to your tests to be sure that tapping outside of the email or password input allows the keyboard to be dismissed?

Testing steps for this are added in OP.

@huzaifa-99
Copy link
Contributor Author

@tgolen I believe the original issue was focusing on the transition jerk when going from login screen to password screen which was a regression from #7604.

I am not sure if we would want to also handle the behaviour you mentioned (I however tested and the return key also works fine on my end.). Maybe @rushatgabhane can share more context?

@pecanoro
Copy link
Contributor

pecanoro commented Dec 5, 2022

You press [Enter]

What do you mean by pressing Enter? On a physical keyboard?

You press the [Return] button on the soft keyboard.

I was able to reproduce what Tim mentioned when pressing the keyboard button for Return, it closes the keyboard. However, this seems like the native behavior of the keyboard because it does the same in many other apps on my phone. Just guessing though, maybe I'm totally wrong.

I am asuming the Return button you mention is this one:

Monosnap App 2022-12-05 12-20-26

@tgolen
Copy link
Contributor

tgolen commented Dec 5, 2022

What do you mean by pressing Enter? On a physical keyboard?

Yeah, a physical keyboard. This is easy to do when testing an emulator. Granted, it won't happen much in the real world except on tablets. However, since behavior is the same as the "return button" I thought it was worth mentioning.

I am asuming the Return button you mention is this one:

Yep, exactly.

@huzaifa-99
Copy link
Contributor Author

@pecanoro I am unclear as how to. move forward.

Is it something we are implementing?

@rushatgabhane
Copy link
Member

rushatgabhane commented Dec 6, 2022

I was able to reproduce what Tim mentioned when pressing the keyboard button for Return, it closes the keyboard. However, this seems like the native behavior of the keyboard because it does the same in many other apps on my phone. Just guessing though, maybe I'm totally wrong.

@tgolen @pecanoro On pressing Return on mWeb and native, the submit button is being pressed and the keyboard is being closed.
I think we can't do anything about it because we're setting the blurOnSubmit prop correctly. So this must be native behavior

WhatsApp.Video.2022-12-06.at.18.44.09.mp4
Screen.Recording.2022-12-06.at.6.49.04.PM.mov

@pecanoro
Copy link
Contributor

pecanoro commented Dec 6, 2022

I honestly think it's native behavior, as I mentioned, I tried with other apps and it closes it every single time even when it makes sense to leave it open. @tgolen do you think we should look into it or can we move forward with merging it as it is right now.

@tgolen
Copy link
Contributor

tgolen commented Dec 6, 2022

Yeah, I also agree that it's native behavior. I mostly bring it up so that we can all agree that in some cases, we just won't be able to avoid it, and that's probably OK.

@pecanoro pecanoro merged commit 5869c66 into Expensify:main Dec 6, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Dec 6, 2022

✋ 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

🚀 Deployed to production by @chiragsalian in version: 1.2.38-6 🚀

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

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.

5 participants