Skip to content

Commit 74d44d6

Browse files
authored
Keep the real status code on rendered error pages (#465)
The error middleware rendered error.html for every HTTPException but returned it with status 200, so a 404 or 403 looked like a success to health probes, monitoring and Sentry. Pass the exception's status to the renderer, and let redirects raised as exceptions pass through.
1 parent e85ed84 commit 74d44d6

2 files changed

Lines changed: 69 additions & 2 deletions

File tree

‎blurb_it/middleware.py‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,24 @@
44

55
@web.middleware
66
async def error_middleware(request, handler):
7-
"""Middleware to render error message using the template renderer."""
7+
"""Middleware to render error message using the template renderer.
8+
9+
Only client and server errors are rendered. Redirects and other
10+
non-error responses raised as exceptions pass through untouched.
11+
The rendered page keeps the original status code, so monitoring,
12+
health probes and Sentry see the real error instead of a 200.
13+
"""
814
try:
915
response = await handler(request)
1016
except web.HTTPException as ex:
17+
if ex.status < 400:
18+
raise
1119
if ex.text:
1220
message = ex.text
1321
else:
1422
message = ex.reason
1523
context = {"error_message": message, "status": ex.status}
1624
response = aiohttp_jinja2.render_template(
17-
"error.html", request, context=context
25+
"error.html", request, context=context, status=ex.status
1826
)
1927
return response

‎tests/test_middleware.py‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
from __future__ import annotations
2+
3+
import pathlib
4+
5+
import aiohttp_jinja2
6+
import jinja2
7+
from aiohttp import web
8+
9+
from blurb_it import middleware
10+
11+
12+
def create_app() -> web.Application:
13+
app = web.Application(middlewares=[middleware.error_middleware])
14+
aiohttp_jinja2.setup(
15+
app, loader=jinja2.FileSystemLoader(pathlib.Path.cwd() / "templates")
16+
)
17+
return app
18+
19+
20+
async def test_not_found_keeps_status_code(aiohttp_client) -> None:
21+
app = create_app()
22+
client = await aiohttp_client(app)
23+
24+
response = await client.get("/does-not-exist")
25+
26+
assert response.status == 404
27+
text = await response.text()
28+
assert "<h1>404</h1>" in text
29+
assert "Not Found" in text
30+
31+
32+
async def test_handler_error_renders_text_with_status(aiohttp_client) -> None:
33+
async def forbidden(request):
34+
raise web.HTTPForbidden(reason="Invalid CSRF token. Please retry.")
35+
36+
app = create_app()
37+
app.router.add_get("/forbidden", forbidden)
38+
client = await aiohttp_client(app)
39+
40+
response = await client.get("/forbidden")
41+
42+
assert response.status == 403
43+
text = await response.text()
44+
assert "<h1>403</h1>" in text
45+
assert "Invalid CSRF token. Please retry." in text
46+
47+
48+
async def test_redirect_passes_through(aiohttp_client) -> None:
49+
async def redirect(request):
50+
raise web.HTTPFound(location="/elsewhere")
51+
52+
app = create_app()
53+
app.router.add_get("/redirect", redirect)
54+
client = await aiohttp_client(app)
55+
56+
response = await client.get("/redirect", allow_redirects=False)
57+
58+
assert response.status == 302
59+
assert response.headers["Location"] == "/elsewhere"

0 commit comments

Comments
 (0)