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

Deep merge User & System Filters for DataGrid #1616

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Conversation

rdonigian
Copy link
Contributor

@rdonigian rdonigian commented Oct 31, 2024

This fixes a problem where user input filters were getting overwritten. Now variables and input deep merge properly for data requests.

Summary by CodeRabbit

  • Bug Fixes
    • Improved data handling within the data grid component for better performance.
  • Refactor
    • Streamlined the process of merging data for pagination and filters, enhancing code readability and maintainability.

@rdonigian rdonigian requested a review from CarsonF as a code owner October 31, 2024 14:23
Copy link
Contributor

coderabbitai bot commented Oct 31, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to the useDataGridSource hook in src/components/Grid/useDataGridSource.tsx. Key changes include replacing the lodash pick function with merge, simplifying the computation of variablesWithFilter, and updating the construction of the variables object for the firstPage query. The onFetchRows function has also been adjusted to utilize merge for building query variables. These changes enhance the clarity and efficiency of the code while maintaining the existing control flow and error handling.

Changes

File Change Summary
src/components/Grid/useDataGridSource.tsx Replaced pick with merge in lodash import; simplified variablesWithFilter using merge; updated variables construction for firstPage query; modified onFetchRows to use merge for query variables.

Possibly related PRs

Suggested reviewers

  • CarsonF

Poem

🐇 In the grid where data flows,
Merging inputs, watch it grow!
With every change, a clearer sight,
Our hook now shines, oh what a delight!
So hop along, let’s fetch with glee,
For data’s dance is wild and free! 🌼


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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

🧹 Outside diff range and nitpick comments (1)
src/components/Grid/useDataGridSource.tsx (1)

Line range hint 278-344: Consistent implementation of deep merging strategy

The implementation consistently uses lodash merge across all variable compositions (variablesWithFilter, firstPage query, and onFetchRows), which is a solid architectural choice. This unified approach ensures that filters are properly preserved throughout the DataGrid's lifecycle.

Consider documenting this pattern in the component's documentation to ensure future modifications maintain this consistency.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 06d8ce8 and 8efcaee.

📒 Files selected for processing (1)
  • src/components/Grid/useDataGridSource.tsx (4 hunks)
🔇 Additional comments (2)
src/components/Grid/useDataGridSource.tsx (2)

36-36: LGTM: Import of lodash merge function

The addition of merge from lodash is appropriate for implementing deep merging of variables and input.


278-279: LGTM: Simplified variables merging logic

The use of lodash merge ensures proper deep merging of variables and input, which addresses the PR objective of preventing filter overwrites.

Let's verify the structure of merged variables:

✅ Verification successful

Merging behavior appears to be correctly implemented

From the context we can see that:

  • The variablesWithFilter is used specifically for filtered queries
  • Pagination fields (count, sort, order) are properly excluded before merging
  • The merged result is used consistently in both cache updates and filtered queries
  • The deep merge with lodash ensures proper object composition

The implementation aligns with the intended behavior and shows proper separation of concerns between filtered and unfiltered data handling.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for tests or usage patterns of variablesWithFilter to ensure proper merging
rg -l "variablesWithFilter" --type ts

Length of output: 79


Script:

#!/bin/bash
# Let's examine the usage context of variablesWithFilter in the file
rg "variablesWithFilter" -B 5 -A 5 --type ts src/components/Grid/useDataGridSource.tsx

Length of output: 850


Script:

#!/bin/bash
# Let's examine the structure of variables and input to understand the merge operation
ast-grep --pattern 'const variables = useMemo' -A 10

Length of output: 54


Script:

#!/bin/bash
# Let's try a different approach to examine the variables structure
rg "const variables =" -B 5 -A 10 --type ts src/components/Grid/useDataGridSource.tsx

Length of output: 87

src/components/Grid/useDataGridSource.tsx Outdated Show resolved Hide resolved
src/components/Grid/useDataGridSource.tsx Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@CarsonF CarsonF changed the title Deep merge Variables and Input for DataGrid Filters Deep merge User & System Filters for DataGrid Oct 31, 2024
@CarsonF CarsonF merged commit 8876771 into develop Oct 31, 2024
3 of 4 checks passed
@CarsonF CarsonF deleted the fix-datagrid-filter branch October 31, 2024 14:35
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