Merge branch 'main' of https://github.com/stac-utils/stac-fastapi-pgstac into tests/add-paging-links-tests

Author: vincentsarago

.github/workflows/packages.yml

@@ -24,11 +24,11 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@v5.6.1
+        uses: docker/metadata-action@v5.7.0
         with:
           images: ghcr.io/stac-utils/stac-fastapi-pgstac
       - name: Build and push Docker image
-        uses: docker/build-push-action@v6.13.0
+        uses: docker/build-push-action@v6.15.0
         with:
           context: .
           file: Dockerfile

CHANGES.md

@@ -2,6 +2,25 @@
 
 ## [Unreleased]
 
+## [4.0.2] - 2025-02-18
+
+### Fixed
+
+- use Relation's `value` for `POST` prev/next links
+- return `JSONResponse` directly from `/items` endpoint when `fields` parameter is pass and avoid Pydantic validation
+
+### Changed
+
+- avoid re-use of internal `CoreCrudClient.post_search` in `CoreCrudClient.get_search` method to allow customization
+
+## [4.0.1] - 2025-02-06
+
+### Added
+
+- add `numberReturned` and `numberMatched` in `/collections` response
+
+## [4.0.0] - 2025-02-03
+
 ### Changed
 
 - remove `python 3.8` support
@@ -17,6 +36,8 @@
 ### Fixed
 
 - handle `next` and `dev` tokens now returned as links from pgstac>=0.9.0 (author @zstatmanweil, <https://github.com/stac-utils/stac-fastapi-pgstac/pull/140>)
+- fix Docker compose file, so example data can be loaded into database (author @zstatmanweil, <https://github.com/stac-utils/stac-fastapi-pgstac/pull/142>)
+- fix `filter` extension implementation in `CoreCrudClient`
 
 ### Added
 
@@ -27,11 +48,6 @@
 - add [query extension](https://github.com/stac-api-extensions/query) support to Item Collection endpoint ([#162](https://github.com/stac-utils/stac-fastapi-pgstac/pull/192))
 - add [fields extension](https://github.com/stac-api-extensions/fields) support to Item Collection endpoint ([#162](https://github.com/stac-utils/stac-fastapi-pgstac/pull/192))
 
-### Fixed
-
-- fix Docker compose file, so example data can be loaded into database (author @zstatmanweil, <https://github.com/stac-utils/stac-fastapi-pgstac/pull/142>)
-- fix `filter` extension implementation in `CoreCrudClient`
-
 ## [3.0.1] - 2024-11-14
 
 - Enable runtime `CORS` configuration using environment variables (`CORS_ORIGIN="https://...,https://..."`, `CORS_METHODS="PUT,OPTIONS"`) (<https://github.com/stac-utils/stac-fastapi-pgstac/pull/168>)
@@ -367,7 +383,10 @@ As a part of this release, this repository was extracted from the main
 
 - First PyPi release!
 
-[Unreleased]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/3.0.1..main>
+[Unreleased]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/4.0.2..main>
+[4.0.2]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/4.0.1..4.0.2>
+[4.0.1]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/4.0.0..4.0.1>
+[4.0.0]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/3.0.1..4.0.0>
 [3.0.1]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/3.0.0..3.0.1>
 [3.0.0]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/2.5.0..3.0.0>
 [2.5.0]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/2.4.11..2.5.0>

VERSION

@@ -1 +1 @@
-3.0.0
+4.0.2

docker-compose.nginx.yml

@@ -76,6 +76,23 @@ services:
       - database
       - app
 
+  nginx:
+    image: nginx
+    ports:
+      - ${STAC_FASTAPI_NGINX_PORT:-8080}:80
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf
+    depends_on:
+      - app-nginx
+    command: [ "nginx-debug", "-g", "daemon off;" ]
+
+  app-nginx:
+    extends:
+      service: app
+    command: bash -c "./scripts/wait-for-it.sh database:5432 && uvicorn stac_fastapi.pgstac.app:app --host 0.0.0.0 --port 8082 --proxy-headers --forwarded-allow-ips=*"
+    environment:
+      - ROOT_PATH=/api/v1/pgstac
+
 networks:
   default:
     name: stac-fastapi-network

docker-compose.yml

@@ -6,8 +6,8 @@ http {
 
         location /api/v1/pgstac {
             rewrite ^/api/v1/pgstac(.*)$ $1 break;
-            proxy_pass http://app:8082;
-            proxy_set_header HOST $host;
+            proxy_pass http://app-nginx:8082;
+            proxy_set_header HOST $http_host;
             proxy_set_header Referer $http_referer;
             proxy_set_header X-Forwarded-For $remote_addr;
             proxy_set_header X-Forwarded-Proto $scheme;

nginx.conf

@@ -148,6 +148,12 @@ async def all_collections(  # noqa: C901
         return Collections(
             collections=linked_collections or [],
             links=links,
+            numberMatched=collections_result.get(
+                "numberMatched", len(linked_collections)
+            ),
+            numberReturned=collections_result.get(
+                "numberReturned", len(linked_collections)
+            ),
         )
 
     async def get_collection(
@@ -387,15 +393,28 @@ async def item_collection(
             sortby=sortby,
         )
 
-        search_request = self.pgstac_search_model(**clean)
+        try:
+            search_request = self.pgstac_search_model(**clean)
+        except ValidationError as e:
+            raise HTTPException(
+                status_code=400, detail=f"Invalid parameters provided {e}"
+            ) from e
+
         item_collection = await self._search_base(search_request, request=request)
 
         links = await ItemCollectionLinks(
             collection_id=collection_id, request=request
         ).get_links(extra_links=item_collection["links"])
         item_collection["links"] = links
 
-        return item_collection
+        # If we have the `fields` extension enabled
+        # we need to avoid Pydantic validation because the
+        # Items might not be a valid STAC Item objects
+        if fields := getattr(search_request, "fields", None):
+            if fields.include or fields.exclude:
+                return JSONResponse(item_collection)  # type: ignore
+
+        return ItemCollection(**item_collection)
 
     async def get_item(
         self, item_id: str, collection_id: str, request: Request, **kwargs
@@ -494,15 +513,23 @@ async def get_search(
             filter_lang=filter_lang,
         )
 
-        # Do the request
         try:
             search_request = self.pgstac_search_model(**clean)
         except ValidationError as e:
             raise HTTPException(
                 status_code=400, detail=f"Invalid parameters provided {e}"
             ) from e
 
-        return await self.post_search(search_request, request=request)
+        item_collection = await self._search_base(search_request, request=request)
+
+        # If we have the `fields` extension enabled
+        # we need to avoid Pydantic validation because the
+        # Items might not be a valid STAC Item objects
+        if fields := getattr(search_request, "fields", None):
+            if fields.include or fields.exclude:
+                return JSONResponse(item_collection)  # type: ignore
+
+        return ItemCollection(**item_collection)
 
     def _clean_search_args(  # noqa: C901
         self,

stac_fastapi/pgstac/core.py

@@ -140,8 +140,8 @@ def link_next(self) -> Optional[Dict[str, Any]]:
 
             if method == "POST":
                 return {
-                    "rel": Relations.next,
-                    "type": MimeTypes.geojson,
+                    "rel": Relations.next.value,
+                    "type": MimeTypes.geojson.value,
                     "method": method,
                     "href": str(self.request.url),
                     "body": {**self.request.postbody, "token": f"next:{self.next}"},
@@ -164,8 +164,8 @@ def link_prev(self) -> Optional[Dict[str, Any]]:
 
             if method == "POST":
                 return {
-                    "rel": Relations.previous,
-                    "type": MimeTypes.geojson,
+                    "rel": Relations.previous.value,
+                    "type": MimeTypes.geojson.value,
                     "method": method,
                     "href": str(self.request.url),
                     "body": {**self.request.postbody, "token": f"prev:{self.prev}"},

stac_fastapi/pgstac/models/links.py

@@ -1,3 +1,3 @@
 """library version."""
 
-__version__ = "3.0.0"
+__version__ = "4.0.2"

stac_fastapi/pgstac/version.py

@@ -116,6 +116,7 @@ async def test_nocollections(
 ):
     resp = await app_client.get("/collections")
     assert resp.status_code == 200
+    assert resp.json()["numberReturned"] == 0
 
 
 async def test_returns_valid_collection(app_client, load_test_data):
@@ -168,6 +169,9 @@ async def test_returns_valid_links_in_collections(app_client, load_test_data):
     resp = await app_client.get("/collections")
     assert resp.status_code == 200
     resp_json = resp.json()
+    assert resp.json()["numberReturned"]
+    assert resp.json()["numberMatched"]
+
     collections = resp_json["collections"]
     # Find collection in list by ID
     single_coll = next(coll for coll in collections if coll["id"] == in_json["id"])
@@ -317,6 +321,8 @@ async def test_collection_search_freetext(
         "/collections",
         params={"q": "temperature"},
     )
+    assert resp.json()["numberReturned"] == 1
+    assert resp.json()["numberMatched"] == 1
     assert len(resp.json()["collections"]) == 1
     assert resp.json()["collections"][0]["id"] == load_test2_collection.id
 
@@ -341,13 +347,17 @@ async def test_all_collections_with_pagination(app_client, load_test_data):
         assert resp.status_code == 201
 
     resp = await app_client.get("/collections")
+    assert resp.json()["numberReturned"] == 10
+    assert resp.json()["numberMatched"] == 12
     cols = resp.json()["collections"]
     assert len(cols) == 10
     links = resp.json()["links"]
     assert len(links) == 3
     assert {"root", "self", "next"} == {link["rel"] for link in links}
 
     resp = await app_client.get("/collections", params={"limit": 12})
+    assert resp.json()["numberReturned"] == 12
+    assert resp.json()["numberMatched"] == 12
     cols = resp.json()["collections"]
     assert len(cols) == 12
     links = resp.json()["links"]
@@ -369,6 +379,8 @@ async def test_all_collections_without_pagination(app_client_no_ext, load_test_d
         assert resp.status_code == 201
 
     resp = await app_client_no_ext.get("/collections")
+    assert resp.json()["numberReturned"] == 12
+    assert resp.json()["numberMatched"] == 12
     cols = resp.json()["collections"]
     assert len(cols) == 12
     links = resp.json()["links"]
@@ -382,6 +394,8 @@ async def test_get_collections_search_pagination(
     app_client, load_test_collection, load_test2_collection
 ):
     resp = await app_client.get("/collections")
+    assert resp.json()["numberReturned"] == 2
+    assert resp.json()["numberMatched"] == 2
     cols = resp.json()["collections"]
     assert len(cols) == 2
     links = resp.json()["links"]