fix keyboard flashing while clicking "Add attachment" #23994

ntdiary · 2023-08-01T12:43:37Z

Details

Notes:

Browser versions that support input cancel event: Chrome 113+ / Firefox 91+ / Safari 16.4+
Due to browser engine limitations, safari can only refocus, not open the keyboard.
Our debug version of the app appears a bit slow, but the release version will be smoother.

Fixed Issues

$ #13922
PROPOSAL: #13922 (comment)

Tests

case 1:

Open any chat.
Focus the composer to open the keyboard.
Click plus icon in the composer, and then click Add Attachment.
Verify that the keyboard doesn't show briefly before the next modal appears.

case 2:

Open any chat.
Focus the composer to open the keyboard.
Click plus icon in the composer.
Click the backdrop.
Verify that the keyboard will reopen.

case 3:

Open any chat.
Focus the composer to open the keyboard.
Click plus icon in the composer, and then click Add Attachment.
Click the backdrop (only for mobile) or Cancel button to exit the attachment flow.
Verify that the keyboard will reopen.

case 4:

Open any chat.
Focus the composer to open the keyboard.
Click plus icon in the composer, and then click Add Attachment.
Select an attachment.
Click the back button in the top left or the send button below to hide the preview modal.
Verify that the keyboard will reopen.

Verify that no errors appear in the JS console

Offline tests

QA Steps

case 1:

Open any chat.
Focus the composer to open the keyboard.
Click plus icon in the composer, and then click Add Attachment.
Verify that the keyboard doesn't show briefly before the next modal appears.

case 2:

Open any chat.
Focus the composer to open the keyboard.
Click plus icon in the composer.
Click the backdrop.
Verify that the keyboard will reopen.

case 3:

Open any chat.
Focus the composer to open the keyboard.
Click plus icon in the composer, and then click Add Attachment.
Click the backdrop (only for mobile) or Cancel button to exit the attachment flow.
Verify that the keyboard will reopen.

case 4:

Open any chat.
Focus the composer to open the keyboard.
Click plus icon in the composer, and then click Add Attachment.
Select an attachment.
Click the back button in the top left or the send button below to hide the preview modal.
Verify that the keyboard will reopen.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari.mp4

Desktop

desktop.mp4

iOS

ios-app.mp4

Android

android-app.mp4

shubham1206agra · 2023-08-01T13:12:30Z

Please do not merge this before #18507

melvin-bot · 2023-08-01T17:23:56Z

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

ntdiary · 2023-08-03T10:28:16Z

@thesahindia, hi, if there are anything that needs to be revised, please feel free to let me know. 😄

ntdiary · 2023-08-07T10:39:46Z

We need to wait at least until PR #24184 is merged, because the attachment workflow on the main branch is currently broken.

aimane-chnaif · 2023-08-07T16:33:42Z

@ntdiary it's merged. You can continue

thesahindia · 2023-08-07T16:37:08Z

Cool! @ntdiary, ping me once you resolve the conflicts. I will prioritize the review on this.

P.S. Sorry for the delay!

ntdiary · 2023-08-07T18:37:11Z

@thesahindia no worries. Resolved. : )

ntdiary · 2023-08-08T15:32:10Z

@thesahindia, kindly reminder for the review 🙂

thesahindia · 2023-08-08T20:35:24Z

I only need to test ios now. I will get back to it tomorrow.

ntdiary · 2023-08-12T08:49:31Z

Resolve the conflict again and await review. 🙂

bernhardoj · 2023-08-12T09:23:16Z

@ntdiary hi, I see a similar issue here. Do you think it's gonna be fixed by this PR?

ntdiary · 2023-08-12T13:52:01Z

@ntdiary hi, I see a similar issue #24452. Do you think it's gonna be fixed by this PR?

@bernhardoj, so far, based on the previous discussion, the current code only fixes the flashing issue in the attachment flow. Of course, if needed, it can also be extended to fix the IOU flow, however it requires us to first confirm the expected behavior (so we can have as consistent of a user experience across platforms as possible) 🙂

ntdiary · 2023-08-15T09:57:16Z

@situchan, a kindly reminder for the review. 🙂

situchan · 2023-08-15T09:57:50Z

reviewing today

situchan

I think we should fix emoji picker as well as they have the same root cause

situchan · 2023-08-15T10:00:08Z

src/components/Modal/BaseModal.js

@@ -73,6 +74,9 @@ class BaseModal extends PureComponent {
            this.props.onModalHide();
        }
        Modal.onModalDidClose();
+        if (!this.props.fullscreen) {


what's this condition for?

Ensure that the pending promise can also be settled when coverScreen is false, because onDismiss will not be emitted in this case. (It only exists in the RN Modal component.)

Hey @ntdiary, I know this thread is kinda old, but would appreciate your input:
Why was it necessary to put the ComposerFocusManager.setReadyToFocus() logic into both onDismiss and onModalHide (which calls hideModal)?
Was there any drawback to just calling it in hideModal regardless of the fullscreen condition? This would mean removing the ReactNativeModal.onDismiss prop below.
I'm asking because we've recently discovered another case when the onDismiss is not called, this time for a full-screen Attachments modal.

@paultsimura, when using the Modal component, the invocation of onModalHide happens earlier than the destruction of the focus trap, which will cause the composer not gaining focus correctly after the modal is dismissed. :)

Thanks @ntdiary. Do you have any particular Modal scenario in mind that might break?
I tried with only the hideModal: emoji picker, attachments modal, the side drawer – everything focuses the composer correctly

@paultsimura, I'm not exactly sure about the new code in the main branch, maybe you can verify the emoji picker in mobile chrome. Additionally, I'm refactoring the modal's refocusing behavior (#29199), so there might be a chance to review the related code again tomorrow. :)

Cool, would your change cover the modal being closed on clicking the browser's "Back" button as well?

Yeah, I added a new ModalContent, I feel it should fix that issue.

situchan · 2023-08-15T10:04:21Z

src/libs/ComposerFocusManager.js

@@ -0,0 +1,23 @@
+let isReadyToFocusPromise = Promise.resolve();


Do we need this logic on web at all?

Yeah, the Modal component in react-native-web has focus trap. This code, together with InteractionManager.runAfterInteractions, can also ensure that the focus is called safely.

ntdiary · 2023-08-23T14:10:37Z

So we can continue to the review?

situchan · 2023-08-23T14:17:33Z

So we can continue to the review?

yes, was doing thorough test.

situchan · 2023-08-23T14:20:17Z

Inconsistency: after opening emoji picker modal while composer is not focused, composer is auto focused on modal close
This also happens on main so out of scope

Screen.Recording.2023-08-23.at.8.16.40.PM.mov

situchan · 2023-08-23T14:40:30Z

@ntdiary Opposite of Case 2 fails on android chrome, though happens on staging.

Repro step:

Open any chat
Blur the composer if already focused
Click plus icon in the composer
Click the backdrop
Verify that the keyboard won't open and composer is still unfocused

ntdiary · 2023-08-23T15:06:18Z

@situchan, Uh, yeah, on android chrome, closing the modal will show the keyboard event if the composer was previously blurred, which is exactly what willBlurTextInputOnTapOutside is meant to address.

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

Lines 985 to 990 in 867d61e

    
           // We want to focus or refocus the input when a modal has been closed or the underlying screen is refocused. 
        
           // We avoid doing this on native platforms since the software keyboard popping 
        
           // open creates a jarring and broken UX. 
        
           if (!(willBlurTextInputOnTapOutside && !modal.isVisible && isFocusedProp && (prevIsModalVisible || !prevIsFocused))) { 
        
               return; 
        
           }

situchan · 2023-08-23T15:09:23Z

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

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

situchan · 2023-08-23T15:10:57Z

Above issues I mentioned already exist on main so out of scope for this PR

situchan · 2023-08-23T15:17:26Z

I can also confirm that our PR also fixes #22052, #17479.
@ntdiary can you double confirm?

situchan

LGTM

@joelbettner all yours!

ntdiary · 2023-08-23T16:08:44Z

I can also confirm that our PR also fixes #22052, #17479.
@ntdiary can you double confirm?

@situchan, yeah, the patch file also fixes these two issues. : )

OSBotify · 2023-08-23T18:45:32Z

✋ 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-08-24T03:35:08Z

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.57-0 🚀

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

OSBotify · 2023-08-28T18:51:47Z

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.58-0 🚀

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

OSBotify · 2023-08-29T00:06:48Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.57-6 🚀

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

OSBotify · 2023-08-30T01:20:50Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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

s77rt · 2023-09-15T18:33:31Z

src/pages/home/report/ReportActionCompose.js

                                            setIsFocused(false);
                                            resetSuggestions();
+                                            if (e.relatedTarget && e.relatedTarget === actionButtonRef.current) {
+                                                isKeyboardVisibleWhenShowingModalRef.current = true;


This caused a regression #26489. After setting this value to true we had to reset it to false as soon as a menu item is selected otherwise we will focus the composer for a brief period while opening the RHP.

fix keyboard flashing while clicking "Add attachment"

11717c5

fix lint style

e076446

ntdiary marked this pull request as ready for review August 1, 2023 17:23

ntdiary requested a review from a team as a code owner August 1, 2023 17:23

melvin-bot bot requested review from thesahindia and removed request for a team August 1, 2023 17:23

ntdiary added 2 commits August 3, 2023 11:56

Merge branch 'main' into fix-13922

4ebbd77

upgrade patch approach for modal

7ac72b5

Merge branch 'main' into fix-13922

87699e3

rename patch filename

98a5c4a

ntdiary mentioned this pull request Aug 10, 2023

[HOLD PR #23994][$1000] The keyboard is re rendered when an emoji appears #22052

Closed

6 tasks

ntdiary added 2 commits August 12, 2023 16:33

Merge branch 'main' into fix-13922

47c05fe

rename patch filename

4d0afeb

trjExpensify requested review from situchan and removed request for thesahindia August 14, 2023 10:25

situchan reviewed Aug 15, 2023

View reviewed changes

situchan approved these changes Aug 23, 2023

View reviewed changes

melvin-bot bot requested a review from joelbettner August 23, 2023 15:29

situchan mentioned this pull request Aug 23, 2023

[HOLD for payment 2023-09-20] [$1000] iOS - Chat - After going back from the sub-thread and editing the message, the Chat Composer is hidden behind the keyboard #24555

Closed

6 tasks

joelbettner approved these changes Aug 23, 2023

View reviewed changes

joelbettner merged commit 431d23d into Expensify:main Aug 23, 2023

OSBotify mentioned this pull request Aug 24, 2023

Deploy Checklist: New Expensify 2023-08-24 #25813

Closed

73 tasks

situchan mentioned this pull request Aug 24, 2023

[$1000] Auto focus is broken on New room page #17479

Closed

6 tasks

ntdiary mentioned this pull request Aug 24, 2023

[$4000] Android - Edit message - keyboard is dismissed after selecting an emoji @Tushu17 #9252

Closed

lanitochka17 mentioned this pull request Aug 24, 2023

[HOLD for payment 2023-09-21] Attachment - Keyboard does not reopen when tap Back button on Gallery page #25872

Closed

6 tasks

OSBotify mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-28 #26113

Closed

melvin-bot bot mentioned this pull request Aug 28, 2023

[HOLD for payment 2023-09-04] [$4000] Keyboard shows again briefly when clicking "Add attachment" while the composer is focused #13922

Closed

2 tasks

tienifr mentioned this pull request Sep 6, 2023

[$1000] Chat - Composer Not focused when clicking on composer box #25892

Closed

6 tasks

0xmiros mentioned this pull request Sep 6, 2023

[HOLD for payment 2024-06-20] [$1000] IOS- Screen flickering on tapping delete(Transition not smooth) #24452

Closed

6 tasks

bernhardoj mentioned this pull request Sep 13, 2023

[HOLD for payment 2024-06-13] [$1000] Chat - Thread - Keyboard does not open when click of reply in thread #19558

Closed

6 tasks

s77rt reviewed Sep 15, 2023

View reviewed changes

s77rt mentioned this pull request Sep 15, 2023

[HOLD for payment 2023-09-21] [$500] Emoji suggestion/email mentions open and close on opening assign task/request money in chat #26489

Closed

6 tasks

		@@ -0,0 +1,23 @@
		let isReadyToFocusPromise = Promise.resolve();

fix keyboard flashing while clicking "Add attachment" #23994

fix keyboard flashing while clicking "Add attachment" #23994

Conversation

ntdiary commented Aug 1, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

shubham1206agra commented Aug 1, 2023

melvin-bot bot commented Aug 1, 2023

ntdiary commented Aug 3, 2023

ntdiary commented Aug 7, 2023

aimane-chnaif commented Aug 7, 2023

thesahindia commented Aug 7, 2023 • edited Loading

ntdiary commented Aug 7, 2023

ntdiary commented Aug 8, 2023

thesahindia commented Aug 8, 2023

ntdiary commented Aug 12, 2023

bernhardoj commented Aug 12, 2023

ntdiary commented Aug 12, 2023 • edited Loading

ntdiary commented Aug 15, 2023

situchan commented Aug 15, 2023

situchan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paultsimura Nov 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ntdiary commented Aug 23, 2023

situchan commented Aug 23, 2023

situchan commented Aug 23, 2023

situchan commented Aug 23, 2023 • edited Loading

ntdiary commented Aug 23, 2023

situchan commented Aug 23, 2023

Reviewer Checklist

Screenshots/Videos

situchan commented Aug 23, 2023

situchan commented Aug 23, 2023

situchan left a comment

Choose a reason for hiding this comment

ntdiary commented Aug 23, 2023

OSBotify commented Aug 23, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

Choose a reason for hiding this comment

ntdiary commented Aug 1, 2023 •

edited

Loading

thesahindia commented Aug 7, 2023 •

edited

Loading

ntdiary commented Aug 12, 2023 •

edited

Loading

paultsimura Nov 20, 2023 •

edited

Loading

situchan commented Aug 23, 2023 •

edited

Loading