Merge pull request #1117 from xcube-dev/forman-1116-suppress_no_ext_config_error

Suppress no ext config error

Author: forman

CHANGES.md

@@ -1,3 +1,9 @@
+## Changes in 1.8.2 (in development)
+
+* No longer logging a `TypeError` if xcube server's 
+  `GET viewer/ext/contributions` is called without any 
+  viewer extensions configured. (#1116)
+
 ## Changes in 1.8.1
 
 ### Fixes

test/webapi/viewer/test_routes.py

@@ -137,6 +137,51 @@ def test_viewer_ext_callback(self):
         self.assertEqual({"result": expected_callback_result}, result)
 
 
+class ViewerExtRoutesWithDefaultConfigTest(RoutesTestCase):
+
+    def setUp(self) -> None:
+        super().setUp()
+        self.maxDiff = None
+
+    def test_viewer_ext_contributions(self):
+        response = self.fetch("/viewer/ext/contributions")
+        self.assertResourceNotFoundResponse(response)
+
+    def test_viewer_ext_layout(self):
+        response = self.fetch(
+            "/viewer/ext/layout/panels/0",
+            method="POST",
+            body={
+                "inputValues": [
+                    "",  # dataset_id
+                ]
+            },
+        )
+        self.assertResourceNotFoundResponse(response)
+
+    def test_viewer_ext_callback(self):
+        response = self.fetch(
+            "/viewer/ext/callback",
+            method="POST",
+            body={
+                "callbackRequests": [
+                    {
+                        "contribPoint": "panels",
+                        "contribIndex": 0,
+                        "callbackIndex": 0,
+                        "inputValues": [
+                            "",  # dataset_id
+                            True,  # opaque
+                            1,  # color
+                            "",  # info_text
+                        ],
+                    }
+                ]
+            },
+        )
+        self.assertResourceNotFoundResponse(response)
+
+
 expected_callback_result = [
     {
         "contribIndex": 0,

xcube/version.py

@@ -2,4 +2,4 @@
 # Permissions are hereby granted under the terms of the MIT License:
 # https://opensource.org/licenses/MIT.
 
-version = "1.8.1"
+version = "1.8.2.dev0"

xcube/webapi/viewer/routes.py

@@ -163,17 +163,31 @@ def new_key(self, length: int = 8) -> str:
 
 class ViewerExtHandler(ApiHandler[ViewerContext]):
     def do_get_contributions(self):
-        self._write_response(get_contributions(self.ctx.ext_ctx))
+        if self.ctx.ext_ctx is None:
+            self._write_no_ext_status()
+        else:
+            self._write_response(get_contributions(self.ctx.ext_ctx))
 
     def do_get_layout(self, contrib_point: str, contrib_index: str):
-        self._write_response(
-            get_layout(
-                self.ctx.ext_ctx, contrib_point, int(contrib_index), self.request.json
+        if self.ctx.ext_ctx is None:
+            self._write_no_ext_status()
+        else:
+            self._write_response(
+                get_layout(
+                    self.ctx.ext_ctx,
+                    contrib_point,
+                    int(contrib_index),
+                    self.request.json,
+                )
             )
-        )
 
     def do_get_callback_results(self):
-        self._write_response(get_callback_results(self.ctx.ext_ctx, self.request.json))
+        if self.ctx.ext_ctx is None:
+            self._write_no_ext_status()
+        else:
+            self._write_response(
+                get_callback_results(self.ctx.ext_ctx, self.request.json)
+            )
 
     def _write_response(self, response: ExtResponse):
         self.response.set_header("Content-Type", "text/json")
@@ -187,6 +201,10 @@ def _write_response(self, response: ExtResponse):
                 {"error": {"status": response.status, "message": response.reason}}
             )
 
+    def _write_no_ext_status(self):
+        self.response.set_status(404, "No extensions configured")
+        self.response.finish()
+
 
 @api.route("/viewer/ext/contributions")
 class ViewerExtContributionsHandler(ViewerExtHandler):