feat: blur the composer focus when open context menu by dominictb · Pull Request #47621 · Expensify/App

dominictb · 2024-08-19T05:12:37Z

Details

Fixed Issues

$ #44042
PROPOSAL: #44042 (comment)

Tests

Go to any chat
Click on the composer to bring the keyboard (if its not already open)
While the keyboard is open long press on a message to bring the action menu

Verify that: The keyboard closes when the action menu is opened

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to any chat
Click on the composer to bring the keyboard (if its not already open)
While the keyboard is open long press on a message to bring the action menu

Verify that: The keyboard closes when the action menu is opened

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

compressed_android.webm.mp4

Android: mWeb Chrome

compressed_aweb.webm.mp4

iOS: Native

compressed_ios.mp4.mp4

iOS: mWeb Safari

compressed_iosweb.mp4.mp4

MacOS: Chrome / Safari

compressed_web.mov.mp4

MacOS: Desktop

compressed_web.mov.mp4

dominictb · 2024-08-20T15:11:11Z

Small note: refocusing the edit composer after closing context menu will be handled here: #28238

melvin-bot · 2024-08-20T15:30:41Z

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

rojiphil

@dominictb Thanks for the PR. I have just left a couple of review comments. Please have a look.

rojiphil · 2024-09-02T19:32:12Z

src/pages/home/report/ReportActionItem.tsx

            }

+            ReportActionComposeFocusManager.composerRef.current?.blur();
+            ReportActionComposeFocusManager.editComposerRef.current?.blur();


Instead of calling individual blur, can we define a utility function in ReportActionComposeFocusManager and call blur when focussed? I think that would be neater.

hmm let me check on this.

rojiphil · 2024-09-02T19:42:34Z

src/pages/home/report/ReportActionItemMessageEdit.tsx

                            onFocus={() => {
                                setIsFocused(true);
+                                if (textInputRef.current) {
+                                    ReportActionComposeFocusManager.editComposerRef.current = textInputRef.current;


Let us reset the editComposerRef when the focus is lost to avoid dangling references. One way to do this is by resetting it inside ReportActionComposeFocusManager.clear.

I think we shouldn't reset editComposerRef since we use it to restore focus in case users open edit emoji picker then dismiss it

Maybe I am missing something here but why would we need editComposerRef after ReportActionComposeFocusManager.clear is called here?

Ah, when ReportActionComposeFocusManager.clear we can reset editComposerRef, but not when the focus is lost. So you mean to reset it when the edit composer disappears (not when it's blurred), right?

when ReportActionComposeFocusManager.clear we can reset editComposerRef

Yes, that's what I meant

Can you please check if we also have to set the editComposerRef on component mount of ReportActionItemMessageEdit because I ran into issues where the edit composer did not blur as editComposerRef was not set at all? Here is a video that demonstrates this. Please have a look.

47621-mweb-safari-blurissue.mp4

Let me check this and get back to you.

@rojiphil after testing, there's a small change needed to fix this issue. As ReportActionComposeFocusManager.clear(); is triggered in both main and edit composer, when users open new edit composer, editComposerRef is set, then the logic clear

App/src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.tsx

Line 645 in 14b99ca

ReportActionComposeFocusManager.clear();

in main composer would reset editComposerRef

-> It’s wrong since the edit composer is still open

I think we should set/reset editComposerRef in ReportActionItemMessageEdit. I have pushed the latest commit with the change.

dominictb · 2024-09-04T10:57:19Z

Will look into this

dominictb · 2024-09-09T08:25:50Z

On it now.

rojiphil · 2024-09-13T04:56:45Z

@dominictb There are conflicts that must be resolved. Please resolve and ping me here when ready for review. Thanks.

rojiphil

@dominictb I have left few comments. Please have a look.

rojiphil · 2024-09-14T17:28:56Z

src/libs/ReportActionComposeFocusManager.ts

    if (isPriorityCallback) {
        priorityFocusCallback = null;
    } else {
+        editComposerRef.current = null;


Don't we have to reset editComposerRef when isPriorityCallback is true because we call clear(true) in ReportActionItemMessageEdit?

rojiphil · 2024-09-14T17:48:59Z

src/pages/home/report/ReportActionItemMessageEdit.tsx

                            onFocus={() => {
                                setIsFocused(true);
+                                if (textInputRef.current) {
+                                    ReportActionComposeFocusManager.editComposerRef.current = textInputRef.current;


Can you please check if we also have to set the editComposerRef on component mount of ReportActionItemMessageEdit because I ran into issues where the edit composer did not blur as editComposerRef was not set at all? Here is a video that demonstrates this. Please have a look.

47621-mweb-safari-blurissue.mp4

dominictb · 2024-09-17T07:09:54Z

On it now.

dominictb · 2024-09-20T07:15:23Z

https://github.com/Expensify/App/pull/47621/files#diff-f0bdc7ab41060e24e6bcdc847f25185b372c5f9a072251fe5d3cae2a27887920L85-L96 Migrating withOnyx to useOnyx in this case seems non-trivial. Could we skip this in this PR?

dominictb · 2024-09-30T03:12:06Z

waiting on @rojiphil's review.

rojiphil · 2024-09-30T04:50:30Z

waiting on @rojiphil's review.

@dominictb Can you please merge with the latest main? I will review this today.
I am also expecting the eslint error to go away once you merge.

rojiphil

@dominictb Thanks for the merge. I have left some more review comments. Please have a look.

rojiphil · 2024-09-30T07:09:28Z

src/pages/home/report/ReportActionItemMessageEdit.tsx

                            onFocus={() => {
                                setIsFocused(true);
-                                if (textInputRef.current) {
-                                    ReportActionComposeFocusManager.editComposerRef.current = textInputRef.current;


I am not sure why we removed this as I think we need to set the editComposerRef here too i.e. when the edit composer receives focus as there will be cases where the edit composer is mounted but the focus has changed. Here is a test video demonstrating the problem

47621-focus-issue-1.mp4

rojiphil · 2024-09-30T08:56:21Z

src/pages/home/report/ReportActionItemMessageEdit.tsx

+                ReportActionComposeFocusManager.editComposerRef.current = textInputRef.current;
+            }
+            return () => {
+                ReportActionComposeFocusManager.editComposerRef.current = null;


As mentioned here already, we just had to reset the editComposerRef when isPriorityCallback is true because we call clear(true) in ReportActionItemMessageEdit here. Can we move the code to reset the editComposerRef to within ReportActionComposeFocusManager:clear?

Yes, we can. I'll update soon

@rojiphil I updated

rojiphil · 2024-09-30T08:57:10Z

src/pages/home/report/ReportActionItemMessageEdit.tsx

+            }
+            return () => {
+                ReportActionComposeFocusManager.editComposerRef.current = null;
+                ReportActionComposeFocusManager.clear(true);


There is already a code used for handling unmount as mentioned here. Let us use that code to avoid duplicate coding.

Also, shouldn't it be ReportActionComposeFocusManager.clear(); here as we do not want to reset the editcomposer if focus already exists on another edit item. Here is a test video demonstrating the problem:

47621-clear-issue-1.mp4

Here's the result after refactoring

Screen.Recording.2024-10-01.at.11.21.52.mov

dominictb · 2024-10-01T11:20:39Z

@rojiphil updated. Please re-review.

rojiphil

@dominictb The following comments are not addressed yet:

The comment here
The comment here
The following comment here

1 Also, shouldn't it be ReportActionComposeFocusManager.clear(); here as we do not want to reset the editcomposer if focus already exists on another edit item. Here is a test video demonstrating the problem:

dominictb · 2024-10-02T11:29:40Z

Also, shouldn't it be ReportActionComposeFocusManager.clear(); here as we do not want to reset the editcomposer if focus already exists on another edit item

You're right, I think we just call ReportActionComposeFocusManager.clear(true) when editComposerRef === textInputRef.current. Any thoughts?

rojiphil · 2024-10-02T16:38:21Z

Also, shouldn't it be ReportActionComposeFocusManager.clear(); here as we do not want to reset the editcomposer if focus already exists on another edit item

You're right, I think we just call ReportActionComposeFocusManager.clear(true) when editComposerRef === textInputRef.current. Any thoughts?

Yes. That make sense.

rojiphil · 2024-10-02T16:43:16Z

The comment here

Isn't this pending to be addressed?

2. The comment here

Ok. This is addressed. Thanks.

3. The following comment here

1 Also, shouldn't it be ReportActionComposeFocusManager.clear(); here as we do not want to reset the editcomposer if focus already exists on another edit item. Here is a test video demonstrating the problem:

And this is addressed here

dominictb · 2024-10-03T04:08:42Z

The comment #47621 (comment)

Addressed in the latest commit.

dominictb · 2024-10-03T04:17:25Z

#47621

Fixed in the latest commit.

rojiphil · 2024-10-08T09:45:25Z

@dominictb This looks much closer to getting it done. Can you please merge it with the latest main?

dominictb · 2024-10-08T13:39:09Z

@rojiphil done!

rojiphil · 2024-10-09T19:50:12Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

iOS: mWeb Safari

47621-mweb-safari-005.mp4

Android: Native

47621-android-native-005.mp4

Android: mWeb Chrome

47621-mweb-chrome-005.mp4

iOS: Native

47621-ios-native-005.mp4

MacOS: Chrome / Safari

47621-web-safari-005.mp4

MacOS: Desktop

47621-desktop-005.mp4

mWeb Safari - Original Issue

47621-mweb-safari-issue-repro.mp4

rojiphil

@dominictb Thanks. I have just one comment related to test steps.
Please update the test cases as follows to include testing for editable messages:

Note: Tests are applicable only for native and mweb platforms.

Go to any chat
Click on the composer to bring the keyboard (if its not already open)
While the keyboard is open long press on a message to bring the action menu
Verify that the keyboard closes when the action menu is opened (Test 1)
Click and focus inside an editable message so that the keyboard is displayed.
While the keyboard is open long press on any other message to bring the action menu.
Verify that the keyboard closes when the action menu is opened (Test 2)

@cead22 LGTM and works well too.
Over to you for review. Thanks.

cead22 · 2024-10-09T21:30:38Z

@rojiphil I see a console warning on your iOS video for "Function components cannot be given refs", is that the same as the one in this issue #49062? If so, do we need to merge main into this branch to solve it? If it's different please report it in GH or slack, and don't forget checking for console errors is part of the checklist

rojiphil · 2024-10-10T05:28:38Z

I see a console warning on your iOS video for "Function components cannot be given refs", is that the same as the one in this issue #49062? If so, do we need to merge main into this branch to solve it? If it's different please report it in GH or slack, and don't forget checking for console errors is part of the checklist

The warning is the same but this comes up in another flow. I have reported the same in slack here

cead22 · 2024-10-10T17:31:14Z

They linked the same GH issue #49062 on that slack thread. So let's merge main into this branch, test again, and if it doesn't happen, problem solved.

If it does happen, we need to open a new GH issue to solve this for the flow in which is happening

rojiphil · 2024-10-11T07:23:48Z

They linked the same GH issue #49062 on that slack thread. So let's merge main into this branch, test again, and if it doesn't happen, problem solved.

If it does happen, we need to open a new GH issue to solve this for the flow in which is happening

I still think they have got it wrong as I could reproduce this in the latest main and the mentioned duplicate issue's PR has already been merged since last one week. And our PR also contains that code. Anyway, I have responded to this in slack here.

Meanwhile, I think we can go ahead and merge this as we have reported it.

OSBotify · 2024-10-11T16:01:52Z

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

github-actions · 2024-10-15T03:29:47Z

🚀 Deployed to staging by https://github.com/cead22 in version: 9.0.49-0 🚀

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

github-actions · 2024-10-17T01:44:42Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.49-2 🚀

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

feat: blur the composer focus when open context menu

c66dd94

fix: assign editComposerRef when focus

9dd2342

dominictb marked this pull request as ready for review August 20, 2024 15:30

dominictb requested a review from a team as a code owner August 20, 2024 15:30

melvin-bot bot requested review from rojiphil and removed request for a team August 20, 2024 15:30

bernhardoj mentioned this pull request Aug 20, 2024

Fix composer selection is at start after when copying link to a message #47596

Merged

50 tasks

rojiphil reviewed Sep 2, 2024

View reviewed changes

chore: add blurAll utility to ReportActionComposeFocusManager

80bd82e

fix: reset editComposerRef when clear focus manager

dec716c

CortneyOfstad mentioned this pull request Sep 11, 2024

[HOLD for payment 2024-10-24] [$250] mWeb/Safari - Chat - Keyboard does not close when action menu opens #44042

Closed

6 tasks

Merge remote-tracking branch 'origin/main' into fix/44042-close-keyboard

5c0ebae

rojiphil reviewed Sep 14, 2024

View reviewed changes

dominictb added 3 commits September 17, 2024 14:12

Merge remote-tracking branch 'origin/main' into fix/44042-close-keyboard

bd065ee

fix: unsert editComposerRef whenever focusManager clears

edb8fb2

fix: assign editComposerRef when ReportActionItemMessageEdit mounts

6b686ba

Merge remote-tracking branch 'origin/main' into fix/44042-close-keyboard

2cf341b

rojiphil reviewed Sep 30, 2024

View reviewed changes

chore: remove redundant useEffects and refactor code

56499bc

rojiphil suggested changes Oct 1, 2024

View reviewed changes

fix: set editComposerRef when focusing

de12e1a

fix: do not clear focus callback if ref doesn't match

3ab551c

fix: prettier

b19ef5c

Merge remote-tracking branch 'origin/main' into fix/44042-close-keyboard

21d0f80

rojiphil approved these changes Oct 9, 2024

View reviewed changes

melvin-bot bot requested a review from cead22 October 9, 2024 19:55

cead22 approved these changes Oct 9, 2024

View reviewed changes

cead22 merged commit 2014ab8 into Expensify:main Oct 11, 2024

github-actions bot mentioned this pull request Oct 15, 2024

Deploy Checklist: New Expensify 2024-10-15 #50764

Closed

71 tasks

andriivitiv mentioned this pull request Oct 17, 2024

[HOLD for payment 2024-11-05] [$250] mWeb -Chat - Cursor of compose box appears through options after long pressing message #50661

Closed

6 tasks

Conversation

dominictb commented Aug 19, 2024 • 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!

dominictb commented Aug 20, 2024

Uh oh!

melvin-bot bot commented Aug 20, 2024

Uh oh!

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

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dominictb commented Sep 4, 2024

Uh oh!

dominictb commented Sep 9, 2024

Uh oh!

rojiphil commented Sep 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

dominictb commented Sep 17, 2024

Uh oh!

dominictb commented Sep 20, 2024

Uh oh!

dominictb commented Sep 30, 2024

Uh oh!

rojiphil commented Sep 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rojiphil left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rojiphil Sep 30, 2024 • 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!

dominictb commented Aug 19, 2024 •

edited

Loading

rojiphil commented Sep 13, 2024 •

edited

Loading

rojiphil commented Sep 30, 2024 •

edited

Loading

rojiphil Sep 30, 2024 •

edited

Loading

rojiphil commented Oct 9, 2024 •

edited

Loading

rojiphil left a comment •

edited

Loading

cead22 commented Oct 10, 2024 •

edited

Loading