fix: implement recommendations

Author: Yuri Zmytrakov

.pre-commit-config.yaml

@@ -31,7 +31,8 @@ repos:
         ]
         additional_dependencies: [
           "types-attrs",
-          "types-requests"
+          "types-requests",
+          "types-redis"
         ]
   - repo: https://github.com/PyCQA/pydocstyle
     rev: 6.1.1

Makefile

@@ -82,7 +82,7 @@ test-datetime-filtering-os:
 	docker compose down
 
 .PHONY: test
-test: test-elasticsearch test-datetime-filtering-es test-opensearch test-datetime-filtering-os test-redis-es test-redis-os
+test: test-elasticsearch test-datetime-filtering-es test-opensearch test-datetime-filtering-os
 
 .PHONY: run-database-es
 run-database-es:
@@ -118,15 +118,3 @@ docs-image:
 docs: docs-image
 	docker compose -f compose.docs.yml \
 		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

@@ -23,6 +23,9 @@ services:
       - BACKEND=elasticsearch
       - DATABASE_REFRESH=true
       - ENABLE_COLLECTIONS_SEARCH_ROUTE=true
+      - REDIS_ENABLE=true
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
     ports:
       - "8080:8080"
     volumes:
@@ -31,6 +34,7 @@ services:
       - ./esdata:/usr/share/elasticsearch/data
     depends_on:
       - elasticsearch
+      - redis
     command:
       bash -c "./scripts/wait-for-it-es.sh es-container:9200 && python -m stac_fastapi.elasticsearch.app"
 
@@ -58,6 +62,9 @@ services:
       - BACKEND=opensearch
       - STAC_FASTAPI_RATE_LIMIT=200/minute
       - ENABLE_COLLECTIONS_SEARCH_ROUTE=true
+      - REDIS_ENABLE=true
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
     ports:
       - "8082:8082"
     volumes:
@@ -66,6 +73,7 @@ services:
       - ./osdata:/usr/share/opensearch/data
     depends_on:
       - opensearch
+      - redis
     command:
       bash -c "./scripts/wait-for-it-es.sh os-container:9202 && python -m stac_fastapi.opensearch.app"
 
@@ -96,3 +104,14 @@ services:
       - ./opensearch/snapshots:/usr/share/opensearch/snapshots
     ports:
       - "9202:9202"
+
+  redis:
+    image: redis:7-alpine
+    hostname: redis
+    ports:
+      - "6379:6379"
+    volumes:
+      - redis_test_data:/data
+    command: redis-server
+volumes:
+  redis_test_data:

compose.yml

@@ -20,6 +20,11 @@
     "jsonschema~=4.0.0",
     "slowapi~=0.1.9",
 ]
+extra_reqs = {
+    "dev": [
+        "redis==6.4.0",
+    ],
+}
 
 setup(
     name="stac_fastapi_core",
@@ -43,4 +48,5 @@
     packages=find_namespace_packages(),
     zip_safe=False,
     install_requires=install_requires,
+    extras_require=extra_reqs,
 )

mypy.ini

@@ -24,7 +24,7 @@
 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, get_prev_link, save_self_link
+from stac_fastapi.core.redis_utils import redis_pagination_links
 from stac_fastapi.core.serializers import CollectionSerializer, ItemSerializer
 from stac_fastapi.core.session import Session
 from stac_fastapi.core.utilities import filter_fields, get_bool_env
@@ -270,6 +270,7 @@ async def all_collections(
             A Collections object containing all the collections in the database and links to various resources.
         """
         base_url = str(request.base_url)
+        redis_enable = get_bool_env("REDIS_ENABLE", default=False)
 
         # Get the global limit from environment variable
         global_limit = None
@@ -329,20 +330,6 @@ async def all_collections(
             if parsed_sort:
                 sort = parsed_sort
 
-        current_url = str(request.url)
-        redis_enable = get_bool_env("REDIS_ENABLE", default=False)
-
-        redis = None
-        if redis_enable:
-            try:
-                redis = await connect_redis()
-                logger.info("Redis connection established successfully")
-            except Exception as e:
-                redis = None
-                logger.warning(
-                    f"Redis connection failed, continuing without Redis: {e}"
-                )
-
         # Convert q to a list if it's a string
         q_list = None
         if q is not None:
@@ -441,21 +428,13 @@ async def all_collections(
             },
         ]
 
-        if redis_enable and redis:
-            if next_token:
-                await save_self_link(redis, next_token, current_url)
-
-            prev_link = await get_prev_link(redis, token)
-            if prev_link:
-                links.insert(
-                    0,
-                    {
-                        "rel": "prev",
-                        "type": "application/json",
-                        "method": "GET",
-                        "href": prev_link,
-                    },
-                )
+        if redis_enable:
+            await redis_pagination_links(
+                current_url=str(request.url),
+                token=token,
+                next_token=next_token,
+                links=links,
+            )
 
         if next_token:
             next_link = PagingLinks(next=next_token, request=request).link_next()
@@ -775,9 +754,8 @@ async def post_search(
             HTTPException: If there is an error with the cql2_json filter.
         """
         base_url = str(request.base_url)
-        redis_enable = get_bool_env("REDIS_ENABLE", default=False)
-
         search = self.database.make_search()
+        redis_enable = get_bool_env("REDIS_ENABLE", default=False)
 
         if search_request.ids:
             search = self.database.apply_ids_filter(
@@ -902,28 +880,12 @@ async def post_search(
         links.extend(collection_links)
 
         if redis_enable:
-            redis = None
-            try:
-                redis = await connect_redis()
-                logger.info("Redis connection established successfully")
-                self_link = str(request.url)
-                await save_self_link(redis, next_token, self_link)
-
-                prev_link = await get_prev_link(redis, token_param)
-                if prev_link:
-                    links.insert(
-                        0,
-                        {
-                            "rel": "prev",
-                            "type": "application/json",
-                            "method": "GET",
-                            "href": prev_link,
-                        },
-                    )
-            except Exception as e:
-                logger.warning(
-                    f"Redis connection failed, continuing without Redis: {e}"
-                )
+            await redis_pagination_links(
+                current_url=str(request.url),
+                token=token_param,
+                next_token=next_token,
+                links=links,
+            )
 
         return stac_types.ItemCollection(
             type="FeatureCollection",