Merge branch 'main' of https://github.com/stac-utils/stac-fastapi-pgstac into patch/collection-search-paging

Author: vincentsarago

.github/workflows/cicd.yaml

@@ -11,7 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        include:
+          - {python: '3.12', pypgstac: '0.9.*'}
+          - {python: '3.12', pypgstac: '0.8.*'}
+          - {python: '3.11', pypgstac: '0.8.*'}
+          - {python: '3.9', pypgstac: '0.8.*'}
+          - {python: '3.8', pypgstac: '0.8.*'}
+
     timeout-minutes: 20
 
     steps:
@@ -22,12 +28,12 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: ${{ matrix.python }}
           cache: pip
           cache-dependency-path: setup.py
 
       - name: Lint code
-        if: ${{ matrix.python-version == 3.11 }}
+        if: ${{ matrix.python == 3.11 }}
         run: |
           python -m pip install pre-commit
           pre-commit run --all-files
@@ -39,6 +45,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install .[dev,server]
+          python -m pip install "pypgstac==${{ matrix.pypgstac }}"
 
       - name: Run test suite
         run:  python -m pytest --cov stac_fastapi.pgstac --cov-report xml --cov-report term-missing

.github/workflows/packages.yml

@@ -28,7 +28,7 @@ jobs:
         with:
           images: ghcr.io/stac-utils/stac-fastapi-pgstac
       - name: Build and push Docker image
-        uses: docker/build-push-action@v6.7.0
+        uses: docker/build-push-action@v6.9.0
         with:
           context: .
           file: Dockerfile

CHANGES.md

@@ -3,9 +3,15 @@
 ## [Unreleased]
 
 - Fix Docker compose file, so example data can be loaded into database (author @zstatmanweil, <https://github.com/stac-utils/stac-fastapi-pgstac/pull/142>)
+- 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)
 - Add collection search extension ([#139](https://github.com/stac-utils/stac-fastapi-pgstac/pull/139))
 - keep `/search` and `/collections` extensions separate ([#158](https://github.com/stac-utils/stac-fastapi-pgstac/pull/158))
 - Fix `filter` extension implementation in `CoreCrudClient`
+- update `pypgstac` requirement to `>=0.8,<0.10`
+- set `pypgstac==0.9.*` for test requirements
+
+## [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)
 
 ## [3.0.0] - 2024-08-02
 
@@ -338,7 +344,8 @@ 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.0..main>
+[Unreleased]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/3.0.1..main>
+[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>
 [2.4.11]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/2.4.10..2.4.11>

docker-compose.yml

@@ -46,7 +46,7 @@ services:
 
   database:
     container_name: stac-db
-    image: ghcr.io/stac-utils/pgstac:v0.8.5
+    image: ghcr.io/stac-utils/pgstac:v0.9.1
     environment:
       - POSTGRES_USER=username
       - POSTGRES_PASSWORD=password

setup.py

@@ -17,17 +17,17 @@
     "buildpg",
     "brotli_asgi",
     "pygeofilter>=0.2",
-    "pypgstac==0.8.*",
+    "pypgstac>=0.8,<0.10",
 ]
 
 extra_reqs = {
     "dev": [
         "pystac[validation]",
-        "pypgstac[psycopg]==0.8.*",
+        "pypgstac[psycopg]==0.9.*",
         "pytest-postgresql",
         "pytest",
         "pytest-cov",
-        "pytest-asyncio>=0.17,<0.23.0",
+        "pytest-asyncio>=0.17,<0.25.0",
         "pre-commit",
         "requests",
         "shapely",
@@ -36,7 +36,7 @@
         "wheel",
     ],
     "docs": ["mkdocs", "mkdocs-material", "pdocs"],
-    "server": ["uvicorn[standard]==0.19.0"],
+    "server": ["uvicorn[standard]==0.32.0"],
     "awslambda": ["mangum"],
 }
 

stac_fastapi/pgstac/app.py

@@ -7,8 +7,10 @@
 
 import os
 
+from brotli_asgi import BrotliMiddleware
 from fastapi.responses import ORJSONResponse
 from stac_fastapi.api.app import StacApi
+from stac_fastapi.api.middleware import CORSMiddleware, ProxyHeaderMiddleware
 from stac_fastapi.api.models import (
     EmptyRequest,
     ItemCollectionUri,
@@ -26,6 +28,7 @@
 )
 from stac_fastapi.extensions.core.collection_search import CollectionSearchExtension
 from stac_fastapi.extensions.third_party import BulkTransactionExtension
+from starlette.middleware import Middleware
 
 from stac_fastapi.pgstac.config import Settings
 from stac_fastapi.pgstac.core import CoreCrudClient
@@ -111,6 +114,15 @@
     search_get_request_model=get_request_model,
     search_post_request_model=post_request_model,
     collections_get_request_model=collections_get_request_model,
+    middlewares=[
+        Middleware(BrotliMiddleware),
+        Middleware(ProxyHeaderMiddleware),
+        Middleware(
+            CORSMiddleware,
+            allow_origins=settings.cors_origins,
+            allow_methods=settings.cors_methods,
+        ),
+    ],
 )
 app = api.app
 

stac_fastapi/pgstac/config.py

@@ -3,7 +3,7 @@
 from typing import List, Type
 from urllib.parse import quote_plus as quote
 
-from pydantic import BaseModel
+from pydantic import BaseModel, field_validator
 from pydantic_settings import SettingsConfigDict
 from stac_fastapi.types.config import ApiSettings
 
@@ -75,8 +75,21 @@ class Settings(ApiSettings):
     base_item_cache: Type[BaseItemCache] = DefaultBaseItemCache
     invalid_id_chars: List[str] = DEFAULT_INVALID_ID_CHARS
 
+    cors_origins: str = "*"
+    cors_methods: str = "GET,POST,OPTIONS"
+
     testing: bool = False
 
+    @field_validator("cors_origins")
+    def parse_cors_origin(cls, v):
+        """Parse CORS origins."""
+        return [origin.strip() for origin in v.split(",")]
+
+    @field_validator("cors_methods")
+    def parse_cors_methods(cls, v):
+        """Parse CORS methods."""
+        return [method.strip() for method in v.split(",")]
+
     @property
     def reader_connection_string(self):
         """Create reader psql connection string."""

stac_fastapi/pgstac/core.py

@@ -252,8 +252,17 @@ async def _search_base(  # noqa: C901
                 f"Datetime parameter {search_request.datetime} is invalid."
             ) from e
 
-        next: Optional[str] = items.pop("next", None)
-        prev: Optional[str] = items.pop("prev", None)
+        # Starting in pgstac 0.9.0, the `next` and `prev` tokens are returned in spec-compliant links with method GET
+        next_from_link: Optional[str] = None
+        prev_from_link: Optional[str] = None
+        for link in items.get("links", []):
+            if link.get("rel") == "next":
+                next_from_link = link.get("href").split("token=next:")[1]
+            if link.get("rel") == "prev":
+                prev_from_link = link.get("href").split("token=prev:")[1]
+
+        next: Optional[str] = items.pop("next", next_from_link)
+        prev: Optional[str] = items.pop("prev", prev_from_link)
         collection = ItemCollection(**items)
 
         fields = getattr(search_request, "fields", None)