Improved Stack Trace for Collection Comparison #1615
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
dennisdoomen
approved these changes
Jun 22, 2021
jnyrup
approved these changes
Jun 22, 2021
Member
jnyrup
left a comment
There was a problem hiding this comment.
For the record, here's a dump of how this PR changes the stack trace.
act.Should().Throw<NotImplementedException>()
.Which.StackTrace.Should().Contain("ExceptionThrowingProperty");System.NotImplementedException: The method or operation is not implemented.
at FluentAssertions.Equivalency.Steps.GenericEnumerableEquivalencyStep.Handle(Comparands comparands, IEquivalencyValidationContext context, IEquivalencyValidator nestedValidator) in C:\dev\fluentassertions\Src\FluentAssertions\Equivalency\Steps\GenericEnumerableEquivalencyStep.cs:line 52
at FluentAssertions.Equivalency.EquivalencyValidator.RunStepsUntilEquivalencyIsProven(Comparands comparands, IEquivalencyValidationContext context) in C:\dev\fluentassertions\Src\FluentAssertions\Equivalency\EquivalencyValidator.cs:line 65
at FluentAssertions.Equivalency.EquivalencyValidator.RecursivelyAssertEquality(Comparands comparands, IEquivalencyValidationContext context) in C:\dev\fluentassertions\Src\FluentAssertions\Equivalency\EquivalencyValidator.cs:line 37
at FluentAssertions.Equivalency.EquivalencyValidator.AssertEquality(Comparands comparands, EquivalencyValidationContext context) in C:\dev\fluentassertions\Src\FluentAssertions\Equivalency\EquivalencyValidator.cs:line 19
at FluentAssertions.Collections.GenericCollectionAssertions`3.BeEquivalentTo[TExpectation](IEnumerable`1 expectation, Func`2 config, String because, Object[] becauseArgs) in C:\dev\fluentassertions\Src\FluentAssertions\Collections\GenericCollectionAssertions.cs:line 333
at FluentAssertions.Collections.GenericCollectionAssertions`3.BeEquivalentTo[TExpectation](IEnumerable`1 expectation, String because, Object[] becauseArgs) in C:\dev\fluentassertions\Src\FluentAssertions\Collections\GenericCollectionAssertions.cs:line 284
at FluentAssertions.Specs.Equivalency.CollectionEquivalencySpecs.<>c__DisplayClass113_0.<When_an_exception_is_thrown_during_data_access_the_stack_trace_contains_the_original_site>b__0() in C:\dev\fluentassertions\Tests\FluentAssertions.Specs\Equivalency\CollectionEquivalencySpecs.cs:line 2813
at FluentAssertions.Specs.Equivalency.CollectionEquivalencySpecs.When_an_exception_is_thrown_during_data_access_the_stack_trace_contains_the_original_site() in C:\dev\fluentassertions\Tests\FluentAssertions.Specs\Equivalency\CollectionEquivalencySpecs.cs:line 2817
Notice the second line not present in the trace above.
System.NotImplementedException: The method or operation is not implemented.
at FluentAssertions.Specs.Equivalency.CollectionEquivalencySpecs.ExceptionThrowingClass.get_ExceptionThrowingProperty() in C:\dev\fluentassertions\Tests\FluentAssertions.Specs\Equivalency\CollectionEquivalencySpecs.cs:line 196
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at FluentAssertions.Equivalency.Steps.GenericEnumerableEquivalencyStep.Handle(Comparands comparands, IEquivalencyValidationContext context, IEquivalencyValidator nestedValidator) in C:\dev\fluentassertions\Src\FluentAssertions\Equivalency\Steps\GenericEnumerableEquivalencyStep.cs:line 52
at FluentAssertions.Equivalency.EquivalencyValidator.RunStepsUntilEquivalencyIsProven(Comparands comparands, IEquivalencyValidationContext context) in C:\dev\fluentassertions\Src\FluentAssertions\Equivalency\EquivalencyValidator.cs:line 65
at FluentAssertions.Equivalency.EquivalencyValidator.RecursivelyAssertEquality(Comparands comparands, IEquivalencyValidationContext context) in C:\dev\fluentassertions\Src\FluentAssertions\Equivalency\EquivalencyValidator.cs:line 37
at FluentAssertions.Equivalency.EquivalencyValidator.AssertEquality(Comparands comparands, EquivalencyValidationContext context) in C:\dev\fluentassertions\Src\FluentAssertions\Equivalency\EquivalencyValidator.cs:line 19
at FluentAssertions.Collections.GenericCollectionAssertions`3.BeEquivalentTo[TExpectation](IEnumerable`1 expectation, Func`2 config, String because, Object[] becauseArgs) in C:\dev\fluentassertions\Src\FluentAssertions\Collections\GenericCollectionAssertions.cs:line 333
at FluentAssertions.Collections.GenericCollectionAssertions`3.BeEquivalentTo[TExpectation](IEnumerable`1 expectation, String because, Object[] becauseArgs) in C:\dev\fluentassertions\Src\FluentAssertions\Collections\GenericCollectionAssertions.cs:line 284
at FluentAssertions.Specs.Equivalency.CollectionEquivalencySpecs.<>c__DisplayClass113_0.<When_an_exception_is_thrown_during_data_access_the_stack_trace_contains_the_original_site>b__0() in C:\dev\fluentassertions\Tests\FluentAssertions.Specs\Equivalency\CollectionEquivalencySpecs.cs:line 2813
at FluentAssertions.Specs.Equivalency.CollectionEquivalencySpecs.When_an_exception_is_thrown_during_data_access_the_stack_trace_contains_the_original_site() in C:\dev\fluentassertions\Tests\FluentAssertions.Specs\Equivalency\CollectionEquivalencySpecs.cs:line 2817
@dennisdoomen Should this be targeted against the release-6.0 branch?
Member
Yes, I think it's totally fine to get it in 6.0 |
Contributor
Author
|
Do I have to do something? |
Member
|
Yes, to rebase it on the |
…e is returned from the unwrapping of the TargetInvocationException in GenericEnumerableEquivalencyStep.
…nner exception of the TargetInvocationException, so that the error message contains the correct stack trace.
a2819c4 to
3144bb3
Compare
Contributor
Author
|
Done. |
Member
|
Oh crap. We also forgot about the release notes. Would you mind adding a line to https://github.com/fluentassertions/fluentassertions/blob/release-6.0/docs/_pages/releases.md? |
Contributor
Author
|
Done. |
Member
|
Thanks for the contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This fixes #1613.
When an instance to compare throws an exception during the invocation of the HandleMethod in the Handle method of GenericEnumerableEquivalencyStep, the TargetInvocationException is unwrapped (to give the innermost exception) and rethrown. This previously lead to a wrong stack trace that would indicate, that something is wrong in GenericEnumerableEquivalencyStep.
The first commit provides a test that shows this.
The second commit fixes it by using ExceptionDispatchInfo to capture the stack trace. Since the class ExceptionExtensions is internal, the signature change of the Unwrap method is not changing the public API.
If you do not like the change of the method signature, there is a hack to keep it.
I read that I should add this fix to the release notes. In this branch or another branch?