[CP Staging] Fix selecting items and animating Pages with SelectionList #40562

WojtekBoman · 2024-04-19T12:12:14Z

Details

This PR fixes an issue with the Notification preferences page transition and selecting items on pages with SelectionList.

Fixed Issues

$ #40426
$ #40410
PROPOSAL:

Tests / QA Steps

Verify that no errors appear in the JS console

Test 1:

Create a group chat.
Click on chat header > Settings > Click ‘Notify me about new replies’.
Verify whether the page opening animation works well.

Test 2:

Open a workspace chat (select the workspace with tags enabled, make sure there are enough tags to make the list scrollable).
Start manual request flow.
Click Tag.
Select a tag from the list.
Click Tag again.
Scroll down after opening the Tag list.
Click on any tag.
Verify that the clicked tag has been selected properly.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-04-19.at.14.13.13.mov

Screen.Recording.2024-04-22.at.11.53.17.mov

MacOS: Desktop

Screen.Recording.2024-04-19.at.14.15.17.mov

Screen.Recording.2024-04-22.at.11.51.08.mov

melvin-bot · 2024-04-19T12:16:00Z

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

paultsimura · 2024-04-19T12:29:11Z

@fedirjh would you take it as a regression fix, please?

fedirjh · 2024-04-19T18:40:27Z

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

CleanShot.2024-04-19.at.20.07.16.mp4

Android: mWeb Chrome

CleanShot.2024-04-19.at.20.05.12.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-04-19.at.20.03.31.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-04-19.at.20.01.25.mp4

MacOS: Chrome / Safari

CleanShot.2024-04-19.at.19.51.12.mp4

MacOS: Desktop

CleanShot.2024-04-19.at.20.07.57.mp4

fedirjh · 2024-04-19T19:37:35Z

src/components/SelectionList/BaseSelectionList.tsx

@@ -94,6 +95,7 @@ function BaseSelectionList<TItem extends ListItem>(
    const itemFocusTimeoutRef = useRef<NodeJS.Timeout | null>(null);
    const [currentPage, setCurrentPage] = useState(1);
    const isTextInputFocusedRef = useRef<boolean>(false);
+    const {didScreenTransitionEnd} = useScreenWrapperTranstionStatus();


@WojtekBoman The bug appears to affect other pages where we use the BaseListItem without using a list , e.g. the StatusClearAfterPage :

Video

Screen.Recording.2024-04-19.at.8.32.53.PM.mov

I think it would be ideal if we move this check to the useSyncFocus hook.

diff --git a/src/hooks/useSyncFocus/index.ts b/src/hooks/useSyncFocus/index.ts index bdc4a6a876..8c516645d9 100644 --- a/src/hooks/useSyncFocus/index.ts +++ b/src/hooks/useSyncFocus/index.ts @@ -1,6 +1,7 @@ import {useLayoutEffect} from 'react'; import type {RefObject} from 'react'; import type {View} from 'react-native'; +import useScreenWrapperTranstionStatus from "@hooks/useScreenWrapperTransitionStatus"; /** * Custom React hook created to handle sync of focus on an element when the user navigates through the app with keyboard. @@ -8,13 +9,15 @@ import type {View} from 'react-native'; * To maintain consistency when an element is focused in the app, the focus() method is additionally called on the focused element to eliminate the difference between native browser focus and application focus. */ const useSyncFocus = (ref: RefObject<HTMLDivElement | View>, isFocused: boolean) => { + const {didScreenTransitionEnd} = useScreenWrapperTranstionStatus(); + useLayoutEffect(() => { - if (!isFocused) { + if (!isFocused || !didScreenTransitionEnd) { return; } ref.current?.focus(); - }, [isFocused, ref]); + }, [didScreenTransitionEnd, isFocused, ref]); }; export default useSyncFocus;

…here text input is displayed

…tReportFieldDropdown

WojtekBoman · 2024-04-22T09:26:42Z

I've included in this PR also the fix for this issue: #40410. To solve this problem, I added a shouldPreventDefaultFocusOnSelectRow prop to each SelectionList component that displays the text input. We've already had this prop added in similar cases, so I think this change will make the code more consistent.

WojtekBoman · 2024-04-22T09:57:35Z

@fedirjh @roryabraham It's ready for another round of review :)

fedirjh · 2024-04-22T10:01:20Z

To solve this problem, I added a shouldPreventDefaultFocusOnSelectRow prop to each SelectionList component that displays the text input.

@WojtekBoman This doesn't seem to fix the root cause of the issue. Even after implementing this fix, the bug persists when the text input loses focus. In such cases, if the selected item is not currently visible in the list, the list will automatically scroll to make it visible.

Steps to reproduce :

Focus on textInput
Scroll down until the selected item is not visible
Click outside the textInput and verify that the list is automatically scrolled to the top.

CleanShot.2024-04-22.at.10.55.45.mp4

WojtekBoman · 2024-04-22T10:27:14Z

@fedirjh I've added one more adjustment, could you check it now? During this time I'll check if it's necessary to add shouldPreventDefaultFocusOnSelectRow to SelectionList with text inputs. If not, I'll revert my commit

…nLists where text input is displayed" This reverts commit a0e6f68.

fedirjh · 2024-04-22T10:34:52Z

I've added one more adjustment, could you check it now?

Seems to be working fine for me.

…t in EditReportFieldDropdown" This reverts commit d3f94ef.

WojtekBoman · 2024-04-22T10:38:28Z

I've reverted all changes that added shouldPreventDefaultFocusOnSelectRow prop, you were right it didn't fix the root cause of this issue :) Thanks for noticing that, your video was very helpful

fedirjh · 2024-04-22T11:24:42Z

Screenshots/Videos for #40410

Web

CleanShot.2024-04-22.at.11.42.59.mp4

Mobile Web - Chrome

CleanShot.2024-04-22.at.11.50.04.mp4

Mobile Web - Safari

CleanShot.2024-04-22.at.12.09.00.mp4

Desktop

CleanShot.2024-04-22.at.12.20.23.mp4

iOS

CleanShot.2024-04-22.at.12.13.59.mp4

Android

CleanShot.2024-04-22.at.11.56.42.mp4

fedirjh

Looks good to me

WojtekBoman · 2024-04-22T11:39:51Z

@fedirjh I see one thing that is a side effect of changes introduced in this PR:
When we scroll using the arrows on the keyboard and then press the Tab button while text input is active, we'll be scrolled to the top of the list.

Screen.Recording.2024-04-22.at.13.37.37.mov

mountiny · 2024-04-22T11:45:11Z

I think that is ok to move ahead to fix the deploy blocker

fedirjh · 2024-04-22T11:57:14Z

I see one thing that is a side effect of changes introduced in this PR:

@WojtekBoman I think we can handle that in a followup PR. It doesn’t seem like it has a straightforward fix. Probably we can add new useKeyboardShortcut for the TAB navigation inside the useArrowKeyFocusManager and make it focus on the selected item.

cristipaval

Code LGTM. I'll test this real quick to confirm the selection for the tags works.

…-preferences-animation [CP Staging] Fix selecting items and animating Pages with SelectionList (cherry picked from commit 2c15ccc)

kavimuru · 2024-04-22T14:19:18Z

Issue #40410 is not completely fixed in web.
Sometimes the list scrolls down when selecting a tag and the tag is not selected. Sometimes it scrolls down while selecting a tag.

bandicam.2024-04-22.21-06-36-698.mp4

mountiny · 2024-04-22T14:22:44Z

Thanks for testing, from the video it seems like its mostly ok, but we need to make this reliable @WojtekBoman if you could continue with the clean up? thanks!

WojtekBoman · 2024-04-22T14:54:14Z

Issue #40410 is not completely fixed in web. Sometimes the list scrolls down when selecting a tag and the tag is not selected. Sometimes it scrolls down while selecting a tag.

bandicam.2024-04-22.21-06-36-698.mp4

@kavimuru Could you check if it works for you on this branch: #40703

OSBotify · 2024-04-22T15:03:16Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

Check didScreenTransitionEnd in BaseSelectionList

c678929

WojtekBoman marked this pull request as ready for review April 19, 2024 12:15

WojtekBoman requested a review from a team as a code owner April 19, 2024 12:15

melvin-bot bot removed the request for review from a team April 19, 2024 12:15

melvin-bot bot requested a review from paultsimura April 19, 2024 12:16

roryabraham requested review from fedirjh and removed request for paultsimura April 19, 2024 18:52

roryabraham previously approved these changes Apr 19, 2024

View reviewed changes

fedirjh suggested changes Apr 19, 2024

View reviewed changes

WojtekBoman added 3 commits April 22, 2024 09:44

Merge branch 'main' into fix/notification-preferences-animation

0483e94

Move useScreenWrapperTranstionStatus to useSyncFocus

45d64f3

Add checking shouldPreventDefaultFocusOnSelectRow to SelectionLists w…

a0e6f68

…here text input is displayed

WojtekBoman dismissed roryabraham’s stale review via a0e6f68 April 22, 2024 09:00

WojtekBoman changed the title ~~Check didScreenTransitionEnd in BaseSelectionList~~ Fix animating and selecting items on Pages with SelectionList Apr 22, 2024

WojtekBoman changed the title ~~Fix animating and selecting items on Pages with SelectionList~~ Fix selecting items and animating Pages with SelectionList Apr 22, 2024

Add shouldPreventDefaultFocusOnSelectRow prop to SelectionList in Edi…

d3f94ef

…tReportFieldDropdown

Add shouldUseSync param to useSyncFocus hook

e756647

Revert "Add checking shouldPreventDefaultFocusOnSelectRow to Selectio…

58cdf15

…nLists where text input is displayed" This reverts commit a0e6f68.

Revert "Add shouldPreventDefaultFocusOnSelectRow prop to SelectionLis…

077ca98

…t in EditReportFieldDropdown" This reverts commit d3f94ef.

Fix lint

741b1e3

mountiny changed the title ~~Fix selecting items and animating Pages with SelectionList~~ [CP Stagin] Fix selecting items and animating Pages with SelectionList Apr 22, 2024

mountiny assigned WojtekBoman Apr 22, 2024

fedirjh approved these changes Apr 22, 2024

View reviewed changes

melvin-bot bot requested a review from cristipaval April 22, 2024 11:38

cristipaval approved these changes Apr 22, 2024

View reviewed changes

mountiny changed the title ~~[CP Stagin] Fix selecting items and animating Pages with SelectionList~~ [CP Staging] Fix selecting items and animating Pages with SelectionList Apr 22, 2024

cristipaval merged commit 2c15ccc into Expensify:main Apr 22, 2024
18 checks passed

OSBotify pushed a commit that referenced this pull request Apr 22, 2024

Merge pull request #40562 from software-mansion-labs/fix/notification…

00520bb

…-preferences-animation [CP Staging] Fix selecting items and animating Pages with SelectionList (cherry picked from commit 2c15ccc)

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

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

WojtekBoman mentioned this pull request Apr 22, 2024

Add shouldPreventDefaultFocusOnSelectRow to SelectionLists where TextInput is displayed #40703

Closed

50 tasks

bernhardoj mentioned this pull request Apr 27, 2024

[$250] Scan split - Confirmation page & Category RHPs appear together when opening Category #40538

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Fix selecting items and animating Pages with SelectionList #40562

[CP Staging] Fix selecting items and animating Pages with SelectionList #40562

WojtekBoman commented Apr 19, 2024 •

edited

Loading

melvin-bot bot commented Apr 19, 2024

paultsimura commented Apr 19, 2024 •

edited

Loading

fedirjh commented Apr 19, 2024 •

edited

Loading

fedirjh Apr 19, 2024

WojtekBoman commented Apr 22, 2024 •

edited

Loading

WojtekBoman commented Apr 22, 2024

fedirjh commented Apr 22, 2024

WojtekBoman commented Apr 22, 2024

fedirjh commented Apr 22, 2024

WojtekBoman commented Apr 22, 2024 •

edited

Loading

fedirjh commented Apr 22, 2024 •

edited

Loading

fedirjh left a comment

WojtekBoman commented Apr 22, 2024 •

edited

Loading

mountiny commented Apr 22, 2024

fedirjh commented Apr 22, 2024

cristipaval left a comment

kavimuru commented Apr 22, 2024

mountiny commented Apr 22, 2024

WojtekBoman commented Apr 22, 2024

OSBotify commented Apr 22, 2024

[CP Staging] Fix selecting items and animating Pages with SelectionList #40562

[CP Staging] Fix selecting items and animating Pages with SelectionList #40562

Conversation

WojtekBoman commented Apr 19, 2024 • edited Loading

Details

Fixed Issues

Tests / QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 19, 2024

paultsimura commented Apr 19, 2024 • edited Loading

fedirjh commented Apr 19, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

fedirjh Apr 19, 2024

Choose a reason for hiding this comment

WojtekBoman commented Apr 22, 2024 • edited Loading

WojtekBoman commented Apr 22, 2024

fedirjh commented Apr 22, 2024

WojtekBoman commented Apr 22, 2024

fedirjh commented Apr 22, 2024

WojtekBoman commented Apr 22, 2024 • edited Loading

fedirjh commented Apr 22, 2024 • edited Loading

Screenshots/Videos for #40410

fedirjh left a comment

Choose a reason for hiding this comment

WojtekBoman commented Apr 22, 2024 • edited Loading

mountiny commented Apr 22, 2024

fedirjh commented Apr 22, 2024

cristipaval left a comment

Choose a reason for hiding this comment

kavimuru commented Apr 22, 2024

mountiny commented Apr 22, 2024

WojtekBoman commented Apr 22, 2024

OSBotify commented Apr 22, 2024

WojtekBoman commented Apr 19, 2024 •

edited

Loading

paultsimura commented Apr 19, 2024 •

edited

Loading

fedirjh commented Apr 19, 2024 •

edited

Loading

WojtekBoman commented Apr 22, 2024 •

edited

Loading

WojtekBoman commented Apr 22, 2024 •

edited

Loading

fedirjh commented Apr 22, 2024 •

edited

Loading

WojtekBoman commented Apr 22, 2024 •

edited

Loading