scalableminds / webknossos

Visualize, share and annotate your large 3D images online
https://webknossos.org
GNU Affero General Public License v3.0
129 stars 24 forks source link

Fix: Use forwardRef for scrollable virtualized tree #8186

Closed MichaelBuessemeyer closed 1 week ago

MichaelBuessemeyer commented 1 week ago

The newly deployed scrollable fix added a wrapper for the antd tree implementation. The wrapper is functional component which needs to be wrapped in a forwardRef as it received a ref which should be forwarded to the antd tree component. The forwardRef was missing and is now added in this pr.

URL of deployed dev instance (used for testing):

Steps to test:

Issues:


(Please delete unneeded items, merge only when none are left open)

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes in this pull request focus on the ScrollableVirtualizedTree component, enhancing its structure by implementing forwardRef to better manage refs. The internal function was renamed to ScrollableVirtualizedTreeInner, and its parameters were adjusted accordingly. Additionally, the SegmentsView class was modified to simplify the usage of ScrollableVirtualizedTree by removing a generic type parameter. Improvements were made to state management, user interactions, and error handling within the SegmentsView, ensuring a more intuitive experience without altering core functionalities.

Changes

File Path Change Summary
frontend/javascripts/oxalis/view/right-border-tabs/scrollable_virtualized_tree.tsx - Updated ScrollableVirtualizedTree to use forwardRef and renamed inner function to ScrollableVirtualizedTreeInner.
- Adjusted function signature to separate props and ref.
- Updated export statement to reflect new structure.
frontend/javascripts/oxalis/view/right-border-tabs/segments_tab/segments_view.tsx - Removed generic type parameter <SegmentHierarchyNode> from ScrollableVirtualizedTree instantiation.
- Enhanced methods for segment selection, visibility management, and error handling.
- Updated lifecycle methods for better mesh file fetching and job data polling.
CHANGELOG.unreleased.md - Documented new features including metadata for annotations, time tracking summary, improved search, and support for OME-Zarr NGFF datasets.
- Listed changes to existing functionalities and fixed various bugs affecting user experience.

Possibly related PRs

Suggested reviewers

πŸ‡ In the code we hop and play,
Refactoring makes a brighter day.
With trees that scroll and segments neat,
Our UI dances, oh so sweet!
Forward refs, we now embrace,
In our code, we find our place! 🌟


πŸ“œ Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between fec41221a04dea4252e9f5dcfe4420aaacfaac5c and 435cd3246b2ace2ae9d250d723d3951698f9b88a.
πŸ“’ Files selected for processing (1) * `CHANGELOG.unreleased.md` (1 hunks)
πŸ”‡ Additional comments (1)
CHANGELOG.unreleased.md (1) `38-38`: **LGTM! Clear and well-documented changelog entry.** The changelog entry accurately describes the fix, provides proper context by referencing the related PR that introduced the issue, and aligns well with the PR objectives.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
πŸͺ§ Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.