Fix - mWeb auto focus on reply in thread #37929

FitseTLT · 2024-03-07T20:10:00Z

Details

Fixed Issues

$ #30689
PROPOSAL: #30689 (comment)

Tests

On mWeb:

Open any chat
On any message open the context menu
select reply in thread
Verify that in the new thread report opened the compose is auto-focused

Verify that no errors appear in the JS console

Offline tests

QA Steps

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.

Screenshots/Videos

Android: Native

nat.mp4

Android: mWeb Chrome

android.web.mp4

iOS: Native

2024-03-26.16-35-25.mp4

iOS: mWeb Safari

ios.web.mp4

MacOS: Chrome / Safari

2024-03-26.16-09-52.mp4

MacOS: Desktop

2024-03-26.16-37-03.mp4

melvin-bot · 2024-03-07T20:10:06Z

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

allroundexperts · 2024-03-11T20:16:59Z

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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: Native

Screen.Recording.2024-04-02.at.4.44.22.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-04-02.at.4.42.02.PM.mov

iOS: Native

Screen.Recording.2024-04-02.at.4.41.13.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-04-02.at.4.39.43.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-02.at.4.23.07.PM.mov

MacOS: Desktop

Screen.Recording.2024-04-02.at.4.25.33.PM.mov

src/libs/focusComposerWithDelay.ts

allroundexperts · 2024-03-17T22:22:08Z

src/components/Composer/index.tsx

+                    if (isReportActionCompose) {
+                        ReportActionComposeFocusManager.onComposerFocus(null);
+                    } else {
+                        // While a user was editing a comment and if they open on LHN menu we want the focus to return
+                        // to the ReportActionItemMessageEdit compose after they click on the menu (for e.g. mark as read)
+                        // so we assign the focus callback here.
+                        ReportActionComposeFocusManager.onComposerFocus(() => {
+                            if (!textInput.current) {
+                                return;
+                            }
+
+                            textInput.current.focus();
+                        });
+                    }


Suggested change

if (isReportActionCompose) {

ReportActionComposeFocusManager.onComposerFocus(null);

} else {

// While a user was editing a comment and if they open on LHN menu we want the focus to return

// to the ReportActionItemMessageEdit compose after they click on the menu (for e.g. mark as read)

// so we assign the focus callback here.

ReportActionComposeFocusManager.onComposerFocus(() => {

if (!textInput.current) {

return;

}

textInput.current.focus();

});

}

ReportActionComposeFocusManager.onComposerFocus(() => {

/*

While a user was editing a comment and if they open on LHN menu we want the focus to return

to the ReportActionItemMessageEdit compose after they click on the menu (for e.g. mark as read)

so we assign the focus callback here.

*/

if (!textInput.current || isReportActionCompose) {

return;

}

textInput.current.focus();

});

Nope. What we are trying to avoid for main composer is overriding of the focus callback; onComposerFocus is callback assigner so we should avoid overriding of mainComposerFocusCallback by focusCallback so when isReportActionCompose is true we reset it to null.

I still don't get the reasoning behind this. Why can't we just return early in the callback if isReportActionCompose is true?

What we want to achieve is when the focus is called from reply in thread we want to focus the compose in the newly created thread and we can do that via mainComposerFocusCallback set here

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

Lines 611 to 617 in 822cf62

ReportActionComposeFocusManager.onComposerFocus((shouldFocusForNative = false) => {

if ((!willBlurTextInputOnTapOutside && !shouldFocusForNative) || !isFocused) {

return;

}

focus(false);

}, true);

But mainComposerFocusCallback are only called when focusCallback is not set.

App/src/libs/ReportActionComposeFocusManager.ts

Lines 38 to 43 in 822cf62

if (typeof focusCallback !== 'function') {

if (typeof mainComposerFocusCallback !== 'function') {

return;

}

mainComposerFocusCallback(shouldFocusForNative);

So here what we want is to reset focusCallback to null so that our mainComposerFocusCallback will be called. But early returning, as U suggest, means we leave (without reseting) what was already set on focusCallback therefore our mainComposerFocusCallback will not be called.

src/libs/ReportActionComposeFocusManager.ts

allroundexperts · 2024-03-17T22:25:05Z

@FitseTLT Please ensure that the screen recordings are available on ALL the platforms.

FitseTLT · 2024-03-27T16:44:19Z

ping

FitseTLT · 2024-04-01T10:54:47Z

Bump @allroundexperts

allroundexperts · 2024-04-01T16:14:47Z

Bump @allroundexperts

Replied again @FitseTLT

allroundexperts

Looks good to me!

marcaaron

A have a small suggestion on the comment to improve the readability. Code LGTM - just need to improve quality.

src/components/Composer/index.tsx

marcaaron · 2024-04-02T20:16:17Z

src/libs/ReportActionComposeFocusManager.ts

@@ -29,7 +29,7 @@ function onComposerFocus(callback: FocusCallback, isMainComposer = false) {
 /**
 * Request focus on the ReportActionComposer
 */
-function focus() {
+function focus(shouldFocusForNative?: boolean) {


Having a shouldFocusForNative param seems to encourages code that is not cross platform.

Can we rename this to indicate the intended behavior regardless of what platform we are on?

Can we rename this to indicate the intended behavior regardless of what platform we are on?

That isn't clear @marcaaron. Because we are early returning here

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

Lines 612 to 613 in a4d01a8

if (!willBlurTextInputOnTapOutside || !isFocused) {

return;

willBlurTextInputOnTapOutside is false only for natives so we are normally preventing focus for natives but in our case we have to manually focus it for natives too that's why I came up with the variable. What other name could we give?

Naming it shouldReturnEarly should be fine @FitseTLT. We do not support code that this written just for native platforms mixed together with the rest of the code. If we need to do something specific to the native platform, we usually create a separate file .native.ts extension to keep proper separation of concerns.

marcaaron · 2024-04-02T20:16:43Z

src/pages/home/report/ContextMenu/ContextMenuActions.tsx

@@ -200,7 +201,9 @@ const ContextMenuActions: ContextMenuAction[] = [
        onPress: (closePopover, {reportAction, reportID}) => {
            if (closePopover) {
                hideContextMenu(false, () => {
-                    ReportActionComposeFocusManager.focus();
+                    InteractionManager.runAfterInteractions(() => {
+                        ReportActionComposeFocusManager.focus(true);


Please add a comment here to explain why we are passing true.

added but can u check the comments.

Let's avoid creating platform specific language.

Can you answer this question without referencing "native":

What behavior are we giving the callback by passing true?

FitseTLT · 2024-04-05T15:00:46Z

@marcaaron @allroundexperts Changed the variable name to shouldFocusForNonBlurInputOnTapOutside WDYT and also updated comment accordingly.

marcaaron

Much better thanks!

OSBotify · 2024-04-05T22:00:11Z

✋ 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 · 2024-04-08T11:08:02Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-08T13:04:40Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-10T17:22:17Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

FitseTLT added 6 commits February 23, 2024 21:23

fix auto focus on reply in thread

5e7121a

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

1450307

refactor on the implementation

b7f306e

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

d7abc9d

pass text input ref

f69df2a

revert ref variable change

69e6022

FitseTLT requested a review from a team as a code owner March 7, 2024 20:10

melvin-bot bot requested review from allroundexperts and removed request for a team March 7, 2024 20:10

FitseTLT added 2 commits March 7, 2024 23:12

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

0d37448

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

c51602f

allroundexperts reviewed Mar 17, 2024

View reviewed changes

src/libs/focusComposerWithDelay.ts Outdated Show resolved Hide resolved

allroundexperts suggested changes Mar 17, 2024

View reviewed changes

FitseTLT added 8 commits March 20, 2024 23:45

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

9e2c1d1

minor fix

78d815b

minor fix

1b9163c

minor fix

aa4fe30

minor fix

4c34830

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

31db23e

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

297cd03

fix auto focus for natives

2bf777e

FitseTLT requested a review from allroundexperts March 26, 2024 13:36

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

822cf62

allroundexperts approved these changes Apr 2, 2024

View reviewed changes

melvin-bot bot requested a review from marcaaron April 2, 2024 11:48

marcaaron requested changes Apr 2, 2024

View reviewed changes

FitseTLT added 4 commits April 3, 2024 12:02

Updated comment

c27d74e

added comment

4a40236

Merge branch 'main' into fix-auto-focus-on-reply-in-thread

335b5fa

changed variable names

6fd4517

marcaaron approved these changes Apr 5, 2024

View reviewed changes

marcaaron merged commit 0e6dba4 into Expensify:main Apr 5, 2024
15 checks passed

github-actions bot mentioned this pull request Apr 5, 2024

Investigate workflow job failing on main: test / test (job 1) #39758

Closed

github-actions bot mentioned this pull request Apr 8, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807

Closed

This was referenced Apr 12, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807 Derevyaa/Expensify-App#1

Closed

Deploy Checklist: New Expensify 2024-04-09 #39808 Derevyaa/Expensify-App#2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix - mWeb auto focus on reply in thread #37929

Fix - mWeb auto focus on reply in thread #37929

FitseTLT commented Mar 7, 2024 •

edited

Loading

melvin-bot bot commented Mar 7, 2024

allroundexperts commented Mar 11, 2024 •

edited

Loading

allroundexperts Mar 17, 2024

FitseTLT Mar 20, 2024

allroundexperts Apr 1, 2024

FitseTLT Apr 2, 2024

allroundexperts commented Mar 17, 2024

FitseTLT commented Mar 27, 2024

FitseTLT commented Apr 1, 2024

allroundexperts commented Apr 1, 2024

allroundexperts left a comment

marcaaron left a comment

marcaaron Apr 2, 2024

FitseTLT Apr 3, 2024

allroundexperts Apr 4, 2024 •

edited

Loading

marcaaron Apr 2, 2024

FitseTLT Apr 3, 2024

marcaaron Apr 4, 2024

FitseTLT commented Apr 5, 2024

marcaaron left a comment

OSBotify commented Apr 5, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 10, 2024

	ReportActionComposeFocusManager.onComposerFocus((shouldFocusForNative = false) => {
	if ((!willBlurTextInputOnTapOutside && !shouldFocusForNative) \|\| !isFocused) {
	return;
	}

	focus(false);
	}, true);

	if (typeof focusCallback !== 'function') {
	if (typeof mainComposerFocusCallback !== 'function') {
	return;
	}

	mainComposerFocusCallback(shouldFocusForNative);

Fix - mWeb auto focus on reply in thread #37929

Fix - mWeb auto focus on reply in thread #37929

Conversation

FitseTLT commented Mar 7, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 7, 2024

allroundexperts commented Mar 11, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

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

allroundexperts commented Mar 17, 2024

FitseTLT commented Mar 27, 2024

FitseTLT commented Apr 1, 2024

allroundexperts commented Apr 1, 2024

allroundexperts left a comment

Choose a reason for hiding this comment

marcaaron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allroundexperts Apr 4, 2024 • 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

FitseTLT commented Apr 5, 2024

marcaaron left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 5, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 10, 2024

FitseTLT commented Mar 7, 2024 •

edited

Loading

allroundexperts commented Mar 11, 2024 •

edited

Loading

allroundexperts Apr 4, 2024 •

edited

Loading