Merge pull request #128 from nanotaboada/feature/fastapi-cache2

feat(routes): add in-memory cache

Author: nanotaboada

main.py

@@ -2,8 +2,17 @@
 # Main
 # ------------------------------------------------------------------------------
 
+from contextlib import asynccontextmanager
 from fastapi import FastAPI
+from fastapi_cache import FastAPICache
+from fastapi_cache.backends.inmemory import InMemoryBackend
 from routes import player_route
 
-app = FastAPI()
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    FastAPICache.init(InMemoryBackend())
+    yield
+
+app = FastAPI(lifespan=lifespan)
 app.include_router(player_route.api_router)

requirements.txt

@@ -1,34 +1,75 @@
+aiohttp==3.9.5
+aiosignal==1.3.1
 annotated-types==0.7.0
 anyio==4.4.0
+attrs==23.2.0
 certifi==2024.6.2
+charset-normalizer==3.3.2
 click==8.1.7
+colorclass==2.2.2
 coverage==7.5.4
+dnspython==2.6.1
+docopt==0.6.2
+email_validator==2.1.2
 fastapi==0.111.0
+fastapi-cache2==0.2.1
+fastapi-cli==0.0.4
 flake8==7.1.0
+frozenlist==1.4.1
 greenlet==3.0.3
 h11==0.14.0
 httpcore==1.0.5
 httptools==0.6.1
 httpx==0.27.0
 idna==3.7
+ijson==3.2.3
 iniconfig==2.0.0
+Jinja2==3.1.4
+markdown-it-py==3.0.0
+MarkupSafe==2.1.5
 mccabe==0.7.0
+mdurl==0.1.2
+multidict==6.0.5
+orjson==3.10.5
 packaging==24.1
+pendulum==3.0.0
 pluggy==1.5.0
+pur==7.3.1
 pycodestyle==2.12.0
 pydantic==2.7.4
 pydantic_core
+pydeps==1.12.19
 pyflakes==3.2.0
+Pygments==2.18.0
 pytest==8.2.2
 pytest-cov==5.0.0
 pytest-sugar==1.0.0
+python-dateutil==2.9.0.post0
 python-dotenv==1.0.1
+python-multipart==0.0.9
 PyYAML==6.0.1
+requests==2.31.0
+responses==0.21.0
+rfc3986==1.5.0
+rich==13.7.1
+setuptools==69.5.1
+shellingham==1.5.4
+six==1.16.0
 sniffio==1.3.1
 SQLAlchemy==2.0.31
 starlette
+stdlib-list==0.10.0
+termcolor==2.4.0
+terminaltables==3.1.10
+time-machine==2.14.1
+tree-sitter==0.20.4
+typer==0.12.3
 typing_extensions==4.12.2
+tzdata==2024.1
+ujson==5.10.0
+urllib3==2.2.1
 uvicorn==0.30.1
 uvloop==0.19.0
 watchfiles==0.22.0
 websockets==12.0
+yarl==1.9.4

routes/player_route.py

@@ -5,14 +5,19 @@
 from typing import List
 from fastapi import APIRouter, Body, Depends, HTTPException, status, Path
 from sqlalchemy.orm import Session
+from fastapi_cache import FastAPICache
+from fastapi_cache.decorator import cache
 from data.player_database import OrmSession
 from models.player_model import PlayerModel
 from services import player_service
 
 api_router = APIRouter()
 
+CACHING_TIME_IN_SECONDS = 600
 
 # https://fastapi.tiangolo.com/tutorial/sql-databases/#create-a-dependency
+
+
 def get_orm_session():
     orm_session = OrmSession()
     try:
@@ -39,6 +44,8 @@ def post(
 
     player_service.create(orm_session, player_model)
 
+    FastAPICache.clear()
+
 # GET --------------------------------------------------------------------------
 
 
@@ -48,6 +55,7 @@ def post(
     status_code=status.HTTP_200_OK,
     summary="Retrieves a collection of Players"
 )
+@cache(expire=CACHING_TIME_IN_SECONDS)
 def get_all(
     orm_session: Session = Depends(get_orm_session)
 ):
@@ -62,6 +70,7 @@ def get_all(
     status_code=status.HTTP_200_OK,
     summary="Retrieves a Player by its Id"
 )
+@cache(expire=CACHING_TIME_IN_SECONDS)
 def get_by_id(
     player_id: int = Path(..., title="The Id of the Player"),
     orm_session: Session = Depends(get_orm_session)
@@ -80,6 +89,7 @@ def get_by_id(
     status_code=status.HTTP_200_OK,
     summary="Retrieves a Player by its Squad Number"
 )
+@cache(expire=CACHING_TIME_IN_SECONDS)
 def get_by_squad_number(
     squad_number: int = Path(..., title="The Squad Number of the Player"),
     orm_session: Session = Depends(get_orm_session)
@@ -112,6 +122,8 @@ def put(
 
     player_service.update(orm_session, player_model)
 
+    FastAPICache.clear()
+
 # DELETE -----------------------------------------------------------------------
 
 
@@ -130,3 +142,5 @@ def delete(
         raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Player not found")
 
     player_service.delete(orm_session, player_id)
+
+    FastAPICache.clear()

tests/conftest.py

@@ -0,0 +1,13 @@
+import warnings
+import pytest
+from fastapi.testclient import TestClient
+from main import app
+
+# Suppress the DeprecationWarning from httpx
+warnings.filterwarnings("ignore", category=DeprecationWarning)
+
+
+@pytest.fixture(scope="module")
+def client():
+    with TestClient(app) as test_client:
+        yield test_client

tests/test_main.py

@@ -4,25 +4,18 @@
 
 import json
 from tests.player_stub import existing_player, non_existing_player, unknown_player
-from main import app
-from fastapi.testclient import TestClient
-import warnings
-# Suppress the DeprecationWarning from httpx
-warnings.filterwarnings("ignore", category=DeprecationWarning)
 
-
-client = TestClient(app)
 PATH = "/players/"
 
 # GET /players/ ----------------------------------------------------------------
 
 
-def test_given_get_when_request_path_has_no_id_then_response_status_code_should_be_200_ok():
+def test_given_get_when_request_path_has_no_id_then_response_status_code_should_be_200_ok(client):
     response = client.get(PATH)
     assert response.status_code == 200
 
 
-def test_given_get_when_request_path_has_no_id_then_response_body_should_be_collection_of_players():
+def test_given_get_when_request_path_has_no_id_then_response_body_should_be_collection_of_players(client):
     response = client.get(PATH)
     players = response.json()
     player_id = 0
@@ -33,19 +26,19 @@ def test_given_get_when_request_path_has_no_id_then_response_body_should_be_coll
 # GET /players/{player_id} -----------------------------------------------------
 
 
-def test_given_get_when_request_path_is_non_existing_id_then_response_status_code_should_be_404_not_found():
+def test_given_get_when_request_path_is_non_existing_id_then_response_status_code_should_be_404_not_found(client):
     player_id = 999
     response = client.get(PATH + str(player_id))
     assert response.status_code == 404
 
 
-def test_given_get_when_request_path_is_existing_id_then_response_status_code_should_be_200_ok():
+def test_given_get_when_request_path_is_existing_id_then_response_status_code_should_be_200_ok(client):
     player_id = 1
     response = client.get(PATH + str(player_id))
     assert response.status_code == 200
 
 
-def test_given_get_when_request_path_is_existing_id_then_response_body_should_be_matching_player():
+def test_given_get_when_request_path_is_existing_id_then_response_body_should_be_matching_player(client):
     player_id = 1
     response = client.get(PATH + str(player_id))
     player = response.json()
@@ -54,19 +47,19 @@ def test_given_get_when_request_path_is_existing_id_then_response_body_should_be
 # GET /players/squadnumber/{squad_number} --------------------------------------
 
 
-def test_given_get_when_request_path_is_non_existing_squad_number_then_response_status_code_should_be_404_not_found():
+def test_given_get_when_request_path_is_non_existing_squad_number_then_response_status_code_should_be_404_not_found(client):
     squad_number = 999
     response = client.get(PATH + "squadnumber" + "/" + str(squad_number))
     assert response.status_code == 404
 
 
-def test_given_get_when_request_path_is_existing_squad_number_then_response_status_code_should_be_200_ok():
+def test_given_get_when_request_path_is_existing_squad_number_then_response_status_code_should_be_200_ok(client):
     squad_number = 10
     response = client.get(PATH + "squadnumber" + "/" + str(squad_number))
     assert response.status_code == 200
 
 
-def test_given_get_when_request_path_is_existing_squad_number_then_response_body_should_be_matching_player():
+def test_given_get_when_request_path_is_existing_squad_number_then_response_body_should_be_matching_player(client):
     squad_number = 10
     response = client.get(PATH + "squadnumber" + "/" + str(squad_number))
     player = response.json()
@@ -75,20 +68,20 @@ def test_given_get_when_request_path_is_existing_squad_number_then_response_body
 # POST /players/ ---------------------------------------------------------------
 
 
-def test_given_post_when_request_body_is_empty_then_response_status_code_should_be_422_unprocessable_entity():
+def test_given_post_when_request_body_is_empty_then_response_status_code_should_be_422_unprocessable_entity(client):
     body = json.dumps({})
     response = client.post(PATH, data=body)
     assert response.status_code == 422
 
 
-def test_given_post_when_request_body_is_existing_player_then_response_status_code_should_be_409_conflict():
+def test_given_post_when_request_body_is_existing_player_then_response_status_code_should_be_409_conflict(client):
     player = existing_player()
     body = json.dumps(player.__dict__)
     response = client.post(PATH, data=body)
     assert response.status_code == 409
 
 
-def test_given_post_when_request_body_is_non_existing_player_then_response_status_code_should_be_201_created():
+def test_given_post_when_request_body_is_non_existing_player_then_response_status_code_should_be_201_created(client):
     player = non_existing_player()
     body = json.dumps(player.__dict__)
     response = client.post(PATH, data=body)
@@ -97,22 +90,22 @@ def test_given_post_when_request_body_is_non_existing_player_then_response_statu
 # PUT /players/{player_id} -----------------------------------------------------
 
 
-def test_given_put_when_request_body_is_empty_then_response_status_code_should_be_422_unprocessable_entity():
+def test_given_put_when_request_body_is_empty_then_response_status_code_should_be_422_unprocessable_entity(client):
     player_id = 1
     body = {}
     response = client.put(PATH + str(player_id), data=body)
     assert response.status_code == 422
 
 
-def test_given_put_when_request_body_is_unknown_player_then_response_status_code_should_be_404_not_found():
+def test_given_put_when_request_body_is_unknown_player_then_response_status_code_should_be_404_not_found(client):
     player_id = 999
     player = unknown_player()
     body = json.dumps(player.__dict__)
     response = client.put(PATH + str(player_id), data=body)
     assert response.status_code == 404
 
 
-def test_given_put_when_request_body_is_existing_player_then_response_status_code_should_be_204_no_content():
+def test_given_put_when_request_body_is_existing_player_then_response_status_code_should_be_204_no_content(client):
     player_id = 1
     player = existing_player()
     player.first_name = "Emiliano"
@@ -124,13 +117,13 @@ def test_given_put_when_request_body_is_existing_player_then_response_status_cod
 # DELETE /players/{player_id} --------------------------------------------------
 
 
-def test_given_delete_when_request_path_is_non_existing_id_then_response_status_code_should_be_404_not_found():
+def test_given_delete_when_request_path_is_non_existing_id_then_response_status_code_should_be_404_not_found(client):
     player_id = 999
     response = client.delete(PATH + str(player_id))
     assert response.status_code == 404
 
 
-def test_given_delete_when_request_path_is_existing_id_then_response_status_code_should_be__204_no_content():
+def test_given_delete_when_request_path_is_existing_id_then_response_status_code_should_be__204_no_content(client):
     player_id = 12
     response = client.delete(PATH + str(player_id))
     assert response.status_code == 204