Fix: Composer is not focused when press Message User in Profile page #30973

tienifr · 2023-11-07T10:17:19Z

Details

Composer is not focused when press Message User in Profile page. This PR fixes that.

Fixed Issues

$ #30254
PROPOSAL: #30254 (comment)

Tests

Open an empty DM
Press report header to open user details page
Press Message User
Verify that composer is focused

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Open an empty DM
Press report header to open user details page
Press Message User
Verify that composer is 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 / 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
  - 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2023-11-08.at.16.29.37-compressed.mov

Android: mWeb Chrome

Screen.Recording.2023-11-08.at.16.30.52-compressed.mov

iOS: Native

Screen.Recording.2023-11-08.at.16.25.32-compressed.mov

iOS: mWeb Safari

Screen.Recording.2023-11-08.at.16.26.42-compressed.mov

MacOS: Chrome / Safari

Screen.Recording.2023-11-07.at.17.37.29-compressed.mov

MacOS: Desktop

Screen.Recording.2023-11-08.at.15.29.22-compressed.mov

melvin-bot · 2023-11-08T09:32:01Z

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

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

hoangzinh · 2023-11-09T04:36:43Z

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

@@ -499,6 +499,22 @@ function ComposerWithSuggestions({
        }
        focus();
    }, [focus, prevIsFocused, editFocused, prevIsModalVisible, isFocused, modal.isVisible, isNextModalWillOpenRef]);
+
+    const shouldAutoFocusRef = useRef(false);
+    shouldAutoFocusRef.current = shouldAutoFocus;


Is there any reason why we don't use shouldAutoFocus directly, but using ref here?

We won't need this anymore in the latest approach. Thanks.

parasharrajat · 2023-11-10T21:07:23Z

We need to trigger .focus() on the composer if shouldAutoFocus of the report is true and the Report screen gains focus.

Note: autoFocus prop is only used to focus the input on the mount and this is its main
purpose. So I didn't understand the proposal.

The solution does not match the proposal. Can we please explain this in the PR description?

parasharrajat · 2023-11-10T21:09:01Z

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

+    useEffect(() => {
+        if (prevIsFocused || !isFocused) {
+            return;
+        }
+        // Focus composer when navigating from another screen
+        setTimeout(() => {
+            if (!shouldAutoFocusRef.current) {
+                return;
+            }
+            textInputRef.current.focus();
+        }, CONST.ANIMATED_TRANSITION);
+    }, [isFocused, prevIsFocused]);


No setTimeouts. We should fix the existing focus handler effect.

hoangzinh · 2023-11-17T15:41:48Z

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

@@ -498,7 +498,9 @@ function ComposerWithSuggestions({
            return;
        }
        focus();
+        // eslint-disable-next-line react-hooks/exhaustive-deps


@tienifr could you share why we don't add shouldAutoFocus to the dependency array?

I don't think we should run the effect again when shouldAutoFocus changes. It's just a check. The effect should only be re-triggered when some modal close/open or the page gets focused.

do you mind sharing will it cause any regression bugs if we add this value to the dependency list?

cc @tienifr ^

Not yet found any regression so far. My initial idea was to limit the number of re-render by avoiding unncessary dependency. But as I tested and confirmed that it did not affect re-render performance.

hoangzinh · 2023-11-28T14:10:08Z

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

@@ -491,6 +491,7 @@ function ComposerWithSuggestions({
    const prevIsModalVisible = usePrevious(modal.isVisible);
    const prevIsFocused = usePrevious(isFocused);
    useEffect(() => {
+        console.log('abcdef');


Is it accidentally added?

My bad! Removed!

hoangzinh · 2023-11-29T15:22:29Z

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: mWeb Chrome

Screen.Recording.2023-11-30.at.18.27.00.-.android.chrome.mov

iOS: Native

Screen.Recording.2023-11-30.at.19.33.35.-.ios.mp4

iOS: mWeb Safari

Screen.Recording.2023-11-30.at.19.33.35.-.ios.mp4

MacOS: Chrome / Safari

Screen.Recording.2023-11-30.at.17.14.53.-.web.mov

MacOS: Desktop

Screen.Recording.2023-11-30.at.17.15.42.-.desktop.mov

OSBotify · 2023-12-01T09:41:19Z

✋ 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-12-01T12:56:25Z

🚀 Deployed to staging by https://github.com/Gonals in version: 1.4.7-0 🚀

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

OSBotify · 2023-12-05T02:26:48Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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

tienifr added 7 commits October 28, 2023 16:30

fix: 30254

9a6375a

Merge branch 'main' of https://github.com/tienifr/App into fix/30254

6d09d59

fix lint

331e2a8

refactor code

2b7be0a

fix lint

4294da8

Merge branch 'main' of https://github.com/tienifr/App into fix/30254

f3c06d6

remove clearTimeout

5464fc5

tienifr marked this pull request as ready for review November 8, 2023 09:31

tienifr requested a review from a team as a code owner November 8, 2023 09:31

melvin-bot bot requested review from hoangzinh and removed request for a team November 8, 2023 09:31

tienifr mentioned this pull request Nov 8, 2023

[HOLD for payment 2023-12-12] [$500] Chat - Composer is not focused when message user from Profile page #30254

Closed

6 tasks

hoangzinh reviewed Nov 9, 2023

View reviewed changes

tienifr mentioned this pull request Nov 10, 2023

[$500] Task - When returning from the assignee page back to the task page, the compose focus is lost #31213

Closed

6 tasks

parasharrajat reviewed Nov 10, 2023

View reviewed changes

tienifr added 3 commits November 15, 2023 14:39

Merge branch 'main' of https://github.com/tienifr/App into fix/30254

417b519

refactor to handle focus in the same useEffect

816a67c

fix lint

f671ed3

hoangzinh reviewed Nov 17, 2023

View reviewed changes

tienifr added 3 commits November 22, 2023 17:14

Merge branch 'main' of https://github.com/tienifr/App into fix/30254

e8c5d79

Merge branch 'main' into fix/30254

4a8be24

add shouldAutoFocus to dependencies

ac9c935

hoangzinh reviewed Nov 28, 2023

View reviewed changes

tienifr added 2 commits November 29, 2023 04:03

Merge branch 'main' of https://github.com/tienifr/App into fix/30254

d58d465

remove log

a08dadd

hoangzinh approved these changes Nov 30, 2023

View reviewed changes

melvin-bot bot requested a review from Gonals November 30, 2023 12:46

Gonals approved these changes Dec 1, 2023

View reviewed changes

Gonals merged commit 2e8de3f into Expensify:main Dec 1, 2023
16 of 17 checks passed

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

Deploy Checklist: New Expensify 2023-12-01 #32342

Closed

53 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Composer is not focused when press Message User in Profile page #30973

Fix: Composer is not focused when press Message User in Profile page #30973

tienifr commented Nov 7, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Nov 8, 2023

hoangzinh Nov 9, 2023

tienifr Nov 15, 2023

parasharrajat commented Nov 10, 2023

parasharrajat Nov 10, 2023

hoangzinh Nov 17, 2023

tienifr Nov 17, 2023

hoangzinh Nov 20, 2023

hoangzinh Nov 27, 2023

tienifr Nov 27, 2023 •

edited

Loading

hoangzinh Nov 28, 2023

tienifr Nov 28, 2023

hoangzinh commented Nov 29, 2023 •

edited

Loading

OSBotify commented Dec 1, 2023

OSBotify commented Dec 1, 2023

OSBotify commented Dec 5, 2023

Fix: Composer is not focused when press Message User in Profile page #30973

Fix: Composer is not focused when press Message User in Profile page #30973

Conversation

tienifr commented Nov 7, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parasharrajat commented Nov 10, 2023

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

tienifr Nov 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoangzinh commented Nov 29, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Dec 1, 2023

OSBotify commented Dec 1, 2023

OSBotify commented Dec 5, 2023

tienifr commented Nov 7, 2023 •

edited by github-actions bot

Loading

tienifr Nov 27, 2023 •

edited

Loading

hoangzinh commented Nov 29, 2023 •

edited

Loading