Merge pull request #98 from Point72/tkp/cc

Swap static files to have 7 day cache control header set, fixes #91

Author: timkpaine

csp_gateway/server/web/app.py

@@ -12,7 +12,6 @@
 from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
 from fastapi.openapi.utils import get_openapi
 from fastapi.responses import FileResponse, HTMLResponse, RedirectResponse
-from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
 from pydantic import BaseModel
 from starlette.middleware.cors import CORSMiddleware
@@ -40,6 +39,7 @@
     add_state_api_available_channels,
     add_state_routes,
 )
+from .static import CacheControlledStaticFiles
 
 # from uvicorn.supervisors import Multiprocess
 
@@ -208,14 +208,14 @@ def add_static_files(self) -> None:
         # Mount static files
         self.app.mount(
             "/static",
-            StaticFiles(directory=static_files_dir, check_dir=False, html=True),
+            CacheControlledStaticFiles(directory=static_files_dir, check_dir=False, html=True),
             name="frontend",
         )
 
         # Mount images
         self.app.mount(
             "/img",
-            StaticFiles(directory=images_files_dir, check_dir=False, html=True),
+            CacheControlledStaticFiles(directory=images_files_dir, check_dir=False, html=True),
             name="img",
         )
 

csp_gateway/server/web/static.py

@@ -0,0 +1,12 @@
+from starlette.responses import Response
+from starlette.staticfiles import StaticFiles
+from starlette.types import Scope
+
+__all__ = ("CacheControlledStaticFiles",)
+
+
+class CacheControlledStaticFiles(StaticFiles):
+    async def get_response(self, path: str, scope: Scope) -> Response:
+        response = await super().get_response(path, scope)
+        response.headers["Cache-Control"] = "public, max-age=604800"
+        return response

csp_gateway/tests/server/web/test_webserver.py

@@ -99,6 +99,11 @@ def test_unknown_404(self, rest_client: TestClient):
         assert response.status_code == 404
         assert response.json() == {"detail": "Not Found"}
 
+    def test_static_cachecontrol(self, rest_client: TestClient):
+        response = rest_client.get("/static/favicon.png")
+        assert response.status_code == 200
+        assert response.headers["Cache-Control"] == "public, max-age=604800"
+
     ######################
     # Core Functionality #
     def test_log_viewer(self, rest_client: TestClient):