Skip to content

Conversation

MichaelBuessemeyer
Copy link
Contributor

@MichaelBuessemeyer MichaelBuessemeyer commented Jan 28, 2025

The merging trees code accidentally dropped all trees of the other type (which are not merged). The newest version of the code makes sure to not drop the trees of the other (not active) type. Moreover, I improved the test such that both types (default & agglomerate) are not tested in the reducer tests. I added an additional that tests that trees of different types are not merged together.

URL of deployed dev instance (used for testing):

  • https://___.webknossos.xyz

Steps to test:

  • Create an annotation on a dataset with an agglomerate mapping
  • create some trees
  • activate the agglomerate mapping
  • load some agglomerate skeletons
  • merge some agglomerate skeletons (e.g. via context menu)
  • the initially created trees should not disappear

TODOs:

  • Test whether the changes to the tests would have caught this problem.
    • Yes they would, I tested

Issues:


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

Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

Warning

Rate limit exceeded

@MichaelBuessemeyer has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8756720 and a3dc7da.

📒 Files selected for processing (1)
  • CHANGELOG.unreleased.md (1 hunks)
📝 Walkthrough

Walkthrough

The pull request introduces modifications to the skeleton tracing reducer and its helper functions, focusing on tree merging logic. The changes primarily involve adding a new treeType parameter to the mergeTrees function, which enhances type consistency checks during tree merging operations. The modifications affect how trees are merged, with additional validation to ensure only trees of the same type can be combined. Test files have been updated to reflect these changes, including the addition of a new test tree and adjustments to existing test cases.

Changes

File Change Summary
frontend/javascripts/oxalis/model/reducers/skeletontracing_reducer.ts Modified MERGE_TREES case to directly assign oldTrees and update mergeTrees function call with treeType parameter.
frontend/javascripts/oxalis/model/reducers/skeletontracing_reducer_helpers.ts Added treeType parameter to mergeTrees function, implemented type consistency checks for tree merging.
frontend/javascripts/test/reducers/skeletontracing_reducer.spec.ts Added new test tree (ID 2), created initialStateWithActiveTreeId2, updated test cases to reflect new tree structure and active tree ID changes.

Possibly related PRs

Suggested labels

testing

Suggested reviewers

  • normanrz

Poem

🐰 Merging trees with rabbit care,
Type-checking with a vigilant stare,
Code hops, logic leaps so bright,
Skeleton tracing takes its flight!
A rabbit's code, precise and fair 🌳


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.

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.

@MichaelBuessemeyer
Copy link
Contributor Author

already requesting review

but I don't have anymore time to add the changelog entry and check whether the tests actually improved / would have shown this bug.

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)
frontend/javascripts/test/reducers/skeletontracing_reducer.spec.ts (1)

1062-1159: Well-structured test case for tree type validation.

The test case thoroughly verifies that trees of different types cannot be merged, which is crucial for maintaining data integrity.

However, consider adding a few more test scenarios:

  1. Attempting to merge two agglomerate trees
  2. Attempting to merge two default trees
 test("SkeletonTracing shouldn't merge two trees of different type", (t) => {
   // ... existing test code ...
 });
+
+test("SkeletonTracing should merge two agglomerate trees", (t) => {
+  // Add test for merging two agglomerate trees
+});
+
+test("SkeletonTracing should merge two default trees", (t) => {
+  // Add test for merging two default trees
+});
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9c3283 and 8756720.

📒 Files selected for processing (1)
  • frontend/javascripts/test/reducers/skeletontracing_reducer.spec.ts (18 hunks)
🔇 Additional comments (4)
frontend/javascripts/test/reducers/skeletontracing_reducer.spec.ts (4)

12-12: LGTM! Type imports are correctly updated.

The addition of MutableNode and Tree types to the imports aligns with the new test requirements.


83-97: LGTM! Well-structured agglomerate tree initialization.

The new agglomerate tree is properly initialized with all required properties and follows the same structure as the default tree. The TreeTypeEnum.AGGLOMERATE type is correctly set.


114-120: LGTM! Clean state initialization for active tree ID 2.

The new initial state variant is properly created using immutable update pattern.


208-214: Test assertions are correctly updated for new tree IDs.

The test assertions have been properly updated to account for the new tree ID structure, maintaining consistency with the addition of the agglomerate tree.

Also applies to: 845-847, 854-856, 876-878, 982-984, 1043-1044, 1153-1155

Copy link
Member

@philippotto philippotto left a comment

Choose a reason for hiding this comment

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

thanks for fixing this!

const oldTrees = getTreesWithType(skeletonTracing, treeType);
const mergeResult = mergeTrees(oldTrees, sourceNodeId, targetNodeId);
const oldTrees = skeletonTracing.trees;
const mergeResult = mergeTrees(oldTrees, sourceNodeId, targetNodeId, treeType);
Copy link
Member

Choose a reason for hiding this comment

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

nice 👍

@MichaelBuessemeyer MichaelBuessemeyer merged commit 3400b36 into master Jan 29, 2025
3 checks passed
@MichaelBuessemeyer MichaelBuessemeyer deleted the fix-merging-trees branch January 29, 2025 09:38
@coderabbitai coderabbitai bot mentioned this pull request Feb 5, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants