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

Bugfix: TreeSelectionView component handles grid selection sync #5077

Merged
merged 2 commits into from
Nov 8, 2024

Conversation

lanzhenw
Copy link
Contributor

@lanzhenw lanzhenw commented Nov 8, 2024

What changes are proposed in this pull request?

Bugfix:

  1. When user select samples from the grid (lookers), the checkbox tree now updates the state and reflect the changes
  2. Pass in componentProps, so we can edit css properties in python
  3. Add expand all and collapse all button

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

Created a dataset with 200 groups of duplicate samples. Selection in the grid is captured in the grid. expansion works.

Screen.Recording.2024-11-07.at.9.39.36.PM.mov

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

    • Introduced a bulk expand/collapse functionality for the tree structure.
    • Updated the "Select All" checkbox to include an expand/collapse button.
  • Improvements

    • Enhanced synchronization of checkbox states with the underlying data.
    • Expanded titles in the TreeNode component for clearer context.

These changes significantly improve user interaction with the tree structure, making it easier to manage selections.

@lanzhenw lanzhenw self-assigned this Nov 8, 2024
Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

Walkthrough

The TreeSelectionView component in the TreeSelectionView.tsx file has been updated to improve its functionality and user experience. Key changes include the introduction of a new state variable for managing the collapse/expand state of the tree, a new method for toggling all nodes, and updates to the rendering of the component to enhance styling. Additionally, the component's effect hook has been modified to ensure checkbox states accurately reflect the current selection based on the provided data.

Changes

File Path Change Summary
app/packages/core/src/plugins/SchemaIO/components/TreeSelectionView.tsx - Added state variable allCollapsed for managing overall collapse/expand state.
- Introduced handleExpandCollapseAll method for toggling all nodes.
- Updated rendering to use <Box> component and added expand/collapse button next to "Select All" checkbox.
- Modified useEffect to synchronize checkbox states with data changes.
- Expanded TreeNode title to include nodeId.

Possibly related PRs

Suggested labels

bug, app, plugins

Suggested reviewers

  • imanjra
  • Br2850

🐇 In the tree where branches sway,
A checkbox dances, bright and gay.
With a click, all nodes can hide,
Or show their faces, side by side.
A new state leads the way,
In our garden, joy will stay! 🌳


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

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

223-295: Ensure efficient synchronization between grid selection and checkbox tree

The useEffect hook appropriately updates the checkedState when data and unboundState differ, ensuring that selections made in the grid are reflected in the tree. However, consider verifying the performance of this effect with large datasets to prevent potential slowdowns. Optimizing the synchronization logic can enhance user experience.


330-333: Consider removing nodeId from the displayed title to avoid exposing internal identifiers

Including nodeId in the title may expose internal identifiers to users, which could be unnecessary or potentially confusing. It might be better to display only user-friendly information.

Apply this diff to adjust the title:

 const title = `Group ${getGroupIdx(
   nodeId,
   structure
- )}  • ${count} Samples • ${nodeId}`;
+ )}  • ${count} Samples`;
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3ae950e and 1744e8d.

📒 Files selected for processing (1)
  • app/packages/core/src/plugins/SchemaIO/components/TreeSelectionView.tsx (7 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)

383-395: Verify that the expand/collapse icon reflects the corrected allCollapsed state

After fixing the logic in handleExpandCollapseAll, ensure that the IconButton displays the appropriate icon based on the updated allCollapsed state. This will accurately represent the current state and expected action (expand or collapse all) to the user.

Comment on lines +90 to +101
const [allCollapsed, setAllCollapsed] = React.useState(false);

const handleExpandCollapseAll = () => {
setCollapsedState((prevState) => {
const newState = { ...prevState };
Object.keys(newState).forEach((key) => {
newState[key] = allCollapsed;
});
return newState;
});
setAllCollapsed(!allCollapsed); // Toggle the expand/collapse state
};
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix the toggle logic in handleExpandCollapseAll to correctly expand/collapse all nodes

The handleExpandCollapseAll function currently sets the collapsed state of all nodes to the current allCollapsed value and then toggles allCollapsed. This results in the nodes reflecting the previous state instead of the intended new state after the button is clicked. To correctly toggle the collapse state, you should first compute the new allCollapsed value and then apply it to all nodes.

Apply this diff to fix the logic:

const handleExpandCollapseAll = () => {
+  const newAllCollapsed = !allCollapsed;
+  setAllCollapsed(newAllCollapsed); // Toggle the expand/collapse state
  setCollapsedState((prevState) => {
    const newState = { ...prevState };
    Object.keys(newState).forEach((key) => {
-     newState[key] = allCollapsed;
+     newState[key] = newAllCollapsed;
    });
    return newState;
  });
- setAllCollapsed(!allCollapsed); // Toggle the expand/collapse state
};
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const [allCollapsed, setAllCollapsed] = React.useState(false);
const handleExpandCollapseAll = () => {
setCollapsedState((prevState) => {
const newState = { ...prevState };
Object.keys(newState).forEach((key) => {
newState[key] = allCollapsed;
});
return newState;
});
setAllCollapsed(!allCollapsed); // Toggle the expand/collapse state
};
const [allCollapsed, setAllCollapsed] = React.useState(false);
const handleExpandCollapseAll = () => {
const newAllCollapsed = !allCollapsed;
setAllCollapsed(newAllCollapsed); // Toggle the expand/collapse state
setCollapsedState((prevState) => {
const newState = { ...prevState };
Object.keys(newState).forEach((key) => {
newState[key] = newAllCollapsed;
});
return newState;
});
};

@lanzhenw lanzhenw merged commit 6cd011e into release/v1.1.0 Nov 8, 2024
9 of 10 checks passed
@lanzhenw lanzhenw deleted the bugfix/syncGridClick branch November 8, 2024 03:56
sashankaryal pushed a commit that referenced this pull request Nov 15, 2024
* implement the grid change on checkboxes

* implement style tweak and add expand/collapse all button
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