fix/16098: Listen keydown from user to focus again the composer #17138

tienifr · 2023-04-07T17:00:59Z

Details

We should automatically focus on the Composer if we press on regular characters like a, b, c, d, ... (not non-character keys like Enter, Shift) when we're not typing on any input or textarea.

Fixed Issues

$ #16098
PROPOSAL: #16098 (comment)

Tests

Go to any chats
Click on any message
Press any character keys like a,b,c,d (not non-character keys like Enter, Shift)
Verify that the composer is focused again and the above character is entered in the composer

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to any chats
Click on any message
Press any character keys like a,b,c,d (not non-character keys like Enter, Shift)
Verify that the composer is focused again and the above character is entered in the composer

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-08.at.00.50.34.mov

Mobile Web - Chrome

RPReplay_Final1680890370.mp4

Mobile Web - Safari

RPReplay_Final1680890255.mp4

Desktop

Screen.Recording.2023-04-08.at.01.07.15.mov

iOS

Screen-Recording-2023-04-08-at-01.06.13.mp4

Android

Screen.Recording.2023-04-08.at.01.27.23.mov

MelvinBot · 2023-04-07T18:16:28Z

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

PauloGasparSv · 2023-04-07T19:00:16Z

Won't be able to review this Today but will prioritize it on Monday!

rushatgabhane · 2023-04-10T10:17:51Z

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

Screen.Recording.2023-04-10.at.13.21.06.mov

Mobile Web - Chrome

N.A.

Mobile Web - Safari

N.A.

Desktop

Screen.Recording.2023-04-10.at.14.15.16.mov

iOS

no crash

Android

No crash

rushatgabhane

@tienifr nice polish to the UX!

Left a few minor style change requests

rushatgabhane · 2023-04-10T10:28:00Z

src/pages/home/report/ReportActionCompose/listenKeyDown.js

@@ -0,0 +1,5 @@
+function listenKeyDown(callback) {
+    document.addEventListener('keydown', callback);


@tienifr nitpick: style change -

condense listenKeyDown and removeListenKeyDown to a single file.

src/pages/home/report/ReportActionCompose/index.js

rushatgabhane · 2023-04-10T10:30:29Z

src/pages/home/report/ReportActionCompose/index.js

@@ -255,6 +261,7 @@ class ReportActionCompose extends React.Component {
    }

    componentWillUnmount() {
+        removeListenKeyDown(this.keydownListener);


We should perform this only if keydownListener is not null

Suggested change

removeListenKeyDown(this.keydownListener);

if (this.keydownListener) {

removeListenKeyDown(this.keydownListener);

Co-authored-by: Rushat Gabhane <[email protected]>

rushatgabhane

@PauloGasparSv LGTM! 🎉

appreciate the quick work @tienifr 🚀

PauloGasparSv · 2023-04-10T13:40:12Z

Hey, the changes here are looking great!!! I'm testing on all platforms here too.

I'm testing if it's ok to introduce the following behavior though. In Web/Desktop if we have a chat open and we access the Profile Settings (or any other "page") and start typing stuff it will focus on the composer and add the input there.

That makes total sense but may be confusing to the user, for example in Desktop Web:

Screen.Recording.2023-04-10.at.10.26.27.mov

And Desktop Web with a small screen (mobile mode). This one may be a problem but I don't think it's worth solving since no one will probably use the Web version like this.

mWeb.Desktop.mov

I'm checking if this happens on mWeb too and if there is a simple fix for this. If there isn't IMO we should send a message in #expensify-open-source to get other people's opinions (mine is Do Nothing).

rushatgabhane · 2023-04-10T15:22:33Z

@tienifr is there a simple solution to the problems @PauloGasparSv mentioned maybe?

Can we check if the page is active?

tienifr · 2023-04-10T16:12:20Z

@rushatgabhane Please help to check my small fix for the above problem

rushatgabhane · 2023-04-10T16:20:25Z

@tienifr instead of checking visibility inside component did update, can we modify the callback function for the event listener to return early if modal isn't visible?

tienifr · 2023-04-10T16:28:28Z

@rushatgabhane Your suggestion is so great. Just updated

PauloGasparSv · 2023-04-10T16:29:36Z

Amazing!!! Re-testing here in a bit!

rushatgabhane

@tienifr non-blocking bug:

Go to mWeb
Open LHN
Type "123"
Go to the most recent chat

Typing while on LHN page in mWeb types into the composer

@tienifr is there an easy way to find if LHN is being focused?

Screen.Recording.2023-04-11.at.00.22.31.mov

rushatgabhane

@PauloGasparSv nice catch with the bug related to RHN

LGTM!

Screen.Recording.2023-04-11.at.00.19.49.mov

Screen.Recording.2023-04-11.at.00.18.18.mov

tienifr · 2023-04-12T14:53:32Z

@PauloGasparSv Just updated

PauloGasparSv

LGTM!

Web

Screen.Recording.2023-04-12.at.13.55.45.mov

Desktop

Screen.Recording.2023-04-12.at.14.02.49.mov

iOS Native

Screen.Recording.2023-04-12.at.14.31.49.mov

iOS mWeb

Screen.Recording.2023-04-12.at.14.34.56.mov

Android Native

Screen.Recording.2023-04-12.at.14.57.10.mov

Android mWeb

Screen.Recording.2023-04-12.at.14.45.41.mov

PauloGasparSv · 2023-04-12T17:59:28Z

Hey @tienifr can you also mention in the QA steps that the behaviour should only work for Desktop and Desktop Web?

OSBotify · 2023-04-12T18:05:04Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

getusha · 2023-04-12T20:04:43Z

Hey guys! just noticed a regression reported it here,
We can fix that by checking if key.metaKey to check if the user is using shortcuts and return early.

cc: @PauloGasparSv @rushatgabhane @tienifr

OSBotify · 2023-04-13T03:43:39Z

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.0-0 🚀

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

getusha · 2023-04-13T19:58:21Z

Is this a deploy blocker?
Looks like related to this PR
https://expensify.slack.com/archives/C049HHMV9SM/p1681367247044099

cc: @PauloGasparSv @rushatgabhane @tienifr

PauloGasparSv · 2023-04-13T20:34:06Z

Taking a look at that, I think everyone else is out right now.

parasharrajat · 2023-04-14T17:48:23Z

There are many regressions being reported from this PR. Can we please revert this @rushatgabhane? Let me know if you need a hand with that.

PauloGasparSv · 2023-04-14T17:49:35Z

There are many regressions being reported from this PR. Can we please revert this @rushatgabhane?

Was about to comment that after seeing this.

PauloGasparSv · 2023-04-14T17:51:44Z

We should also revert #17360

parasharrajat · 2023-04-14T17:54:12Z

Yes and then work on a new PR with all the fixes merged and everything tested. We can just also skip the issue as I don't see a strong need to have that feature.

PauloGasparSv · 2023-04-14T20:40:37Z

Bump @tienifr too, can you take a look at this and help revert both P.R.'s?

This reverts commit f496b9f, reversing changes made to 34c5155.

OSBotify · 2023-04-17T22:58:05Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.0-2 🚀

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

OSBotify · 2023-04-18T04:39:27Z

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.1-0 🚀

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

OSBotify · 2023-04-18T06:09:03Z

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.1-0 🚀

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

OSBotify · 2023-04-19T17:22:12Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.1-3 🚀

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

tienifr added 3 commits April 7, 2023 22:51

fix: listen keydown from user to focus again the composer

2e3fbf3

fix: rename

e0ed40a

fix: move this fix to web only

a5d171b

tienifr marked this pull request as ready for review April 7, 2023 18:16

tienifr requested a review from a team as a code owner April 7, 2023 18:16

melvin-bot bot requested review from PauloGasparSv and rushatgabhane and removed request for a team April 7, 2023 18:16

tienifr added 2 commits April 8, 2023 01:23

fix: remove redundant

c0c962d

fix: issue

0c2f048

tienifr mentioned this pull request Apr 7, 2023

[HOLD for payment 2023-07-21] [$2000] Selecting a chat message and pressing any key focus the message instead of switching the focus to the composer. #16098

Closed

6 tasks

PauloGasparSv assigned tienifr Apr 7, 2023

rushatgabhane suggested changes Apr 10, 2023

View reviewed changes

tienifr and others added 2 commits April 10, 2023 17:51

Update src/pages/home/report/ReportActionCompose/index.js

5d8e795

Co-authored-by: Rushat Gabhane <[email protected]>

fix: condense keydownAction to single file

81e7870

rushatgabhane previously approved these changes Apr 10, 2023

View reviewed changes

fix: only listen when report screen is active

74d52fa

tienifr dismissed rushatgabhane’s stale review via 74d52fa April 10, 2023 16:11

fix: only listen when report screen is active

ca06ffb

rushatgabhane suggested changes Apr 10, 2023

View reviewed changes

rushatgabhane previously approved these changes Apr 10, 2023

View reviewed changes

PauloGasparSv approved these changes Apr 12, 2023

View reviewed changes

PauloGasparSv merged commit f496b9f into Expensify:main Apr 12, 2023

OSBotify mentioned this pull request Apr 13, 2023

Deploy Checklist: New Expensify 2023-04-13 #17379

Closed

26 tasks

bernhardoj mentioned this pull request Apr 13, 2023

Create a common function to insert an emoji into a text #17346

Merged

56 tasks

This was referenced Apr 13, 2023

[HOLD for payment 2023-04-26] [HOLD for payment 2023-04-24] Web - Chat - Typing from emoji picker also fills composer input unnecessarily #17413

Closed

Use DOM activeElement instead of event target in composer focus logic #17428

Closed

getusha mentioned this pull request Apr 14, 2023

[$1000] Pressing space key scrolls chat and brings focus to the composer #17465

Closed

6 tasks

tienifr added a commit to tienifr/App that referenced this pull request Apr 15, 2023

Revert "Merge pull request Expensify#17138 from tienifr/fix/16098"

d82c654

This reverts commit f496b9f, reversing changes made to 34c5155.

tienifr mentioned this pull request Apr 15, 2023

Revert: 17138 17360 listen keydown from user #17475

Merged

56 tasks

PauloGasparSv pushed a commit that referenced this pull request Apr 17, 2023

Resolving merge conflict to CP and revert #17138 and #17360

8937574

OSBotify mentioned this pull request Apr 17, 2023

Deploy Checklist: New Expensify 2023-04-17 #17546

Closed

53 tasks

kbecciv mentioned this pull request Apr 18, 2023

Web - Chat - Composer is not focused upon pressing characters like a,b,c,d #17604

Closed

6 tasks

dukenv0307 mentioned this pull request Jul 2, 2023

[HOLD for payment 2023-08-07] [$1000] In emoji picker, clicking on spacebar leaves selected/highlight focus on emoji #21806

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix/16098: Listen keydown from user to focus again the composer #17138

fix/16098: Listen keydown from user to focus again the composer #17138

tienifr commented Apr 7, 2023 •

edited

Loading

MelvinBot commented Apr 7, 2023

PauloGasparSv commented Apr 7, 2023

rushatgabhane commented Apr 10, 2023 •

edited

Loading

rushatgabhane left a comment

rushatgabhane Apr 10, 2023

rushatgabhane Apr 10, 2023

rushatgabhane left a comment •

edited

Loading

PauloGasparSv commented Apr 10, 2023

rushatgabhane commented Apr 10, 2023

tienifr commented Apr 10, 2023

rushatgabhane commented Apr 10, 2023 •

edited

Loading

tienifr commented Apr 10, 2023

PauloGasparSv commented Apr 10, 2023

rushatgabhane left a comment •

edited

Loading

rushatgabhane left a comment

tienifr commented Apr 12, 2023

PauloGasparSv left a comment

PauloGasparSv commented Apr 12, 2023

OSBotify commented Apr 12, 2023

getusha commented Apr 12, 2023

OSBotify commented Apr 13, 2023

getusha commented Apr 13, 2023

PauloGasparSv commented Apr 13, 2023

parasharrajat commented Apr 14, 2023 •

edited

Loading

PauloGasparSv commented Apr 14, 2023

PauloGasparSv commented Apr 14, 2023

parasharrajat commented Apr 14, 2023

PauloGasparSv commented Apr 14, 2023

OSBotify commented Apr 17, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 19, 2023

		@@ -0,0 +1,5 @@
		function listenKeyDown(callback) {
		document.addEventListener('keydown', callback);

	removeListenKeyDown(this.keydownListener);
	if (this.keydownListener) {
	removeListenKeyDown(this.keydownListener);

fix/16098: Listen keydown from user to focus again the composer #17138

fix/16098: Listen keydown from user to focus again the composer #17138

Conversation

tienifr commented Apr 7, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 7, 2023

PauloGasparSv commented Apr 7, 2023

rushatgabhane commented Apr 10, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment

Choose a reason for hiding this comment

rushatgabhane Apr 10, 2023

Choose a reason for hiding this comment

rushatgabhane Apr 10, 2023

Choose a reason for hiding this comment

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

PauloGasparSv commented Apr 10, 2023

rushatgabhane commented Apr 10, 2023

tienifr commented Apr 10, 2023

rushatgabhane commented Apr 10, 2023 • edited Loading

tienifr commented Apr 10, 2023

PauloGasparSv commented Apr 10, 2023

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

rushatgabhane left a comment

Choose a reason for hiding this comment

tienifr commented Apr 12, 2023

PauloGasparSv left a comment

Choose a reason for hiding this comment

PauloGasparSv commented Apr 12, 2023

OSBotify commented Apr 12, 2023

getusha commented Apr 12, 2023

OSBotify commented Apr 13, 2023

getusha commented Apr 13, 2023

PauloGasparSv commented Apr 13, 2023

parasharrajat commented Apr 14, 2023 • edited Loading

PauloGasparSv commented Apr 14, 2023

PauloGasparSv commented Apr 14, 2023

parasharrajat commented Apr 14, 2023

PauloGasparSv commented Apr 14, 2023

OSBotify commented Apr 17, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 19, 2023

tienifr commented Apr 7, 2023 •

edited

Loading

rushatgabhane commented Apr 10, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

rushatgabhane commented Apr 10, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

parasharrajat commented Apr 14, 2023 •

edited

Loading