Allow local absolute mag paths to point to same-orga datasets

[fm3]

Vx now writes out absolute paths instead of symlinking other dataset layers. This is currently rejected by wk. This PR relaxes this check.

Issues:

• fixes https://scm.slack.com/archives/C5AKLAV0B/p1750927178238689?thread_ts=1750859466.889959&cid=C5AKLAV0B

---

• Needs datastore update after deployment

[coderabbitai]

📝 Walkthrough

Walkthrough

The change updates the path validation logic in the uriFromPathLiteral method to check if an absolute local path starts with the parent directory of localDatasetDir, instead of localDatasetDir itself. The rest of the whitelist and exception handling logic remains unchanged.

Changes

Files	Change Summary
webknossos-datastore/app/com/scalableminds/webknossos/datastore/storage/RemoteSourceDescriptorService.scala	Modified path whitelist logic to compare against the parent of localDatasetDir instead of itself.

Possibly related PRs

• Stricter checks for explicit local mag paths #8547: Both PRs modify path containment checks related to local dataset directories to enforce stricter validation of allowed local paths, indicating a related focus on path security within the datastore.

Suggested labels

bug

Suggested reviewers

• normanrz

Poem

A rabbit hopped down a path so neat,
Checking folders beneath its feet.
With a whisk and a hop, it checked the parent,
Ensuring the whitelist was ever apparent.
No stray burrows, no hidden lair—
Just secure paths, handled with care! 🐇

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/storage/RemoteSourceDescriptorService.scala (1)

58-63: Consider adding a comment to document the security boundary change.

The path validation logic has been relaxed from dataset-level to organization-level access. Adding a brief comment would help future maintainers understand the rationale behind this security boundary.

       if (localPath.isAbsolute) {
+        // Allow absolute paths within the same organization directory or whitelisted paths
         if (localPath.toString.startsWith(localDatasetDir.getParent.toAbsolutePath.toString) || dataStoreConfig.Datastore.localDirectoryWhitelist
               .exists(whitelistEntry => localPath.toString.startsWith(whitelistEntry)))
           uri
         else
           throw new Exception(
             s"Absolute path $localPath in local file system is not in path whitelist. Consider adding it to datastore.localDirectoryWhitelist")

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9395ef6 and 1288858.

📒 Files selected for processing (1)

• webknossos-datastore/app/com/scalableminds/webknossos/datastore/storage/RemoteSourceDescriptorService.scala (1 hunks)

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

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

🔇 Additional comments (1)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/storage/RemoteSourceDescriptorService.scala (1)

58-58: LGTM! The change correctly implements organization-level path validation.

The modification from localDatasetDir to localDatasetDir.getParent effectively allows absolute paths to reference datasets within the same organization, which aligns with the PR objectives. Since localDatasetDir is constructed as baseDir/organizationId/datasetName, using getParent correctly targets the organization directory.

However, please verify that getParent() won't return null in edge cases:

#!/bin/bash
# Description: Search for other usages of getParent() in the codebase to see if null checks are used elsewhere
# Expected: Find patterns of getParent() usage and null safety handling

rg "\.getParent\(\)" -A 3 -B 1