fix: apply recommendations

Author: Yuri Zmytrakov

.github/workflows/cicd.yml

@@ -66,6 +66,16 @@ jobs:
         ports:
           - 9202:9202
 
+      redis:
+        image: redis:7-alpine
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
     strategy:
       matrix:
         python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13"]
@@ -126,3 +136,6 @@ jobs:
           DATABASE_REFRESH: true
           ES_VERIFY_CERTS: false
           BACKEND: ${{ matrix.backend == 'elasticsearch7' && 'elasticsearch' || matrix.backend == 'elasticsearch8' && 'elasticsearch' || 'opensearch' }}
+          REDIS_ENABLE: true
+          REDIS_HOST: localhost
+          REDIS_PORT: 6379

Makefile

@@ -63,13 +63,15 @@ docker-shell-os:
 
 .PHONY: test-elasticsearch
 test-elasticsearch:
-	-$(run_es) /bin/bash -c 'pip install redis==6.4.0 export && ./scripts/wait-for-it-es.sh elasticsearch:9200 && cd stac_fastapi/tests/ && pytest'
-	docker compose down
+	docker compose -f compose-redis.yml up -d
+	-$(run_es) /bin/bash -c 'export REDIS_ENABLE=true REDIS_HOST=redis REDIS_PORT=6379 && ./scripts/wait-for-it-es.sh elasticsearch:9200 && cd stac_fastapi/tests/ && pytest'
+	docker compose -f compose-redis.yml down
 
-.PHONY: test-opensearch
+.PHONY: test-opensearch  
 test-opensearch:
-	-$(run_os) /bin/bash -c 'pip install redis==6.4.0 export && ./scripts/wait-for-it-es.sh opensearch:9202 && cd stac_fastapi/tests/ && pytest'
-	docker compose down
+	docker compose -f compose-redis.yml up -d
+	-$(run_os) /bin/bash -c 'export REDIS_ENABLE=true REDIS_HOST=redis REDIS_PORT=6379 && ./scripts/wait-for-it-es.sh opensearch:9202 && cd stac_fastapi/tests/ && pytest'
+	docker compose -f compose-redis.yml down
 
 .PHONY: test-datetime-filtering-es
 test-datetime-filtering-es:
@@ -82,7 +84,7 @@ test-datetime-filtering-os:
 	docker compose down
 
 .PHONY: test
-test: test-elasticsearch test-datetime-filtering-es test-opensearch test-datetime-filtering-os
+test: test-elasticsearch test-datetime-filtering-es test-opensearch test-datetime-filtering-os test-redis-es test-redis-os
 
 .PHONY: run-database-es
 run-database-es:
@@ -117,4 +119,16 @@ docs-image:
 .PHONY: docs
 docs: docs-image
 	docker compose -f compose.docs.yml \
-		run docs
+		run docs
+
+.PHONY: test-redis-es
+test-redis-es:
+	docker compose -f compose-redis.yml up -d
+	-$(run_es) /bin/bash -c 'export REDIS_ENABLE=true REDIS_HOST=redis REDIS_PORT=6379 && ./scripts/wait-for-it-es.sh elasticsearch:9200 && cd stac_fastapi/tests/ && pytest redis/ -v'
+	docker compose -f compose-redis.yml down
+
+.PHONY: test-redis-os
+test-redis-os:
+	docker compose -f compose-redis.yml up -d
+	-$(run_os) /bin/bash -c 'export REDIS_ENABLE=true REDIS_HOST=redis REDIS_PORT=6379 && ./scripts/wait-for-it-es.sh opensearch:9202 && cd stac_fastapi/tests/ && pytest redis/ -v'
+	docker compose -f compose-redis.yml down

compose-redis.yml

@@ -0,0 +1,13 @@
+version: '3.8'
+
+services:
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "6379:6379"
+    volumes:
+      - redis_test_data:/data
+    command: redis-server --appendonly yes
+
+volumes:
+  redis_test_data:

stac_fastapi/core/stac_fastapi/core/core.py

@@ -24,14 +24,10 @@
 from stac_fastapi.core.base_settings import ApiBaseSettings
 from stac_fastapi.core.datetime_utils import format_datetime_range
 from stac_fastapi.core.models.links import PagingLinks
-from stac_fastapi.core.redis_utils import (
-    connect_redis_sentinel,
-    get_prev_link,
-    save_self_link,
-)
+from stac_fastapi.core.redis_utils import connect_redis, get_prev_link, save_self_link
 from stac_fastapi.core.serializers import CollectionSerializer, ItemSerializer
 from stac_fastapi.core.session import Session
-from stac_fastapi.core.utilities import filter_fields
+from stac_fastapi.core.utilities import filter_fields, get_bool_env
 from stac_fastapi.extensions.core.transaction import AsyncBaseTransactionsClient
 from stac_fastapi.extensions.core.transaction.request import (
     PartialCollection,
@@ -277,11 +273,13 @@ async def all_collections(
                 sort = parsed_sort
 
         current_url = str(request.url)
-        redis = None
-        try:
-            redis = await connect_redis_sentinel()
-        except Exception:
-            redis = None
+        redis_enable = get_bool_env("REDIS_ENABLE", default=False)
+
+        if redis_enable:
+            try:
+                redis = await connect_redis()
+            except Exception:
+                redis = None
 
         # Convert q to a list if it's a string
         q_list = None
@@ -311,7 +309,7 @@ async def all_collections(
             },
         ]
 
-        if redis:
+        if redis_enable and redis:
             if next_token:
                 await save_self_link(redis, next_token, current_url)
 
@@ -557,10 +555,14 @@ async def post_search(
             HTTPException: If there is an error with the cql2_json filter.
         """
         base_url = str(request.base_url)
-        try:
-            redis = await connect_redis_sentinel()
-        except Exception:
-            redis = None
+        redis_enable = get_bool_env("REDIS_ENABLE", default=False)
+
+        redis = None
+        if redis_enable:
+            try:
+                redis = await connect_redis()
+            except Exception:
+                redis = None
 
         search = self.database.make_search()
 
@@ -690,7 +692,7 @@ async def post_search(
                 )
         links.extend(collection_links)
 
-        if redis:
+        if redis_enable and redis:
             self_link = str(request.url)
             await save_self_link(redis, next_token, self_link)
 

stac_fastapi/core/stac_fastapi/core/redis_utils.py

@@ -39,7 +39,7 @@ class RedisSettings(BaseSettings):
 
 
 # Select the Redis or Redis Sentinel configuration
-redis_settings: BaseSettings = RedisSentinelSettings()
+redis_settings: BaseSettings = RedisSettings()
 
 
 async def connect_redis(settings: Optional[RedisSettings] = None) -> aioredis.Redis:

stac_fastapi/tests/redis/__init__.py

@@ -0,0 +1,80 @@
+import uuid
+
+import pytest
+
+from ..conftest import create_collection, create_item
+
+
+@pytest.mark.asyncio
+async def test_search_pagination_uses_redis_cache(
+    app_client, txn_client, load_test_data
+):
+    """Test Redis caching and navigation for the /search endpoint."""
+
+    collection = load_test_data("test_collection.json")
+    collection_id = f"test-pagination-collection-{uuid.uuid4()}"
+    collection["id"] = collection_id
+    await create_collection(txn_client, collection)
+
+    for i in range(5):
+        item = load_test_data("test_item.json")
+        item["id"] = f"test-pagination-item-{uuid.uuid4()}"
+        item["collection"] = collection_id
+        await create_item(txn_client, item)
+
+    resp = await app_client.post(
+        "/search", json={"collections": [collection_id], "limit": 1}
+    )
+    resp_json = resp.json()
+
+    next_link = next(
+        (link for link in resp_json["links"] if link["rel"] == "next"), None
+    )
+    next_token = next_link["body"]["token"]
+
+    # Expect the previous link on the second page to be retrieved from Redis cache
+    resp2 = await app_client.post(
+        "/search",
+        json={"collections": [collection_id], "limit": 1, "token": next_token},
+    )
+    resp2_json = resp2.json()
+
+    prev_link = next(
+        (link for link in resp2_json["links"] if link["rel"] == "prev"), None
+    )
+    assert prev_link is not None
+
+
+@pytest.mark.asyncio
+async def test_collections_pagination_uses_redis_cache(
+    app_client, txn_client, load_test_data
+):
+    """Test Redis caching and navigation for the /collection endpoint."""
+
+    collection_data = load_test_data("test_collection.json")
+    for i in range(5):
+        collection = collection_data.copy()
+        collection["id"] = f"test-collection-pagination-{uuid.uuid4()}"
+        collection["title"] = f"Test Collection Pagination {i}"
+        await create_collection(txn_client, collection)
+
+    resp = await app_client.get("/collections", params={"limit": 1})
+    assert resp.status_code == 200
+    resp1_json = resp.json()
+
+    next_link = next(
+        (link for link in resp1_json["links"] if link["rel"] == "next"), None
+    )
+    next_token = next_link["href"].split("token=")[1]
+
+    # Expect the previous link on the second page to be retrieved from Redis cache
+    resp2 = await app_client.get(
+        "/collections", params={"limit": 1, "token": next_token}
+    )
+    assert resp2.status_code == 200
+    resp2_json = resp2.json()
+
+    prev_link = next(
+        (link for link in resp2_json["links"] if link["rel"] == "prev"), None
+    )
+    assert prev_link is not None

stac_fastapi/tests/redis/test_redis_pagination.py

@@ -0,0 +1,44 @@
+import pytest
+
+from stac_fastapi.core.redis_utils import connect_redis, get_prev_link, save_self_link
+
+
+@pytest.mark.asyncio
+async def test_redis_connection():
+    """Test Redis connection."""
+    redis = await connect_redis()
+    assert redis is not None
+
+    # Test set/get
+    await redis.set("string_key", "string_value")
+    string_value = await redis.get("string_key")
+    assert string_value == "string_value"
+
+    # Test key retrieval operation
+    exists = await redis.exists("string_key")
+    assert exists == 1
+
+    # Test key deletion
+    await redis.delete("string_key")
+    deleted_value = await redis.get("string_key")
+    assert deleted_value is None
+
+
+@pytest.mark.asyncio
+async def test_redis_utils_functions():
+    redis = await connect_redis()
+    assert redis is not None
+
+    token = "test_token_123"
+    self_link = "http://mywebsite.com/search?token=test_token_123"
+
+    await save_self_link(redis, token, self_link)
+    retrieved_link = await get_prev_link(redis, token)
+    assert retrieved_link == self_link
+
+    await save_self_link(redis, None, "should_not_save")
+    null_result = await get_prev_link(redis, None)
+    assert null_result is None
+
+    non_existent = await get_prev_link(redis, "non_existent_token")
+    assert non_existent is None