Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(web): grants pagination reset page count #17665

Merged
merged 3 commits into from
Jan 29, 2025
Merged

Conversation

thorkellmani
Copy link
Member

@thorkellmani thorkellmani commented Jan 27, 2025

What

  • Updating filters reset pagination

Why

  • If currently on page 3 and the filters are updated, the user should be towed back to page 1.

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

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
    • Enhanced search functionality for grants with improved state management
  • Bug Fixes
    • Improved search input handling and pagination reset mechanism
  • Refactor
    • Streamlined search string management in the grants search results page

@thorkellmani thorkellmani requested a review from a team as a code owner January 27, 2025 11:02
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request modifies the search functionality in the Grants Search Results screen by introducing a new searchString state variable. This change replaces the previous query variable in the fetchGrants function, improving the management of search input. The implementation includes updating the useEffect hook, modifying the onResetFilter function, and adjusting the debounced search update mechanism to work with the new searchString state.

Changes

File Change Summary
apps/web/screens/Grants/SearchResults/SearchResults.tsx - Added searchString state variable as string | null
- Updated fetchGrants to use searchString
- Modified useEffect to depend on searchString
- Updated onResetFilter to clear searchString
- Adjusted debounced search update logic

Suggested labels

automerge

Suggested reviewers

  • mannipje

Possibly related PRs


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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
apps/web/screens/Grants/SearchResults/SearchResults.tsx (1)

89-89: Consider deriving searchString from query parameter

The searchString state duplicates information already present in the URL query parameter. Consider deriving it from query to avoid state synchronization issues.

-const [searchString, setSearchString] = useState<string | null>()
+const searchString = query
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27f0c9a and 9bfc299.

📒 Files selected for processing (1)
  • apps/web/screens/Grants/SearchResults/SearchResults.tsx (5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/web/screens/Grants/SearchResults/SearchResults.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 (5)
apps/web/screens/Grants/SearchResults/SearchResults.tsx (5)

120-120: LGTM!

The search parameter is correctly passed to the GraphQL query.


161-166: LGTM!

The debounced search update correctly resets pagination and updates the search string.


192-194: LGTM!

The reset functionality correctly clears all filters and resets pagination.


154-157: Review ESLint dependency warning suppression

The ESLint disable comment suggests potential missing dependencies. Consider including all dependencies or extracting the fetch logic to avoid the warning.

✅ Verification successful

ESLint dependency warning suppression is appropriate

The current implementation using useCallback with the ESLint warning suppression is correct. The effect's dependency array properly includes all relevant dependencies (categories, locale, organizations, page, searchString, types, status) while avoiding unnecessary re-renders from the stable fetchGrants callback.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for other useEffect hooks with disabled exhaustive-deps
rg -A 2 "useEffect.*\(" | rg "eslint-disable.*exhaustive-deps" -B 2

Length of output: 3256


Script:

#!/bin/bash
# Look for fetchGrants definition in SearchResults.tsx
ast-grep --pattern 'const fetchGrants = async () => { $$$ }'

Length of output: 62


Script:

#!/bin/bash
# Search for fetchGrants with context
rg "fetchGrants" apps/web/screens/Grants/SearchResults/SearchResults.tsx -B 2 -A 5

Length of output: 486


240-240: LGTM! Verify similar pagination patterns

The pagination reset on filter change is correctly implemented. Consider checking other similar patterns in the codebase.

✅ Verification successful

Pagination reset pattern is correctly implemented

The implementation follows the established pattern in the codebase where pagination state is reset when filters change. This is consistently implemented across multiple components including WorkMachinesOverview, DentistRegistration, MedicineCalculator, and others.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for similar pagination patterns that might need the same fix
ast-grep --pattern 'setPage($value)' | rg -A 5 -B 5 'setPage'

Length of output: 61


Script:

#!/bin/bash
# Search for page-related state declarations and their usage
rg -g '*.{ts,tsx,js,jsx}' -i 'const.*\[.*page.*,.*set.*page.*\].*useState'

# Search for pagination-related components and their implementations
rg -g '*.{ts,tsx,js,jsx}' -i '(pagination|paginate)' -A 3 -B 3

# Look for filter-related components with potential pagination
rg -g '*.{ts,tsx,js,jsx}' -i '(filter.*page|page.*filter)' -A 3 -B 3

Length of output: 66996

@thorkellmani thorkellmani added this pull request to the merge queue Jan 29, 2025
Merged via the queue into main with commit 4ab25e3 Jan 29, 2025
27 checks passed
@thorkellmani thorkellmani deleted the fix/pagination-errors branch January 29, 2025 11:32
RunarVestmann pushed a commit that referenced this pull request Jan 29, 2025
thorhildurt pushed a commit that referenced this pull request Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants