Support reading Blosc-compressed data chunks with autoshuffle

[fm3]

Turns out the error didn’t come from JBlosc, but our own implementation. @frcroth do you remember if there was a specific reason to originally reject AUTOSHUFFLE?

URL of deployed dev instance (used for testing):

• https://autoshuffle.webknossos.xyz

Steps to test:

• Import dataset from https://scm.slack.com/archives/C02H5T8Q08P/p1738766454436339 – should show data

Issues:

• fixes Support decompressing Chunks with Blosc AUTOSHUFFLE (-1) #8381

---

• Updated changelog
• Removed dev-only changes like prints and application.conf edits
• Considered common edge cases
• Needs datastore update after deployment

[coderabbitai]

📝 Walkthrough

Walkthrough

The changelog has been updated to record new features, improvements, bug fixes, and the removal of an existing volume annotation downsampling feature. Notably, support for Blosc AUTOSHUFFLE in compressed dataset reading has been added. Additionally, the BloscCompressor class has been modified to include AUTOSHUFFLE in its supported shuffle types, with corresponding updates to error messaging. The PR also addresses several bugs including issues during tree merges, onboarding display glitches, and segment registration at coarser magnifications, and enhances UI behavior for slider scrolling.

Changes

File	Change Summary
CHANGELOG.unreleased.md	Documented new Blosc AUTOSHUFFLE support, UI improvements (focused slider scrolling), bug fixes (tree merge, onboarding, segment registration), and removed volume downsampling.
webknossos-datastore/.../Compressor.scala	Expanded supported shuffle types by adding AUTOSHUFFLE and updated error messaging in the validateShuffle method to reflect the change.

Assessment against linked issues

Objective	Addressed	Explanation
Support decompressing Chunks with Blosc AUTOSHUFFLE (-1) [#8381]	✅

Possibly related PRs

• Release 24.12.0 #8264: Directly relates to the addition of the AUTOSHUFFLE parameter in the BloscCompressor class.
• Fix: Use forwardRef for scrollable virtualized tree #8186: Updates to BloscCompressor for AUTOSHUFFLE support align closely with this change.
• Release 24.11.1 #8188: Involves modifications to shuffle options in BloscCompressor, directly connected to the current changes.

Suggested labels

bug, frontend, documentation

Poem

I'm a hopping rabbit, joyful and spry,
My code now shuffles like carrots in the sky.
AUTOSHUFFLE's the magic in each new byte,
Bugs tiptoe away in the soft moonlight.
With each hop, my code sings a tune so bright,
Celebrating changes with a wiggle and delight!
🥕🐇

---

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.

[frcroth]

Turns out the error didn’t come from JBlosc, but our own implementation. @frcroth do you remember if there was a specific reason to originally reject AUTOSHUFFLE?

I have no idea, it was introduced here: #6466

[frcroth]

LGTM

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/datareaders/Compressor.scala (1)

244-244: Consider improving error message readability.

While the error message update correctly includes AUTOSHUFFLE, the formatting could be improved for better readability.

Consider this alternative format:

-      List("-1 (AUTOSHUFFLE), 0 (NOSHUFFLE)", "1 (BYTESHUFFLE)", "2 (BITSHUFFLE)")
+      List(
+        "-1 (AUTOSHUFFLE)",
+        "0 (NOSHUFFLE)",
+        "1 (BYTESHUFFLE)",
+        "2 (BITSHUFFLE)"
+      )

This would make the error message more readable and maintainable.

Also applies to: 248-248

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5d04993 and 43b3302.

📒 Files selected for processing (2)

• CHANGELOG.unreleased.md (1 hunks)
• webknossos-datastore/app/com/scalableminds/webknossos/datastore/datareaders/Compressor.scala (2 hunks)

🔇 Additional comments (2)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/datareaders/Compressor.scala (1)

201-201: LGTM! Added AUTOSHUFFLE support.

The addition of AUTOSHUFFLE to the supported shuffle types aligns with the PR objectives and enables reading Blosc-compressed data chunks with autoshuffle.

CHANGELOG.unreleased.md (1)

19-19: LGTM! Clear and well-formatted changelog entry.

The changelog entry correctly documents the new feature and follows the project's changelog format.