fix: asgi lifespan msg after lifespan context exception #3315
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peterschutt
commented
Apr 5, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3315 +/- ##
=======================================
Coverage 98.26% 98.26%
=======================================
Files 322 322
Lines 14718 14720 +2
Branches 2342 2342
=======================================
+ Hits 14462 14464 +2
Misses 117 117
Partials 139 139 ☔ View full report in Codecov by Sentry. |
peterschutt
force-pushed
the
error-in-asgi-lifespan-context
branch
from
d2fc354 to
0666740
Compare
provinzkraut
approved these changes
Apr 6, 2024
An exception raised within an asgi lifespan context manager would result in a "lifespan.startup.failed" message being sent after we've already sent a "lifespan.startup.complete" message. This would cause uvicorn to raise a `STATE_TRANSITION_ERROR` assertion error due to their [check for that condition][1]. This PR modifies `ASGIRouter.lifespan()` so that it sends a shutdown failure message if we've already confirmed startup. This is consistent with [starlette's behavior][2] under the same conditions. [1]: https://github.com/encode/uvicorn/blob/a2219eb2ed2bbda4143a0fb18c4b0578881b1ae8/uvicorn/lifespan/on.py#L115-L117 [2]: https://github.com/encode/starlette/blob/4e453ce91940cc7c995e6c728e3fdf341c039056/starlette/routing.py#L744-L745
peterschutt
force-pushed
the
error-in-asgi-lifespan-context
branch
from
0666740 to
a34f92a
Compare
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3315 |
peterschutt
added a commit
that referenced
this pull request
Apr 8, 2024
An exception raised within an asgi lifespan context manager would result in a "lifespan.startup.failed" message being sent after we've already sent a "lifespan.startup.complete" message. This would cause uvicorn to raise a `STATE_TRANSITION_ERROR` assertion error due to their [check for that condition][1]. This PR modifies `ASGIRouter.lifespan()` so that it sends a shutdown failure message if we've already confirmed startup. This is consistent with [starlette's behavior][2] under the same conditions. [1]: https://github.com/encode/uvicorn/blob/a2219eb2ed2bbda4143a0fb18c4b0578881b1ae8/uvicorn/lifespan/on.py#L115-L117 [2]: https://github.com/encode/starlette/blob/4e453ce91940cc7c995e6c728e3fdf341c039056/starlette/routing.py#L744-L745 (cherry picked from commit fac641a)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An exception raised within an asgi lifespan context manager would result in a "lifespan.startup.failed" message being sent after we've already sent a "lifespan.startup.complete" message. This would cause uvicorn to raise a
STATE_TRANSITION_ERRORassertion error due to their check for that condition, if asgi lifespan is forced (i.e., with$ uvicorn test_apps.test_app:app --lifespan on).E.g.,
This PR modifies
ASGIRouter.lifespan()so that it sends a shutdown failure message if we've already confirmed startup. This is consistent with starlette's behavior under the same conditions.Description
Closes