Login keyboard is not consistent in apps and browsers by ZhenjaHorbach · Pull Request #29699 · Expensify/App

ZhenjaHorbach · 2023-10-16T18:17:55Z

Login keyboard is not consistent in safari

Details

Fixed Issues

$ #28569
PROPOSAL: #28569 (comment)

Tests

Go to sign in page
Enter any email
Notice that keyboard in native app and browser web is the same

Verify that no errors appear in the JS console

Offline tests

Go to sign in page
Enter any email
Notice that keyboard in native app and browser web is the same

QA Steps

Go to sign in page
Enter any email
Notice that keyboard in native app and browser web is the same

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Not relevant

MacOS: Desktop

Not relevant

melvin-bot · 2023-10-16T18:18:00Z

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

ZhenjaHorbach · 2023-10-16T18:24:21Z

@Ollyws
Hello )
PR is ready )

Plus small clarification

I delete keyboardType={CONST.KEYBOARD_TYPE.EMAIL_ADDRESS} since this property is a priority for the keyboard in chrome android
And other properties are simply ignored

And it seems to me that in addition to the coincidence of the confirmation button on iOS app and iOS browser
We must do the same for android app and android browser

And since this input is used to enter an email or phone number
This type seems redundant

Ollyws · 2023-10-16T18:36:34Z

src/pages/signin/LoginForm/BaseLoginForm.js

                    onSubmitEditing={validateAndSubmitForm}
                    autoCapitalize="none"
                    autoCorrect={false}
-                    keyboardType={CONST.KEYBOARD_TYPE.EMAIL_ADDRESS}


This type isn't redundant, it's used to specify a specific keyboard layout:

Image

As far as android is concerned, there is no label on the enter key generally, see: https://lefkowitz.me/visual-guide-to-react-native-textinput-keyboardtype-options/

Oh, sorry
You're right
But I found an alternative solution to make sure that the icons were the same for android app and browser )

Use returnKeyType="go"

The only question

Should I leave this text for iOS or use something else?

I think go is fine, thanks.

Ollyws · 2023-10-17T11:22:50Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

N/A

Mobile Web - Chrome

Mobile Web - Safari

Desktop

N/A

iOS

Android

Ollyws

@MonilBhavsar We've gone for "Go" for the enter key label, let me know if you disagree with this, otherwise:
LGTM.

MonilBhavsar · 2023-10-17T18:29:36Z

src/pages/signin/LoginForm/BaseLoginForm.js

                    accessibilityLabel={translate('loginForm.phoneOrEmail')}
                    accessibilityRole={CONST.ACCESSIBILITY_ROLE.TEXT}
                    value={login}
+                    returnKeyType="go"


Looks like we're using "done" in PDFPasswordForm and NewContactMethod page. So may be we use "done" for consistency?

Done )
The only thing, since the confirmation icon on Android browser is tied to keyboardType, I added the condition that the Android application had the same icon as in the Android browser

In the case of iOS the text will be 'done'

cc: @Ollyws

Is platform specific key required. I see for other pages we have simple static value as 'done'

In those places where we use only 'done' the same problem )

So android does not support 'done'?
And can we please fix these places too as it does seem like an exact issue

The simpler option to keep consistency while avoiding using platform specific code would be to use returnKeyType="go" by default on every instance, instead of done.
Ofcourse on iOS that means the enter key would read go instead of done but either seems appropriate to me.
Any thoughts on this approach @MonilBhavsar ?

Okay, I am with that that as far it is consistent on all platforms. @Expensify/design could you please share your thought, if we're okay using go as return key on keyboard

For example:

@shawnborton
@dannymcclain

Hello )
Can you share your thoughts, please ?)

also cc @dubielzyk-expensify

But yeah, having "go" here makes sense to me.

Thank you! Let's use go 👍

ZhenjaHorbach · 2023-10-18T08:01:54Z

@Ollyws
@MonilBhavsar

I added a little manager for returnKeyType )

ZhenjaHorbach · 2023-10-20T09:00:48Z

@Ollyws
@MonilBhavsar
Hello )
PR is ready )

MonilBhavsar

Looks like we're missing PDFPasswordForm

ZhenjaHorbach · 2023-10-20T09:28:23Z

Looks like we're missing PDFPasswordForm

it's not necessary )
Because we don't use keyboardType for PDFPasswordForm
So the keyboard should display correctly on all platform
Although on the other hand
So that the keyboard looks the same as in other places
I'll change it )

ZhenjaHorbach · 2023-10-20T09:32:19Z

@MonilBhavsar
Done )

MonilBhavsar

Thanks!

OSBotify · 2023-10-20T09:54:09Z

✋ 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-10-20T21:37:33Z

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

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

OSBotify · 2023-10-23T04:49:45Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

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

Fix bug with keyboard is not consistent in safari

f342ea0

ZhenjaHorbach requested a review from a team as a code owner October 16, 2023 18:17

melvin-bot bot requested review from Ollyws and removed request for a team October 16, 2023 18:17

ZhenjaHorbach changed the title ~~Login keyboard is not consistent in safari~~ Login keyboard is not consistent in apps and browsers Oct 16, 2023

Update login file using formatter

fe63fc9

Ollyws reviewed Oct 16, 2023

View reviewed changes

Update text button

0abf5f5

Ollyws approved these changes Oct 17, 2023

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar October 17, 2023 11:25

MonilBhavsar reviewed Oct 17, 2023

View reviewed changes

ZhenjaHorbach added 2 commits October 18, 2023 08:30

Add condition for returnKeyType

bd3e4f4

Add getReturnKeyType function

43eb00d

Revert changes

585e890

MonilBhavsar reviewed Oct 20, 2023

View reviewed changes

Update returnKeyType for PDFPasswordForm

63218c9

MonilBhavsar approved these changes Oct 20, 2023

View reviewed changes

MonilBhavsar merged commit 69cf29e into Expensify:main Oct 20, 2023

OSBotify mentioned this pull request Oct 20, 2023

Deploy Checklist: New Expensify 2023-10-20 #30108

Closed

melvin-bot bot mentioned this pull request Oct 23, 2023

[HOLD for payment 2023-10-30] [$500] Log in - Keyboard is not consistent in safari and pressing enter does not submit a form #28569

Closed

6 tasks

Conversation

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

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 16, 2023

Uh oh!

ZhenjaHorbach commented Oct 16, 2023

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ollyws commented Oct 17, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

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

ZhenjaHorbach Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ollyws Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Choose a reason for hiding this comment

Uh oh!

ZhenjaHorbach commented Oct 18, 2023

Uh oh!

ZhenjaHorbach commented Oct 20, 2023

Uh oh!

MonilBhavsar left a comment

Choose a reason for hiding this comment

Uh oh!

ZhenjaHorbach commented Oct 20, 2023

Uh oh!

ZhenjaHorbach commented Oct 20, 2023

Uh oh!

MonilBhavsar left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 23, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

ZhenjaHorbach commented Oct 16, 2023 •

edited

Loading

Ollyws Oct 16, 2023 •

edited

Loading

ZhenjaHorbach Oct 16, 2023 •

edited

Loading

ZhenjaHorbach Oct 18, 2023 •

edited

Loading

Ollyws Oct 18, 2023 •

edited

Loading