Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions lite_bootstrap/bootstrappers/litestar_bootstrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -502,10 +502,11 @@ def _apply_config(self, application_config: "AppConfig") -> None:
# An Empty value reaches layer resolution and 500s every body-reading handler.
if application_config.request_max_body_size is Empty:
application_config.request_max_body_size = _LITESTAR_DEFAULT_REQUEST_MAX_BODY_SIZE
application_config.on_shutdown.append(self.teardown)

def is_ready(self) -> bool:
return import_checker.is_litestar_installed

def _prepare_application(self) -> "litestar.Litestar":
return litestar.Litestar.from_config(self.bootstrap_config.application_config)
application = litestar.Litestar.from_config(self.bootstrap_config.application_config)
application.on_shutdown.append(self.teardown)
return application
63 changes: 61 additions & 2 deletions tests/test_litestar_bootstrap.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import typing
import uuid
import warnings
from collections.abc import Generator
from collections.abc import AsyncGenerator, Generator

import litestar
import pytest
Expand All @@ -26,7 +26,7 @@
from opentelemetry.sdk.trace import TracerProvider as SDKTracerProvider
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
from opentelemetry.trace import SpanKind, get_tracer_provider
from opentelemetry.trace import SpanKind, get_tracer, get_tracer_provider

from lite_bootstrap import LitestarBootstrapper, LitestarConfig, import_checker
from lite_bootstrap.bootstrappers import litestar_bootstrapper
Expand Down Expand Up @@ -113,6 +113,65 @@ def test_second_litestar_bootstrapper_on_same_config_warns_not_stacks(litestar_c
)


@pytest.mark.parametrize("shutdown_failure", [None, "lifespan", "hook"])
def test_litestar_exports_shutdown_spans_from_hooks_added_after_construction(shutdown_failure: str | None) -> None:
events: list[str] = []
tracer = get_tracer(__name__)

def early_shutdown() -> None:
with tracer.start_as_current_span("early-shutdown"):
events.append("early-shutdown")

async def late_shutdown(app: litestar.Litestar) -> None:
assert app.state.started
with tracer.start_as_current_span("late-shutdown"):
events.append("late-shutdown")
if shutdown_failure == "hook":
msg = "user shutdown failed"
raise RuntimeError(msg)

@contextlib.asynccontextmanager
async def lifespan(app: litestar.Litestar) -> AsyncGenerator[None]:
app.state.started = True
events.append("lifespan-startup")
yield
with tracer.start_as_current_span("lifespan-shutdown"):
events.append("lifespan-shutdown")
if shutdown_failure == "lifespan":
msg = "user shutdown failed"
raise RuntimeError(msg)

application_config = AppConfig(on_shutdown=[early_shutdown], lifespan=[lifespan])
bootstrapper = LitestarBootstrapper(
bootstrap_config=LitestarConfig(
application_config=application_config, logging_enabled=False, opentelemetry_log_traces=True
)
)
application_config.on_shutdown.append(late_shutdown)
application = bootstrapper.bootstrap()
exporter = InMemorySpanExporter()
provider = typing.cast("SDKTracerProvider", get_tracer_provider())
provider.add_span_processor(SimpleSpanProcessor(exporter))
expected_error = (
pytest.RaisesGroup(pytest.RaisesExc(RuntimeError, match="user shutdown failed"), allow_unwrapped=True)
if shutdown_failure
else contextlib.nullcontext()
)
try:
with expected_error, TestClient(application):
assert events == ["lifespan-startup"]
assert not bootstrapper.is_bootstrapped
finally:
bootstrapper.teardown()

assert events == ["lifespan-startup", "lifespan-shutdown", "early-shutdown", "late-shutdown"]
assert [span.name for span in exporter.get_finished_spans()] == [
"lifespan-shutdown",
"early-shutdown",
"late-shutdown",
]


def test_litestar_bootstrap(litestar_config: LitestarConfig) -> None:
bootstrapper = LitestarBootstrapper(bootstrap_config=litestar_config)
application = bootstrapper.bootstrap()
Expand Down
Loading