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). Additionally, a changelog entry was added to document the inclusion of a relative "path" attribute for every magnification level in datasource-properties.json. No other parameters or exported entities were changed.

Changes

File	Summary
webknossos-datastore/app/.../ZarrStreamingController.scala	Updated MagLocator instantiation in convertLayerToZarrLayer for SegmentationLayer and DataLayer, adding a concatenated identifier using the layer name and x.toMagLiteral(allowScalar = true); fifth parameter remains None.
CHANGELOG.unreleased.md	Added changelog entry documenting that datasource-properties.json now includes a relative "path" attribute for every magnification level in zarr streaming routes and volume annotation downloads.

Suggested reviewers

• normanrz

Poem

🐇 In code’s green meadow, I leap and bound,
A string here, a path there, new magic found.
Layers and mags in a tidy embrace,
Paths now aligned, no more lost trace.
Hopping through changes with nimble delight,
I code and I cheer in the soft twilight!
🌿✨

---

📜 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 7fee77b and 71d1508.

📒 Files selected for processing (1)

• CHANGELOG.unreleased.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• CHANGELOG.unreleased.md

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

• GitHub Check: build-smoketest-push
• GitHub Check: backend-tests

---

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.
  • 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.
  • @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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

[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.