Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Composer does not refocus on clicking the same chat in LHN #21552

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Jun 26, 2023

Details

Composer does not refocus on clicking the same chat in LHN.

Fixed Issues

$ #20865
PROPOSAL: #20865 (comment)

Tests

  1. Test on Desktop App & Desktop Web only
  2. Login with any account
  3. Open any chat
  4. Verify that the composer is focused
  5. Click on the same chat in LHN
  6. Verify that the composer does not lose focus
  • Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

  1. Test on Desktop App & Desktop Web only
  2. Login with any account
  3. Open any chat
  4. Verify that the composer is focused
  5. Click on the same chat in LHN
  6. Verify that the composer does not lose focus
  • 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 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
Screencast.from.11-07-2023.00.23.22.webm
Mobile Web - Chrome
video_2023-07-10_08-17-35.mp4
Mobile Web - Safari
original-AEC2EF59-A73F-4B88-957E-D0C50281B4C5.mp4
Desktop
250957331-188dad0d-91c8-4dd5-bd41-cad5196339dc.mov
iOS
250957312-31d65fc5-9301-445f-b246-dbec92307d2d.mov
Android
Screencast.from.10-07-2023.08.45.35.webm

@tienifr tienifr marked this pull request as ready for review July 6, 2023 11:42
@tienifr tienifr requested a review from a team as a code owner July 6, 2023 11:42
@melvin-bot melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team July 6, 2023 11:42
@melvin-bot
Copy link

melvin-bot bot commented Jul 6, 2023

@Santhosh-Sellavel 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]

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@@ -148,6 +148,14 @@ function OptionRowLHN(props) {

props.onSelectRow(optionItem, popoverAnchor);
}}
// Prevent losing Composer focus
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's take this comment inside and above preventDefault()

Copy link
Contributor

@MonilBhavsar MonilBhavsar Jul 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make sure to test it does not add regression if focus is on other element than composer. cc @Santhosh-Sellavel

src/pages/home/sidebar/SidebarLinks.js Outdated Show resolved Hide resolved
@Santhosh-Sellavel
Copy link
Collaborator

@tienifr Avoid creating PRs before you are assigned to the issue. This would lead to unnecessary confusion and it's against guidelines.

Please update the recordings after merging the latest main

@tienifr
Copy link
Contributor Author

tienifr commented Jul 10, 2023

@Santhosh-Sellavel I've updated the screenshots accordingly. Also tested on a small screen to avoid #20797 regression.

Screencast.from.11-07-2023.00.28.03.webm

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 10, 2023

Switching to other chats the focus is lost on composer, Can you please check @tienifr ?

Screen.Recording.2023-07-11.at.4.02.18.AM.mov

@tienifr
Copy link
Contributor Author

tienifr commented Jul 11, 2023

It's working fine on my side 😕

Screencast.from.11-07-2023.14.01.08.webm

@tienifr
Copy link
Contributor Author

tienifr commented Jul 11, 2023

Maybe that's because in your video, there was another Expensify tab where a modal was already open, which made this check fail:

this.shouldAutoFocus = !props.modal.isVisible && (this.shouldFocusInputOnScreenFocus || this.isEmptyChat()) && props.shouldShowComposeInput;

Do you think we should fix this?

@Santhosh-Sellavel
Copy link
Collaborator

@tienifr Try merging with the main

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 11, 2023

So this PR becomes stale if that's the new expectation

@github-actions
Copy link
Contributor

github-actions bot commented Jul 11, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@tienifr
Copy link
Contributor Author

tienifr commented Jul 11, 2023

Sorry, I'm a little bit messed up with the newly-configured git. I've merged the latest main.

@tienifr tienifr force-pushed the fix/20865-composer-refocuses-on-clicking-same-chat-lhn branch from 9515da1 to 37520c4 Compare July 12, 2023 04:33
@tienifr
Copy link
Contributor Author

tienifr commented Jul 12, 2023

@Santhosh-Sellavel So what are the next steps regarding #21552 (comment) ?

@Santhosh-Sellavel
Copy link
Collaborator

@tienifr Did you find where(PR or issue) that change was made?

@tienifr
Copy link
Contributor Author

tienifr commented Jul 12, 2023

@Santhosh-Sellavel This is the root PR: #1699. The purpose of the change was:

When any modal goes from visible to hidden, bring focus to the compose field

Also, the issue exists before this PR. We should create a separate issue in case we want to fix it.

@Santhosh-Sellavel
Copy link
Collaborator

I'm confused why you brought up this.

On Staging/Main we no longer focus the composer even when switching to different chats refer to the video here. I've asked if can you find the PR/Issue where this change was made.

@tienifr
Copy link
Contributor Author

tienifr commented Jul 13, 2023

On Staging/Main we no longer focus the composer even when switching to different chats refer to the video.

I've tested on both staging and the latest main and the composer auto-focusing is working as expected. There's also a new feature that the composer will auto focus when typing any character key. Maybe you've missed my analysis here on why your composer was not focused. Please check again.

Screen.Recording.2023-07-14.at.01.18.38.mov
Screen.Recording.2023-07-14.at.01.22.17.mov

@Santhosh-Sellavel
Copy link
Collaborator

Sorry as you can see it was not working for me here.

It was confusing for me as well. It's working now, will try testing again with your changes and let you know!

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 14, 2023

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 & Desktop
Screen.Recording.2023-07-14.at.6.49.30.PM.mov
Mobile All
Screen.Recording.2023-07-14.at.7.01.05.PM.mov

@Santhosh-Sellavel
Copy link
Collaborator

@tienifr The test steps don't work as expected for mobile native/web. That's irrelevant here so better update the test steps to test only focus issue on Desktop App & Desktop Web only.

@Santhosh-Sellavel
Copy link
Collaborator

@tienifr bump!

@tienifr
Copy link
Contributor Author

tienifr commented Jul 17, 2023

@Santhosh-Sellavel Thanks for bumping me. Agree with you that we should only test on Desktop App & Desktop Web only. I just updated the steps. Can you please check again?

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MonilBhavsar Looks good to me All yours thanks!

@melvin-bot melvin-bot bot requested a review from MonilBhavsar July 17, 2023 16:59
@MonilBhavsar MonilBhavsar merged commit d0cc499 into Expensify:main Jul 17, 2023
13 checks passed
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.42-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

}

// Prevent losing Composer focus
e.preventDefault();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This caused issue of composer keep being focused even on right click which opens context menu.
As a solution, we call this line only on left click. There was already similar pattern here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants