Warn on DAM mismatch between overrides#2656
Merged
jtschuster merged 11 commits intodotnet:mainfrom Mar 11, 2022
Merged
Conversation
Member
I agree that it would make more sense, the question is if it's worth the change. If there's an existing suppression, fixing this will break that suppression. I'm not sure the change is important enough to risk a break like that. |
vitek-karas
reviewed
Feb 25, 2022
src/ILLink.RoslynAnalyzer/DynamicallyAccessedMembersAnalyzer.cs
Outdated
Show resolved
Hide resolved
src/ILLink.RoslynAnalyzer/DynamicallyAccessedMembersAnalyzer.cs
Outdated
Show resolved
Hide resolved
Comment on lines
+268
to
+276
| var methodParamHasDam = methodTypeParam.TryGetAttribute (DynamicallyAccessedMembersAttribute, out var methodTypeParamAttribute); | ||
| var overriddenParamHasDam = overriddenTypeParam.TryGetAttribute (DynamicallyAccessedMembersAttribute, out var overriddenTypeParamAttribute); | ||
| if ((methodParamHasDam && overriddenParamHasDam && !DamAttributesMatch (methodTypeParamAttribute!, overriddenTypeParamAttribute!)) | ||
| || (methodParamHasDam ^ overriddenParamHasDam)) { | ||
| context.ReportDiagnostic (Diagnostic.Create ( | ||
| DiagnosticDescriptors.GetDiagnosticDescriptor (DiagnosticId.DynamicallyAccessedMembersMismatchOnGenericParameterBetweenOverrides), | ||
| methodTypeParam.Locations[0], | ||
| methodTypeParam.GetDisplayName (), method.GetDisplayName (), overriddenTypeParam.GetDisplayName (), overriddenMethod.GetDisplayName ())); | ||
| } |
Member
There was a problem hiding this comment.
Would it be possible to refactor this to share the code between the four places? The condition and warnings are nearly identical.
Member
Author
There was a problem hiding this comment.
I tried to, and for me the slight differences in each case are just enough so that anything I tried ended up adding complexity without reducing repetition.
src/ILLink.RoslynAnalyzer/DynamicallyAccessedMembersAnalyzer.cs
Outdated
Show resolved
Hide resolved
src/ILLink.RoslynAnalyzer/DynamicallyAccessedMembersAnalyzer.cs
Outdated
Show resolved
Hide resolved
src/ILLink.RoslynAnalyzer/DynamicallyAccessedMembersAnalyzer.cs
Outdated
Show resolved
Hide resolved
test/ILLink.RoslynAnalyzer.Tests/DynamicallyAccessedMembersAnalyzerTests.cs
Show resolved
Hide resolved
test/ILLink.RoslynAnalyzer.Tests/DynamicallyAccessedMembersAnalyzerTests.cs
Outdated
Show resolved
Hide resolved
vitek-karas
approved these changes
Mar 2, 2022
Member
vitek-karas
left a comment
vitek-karas
left a comment
There was a problem hiding this comment.
Some minor comments, but looks good otherwise.
src/ILLink.RoslynAnalyzer/DynamicallyAccessedMembersAnalyzer.cs
Outdated
Show resolved
Hide resolved
vitek-karas
approved these changes
Mar 9, 2022
sbomer
approved these changes
Mar 9, 2022
Member
sbomer
left a comment
sbomer
left a comment
There was a problem hiding this comment.
LGTM, only a few nits. Thank you!
src/ILLink.RoslynAnalyzer/DynamicallyAccessedMembersAnalyzer.cs
Outdated
Show resolved
Hide resolved
src/ILLink.RoslynAnalyzer/DynamicallyAccessedMembersAnalyzer.cs
Outdated
Show resolved
Hide resolved
agocke
pushed a commit
to dotnet/runtime
that referenced
this pull request
Nov 16, 2022
* Warn on DAM mismatch between overrides Commit migrated from dotnet/linker@ac6cfb3
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
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.
Fixes #2512
Adds checks to ensure that method overrides have the same DAM annotations as the virtual methods / interfaces. Warning on the implicit 'this' meant I had to add annotations to the test class that inherited from
Typeand update the expected warnings related to that class.I found that the when there is a mismatch between DAM on a property and on the accessor, the linker will warn on the accessor, but use that DAM annotation instead of the property's. I think it would make more sense to warn on the property, so the analyzer warns there, and I filed #2654 to track the issue with the linker.
Also created a helper to find all the interface members that a type implements, which also takes into account any interfaces an interface recursively implements, and updated the RequiresAnalyzer to use that helper.
Finally, updated the checks for
LogContainsandLogDoesNotContainin the analyzer tests to support Regex matches and deduplicated some code there.