Skip to content

Conversation

fm3
Copy link
Member

@fm3 fm3 commented Aug 6, 2025

Fixed a bug where layer attachments with relative paths would not be read correctly. Regression from #8829

Steps to test:

  • I tested that I can now load both hdf5 and zarr attachments with the following path styles:
segmentation/agglomerates/agglomerate_view_5
./segmentation/agglomerates/agglomerate_view_50
/absolute/path/to/webknossos/binaryData/sample_organization/test-agglomerate-file-zarr/segmentation/agglomerates/agglomerate_view_90
file:///absolute/path/to/webknossos/binaryData/sample_organization/test-agglomerate-file-zarr/segmentation/agglomerates/agglomerate_view_80

  • Added changelog entry (create a $PR_NUMBER.md file in unreleased_changes or use ./tools/create-changelog-entry.py)
  • Needs datastore update after deployment

Copy link
Contributor

coderabbitai bot commented Aug 6, 2025

📝 Walkthrough

Walkthrough

This change introduces a new method to resolve relative file paths for layer attachments, ensuring they are correctly interpreted based on a configurable base directory. Multiple services are updated to use this resolution logic by injecting the configuration and applying the new method when constructing file keys. No other logic is modified.

Changes

Cohort / File(s) Change Summary
LayerAttachment Path Resolution
.../models/datasource/DatasetLayerAttachments.scala
Adds resolvedPath method to LayerAttachment for resolving relative paths against a base directory and data source ID, returning an absolute URI.
Service Constructor Updates & Path Resolution
.../services/connectome/ConnectomeFileService.scala,
.../services/mapping/AgglomerateService.scala,
.../services/mesh/MeshFileService.scala,
.../services/segmentindex/SegmentIndexFileService.scala
Updates constructors to require DataStoreConfig and uses the new resolvedPath method to ensure attachments use resolved file paths when constructing file keys. Some minor refactoring (e.g., return type, variable names) in select services.
Documentation
unreleased_changes/8834.md
Documents the bugfix for handling layer attachments with relative file paths.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Suggested reviewers

  • frcroth

Poem

🐇✨
A hop and a skip through the code we go,
Paths once confused now perfectly so!
Attachments resolved, no longer astray,
With config in paw, we find the right way.
No more lost files—just carrot-filled cheer,
The rabbit ensures your data is near!
🗂️🥕

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 e4afd9b and cf027f1.

📒 Files selected for processing (3)
  • webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/connectome/ConnectomeFileService.scala (3 hunks)
  • webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/mesh/MeshFileService.scala (3 hunks)
  • webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/segmentindex/SegmentIndexFileService.scala (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/segmentindex/SegmentIndexFileService.scala
  • webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/connectome/ConnectomeFileService.scala
  • webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/mesh/MeshFileService.scala
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: build-smoketest-push
  • GitHub Check: backend-tests
  • GitHub Check: frontend-tests
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch resolve-relative-attachment-paths

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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 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.

@fm3 fm3 self-assigned this Aug 6, 2025
@fm3 fm3 requested a review from MichaelBuessemeyer August 6, 2025 11:32
@fm3 fm3 marked this pull request as ready for review August 6, 2025 11:32
Copy link
Contributor

@MichaelBuessemeyer MichaelBuessemeyer left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for fixing this 🎉

@fm3 fm3 enabled auto-merge (squash) August 6, 2025 11:49
@fm3 fm3 merged commit 6ebcbf2 into master Aug 6, 2025
5 checks passed
@fm3 fm3 deleted the resolve-relative-attachment-paths branch August 6, 2025 11:59
This was referenced Sep 25, 2025
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