Do not share query_types between subclasses of BaseEDRProvider (#2049)

* Add test for shared edr query_type inheritance

* Fix test_load_and_prepare_item_missing_geojson_parts

* Auto-register subclasses EDR query types

- Automatically register EDR query types
- Ensure subclasses of `BaseEDRProvider` does not share query_types between instances of its subclass

Author: webb-ben

.github/workflows/main.yml

@@ -143,6 +143,7 @@ jobs:
       run: |
         pytest tests/api
         pytest tests/test_api_ogr_provider.py
+        pytest tests/test_base_provider.py
         pytest tests/test_config.py
         pytest tests/test_csv__formatter.py
         pytest tests/test_csv__provider.py

pygeoapi/provider/base_edr.py

@@ -56,17 +56,28 @@ def __init__(self, provider_def):
 
 #        self.instances = []
 
-    @classmethod
-    def register(cls):
-        def inner(fn):
-            if fn.__name__ not in EDR_QUERY_TYPES:
-                msg = 'Invalid EDR Query type'
-                LOGGER.error(msg)
-                raise ProviderInvalidDataError(msg)
-
-            cls.query_types.append(fn.__name__)
-            return fn
-        return inner
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+
+        cls.query_types = [
+            name for name, function in cls.__dict__.items()
+            if name in EDR_QUERY_TYPES and callable(function)
+        ]
+
+        if not cls.query_types:
+            msg = f"{cls.__name__} does not implement any query types"
+            LOGGER.error(msg)
+            raise ProviderInvalidDataError(msg)
+
+        LOGGER.debug(
+            f'{cls.__name__} registered query types: {cls.query_types}'
+        )
+
+        if 'items' in cls.query_types:
+            LOGGER.warning(
+                f'items query is registered in {cls.__name__}, '
+                'but requests will be routed to a feature provider'
+            )
 
     def get_instance(self, instance):
         """

pygeoapi/provider/sensorthings_edr.py

@@ -100,7 +100,6 @@ def get_fields(self):
 
         return self._fields
 
-    @BaseEDRProvider.register()
     def items(self, **kwargs):
         """
         Retrieve a collection of items.
@@ -113,7 +112,6 @@ def items(self, **kwargs):
         # We implement this method inside of the feature provider
         pass
 
-    @BaseEDRProvider.register()
     def locations(
         self,
         select_properties: list = [],
@@ -188,7 +186,6 @@ def locations(
 
         return fc
 
-    @BaseEDRProvider.register()
     def cube(
         self,
         select_properties: list = [],
@@ -240,7 +237,6 @@ def cube(
 
         return self._make_coverage_collection(response)
 
-    @BaseEDRProvider.register()
     def area(
         self,
         wkt: str,

pygeoapi/provider/xarray_edr.py

@@ -57,7 +57,6 @@ def __init__(self, provider_def):
         BaseEDRProvider.__init__(self, provider_def)
         XarrayProvider.__init__(self, provider_def)
 
-    @BaseEDRProvider.register()
     def position(self, **kwargs):
         """
         Extract data from collection collection
@@ -168,7 +167,6 @@ def position(self, **kwargs):
 
         return self.gen_covjson(out_meta, data, self.fields)
 
-    @BaseEDRProvider.register()
     def cube(self, **kwargs):
         """
         Extract data from collection

tests/test_base_provider.py

@@ -318,28 +318,28 @@ def test_load_and_prepare_item_accept_missing_identifier(
         assert data["type"] == "Feature"
 
 
-@pytest.mark.parametrize("missing_part,item_data", [
-    ("geometry", {
+@pytest.mark.parametrize("item_data", [
+    {
         "type": "Feature",
         "id": "test_id",
         "properties": {"name": "Test Feature"}
-    }),
-    ("properties", {
+    },
+    {
         "type": "Feature",
         "id": "test_id",
         "geometry": {"type": "Point", "coordinates": [0, 0]}
-    })
+    }
 ])
 def test_load_and_prepare_item_missing_geojson_parts(
-    mock_provider_with_get, missing_part, item_data, remove_stdout
+    mock_provider_with_get, item_data, remove_stdout
 ):
     """Test loading item without required GeoJSON parts."""
     item_json = json.dumps(item_data)
 
     with remove_stdout():
         with pytest.raises(
             ProviderInvalidDataError,
-            match=f"Missing core GeoJSON {missing_part}"
+            match="Missing core GeoJSON geometry or properties"
         ):
             mock_provider_with_get._load_and_prepare_item(item_json)
 
@@ -400,3 +400,17 @@ def test_provider_request_entity_too_large_error_with_message():
 def test_schema_type_values(schema_type, expected_value):
     """Test SchemaType enum values."""
     assert schema_type.value == expected_value
+
+
+def test_unique_subclass_query_types():
+    from pygeoapi.provider.base_edr import BaseEDRProvider
+    assert BaseEDRProvider.query_types == []
+
+    from pygeoapi.provider.xarray_edr import XarrayEDRProvider
+    assert BaseEDRProvider.query_types != XarrayEDRProvider.query_types
+    assert XarrayEDRProvider.query_types == ['position', 'cube']
+
+    from pygeoapi.provider.sensorthings_edr import SensorThingsEDRProvider
+    assert BaseEDRProvider.query_types != SensorThingsEDRProvider.query_types
+    assert SensorThingsEDRProvider.query_types == \
+        ['items', 'locations', 'cube', 'area']