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

Fixes treeSelection filtering of samples in group #5227

Merged
merged 1 commit into from
Dec 5, 2024

Conversation

manivoxel51
Copy link
Contributor

@manivoxel51 manivoxel51 commented Dec 5, 2024

What changes are proposed in this pull request?

  • Adds a filter to TreeSelection to filter the group ids
  • tested locally with @lanzhenw

How is this patch tested? If it is not, please explain why.

(Details)

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • New Features
    • Improved handling of checkbox states in the Tree Selection component, enhancing the "select all" functionality.
  • Bug Fixes
    • Resolved issues with indeterminate checkbox states affecting selected sample IDs.

@manivoxel51 manivoxel51 requested a review from lanzhenw December 5, 2024 18:56
Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

Walkthrough

The changes in this pull request focus on the TreeSelectionView component within the TreeSelectionView.tsx file. A key modification is the introduction of a condition in the handleCheckboxChange function to exclude the "indeterminate" state when calculating selected sample IDs. Additionally, the useEffect hook has been updated to accurately reflect the checked state of samples based on the dataSet, and the logic for the selectAll checkbox has been refined to maintain the overall selection state.

Changes

File Path Change Summary
app/packages/core/src/plugins/SchemaIO/components/TreeSelectionView.tsx Updated handleCheckboxChange to exclude "indeterminate" state; refined useEffect for sample states; improved selectAll checkbox logic.

Possibly related PRs

Suggested labels

bug, app, plugins

Suggested reviewers

  • Br2850

🐰 In the garden where bunnies play,
A checkbox now knows the right way.
With indeterminate states kept at bay,
Selections are clear, come what may!
Hopping along, we check and we cheer,
For a tidy view, the change is here! 🌼


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.

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

🧹 Outside diff range and nitpick comments (1)
app/packages/core/src/plugins/SchemaIO/components/TreeSelectionView.tsx (1)

Line range hint 1-400: Consider performance optimizations for large datasets

The tree selection component handles complex state management with nested structures. With the addition of indeterminate state filtering, consider these optimizations:

  1. Memoize the filtered selectedSampleIds calculation using useMemo to prevent unnecessary recalculations
  2. Consider using a Set for faster lookups when checking indeterminate states
  3. Add performance testing for large datasets to ensure the filtering doesn't impact responsiveness

Would you like help implementing these optimizations?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 525bfde and 0a86356.

📒 Files selected for processing (1)
  • app/packages/core/src/plugins/SchemaIO/components/TreeSelectionView.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/packages/core/src/plugins/SchemaIO/components/TreeSelectionView.tsx (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

🔇 Additional comments (1)
app/packages/core/src/plugins/SchemaIO/components/TreeSelectionView.tsx (1)

180-181: Verify the filtering logic for indeterminate states

The addition of the indeterminate state check aligns with the PR objective to fix group filtering. However, let's verify the behavior in edge cases:

  1. The condition !Object.keys(updatedState[key])?.includes("indeterminate") uses optional chaining, but updatedState[key] is guaranteed to exist here, making it unnecessary.
  2. The check for indeterminate state could be simplified to directly access the property.

Consider simplifying the condition:

-          !Object.keys(updatedState[key])?.includes("indeterminate");
+          !updatedState[key].indeterminate;

Let's verify the impact of this change on group selection behavior:

✅ Verification successful

The optional chaining in the indeterminate check is unnecessary and can be simplified

Based on the codebase analysis, I can confirm that:

  1. The updatedState[key] object always exists and contains a structured state with checked and optional indeterminate properties.
  2. The indeterminate state is consistently managed throughout the component, being explicitly set to false or used in parent node calculations.
  3. The suggested simplification is safe as the state object is guaranteed to exist at this point.

Recommended change:

-          !Object.keys(updatedState[key])?.includes("indeterminate");
+          !updatedState[key].indeterminate;

This change will:

  • Make the code more concise and easier to read
  • Maintain the same functionality as the original code
  • Be more performant by avoiding unnecessary object key enumeration
  • Match the pattern used elsewhere in the codebase for checking indeterminate state
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other instances where indeterminate state is handled
rg -n "indeterminate.*state|state.*indeterminate" --type ts

# Look for related test files
fd "TreeSelectionView.test" --type file

Length of output: 551


Script:

#!/bin/bash
# Let's examine the state object structure and its usage
ast-grep --pattern 'state: {
  $$$
}'

# Look for checkbox state type definitions
ast-grep --pattern 'interface $_ {
  $$$
  indeterminate?: $_
  $$$
}'

# Search for state updates related to indeterminate
rg -n -A 2 -B 2 "state\[.*\].*=.*{.*indeterminate" --type ts

Length of output: 307


Script:

#!/bin/bash
# Let's examine the state handling in TreeSelectionView
rg -n "state\[.+\]\s*=" --type ts

# Look for the type definition of the state object
ast-grep --pattern 'type $_ = {
  $$$
  indeterminate: $_
  $$$
}'

# Check how updatedState is used in the component
rg -n -A 2 -B 2 "updatedState\[.+\]" --type ts

Length of output: 10606

@lanzhenw lanzhenw merged commit c2e2d0f into release/v1.1.0 Dec 5, 2024
10 checks passed
@lanzhenw lanzhenw deleted the bug/exact-dup-bug branch December 5, 2024 19:01
@lanzhenw lanzhenw added bug Bug fixes app Issues related to App features plugins and removed app Issues related to App features labels Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants