Fix: Chats - Selected chat is hidden when navigating via keyboard by tushar-a-b · Pull Request #51754 · Expensify/App

tushar-a-b · 2024-10-30T18:25:59Z

Explanation of Change

This PR addresses an issue where focused chat moves out of view in search chats section.

Fixed Issues

$ #48902
PROPOSAL: #48902 (comment)

Tests

Precondition:

The account contains many chats.
Some messages in the chats are large in size.

Steps:

Go to Search > Chats.
Navigate through the list using the keyboard's up and down buttons.
Verify that the selected chat is not hidden when navigating via keyboard.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-10-30T18:26:04Z

@rayane-djouah 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]

rayane-d · 2024-11-01T18:31:54Z

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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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-11-05.at.7.59.43.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-11-05.at.7.54.44.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-05.at.20.29.58.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-05.at.19.21.57.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-11-05.at.6.58.51.PM.mov

MacOS: Desktop

Screen.Recording.2024-11-05.at.7.03.15.PM.mov

rayane-d

Instead of passing searchType to BaseSelectionList, consider passing a shouldKeepFocusedItemAtTopOfViewableArea boolean prop. This would make the solution reusable and help keep BaseSelectionList more abstract.

rayane-d · 2024-11-02T18:06:21Z

src/components/Search/index.tsx

            }
            contentContainerStyle={[contentContainerStyle, styles.pb3]}
            scrollEventThrottle={1}
+            searchType={type}


Suggested change

searchType={type}

shouldKeepFocusedItemAtTopOfViewableArea={type === CONST.SEARCH.DATA_TYPES.CHAT}

rayane-d · 2024-11-02T18:07:29Z

src/components/SelectionList/BaseSelectionList.tsx

        scrollEventThrottle,
        contentContainerStyle,
        shouldHighlightSelectedItem = false,
+        searchType = '',


Suggested change

searchType = '',

shouldKeepFocusedItemAtTopOfViewableArea = false,

rayane-d · 2024-11-02T18:07:45Z

src/components/SelectionList/BaseSelectionList.tsx

+            // Since there are always two items above the focused item in viewable area, and items can grow beyond the screen size
+            // in searchType chat, the focused item may move out of view. To prevent this, we will ensure that the focused item remains at
+            // the top of the viewable area at all times by adjusting the viewOffset.
+            if (searchType === 'chat') {


Suggested change

if (searchType === 'chat') {

if (shouldKeepFocusedItemAtTopOfViewableArea) {

Let's also adjust the comment

src/components/SelectionList/types.ts

tushar-a-b · 2024-11-03T06:56:30Z

Instead of passing searchType to BaseSelectionList, consider passing a shouldKeepFocusedItemAtTopOfViewableArea boolean prop. This would make the solution reusable and help keep BaseSelectionList more abstract.

Yup, that's a good idea 👍

…TopOfViewableArea` instead of `searchType`

rayane-d

LGTM and tests well 👍

rayane-d · 2024-11-05T19:27:10Z

@tushar-a-b Let's clarify the QA tests (Add expected behaviour):


Precondition:

- The account contains many chats.
- Some messages in the chats are large in size.

Steps:

1. Go to Search > Chats.
2. Navigate through the list using the keyboard's up and down buttons.
3. Verify that the selected chat is not hidden when navigating via keyboard.

tushar-a-b · 2024-11-06T02:09:44Z

Let's clarify the QA tests (Add expected behaviour)

Yes, Thanks! @rayane-djouah

rayane-d · 2024-11-06T07:09:24Z

@marcochavezf all yours!

marcochavezf

LGTM, Thanks!

OSBotify · 2024-11-06T16:54:04Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-11-07T13:08:53Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 9.0.59-0 🚀

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

github-actions · 2024-11-11T18:14:28Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.59-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

tushar-a-b added 2 commits October 30, 2024 13:19

fix selected chat is hidden when navigating via keyboard

27dd544

use .at() method instead of direct indexing to resolve lint warnings

a06ba5b

tushar-a-b requested a review from a team as a code owner October 30, 2024 18:26

melvin-bot bot requested review from rayane-d and removed request for a team October 30, 2024 18:26

tushar-a-b mentioned this pull request Oct 30, 2024

[HOLD for payment 2024-11-18] [$250] [Search v2.2] - Chats - Selected chat is hidden when navigating via keyboard #48902

Closed

6 tasks

resolve typecheck error

f1affc3

rayane-d suggested changes Nov 2, 2024

View reviewed changes

Update focused item positioning logic to use `shouldKeepFocusedItemAt…

fa8db91

…TopOfViewableArea` instead of `searchType`

rayane-d approved these changes Nov 5, 2024

View reviewed changes

melvin-bot bot requested a review from marcochavezf November 5, 2024 19:18

marcochavezf approved these changes Nov 6, 2024

View reviewed changes

marcochavezf merged commit 7a90267 into Expensify:main Nov 6, 2024

github-actions bot mentioned this pull request Nov 7, 2024

Deploy Checklist: New Expensify 2024-11-07 #52178

Closed

60 tasks

	searchType={type}
	shouldKeepFocusedItemAtTopOfViewableArea={type === CONST.SEARCH.DATA_TYPES.CHAT}

	searchType = '',
	shouldKeepFocusedItemAtTopOfViewableArea = false,

	if (searchType === 'chat') {
	if (shouldKeepFocusedItemAtTopOfViewableArea) {

Conversation

tushar-a-b commented Oct 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 30, 2024

Uh oh!

rayane-d commented Nov 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

rayane-d left a comment

Choose a reason for hiding this comment

Uh oh!

rayane-d Nov 2, 2024

Choose a reason for hiding this comment

Uh oh!

rayane-d Nov 2, 2024

Choose a reason for hiding this comment

Uh oh!

rayane-d Nov 2, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tushar-a-b commented Nov 3, 2024

Uh oh!

rayane-d left a comment

Choose a reason for hiding this comment

Uh oh!

rayane-d commented Nov 5, 2024

Uh oh!

tushar-a-b commented Nov 6, 2024

Uh oh!

rayane-d commented Nov 6, 2024

Uh oh!

marcochavezf left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 6, 2024

Uh oh!

github-actions bot commented Nov 7, 2024

Uh oh!

github-actions bot commented Nov 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tushar-a-b commented Oct 30, 2024 •

edited

Loading

rayane-d commented Nov 1, 2024 •

edited

Loading