Consistent key press focus logic between composer and emoji picker by dukenv0307 · Pull Request #31899 · Expensify/App

dukenv0307 · 2023-11-27T08:33:41Z

Details

Consistent key press focus logic between composer and emoji picker

Fixed Issues

$ #30867
PROPOSAL: #30867 (comment)

Tests

Open any report
Open emoji picker
Blur the search input
Press keys like Cmd, Control, Option, ...
Verify that on the Web and Desktop, the Emoji isn't focused

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Open any report
Open emoji picker
Blur the search input
Press keys like Cmd, Control, Option, ...
Verify that on the Web and Desktop, the Emoji isn't focused

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 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.- [x] 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 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.

Screenshots/Videos

Android: Native

Screen.Recording.2023-11-27.at.15.18.06.mov

Android: mWeb Chrome

Screen.Recording.2023-11-27.at.15.09.05.mov

iOS: Native

Screen.Recording.2023-11-27.at.15.22.34.mov

iOS: mWeb Safari

Screen.Recording.2023-11-27.at.15.05.22.mov

MacOS: Chrome / Safari

Screen.Recording.2023-11-27.at.14.59.21.mov

MacOS: Desktop

Screen.Recording.2023-11-27.at.15.24.55.mov

melvin-bot · 2023-11-27T08:33:57Z

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

robertKozik · 2023-11-29T09:09:43Z

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

Android: Native

android.mov

Android: mWeb Chrome

android.web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios.web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

robertKozik · 2023-11-29T09:10:05Z

Could you resolve conficts @dukenv0307 ?

dukenv0307 · 2023-11-29T09:17:09Z

@robertKozik I updated.

robertKozik · 2023-11-29T09:19:17Z

Great thanks! I'll proceed with the review then

robertKozik · 2023-11-29T09:22:01Z

In the meantime looks like lint is failing on ts

dukenv0307 · 2023-11-29T09:29:19Z

@robertKozik Fixed lint error.

robertKozik

Few questions

robertKozik · 2023-11-29T12:19:09Z


            focus();
-            replaceSelectionWithText(e.key, false);
+            if (e.key.length === 1) {


Moving this condition could potencially change the behaviour - regardless of e.key.length value we will focus the input. Before we would return early from the the function without trigerring focus()

@robertKozik Because now we allow focus for option, cmd, ... which isn't letter key so we should add this condition to prevent replace text when we focus on text input with this key.

Wasn't the main part of the issue to not focus on modifier keys? Copying from the expected behaviour: The Emoji search field is not focused when clicking on Modifier keys

So we would need this condition to be shared between composer and emoji picker as well

@robertKozik You're right. Updated with the correct expected.

D we still need this condition @dukenv0307 ? Beforehand in shouldAutoFocusOnKeyPress we are checking whether e.key.length >1

Yes we don't need this any more.

@robertKozik Updated.

robertKozik

LGTM

OSBotify · 2023-12-05T22:20: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.

TMisiukiewicz · 2023-12-06T09:01:56Z

-            if (keyBoardEvent.key === 'Tab' || keyBoardEvent.key === 'Enter' || (keyBoardEvent.key === 'Shift' && searchInputRef.current && !searchInputRef.current.isFocused())) {
+            if (!ReportUtils.shouldAutoFocusOnKeyPress(keyBoardEvent)) {


This change caused a regression in EmojiPickerMenu. When filtering the emoji list, it's focusing the emoji each time backspace is hit

Screen.Recording.2023-12-06.at.09.58.13.mov

OSBotify · 2023-12-06T22:17:43Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.4.9-0 🚀

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

OSBotify · 2023-12-06T23:11:54Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.4.9-0 🚀

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

OSBotify · 2023-12-08T01:09:00Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.9-5 🚀

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

consistent key press focus logic between composer and emoji picker

3bea1b5

dukenv0307 marked this pull request as ready for review November 27, 2023 08:33

dukenv0307 requested a review from a team as a code owner November 27, 2023 08:33

melvin-bot bot requested review from robertKozik and removed request for a team November 27, 2023 08:33

dukenv0307 added 2 commits November 29, 2023 16:13

Merge branch 'main' into fix/30867

bdbdc8c

fix ts check

1efd85d

fix lint

bddf958

robertKozik suggested changes Nov 29, 2023

View reviewed changes

dukenv0307 added 5 commits November 29, 2023 19:30

not focus with space key

cb738e9

fix ts

d0f3f30

merge main

ee9c915

merge main

363ccfa

remove unnecessary condition

3d4bd06

robertKozik approved these changes Dec 5, 2023

View reviewed changes

melvin-bot bot requested a review from marcaaron December 5, 2023 12:55

marcaaron approved these changes Dec 5, 2023

View reviewed changes

marcaaron merged commit e4586d0 into Expensify:main Dec 5, 2023

TMisiukiewicz reviewed Dec 6, 2023

View reviewed changes

github-actions bot mentioned this pull request Dec 6, 2023

Deploy Checklist: New Expensify 2023-12-06 #32589

Closed

74 tasks

MariaHCD mentioned this pull request Dec 7, 2023

[HOLD for payment 2023-12-18] [HOLD for payment 2023-12-15] [$500] Chat - Focus is lost after deleting letter in a word in the emoji search bar #32644

Closed

6 tasks

situchan mentioned this pull request Dec 7, 2023

[$500] Chat - When typing on emoji search the keyboard is dismissed after typing a character #32652

Closed

6 tasks

melvin-bot bot mentioned this pull request Dec 8, 2023

[HOLD for payment 2023-12-15] [$500] Chat - The Emoji search field is focused when clicking on Modifier keys #30867

Closed

6 tasks

		if (keyBoardEvent.key === 'Tab' \|\| keyBoardEvent.key === 'Enter' \|\| (keyBoardEvent.key === 'Shift' && searchInputRef.current && !searchInputRef.current.isFocused())) {
		if (!ReportUtils.shouldAutoFocusOnKeyPress(keyBoardEvent)) {

Conversation

dukenv0307 commented Nov 27, 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 Nov 27, 2023

Uh oh!

robertKozik commented Nov 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

robertKozik commented Nov 29, 2023

Uh oh!

dukenv0307 commented Nov 29, 2023

Uh oh!

robertKozik commented Nov 29, 2023

Uh oh!

robertKozik commented Nov 29, 2023

Uh oh!

dukenv0307 commented Nov 29, 2023

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

robertKozik Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

dukenv0307 Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

robertKozik Dec 1, 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!

dukenv0307 Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

robertKozik Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

dukenv0307 Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

dukenv0307 Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Dec 5, 2023

Uh oh!

TMisiukiewicz Dec 6, 2023

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Dec 6, 2023

Uh oh!

OSBotify commented Dec 6, 2023

Uh oh!

OSBotify commented Dec 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dukenv0307 commented Nov 27, 2023 •

edited

Loading

robertKozik commented Nov 29, 2023 •

edited

Loading

robertKozik Dec 1, 2023 •

edited

Loading