fix: don't focus on composer when open right modal #27155

s-alves10 · 2023-09-11T14:43:38Z

Details

Fixed Issues

$ #26489
PROPOSAL: #26489 (comment)

Tests

Open ND and log in with any account
Open any chat
Input @ character and verify that mention suggestions appears
Tap + button again and tap any menu except Add attachment
Verify that suggestion list doesn't appear for a brief moment before modal is opened

Verify that no errors appear in the JS console

Offline tests

Open ND and log in with any account
Open any chat
Input @ character and verify that mention suggestions appears
Tap + button again and tap any menu except Add attachment
Verify that suggestion list doesn't appear for a brief moment before modal is opened

QA Steps

Open ND and log in with any account
Open any chat
Input @ character and verify that mention suggestions appears
Tap + button again and tap any menu except Add attachment
Verify that suggestion list doesn't appear for a brief moment before modal is opened

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 / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

26489_mac_chrome.mp4

Mobile Web - Chrome

26489_anroid_chrome.mp4

Mobile Web - Safari

26489_ios_safari.mp4

Desktop

26489_mac_desktop.mp4

iOS

26489_ios_native.mp4

Android

26489_android_native.mp4

melvin-bot · 2023-09-11T14:59:04Z

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

s77rt · 2023-09-11T18:13:23Z

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

+        // Restore the suggestions if onSelectionChange is not called on focused
+        if (isSelectionChangedOnFocus || !suggestionsRef.current) {
+            return;
+        }
+        suggestionsRef.current.restoreSuggestions();


What is this for?

onSelectionChange isn't called when composer gets focused(without any selection changes) on native platforms
In this case, we can restore the previous suggestion list. Previous suggestions are stored in resetSuggestions on blur handler

Is this still needed?

Without this, suggestions won't be shown unless selection is changed in native platforms. Refocusing or mouse clicking doesn't work.

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

s77rt · 2023-09-11T18:15:13Z

@s-alves10 The PR is slightly different than the approved solution. Please comment on each new section that was added explaining the need for it.

s-alves10 · 2023-09-11T18:24:38Z

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

    };

    const isKeyboardVisibleWhenShowingModalRef = useRef(false);
    const restoreKeyboardState = useCallback(() => {
-        if (!isKeyboardVisibleWhenShowingModalRef.current) {
+        if (!isKeyboardVisibleWhenShowingModalRef.current || !shouldFocusInputOnScreenFocus) {


We don't need to set focus manually if focus is set automatically

What problem is this solving?

We have composer focused already if shouldFocusInputOnScreenFocus is true. In android chrome, onSelectionChange isn't called when we set focus again.
You can reproduce this with the following steps(Android chrome):

Open any chat and input @ to show mentions list

Click + button to open menu and tap outside of the menu to close it

Verify that mention list doesn't show

s-alves10 · 2023-09-11T18:28:18Z

@s-alves10 The PR is slightly different than the approved solution. Please comment on each new section that was added explaining the need for it.

I added some comments.
Suggestions, SuggestionEmojis, and SuggestionMentions have a new method: restoreSuggestions. This is created for restoring the previous suggestions.
We calculate the suggestions in onSelectionChange, but this is not called when gets refocused if there is no selection change. In this case, I restored the previous suggestions.

s-alves10 · 2023-09-11T18:28:35Z

@s77rt

Please take a look again

s77rt · 2023-09-11T20:06:08Z

Added some comments on the previous review comments

s-alves10 · 2023-09-12T12:10:44Z

@s77rt

If you think we should limit the scope of the PR in the issue, please let me know.
We don't need restoreSuggestions in that case. I'll remove them

s77rt · 2023-09-12T12:23:02Z

@s-alves10 Yes, let's please limit the PR to the bugs that are linked in the issue. If a bug is found and it's a regression we should fix it, but if it's on staging/main already it's better to report it in Slack otherwise we would be working out a new solution instead of going forward with the approved one (with the exception of some bugs where the solution is straightforward).

s-alves10 · 2023-09-12T13:16:30Z

@s77rt

I removed all unrelated code. Also updated the test steps in PR description
Please check again

s77rt · 2023-09-12T13:15:04Z

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

@@ -257,6 +261,7 @@ function AttachmentPickerWithMenuItems({
                            onClose={onPopoverMenuClose}
                            onItemSelected={(item, index) => {
                                setMenuVisibility(false);
+                                onItemSelected();


Can we move this to be the last function call?

We need to overwrite isKeyboardVisibleWhenShowingModalRef.current value in triggerAttachmentPicker function when selecting Add attachment.
I think this is the ideal position this call should be placed at.
Is there any specific reason for moving?

I think you are right here.

s77rt · 2023-09-12T16:40:04Z

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

mweb-chrome.mov

Mobile Web - Safari

mweb-safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

s-alves10 · 2023-09-12T21:12:24Z

@youssef-lr

Please take a look

youssef-lr

LGTM!

OSBotify · 2023-09-13T02:52:12Z

✋ 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-09-13T09:13:08Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.3.69-0 🚀

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

OSBotify · 2023-09-14T10:27:22Z

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

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

OSBotify · 2023-09-14T10:54:10Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.3.70-0 🚀

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

OSBotify · 2023-09-18T10:12:09Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

sangar-1028 added 4 commits September 11, 2023 07:22

fix: doesn't focus when modal is open from menu

3ae75c7

fix: onSelectionChange isn't called on native platforms

ae54bc6

fix: lint error

9bc0b9c

fix: add comments

167ef3b

s-alves10 marked this pull request as ready for review September 11, 2023 14:58

s-alves10 requested a review from a team as a code owner September 11, 2023 14:58

melvin-bot bot requested review from s77rt and removed request for a team September 11, 2023 14:59

s-alves10 mentioned this pull request Sep 11, 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

s77rt reviewed Sep 11, 2023

View reviewed changes

src/pages/home/report/ReportActionCompose/ReportActionCompose.js Outdated Show resolved Hide resolved

s-alves10 commented Sep 11, 2023

View reviewed changes

fix: remove modal props from ReportActionCompose

c140802

sangar-1028 added 2 commits September 12, 2023 08:03

fix: remove restoreSuggestions

7b6570c

fix: update comments

0d3f709

s77rt suggested changes Sep 12, 2023

View reviewed changes

s77rt approved these changes Sep 12, 2023

View reviewed changes

melvin-bot bot requested a review from youssef-lr September 12, 2023 16:40

youssef-lr approved these changes Sep 13, 2023

View reviewed changes

youssef-lr merged commit 6b7ee90 into Expensify:main Sep 13, 2023
12 of 16 checks passed

OSBotify mentioned this pull request Sep 13, 2023

Deploy Checklist: New Expensify 2023-09-13 #27313

Closed

72 tasks

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

s-alves10 deleted the fix/issue-26489 branch December 21, 2023 07:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: don't focus on composer when open right modal #27155

fix: don't focus on composer when open right modal #27155

s-alves10 commented Sep 11, 2023 •

edited

Loading

melvin-bot bot commented Sep 11, 2023

s77rt Sep 11, 2023

s-alves10 Sep 11, 2023

s77rt Sep 11, 2023 •

edited

Loading

s-alves10 Sep 11, 2023

s77rt commented Sep 11, 2023

s-alves10 Sep 11, 2023

s77rt Sep 11, 2023

s-alves10 Sep 11, 2023

s-alves10 commented Sep 11, 2023

s-alves10 commented Sep 11, 2023

s77rt commented Sep 11, 2023

s-alves10 commented Sep 12, 2023

s77rt commented Sep 12, 2023

s-alves10 commented Sep 12, 2023 •

edited

Loading

s77rt Sep 12, 2023

s-alves10 Sep 12, 2023 •

edited

Loading

s77rt Sep 12, 2023

s77rt commented Sep 12, 2023

s-alves10 commented Sep 12, 2023

youssef-lr left a comment

OSBotify commented Sep 13, 2023

OSBotify commented Sep 13, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

fix: don't focus on composer when open right modal #27155

fix: don't focus on composer when open right modal #27155

Conversation

s-alves10 commented Sep 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt Sep 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt commented Sep 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s-alves10 commented Sep 11, 2023

s-alves10 commented Sep 11, 2023

s77rt commented Sep 11, 2023

s-alves10 commented Sep 12, 2023

s77rt commented Sep 12, 2023

s-alves10 commented Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

s-alves10 Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt commented Sep 12, 2023

Reviewer Checklist

Screenshots/Videos

s-alves10 commented Sep 12, 2023

youssef-lr left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 13, 2023

OSBotify commented Sep 13, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

s-alves10 commented Sep 11, 2023 •

edited

Loading

s77rt Sep 11, 2023 •

edited

Loading

s-alves10 commented Sep 12, 2023 •

edited

Loading

s-alves10 Sep 12, 2023 •

edited

Loading