stac-fastapi-core 6.5.1__py3-none-any.whl → 6.7.0__py3-none-any.whl

stac_fastapi/core/redis_utils.py

@@ -0,0 +1,301 @@
+"""Utilities for connecting to and managing Redis connections."""
+
+import json
+import logging
+from typing import List, Optional, Tuple
+from urllib.parse import parse_qs, urlencode, urlparse, urlunparse
+
+from pydantic import field_validator
+from pydantic_settings import BaseSettings
+from redis import asyncio as aioredis
+from redis.asyncio.sentinel import Sentinel
+
+logger = logging.getLogger(__name__)
+
+
+class RedisSentinelSettings(BaseSettings):
+    """Configuration for connecting to Redis Sentinel."""
+
+    REDIS_SENTINEL_HOSTS: str = ""
+    REDIS_SENTINEL_PORTS: str = "26379"
+    REDIS_SENTINEL_MASTER_NAME: str = "master"
+    REDIS_DB: int = 15
+
+    REDIS_MAX_CONNECTIONS: int = 10
+    REDIS_RETRY_TIMEOUT: bool = True
+    REDIS_DECODE_RESPONSES: bool = True
+    REDIS_CLIENT_NAME: str = "stac-fastapi-app"
+    REDIS_HEALTH_CHECK_INTERVAL: int = 30
+    REDIS_SELF_LINK_TTL: int = 1800
+
+    @field_validator("REDIS_DB")
+    @classmethod
+    def validate_db_sentinel(cls, v: int) -> int:
+        """Validate REDIS_DB is not negative integer."""
+        if v < 0:
+            raise ValueError("REDIS_DB must be a positive integer")
+        return v
+
+    @field_validator("REDIS_MAX_CONNECTIONS")
+    @classmethod
+    def validate_max_connections_sentinel(cls, v: int) -> int:
+        """Validate REDIS_MAX_CONNECTIONS is at least 1."""
+        if v < 1:
+            raise ValueError("REDIS_MAX_CONNECTIONS must be at least 1")
+        return v
+
+    @field_validator("REDIS_HEALTH_CHECK_INTERVAL")
+    @classmethod
+    def validate_health_check_interval_sentinel(cls, v: int) -> int:
+        """Validate REDIS_HEALTH_CHECK_INTERVAL is not negative integer."""
+        if v < 0:
+            raise ValueError("REDIS_HEALTH_CHECK_INTERVAL must be a positive integer")
+        return v
+
+    @field_validator("REDIS_SELF_LINK_TTL")
+    @classmethod
+    def validate_self_link_ttl_sentinel(cls, v: int) -> int:
+        """Validate REDIS_SELF_LINK_TTL is not a negative integer."""
+        if v < 0:
+            raise ValueError("REDIS_SELF_LINK_TTL must be a positive integer")
+        return v
+
+    def get_sentinel_hosts(self) -> List[str]:
+        """Parse Redis Sentinel hosts from string to list."""
+        if not self.REDIS_SENTINEL_HOSTS:
+            return []
+
+        if self.REDIS_SENTINEL_HOSTS.strip().startswith("["):
+            return json.loads(self.REDIS_SENTINEL_HOSTS)
+        else:
+            return [
+                h.strip() for h in self.REDIS_SENTINEL_HOSTS.split(",") if h.strip()
+            ]
+
+    def get_sentinel_ports(self) -> List[int]:
+        """Parse Redis Sentinel ports from string to list of integers."""
+        if not self.REDIS_SENTINEL_PORTS:
+            return [26379]
+
+        if self.REDIS_SENTINEL_PORTS.strip().startswith("["):
+            return json.loads(self.REDIS_SENTINEL_PORTS)
+        else:
+            ports_str_list = [
+                p.strip() for p in self.REDIS_SENTINEL_PORTS.split(",") if p.strip()
+            ]
+            return [int(port) for port in ports_str_list]
+
+    def get_sentinel_nodes(self) -> List[Tuple[str, int]]:
+        """Get list of (host, port) tuples for Sentinel connection."""
+        hosts = self.get_sentinel_hosts()
+        ports = self.get_sentinel_ports()
+
+        if not hosts:
+            return []
+
+        if len(ports) == 1 and len(hosts) > 1:
+            ports = ports * len(hosts)
+
+        if len(hosts) != len(ports):
+            raise ValueError(
+                f"Mismatch between hosts ({len(hosts)}) and ports ({len(ports)})"
+            )
+
+        return [(str(host), int(port)) for host, port in zip(hosts, ports)]
+
+
+class RedisSettings(BaseSettings):
+    """Configuration for connecting Redis."""
+
+    REDIS_HOST: str = ""
+    REDIS_PORT: int = 6379
+    REDIS_DB: int = 15
+
+    REDIS_MAX_CONNECTIONS: int = 10
+    REDIS_RETRY_TIMEOUT: bool = True
+    REDIS_DECODE_RESPONSES: bool = True
+    REDIS_CLIENT_NAME: str = "stac-fastapi-app"
+    REDIS_HEALTH_CHECK_INTERVAL: int = 30
+    REDIS_SELF_LINK_TTL: int = 1800
+
+    @field_validator("REDIS_PORT")
+    @classmethod
+    def validate_port_standalone(cls, v: int) -> int:
+        """Validate REDIS_PORT is not a negative integer."""
+        if v < 0:
+            raise ValueError("REDIS_PORT must be a positive integer")
+        return v
+
+    @field_validator("REDIS_DB")
+    @classmethod
+    def validate_db_standalone(cls, v: int) -> int:
+        """Validate REDIS_DB is not a negative integer."""
+        if v < 0:
+            raise ValueError("REDIS_DB must be a positive integer")
+        return v
+
+    @field_validator("REDIS_MAX_CONNECTIONS")
+    @classmethod
+    def validate_max_connections_standalone(cls, v: int) -> int:
+        """Validate REDIS_MAX_CONNECTIONS is at least 1."""
+        if v < 1:
+            raise ValueError("REDIS_MAX_CONNECTIONS must be at least 1")
+        return v
+
+    @field_validator("REDIS_HEALTH_CHECK_INTERVAL")
+    @classmethod
+    def validate_health_check_interval_standalone(cls, v: int) -> int:
+        """Validate REDIS_HEALTH_CHECK_INTERVAL is not a negative."""
+        if v < 0:
+            raise ValueError("REDIS_HEALTH_CHECK_INTERVAL must be a positive integer")
+        return v
+
+    @field_validator("REDIS_SELF_LINK_TTL")
+    @classmethod
+    def validate_self_link_ttl_standalone(cls, v: int) -> int:
+        """Validate REDIS_SELF_LINK_TTL is negative."""
+        if v < 0:
+            raise ValueError("REDIS_SELF_LINK_TTL must be a positive integer")
+        return v
+
+
+# Configure only one Redis configuration
+sentinel_settings = RedisSentinelSettings()
+standalone_settings = RedisSettings()
+
+
+async def connect_redis() -> Optional[aioredis.Redis]:
+    """Return a Redis connection Redis or Redis Sentinel."""
+    try:
+        if sentinel_settings.REDIS_SENTINEL_HOSTS:
+            sentinel_nodes = sentinel_settings.get_sentinel_nodes()
+            sentinel = Sentinel(
+                sentinel_nodes,
+                decode_responses=sentinel_settings.REDIS_DECODE_RESPONSES,
+            )
+
+            redis = sentinel.master_for(
+                service_name=sentinel_settings.REDIS_SENTINEL_MASTER_NAME,
+                db=sentinel_settings.REDIS_DB,
+                decode_responses=sentinel_settings.REDIS_DECODE_RESPONSES,
+                retry_on_timeout=sentinel_settings.REDIS_RETRY_TIMEOUT,
+                client_name=sentinel_settings.REDIS_CLIENT_NAME,
+                max_connections=sentinel_settings.REDIS_MAX_CONNECTIONS,
+                health_check_interval=sentinel_settings.REDIS_HEALTH_CHECK_INTERVAL,
+            )
+            logger.info("Connected to Redis Sentinel")
+
+        elif standalone_settings.REDIS_HOST:
+            pool = aioredis.ConnectionPool(
+                host=standalone_settings.REDIS_HOST,
+                port=standalone_settings.REDIS_PORT,
+                db=standalone_settings.REDIS_DB,
+                max_connections=standalone_settings.REDIS_MAX_CONNECTIONS,
+                decode_responses=standalone_settings.REDIS_DECODE_RESPONSES,
+                retry_on_timeout=standalone_settings.REDIS_RETRY_TIMEOUT,
+                health_check_interval=standalone_settings.REDIS_HEALTH_CHECK_INTERVAL,
+            )
+            redis = aioredis.Redis(
+                connection_pool=pool, client_name=standalone_settings.REDIS_CLIENT_NAME
+            )
+            logger.info("Connected to Redis")
+        else:
+            logger.warning("No Redis configuration found")
+            return None
+
+        return redis
+
+    except aioredis.ConnectionError as e:
+        logger.error(f"Redis connection error: {e}")
+        return None
+    except aioredis.AuthenticationError as e:
+        logger.error(f"Redis authentication error: {e}")
+        return None
+    except aioredis.TimeoutError as e:
+        logger.error(f"Redis timeout error: {e}")
+        return None
+    except Exception as e:
+        logger.error(f"Failed to connect to Redis: {e}")
+        return None
+
+
+def get_redis_key(url: str, token: str) -> str:
+    """Create Redis key using URL path and token."""
+    parsed = urlparse(url)
+    return f"nav:{parsed.path}:{token}"
+
+
+def build_url_with_token(base_url: str, token: str) -> str:
+    """Build URL with token parameter."""
+    parsed = urlparse(base_url)
+    query_params = parse_qs(parsed.query)
+
+    query_params["token"] = [token]
+
+    new_query = urlencode(query_params, doseq=True)
+
+    return urlunparse(
+        (
+            parsed.scheme,
+            parsed.netloc,
+            parsed.path,
+            parsed.params,
+            new_query,
+            parsed.fragment,
+        )
+    )
+
+
+async def save_prev_link(
+    redis: aioredis.Redis, next_url: str, current_url: str, next_token: str
+) -> None:
+    """Save the current page as the previous link for the next URL."""
+    if next_url and next_token:
+        if sentinel_settings.REDIS_SENTINEL_HOSTS:
+            ttl_seconds = sentinel_settings.REDIS_SELF_LINK_TTL
+        elif standalone_settings.REDIS_HOST:
+            ttl_seconds = standalone_settings.REDIS_SELF_LINK_TTL
+        key = get_redis_key(next_url, next_token)
+        await redis.setex(key, ttl_seconds, current_url)
+
+
+async def get_prev_link(
+    redis: aioredis.Redis, current_url: str, current_token: str
+) -> Optional[str]:
+    """Get the previous page link for the current token."""
+    if not current_url or not current_token:
+        return None
+    key = get_redis_key(current_url, current_token)
+    return await redis.get(key)
+
+
+async def redis_pagination_links(
+    current_url: str, token: str, next_token: str, links: list
+) -> None:
+    """Handle Redis pagination."""
+    redis = await connect_redis()
+    if not redis:
+        logger.warning("Redis connection failed.")
+        return
+
+    try:
+        if next_token:
+            next_url = build_url_with_token(current_url, next_token)
+            await save_prev_link(redis, next_url, current_url, next_token)
+
+        if token:
+            prev_link = await get_prev_link(redis, current_url, token)
+            if prev_link:
+                links.insert(
+                    0,
+                    {
+                        "rel": "previous",
+                        "type": "application/json",
+                        "method": "GET",
+                        "href": prev_link,
+                    },
+                )
+    except Exception as e:
+        logger.warning(f"Redis pagination operation failed: {e}")
+    finally:
+        await redis.close()

stac_fastapi/core/serializers.py

@@ -1,6 +1,7 @@
 """Serializers."""
 
 import abc
+import logging
 from copy import deepcopy
 from typing import Any, List, Optional
 
@@ -13,6 +14,8 @@ from stac_fastapi.core.utilities import get_bool_env
 from stac_fastapi.types import stac as stac_types
 from stac_fastapi.types.links import ItemLinks, resolve_links
 
+logger = logging.getLogger(__name__)
+
 
 @attr.s
 class Serializer(abc.ABC):
@@ -168,6 +171,9 @@ class CollectionSerializer(Serializer):
         # Avoid modifying the input dict in-place ... doing so breaks some tests
         collection = deepcopy(collection)
 
+        # Remove internal bbox_shape field (not part of STAC spec)
+        collection.pop("bbox_shape", None)
+
         # Set defaults
         collection_id = collection.get("id")
         collection.setdefault("type", "Collection")

stac_fastapi/core/utilities.py

@@ -10,15 +10,7 @@ from typing import Any, Dict, List, Optional, Set, Union
 
 from stac_fastapi.types.stac import Item
 
-
-def get_max_limit():
-    """
-    Retrieve a MAX_LIMIT value from an environment variable.
-
-    Returns:
-        int: The int value parsed from the environment variable.
-    """
-    return int(os.getenv("ENV_MAX_LIMIT", 10000))
+MAX_LIMIT = 10000
 
 
 def get_bool_env(name: str, default: Union[bool, str] = False) -> bool:

stac_fastapi/core/version.py

@@ -1,2 +1,2 @@
 """library version."""
-__version__ = "6.5.1"
+__version__ = "6.7.0"

stac_fastapi_core-6.7.0.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: stac_fastapi_core
+Version: 6.7.0
+Summary: Core library for the Elasticsearch and Opensearch stac-fastapi backends.
+Project-URL: Homepage, https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
+License: MIT
+Keywords: Elasticsearch,FastAPI,Opensearch,STAC,STAC-API,stac-fastapi
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Requires-Dist: attrs>=23.2.0
+Requires-Dist: fastapi~=0.109.0
+Requires-Dist: geojson-pydantic~=1.0.0
+Requires-Dist: jsonschema~=4.0.0
+Requires-Dist: orjson~=3.11.0
+Requires-Dist: overrides~=7.4.0
+Requires-Dist: pydantic<3.0.0,>=2.4.1
+Requires-Dist: pygeofilter~=0.3.1
+Requires-Dist: redis==6.4.0
+Requires-Dist: slowapi~=0.1.9
+Requires-Dist: stac-fastapi-api==6.0.0
+Requires-Dist: stac-fastapi-extensions==6.0.0
+Requires-Dist: stac-fastapi-types==6.0.0
+Requires-Dist: stac-pydantic~=3.3.0
+Description-Content-Type: text/markdown
+
+# stac-fastapi-core
+
+<p align="left">
+  <img src="https://raw.githubusercontent.com/stac-utils/stac-fastapi-elasticsearch-opensearch/refs/heads/main/assets/sfeos.png" width=1000>
+</p>
+
+  [![Downloads](https://static.pepy.tech/badge/stac-fastapi-core?color=blue)](https://pepy.tech/project/stac-fastapi-core)
+  [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-fastapi-elasticsearch-opensearch?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/graphs/contributors)
+  [![GitHub stars](https://img.shields.io/github/stars/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/stargazers)
+  [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/network/members)
+   [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/)
+  [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
+  [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
+
+Core functionality for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
+
+## Package Information
+
+- **Package name**: stac-fastapi-core
+- **Description**: Core functionality for STAC API implementations.
+- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
+- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/)
+
+## Installation
+
+```bash
+pip install stac-fastapi-core
+```
+
+## Quick Start
+
+For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/).

{stac_fastapi_core-6.5.1.dist-info → stac_fastapi_core-6.7.0.dist-info}/RECORD

@@ -1,25 +1,25 @@
 stac_fastapi/core/__init__.py,sha256=8izV3IWRGdXmDOK1hIPQAanbWs9EI04PJCGgqG1ZGIs,20
-stac_fastapi/core/base_database_logic.py,sha256=nhj0CZNur_SRs4GtXTER-Zjq8JPub5zINiCKbCjw0Bs,3814
+stac_fastapi/core/base_database_logic.py,sha256=3_XJ_j06ogQHE-Tcjkv5Vye_zNDn9OEU9lNYU03am1k,4618
 stac_fastapi/core/base_settings.py,sha256=R3_Sx7n5XpGMs3zAwFJD7y008WvGU_uI2xkaabm82Kg,239
 stac_fastapi/core/basic_auth.py,sha256=RhFv3RVSHF6OaqnaaU2DO4ncJ_S5nB1q8UNpnVJJsrk,2155
-stac_fastapi/core/core.py,sha256=D_TUtcPnLKWDLnY-oPw5jsmqoA2ghLqPPs6H56c4myc,48369
+stac_fastapi/core/core.py,sha256=0_H0QKQN-fkvzAidqGt8MvYfO2f_OF82pXXYs9HpQ_4,50387
 stac_fastapi/core/datetime_utils.py,sha256=TrTgbU7AKNC-ic4a3HptfE5XAc9tHR7uJasZyhOuwnc,2633
 stac_fastapi/core/rate_limit.py,sha256=Gu8dAaJReGsj1L91U6m2tflU6RahpXDRs2-AYSKoybA,1318
+stac_fastapi/core/redis_utils.py,sha256=hoghKhq7eHkqttU6T_Yq6uSWPPfgFjz9HrN8nMLJqNo,10440
 stac_fastapi/core/route_dependencies.py,sha256=hdtuMkv-zY1vg0YxiCz1aKP0SbBcORqDGEKDGgEazW8,5482
-stac_fastapi/core/serializers.py,sha256=HU7sVSMa6w_F_qs_gdAeIFZ18GW-6t8ZHFmgI4-1uNw,7455
+stac_fastapi/core/serializers.py,sha256=ZW5hPgq-mftk6zxJeZGur-1Qxn7YGc3fJYFLsd-SYwM,7619
 stac_fastapi/core/session.py,sha256=aXqu4LXfVbAAsChMVXd9gAhczA2bZPne6HqPeklAwMY,474
-stac_fastapi/core/utilities.py,sha256=WbspaJey_Cs-7TrBKasdqq7yjB7vjKiU01KyJM0m8_E,7506
-stac_fastapi/core/version.py,sha256=FuGC3fKnAmD4Wk95swJ6qCVBs5mZiShrlRKuSH-voyE,45
+stac_fastapi/core/utilities.py,sha256=xXWO5oJCNDi7_C5jPYlHZD0B-DL-FN66eEUBUSW-cXw,7296
+stac_fastapi/core/version.py,sha256=GMc7YzxyWeUVpr_RMVlweeoH2lCLxOWemF-FOkqKXx8,45
 stac_fastapi/core/extensions/__init__.py,sha256=zSIAqou8jnakWPbkh4Ddcx1-oazZVBOs7U2PAakAdU0,291
 stac_fastapi/core/extensions/aggregation.py,sha256=v1hUHqlYuMqfQ554g3cTp16pUyRYucQxPERbHPAFtf8,1878
-stac_fastapi/core/extensions/collections_search.py,sha256=q7eRBykEqNRCiTfkmM_TobqKkxA3n1zQ7dYo37juE6s,6503
+stac_fastapi/core/extensions/collections_search.py,sha256=xpv51nffMq5a8grNSaLbv2IzeI5JH_pqcoWRbWhzn6Y,14406
 stac_fastapi/core/extensions/fields.py,sha256=NCT5XHvfaf297eDPNaIFsIzvJnbbUTpScqF0otdx0NA,1066
 stac_fastapi/core/extensions/filter.py,sha256=-NQGME7rR_ereuDx-LAa1M5JhEXFaKiTtkH2asraYHE,2998
 stac_fastapi/core/extensions/query.py,sha256=Xmo8pfZEZKPudZEjjozv3R0wLOP0ayjC9E67sBOXqWY,1803
 stac_fastapi/core/models/__init__.py,sha256=g-D1DiGfmC9Bg27DW9JzkN6fAvscv75wyhyiZ6NzvIk,48
 stac_fastapi/core/models/links.py,sha256=0dWSEMt3aa7NCISlHwo11zLBeIV1LwXG3JGjrXC3dZI,6672
 stac_fastapi/core/models/search.py,sha256=7SgAUyzHGXBXSqB4G6cwq9FMwoAS00momb7jvBkjyow,27
-stac_fastapi_core-6.5.1.dist-info/METADATA,sha256=PIBVPUY1dqhKMj_JDMOUYuyLoSa8mDoLuUpfI_sjKcU,41746
-stac_fastapi_core-6.5.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-stac_fastapi_core-6.5.1.dist-info/top_level.txt,sha256=vqn-D9-HsRPTTxy0Vk_KkDmTiMES4owwBQ3ydSZYb2s,13
-stac_fastapi_core-6.5.1.dist-info/RECORD,,
+stac_fastapi_core-6.7.0.dist-info/METADATA,sha256=K8U8uKNxI9D5JM_ZIqaOV0wi0TLPgSwK9Qv4ca2VCb4,3494
+stac_fastapi_core-6.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+stac_fastapi_core-6.7.0.dist-info/RECORD,,

{stac_fastapi_core-6.5.1.dist-info → stac_fastapi_core-6.7.0.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.45.1)
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-