Adding pagination to SelectionList component #37627

lukemorawski · 2024-03-01T18:31:29Z

Details

This PR adds pagination feature to the SelectionList component the same way as is in currently deprecated OptionsSelector.

Fixed Issues

$ #36121
PROPOSAL: no-proposal

Tests

same as QA
Verify that no errors appear in the JS console

Offline tests

same as QA

QA Steps

Open any list that uses SectionList (like SearchPage) on a high traffic account
scroll to the very bottom and tap "ShowMoreBottom"
look for any odd behaviour
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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.

Screenshots/Videos

Android: Native

native.android.mov

Android: mWeb Chrome

web.android.mov

iOS: Native

native.ios.mov

iOS: mWeb Safari

web.ios.mov

MacOS: Chrome / Safari

web.desktop.mov

MacOS: Desktop

native.desktop.mov

melvin-bot · 2024-03-01T18:56:01Z

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

fedirjh · 2024-03-05T10:55:39Z

src/components/SelectionList/BaseSelectionList.tsx

@@ -78,6 +80,9 @@ function BaseSelectionList<TItem extends ListItem>(
    const isFocused = useIsFocused();
    const [maxToRenderPerBatch, setMaxToRenderPerBatch] = useState(shouldUseDynamicMaxToRenderPerBatch ? 0 : CONST.MAX_TO_RENDER_PER_BATCH.DEFAULT);
    const [isInitialSectionListRender, setIsInitialSectionListRender] = useState(true);
+    const [currentPage, setCurrentPage] = useState(1);
+
+    const incrementPage = () => setCurrentPage((prev) => prev + 1);


When the search text changes, let's not forget to reset the pagination state. We have useEffect that takes care of resetting the focusedItem on text changes, we'll just have to reset the pagination state too.

cc @lukemorawski Friendly bump.

Yeah, sorry, you are absolutely right. Will fix that in a mo.

fedirjh · 2024-03-05T10:58:18Z

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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

CleanShot.2024-03-05.at.10.58.56.mp4

MacOS: Desktop

fedirjh

Looks good to me.

melvin-bot · 2024-03-12T12:36:56Z

@cristipaval looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

cristipaval · 2024-03-12T12:37:30Z

All checks were passed when I merged 🤔

OSBotify · 2024-03-12T12: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 · 2024-03-12T18:50:03Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.51-0 🚀

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

OSBotify · 2024-03-13T19:45:18Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.51-3 🚀

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

lukemorawski added 2 commits March 1, 2024 17:56

pagination

04625ae

linting

aad3855

lukemorawski marked this pull request as ready for review March 1, 2024 18:55

lukemorawski requested a review from a team as a code owner March 1, 2024 18:55

melvin-bot bot removed the request for review from a team March 1, 2024 18:56

melvin-bot bot requested a review from fedirjh March 1, 2024 18:56

fedirjh suggested changes Mar 5, 2024

View reviewed changes

current page on search value fix

1ba195b

fedirjh approved these changes Mar 12, 2024

View reviewed changes

melvin-bot bot requested a review from cristipaval March 12, 2024 11:28

cristipaval approved these changes Mar 12, 2024

View reviewed changes

cristipaval merged commit 0dc2151 into Expensify:main Mar 12, 2024
16 checks passed

melvin-bot bot added the Emergency label Mar 12, 2024

cristipaval removed the Emergency label Mar 12, 2024

github-actions bot mentioned this pull request Mar 12, 2024

Deploy Checklist: New Expensify 2024-03-12 #38162

Closed

84 tasks

melvin-bot bot mentioned this pull request Mar 13, 2024

[HOLD for payment 2024-03-20] [LOW] Enable pagination on SelectionList #36121

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding pagination to SelectionList component #37627

Adding pagination to SelectionList component #37627

lukemorawski commented Mar 1, 2024

melvin-bot bot commented Mar 1, 2024

fedirjh Mar 5, 2024 •

edited

Loading

fedirjh Mar 11, 2024

lukemorawski Mar 12, 2024

fedirjh commented Mar 5, 2024

fedirjh left a comment

melvin-bot bot commented Mar 12, 2024

cristipaval commented Mar 12, 2024

OSBotify commented Mar 12, 2024

OSBotify commented Mar 12, 2024

OSBotify commented Mar 13, 2024

Adding pagination to SelectionList component #37627

Adding pagination to SelectionList component #37627

Conversation

lukemorawski commented Mar 1, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 1, 2024

fedirjh Mar 5, 2024 • edited Loading

Choose a reason for hiding this comment

fedirjh Mar 11, 2024

Choose a reason for hiding this comment

lukemorawski Mar 12, 2024

Choose a reason for hiding this comment

fedirjh commented Mar 5, 2024

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Mar 12, 2024

cristipaval commented Mar 12, 2024

OSBotify commented Mar 12, 2024

OSBotify commented Mar 12, 2024

OSBotify commented Mar 13, 2024

fedirjh Mar 5, 2024 •

edited

Loading