fix(web): Generic List - Reset page number when filters are changed

[RunarVestmann]

Generic List - Reset page number when filters are changed

What

• Clicking on filters (when there is only one or fewer filter categories) does not reset the page number

Screenshots / Gifs

This will fix this issue:

Screen.Recording.2024-12-05.at.12.26.21.mov

Checklist:

• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• Formatting passes locally with my changes
• I have rebased against main before asking for a review

Summary by CodeRabbit

• New Features

  • Improved filter handling in the GenericList component, ensuring pagination resets when filters are applied or modified.

• Bug Fixes

  • Resolved issues with pagination not resetting correctly when filters were cleared or changed, enhancing user experience.

[coderabbitai]

Walkthrough

The changes in this pull request focus on the GenericList component, specifically enhancing the functionality related to filter parameters and pagination. Modifications ensure that the pagination resets to the first page whenever a filter is applied, cleared, or modified. This is achieved by invoking setPage(null) in relevant event handlers. The GenericListWrapper component remains mostly unchanged but utilizes the updated GenericList, which now features improved state management for filter interactions.

Changes

File Path	Change Summary
apps/web/components/GenericList/GenericList.tsx	Enhanced filter handling by resetting pagination on filter changes; modified selectedFiltersComponent, onChange, and onClear handlers.

Possibly related PRs

• feat(web): Generic List - UX improvements #15983: This PR enhances the handling of pagination and filtering in the GenericList component, including resetting the page number when filters are applied, which directly relates to the changes made in the main PR.
• feat(web): Generic List - Display filter tags if only one tag group is present #16118: This PR introduces a new component for displaying selected filters in the GenericList, which involves modifications to the filter handling logic, aligning with the main PR's focus on improving filter interactions and pagination management.

Suggested reviewers

• mannipje

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 35.74%. Comparing base (4ff3865) to head (5a0a8bb).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
apps/web/components/GenericList/GenericList.tsx	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #17141      +/-   ##
==========================================
- Coverage   35.74%   35.74%   -0.01%     
==========================================
  Files        6925     6925              
  Lines      147569   147571       +2     
  Branches    42010    42010              
==========================================
  Hits        52747    52747              
- Misses      94822    94824       +2     

Flag	Coverage Δ
web	2.43% <0.00%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
apps/web/components/GenericList/GenericList.tsx	0.00% <0.00%> (ø)

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4ff3865...5a0a8bb. Read the comment docs.

[datadog-island-is]

Datadog Report

Branch report: fix/web-generic-list-page-number-sticks-when-filtering
Commit report: 088fd59
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 34.79s Total Time
➡️ Test Sessions change in coverage: 1 no change

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

apps/web/components/GenericList/GenericList.tsx (1)

Line range hint 314-481: Consider centralizing page reset logic

The page reset logic is currently duplicated across different filter handlers. Consider extracting this into a custom hook or utility function to improve maintainability and ensure consistent behavior.

Example implementation:

const useFilterWithPageReset = (
  setParameters: (value: Record<string, string[]> | null) => void,
  setPage: (value: number | null) => void,
) => {
  const updateFilters = (
    updater: (prev: Record<string, string[]> | null) => Record<string, string[]> | null,
  ) => {
    setPage(null);
    setParameters(updater);
  };
  
  return updateFilters;
};

This would centralize the page reset logic and could be used across all filter handlers.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4ff3865 and 5a0a8bb.

📒 Files selected for processing (1)

• apps/web/components/GenericList/GenericList.tsx (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

apps/web/components/GenericList/GenericList.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

• NextJS best practices, including file structure, API routes, and static generation methods.
• Efficient state management and server-side rendering techniques.
• Optimal use of TypeScript for component and utility type safety."

🔇 Additional comments (2)

apps/web/components/GenericList/GenericList.tsx (2)

Line range hint 314-339: LGTM: Correctly resets page when removing filters

The addition of setPage(null) ensures that the page number resets to 1 when a filter is removed, which aligns with the expected behavior and fixes the reported issue.

---

Line range hint 469-481: LGTM: Correctly resets page when adding filters

The addition of setPage(null) ensures that the page number resets to 1 when a new filter is added, maintaining consistent behavior with filter removal and completing the fix for the reported issue.