Auto focus Message input field on workspace invite member page #18791

PrashantMangukiya · 2023-05-11T19:01:11Z

@hayata-suenaga @mollfpr PR is ready for review.

Details

Whenever we select member from Invite member screen, and tap Next button it will show Add message screen. On this screen there is a Message input field that was not auto focused until now. So in this pr we added logic to autofocus the Message input field.

Fixed Issues

$ #18371
PROPOSAL: #18371 (comment)

Tests

Go to Settings > Workspace > Manage Members
Tap Invite button (Green)
Select member(s) to invite
Tap Next button
Verify that Message field is auto-focused

Verify that no errors appear in the JS console

Offline tests

Go to Settings > Workspace > Manage Members
Tap Invite button (Green)
Select member(s) to invite
Tap Next button
Verify that Message field is auto-focused

QA Steps

Go to Settings > Workspace > Manage Members
Tap Invite button (Green)
Select member(s) to invite
Tap Next button
Verify that Message field is auto-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
- 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 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

Chrome

Web-Chrome.mov

Safari

Web-Safari.mov

Mobile Web - Chrome

MWeb-Chrome.mov

Mobile Web - Safari

MWeb-Safari.mov

Desktop

Desktop.mov

iOS

iOS.mov

Android

Android.mov

melvin-bot · 2023-05-11T19:01:17Z

@hayata-suenaga @mollfpr One of you needs to 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]

mollfpr · 2023-05-12T13:49:16Z

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

18791.Web.mov

Mobile Web - Chrome

18791.mWeb.Chrome.mov

Mobile Web - Safari

18791.mWeb.Safari.mp4

Desktop

18791.Desktop.mov

iOS

18791.iOS.mp4

Android

18791.Android.mov

mollfpr · 2023-05-12T14:08:24Z

@PrashantMangukiya @hayata-suenaga Coming from my curiosity, should we also make the input focus after refresh?

PrashantMangukiya · 2023-05-12T15:17:23Z

@PrashantMangukiya @hayata-suenaga Coming from my curiosity, should we also make the input focus after refresh?

I think it is also possible option. If we have to do this then we have to remove code from onEntryTransitionEnd={() => {}} and put within componentDidMount as shown code below. It will work for both refresh and regular navigation. I tested it and it is working fine in all platform.

componentDidMount() {
    this.focusTimeout = setTimeout(() => {
        this.welcomeMessageInputRef.focus();
        // Below condition is needed for web, desktop and mweb only, for native cursor is set at end by default.
        if (this.welcomeMessageInputRef.value && this.welcomeMessageInputRef.setSelectionRange) {
            const length = this.welcomeMessageInputRef.value.length;
            this.welcomeMessageInputRef.setSelectionRange(length, length);
        }
    }, CONST.ANIMATED_TRANSITION);
}

componentWillUnmount() {
    if (!this.focusTimeout) {
        return;
    }
    clearTimeout(this.focusTimeout);
}

mollfpr · 2023-05-15T16:29:19Z

@PrashantMangukiya Let's try your suggestion above.

PrashantMangukiya · 2023-05-15T16:44:41Z

@mollfpr Pushed updated code to support focus after refresh. Please let me know if anything else is needed. It will be great if we can merge PR asap, so eligible for timeline bonus. Thank you.

mollfpr

Nice work @PrashantMangukiya! It tests well 👍

All yours @hayata-suenaga

mollfpr

Trigger again the PR checklist check.

PrashantMangukiya · 2023-05-16T00:22:56Z

@hayata-suenaga It will be great if we can merge PR, so it will be eligible for timeline bonus. Thank you.

hayata-suenaga · 2023-05-16T00:52:28Z

@PrashantMangukiya I left a comment above. It's strongly discouraged to use setTimeOut in the codebase. do you think there is any way we can avoid it?

PrashantMangukiya · 2023-05-16T01:09:46Z

@hayata-suenaga As we have to set focus during browser refresh also, here time out is needed to set focus during componentDidMount.

Also our BaseTextInput component using timeout to set focus on componentDidMount.

App/src/components/TextInput/BaseTextInput.js

Lines 63 to 66 in 896ad77

    
           if (this.props.shouldDelayFocus) { 
        
               this.focusTimeout = setTimeout(() => this.input.focus(), CONST.ANIMATED_TRANSITION); 
        
               return; 
        
           }

So here If we have to avoid timeout then we can go with original proposed solution, but that will not focus during page refresh so we implemented this. Thank you.

hayata-suenaga · 2023-05-16T18:32:40Z

@PrashantMangukiya with setTimeout, are we waiting for some kind of animations to finish?

I'd appreciate it if you could expand on that a little bit

why can't be listen to animation end event?

PrashantMangukiya · 2023-05-16T18:57:19Z

@hayata-suenaga by setting timeout we can make sure that it will finish transition and then set focus. Previously we use the solution based on the onEnteryTransitionEnd() as per my initial proposal here But within that, focus was not set when browser refresh. So to make focus work during browser refresh we used timeout based solution. So this solution is working in both situation i.e.normal navigation and browser refresh. So this is my thought to use this solution.

Please let me know if you have different idea that will achieve the same goal. Thank you.

hayata-suenaga · 2023-05-16T19:08:23Z

Thank you for the detailed explanation. Although I understand the reasoning, I'm curious if anyone has a solution that doesn't use setTimeout (setTimeout has caused troubles in the past and I'm really hesitant to push codes that contain setTimeout

so I opened up a thread in #expensify-open-source Slack channel.

hayata-suenaga · 2023-05-18T00:35:21Z

from the above Slack thread, we determined that we have no other good choice but to use setTimeout for now.

hayata-suenaga

LGTM!

src/pages/workspace/WorkspaceInviteMessagePage.js

OSBotify · 2023-05-18T00:42:16Z

✋ 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-05-18T07:38:24Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.16-0 🚀

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

hayata-suenaga · 2023-05-22T20:10:10Z

@PrashantMangukiya, the QA for this PR has failed

the original issue has not been on mWeb Safari and iOS. can you investigate?

PrashantMangukiya · 2023-05-22T21:03:29Z

@mvtglobally @hayata-suenaga I tested it, this issue is fixed for iOS and Mweb as shown video here.

MWeb Safari

Mweb-Safari.mov

iOS

iOS.mov

hayata-suenaga · 2023-05-22T23:15:13Z

@PrashantMangukiya thank you for testing again. I'll update the QA team if they can redo the tests again

OSBotify · 2023-05-22T23:39:51Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

OSBotify · 2023-05-23T00:15:46Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

mvtglobally · 2023-05-23T00:52:07Z

@hayata-suenaga team is still able to repro https://github.com/Expensify/App/assets/43995119/d442df5f-81d8-4871-86a8-ce27a3af0b0d

hayata-suenaga · 2023-05-23T01:12:17Z

@PrashantMangukiya can you test it again with staging changes?

mvtglobally · 2023-05-23T01:40:07Z

Issue is not repro on IOS 16.4
Only MWeb Safari is the issue

PrashantMangukiya · 2023-05-23T02:02:22Z

@mvtglobally For Staging Mweb Safari it is not reproduce in emulator. I can see you have real device, where it shows green bottom line (due to focus in input) but does not show cursor. This is strange behaviour. Not any idea at present, I will investigate more about this. cc: @hayata-suenaga

Stg-Mweb-Safari.mp4

PrashantMangukiya · 2023-05-23T16:35:27Z

@hayata-suenaga @mvtglobally I did some investigation on MWeb focus issue for real device and found out that this issue is not specific to our PR, but it is in many places in our App (maybe due to faulty TextInput component) having same behaviour i.e. TextInput focused but cursor does not show. Below are few videos recorded on Real Device MWeb Safari.

New Contact Method

New-Contact-Method.MP4

Change Password

Change-Password.MP4

Add PayPal

Add-PayPal.MP4

New Chat

New-Chat.MP4

New Group

New-Group.MP4

Send Money Description

Send-Money-Desc.MP4

Request Money Description

Request-Money-Desc.MP4

Split Bill Description

Split-Bill-Desc.MP4

Assign Task Title

Assign-Task-Title.MP4

Assign Task Description

Assign-Task-Desc.MP4

I think we can create a new issue for this.

OSBotify · 2023-05-23T19:53:40Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

OSBotify · 2023-05-23T21:52:24Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

hayata-suenaga · 2023-05-24T16:42:29Z

@PrashantMangukiya can you report the bug to #expensify-open-source channel?

this is very weird... the text input is focused but the cursor is not being shown and the keyboard is not shown up...

PrashantMangukiya · 2023-05-25T04:06:19Z

@hayata-suenaga Should I report this to #expensify-open-source OR #expensify-bugs channel? Generally we report bug on #expensify-bugs channel so I am asking to verify it. Thank you.

PrashantMangukiya · 2023-05-25T13:36:39Z

@hayata-suenaga Cursor missing in mWeb Safari related issue already reported #19608 so I think no need to report again. Thank you.

Santhosh-Sellavel · 2023-06-20T18:32:10Z

src/pages/workspace/WorkspaceInviteMessagePage.js

+            // Below condition is needed for web, desktop and mweb only, for native cursor is set at end by default.
+            if (this.welcomeMessageInputRef.value && this.welcomeMessageInputRef.setSelectionRange) {
+                const length = this.welcomeMessageInputRef.value.length;
+                this.welcomeMessageInputRef.setSelectionRange(length, length);
+            }


This is caused a regression here #20875 (comment).

Why do we need this?

cc: @mollfpr @PrashantMangukiya

Why is #20875 a regression of this?

On the native the cursor is set at the end of the text, so we want the same behavior for the web and desktop.

Auto focus message input field

3a6c7ab

PrashantMangukiya requested a review from a team as a code owner May 11, 2023 19:01

melvin-bot bot requested review from hayata-suenaga and mollfpr and removed request for a team May 11, 2023 19:01

Update logic to support focus after refresh

d912714

mollfpr approved these changes May 15, 2023

View reviewed changes

hayata-suenaga approved these changes May 18, 2023

View reviewed changes

src/pages/workspace/WorkspaceInviteMessagePage.js Show resolved Hide resolved

hayata-suenaga merged commit aa9eea8 into Expensify:main May 18, 2023

OSBotify mentioned this pull request May 18, 2023

Deploy Checklist: New Expensify 2023-05-18 #19175

Closed

39 tasks

melvin-bot bot mentioned this pull request May 22, 2023

[HOLD for payment 2023-05-29] [$1000] ‘Message’ input field is not auto-focused even though it is the only input field in the page #18371

Closed

6 tasks

s77rt mentioned this pull request Jun 19, 2023

[HOLD for payment 2023-06-23] [$1000] Invite message input is not auto focus after going back #20092

Closed

6 tasks

Santhosh-Sellavel reviewed Jun 20, 2023

View reviewed changes

TMisiukiewicz mentioned this pull request Oct 25, 2023

perf: improve performance when opening Search with cmd+k #30263

Merged

59 tasks

Auto focus Message input field on workspace invite member page #18791

Auto focus Message input field on workspace invite member page #18791

Conversation

PrashantMangukiya commented May 11, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Chrome

Safari

melvin-bot bot commented May 11, 2023

mollfpr commented May 12, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr commented May 12, 2023

PrashantMangukiya commented May 12, 2023

mollfpr commented May 15, 2023

PrashantMangukiya commented May 15, 2023

mollfpr left a comment

Choose a reason for hiding this comment

mollfpr left a comment

Choose a reason for hiding this comment

PrashantMangukiya commented May 16, 2023

hayata-suenaga commented May 16, 2023

PrashantMangukiya commented May 16, 2023

hayata-suenaga commented May 16, 2023 • edited Loading

PrashantMangukiya commented May 16, 2023

hayata-suenaga commented May 16, 2023

hayata-suenaga commented May 18, 2023

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented May 18, 2023

OSBotify commented May 18, 2023

hayata-suenaga commented May 22, 2023

PrashantMangukiya commented May 22, 2023

MWeb Safari

iOS

hayata-suenaga commented May 22, 2023

OSBotify commented May 22, 2023

OSBotify commented May 23, 2023

mvtglobally commented May 23, 2023

hayata-suenaga commented May 23, 2023

mvtglobally commented May 23, 2023

PrashantMangukiya commented May 23, 2023

PrashantMangukiya commented May 23, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

hayata-suenaga commented May 24, 2023

PrashantMangukiya commented May 25, 2023

PrashantMangukiya commented May 25, 2023

Santhosh-Sellavel Jun 20, 2023

Choose a reason for hiding this comment

hayata-suenaga Jun 21, 2023

Choose a reason for hiding this comment

mollfpr Jun 21, 2023

Choose a reason for hiding this comment

mollfpr commented May 12, 2023 •

edited

Loading

hayata-suenaga commented May 16, 2023 •

edited

Loading