fix: scroll date of birth year list on first mount only #23079

allroundexperts · 2023-07-18T12:42:18Z

Details

This PR modifies the logic inside the SectionList, such that it scrolls to the focus index only on the first layout.

Fixed Issues

$ #22689
PROPOSAL: #22689 (comment)

Tests

Open the App on mweb.
Go to Settings > Profile > Personal details > Date of birth
Tap on the year to open year list
With the keyboard on, scroll up the list and verify that the list does not scroll back to the focused index.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open the App on mweb.
Go to Settings > Profile > Personal details > Date of birth
Tap on the year to open year list
With the keyboard on, scroll up the list and verify that the list does not scroll back to the focused index.

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 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 correct English and 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

Screen.Recording.2023-07-18.at.5.21.31.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-07-18.at.5.24.41.PM.mov

Mobile Web - Safari

Screen.Recording.2023-07-18.at.5.23.42.PM.mov

Desktop

Screen.Recording.2023-07-18.at.5.22.27.PM.mov

iOS

Screen.Recording.2023-07-18.at.5.23.10.PM.mov

Android

Screen.Recording.2023-07-18.at.5.25.49.PM.mov

melvin-bot · 2023-07-18T12:42:23Z

@fedirjh 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 · 2023-07-18T12:43:41Z

@fedirjh FYI, I'm not using useEffect with [] because it seems to be triggered before the flat list is rendered on iOS.

fedirjh · 2023-07-18T13:15:18Z

src/components/SelectionListRadio/BaseSelectionListRadio.js

+                                if (!firstLayoutRef.current) {
+                                    return;
+                                }


@allroundexperts Let's move the logic inside scrollToIndex method.

Hm... Are you sure about this? I mean it would be better if the scrollToIndex function would have single responsibility.

Oh I thought it was used only for this instance , it seems to be used on ArrowKeyFocusManager as well .

I wonder why we can’t just remove the scrolling onLayout ? it does feel like a workaround.

Well, removing it would not scroll the list to the last element.

Can’t we fix that with a useEffect ? something like

useEffect(() => scrollToIndex(focusedIndex, false), [focusedIndex]);

This is what I tried first. It works on every platform except on iOS native 😿

Another option would have been to have a state + useEffect:

const [onLayoutTriggered, setOnLayoutTriggered] = useState(false); useEffect(() => { if (onLayoutTriggered) { scrollToIndex(focusedIndex, false); } }, [focusedIndex, onLayoutTriggered]); ... <SectionList onLayout={() => setOnLayoutTriggered(true)} </SectionList>

but I'm not really sure that that is better than what you did with the ref.

Hm... Are you sure about this? I mean it would be better if the scrollToIndex function would have single responsibility.

Agree, I prefer how it is now.

but I'm not really sure that that is better than what you did with the ref.

I think ref is better approach as it doesn’t trigger a re-render when it's updated unlike using the state.

fedirjh · 2023-07-18T14:52:55Z

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

Web.mp4

Mobile Web - Chrome

Chrome.mp4

Mobile Web - Safari

Safari.mp4

Desktop

Desktop.mp4

iOS

IOS.mp4

Android

Android.mp4

fedirjh

Looks good to me and tests well.

OSBotify · 2023-07-20T00:42:29Z

✋ 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-07-21T18:51:06Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.3.44-0 🚀

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

OSBotify · 2023-07-25T01:25:03Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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

OSBotify · 2023-07-25T01:45:39Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.3.45-0 🚀

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

OSBotify · 2023-07-26T15:55:10Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.45-7 🚀

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

fix: scroll date of birth year list on first mount only

31b3bc8

allroundexperts requested a review from a team as a code owner July 18, 2023 12:42

melvin-bot bot removed the request for review from a team July 18, 2023 12:42

melvin-bot bot requested a review from fedirjh July 18, 2023 12:42

allroundexperts mentioned this pull request Jul 18, 2023

[HOLD for payment 2023-08-01] [$1000] Date of birth - Year list is scrolled back to current selection when keyboard disappears #22689

Closed

6 tasks

fedirjh reviewed Jul 18, 2023

View reviewed changes

fedirjh approved these changes Jul 18, 2023

View reviewed changes

melvin-bot bot requested a review from aldo-expensify July 18, 2023 14:56

aldo-expensify approved these changes Jul 20, 2023

View reviewed changes

aldo-expensify merged commit f11364f into Expensify:main Jul 20, 2023

OSBotify mentioned this pull request Jul 21, 2023

Deploy Checklist: New Expensify 2023-07-21 #23362

Closed

OSBotify mentioned this pull request Jul 25, 2023

Deploy Checklist: New Expensify 2023-07-25 #23522

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: scroll date of birth year list on first mount only #23079

fix: scroll date of birth year list on first mount only #23079

allroundexperts commented Jul 18, 2023

melvin-bot bot commented Jul 18, 2023

allroundexperts commented Jul 18, 2023

fedirjh Jul 18, 2023

allroundexperts Jul 18, 2023

fedirjh Jul 18, 2023

fedirjh Jul 18, 2023 •

edited

Loading

allroundexperts Jul 18, 2023

fedirjh Jul 18, 2023

allroundexperts Jul 18, 2023

aldo-expensify Jul 20, 2023 •

edited

Loading

aldo-expensify Jul 20, 2023

fedirjh Jul 20, 2023

fedirjh commented Jul 18, 2023

fedirjh left a comment

OSBotify commented Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

fix: scroll date of birth year list on first mount only #23079

fix: scroll date of birth year list on first mount only #23079

Conversation

allroundexperts commented Jul 18, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 18, 2023

allroundexperts commented Jul 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh Jul 18, 2023 • 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

aldo-expensify Jul 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh commented Jul 18, 2023

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

fedirjh Jul 18, 2023 •

edited

Loading

aldo-expensify Jul 20, 2023 •

edited

Loading