rename settings from POSTGRES_* to PG*

Author: vincentsarago

.github/workflows/cicd.yaml

@@ -90,13 +90,10 @@ jobs:
       - name: Load data and validate
         run: python -m stac_fastapi.pgstac.app & ./scripts/wait-for-it.sh localhost:8080 && python ./scripts/ingest_joplin.py http://localhost:8080 && ./scripts/validate http://localhost:8080
         env:
-          POSTGRES_USER: username
-          POSTGRES_PASS: password
-          POSTGRES_DBNAME: postgis
-          POSTGRES_HOST: localhost
-          POSTGRES_PORT: 5432
           PGUSER: username
           PGPASSWORD: password
+          PGHOST: localhost
+          PGPORT: 5432
           PGDATABASE: postgis
           APP_HOST: 0.0.0.0
           APP_PORT: 8080

CHANGES.md

@@ -4,7 +4,34 @@
 
 ### Changed
 
-- rename `POSTGRES_HOST_READER` to `POSTGRES_HOST` in config **breaking change**
+- rename `POSTGRES_HOST_READER` to `PGHOST` in config **breaking change**
+- rename `POSTGRES_USER` to `PGUSER` in config **breaking change**
+- rename `POSTGRES_PASS` to `PGPASSWORD` in config **breaking change**
+- rename `POSTGRES_PORT` to `PGPORT` in config **breaking change**
+- rename `POSTGRES_DBNAME` to `PGDBNAME` in config **breaking change**
+  ```python
+  from stac_fastapi.pgstac.config import PostgresSettings
+
+  # before
+  settings = PostgresSettings(
+      postgres_user="user",
+      postgres_pass="password",
+      postgres_host_reader="0.0.0.0",
+      postgres_host_writer="0.0.0.0",
+      postgres_port=1111,
+      postgres_dbname="pgstac",
+  )
+
+  # now
+  settings = PostgresSettings(
+      pguser="user",
+      pgpassword="password",
+      pghost="0.0.0.0",
+      pgport=1111,
+      pgdatabase="pgstac",
+  )
+  ```
+
 - rename `reader_connection_string` to `connection_string` in `PostgresSettings` class **breaking change**
 - add `ENABLE_TRANSACTIONS_EXTENSIONS` env variable to enable `transaction` extensions
 - disable transaction and bulk_transactions extensions by default **breaking change**

docker-compose.yml

@@ -8,11 +8,11 @@ services:
       - APP_PORT=8082
       - RELOAD=true
       - ENVIRONMENT=local
-      - POSTGRES_USER=username
-      - POSTGRES_PASS=password
-      - POSTGRES_DBNAME=postgis
-      - POSTGRES_HOST=database
-      - POSTGRES_PORT=5432
+      - PGUSER=username
+      - PGPASS=password
+      - PGDATABASE=postgis
+      - PGHOST=database
+      - PGPORT=5432
       - WEB_CONCURRENCY=10
       - VSI_CACHE=TRUE
       - GDAL_HTTP_MERGE_CONSECUTIVE_RANGES=YES

setup.py

@@ -17,6 +17,7 @@
     "brotli_asgi",
     "pygeofilter>=0.2",
     "pypgstac>=0.8,<0.10",
+    "typing_extensions>=4.9.0",
 ]
 
 extra_reqs = {

stac_fastapi/pgstac/config.py

@@ -1,9 +1,10 @@
 """Postgres API configuration."""
 
-from typing import List, Type
+import warnings
+from typing import Annotated, Any, List, Optional, Type
 from urllib.parse import quote_plus as quote
 
-from pydantic import BaseModel, field_validator
+from pydantic import BaseModel, Field, field_validator, model_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 from stac_fastapi.types.config import ApiSettings
 
@@ -61,11 +62,44 @@ class PostgresSettings(BaseSettings):
         invalid_id_chars: list of characters that are not allowed in item or collection ids.
     """
 
-    postgres_user: str
-    postgres_pass: str
-    postgres_host: str
-    postgres_port: int
-    postgres_dbname: str
+    postgres_user: Annotated[
+        Optional[str],
+        Field(
+            deprecated="`postgres_user` is deprecated, please use `pguser`", default=None
+        ),
+    ]
+    postgres_pass: Annotated[
+        Optional[str],
+        Field(
+            deprecated="`postgres_pass` is deprecated, please use `pgpassword`",
+            default=None,
+        ),
+    ]
+    postgres_host: Annotated[
+        Optional[str],
+        Field(
+            deprecated="`postgres_host` is deprecated, please use `pghost`", default=None
+        ),
+    ]
+    postgres_port: Annotated[
+        Optional[int],
+        Field(
+            deprecated="`postgres_port` is deprecated, please use `pgport`", default=None
+        ),
+    ]
+    postgres_dbname: Annotated[
+        Optional[str],
+        Field(
+            deprecated="`postgres_dbname` is deprecated, please use `pgdatabase`",
+            default=None,
+        ),
+    ]
+
+    pguser: str
+    pgpassword: str
+    pghost: str
+    pgport: int
+    pgdatabase: str
 
     db_min_conn_size: int = 1
     db_max_conn_size: int = 10
@@ -76,10 +110,32 @@ class PostgresSettings(BaseSettings):
 
     model_config = {"env_file": ".env", "extra": "ignore"}
 
+    @model_validator(mode="before")
+    @classmethod
+    def _pg_settings_compat(cls, data: Any) -> Any:
+        if isinstance(data, dict):
+            compat = {
+                "postgres_user": "pguser",
+                "postgres_pass": "pgpassword",
+                "postgres_host": "pghost",
+                "postgres_port": "pgport",
+                "postgres_dbname": "pgdatabase",
+            }
+            for old_key, new_key in compat.items():
+                if val := data.get(old_key, None):
+                    warnings.warn(
+                        f"`{old_key}` is deprecated, please use `{new_key}`",
+                        DeprecationWarning,
+                        stacklevel=1,
+                    )
+                    data[new_key] = val
+
+        return data
+
     @property
     def connection_string(self):
         """Create reader psql connection string."""
-        return f"postgresql://{self.postgres_user}:{quote(self.postgres_pass)}@{self.postgres_host}:{self.postgres_port}/{self.postgres_dbname}"
+        return f"postgresql://{self.pguser}:{quote(self.pgpassword)}@{self.pghost}:{self.pgport}/{self.pgdatabase}"
 
 
 class Settings(ApiSettings):

stac_fastapi/pgstac/db.py

@@ -74,7 +74,7 @@ async def connect_to_db(
 
     if add_write_connection_pool:
         if not write_postgres_settings:
-            write_postgres_settings = PostgresSettings()
+            write_postgres_settings = postgres_settings
 
         app.state.writepool = await _create_pool(write_postgres_settings)
 

tests/api/test_api.py

@@ -740,11 +740,11 @@ async def get_collection(
     )
 
     postgres_settings = PostgresSettings(
-        postgres_user=database.user,
-        postgres_pass=database.password,
-        postgres_host=database.host,
-        postgres_port=database.port,
-        postgres_dbname=database.dbname,
+        pguser=database.user,
+        pgpassword=database.password,
+        pghost=database.host,
+        pgport=database.port,
+        pgdatabase=database.dbname,
     )
 
     extensions = [
@@ -773,7 +773,6 @@ async def get_collection(
         app,
         postgres_settings=postgres_settings,
         add_write_connection_pool=True,
-        write_postgres_settings=postgres_settings,
     )
     try:
         async with AsyncClient(transport=ASGITransport(app=app)) as client:
@@ -814,11 +813,11 @@ async def test_no_extension(
         enable_response_models=validation,
     )
     postgres_settings = PostgresSettings(
-        postgres_user=database.user,
-        postgres_pass=database.password,
-        postgres_host=database.host,
-        postgres_port=database.port,
-        postgres_dbname=database.dbname,
+        pguser=database.user,
+        pgpassword=database.password,
+        pghost=database.host,
+        pgport=database.port,
+        pgdatabase=database.dbname,
     )
     extensions = []
     post_request_model = create_post_request_model(extensions, base_model=PgstacSearch)
@@ -833,7 +832,6 @@ async def test_no_extension(
         app,
         postgres_settings=postgres_settings,
         add_write_connection_pool=True,
-        write_postgres_settings=postgres_settings,
     )
     try:
         async with AsyncClient(transport=ASGITransport(app=app)) as client:

tests/clients/test_postgres.py

@@ -527,11 +527,11 @@ async def test_create_bulk_items_id_mismatch(
 
 async def test_db_setup_works_with_env_vars(api_client, database, monkeypatch):
     """Test that the application starts successfully if the POSTGRES_* environment variables are set"""
-    monkeypatch.setenv("POSTGRES_USER", database.user)
-    monkeypatch.setenv("POSTGRES_PASS", database.password)
-    monkeypatch.setenv("POSTGRES_HOST", database.host)
-    monkeypatch.setenv("POSTGRES_PORT", str(database.port))
-    monkeypatch.setenv("POSTGRES_DBNAME", database.dbname)
+    monkeypatch.setenv("PGUSER", database.user)
+    monkeypatch.setenv("PGPASSWORD", database.password)
+    monkeypatch.setenv("PGHOST", database.host)
+    monkeypatch.setenv("PGPORT", str(database.port))
+    monkeypatch.setenv("PGDATABASE", database.dbname)
 
     await connect_to_db(api_client.app)
     await close_db_connection(api_client.app)
@@ -564,11 +564,11 @@ async def app(self, api_client, database):
         app fixture override to setup app with a customized db connection getter
         """
         postgres_settings = PostgresSettings(
-            postgres_user=database.user,
-            postgres_pass=database.password,
-            postgres_host=database.host,
-            postgres_port=database.port,
-            postgres_dbname=database.dbname,
+            pguser=database.user,
+            pgpassword=database.password,
+            pghost=database.host,
+            pgport=database.port,
+            pgdatabase=database.dbname,
         )
 
         logger.debug("Customizing app setup")

tests/conftest.py

@@ -200,11 +200,11 @@ def api_client(request):
 @pytest.fixture(scope="function")
 async def app(api_client, database):
     postgres_settings = PostgresSettings(
-        postgres_user=database.user,
-        postgres_pass=database.password,
-        postgres_host=database.host,
-        postgres_port=database.port,
-        postgres_dbname=database.dbname,
+        pguser=database.user,
+        pgpassword=database.password,
+        pghost=database.host,
+        pgport=database.port,
+        pgdatabase=database.dbname,
     )
     logger.info("Creating app Fixture")
     time.time()
@@ -213,7 +213,6 @@ async def app(api_client, database):
         app,
         postgres_settings=postgres_settings,
         add_write_connection_pool=True,
-        write_postgres_settings=postgres_settings,
     )
 
     yield app
@@ -308,19 +307,18 @@ async def app_no_ext(database):
     )
 
     postgres_settings = PostgresSettings(
-        postgres_user=database.user,
-        postgres_pass=database.password,
-        postgres_host=database.host,
-        postgres_port=database.port,
-        postgres_dbname=database.dbname,
+        pguser=database.user,
+        pgpassword=database.password,
+        pghost=database.host,
+        pgport=database.port,
+        pgdatabase=database.dbname,
     )
     logger.info("Creating app Fixture")
     time.time()
     await connect_to_db(
         api_client_no_ext.app,
         postgres_settings=postgres_settings,
         add_write_connection_pool=True,
-        write_postgres_settings=postgres_settings,
     )
     yield api_client_no_ext.app
     await close_db_connection(api_client_no_ext.app)
@@ -349,11 +347,11 @@ async def app_no_transaction(database):
     )
 
     postgres_settings = PostgresSettings(
-        postgres_user=database.user,
-        postgres_pass=database.password,
-        postgres_host=database.host,
-        postgres_port=database.port,
-        postgres_dbname=database.dbname,
+        pguser=database.user,
+        pgpassword=database.password,
+        pghost=database.host,
+        pgport=database.port,
+        pgdatabase=database.dbname,
     )
     logger.info("Creating app Fixture")
     time.time()
@@ -380,11 +378,11 @@ async def app_client_no_transaction(app_no_transaction):
 @pytest.fixture(scope="function")
 async def default_app(database, monkeypatch):
     """Test default stac-fastapi-pgstac application."""
-    monkeypatch.setenv("POSTGRES_USER", database.user)
-    monkeypatch.setenv("POSTGRES_PASS", database.password)
-    monkeypatch.setenv("POSTGRES_HOST", database.host)
-    monkeypatch.setenv("POSTGRES_PORT", str(database.port))
-    monkeypatch.setenv("POSTGRES_DBNAME", database.dbname)
+    monkeypatch.setenv("PGUSER", database.user)
+    monkeypatch.setenv("PGPASSWORD", database.password)
+    monkeypatch.setenv("PGHOST", database.host)
+    monkeypatch.setenv("PGPORT", str(database.port))
+    monkeypatch.setenv("PGDATABASE", database.dbname)
     monkeypatch.delenv("ENABLED_EXTENSIONS", raising=False)
 
     monkeypatch.setenv("ENABLE_TRANSACTIONS_EXTENSIONS", "TRUE")

tests/resources/test_mgmt.py

@@ -58,11 +58,11 @@ async def test_health_503(database):
 
     # No lifespan so no `get_connection` is application state
     postgres_settings = PostgresSettings(
-        postgres_user=database.user,
-        postgres_pass=database.password,
-        postgres_host=database.host,
-        postgres_port=database.port,
-        postgres_dbname=database.dbname,
+        pguser=database.user,
+        pgpassword=database.password,
+        pghost=database.host,
+        pgport=database.port,
+        pgdatabase=database.dbname,
     )
     # Create connection pool but close it just after
     await connect_to_db(api.app, postgres_settings=postgres_settings)