Add an analyzer for Debug.Assert #7416
Merged
Conversation
This file contains 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
As @jaredpar found in dotnet/roslyn#75163, interpolated strings in `Debug.Assert` can consume a surprising amount of memory. On modern .NET, this is fine; `Debug.Assert` has an interpolated string handler that will avoid the allocations if the assert isn't triggered. However, on our framework tests, this can be very bad and OOM our tests. So, this analyzer looks for cases where interpolated strings are passed to `Debug.Assert`, and recommends moving over to `RoslynDebug.Assert` instead, which is an interpolated string handler on all platforms. Note that I only did C# support, as there's no equivalent handler API for VB.
jjonescz
reviewed
Sep 19, 2024
src/Roslyn.Diagnostics.Analyzers/CSharp/CSharpDoNotUseDebugAssertForInterpolatedStrings.cs
Outdated
Show resolved
Hide resolved
|
@sharwell, any what's going on with this failure? Running |
|
@dotnet/roslyn-compiler @sharwell for review |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #7416 +/- ##
==========================================
- Coverage 96.50% 96.50% -0.01%
==========================================
Files 1443 1446 +3
Lines 346376 346544 +168
Branches 11387 11396 +9
==========================================
+ Hits 334263 334417 +154
- Misses 9232 9240 +8
- Partials 2881 2887 +6 |
sharwell
approved these changes
Sep 24, 2024
sharwell
reviewed
Sep 24, 2024
src/Roslyn.Diagnostics.Analyzers/CSharp/CSharpDoNotUseDebugAssertForInterpolatedStrings.cs
Outdated
Show resolved
Hide resolved
jaredpar
approved these changes
Sep 26, 2024
src/Roslyn.Diagnostics.Analyzers/CSharp/CSharpDoNotUseDebugAssertForInterpolatedStringsFixer.cs
Outdated
Show resolved
Hide resolved
src/Roslyn.Diagnostics.Analyzers/CSharp/CSharpDoNotUseDebugAssertForInterpolatedStringsFixer.cs
Outdated
Show resolved
Hide resolved
src/Roslyn.Diagnostics.Analyzers/CSharp/CSharpDoNotUseDebugAssertForInterpolatedStrings.cs
Outdated
Show resolved
Hide resolved
src/Roslyn.Diagnostics.Analyzers/CSharp/CSharpDoNotUseDebugAssertForInterpolatedStrings.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Jared Parsons <[email protected]>
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.
As @jaredpar found in dotnet/roslyn#75163, interpolated strings in
Debug.Assertcan consume a surprising amount of memory. On modern .NET, this is fine;Debug.Asserthas an interpolated string handler that will avoid the allocations if the assert isn't triggered. However, on our framework tests, this can be very bad and OOM our tests. So, this analyzer looks for cases where interpolated strings are passed toDebug.Assert, and recommends moving over toRoslynDebug.Assertinstead, which is an interpolated string handler on all platforms. Note that I only did C# support, as there's no equivalent handler API for VB.