Fixes issue when violations count is reported to be 0 #272
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
rwjblue
approved these changes
Jul 1, 2021
ckundo
approved these changes
Jul 1, 2021
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.
It's possible when encountering violations that the violations' node array is empty. In that case, when we try to format the violation, we output a 0 count for violations due to the fact we try to infer the violations count occurrences through the presence of node's html.
In addition, the
formatViolationtests were not indicative of the actual execution of this function. The function signature indicated that both violation and markup could be either undefined or optional respectively, but this did not reflect how this was used in practice. The two parameters are always required, and this misalignment helped manifest this bug.This PR addresses both fixing the issue, and updating the tests to better reflect the usage.