fix: toHaveStyle assertion with invalid style (#564) #582
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
Given an invalid declaration such as `fontSize: 8`, due to the missing unit, the `toHaveStyle` matcher should not pass the following test: ``` render(<div data-testid="element" style={{ fontSize: 8 }} />) expect(screen.getByTestId('element')).toHaveStyle({ fontSize: 1 }) ``` This PR fixes testing-library#564 by adding a more restrictive guard in the matcher's logic. 
gnapse approved these changes Mar 4, 2024
Member
gnapse left a comment
gnapse left a comment There was a problem hiding this comment.
Looks good, thanks!
Although it may benefit from a comment on the new helper function as mentioned/requested below.
Comment on lines +17 to +24
| function isInvalidStyleDeclaration(name, value, computedStyle) { | ||
| return ( | ||
| name && | ||
| !value && | ||
| !computedStyle[name] && | ||
| !computedStyle.getPropertyValue(name) | ||
| ) | ||
| } |
Member
There was a problem hiding this comment.
It is not fully evident (to me at least) why this works. I'm not saying I doubt that it works, I'm saying that perhaps this function could use a jsdoc to explain what it does. Or at the very least can you share here the logic? Perhaps no comment is needed, and I'm just having trouble to understand it myself.
Author
There was a problem hiding this comment.
Good point! Actually getting it to work was a bit tricky, so a comment would not harm.
Co-authored-by: Ernesto García <ernesto@ernesto.dev>
Author
| Hey @gnapse , would it be possible to add the Hacktoberfest label to the PR? |
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.
What:
Given an invalid declaration such as
fontSize: 8, due to the missing unit, thetoHaveStylematcher should not pass the following test:Why:
Refer to the original issue for more info: #564
How:
This PR fixes #564 by adding a more restrictive guard in the matcher's logic.
Checklist: