|
| 1 | +"""Utilities for connecting to and managing Redis connections.""" |
| 2 | + |
| 3 | +import logging |
| 4 | +from typing import Optional |
| 5 | + |
| 6 | +from pydantic_settings import BaseSettings |
| 7 | +from redis import asyncio as aioredis |
| 8 | +from redis.asyncio.sentinel import Sentinel |
| 9 | + |
| 10 | +logger = logging.getLogger(__name__) |
| 11 | +redis_pool: Optional[aioredis.Redis] = None |
| 12 | + |
| 13 | + |
| 14 | +class RedisSentinelSettings(BaseSettings): |
| 15 | + """Configuration for connecting to Redis Sentinel.""" |
| 16 | + |
| 17 | + REDIS_SENTINEL_HOSTS: str = "" |
| 18 | + REDIS_SENTINEL_PORTS: str = "26379" |
| 19 | + REDIS_SENTINEL_MASTER_NAME: str = "master" |
| 20 | + REDIS_DB: int = 15 |
| 21 | + |
| 22 | + REDIS_MAX_CONNECTIONS: int = 10 |
| 23 | + REDIS_RETRY_TIMEOUT: bool = True |
| 24 | + REDIS_DECODE_RESPONSES: bool = True |
| 25 | + REDIS_CLIENT_NAME: str = "stac-fastapi-app" |
| 26 | + REDIS_HEALTH_CHECK_INTERVAL: int = 30 |
| 27 | + |
| 28 | + |
| 29 | +class RedisSettings(BaseSettings): |
| 30 | + """Configuration for connecting Redis Sentinel.""" |
| 31 | + |
| 32 | + REDIS_HOST: str = "" |
| 33 | + REDIS_PORT: int = 6379 |
| 34 | + REDIS_DB: int = 0 |
| 35 | + |
| 36 | + REDIS_MAX_CONNECTIONS: int = 10 |
| 37 | + REDIS_RETRY_TIMEOUT: bool = True |
| 38 | + REDIS_DECODE_RESPONSES: bool = True |
| 39 | + REDIS_CLIENT_NAME: str = "stac-fastapi-app" |
| 40 | + REDIS_HEALTH_CHECK_INTERVAL: int = 30 |
| 41 | + |
| 42 | + |
| 43 | +# Select the Redis or Redis Sentinel configuration |
| 44 | +redis_settings: BaseSettings = RedisSentinelSettings() |
| 45 | + |
| 46 | + |
| 47 | +async def connect_redis(settings: Optional[RedisSettings] = None) -> aioredis.Redis: |
| 48 | + """Return a Redis connection.""" |
| 49 | + global redis_pool |
| 50 | + settings = settings or redis_settings |
| 51 | + |
| 52 | + if redis_pool is None: |
| 53 | + pool = aioredis.ConnectionPool( |
| 54 | + host=settings.REDIS_HOST, |
| 55 | + port=settings.REDIS_PORT, |
| 56 | + db=settings.REDIS_DB, |
| 57 | + max_connections=settings.REDIS_MAX_CONNECTIONS, |
| 58 | + decode_responses=settings.REDIS_DECODE_RESPONSES, |
| 59 | + retry_on_timeout=settings.REDIS_RETRY_TIMEOUT, |
| 60 | + health_check_interval=settings.REDIS_HEALTH_CHECK_INTERVAL, |
| 61 | + ) |
| 62 | + redis_pool = aioredis.Redis( |
| 63 | + connection_pool=pool, client_name=settings.REDIS_CLIENT_NAME |
| 64 | + ) |
| 65 | + return redis_pool |
| 66 | + |
| 67 | + |
| 68 | +async def connect_redis_sentinel( |
| 69 | + settings: Optional[RedisSentinelSettings] = None, |
| 70 | +) -> Optional[aioredis.Redis]: |
| 71 | + """Return a Redis Sentinel connection.""" |
| 72 | + global redis_pool |
| 73 | + |
| 74 | + settings = settings or redis_settings |
| 75 | + |
| 76 | + if not settings.REDIS_SENTINEL_HOSTS or not settings.REDIS_SENTINEL_PORTS or not settings.REDIS_SENTINEL_MASTER_NAME: |
| 77 | + return None |
| 78 | + |
| 79 | + hosts = [h.strip() for h in settings.REDIS_SENTINEL_HOSTS.split(",") if h.strip()] |
| 80 | + ports = [ |
| 81 | + int(p.strip()) for p in settings.REDIS_SENTINEL_PORTS.split(",") if p.strip() |
| 82 | + ] |
| 83 | + |
| 84 | + if redis_pool is None: |
| 85 | + try: |
| 86 | + sentinel = Sentinel( |
| 87 | + [(h, p) for h, p in zip(hosts, ports)], |
| 88 | + decode_responses=settings.REDIS_DECODE_RESPONSES, |
| 89 | + ) |
| 90 | + master = sentinel.master_for( |
| 91 | + service_name=settings.REDIS_SENTINEL_MASTER_NAME, |
| 92 | + db=settings.REDIS_DB, |
| 93 | + decode_responses=settings.REDIS_DECODE_RESPONSES, |
| 94 | + retry_on_timeout=settings.REDIS_RETRY_TIMEOUT, |
| 95 | + client_name=settings.REDIS_CLIENT_NAME, |
| 96 | + max_connections=settings.REDIS_MAX_CONNECTIONS, |
| 97 | + health_check_interval=settings.REDIS_HEALTH_CHECK_INTERVAL, |
| 98 | + ) |
| 99 | + redis_pool = master |
| 100 | + |
| 101 | + except Exception: |
| 102 | + return None |
| 103 | + |
| 104 | + return redis_pool |
| 105 | + |
| 106 | + |
| 107 | +async def save_self_link( |
| 108 | + redis: aioredis.Redis, token: Optional[str], self_href: str |
| 109 | +) -> None: |
| 110 | + """Save the self link for the current token with 30 min TTL.""" |
| 111 | + if token: |
| 112 | + await redis.setex(f"nav:self:{token}", 1800, self_href) |
| 113 | + |
| 114 | + |
| 115 | +async def get_prev_link(redis: aioredis.Redis, token: Optional[str]) -> Optional[str]: |
| 116 | + """Get the previous page link for the current token (if exists).""" |
| 117 | + if not token: |
| 118 | + return None |
| 119 | + return await redis.get(f"nav:self:{token}") |
0 commit comments