Added allOptions to scrollToIndex callback dependencies #29848

jayeshmangwani · 2023-10-18T09:34:45Z

Details

Fixed Issues

$ #29022
PROPOSAL: #29022 (comment)

Tests

Open App
Create a new one or go to the existing Workspace
Go to Workspace> Members > Invite
Scroll the user's list with Up and Down Arrows on the keyboard
Verify that the user's list is going Up and Down using arrows

Verify that no errors appear in the JS console

Offline tests

Open App
Create a new one or go to the existing Workspace
Go to Workspace> Members > Invite
Go Offline
Scroll the user's list with Up and Down Arrows on the keyboard
Verify that the user's list is going Up and Down using arrows

QA Steps

Same as Tests

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 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

Android: Native

Android.1.mp4

Android: mWeb Chrome

mWeb-chrome.mp4

iOS: Native

iOS.mp4

iOS: mWeb Safari

mWeb-safari.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mov

melvin-bot · 2023-10-18T09:34:51Z

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

jayeshmangwani · 2023-10-18T11:38:18Z

src/components/SelectionList/BaseSelectionList.js

-    }, []);
+            listRef.current.scrollToLocation({sectionIndex: adjustedSectionIndex, itemIndex, animated, viewOffset: variables.contentHeaderHeight});
+        },
+        [flattenedSections.allOptions, sections],


@rushatgabhane Getting below error if we pass only flattenedSections.allOptions to dependencies, so to solve that warning, I've added the sections to the dependencies; not sure if this is a good idea as this line (we would need to make sure that the sections prop is stable in every usage of this component)
suggests we should check if sections are stable in every usage, right now SelectionList is being used at 14 pages.

@jayeshmangwani can't we exclude sections from the deps? and slap eslint supress on it

// eslint-disable-next-line react-hooks/exhaustive-deps

@rushatgabhane Thanks for the suggestion. It would also work. I have added disable exhaustive-deps and pushed code.

@rushatgabhane Applied suggested changes and merged the main branch; please help to review

…ctionList_recompute_on_allOptions

rushatgabhane · 2023-10-25T15:30:30Z

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

Screen.Recording.2023-10-26.at.08.52.05.mov

Mobile Web - Chrome

Mobile Web - Safari

Screen.Recording.2023-10-27.at.10.10.15.mov

Desktop

Screen.Recording.2023-10-27.at.10.21.55.mov

iOS

Screen.Recording.2023-10-26.at.09.08.13.mov

Android

rushatgabhane

LGTM!

BTW, my android sim isn't working. others are facing the issue too https://expensify.slack.com/archives/C01GTK53T8Q/p1698287864012389

Let me know if it's ok to merge this PR w/o screenshot for android

OSBotify · 2023-10-27T13:52:11Z

✋ 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-10-30T08:02:26Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.93-0 🚀

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

OSBotify · 2023-10-31T21:35:35Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.93-1 🚀

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

OSBotify · 2023-10-31T22:02:28Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-01T08:54:27Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-02T10:17:48Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀

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

jayeshmangwani added 2 commits October 18, 2023 14:46

added allOptions to useCallback dependencies

f9c66e1

Merge branch 'main' into BaseSelectionList_recompute_on_allOptions

30aa502

jayeshmangwani requested a review from a team as a code owner October 18, 2023 09:34

melvin-bot bot requested review from rushatgabhane and removed request for a team October 18, 2023 09:34

jayeshmangwani added 3 commits October 18, 2023 15:13

fix: prettier diff detected

a598013

Merge branch 'main' into BaseSelectionList_recompute_on_allOptions

192b250

added sections to scrollToIndex dependencies

db319a7

jayeshmangwani commented Oct 18, 2023

View reviewed changes

jayeshmangwani added 6 commits October 18, 2023 22:23

Merge branch 'main' of https://github.com/Expensify/App into BaseSele…

8e93bcc

…ctionList_recompute_on_allOptions

Merge branch 'main' into BaseSelectionList_recompute_on_allOptions

70175bc

Merge branch 'main' of https://github.com/Expensify/App into BaseSele…

c381042

…ctionList_recompute_on_allOptions

dsable exhaustive-deps for scrollToIndex

c51b667

Merge branch 'main' into BaseSelectionList_recompute_on_allOptions

9554060

Merge branch 'main' into BaseSelectionList_recompute_on_allOptions

7b234aa

rushatgabhane approved these changes Oct 26, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath October 26, 2023 03:39

puneetlath approved these changes Oct 27, 2023

View reviewed changes

puneetlath merged commit 1fc2bbc into Expensify:main Oct 27, 2023
13 of 14 checks passed

ZhenjaHorbach mentioned this pull request Oct 27, 2023

[$500] Workspace - Selected contact with green tick is not scrolled up &shown while inviting members #30517

Closed

6 tasks

OSBotify mentioned this pull request Oct 30, 2023

Deploy Checklist: New Expensify 2023-10-30 #30560

Closed

melvin-bot bot mentioned this pull request Oct 31, 2023

[HOLD for payment 2023-11-07] [$500] WS - Members - List of users invited to the workspace does not scroll with Up and Down arrows #29022

Closed

6 tasks

OSBotify mentioned this pull request Oct 31, 2023

Deploy Checklist: New Expensify 2023-10-31 #30662

Closed

97 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added allOptions to scrollToIndex callback dependencies #29848

Added allOptions to scrollToIndex callback dependencies #29848

jayeshmangwani commented Oct 18, 2023

melvin-bot bot commented Oct 18, 2023

jayeshmangwani Oct 18, 2023

rushatgabhane Oct 20, 2023 •

edited

Loading

jayeshmangwani Oct 20, 2023

jayeshmangwani Oct 20, 2023

rushatgabhane commented Oct 25, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

OSBotify commented Oct 27, 2023

OSBotify commented Oct 30, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Nov 1, 2023

OSBotify commented Nov 2, 2023

Added allOptions to scrollToIndex callback dependencies #29848

Added allOptions to scrollToIndex callback dependencies #29848

Conversation

jayeshmangwani commented Oct 18, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 18, 2023

jayeshmangwani Oct 18, 2023

Choose a reason for hiding this comment

rushatgabhane Oct 20, 2023 • edited Loading

Choose a reason for hiding this comment

jayeshmangwani Oct 20, 2023

Choose a reason for hiding this comment

jayeshmangwani Oct 20, 2023

Choose a reason for hiding this comment

rushatgabhane commented Oct 25, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

OSBotify commented Oct 27, 2023

OSBotify commented Oct 30, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Nov 1, 2023

OSBotify commented Nov 2, 2023

rushatgabhane Oct 20, 2023 •

edited

Loading

rushatgabhane commented Oct 25, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading