Datastore client: use datastore token correctly for download (#562)

* Update context.py
* use token for download
* Update context.py
* refactoring
* add changelog entry
* Merge refs/heads/master into datastore_client_use_datastore_token
* fix snapshots

Author: jstriebel

webknossos/Changelog.md

@@ -36,6 +36,7 @@ For upgrade instructions, please check the respective *Breaking Changes* section
 ### Changed
 
 ### Fixed
+- Fixed the dataset download of private datasets which need a token. [#562](https://github.com/scalableminds/webknossos-libs/pull/562)
 
 
 ## [0.8.31](https://github.com/scalableminds/webknossos-libs/releases/tag/v0.8.31) - 2022-01-07

webknossos/tests/cassettes/test_examples/test_learned_segmenter.yaml

@@ -7,12 +7,9 @@ services:
     ports:
       - "9000:9000"
     depends_on:
-      postgres:
-        condition: service_healthy
-      fossildb:
-        condition: service_healthy
-      redis:
-        condition: service_healthy
+      - postgres
+      - fossildb
+      - redis
     command:
       - -Dconfig.file=conf/application.conf
       - -Djava.net.preferIPv4Stack=true

webknossos/tests/docker-compose.yml

@@ -43,6 +43,7 @@ def download_dataset(
     datastore_client = _get_context().get_generated_datastore_client(
         parsed.data_store.url
     )
+    optional_datastore_token = _get_context().datastore_token
 
     actual_path = Path(dataset_name) if path is None else Path(path)
     if actual_path.exists():
@@ -98,6 +99,7 @@ def download_dataset(
                     data_layer_name=layer_name,
                     resolution=mag.max_dim_log2,
                     client=datastore_client,
+                    token=optional_datastore_token,
                     x=aligned_chunk_in_mag.topleft.x,
                     y=aligned_chunk_in_mag.topleft.y,
                     z=aligned_chunk_in_mag.topleft.z,

webknossos/webknossos/client/_download_dataset.py

@@ -85,7 +85,7 @@ def upload_dataset(
     # replicates https://github.com/scalableminds/webknossos/blob/master/frontend/javascripts/admin/dataset/dataset_upload_view.js
     time_str = strftime("%Y-%m-%dT%H-%M-%S", gmtime())
     upload_id = f"{time_str}__{uuid4()}"
-    datastore_token = context.datastore_token
+    datastore_token = context.datastore_required_token
     datastore_url = _cached_get_upload_datastore(context)
     datastore_client = _get_context().get_generated_datastore_client(datastore_url)
     simultaneous_uploads = jobs if jobs is not None else DEFAULT_SIMULTANEOUS_UPLOADS

webknossos/webknossos/client/_upload_dataset.py

@@ -137,7 +137,14 @@ def organization(self) -> str:
         return _cached_get_org(self)
 
     @property
-    def datastore_token(self) -> str:
+    def datastore_token(self) -> Optional[str]:
+        if self.token is None:
+            return None
+        else:
+            return _cached_get_datastore_token(self)
+
+    @property
+    def datastore_required_token(self) -> str:
         return _cached_get_datastore_token(self)
 
     @property
@@ -148,22 +155,8 @@ def generated_client(self) -> GeneratedClient:
     def generated_auth_client(self) -> GeneratedClient:
         return _cached__get_generated_client(self.url, self.required_token)
 
-    def get_generated_datastore_client(
-        self, datastore_url: str, enforce_auth: bool = False
-    ) -> GeneratedClient:
-        if enforce_auth:
-            token: Optional[str] = self.required_token
-        else:
-            token = self.token
-
-        if token is None:
-            return GeneratedClient(base_url=datastore_url, timeout=120)
-        else:
-            return GeneratedClient(
-                base_url=datastore_url,
-                headers={"X-Auth-Token": token},
-                timeout=120,
-            )
+    def get_generated_datastore_client(self, datastore_url: str) -> GeneratedClient:
+        return GeneratedClient(base_url=datastore_url, timeout=120)
 
 
 _webknossos_context_var: ContextVar[_WebknossosContext] = ContextVar(