Merge pull request #16 from community-of-python/feature/litestar-sentry-sdk

Use LitestarIntegration for sentry

Author: insani7y

microbootstrap/bootstrappers/litestar.py

@@ -3,16 +3,15 @@
 
 import litestar
 import litestar.types
-import sentry_sdk
 import typing_extensions
-from litestar import openapi, status_codes
+from litestar import openapi
 from litestar.config.app import AppConfig as LitestarConfig
 from litestar.config.cors import CORSConfig as LitestarCorsConfig
 from litestar.contrib.opentelemetry.config import OpenTelemetryConfig as LitestarOpentelemetryConfig
 from litestar.contrib.prometheus import PrometheusConfig as LitestarPrometheusConfig
 from litestar.contrib.prometheus import PrometheusController
-from litestar.exceptions.http_exceptions import HTTPException
 from litestar_offline_docs import generate_static_files_config
+from sentry_sdk.integrations.litestar import LitestarIntegration
 
 from microbootstrap.bootstrappers.base import ApplicationBootstrapper
 from microbootstrap.instruments.cors_instrument import CorsInstrument
@@ -41,19 +40,13 @@ def bootstrap_before(self: typing_extensions.Self) -> dict[str, typing.Any]:
 
 @LitestarBootstrapper.use_instrument()
 class LitestarSentryInstrument(SentryInstrument):
-    @staticmethod
-    async def sentry_exception_catcher_hook(
-        exception: Exception,
-        _request_scope: litestar.types.Scope,
-    ) -> None:
-        if (
-            not isinstance(exception, HTTPException)
-            or exception.status_code >= status_codes.HTTP_500_INTERNAL_SERVER_ERROR
-        ):
-            sentry_sdk.capture_exception(exception)
-
-    def bootstrap_before(self) -> dict[str, typing.Any]:
-        return {"after_exception": [self.sentry_exception_catcher_hook]}
+    def bootstrap(self) -> None:
+        for sentry_integration in self.instrument_config.sentry_integrations:
+            if isinstance(sentry_integration, LitestarIntegration):
+                break
+        else:
+            self.instrument_config.sentry_integrations.append(LitestarIntegration())
+        super().bootstrap()
 
 
 @LitestarBootstrapper.use_instrument()

poetry.lock

@@ -76,6 +76,7 @@ async def test_litestar_opentelemetry_bootstrap_working(
 
     opentelemetry_middleware = opentelemetry_bootstrap_result["middleware"][0]
     assert isinstance(opentelemetry_middleware, DefineMiddleware)
+    async_mock.__name__ = "test-name"
     opentelemetry_middleware.middleware.__call__ = async_mock
 
     @litestar.get("/test-handler")

tests/instruments/test_opentelemetry.py

@@ -1,5 +1,4 @@
 import typing
-from unittest.mock import MagicMock
 
 import litestar
 from litestar.testing import AsyncTestClient
@@ -37,30 +36,8 @@ def test_sentry_teardown(
 
 def test_litestar_sentry_bootstrap(minimal_sentry_config: SentryConfig) -> None:
     sentry_instrument: typing.Final = LitestarSentryInstrument(minimal_sentry_config)
-
     sentry_instrument.bootstrap()
-    assert sentry_instrument.bootstrap_before() == {
-        "after_exception": [sentry_instrument.sentry_exception_catcher_hook],
-    }
-
-
-async def test_litestar_sentry_bootstrap_working(minimal_sentry_config: SentryConfig, magic_mock: MagicMock) -> None:
-    sentry_instrument: typing.Final = LitestarSentryInstrument(minimal_sentry_config)
-    sentry_instrument.sentry_exception_catcher_hook = magic_mock  # type: ignore[method-assign]
-
-    @litestar.get("/test-error-handler")
-    async def error_handler() -> None:
-        raise ValueError("I'm test error")
-
-    sentry_instrument.bootstrap()
-    litestar_application: typing.Final = litestar.Litestar(
-        route_handlers=[error_handler],
-        **sentry_instrument.bootstrap_before(),
-    )
-
-    async with AsyncTestClient(app=litestar_application) as async_client:
-        await async_client.get("/test-error-handler")
-        assert magic_mock.called
+    assert sentry_instrument.bootstrap_before() == {}
 
 
 async def test_litestar_sentry_bootstrap_catch_exception(
@@ -73,10 +50,7 @@ async def error_handler() -> None:
         raise ValueError("I'm test error")
 
     sentry_instrument.bootstrap()
-    litestar_application: typing.Final = litestar.Litestar(
-        route_handlers=[error_handler],
-        **sentry_instrument.bootstrap_before(),
-    )
+    litestar_application: typing.Final = litestar.Litestar(route_handlers=[error_handler])
 
     async with AsyncTestClient(app=litestar_application) as async_client:
         await async_client.get("/test-error-handler")