fix colander schema type for OpenAPI generation

crim-ca · Nov 9, 2024 · 0c005e4 · 0c005e4
1 parent 552949b
commit 0c005e4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/tests/wps_restapi/test_api.py b/tests/wps_restapi/test_api.py
@@ -21,6 +21,8 @@
 if TYPE_CHECKING:
     from typing import List, Tuple
 
+    from weaver.typedefs import JSON  # noqa
+
 
 @pytest.mark.functional
 class GenericApiRoutesTestCase(WpsConfigBase):
@@ -34,7 +36,7 @@ class GenericApiRoutesTestCase(WpsConfigBase):
     def test_frontpage_format(self):
         resp = self.app.get(sd.api_frontpage_service.path, headers=self.json_headers)
         assert resp.status_code == 200
-        body = resp.json
+        body = cast("JSON", resp.json)
         try:
             sd.FrontpageSchema().deserialize(body)
         except colander.Invalid as ex:

diff --git a/weaver/wps_restapi/colander_extras.py b/weaver/wps_restapi/colander_extras.py
@@ -81,6 +81,7 @@
     IntegerTypeConverter,
     NumberTypeConverter,
     ObjectTypeConverter,
+    StringTypeConverter,
     TimeTypeConverter,
     TypeConversionDispatcher,
     TypeConverter,
@@ -138,7 +139,7 @@ def convert_type(self, schema_node):
         return result
 
 
-class ExtendedStringTypeConverter(MetadataTypeConverter, BaseStringTypeConverter):
+class ExtendedStringTypeConverter(MetadataTypeConverter, StringTypeConverter):
     pass
 
 
@@ -197,12 +198,11 @@ class ExtendedMoneyTypeConverter(ExtendedDecimalTypeConverter):
 URI_REGEX = rf"{URL_REGEX[:-1]}(?:#?|[#?]\S+)$"
 URI = colander.Regex(URI_REGEX, msg=colander._("Must be a URI"), flags=re.IGNORECASE)
 STRING_FORMATTERS.update({
-    "uri": {"converter": ExtendedStringTypeConverter, "validator": URI},
-    "url": {"converter": ExtendedStringTypeConverter, "validator": URL},
-    "file": {"converter": ExtendedStringTypeConverter, "validator": FILE_URI},
-    "date": {"converter": ExtendedDateTimeTypeConverter},
-    "time": {"converter": ExtendedDateTimeTypeConverter},
-    "date-time": {"converter": ExtendedDateTimeTypeConverter},
+    # following MUST NOT use the 'StringTypeConverter' or 'ExtendedStringTypeConverter'
+    # otherwise, it causes a recursion error when 'StringTypeConverter' tries to dispatch their parameter handling
+    "uri": {"converter": BaseStringTypeConverter, "validator": URI},
+    "url": {"converter": BaseStringTypeConverter, "validator": URL},
+    "file": {"converter": BaseStringTypeConverter, "validator": FILE_URI},
 })