enforce read_only on remote datasets (#1383)

* enforce read_only on remote datasets

* reset state to server state when change was tried.

* add tests for changing properties on remote datasets. fix test.py

* format

* add changelog

---------

Co-authored-by: valentin-pinkau <[email protected]>

Author: valentin-pinkau

webknossos/Changelog.md

@@ -40,9 +40,10 @@ For upgrade instructions, please check the respective _Breaking Changes_ section
 - Refactored the architecture, by introducing RemoteLayers, RemoteSegmentationLayers and their abstract base classes. [#1371](https://github.com/scalableminds/webknossos-libs/pull/1371])
 - Updated the api version of the webknossos-api to 12. [#1371](https://github.com/scalableminds/webknossos-libs/pull/1371])
 - Allowing RemoteDataset to align mags, when down- or upsampling [#1382](https://github.com/scalableminds/webknossos-libs/pull/1382)
+- RemoteDatasets that use zarr streaming are no longer read-only. [#1383](https://github.com/scalableminds/webknossos-libs/pull/1383)
 
 ### Fixed
-
+- Fixed test.py to parse the command line arguments correctly. [#1383](https://github.com/scalableminds/webknossos-libs/pull/1383)
 
 ## [2.5.0](https://github.com/scalableminds/webknossos-libs/releases/tag/v2.5.0) - 2025-10-06
 [Commits](https://github.com/scalableminds/webknossos-libs/compare/v2.4.12...v2.5.0)

webknossos/test.py

@@ -106,15 +106,17 @@ def local_test_wk() -> Iterator[None]:
 
     # Fetch current version of webknossos.org this can be replaced with a fixed version for testing
     wk_version = requests.get(
-        "https://webknossos.org/api/v{WK_API_VERSION}/buildinfo"
+        f"https://webknossos.org/api/v{WK_API_VERSION}/buildinfo"
     ).json()["webknossos"]["version"]
     wk_docker_tag = f"master__${wk_version}"
     os.environ["DOCKER_TAG"] = wk_docker_tag
     wk_docker_dir = Path("tests")
+    tear_down_wk = False
 
     try:
         if not requests.get(f"{WK_URL}/api/v{WK_API_VERSION}/health").ok:
             start_wk_via_docker()
+            tear_down_wk = True
         else:
             print(
                 f"Using the already running webknossos at {WK_URL}. Make sure l4_sample exists and is set to public first!",
@@ -142,7 +144,8 @@ def local_test_wk() -> Iterator[None]:
         )
         yield
     finally:
-        subprocess.check_call(["docker", "compose", "down"], cwd=wk_docker_dir)
+        if tear_down_wk:
+            subprocess.check_call(["docker", "compose", "down"], cwd=wk_docker_dir)
 
 
 @contextmanager
@@ -259,7 +262,7 @@ def main(snapshot_command: Literal["refresh", "add"] | None, args: list[str]) ->
     snapshot_command = None
     args = sys.argv[1:]
     if len(args) > 0 and args[0] in ["--refresh-snapshots", "--add-snapshots"]:
-        snapshot_command = args[0][3:-10]
+        snapshot_command = args[0][2:-10]
         args = args[1:]
 
     main(snapshot_command, args)

webknossos/tests/cassettes/test_dataset_add_remote_mag_and_layer/test_changing_properties_on_remote_dataset.yml

@@ -6,7 +6,12 @@
 import pytest
 from upath import UPath
 
-from webknossos import COLOR_CATEGORY, Dataset, RemoteDataset
+from webknossos import (
+    COLOR_CATEGORY,
+    Dataset,
+    LayerViewConfiguration,
+    RemoteDataset,
+)
 from webknossos.geometry import BoundingBox
 from webknossos.utils import is_remote_path
 
@@ -158,3 +163,39 @@ def test_add_mag_ref_from_local_path(tmp_upath: UPath) -> None:
     assert layer2_mag1._properties.path == str(
         (tmp_upath / "origin" / "color" / "1").resolve()
     )
+
+
+def test_changing_properties_on_remote_dataset() -> None:
+    remote_dataset = RemoteDataset.open(dataset_id="59e9cfbdba632ac2ab8b23b5")
+    remote_dataset.description = "This is a test description"
+    assert remote_dataset.description == "This is a test description"
+    largest_segment_id_before_change_attempt = remote_dataset.get_segmentation_layer(
+        "segmentation"
+    ).largest_segment_id
+    with pytest.raises(RuntimeError):
+        remote_dataset.get_segmentation_layer("segmentation").largest_segment_id = 10
+    assert (
+        remote_dataset.get_segmentation_layer("segmentation").largest_segment_id
+        == largest_segment_id_before_change_attempt
+    )
+    default_view_configuration_before_change_attempt = remote_dataset.get_layer(
+        "color"
+    ).default_view_configuration
+    with pytest.raises(RuntimeError):
+        remote_dataset.get_layer(
+            "color"
+        ).default_view_configuration = LayerViewConfiguration(alpha=0.3)
+    assert (
+        remote_dataset.get_layer("color").default_view_configuration
+        == default_view_configuration_before_change_attempt
+    )
+
+
+def test_changing_properties_on_read_only_remote_dataset() -> None:
+    remote_dataset = RemoteDataset.open(
+        dataset_id="59e9cfbdba632ac2ab8b23b5", read_only=True
+    )
+    description_before_change_attempt = remote_dataset.description
+    with pytest.raises(RuntimeError):
+        remote_dataset.description = "This is a test description"
+    assert remote_dataset.description == description_before_change_attempt

webknossos/tests/dataset/test_dataset_add_remote_mag_and_layer.py

@@ -131,8 +131,8 @@ def test_remote_dataset(tmp_upath: UPath) -> None:
         sample_dataset.get_color_layers()[0].get_finest_mag().read(),
     )
 
-    assert remote_ds.read_only
-    assert remote_ds.get_color_layers()[0].read_only
+    assert not remote_ds.read_only
+    assert not remote_ds.get_color_layers()[0].read_only
     assert remote_ds.get_color_layers()[0].get_finest_mag().read_only
 
     assert remote_ds.name == "test_remote_metadata"

webknossos/tests/dataset/test_dataset_download_upload_remote.py

@@ -982,7 +982,6 @@ def get_remote_annotation_dataset(self) -> RemoteDataset:
             dataset_id=self.dataset_id,
             annotation_id_or_url=self.annotation_id,
             use_zarr_streaming=True,
-            read_only=True,
         )
 
     def get_remote_base_dataset(

webknossos/webknossos/annotation/annotation.py

@@ -701,7 +701,7 @@ def upload(
                 self, new_dataset_name, converted_layers_to_link, jobs
             )
 
-        return RemoteDataset.open(dataset_id=new_dataset_id, read_only=True)
+        return RemoteDataset.open(dataset_id=new_dataset_id)
 
     def _copy_or_symlink_dataset_to_paths(
         self, data_source: DatasetProperties, symlink_data_instead_of_copy: bool

webknossos/webknossos/dataset/dataset.py

@@ -49,6 +49,7 @@ class RemoteDataset(AbstractDataset[RemoteLayer, RemoteSegmentationLayer]):
     This class is returned from `RemoteDataset.open()` and provides read-only access to
     image data streamed from the webknossos server. It uses the same interface as `Dataset`
     but additionally allows metadata manipulation through properties.
+    In case of zarr streaming, an even smaller subset of metadata manipulation is possible.
 
     Properties:
         metadata: Dataset metadata as key-value pairs
@@ -112,7 +113,6 @@ def __init__(
         self.zarr_streaming_path = zarr_streaming_path
         self._use_zarr_streaming = zarr_streaming_path is not None
         if self._use_zarr_streaming:
-            assert read_only, "zarr streaming is only supported in read-only mode"
             dataset_properties = self._load_dataset_properties()
 
         assert dataset_properties is not None
@@ -187,8 +187,6 @@ def open(
             url_prefix = wk_context.get_datastore_api_client(datastore_url).url_prefix
 
             if use_zarr_streaming:
-                if not read_only:
-                    logger.warning("zarr streaming is supported in read-only mode only")
                 if annotation_id is not None:
                     zarr_path = UPath(
                         f"{url_prefix}/annotations/zarr/{annotation_id}/",
@@ -207,7 +205,7 @@ def open(
                     dataset_id,
                     annotation_id,
                     context_manager,
-                    read_only=True,
+                    read_only=read_only,
                 )
             else:
                 if isinstance(api_dataset_info.data_source, ApiUnusableDataSource):
@@ -246,9 +244,16 @@ def _save_dataset_properties_impl(self) -> None:
         Exports the current dataset properties to the server.
         Note that some edits will not be accepted by the server.
         The client-side RemoteDataset is reinitialized to the new server state.
+        Does not work with zarr streaming, as the remote datasource-properties.json is not writable.
         """
         from ..client.context import _get_api_client
 
+        if self._use_zarr_streaming:
+            # reset the dataset properties to the server state
+            data_source = self._load_dataset_properties()
+            self._init_from_properties(data_source, read_only=self.read_only)
+            raise RuntimeError("zarr streaming does not support updating this property")
+
         with self._context:
             client = _get_api_client()
             client.dataset_update(
@@ -325,6 +330,7 @@ def _update_dataset_info(
         tags: list[str] = _UNSET,
         metadata: list[ApiMetadata] | None = _UNSET,
     ) -> None:
+        self._ensure_writable()
         from ..client.context import _get_api_client
 
         # Atm, the wk backend needs to get previous parameters passed
@@ -578,6 +584,7 @@ def allowed_teams(self) -> tuple["Team", ...]:
     @allowed_teams.setter
     def allowed_teams(self, allowed_teams: Sequence[Union[str, "Team"]]) -> None:
         """Assign the teams that are allowed to access the dataset. Specify the teams like this `[Team.get_by_name("Lab_A"), ...]`."""
+        self._ensure_writable()
         from ..administration.team import Team
         from ..client.context import _get_api_client