mirror of
https://github.com/simonw/datasette.git
synced 2026-09-03 07:04:16 +02:00
Run plugin asgi_wrapper middleware inside the startup-arming layer
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
parent
70af800eaa
commit
7ff29f3a54
3 changed files with 186 additions and 2 deletions
24
RELEASE_NOTES_DRAFT_05.md
Normal file
24
RELEASE_NOTES_DRAFT_05.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# Release notes draft — ticket 05 (wrapper reorder)
|
||||
|
||||
Scratch file: content to be folded into `docs/changelog.rst` by ticket 07
|
||||
(`todos/first-request/07-docs-and-changelog.md`). Not part of the shipped
|
||||
docs on its own.
|
||||
|
||||
## Plugin hooks
|
||||
|
||||
- Plugin `asgi_wrapper` middleware now always runs **after** Datasette
|
||||
startup has completed. Wrappers can rely on startup hooks — including
|
||||
internal-database migrations run by other plugins' `startup()` hooks —
|
||||
having already executed before their code sees an `http` or `websocket`
|
||||
ASGI scope. This applies on every deployment path: behind a real ASGI
|
||||
lifespan-aware server, and on the first-request fallback used by bare
|
||||
`app()` embedding and test clients that never send lifespan events.
|
||||
- Short-circuiting wrappers — ones that return a response without calling
|
||||
the wrapped application, such as an auth plugin returning a 401/403 or a
|
||||
CORS plugin answering a preflight request — no longer defer startup
|
||||
indefinitely. Startup now runs unconditionally before any wrapper sees
|
||||
the scope, so it can no longer be skipped by requests that never reach
|
||||
the inner app.
|
||||
- `lifespan` scopes are unaffected by this change and continue to flow
|
||||
through plugin `asgi_wrapper` middleware exactly as before, so plugins
|
||||
that inspect or wrap lifespan events keep working unmodified.
|
||||
|
|
@ -2940,12 +2940,23 @@ class Datasette:
|
|||
on_startup=[self._startup_sequence, self._launch_background_tasks],
|
||||
on_shutdown=[self.invoke_shutdown],
|
||||
)
|
||||
# Plugin asgi_wrapper middleware sits INSIDE AsgiRunOnFirstRequest
|
||||
# (below it, i.e. closer to the app) but OUTSIDE AsgiLifespan (above
|
||||
# it). That gives wrappers a single, simple contract: every http/
|
||||
# websocket scope they see has already been through
|
||||
# AsgiRunOnFirstRequest, so startup (including plugin migrations
|
||||
# against the internal database) is guaranteed to have completed -
|
||||
# even for a wrapper that short-circuits and never calls the inner
|
||||
# app, and even on hosts that never send ASGI lifespan events.
|
||||
# "lifespan" scopes are untouched by this reorder: AsgiRunOnFirstRequest
|
||||
# ignores them and passes them straight through to the wrappers (and
|
||||
# from there down to AsgiLifespan), exactly as before.
|
||||
for wrapper in pm.hook.asgi_wrapper(datasette=self):
|
||||
asgi = wrapper(asgi)
|
||||
asgi = AsgiRunOnFirstRequest(
|
||||
asgi,
|
||||
on_startup=[self._startup_sequence, self._launch_background_tasks],
|
||||
)
|
||||
for wrapper in pm.hook.asgi_wrapper(datasette=self):
|
||||
asgi = wrapper(asgi)
|
||||
return asgi
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,13 @@ These exercise Datasette._startup_sequence() via three different callers:
|
|||
- AsgiRunOnFirstRequest, the fallback for hosts that never send lifespan
|
||||
events (this is what DatasetteClient / plain httpx.ASGITransport uses)
|
||||
- Both at once, to prove startup hooks run at most once
|
||||
|
||||
Also covers ticket 05 (plans/first-request/04-core-plan.md decision #7):
|
||||
plugin asgi_wrapper middleware runs INSIDE AsgiRunOnFirstRequest (below it)
|
||||
but OUTSIDE AsgiLifespan (above it), so wrappers only ever see http/
|
||||
websocket scopes after startup has completed, in both the lifespan and
|
||||
fallback paths - while lifespan scopes still flow through wrappers
|
||||
unchanged.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
|
|
@ -257,3 +264,145 @@ async def test_setup_db_still_runs_when_invoke_startup_ran_first(tmp_path, monke
|
|||
# Idempotency: a second call must not recompute.
|
||||
await ds._startup_sequence()
|
||||
assert call_count["n"] == 1
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_asgi_wrapper_runs_after_startup_fallback_path():
|
||||
# Ticket 05: plugin asgi_wrapper middleware must never see an http scope
|
||||
# before startup has completed - even on the fallback path (no ASGI
|
||||
# lifespan events at all), which is what plain httpx.ASGITransport /
|
||||
# bare app() embedding exercises. Before the app() reorder in this
|
||||
# ticket, the wrapper loop ran OUTSIDE (above) AsgiRunOnFirstRequest, so
|
||||
# this assertion could see _startup_invoked is False on request #1 -
|
||||
# this test fails on the pre-reorder app().
|
||||
class AssertStartupPlugin:
|
||||
__name__ = "AssertStartupPlugin"
|
||||
|
||||
@hookimpl
|
||||
def asgi_wrapper(self, datasette):
|
||||
def wrap(app):
|
||||
async def check_startup(scope, receive, send):
|
||||
if scope["type"] == "http":
|
||||
assert datasette._startup_invoked is True, (
|
||||
"asgi_wrapper saw an http scope before startup "
|
||||
"completed"
|
||||
)
|
||||
await app(scope, receive, send)
|
||||
|
||||
return check_startup
|
||||
|
||||
return wrap
|
||||
|
||||
ds = Datasette(memory=True)
|
||||
pm.register(AssertStartupPlugin(), name="assert_startup_plugin")
|
||||
try:
|
||||
assert ds._startup_invoked is False
|
||||
app = ds.app()
|
||||
transport = httpx.ASGITransport(app=app)
|
||||
async with httpx.AsyncClient(
|
||||
transport=transport, base_url="http://localhost"
|
||||
) as client:
|
||||
response = await client.get("/-/versions.json")
|
||||
assert response.status_code == 200
|
||||
finally:
|
||||
pm.unregister(name="assert_startup_plugin")
|
||||
|
||||
assert ds._startup_invoked is True
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_short_circuit_wrapper_no_longer_defers_startup():
|
||||
# Ticket 05: a wrapper that short-circuits (returns a response without
|
||||
# ever calling the inner app - the shape of a 401/403/CORS-preflight
|
||||
# responder) used to mean startup never ran for that request, because
|
||||
# the wrapper sat OUTSIDE AsgiRunOnFirstRequest. Now that
|
||||
# AsgiRunOnFirstRequest is outermost, it arms startup before the
|
||||
# wrapper (or anything else) ever sees the scope.
|
||||
class ShortCircuitPlugin:
|
||||
__name__ = "ShortCircuitPlugin"
|
||||
|
||||
@hookimpl
|
||||
def asgi_wrapper(self, datasette):
|
||||
def wrap(app):
|
||||
async def forbidden(scope, receive, send):
|
||||
if scope["type"] != "http":
|
||||
await app(scope, receive, send)
|
||||
return
|
||||
await send(
|
||||
{
|
||||
"type": "http.response.start",
|
||||
"status": 403,
|
||||
"headers": [[b"content-type", b"text/plain"]],
|
||||
}
|
||||
)
|
||||
await send(
|
||||
{
|
||||
"type": "http.response.body",
|
||||
"body": b"Forbidden",
|
||||
}
|
||||
)
|
||||
# Deliberately never call app(...): this is the
|
||||
# short-circuiting shape (auth-passwords, auth-tailscale,
|
||||
# datasette-cors preflight).
|
||||
|
||||
return forbidden
|
||||
|
||||
return wrap
|
||||
|
||||
ds = Datasette(memory=True)
|
||||
pm.register(ShortCircuitPlugin(), name="short_circuit_plugin")
|
||||
try:
|
||||
assert ds._startup_invoked is False
|
||||
app = ds.app()
|
||||
transport = httpx.ASGITransport(app=app)
|
||||
async with httpx.AsyncClient(
|
||||
transport=transport, base_url="http://localhost"
|
||||
) as client:
|
||||
response = await client.get("/-/versions.json")
|
||||
assert response.status_code == 403
|
||||
finally:
|
||||
pm.unregister(name="short_circuit_plugin")
|
||||
|
||||
assert ds._startup_invoked is True
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_asgi_wrapper_still_sees_lifespan_scopes():
|
||||
# Ticket 05: the reorder only moves AsgiRunOnFirstRequest outside the
|
||||
# wrapper loop - AsgiLifespan stays inside it, so a wrapper that
|
||||
# inspects/wraps lifespan scopes still sees identical message flow.
|
||||
# Pin that lifespan scopes keep reaching wrappers alongside http scopes.
|
||||
seen_types = []
|
||||
|
||||
class RecordingPlugin:
|
||||
__name__ = "RecordingPlugin"
|
||||
|
||||
@hookimpl
|
||||
def asgi_wrapper(self, datasette):
|
||||
def wrap(app):
|
||||
async def record(scope, receive, send):
|
||||
seen_types.append(scope["type"])
|
||||
await app(scope, receive, send)
|
||||
|
||||
return record
|
||||
|
||||
return wrap
|
||||
|
||||
ds = Datasette(memory=True)
|
||||
pm.register(RecordingPlugin(), name="recording_plugin")
|
||||
try:
|
||||
app = ds.app()
|
||||
messages = await _drive_lifespan_startup(app)
|
||||
assert {"type": "lifespan.startup.complete"} in messages
|
||||
|
||||
transport = httpx.ASGITransport(app=app)
|
||||
async with httpx.AsyncClient(
|
||||
transport=transport, base_url="http://localhost"
|
||||
) as client:
|
||||
response = await client.get("/-/versions.json")
|
||||
assert response.status_code == 200
|
||||
finally:
|
||||
pm.unregister(name="recording_plugin")
|
||||
|
||||
assert "lifespan" in seen_types
|
||||
assert "http" in seen_types
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue