In NML upload with overwritingDatasetId, do not require valid orga field in the NML

[fm3]

The orga id should be taken from the already looked-up dataset.

URL of deployed dev instance (used for testing):

• https://skiporgalookupifoverwritten.webknossos.xyz

Steps to test:

• Download an NML, delete its organization attribute in the experiment
• Upload the NML via drag’n’drop into another dataset that was opened in view mode
• Should work

Issues:

• fixes When overwritingDatasetId is set in annotation upload, the NML shouldn’t need an existing orga tag #8254

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the NmlParser class within NmlParser.scala. Specifically, the assignment of organizationId in the nmlParametersToResult method has been updated to source the organizationId from the dataset object instead of directly from nmlParams. This adjustment affects how organizationId is set for UploadedVolumeLayer and SkeletonTracing objects. The overall structure of the class remains unchanged, with no new methods introduced or existing methods removed.

Changes

File	Change Summary
app/models/annotation/nml/NmlParser.scala	Updated organizationId assignment in nmlParametersToResult to use dataset._organization instead of nmlParams.organizationId for UploadedVolumeLayer and SkeletonTracing.

Assessment against linked issues

Objective	Addressed	Explanation
When overwritingDatasetId is set in annotation upload, the NML shouldn’t need an existing orga tag (#8254)	✅

Possibly related PRs

• Fix accessing public datasets #8242: This PR modifies the DatasetController to change how the organization is retrieved for a dataset, which is relevant to the handling of organizationId in the main PR.
• Fix permisson error in listGrouped in list datasets route #8249: Similar to Fix accessing public datasets #8242, this PR also updates the DatasetController to use GlobalAccessContext for organization access, which relates to the changes made in the main PR regarding the assignment of organizationId.

Suggested reviewers

• normanrz

Poem

In the fields where data plays,
A rabbit hops through code-filled ways.
With organizationId now in sight,
The parsing dance feels just right!
Hooray for changes, swift and bright! 🐇✨

---

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

🧹 Outside diff range and nitpick comments (2)

app/models/annotation/nml/NmlParser.scala (2)

86-86: Consider using a public accessor method for organization.

The direct access of _organization suggests it might be a private field. Consider using a public accessor method (e.g., dataset.getOrganization()) to maintain better encapsulation.

-            organizationId = Some(dataset._organization),
+            organizationId = Some(dataset.getOrganization),

-            Some(dataset._organization),
+            Some(dataset.getOrganization),

Also applies to: 116-116

---

Line range hint 411-412: Document the optional nature of organization parsing.

Since the organization field is no longer required when overwritingDatasetId is set, consider updating the method documentation to clarify this behavior.

+  /** Parses the organization ID from the NML. Note: The result may be ignored when overwritingDatasetId is set,
+   * as the organization will be derived from the existing dataset instead.
+   */
   private def parseOrganizationId(nodes: NodeSeq): String =
     nodes.headOption.map(node => getSingleAttribute(node, "organization")).getOrElse("")

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c3729ea and f61cb17.

📒 Files selected for processing (1)

• app/models/annotation/nml/NmlParser.scala (2 hunks)

🔇 Additional comments (1)

app/models/annotation/nml/NmlParser.scala (1)

86-86: LGTM! Changes align with PR objective.

The modification to source organizationId from the dataset object instead of requiring it from the NML parameters aligns perfectly with the PR objective. This change ensures that when overwritingDatasetId is set, the organization field in the NML is not required as it will be derived from the dataset that has already been looked up.

Also applies to: 116-116

[MichaelBuessemeyer]

Thanks for this PR 🙏

Works great.

But while checking the code I noticed that NmlParsedParameters organizationId is still String and not an option, although it is now optional. Maybe this should be changed 🤔. It currently works because parseOrganizationId in NmlParser.scala returns a "" as default. But keep / do it the way you prefer :)