Added django-redis as default cache

.github/workflows/run-ci-cd.yaml

@@ -335,6 +335,9 @@ jobs:
           echo "DJANGO_DB_PORT=${{ secrets.DJANGO_DB_PORT }}" >> .env.backend
           echo "DJANGO_DB_USER=${{ secrets.DJANGO_DB_USER }}" >> .env.backend
           echo "DJANGO_OPEN_AI_SECRET_KEY=${{ secrets.DJANGO_OPEN_AI_SECRET_KEY }}" >> .env.backend
+          echo "DJANGO_REDIS_HOST=${{ secrets.DJANGO_REDIS_HOST }}" >> .env.backend
+          echo "DJANGO_REDIS_PASSWORD=${{ secrets.DJANGO_REDIS_PASSWORD }}" >> .env.backend
+          echo "DJANGO_REDIS_PORT=${{ secrets.DJANGO_REDIS_PORT }}" >> .env.backend
           echo "DJANGO_RELEASE_VERSION=$(date '+%y.%-m.%-d')-${GITHUB_SHA:0:7}" >> .env.backend
           echo "DJANGO_SECRET_KEY=${{ secrets.DJANGO_SECRET_KEY }}" >> .env.backend
           echo "DJANGO_SENTRY_DSN=${{ secrets.DJANGO_SENTRY_DSN }}" >> .env.backend
@@ -507,6 +510,9 @@ jobs:
           echo "DJANGO_DB_PORT=${{ secrets.DJANGO_DB_PORT }}" >> .env.backend
           echo "DJANGO_DB_USER=${{ secrets.DJANGO_DB_USER }}" >> .env.backend
           echo "DJANGO_OPEN_AI_SECRET_KEY=${{ secrets.DJANGO_OPEN_AI_SECRET_KEY }}" >> .env.backend
+          echo "DJANGO_REDIS_HOST=${{ secrets.DJANGO_REDIS_HOST }}" >> .env.backend
+          echo "DJANGO_REDIS_PASSWORD=${{ secrets.DJANGO_REDIS_PASSWORD }}" >> .env.backend
+          echo "DJANGO_REDIS_PORT=${{ secrets.DJANGO_REDIS_PORT }}" >> .env.backend
           echo "DJANGO_RELEASE_VERSION=${{ github.event.release.tag_name }}" >> .env.backend
           echo "DJANGO_SECRET_KEY=${{ secrets.DJANGO_SECRET_KEY }}" >> .env.backend
           echo "DJANGO_SENTRY_DSN=${{ secrets.DJANGO_SENTRY_DSN }}" >> .env.backend

backend/.env.example

@@ -12,6 +12,9 @@ DJANGO_DB_PORT=None
 DJANGO_DB_USER=None
 DJANGO_OPEN_AI_SECRET_KEY=None
 DJANGO_PUBLIC_IP_ADDRESS="127.0.0.1"
+DJANGO_REDIS_HOST=None
+DJANGO_REDIS_PASSWORD=None
+DJANGO_REDIS_PORT=None
 DJANGO_RELEASE_VERSION=None
 DJANGO_SECRET_KEY=None
 DJANGO_SENTRY_DSN=None

backend/pyproject.toml

@@ -27,6 +27,7 @@ django = "^5.1"
 django-configurations = "^2.5.1"
 django-cors-headers = "^4.7.0"
 django-filter = "^25.1"
+django-redis = "^5.4.0"
 django-storages = { extras = ["s3"], version = "^1.14.4" }
 djangorestframework = "^3.15.2"
 geopy = "^2.4.1"

backend/settings/base.py

@@ -122,11 +122,20 @@ class Base(Configuration):
         "INDEX_PREFIX": ENVIRONMENT.lower(),
     }
 
+    REDIS_HOST = values.SecretValue(environ_name="REDIS_HOST")
+    REDIS_PASSWORD = values.SecretValue(environ_name="REDIS_PASSWORD")
+    REDIS_PORT = values.SecretValue(environ_name="REDIS_PORT")
     CACHES = {
         "default": {
-            "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+            "BACKEND": "django_redis.cache.RedisCache",
+            "LOCATION": f"redis://:{REDIS_PASSWORD}@{REDIS_HOST}:{REDIS_PORT}",
+            "OPTIONS": {
+                "CLIENT_CLASS": "django_redis.client.DefaultClient",
+            },
+            "TIMEOUT": 300,
         }
     }
+
     # Database
     # https://docs.djangoproject.com/en/5.1/ref/settings/#databases
     DATABASES = {

backend/tests/apps/core/api/algolia_test.py

@@ -3,7 +3,6 @@
 
 import pytest
 import requests
-from django.core.cache import cache
 
 from apps.core.api.algolia import algolia_search
 
@@ -18,15 +17,15 @@
 CLIENT_IP_ADDRESS = "127.0.0.1"
 
 
-@pytest.fixture
-def _clear_cache():
-    """Clear the cache before and after each test."""
-    cache.clear()
-    yield
-    cache.clear()
+@pytest.fixture(autouse=True)
+def mock_redis_cache():
+    """Mock Redis cache used in algolia.py."""
+    with patch("apps.core.api.algolia.cache") as mock_cache:
+        mock_cache.get.return_value = None
+        mock_cache.set.return_value = True
+        yield mock_cache
 
 
-@pytest.mark.usefixtures("_clear_cache")
 class TestAlgoliaSearch:
     @pytest.mark.parametrize(
         ("index_name", "query", "page", "hits_per_page", "facet_filters", "expected_result"),
@@ -92,7 +91,6 @@ def test_algolia_search_invalid_method(self):
     @pytest.mark.parametrize(
         ("index_name", "query", "page", "hits_per_page", "facet_filters", "error_message"),
         [
-            # Index name tests
             (
                 5,
                 "owasp",
@@ -101,14 +99,38 @@ def test_algolia_search_invalid_method(self):
                 ["idx_is_active:true"],
                 "indexName is required and must be a string.",
             ),
-            # Query tests
-            ("chapters", 5, 2, 20, ["idx_is_active:true"], "query must be a string."),
-            # Page tests
-            ("committees", "review", "0", 5, [], "page value must be an integer."),
-            # hitsPerPage tests
-            ("committees", "review", 1, "1001", [], "hitsPerPage must be an integer."),
-            # Facet filters tests
-            ("issues", "bug", 1, 10, "idx_is_active:true", "facetFilters must be a list."),
+            (
+                "chapters",
+                5,
+                2,
+                20,
+                ["idx_is_active:true"],
+                "query must be a string.",
+            ),
+            (
+                "committees",
+                "review",
+                "0",
+                5,
+                [],
+                "page value must be an integer.",
+            ),
+            (
+                "committees",
+                "review",
+                1,
+                "1001",
+                [],
+                "hitsPerPage must be an integer.",
+            ),
+            (
+                "issues",
+                "bug",
+                1,
+                10,
+                "idx_is_active:true",
+                "facetFilters must be a list.",
+            ),
         ],
     )
     def test_algolia_search_invalid_request(

cspell/custom-dict.txt

@@ -83,6 +83,7 @@ pygoat
 pymdownx
 pyyaml
 repositorycontributor
+requirepass
 rsc
 saft
 sakanashi

docker/docker-compose-local.yaml

@@ -10,6 +10,8 @@ services:
       context: ../backend
       dockerfile: docker/Dockerfile.local
     depends_on:
+      cache:
+        condition: service_healthy
       db:
         condition: service_healthy
     env_file: ../backend/.env
@@ -19,6 +21,9 @@ services:
       DJANGO_DB_PASSWORD: ${DJANGO_DB_PASSWORD:-nest_user_dev_password}
       DJANGO_DB_PORT: ${DJANGO_DB_PORT:-5432}
       DJANGO_DB_USER: ${DJANGO_DB_USER:-nest_user_dev}
+      DJANGO_REDIS_HOST: nest-cache
+      DJANGO_REDIS_PASSWORD: ${DJANGO_REDIS_PASSWORD:-nest_cache_password}
+      DJANGO_REDIS_PORT: 6379
     networks:
       - nest-network
     ports:
@@ -27,6 +32,22 @@ services:
       - ../backend:/home/owasp
       - backend-venv:/home/owasp/.venv
 
+  cache:
+    container_name: nest-cache
+    image: redis:7.2.7-alpine3.21
+    command: redis-server --requirepass ${DJANGO_REDIS_PASSWORD:-nest_cache_password} --maxmemory 25mb --maxmemory-policy allkeys-lru
+    healthcheck:
+      interval: 5s
+      retries: 5
+      test: [CMD, redis-cli, -a, '${DJANGO_REDIS_PASSWORD:-nest_cache_password}', ping]
+      timeout: 5s
+    networks:
+      - nest-network
+    ports:
+      - 6379:6379
+    volumes:
+      - cache-data:/data
+
   db:
     container_name: nest-db
     image: postgres:16.4
@@ -91,6 +112,7 @@ networks:
 
 volumes:
   backend-venv:
+  cache-data:
   db-data:
   docs-venv:
   frontend-next:

docker/docker-compose-production.yaml

@@ -4,37 +4,56 @@ services:
     image: arkid15r/owasp-nest-backend:production
     env_file: .env.backend
     depends_on:
+      production-nest-cache:
+        condition: service_healthy
       production-nest-db:
         condition: service_healthy
     restart: unless-stopped
     networks:
       - nest-app-network
+      - nest-cache-network
       - nest-db-network
     volumes:
       - ./data:/home/owasp/data
 
-  production-nest-frontend:
-    container_name: production-nest-frontend
-    image: arkid15r/owasp-nest-frontend:production
+  production-nest-cache:
+    container_name: production-nest-cache
+    image: redis:7.2.7-alpine3.21
+    command: redis-server --requirepass nest_redis_production --maxmemory 25mb --maxmemory-policy allkeys-lru
+    healthcheck:
+      interval: 5s
+      retries: 5
+      test: [CMD, redis-cli, -a, nest_redis_production, ping]
+      timeout: 5s
     restart: unless-stopped
+    volumes:
+      - ./volumes/cache:/data
     networks:
-      - nest-app-network
+      - nest-cache-network
 
   production-nest-db:
     container_name: production-nest-db
     image: postgres:16.4
     env_file: .env.db
     healthcheck:
-      test: [CMD, pg_isready, -U, nest_user_production, -d, nest_db_production]
       interval: 5s
-      timeout: 5s
       retries: 5
+      test: [CMD, pg_isready, -U, nest_user_production, -d, nest_db_production]
+      timeout: 5s
     restart: unless-stopped
     volumes:
       - ./volumes/db:/var/lib/postgresql/data
     networks:
       - nest-db-network
 
+  production-nest-frontend:
+    container_name: production-nest-frontend
+    image: arkid15r/owasp-nest-frontend:production
+    restart: unless-stopped
+    networks:
+      - nest-app-network
+
 networks:
   nest-app-network:
+  nest-cache-network:
   nest-db-network:

docker/docker-compose-staging.yaml

@@ -4,37 +4,56 @@ services:
     image: arkid15r/owasp-nest-backend:staging
     env_file: .env.backend
     depends_on:
+      staging-nest-cache:
+        condition: service_healthy
       staging-nest-db:
         condition: service_healthy
     restart: unless-stopped
     networks:
       - nest-app-network
+      - nest-cache-network
       - nest-db-network
     volumes:
       - ./data:/home/owasp/data
 
-  staging-nest-frontend:
-    container_name: staging-nest-frontend
-    image: arkid15r/owasp-nest-frontend:staging
+  staging-nest-cache:
+    container_name: staging-nest-cache
+    image: redis:7.2.7-alpine3.21
+    command: redis-server --requirepass nest-cache-staging --maxmemory 25mb --maxmemory-policy allkeys-lru
+    healthcheck:
+      interval: 5s
+      retries: 5
+      test: [CMD, redis-cli, -a, nest-cache-staging, ping]
+      timeout: 5s
     restart: unless-stopped
+    volumes:
+      - ./volumes/cache:/data
     networks:
-      - nest-app-network
+      - nest-cache-network
 
   staging-nest-db:
     container_name: staging-nest-db
     image: postgres:16.4
     env_file: .env.db
     healthcheck:
-      test: [CMD, pg_isready, -U, nest_user_staging, -d, nest_db_staging]
       interval: 5s
-      timeout: 5s
       retries: 5
+      test: [CMD, pg_isready, -U, nest_user_staging, -d, nest_db_staging]
+      timeout: 5s
     restart: unless-stopped
     volumes:
       - ./volumes/db:/var/lib/postgresql/data
     networks:
       - nest-db-network
 
+  staging-nest-frontend:
+    container_name: staging-nest-frontend
+    image: arkid15r/owasp-nest-frontend:staging
+    restart: unless-stopped
+    networks:
+      - nest-app-network
+
 networks:
   nest-app-network:
+  nest-cache-network:
   nest-db-network: