Fix merging editable mappings where self-merge is generated; fix compacted update action writes

[fm3]

• Fixed a bug where merging edigable mapping (“proofreading”) annotations would sometimes fail due to incorrect handling of agglomerates being merged with themselves.
• Fixed the json writes for compacted update actions. This broke the version history for duplicated annotations. Regression from Unified annotation versioning #7917

---

• Updated changelog
• Removed dev-only changes like prints and application.conf edits
• Considered common edge cases

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces several enhancements to the WEBKNOSSOS project's annotation and dataset management features. Key changes include adding a dataset rotation configuration, modifying the "Restore older Version" feature to consolidate annotation history, and enabling "merger mode" with existing annotations. The updates also improve error handling and logging for merging editable mapping annotations, and add a new isCompacted field to volume update actions. A bug fix addresses issues with merging annotations and removing the downsampling feature for volume annotations.

Changes

File	Change Summary
CHANGELOG.unreleased.md	Added new features for dataset rotation, annotation version restoration, and merger mode
webknossos-tracingstore/.../EditableMappingUpdater.scala	Enhanced error handling and logging for merge actions, refined graph merging logic
webknossos-tracingstore/.../VolumeUpdateActions.scala	Added isCompacted field to CompactVolumeUpdateAction JSON representation

Possibly related PRs

• Allow merger mode when null-mapping is locked #8335: Introduction of merger mode functionality
• Release 24.11.1 #8188: Addition of metadata to annotations for Trees and Segments
• Log data loading errors in conversion / mapping application #8202: Enhanced error logging during dataset loading

Suggested labels

refactoring

Suggested reviewers

• daniel-wer

Poem

🐰 Hop, hop, through code so bright,
Merging graphs with rabbit might!
Annotations dance and twirl,
Rotation features now unfurl
A changelog of pure delight! 🔬

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2171b8f and ad11ca3.

📒 Files selected for processing (3)

• CHANGELOG.unreleased.md (1 hunks)
• webknossos-tracingstore/app/com/scalableminds/webknossos/tracingstore/tracings/editablemapping/EditableMappingUpdater.scala (2 hunks)
• webknossos-tracingstore/app/com/scalableminds/webknossos/tracingstore/tracings/volume/VolumeUpdateActions.scala (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: circleci_build

🔇 Additional comments (5)

webknossos-tracingstore/app/com/scalableminds/webknossos/tracingstore/tracings/volume/VolumeUpdateActions.scala (1)

376-377: LGTM! The addition of isCompacted field enhances JSON output.

The change correctly adds the isCompacted field to identify compacted actions in the JSON output, which aligns with the PR objective to fix compacted update action writes.

webknossos-tracingstore/app/com/scalableminds/webknossos/tracingstore/tracings/editablemapping/EditableMappingUpdater.scala (3)

337-337: Enhanced error message improves debugging.

The addition of actionTimestamp and graph segments to the error message provides valuable context for debugging merge failures.

---

343-345: Optimization: Skip update for self-merge case.

Good optimization to skip updating the second agglomerate when it's the same as the first one. The comment clearly explains the logic.

---

354-377: Well-structured handling of self-merge case.

The refactored mergeGraph method now properly handles the self-merge case:

1. Checks if graphs are identical
2. Reuses existing edge if present
3. Adds new edge with affinity if needed
4. Maintains validation for segment presence

This aligns with the PR objective to fix merging where self-merge is generated.

CHANGELOG.unreleased.md (1)

22-22: LGTM! Clear and accurate changelog entry.

The changelog entry accurately describes the bug fix for merging editable mapping annotations.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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]

Thanks a lot for debugging & fixing all this 🙏