-
-
Notifications
You must be signed in to change notification settings - Fork 221
fix: Sentry capturing compressed bodies when RequestDecompression middleware is enabled #4315
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
This file contains hidden or 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
#skip-changelog
Flash0ver
reviewed
Jul 7, 2025
src/Sentry.AspNetCore/RequestDecompression/RequestDecompressionMiddleware.cs
Show resolved
Hide resolved
src/Sentry.AspNetCore/RequestDecompression/RequestDecompressionMiddleware.cs
Outdated
Show resolved
Hide resolved
...entry.AspNetCore.Tests/RequestDecompressionMiddleware/RequestDecompressionMiddlewareTests.cs
Outdated
Show resolved
Hide resolved
...entry.AspNetCore.Tests/RequestDecompressionMiddleware/RequestDecompressionMiddlewareTests.cs
Show resolved
Hide resolved
Flash0ver
approved these changes
Jul 8, 2025
This was referenced Aug 1, 2025
This was referenced Aug 15, 2025
This was referenced Aug 27, 2025
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.
Resolves #4312:
Summary
Due to the SentryStartupFilter, Sentry's middleware is the first middleware in the chain, so was being called before the
RequestDecompressionMiddleware
. Because of this, theHttpContext.Request.Body
that Sentry was storing on the Scope (and therefore events) was not being uncompressed as you would expect when enabling this middleware.Solution
This PR alters the
SentryStartupFilter
so that it checks whetherIRequestDecompressionProvider
has been registered in the services collection (see RequestDecompressionServiceExtensions). If it is then theRequestDecompressionMiddleware
is registered before Sentry's middleware.So that we can capture any exceptions that may occur during decompression, we're using a custom RequestDecompressionMiddleware that we vendored in from https://github.com/dotnet/aspnetcore (all of the code we vendored in can be found in the
src/Sentry.AspNetCore/RequestDecompression
folder, with appropriate attribution).Potential issues
app.UseRequestDecompression();
at some point, which will register the middleware a second time. This shouldn't cause any issues... the second instance of the middleware will return null from the call to _provider.GetDecompressionStream and then simply call the next middlewareSizeLimitedStream
, which does not supportStream.Seek
... we can't restore the stream position to 0 on this stream once we're done reading it then. We do EnableBuffering which hopefully mitigates any possible side effects of doing this.