Add caching

Author: Andrew Brookins

Diff for: .pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
       rev: 3.8.0
       hooks:
       - id: flake8
-        exclude: (.git|__pycache__|__init__.py|core/application.py|app/main.py|app/dao/base.py)
+        exclude: (.git|__pycache__|__init__.py|core/application.py|app/main.py|app/dao/base.py|data)
         additional_dependencies: ['flake8-typing-imports==1.7.0']
     - repo: https://github.com/pre-commit/mirrors-autopep8
       rev: v1.5.2

Diff for: Dockerfile

@@ -11,7 +11,6 @@ RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-
 # Copy poetry.lock* in case it doesn't exist in the repo
 COPY ./pyproject.toml ./poetry.lock* /app/
 
-ARG INSTALL_DEV=false
-RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --no-dev ; fi"
+RUN bash -c "poetry install --no-root"
 
 COPY ./app /app

Diff for: app/config.py

@@ -2,12 +2,36 @@
 
 from aiotestspeed.aio import Speedtest
 from fastapi import FastAPI
+from fastapi import Request
+from fastapi import Response
+from fastapi_redis_cache import cache
+from fastapi_redis_cache import FastApiRedisCache
+from pydantic import BaseSettings
+
+
+class Config(BaseSettings):
+    redis_url: str = 'redis://redis:6379'
+
 
 logger = logging.getLogger(__name__)
 app = FastAPI()
+config = Config()
+app = FastAPI(title='FastAPI Redis Cache Example')
+
+
+@app.on_event('startup')
+def startup():
+    redis_cache = FastApiRedisCache()
+    redis_cache.init(
+        host_url=config.redis_url,
+        prefix='speedtest-cache',
+        response_header='X-Speedtest-Cache',
+        ignore_arg_types=[Request, Response],
+    )
 
 
 @app.get('/speedtest')
+@cache(expire=30)
 async def speedtest():
     logger.debug('Running speedtest')
     s: Speedtest = await Speedtest()

Diff for: app/main.py

@@ -7,7 +7,7 @@ services:
         volumes:
           - $PWD/data:/data
         command: redis-server --appendonly yes --aof-use-rdb-preamble yes --dir /data
-    
+
     app:
         restart: always
         build: .
@@ -18,3 +18,11 @@ services:
         depends_on:
             - redis
         command: /start-reload.sh
+
+    test:
+        build: .
+        volumes:
+            - $PWD:/app
+        depends_on:
+            - redis
+        entrypoint: "pytest"

Diff for: data/appendonly.aof

@@ -10,6 +10,7 @@ fastapi = "^0.61.0"
 uvicorn = "^0.11.8"
 requests = "^2.24.0"
 aiotestspeed = {git = "https://github.com/abrookins/aiotestspeed", rev = "master"}
+fastapi-redis-cache = "^0.2.2"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.2"

Diff for: docker-compose.yaml

@@ -2,11 +2,18 @@
 
 import pytest
 from fastapi.testclient import TestClient
+from redis.utils import from_url
 
 from app.main import app
+from app.main import config
 
 
 @pytest.fixture(scope='module')
 def client() -> Generator:
     with TestClient(app) as c:
         yield c
+
+
+@pytest.fixture(scope='module')
+def redis() -> Generator:
+    yield from_url(config.redis_url)

Diff for: poetry.lock

@@ -1,4 +1,7 @@
+import json
+
 from fastapi.testclient import TestClient
+from redis import Redis
 
 
 def test_speedtest(client: TestClient):
@@ -9,3 +12,15 @@ def test_speedtest(client: TestClient):
 
     for field in ('ping_ms', 'download_mbps', 'upload_mbps'):
         assert field in json
+
+
+def test_speedtest_cache(client: TestClient, redis: Redis):
+    # prime the cache
+    client.get('/speedtest')
+
+    cached = redis.get('speedtest-cache:app.main.speedtest()')
+    assert cached is not None
+    data = json.loads(cached)
+
+    for field in ('ping_ms', 'download_mbps', 'upload_mbps'):
+        assert field in data