Adapt datastore client to use versioned routes (#1328)

* Adapt datastore client to use versioned routes

* refresh test cassettes

* format

* adapt one test to newer wk test db

* do not use datastore token as dataset sharing token

* Update cassettes.

* format and lint.

* changelog

* remove merge artifacts in changelog

* implement pr feedback: do not pass api version from concrete to abstract client; remove debug curl call in test setup

* Add version to manualy built routes.

---------

Co-authored-by: markbader <[email protected]>

Author: fm3

webknossos/Changelog.md

@@ -31,10 +31,12 @@ For upgrade instructions, please check the respective _Breaking Changes_ section
     - `my_task.update()` to update a `Task` object.
     - `my_task.delete()` to delete a `Task` object.
 - Added `TaskExperience` class to store domain and value pair.
+- The libs client now uses versioned datastore routes for improved compatibility across webknossos versions. [#1328](https://github.com/scalableminds/webknossos-libs/pull/1328)
 
 ### Changed
 
 ### Fixed
+- Fixed the tests for the newest WEBKNOSSOS version. [#1328](https://github.com/scalableminds/webknossos-libs/pull/1328)
 
 
 ## [2.4.1](https://github.com/scalableminds/webknossos-libs/releases/tag/v2.4.1) - 2025-07-03

webknossos/local_wk_setup.sh

@@ -46,7 +46,7 @@ function ensure_local_test_wk {
         OUT=$(docker compose exec -T webknossos tools/postgres/dbtool.js prepare-test-db 2>&1) || echo "$OUT"
         popd > /dev/null
     else
-        echo "Using the already running local webknossos setup at localhost:9000"
+        echo "Using the already running local webknossos setup at localhost:9000. Make sure l4_sample exists and is set to public first!"
     fi
 
     if ! curl -s -H "X-Auth-Token: $WK_TOKEN" localhost:9000/api/user | grep [email protected] > /dev/null; then

webknossos/tests/administration/test_task.py

@@ -14,12 +14,20 @@
 @pytest.fixture(autouse=True)
 def setup_task_type_and_project() -> Iterator[None]:
     team = wk.Team.get_list()[0]
+    try:
+        wk.TaskType.get_by_name(TEST_TASK_TYPE_NAME).delete()
+    except ValueError:
+        pass
     task_type = wk.TaskType.create(
         name="test_task_type",
         description="This is a test task type",
         team=team,
         tracing_type="volume",
     )
+    try:
+        wk.Project.get_by_name(TEST_PROJECT_NAME).delete()
+    except ValueError:
+        pass
     project = wk.Project.create(
         name=TEST_PROJECT_NAME,
         priority=1,

webknossos/tests/cassettes/test_annotation/test_annotation_upload_download_roundtrip.yml

@@ -2,7 +2,7 @@ http_interactions:
   - request:
       method: GET
       path: >-
-        /api/v9/annotations/570ba0092a7c0e980056fe9b/info?timestamp=1744722468000
+        /api/v9/annotations/570ba0092a7c0e980056fe9b/info?timestamp=1751570393000
       headers:
         host: localhost:9000
         accept: '*/*'
@@ -19,12 +19,10 @@ http_interactions:
       status:
         code: 200
       headers:
-        x-powered-by: Express
         cache-control: no-cache
         referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
         x-permitted-cross-domain-policies: master-only
-        date: Tue, 15 Apr 2025 13:07:47 GMT
-        connection: close
+        date: Thu, 03 Jul 2025 19:19:53 GMT
         content-type: application/json
         content-length: '1911'
       body:

webknossos/tests/cassettes/test_annotation/test_bounding_box_roundtrip.yml

@@ -18,19 +18,17 @@ http_interactions:
       status:
         code: 200
       headers:
-        x-powered-by: Express
         referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
         access-control-max-age: '600'
         access-control-allow-origin: '*'
         x-permitted-cross-domain-policies: master-only
-        date: Tue, 15 Apr 2025 13:07:47 GMT
-        connection: close
+        date: Thu, 03 Jul 2025 19:19:54 GMT
         content-type: application/json
-        content-length: '409'
+        content-length: '426'
       body:
         encoding: utf8
         data: >-
-          {"webknossos":{"name":"webknossos","ciTag":"","commitHash":"920807ab93ef60ae4fd1ba6341c72989f123e13d","ciBuild":"","scalaVersion":"2.13.16","version":"dev","sbtVersion":"1.10.11","datastoreApiVersion":"2.0","commitDate":"Tue
-          Apr 15 13:27:44 2025
-          +0200"},"schemaVersion":130,"httpApiVersioning":{"currentApiVersion":9,"oldestSupportedApiVersion":5},"localDataStoreEnabled":true,"localTracingStoreEnabled":true}
+          {"webknossos":{"name":"webknossos","ciTag":"","commitHash":"f907b5377a89c9ba0f90246741cc8f4c5f521966","ciBuild":"16048991892","scalaVersion":"2.13.16","version":"16048991892","sbtVersion":"1.11.0","datastoreApiVersion":"2.0","commitDate":"Thu
+          Jul 3 13:18:06 2025
+          +0200"},"schemaVersion":135,"httpApiVersioning":{"currentApiVersion":9,"oldestSupportedApiVersion":5},"localDataStoreEnabled":true,"localTracingStoreEnabled":true}
         compression: none

webknossos/tests/cassettes/test_annotation/test_dataset_access_via_annotation.yml

@@ -18,18 +18,16 @@ http_interactions:
       status:
         code: 200
       headers:
-        x-powered-by: Express
         cache-control: no-cache
         referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
         x-permitted-cross-domain-policies: master-only
-        date: Tue, 15 Apr 2025 13:07:47 GMT
-        connection: close
+        date: Thu, 03 Jul 2025 19:19:54 GMT
         content-type: application/json
-        content-length: '682'
+        content-length: '717'
       body:
         encoding: utf8
         data: >-
-          {"id":"570b9f4d2a7c0e4d008da6ef","email":"[email protected]","firstName":"user_A","lastName":"last_A","isAdmin":true,"isOrganizationOwner":true,"isDatasetManager":true,"isActive":true,"teams":[{"id":"570b9f4b2a7c0e3b008da6ec","name":"team_X1","isTeamManager":true},{"id":"59882b370d889b84020efd3f","name":"team_X3","isTeamManager":false},{"id":"59882b370d889b84020efd6f","name":"team_X4","isTeamManager":true}],"experiences":{"abc":5},"lastActivity":1460379469053,"isAnonymous":false,"isEditable":true,"organization":"Organization_X","novelUserExperienceInfos":{},"selectedTheme":"auto","created":1460379469000,"lastTaskTypeId":null,"isSuperUser":true,"isEmailVerified":true}
+          {"id":"570b9f4d2a7c0e4d008da6ef","email":"[email protected]","firstName":"user_A","lastName":"last_A","isAdmin":true,"isOrganizationOwner":true,"isDatasetManager":true,"isActive":true,"teams":[{"id":"570b9f4b2a7c0e3b008da6ec","name":"team_X1","isTeamManager":true},{"id":"59882b370d889b84020efd3f","name":"team_X3","isTeamManager":false},{"id":"59882b370d889b84020efd6f","name":"team_X4","isTeamManager":true}],"experiences":{"abc":5},"lastActivity":1460379469053,"isAnonymous":false,"isEditable":true,"organization":"Organization_X","novelUserExperienceInfos":{},"selectedTheme":"auto","created":1460379469000,"lastTaskTypeId":null,"isSuperUser":true,"isEmailVerified":true,"isUnlisted":false,"isGuest":false}
         compression: none
   - request:
       method: GET
@@ -50,16 +48,14 @@ http_interactions:
       status:
         code: 200
       headers:
-        x-powered-by: Express
         cache-control: no-cache
         referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
         x-permitted-cross-domain-policies: master-only
-        date: Tue, 15 Apr 2025 13:07:47 GMT
-        connection: close
+        date: Thu, 03 Jul 2025 19:19:54 GMT
         content-type: application/json
         content-length: '691'
       body:
         encoding: utf8
         data: >-
-          {"loggedTime":[{"paymentInterval":{"month":4,"year":2016},"durationInSeconds":58},{"paymentInterval":{"month":8,"year":2018},"durationInSeconds":265},{"paymentInterval":{"month":1,"year":2021},"durationInSeconds":112},{"paymentInterval":{"month":3,"year":2021},"durationInSeconds":24},{"paymentInterval":{"month":5,"year":2021},"durationInSeconds":158},{"paymentInterval":{"month":8,"year":2021},"durationInSeconds":14},{"paymentInterval":{"month":11,"year":2021},"durationInSeconds":12},{"paymentInterval":{"month":2,"year":2024},"durationInSeconds":114},{"paymentInterval":{"month":3,"year":2024},"durationInSeconds":200},{"paymentInterval":{"month":4,"year":2025},"durationInSeconds":0}]}
+          {"loggedTime":[{"paymentInterval":{"month":4,"year":2016},"durationInSeconds":58},{"paymentInterval":{"month":8,"year":2018},"durationInSeconds":265},{"paymentInterval":{"month":1,"year":2021},"durationInSeconds":112},{"paymentInterval":{"month":3,"year":2021},"durationInSeconds":24},{"paymentInterval":{"month":5,"year":2021},"durationInSeconds":158},{"paymentInterval":{"month":8,"year":2021},"durationInSeconds":14},{"paymentInterval":{"month":11,"year":2021},"durationInSeconds":12},{"paymentInterval":{"month":2,"year":2024},"durationInSeconds":114},{"paymentInterval":{"month":3,"year":2024},"durationInSeconds":200},{"paymentInterval":{"month":7,"year":2025},"durationInSeconds":0}]}
         compression: none