fix(core): consider message when de-duplicating results
#2052
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
Before this change, the `code` and `path` of the results were the primary factors considered in de-duplication. Results that came from the same rule and same OpenAPI artifact but had different messages were de-duplicated and not all unique results were returned. This change updates the logic to take `message` into account so that all unique results are displayed to the user.
|
Hey! |
|
This is a welcome change! I think many users will benefit from this. Great work @dpopp07! |
4 tasks
P0lip
reviewed
Feb 11, 2022
packages/rulesets/src/oas/__tests__/duplicated-entry-in-enum.test.ts
Outdated
Show resolved
Hide resolved
P0lip
reviewed
Feb 11, 2022
packages/rulesets/src/oas/__tests__/duplicated-entry-in-enum.test.ts
Outdated
Show resolved
Hide resolved
stoplight-bot
pushed a commit
that referenced
this pull request
Feb 14, 2022
# [@stoplight/spectral-core-v1.10.1](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-core-v1.10.0...@stoplight/spectral-core-v1.10.1) (2022-02-14) ### Bug Fixes * **core:** consider `message` when de-duplicating results ([#2052](#2052)) ([b07cc7b](b07cc7b))
|
🎉 This PR is included in version @stoplight/spectral-core-v1.10.1 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
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.
Before this change, the
codeandpathof the results were the primary factorsconsidered in de-duplication. Results that came from the same rule and same OpenAPI
artifact but had different messages were de-duplicated and not all unique results
were returned.
This change updates the logic to take
messageinto account so that all uniqueresults are displayed to the user.
I added a new test to confirm the behavior. I also updated an existing test - one of the tests resulted in multiple results returned for the same OpenAPI artifact with different error messages. I looked into addressing the extra rules but in this case, they are a little bit redundant and so I updated the tests to make the additional results expected. Let me know how you feel about this as an approach.
I also removed the outdated docs about custom de-duplication logic.
Fixes #2038
Checklist
Does this PR introduce a breaking change?