feat(ipa): error on unneeded exceptions IPA 005-104 #877
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
| * @param {Array<string>} objectPath the JSON path to the object | ||
| * @returns {Array<{path: Array<string>, message: string}>|undefined} an array of the validation errors, or undefined if there are no errors | ||
| */ | ||
| export function collectExceptionAdoptionViolations(validationErrors, ruleName, object, objectPath) { |
There was a problem hiding this comment.
I am looking for a better function name, what about evaluateAndCollectAdoptionStatus or something like that?
There was a problem hiding this comment.
It might apply to the function below as well, if we are allowed to use same function name with different signature
There was a problem hiding this comment.
Agree the name is bad :) evaluateAndCollectAdoptionStatus sounds good!
No you can't have the same name with different params unfortunately, I'll name it evaluateAndCollectAdoptionStatusWithoutExceptions for now, it's a bit long but let me know what you think
There was a problem hiding this comment.
Sounds good to me, we'll change it later if we can find any better. Thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Proposed changes
This PR introduces a new helper function to handle all violations, exceptions and adoptions for a rule.
The idea is that when violations are collected in a rule, this function gets called to handle metric collection as well as silencing violations with exceptions.
Additionally, thing brings the functionality to error if there are no violations, but the component still has exceptions. This allows us to remove unnecessary exceptions in the OAS.
For now IPA 005-104 are updated using the new helper function. I'll adjust the other IPAs in incremental follow-up PRs to keep the PRs smaller.
Finally, I'll update the OAS and remove identified exceptions that are no longer needed + remove temporary Spectral overrides.
Jira ticket: CLOUDP-307585
Exceptions found that can be removed: