Run lifespans of mounted applications #1988
Conversation
daanvdk
force-pushed
the
mount-lifespans
branch
from
a6bf3d8
to
c402c22
Compare
| async def lifespan(scope: Scope, receive: Receive, send: Send): | ||
| assert scope["type"] == "lifespan" | ||
| assert scope["app"] == lifespan | ||
|
|
||
| message = await receive() | ||
| assert message["type"] == "lifespan.startup" | ||
| try: | ||
| startup() | ||
| except Exception: | ||
| await send( | ||
| { | ||
| "type": "lifespan.startup.failed", | ||
| "message": format_exc(), | ||
| } | ||
| ) | ||
| return | ||
| await send({"type": "lifespan.startup.complete"}) | ||
|
|
||
| message = await receive() | ||
| assert message["type"] == "lifespan.shutdown" | ||
| try: | ||
| shutdown() | ||
| except Exception: | ||
| await send( | ||
| { | ||
| "type": "lifespan.shutdown.failed", | ||
| "message": format_exc(), | ||
| } | ||
| ) | ||
| return | ||
| await send({"type": "lifespan.shutdown.complete"}) |
There was a problem hiding this comment.
I'm curious what the rational was for implementing this here as opposed to just mounting a Starlette app within a Starlette app (app = Starlette(routes=[Mount(app=Starlette(lifespan=...))], lifespan=...))
There was a problem hiding this comment.
Yeah I mainly, wanted to have a lifespan where I could easily overwrite the result of what happens during startup/shutdown. Might indeed be possible to simplify with a starlette app indeed.
There was a problem hiding this comment.
Great work! I gave this an initial look, left some comments. Haven't reviewed the tests in detail but I appreciate how thorough the test cases are. If we were to move forward with this I plan to do an in-depth review of the test cases and would like several maintainers to do the same. I think this sort of code with lots of events and tasks is prone to all sorts of bugs from race conditions, cancellation, etc.
High level I think the main question (which I'd like input from other maintainers on) is if we want to adopt this complexity (in other words, is the feature worth the complexity). I know this is something that has been requested in the past, but I don't think it's been a huge issue.
I also wonder if it might be better to just take control of the event loop and run Uvicorn programmatically instead of getting into such complex lifespans and mounted apps (that is, instead of lifespans you just do whatever setup you need and then instantiate your apps).
starlette/routing.py
Outdated
| # This wrapper is needed because TaskGroup.start_soon does not like that | ||
| # App returns Awaitable instead of Coroutine |
There was a problem hiding this comment.
Yup that is the case. If we use this somewhere else in the library (I don't recall) it might be worth doing something more generic since the issue relates to awaitables/coroutines and not specifically ASGI apps.
There was a problem hiding this comment.
Yeah makes sense, for now this wrapper turned out to be a good thing because I added some code at the end to check if the app did not return in a situation where that would block the context manager.
| async with create_task_group() as tg: | ||
| tg.start_soon(coro_app, {**scope, "app": app}, receive, send) |
There was a problem hiding this comment.
After all of the issues caused by using tasks in BaseHTTPMiddelware I'd like to avoid using them if possible. And I think that in this case it is possible: https://github.com/adriangb/asgi-routing/blob/main/asgi_routing/_lifespan_dispatcher.py#L11-L101. It's not really more LOC either. But maybe there's a bug in there that I didn't catch.
There was a problem hiding this comment.
Yeah I think the main thing is that you need a task to be able to wrap a lifespan in an async context manager, which does feel like a nice abstraction to have. But I definitely understand your reservations.
|
@adriangb if it's fine by you, I'd prefer for us to avoid this before 1.0. |
|
I agree on that |
Runs lifespans of mounted apps.
Fixes issue #649.