This repository was archived by the owner on Jan 23, 2023. It is now read-only.
Audit System.Net throws losing stack traces #16898
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
There are a bunch of places throughout the System.Net libraries where exceptions are captured and later thrown, using `throw e;`. This overwrites their stack trace and bucket information, making it harder to diagnose problems when they occur. Over time we've chipped away at these, so there are many fewer now than there used to be, but some still remain. I've audited all of the System.Net libs, and fixed all the locations I found where this pattern was being employed, replacing them with usage of ExceptionDispatchInfo to avoid losing the call stack data. There are still some `throw e`s I left, but those were typically of a form where it was obvious no data would be lost, e.g. the exception was just instantiated a few lines earlier. There are likely also a few straggling cases, e.g. where `throw SomeFunction()` is used and `SomeFunction()` returns a cached exception instance, but we can address those on a case-by-case basis as we find them.
|
Why don't we have public static class ExceptionExtensions
{
public static void Rethrow(this Exception exception)
{
ExceptionDispatchInfo.Capture(exception).Throw();
}
} |
|
ianhays
approved these changes
Mar 9, 2017
| @@ -641,7 +642,7 @@ private static void SendEHelloCallback(IAsyncResult result) | |||
| if ((e.StatusCode != SmtpStatusCode.CommandUnrecognized) | |||
| && (e.StatusCode != SmtpStatusCode.CommandNotImplemented)) | |||
| { | |||
| throw e; | |||
| throw; | |||
There was a problem hiding this comment.
throw retains the information but not throw e? Why don't we need the Capture/Throw here?
There was a problem hiding this comment.
Right. throw; can only be used inside of a catch block, and effectively continues the propagation of the exception that was caught (kind of like catch-and-release'ing a fish), so it retains its original info. throw e; can be done anywhere, and overwrites the info.
There was a problem hiding this comment.
gotcha, thanks for the explanation.
Yes, this is a very self-serving change 😉 |
picenka21
pushed a commit
to picenka21/runtime
that referenced
this pull request
Feb 18, 2022
…on_throws Audit System.Net throws losing stack traces Commit migrated from dotnet/corefx@70114fe
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
There are a bunch of places throughout the System.Net libraries where exceptions are captured and later thrown, using
throw e;. This overwrites their stack trace and bucket information, making it harder to diagnose problems when they occur. Over time we've chipped away at these, so there are many fewer now than there used to be, but some still remain.I've audited all of the System.Net libs, and fixed all the locations I found where this pattern was being employed, replacing them with usage of ExceptionDispatchInfo to avoid losing the call stack data. There are still some
throw es I left, but those were typically of a form where it was obvious no data would be lost, e.g. the exception was just instantiated a few lines earlier. There are likely also a few straggling cases, e.g. wherethrow SomeFunction()is used andSomeFunction()returns a cached exception instance, but we can address those on a case-by-case basis as we find them.Fixes https://github.com/dotnet/corefx/issues/5606
cc: @geoffkizer, @CIPop, @davidsh, @Priya91