exclude hydrate markers

Author: vincentsarago

setup.py

@@ -20,6 +20,7 @@
     "typing_extensions>=4.9.0",
     "jsonpatch>=1.33.0",
     "json-merge-patch>=0.3.0",
+    "hydraters>=0.1.3",
 ]
 
 extra_reqs = {

stac_fastapi/pgstac/config.py

@@ -184,6 +184,13 @@ class Settings(ApiSettings):
 
     ref: https://stac-utils.github.io/pgstac/pgstac/#runtime-configurations
     """
+    exclude_hydrate_markers: bool = True
+    """
+    In some case, PgSTAC can return `DO_NOT_MERGE_MARKER` markers (`𒍟※`).
+    If `EXCLUDE_HYDRATE_MARKERS=TRUE` and `USE_API_HYDRATE=TRUE`, stac-fastapi-pgstac
+    will exclude those values from the responses.
+    """
+
     invalid_id_chars: List[str] = DEFAULT_INVALID_ID_CHARS
     base_item_cache: Type[BaseItemCache] = DefaultBaseItemCache
 

stac_fastapi/pgstac/core.py

@@ -331,7 +331,11 @@ async def _get_base_item(collection_id: str) -> Dict[str, Any]:
                 # Exclude None values
                 base_item = {k: v for k, v in base_item.items() if v is not None}
 
-                feature = hydrate(base_item, feature)
+                feature = hydrate(
+                    base_item,
+                    feature,
+                    strip_unmatched_markers=settings.exclude_hydrate_markers,
+                )
 
                 # Grab ids needed for links that may be removed by the fields extension.
                 collection_id = feature.get("collection")

tests/resources/test_item.py

@@ -1786,7 +1786,9 @@ async def test_item_asset_change(app_client, load_test_data):
         resp.json()["features"][0]["assets"]["red"]["raster:bands"][0]
     )
 
-    # NOTE: `description` is not in the original item but in the collection's item-assets
-    # We get "𒍟※" because PgSTAC set it when ingesting (`description`is item-assets)
-    # because we removed item-assets, pgstac cannot hydrate this field, and thus return "𒍟※"
-    assert resp.json()["features"][0]["assets"]["qa_pixel"]["description"] == "𒍟※"
+    # Only run this test for PgSTAC hydratation because `exclude_hydrate_markers=True` by default
+    if not app_client._transport.app.state.settings.use_api_hydrate:
+        # NOTE: `description` is not in the original item but in the collection's item-assets
+        # We get "𒍟※" because PgSTAC set it when ingesting (`description`is item-assets)
+        # because we removed item-assets, pgstac cannot hydrate this field, and thus return "𒍟※"
+        assert resp.json()["features"][0]["assets"]["qa_pixel"]["description"] == "𒍟※"