Fix legacy support for outdated displayName field of datasets #8263

MichaelBuessemeyer · 2024-12-05T13:46:17Z

Fixes a compatibility bug introduced in #8075. wk.Dataset.open_remote("...").display_name = "fancy name" did not result in any changes due to two bugs:

displayName was no longer part of the ds objects returned by the API, even in legacy routes.
When updating a dataset, the name given by the update request took precedence. This discarded all updates to the ds name done via displayName as "old" clients like wklibs always send the current name of the ds and the updated displayName. Therefore, the displayName should take precedence. Clients using new API version should no longer send the `displayName prop and thus renaming with them should also still work.

URL of deployed dev instance (used for testing):

https://___.webknossos.xyz

Steps to test:

Test whether renaming a dataset via the web UI works
with wklibs run the following and check if the console shows the success of the renaming:

    with webknossos_context(token="<token>", url="http://localhost:9000"):
        ds = Dataset.open_remote("l4_sample_small")
        print("current ds name", ds.display_name)
        ds.display_name = "blue"
        print("name after renaming", ds.display_name)

run that script on another branch again. Each print should have a name None as the displayName is not included in the json format of the dataset. This should be fixed in this pr.

Issues:

fixes https://scm.slack.com/archives/C5AKLAV0B/p1733346943571389

(Please delete unneeded items, merge only when none are left open)

Updated changelog

coderabbitai · 2024-12-05T13:46:24Z

Warning

Rate limit exceeded

@MichaelBuessemeyer has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 33 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between cc72de1 and 3207ef8.

📝 Walkthrough

Walkthrough

The pull request introduces changes to the DatasetController and LegacyApiController classes. In the DatasetController, the update method's logic for determining the dataset name is modified to prioritize legacyDatasetDisplayName over datasetName. The LegacyApiController sees the addition of a new method, migrateDatasetJsonToOldFormat, which alters JSON structures for datasets and integrates with existing methods to enhance legacy data handling. Overall, the changes maintain existing functionalities while refining how dataset names and JSON formats are processed.

Changes

File	Change Summary
app/controllers/DatasetController.scala	Modified `update` method to prioritize `legacyDatasetDisplayName` over `datasetName`. `updatePartial` method referenced but unchanged.
app/controllers/LegacyApiController.scala	Added `private def migrateDatasetJsonToOldFormat(jsResult: JsObject): Fox[JsObject]`. Updated `readDatasetV8`, `updateDatasetV8`, and other methods to use `replaceInResult` and handle legacy data formats.

Possibly related PRs

Fix accessing public datasets #8242: Modifies the DatasetController class, specifically the update method, related to dataset handling like the update method.
Sync dataset name with datasource in add remote view #8245: Involves synchronization of dataset names in DatasetAddRemoteView, relevant to the naming logic changed in the update method.
Add missing isValidNewName legacy route #8252: Addition of isValidNewName route in LegacyApiController relates to dataset name validation, connecting to changes in update method.

Suggested reviewers

normanrz
fm3

Poem

🐇 In the meadow where datasets play,
A new name shines bright as day.
With JSONs transformed, they dance and twirl,
Legacy whispers in a digital swirl.
Hops of joy for changes made,
In the code, a bright parade! 🌼

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

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

MichaelBuessemeyer · 2024-12-05T13:47:01Z

app/controllers/DatasetController.scala

      withJsonBodyUsing(datasetPublicReads) {
        case (description, datasetName, legacyDatasetDisplayName, sortingKey, isPublic, tags, metadata, folderId) => {
-          val name = if (datasetName.isDefined) datasetName else legacyDatasetDisplayName
+          val name = if (legacyDatasetDisplayName.isDefined) legacyDatasetDisplayName else datasetName
          for {
            datasetIdValidated <- ObjectId.fromString(datasetId)
            dataset <- datasetDAO.findOne(datasetIdValidated) ?~> notFoundMessage(datasetIdValidated.toString) ~> NOT_FOUND


This fixes the precedence issue described in the pr description

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

CHANGELOG.unreleased.md (1)
35-35: Enhance the changelog entry to better describe the fix.

The current entry could be more descriptive about the specific issues being fixed. Consider expanding it to:
-Fix read and update dataset route for versions 8 and lower. [#8263](https://github.com/scalableminds/webknossos/pull/8263)
+Fixed legacy support for dataset displayName field in read and update routes for API versions 8 and lower, ensuring proper handling of dataset renaming via displayName. [#8263](https://github.com/scalableminds/webknossos/pull/8263)
This provides more context about:

The specific field affected (displayName)

The nature of the fix (legacy support)

The impact (proper handling of dataset renaming)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 20f3afe and cc72de1.

📒 Files selected for processing (1)

CHANGELOG.unreleased.md (1 hunks)

…utes

fix legacy support for outdated displayName field of datasets

20f3afe

MichaelBuessemeyer added bug backend labels Dec 5, 2024

MichaelBuessemeyer requested a review from fm3 December 5, 2024 13:46

MichaelBuessemeyer self-assigned this Dec 5, 2024

MichaelBuessemeyer commented Dec 5, 2024

View reviewed changes

fm3 approved these changes Dec 5, 2024

View reviewed changes

add changelog entry

cc72de1

coderabbitai bot reviewed Dec 5, 2024

View reviewed changes

remove directoryName from serialized dataset json format in legacy ro…

3207ef8

…utes

MichaelBuessemeyer merged commit 2ebe1c0 into master Dec 5, 2024
3 checks passed

MichaelBuessemeyer deleted the fix-display-name-support-legacy-api branch December 5, 2024 14:47

This was referenced Dec 6, 2024

Release 24.12.0 #8264

Merged

Add switch orga to legacy routes #8257

Merged

Fix already upload of zarr datasets with already existing datasource-properties.json file #8268

Merged

Allow dollar in layer name #8241

Merged

This was referenced Dec 13, 2024

Fix nml upload with only ds name in nml by using user's orga as fallback #8277

Merged

Remove unused legacy routes #8293

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix legacy support for outdated displayName field of datasets #8263

Fix legacy support for outdated displayName field of datasets #8263

MichaelBuessemeyer commented Dec 5, 2024 •

edited

Loading

coderabbitai bot commented Dec 5, 2024 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

MichaelBuessemeyer Dec 5, 2024

coderabbitai bot left a comment

Fix legacy support for outdated displayName field of datasets #8263

Fix legacy support for outdated displayName field of datasets #8263

Conversation

MichaelBuessemeyer commented Dec 5, 2024 • edited Loading

URL of deployed dev instance (used for testing):

Steps to test:

Issues:

coderabbitai bot commented Dec 5, 2024 • edited Loading

Rate limit exceeded

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

MichaelBuessemeyer Dec 5, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

MichaelBuessemeyer commented Dec 5, 2024 •

edited

Loading

coderabbitai bot commented Dec 5, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)