Skip to content

Conversation

fm3
Copy link
Member

@fm3 fm3 commented Aug 5, 2025

With #8708 the datastore uses the datasource properties as stored in postgres.

Since wk already scans for attachments not registered in the on-disk datasource-properties.json and writes those into postgres, we don’t need to re-scan when answering the attachment list routes. There we can now rely on the attachment being already registered.

Steps to test:

  • Open a local dataset with hdf5 attachments that are not registered in the local datasource-properties.json
  • They should still be usable.

Issues:


@fm3 fm3 self-assigned this Aug 5, 2025
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025

📝 Walkthrough

Walkthrough

This change removes the reliance on local filesystem scanning and the RemoteSourceDescriptorService across several file-related services and controllers. Now, file discovery and lookup for agglomerates, connectomes, meshes, and segment indices operate solely based on explicit attachments declared in the DataLayer, with constructors and method signatures updated accordingly.

Changes

Cohort / File(s) Change Summary
Controller Refactor
webknossos-datastore/app/com/scalableminds/webknossos/datastore/controllers/DataSourceController.scala
Updated imports to explicitly import ConnectomeFileService; modified listAgglomerates to use only dataLayer instead of both dataSource.id and dataLayer.
Connectome File Service Simplification
webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/connectome/ConnectomeFileService.scala
Removed dependencies on DataStoreConfig and RemoteSourceDescriptorService; simplified lookup and listing methods to rely solely on attached connectome files; eliminated local file scanning and fallback path logic; changed return types from Box to Option.
Agglomerate Service Simplification
webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/mapping/AgglomerateService.scala
Removed dependencies on DataStoreConfig, RemoteSourceDescriptorService, and file utilities; simplified agglomerate file lookup and listing to use only attachments declared in dataLayer; removed local directory scanning and fallback logic; updated method signatures accordingly.
Mesh File Service Simplification
webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/mesh/MeshFileService.scala
Removed dependencies on DataStoreConfig and RemoteSourceDescriptorService; simplified mesh file lookup and listing to rely only on attached mesh files; removed local filesystem scanning and fallback path normalization; updated method signatures and return types.
Segment Index File Service Simplification
webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/segmentindex/SegmentIndexFileService.scala
Removed dependencies on DataStoreConfig and RemoteSourceDescriptorService; simplified segment index file key lookup to directly use the first available attachment; removed fallback local file search and normalization; changed return type from asynchronous Fox to synchronous Option.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~18 minutes

Possibly related PRs

  • Read Zarr Segment Index Files #8711: Refactors DataSourceController and agglomerate service methods to remove RemoteSourceDescriptorService and rely on dataLayer.attachments, closely matching this PR's approach.
  • Allow binaryData scan for single organization #8791: Updates DataSourceController and service method signatures for agglomerate listing to accept only dataLayer, reflecting similar signature changes and removal of DataSourceId dependencies.
  • Read Zarr Mesh Files #8682: Simplifies agglomerate file listing in AgglomerateService to use only dataLayer attachments, directly overlapping with this PR's changes.

Suggested reviewers

  • frcroth

Poem

A bunny hopped through code so neat,
Snipping old paths beneath its feet.
No more searching far and wide—
Attachments now the only guide!
With clutter gone and logic clear,
The warren’s files are always 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 93a5038 and 7ffcbfb.

📒 Files selected for processing (1)
  • webknossos-datastore/app/com/scalableminds/webknossos/datastore/controllers/DataSourceController.scala (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • webknossos-datastore/app/com/scalableminds/webknossos/datastore/controllers/DataSourceController.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 attachment-list-no-scan

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 marked this pull request as ready for review August 5, 2025 14:10
@fm3 fm3 requested a review from frcroth August 5, 2025 14:10
@fm3 fm3 changed the title Don’t re-scan for attachments in their list routes Don’t re-scan attachments in their list routes Aug 5, 2025
Copy link
Contributor

@frcroth frcroth left a comment

Choose a reason for hiding this comment

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

LGTM

@fm3 fm3 merged commit 192cf21 into master Aug 6, 2025
5 checks passed
@fm3 fm3 deleted the attachment-list-no-scan branch August 6, 2025 09:15
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