[Blocked] Add mag path to zarr streaming datasource-properties.json

[fm3]

In outbound zarr streaming routes, each mag now reports its path in the datasource-properties.json. The supplied path is relative to the dataset root and uses the scalar mag literal form if possible.

Issues:

• fixes https://scm.slack.com/archives/C5AKLAV0B/p1744227427313139

---

• Considered common edge cases
• Needs datastore update after deployment

[coderabbitai]

📝 Walkthrough

Walkthrough

The change updates the ZarrStreamingController.scala file by modifying the construction of MagLocator instances within the convertLayerToZarrLayer method. Specifically, both SegmentationLayer and DataLayer now receive a new string parameter that combines the layer name and the result of x.toMagLiteral(allowScalar = true). The other parameters remain unchanged, and there are no alterations to any exported or public entities.

Changes

File	Summary
webknossos-datastore/app/.../ZarrStreamingController.scala	Updated the instantiation of MagLocator in the convertLayerToZarrLayer method for both SegmentationLayer and DataLayer, adding a concatenated identifier using the layer name and x.toMagLiteral(allowScalar = true). The fifth parameter remains unchanged as None.

Suggested reviewers

• frcroth

Poem

I'm a rabbit in the code field, quick on my feet,
Hopping over changes, making every line neat.
A twist of a string, a blend in the byte,
Carrots and code, oh what a delight!
With a joyful skip, improvements are bright.
Happy hops in diff-land, under the starry night!
🐇✨

---

📜 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 18da17f and 7fee77b.

📒 Files selected for processing (1)

• webknossos-datastore/app/com/scalableminds/webknossos/datastore/controllers/ZarrStreamingController.scala (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/controllers/ZarrStreamingController.scala (2)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/dataformats/MagLocator.scala (2)

• MagLocator (9-14)
• MagLocator (16-18)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/datareaders/AxisOrder.scala (3)

• AxisOrder (8-24)
• AxisOrder (26-47)
• cAdditionalxyz (45-45)

🔇 Additional comments (2)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/controllers/ZarrStreamingController.scala (2)

171-178: Well-implemented path addition to MagLocator

The addition of path information to the MagLocator instances for SegmentationLayer enhances the outbound zarr streaming routes by including relative paths in the datasource-properties.json file. Using allowScalar = true in the toMagLiteral method ensures concise representation when possible, which is a nice optimization.

---

195-202: Consistent implementation for DataLayer

The same path construction logic is properly implemented for DataLayer, ensuring consistency across different layer types. The path format (layerName/magLiteral) provides a clear and intuitive relative path structure.

---

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

• 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[normanrz]

Does this work for both datasets and annotations?

[fm3]

Yes, this function is used by both variants. I installed https://streamingmagpath.webknossos.xyz so you can test it

[normanrz]

Ok. This currently breaks the current version of wklibs. I'm afraid we need to delay this change.