Fix repeatable attribute matching in ApiCompat#55448
Open
JoshLove-msft wants to merge 1 commit into
Open
Conversation
Match repeatable attributes as multisets so added instances are not reported as changed and duplicate instances cannot reuse the same match. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 432bd163-3c37-4310-8e2d-026ac6e48f95
|
Azure Pipelines: Successfully started running 1 pipeline(s). 2 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
Pull request overview
Improves ApiCompat’s AttributesMustMatch rule to correctly compare repeatable attributes by matching attribute instances as a multiset, avoiding erroneous “changed” reports when instances are actually added/removed and preventing reusing the same right-side instance for multiple matches.
Changes:
- Update
AttributesMustMatchto first match identical attribute instances one-to-one, then classify remaining instances as changed/removed/added. - Preserve existing behavior of suppressing “added attribute” differences when not in strict mode (via the existing early-return in
AddDifference). - Expand/adjust tests to cover repeatable attribute add/remove/change scenarios and update strict-mode expectations to use
CannotAddAttributefor newly-added instances.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompatibility.Tests/Rules/AttributesMustMatchTests.cs | Adds coverage for repeatable attribute multiset behavior and updates strict-mode expectations for added instances. |
| src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompatibility/Rules/AttributesMustMatch.cs | Implements multiset-style matching for repeated attributes and reports remaining instances as changed/removed/added appropriately. |
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
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.
Summary
Match repeated attributes as multisets in
AttributesMustMatch.This prevents an added repeatable attribute instance from being reported as a change to an existing instance, and prevents duplicate left instances from reusing the same right-side match.
Fixes part of #35542.
Tests
Microsoft.DotNet.ApiCompatibility.Tests(250 passed)