Merge pull request #837 from dcs4cop/forman-xxx-viewer_add_dataset_with_style

forman · web-flow · commit e794e297cf15 · 2023-03-21T17:10:32.000+01:00
Add datasets to viewer with style
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,11 @@
 ## Changes in 1.0.2 (in development)
 
+* The `Viewer.add_dataset()` method of the xcube JupyterLab integration 
+  has been enhanced by two optional keyword arguments `style` and 
+  `color_mappings` to allow for customized, initial color mapping
+  of dataset variables. The example notebook 
+  [xcube-viewer-in-jl.ipynb](examples/notebooks/viewer/xcube-viewer-in-jl.ipynb)
+  has been updated to reflect the enhancement.
 
 ## Changes in 1.0.1
 
@@ -275,12 +281,6 @@
 * Added convenience method `DataStore.list_data_ids()` that works 
   like `get_data_ids()`, but returns a list instead of an iterator. (#776)
 
-* Added Notebook 
-  [xcube-viewer-in-jl.ipynb](examples/notebooks/viewer/xcube-viewer-in-jl.ipynb)
-  that explains how xcube Viewer can now be utilised in JupyterLab
-  using the new (still experimental) xcube JupyterLab extension
-  [xcube-jl-ext](https://github.com/dcs4cop/xcube-jl-ext).
-
 * Replaced usages of deprecated numpy dtype `numpy.bool` 
   by Python type `bool`. 
 
diff --git a/examples/notebooks/viewer/xcube-viewer-in-jl.ipynb b/examples/notebooks/viewer/xcube-viewer-in-jl.ipynb
diff --git a/test/webapi/viewer/test_viewer.py b/test/webapi/viewer/test_viewer.py
@@ -0,0 +1,189 @@
+# The MIT License (MIT)
+# Copyright (c) 2023 by the xcube team and contributors
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+
+import unittest
+from typing import Optional, Mapping, Any
+
+import pytest
+
+from xcube.core.new import new_cube
+from xcube.server.api import ApiError
+from xcube.webapi.datasets.context import DatasetsContext
+from xcube.webapi.viewer import Viewer
+
+STYLES_CONFIG = {
+    "Styles": [
+        {
+            "Identifier": "SST",
+            "ColorMappings": {
+                "analysed_sst": {
+                    "ValueRange": [270, 290],
+                    "ColorBar": "inferno"
+                }
+            }
+        }
+    ]
+}
+
+
+class ViewerTest(unittest.TestCase):
+
+    def setUp(self) -> None:
+        self.viewer: Optional[Viewer] = None
+
+    def tearDown(self) -> None:
+        if self.viewer is not None:
+            self.viewer.stop_server()
+
+    def get_viewer(self, server_config: Optional[Mapping[str, Any]] = None) \
+            -> Viewer:
+        self.viewer = Viewer(server_config=server_config)
+        return self.viewer
+
+    def test_start_and_stop_server(self):
+        viewer = self.get_viewer()
+        self.assertTrue(viewer.is_server_running)
+        self.assertIsInstance(viewer.datasets_ctx, DatasetsContext)
+        viewer.stop_server()
+        self.assertFalse(viewer.is_server_running)
+
+    def test_info(self):
+        viewer = self.get_viewer()
+        # Just a smoke test:
+        viewer.info()  # will print something
+
+    def test_show(self):
+        viewer = self.get_viewer()
+        # Just a smoke test:
+        result = viewer.show()  # will show viewer
+        if result is not None:
+            from IPython.core.display import HTML
+            self.assertIsInstance(result, HTML)
+
+    def test_no_config(self):
+        viewer = self.get_viewer()
+        self.assertIsInstance(viewer.server_config, dict)
+        self.assertIn("port", viewer.server_config)
+        self.assertIn("address", viewer.server_config)
+        self.assertIn("reverse_url_prefix", viewer.server_config)
+
+    def test_with_config(self):
+        viewer = self.get_viewer(STYLES_CONFIG)
+        self.assertIsInstance(viewer.server_config, dict)
+        self.assertIn("port", viewer.server_config)
+        self.assertIn("address", viewer.server_config)
+        self.assertIn("reverse_url_prefix", viewer.server_config)
+        self.assertIn("Styles", viewer.server_config)
+        self.assertEqual(STYLES_CONFIG["Styles"],
+                         viewer.server_config["Styles"])
+
+    def test_urls(self):
+        viewer = self.get_viewer()
+
+        self.assertIn("port", viewer.server_config)
+        port = viewer.server_config["port"]
+        reverse_url_prefix = viewer.server_config.get("reverse_url_prefix")
+
+        if not reverse_url_prefix:
+            expected_server_url = f"http://localhost:{port}"
+            self.assertEqual(expected_server_url,
+                             viewer.server_url)
+
+            expected_viewer_url = f"{expected_server_url}/viewer/" \
+                                  f"?serverUrl={expected_server_url}"
+            self.assertEqual(expected_viewer_url,
+                             viewer.viewer_url)
+        else:
+            self.assertIsInstance(viewer.server_url, str)
+            self.assertIsInstance(viewer.viewer_url, str)
+            self.assertIn(reverse_url_prefix, viewer.server_url)
+            self.assertIn(viewer.server_url, viewer.viewer_url)
+
+    def test_add_and_remove_dataset(self):
+        viewer = self.get_viewer()
+
+        # Generate identifier and get title from dataset
+        ds_id_1 = viewer.add_dataset(
+            new_cube(variables={"analysed_sst": 280.},
+                     title="My SST 1"),
+        )
+        self.assertIsInstance(ds_id_1, str)
+
+        # Provide identifier and title
+        ds_id_2 = viewer.add_dataset(
+            new_cube(variables={"analysed_sst": 282.}),
+            ds_id="my_sst_2",
+            title="My SST 2"
+        )
+        self.assertEqual("my_sst_2", ds_id_2)
+
+        ds_config_1 = self.viewer.datasets_ctx.get_dataset_config(ds_id_1)
+        self.assertEqual({"Identifier": ds_id_1,
+                          "Title": "My SST 1"},
+                         ds_config_1)
+
+        ds_config_2 = self.viewer.datasets_ctx.get_dataset_config(ds_id_2)
+        self.assertEqual({"Identifier": ds_id_2,
+                          "Title": "My SST 2"},
+                         ds_config_2)
+
+        self.viewer.remove_dataset(ds_id_1)
+        with pytest.raises(ApiError.NotFound):
+            self.viewer.datasets_ctx.get_dataset_config(ds_id_1)
+
+        self.viewer.remove_dataset(ds_id_2)
+        with pytest.raises(ApiError.NotFound):
+            self.viewer.datasets_ctx.get_dataset_config(ds_id_2)
+
+    def test_add_dataset_with_style(self):
+        viewer = self.get_viewer(STYLES_CONFIG)
+
+        ds_id = viewer.add_dataset(
+            new_cube(variables={"analysed_sst": 280.}),
+            title="My SST",
+            style="SST"
+        )
+
+        ds_config = self.viewer.datasets_ctx.get_dataset_config(ds_id)
+        self.assertEqual({"Identifier": ds_id,
+                          "Title": "My SST",
+                          "Style": "SST"},
+                         ds_config)
+
+    def test_add_dataset_with_color_mapping(self):
+        viewer = self.get_viewer()
+
+        ds_id = viewer.add_dataset(
+            new_cube(variables={"analysed_sst": 280.}),
+            title="My SST",
+            color_mappings={
+                "analysed_sst": {
+                    "ValueRange": [280., 290.],
+                    "ColorBar": "plasma"
+                }
+            },
+        )
+
+        ds_config = self.viewer.datasets_ctx.get_dataset_config(ds_id)
+        self.assertEqual({"Identifier": ds_id,
+                          "Title": "My SST",
+                          "Style": ds_id},
+                         ds_config)
diff --git a/xcube/webapi/datasets/context.py b/xcube/webapi/datasets/context.py
@@ -188,10 +188,14 @@ def set_ml_dataset(self, ml_dataset: MultiLevelDataset):
                                  dict(Identifier=ml_dataset.ds_id,
                                       Hidden=True)))
 
-    def add_dataset(self,
-                    dataset: Union[xr.Dataset, MultiLevelDataset],
-                    ds_id: Optional[str] = None,
-                    title: Optional[str] = None):
+    def add_dataset(
+            self,
+            dataset: Union[xr.Dataset, MultiLevelDataset],
+            ds_id: Optional[str] = None,
+            title: Optional[str] = None,
+            style: Optional[str] = None,
+            color_mappings: Dict[str, Dict[str, Any]] = None
+    ):
         assert_instance(dataset, (xr.Dataset, MultiLevelDataset), 'dataset')
         if isinstance(dataset, xr.Dataset):
             ml_dataset = BaseMultiLevelDataset(dataset, ds_id=ds_id)
@@ -209,6 +213,12 @@ def add_dataset(self,
         dataset_config = dict(Identifier=ds_id,
                               Title=title or dataset.attrs.get("title",
                                                                ds_id))
+        if style is not None:
+            dataset_config.update(dict(Style=style))
+        if color_mappings is not None:
+            style = style or ds_id
+            dataset_config.update(dict(Style=style))
+            self._cm_styles[style] = color_mappings
         self._dataset_cache[ds_id] = ml_dataset, dataset_config
         self._dataset_configs.append(dataset_config)
         return ds_id
@@ -218,7 +228,11 @@ def remove_dataset(self, ds_id: str):
         assert_given(ds_id, 'ds_id')
         if ds_id in self._dataset_cache:
             del self._dataset_cache[ds_id]
-            # TODO: remove from self._dataset_configs
+        self._dataset_configs = [
+            dc
+            for dc in self._dataset_configs
+            if dc["Identifier"] != ds_id
+        ]
 
     def add_ml_dataset(self,
                        ml_dataset: MultiLevelDataset,
diff --git a/xcube/webapi/viewer/__init__.py b/xcube/webapi/viewer/__init__.py
@@ -20,5 +20,6 @@
 # DEALINGS IN THE SOFTWARE.
 
 # noinspection PyUnresolvedReferences
+
 from .routes import api
 from .viewer import Viewer
diff --git a/xcube/webapi/viewer/context.py b/xcube/webapi/viewer/context.py
@@ -38,7 +38,9 @@ def config_items(self) -> Optional[Mapping[str, bytes]]:
 
     @cached_property
     def config_path(self) -> Optional[str]:
+        if "Viewer" not in self.config:
+            return None
         return self.get_config_path(
-            self.config.get("Viewer", {}).get("Configuration", {}),
+            self.config["Viewer"].get("Configuration", {}),
             "'Configuration' item of 'Viewer'"
         )
diff --git a/xcube/webapi/viewer/viewer.py b/xcube/webapi/viewer/viewer.py
