update from main

Author: vincentsarago

CHANGES.md

@@ -6,6 +6,12 @@
 
 - move Postgres settings into separate `PostgresSettings` class and defer loading until connecting to database ([#209](https://github.com/stac-utils/stac-fastapi-pgstac/pull/209))
 
+## [4.0.3] - 2025-03-10
+
+### Fixed
+
+- fix links when app is mounted behind proxy or has router-prefix ([#195](https://github.com/stac-utils/stac-fastapi-pgstac/pull/195))
+
 ## [4.0.2] - 2025-02-18
 
 ### Fixed
@@ -387,7 +393,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/4.0.2..main>
+[Unreleased]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/4.0.3..main>
+[4.0.3]: <https://github.com/stac-utils/stac-fastapi-pgstac/compare/4.0.2..4.0.3>
 [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>

RELEASING.md

@@ -6,6 +6,12 @@ This is a checklist for releasing a new version of **stac-fastapi**.
    We currently do not have published versioning guidelines, but there is some text on the subject here: <https://github.com/radiantearth/stac-spec/discussions/1184>.
 2. Create a release branch named `release/vX.Y.Z`, where `X.Y.Z` is the new version.
 3. Search and replace all instances of the current version number with the new version.
+
+   Note: You can use [`bump-my-version`](https://github.com/callowayproject/bump-my-version) CLI
+   ```
+   bump-my-version bump --new-version 3.1.0
+   ```
+
 4. Update [CHANGES.md](./CHANGES.md) for the new version.
    Add the appropriate header, and update the links at the bottom of the file.
 5. Audit CHANGES.md for completeness and accuracy.

VERSION

@@ -1 +1 @@
-4.0.2
+4.0.3

pyproject.toml

@@ -26,3 +26,41 @@ ignore = [
     "E501",  # do not perform function calls in argument defaults
     "B028",  # No explicit `stacklevel` keyword argument found
 ]
+
+
+[tool.bumpversion]
+current_version = "4.0.3"
+parse = """(?x)
+    (?P<major>\\d+)\\.
+    (?P<minor>\\d+)\\.
+    (?P<patch>\\d+)
+    (?:
+        (?P<pre_l>a|b|rc)   # pre-release label
+        (?P<pre_n>\\d+)     # pre-release version number
+    )?                      # pre-release section is optional
+    (?:
+        \\.post
+        (?P<post_n>\\d+)    # post-release version number
+    )?                      # post-release section is optional
+"""
+serialize = [
+    "{major}.{minor}.{patch}.post{post_n}",
+    "{major}.{minor}.{patch}{pre_l}{pre_n}",
+    "{major}.{minor}.{patch}",
+]
+
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+tag = false
+commit = true
+
+[[tool.bumpversion.files]]
+filename = "VERSION"
+search = "{current_version}"
+replace = "{new_version}"
+
+[[tool.bumpversion.files]]
+filename = "stac_fastapi/pgstac/version.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'

setup.py

@@ -10,9 +10,9 @@
     "orjson",
     "pydantic",
     "stac_pydantic==3.1.*",
-    "stac-fastapi.api~=5.0",
-    "stac-fastapi.extensions~=5.0",
-    "stac-fastapi.types~=5.0",
+    "stac-fastapi.api>=5.0,<5.1",
+    "stac-fastapi.extensions>=5.0,<5.1",
+    "stac-fastapi.types>=5.0,<5.1",
     "asyncpg",
     "buildpg",
     "brotli_asgi",

stac_fastapi/pgstac/models/links.py

@@ -51,7 +51,11 @@ def base_url(self):
     @property
     def url(self):
         """Get the current request url."""
-        return str(self.request.url)
+        url = urljoin(str(self.request.base_url), self.request.url.path.lstrip("/"))
+        if qs := self.request.url.query:
+            url += f"?{qs}"
+
+        return url
 
     def resolve(self, url):
         """Resolve url to the current request url."""
@@ -143,7 +147,7 @@ def link_next(self) -> Optional[Dict[str, Any]]:
                     "rel": Relations.next.value,
                     "type": MimeTypes.geojson.value,
                     "method": method,
-                    "href": f"{self.request.url}",
+                    "href": self.url,
                     "body": {**self.request.postbody, "token": f"next:{self.next}"},
                 }
 
@@ -167,7 +171,7 @@ def link_prev(self) -> Optional[Dict[str, Any]]:
                     "rel": Relations.previous.value,
                     "type": MimeTypes.geojson.value,
                     "method": method,
-                    "href": f"{self.request.url}",
+                    "href": self.url,
                     "body": {**self.request.postbody, "token": f"prev:{self.prev}"},
                 }
         return None

stac_fastapi/pgstac/version.py

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

tests/api/test_links.py

@@ -0,0 +1,106 @@
+import pytest
+from fastapi import APIRouter, FastAPI
+from starlette.requests import Request
+from starlette.testclient import TestClient
+
+from stac_fastapi.pgstac.models import links as app_links
+
+
+@pytest.mark.parametrize("root_path", ["", "/api/v1"])
+@pytest.mark.parametrize("prefix", ["", "/stac"])
+def tests_app_links(prefix, root_path):  # noqa: C901
+    endpoint_prefix = root_path + prefix
+    url_prefix = "http://stac.io" + endpoint_prefix
+
+    app = FastAPI(root_path=root_path)
+    router = APIRouter(prefix=prefix)
+    app.state.router_prefix = router.prefix
+
+    @router.get("/search")
+    @router.post("/search")
+    async def search(request: Request):
+        links = app_links.PagingLinks(request, next="yo:2", prev="yo:1")
+        return {
+            "url": links.url,
+            "base_url": links.base_url,
+            "links": await links.get_links(),
+        }
+
+    @router.get("/collections")
+    async def collections(request: Request):
+        pgstac_next = {
+            "rel": "next",
+            "body": {"offset": 1},
+            "href": "./collections",
+            "type": "application/json",
+            "merge": True,
+            "method": "GET",
+        }
+        pgstac_prev = {
+            "rel": "prev",
+            "body": {"offset": 0},
+            "href": "./collections",
+            "type": "application/json",
+            "merge": True,
+            "method": "GET",
+        }
+        links = app_links.CollectionSearchPagingLinks(
+            request, next=pgstac_next, prev=pgstac_prev
+        )
+        return {
+            "url": links.url,
+            "base_url": links.base_url,
+            "links": await links.get_links(),
+        }
+
+    app.include_router(router)
+
+    with TestClient(
+        app,
+        base_url="http://stac.io",
+        root_path=root_path,
+    ) as client:
+        response = client.get(f"{prefix}/search")
+        assert response.status_code == 200
+        assert response.json()["url"] == url_prefix + "/search"
+        assert response.json()["base_url"].rstrip("/") == url_prefix
+        links = response.json()["links"]
+        for link in links:
+            if link["rel"] in ["previous", "next"]:
+                assert link["method"] == "GET"
+            assert link["href"].startswith(url_prefix)
+        assert {"next", "previous", "root", "self"} == {link["rel"] for link in links}
+
+        response = client.get(f"{prefix}/search", params={"limit": 1})
+        assert response.status_code == 200
+        assert response.json()["url"] == url_prefix + "/search?limit=1"
+        assert response.json()["base_url"].rstrip("/") == url_prefix
+        links = response.json()["links"]
+        for link in links:
+            if link["rel"] in ["previous", "next"]:
+                assert link["method"] == "GET"
+                assert "limit=1" in link["href"]
+            assert link["href"].startswith(url_prefix)
+        assert {"next", "previous", "root", "self"} == {link["rel"] for link in links}
+
+        response = client.post(f"{prefix}/search", json={})
+        assert response.status_code == 200
+        assert response.json()["url"] == url_prefix + "/search"
+        assert response.json()["base_url"].rstrip("/") == url_prefix
+        links = response.json()["links"]
+        for link in links:
+            if link["rel"] in ["previous", "next"]:
+                assert link["method"] == "POST"
+            assert link["href"].startswith(url_prefix)
+        assert {"next", "previous", "root", "self"} == {link["rel"] for link in links}
+
+        response = client.get(f"{prefix}/collections")
+        assert response.status_code == 200
+        assert response.json()["url"] == url_prefix + "/collections"
+        assert response.json()["base_url"].rstrip("/") == url_prefix
+        links = response.json()["links"]
+        for link in links:
+            if link["rel"] in ["previous", "next"]:
+                assert link["method"] == "GET"
+            assert link["href"].startswith(url_prefix)
+        assert {"next", "previous", "root", "self"} == {link["rel"] for link in links}

tests/conftest.py

@@ -1,4 +1,3 @@
-import asyncio
 import json
 import logging
 import os
@@ -62,11 +61,6 @@
 )
 
 
-@pytest.fixture(scope="session")
-def event_loop():
-    return asyncio.get_event_loop()
-
-
 @pytest.fixture(scope="session")
 def database(postgresql_proc):
     with DatabaseJanitor(