fix(Litestar): Apply `failed_request_status_codes` to exceptions raised in middleware #4074

vrslev · 2025-02-19T08:41:41Z

This is a fix for #4021: exceptions raised in middleware were sent without taking into account failed_request_status_codes value.

See the test case for an example.

Thank you for contributing to sentry-python! Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. The AWS Lambda tests additionally require a maintainer to add a special label, and they will fail until this label is added.

codecov · 2025-02-19T08:50:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.66%. Comparing base (c2d5a76) to head (c26763f).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4074      +/-   ##
==========================================
- Coverage   80.67%   80.66%   -0.01%     
==========================================
  Files         142      142              
  Lines       15982    15988       +6     
  Branches     2729     2729              
==========================================
+ Hits        12893    12897       +4     
  Misses       2232     2232              
- Partials      857      859       +2

Files with missing lines	Coverage Δ
sentry_sdk/integrations/asgi.py	`86.30% <100.00%> (+0.38%)`	⬆️
sentry_sdk/integrations/litestar.py	`84.86% <100.00%> (+0.20%)`	⬆️

... and 3 files with indirect coverage changes

…tus-codes

vrslev · 2025-02-20T10:16:29Z

Relates to #3134

…tus-codes

vrslev · 2025-03-10T09:22:39Z

@sentrivana @antonpirker @untitaker can you review this please? 🙂

…tus-codes

szokeasaurusrex

Thank you for the contribution! I need some extra clarification on some items and also have some suggestions, please see the comments I left

szokeasaurusrex · 2025-04-01T12:53:03Z

sentry_sdk/integrations/asgi.py

@@ -57,17 +57,6 @@
 TRANSACTION_STYLE_VALUES = ("endpoint", "url")


-def _capture_exception(exc, mechanism_type="asgi"):


I would prefer to keep this function the same, as a standalone function instead of a method. I don't think it has to be modified to implement your changes

szokeasaurusrex · 2025-04-01T12:53:41Z

sentry_sdk/integrations/asgi.py

+    def _capture_lifespan_exception(self, exc):
+        # type: (Exception) -> None
+        return self._capture_exception(exc)
+
+    def _capture_request_exception(self, exc):


I am a bit unsure of the difference between these two functions. Please add docstrings to both to clarify the distinction

sentry_sdk/integrations/asgi.py

tests/integrations/litestar/test_litestar.py

szokeasaurusrex · 2025-04-01T12:56:51Z

sentry_sdk/integrations/litestar.py

+    def _capture_request_exception(self, exc):
+        # type: (Exception) -> None
+        """Ignore exceptions for requests here: we catch them in Litestar.after_exception handler."""


I am slightly unsure why this function is needed/how it relates to what you are trying to explain in this PR. Could you please explain in a bit more detail?

Also, I think you need a pass here:

Suggested change

def _capture_request_exception(self, exc):

# type: (Exception) -> None

"""Ignore exceptions for requests here: we catch them in Litestar.after_exception handler."""

def _capture_request_exception(self, exc):

# type: (Exception) -> None

"""Ignore exceptions for requests here: we catch them in Litestar.after_exception handler."""

pass

Currently, Litestar integration catches exceptions raised in middleware twice:

In the custom ASGI handler.

In the Litestar.after_exception handler, which is added in patch_app_init.

The custom ASGI handler doesn't filter exceptions using failed_request_status_codes, so all exceptions (including those not filtered by the expected status code) appear in Sentry.

Interestingly, this behavior doesn't apply to exceptions raised in request handlers because Litestar prepends the built-in exception handling middleware.

This leads us to the conclusion that the ASGI handler only catches exceptions raised in middleware or lifespan handlers. It's still valuable to catch exceptions from lifespan handlers.

In this case, we patch _capture_request_exception to prevent catching exceptions raised in middleware.

…nction

…rASGIMiddleware

…LitestarASGIMiddleware

… SentryAsgiMiddleware for better clarity and support for derived integrations.

…Middleware

…tus-codes

szokeasaurusrex

Hey @vrslev, apologies that this review took awhile for me to get around to.

Thanks for making the changes I requested and for explaining the two separate functions. These changes look good for the most part; however, before merging, I'd like us to add tests which ensure that any middleware exceptions which are not HttpExceptions are still captured by the Litestar integration even after these changes.

szokeasaurusrex · 2025-04-11T13:39:14Z

sentry_sdk/integrations/litestar.py

+        # type: (Exception) -> None
+        """Avoid catching exceptions from request handlers.
+
+        Those exceptions are already han in Litestar.after_exception handler.


Suggested change

Those exceptions are already han in Litestar.after_exception handler.

Those exceptions are already handled in Litestar.after_exception handler.

vrslev · 2025-06-03T16:08:04Z

Hey @szokeasaurusrex, I've added the test you asked for :)

szokeasaurusrex

lgtm, but I'd like a secondary review from someone else on the team before we merge

szokeasaurusrex · 2025-06-03T16:30:47Z

tests/integrations/litestar/test_litestar.py

+    except RuntimeError:
+        pass
+
+    assert len(events) == 1


I'd consider also asserting that the event is as expected (i.e. it is a runtime error with the message "Too Hot")

Makes sense. I’ll add it tomorrow 👍

…ware-failed-request-status-codes

vrslev added 5 commits February 19, 2025 11:28

Allow to override asgi capturers

0b64a40

Add test

4f1963c

Override request exception catcher for litestar

169177f

Fix formatting

3950e2a

Remove debugging print

e1cd18e

vrslev marked this pull request as ready for review February 19, 2025 08:43

Merge branch 'master' into fix-litestar-middleware-failed-request-sta…

2b91e0d

…tus-codes

Merge branch 'master' into fix-litestar-middleware-failed-request-sta…

6ac821b

…tus-codes

Merge branch 'master' into fix-litestar-middleware-failed-request-sta…

0c2da8f

…tus-codes

antonpirker requested a review from a team as a code owner March 27, 2025 09:42

szokeasaurusrex reviewed Apr 1, 2025

View reviewed changes

vrslev added 8 commits April 1, 2025 17:12

Add missing import line for test_litestar.py

204c8a7

Refactor exception capture in SentryAsgiMiddleware to use a shared fu…

bace5ce

…nction

Amend comment to clarify exception handling behavior in SentryLitesta…

fb1274f

…rASGIMiddleware

Adjust documentation to clarify exception handling behavior in Sentry…

babfe27

…LitestarASGIMiddleware

Added docstrings to lifespan and request exception capture methods in…

33b11cc

… SentryAsgiMiddleware for better clarity and support for derived integrations.

Adjusts exception documentation in SentryAsgiMiddleware for clarity

41b5fd5

Adjust comment for Litestar integration to remove unnecessary newline

3819888

Adjusts exception handling comments for clarity in SentryLitestarASGI…

5b27acd

…Middleware

vrslev requested a review from a team as a code owner April 1, 2025 14:51

Merge branch 'master' into fix-litestar-middleware-failed-request-sta…

53baddd

…tus-codes

vrslev requested a review from szokeasaurusrex April 1, 2025 14:52

Merge branch 'master' into fix-litestar-middleware-failed-request-sta…

c1c318d

…tus-codes

szokeasaurusrex reviewed Jun 3, 2025

View reviewed changes

vrslev added 2 commits June 3, 2025 19:07

Fix typo

a401a5e

Add requested test

524e77e

vrslev requested a review from szokeasaurusrex June 3, 2025 16:08

szokeasaurusrex approved these changes Jun 3, 2025

View reviewed changes

szokeasaurusrex requested review from szokeasaurusrex, antonpirker, sentrivana and sl0thentr0py June 3, 2025 16:31

Merge remote-tracking branch 'origin/master' into fix-litestar-middle…

c26763f

…ware-failed-request-status-codes

szokeasaurusrex approved these changes Jun 3, 2025

View reviewed changes

Add more asserts to newly added test

2158823

vrslev requested a review from szokeasaurusrex June 3, 2025 19:41

		@@ -57,17 +57,6 @@
		TRANSACTION_STYLE_VALUES = ("endpoint", "url")


		def _capture_exception(exc, mechanism_type="asgi"):

	Those exceptions are already han in Litestar.after_exception handler.
	Those exceptions are already handled in Litestar.after_exception handler.

fix(Litestar): Apply failed_request_status_codes to exceptions raised in middleware #4074

Are you sure you want to change the base?

fix(Litestar): Apply failed_request_status_codes to exceptions raised in middleware #4074

Conversation

vrslev commented Feb 19, 2025

Uh oh!

codecov bot commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

vrslev commented Feb 20, 2025

Uh oh!

vrslev commented Mar 10, 2025

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vrslev commented Jun 3, 2025

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fix(Litestar): Apply `failed_request_status_codes` to exceptions raised in middleware #4074

fix(Litestar): Apply `failed_request_status_codes` to exceptions raised in middleware #4074

codecov bot commented Feb 19, 2025 •

edited

Loading