fix: validate selectorPriority configuration #18573
Merged
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
mjhenkes
requested review from
BlueWinds and
emilyrohrbough
and removed request for
a team
|
Thanks for taking the time to open a PR!
|
|
|
|
Test summary
Run details
View run in Cypress Dashboard ➡️ Flakiness
This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
||||||||||||||||||||||||||||||||||
| .and.include('`Cypress.SelectorPlayground.defaults()` called with invalid `selectorPriority` property. It must be one of: `data-*`, `id`, `class`, `tag`, `attributes`, `nth-child`. You passed: `name`') | ||
| }) | ||
|
|
||
| it('throws if selector:playground:priority if selectorPriority contains an unsupported priority that contains a valid priority', () => { |
There was a problem hiding this comment.
Are these test names flipped?
There was a problem hiding this comment.
I'm trying to say 'idIsNotValid' contains the substring 'id' to demonstrate we're testing the full word and not just starts with. I'm open to better ways of saying that. 😅
There was a problem hiding this comment.
ahhh maybe
throws selector:playground:priority if selectorPriority has an unsupported priority that contains a substring of a valid priority
Co-authored-by: Emily Rohrbough <[email protected]>
emilyrohrbough
previously approved these changes
Oct 20, 2021
chrisbreiding
requested changes
Oct 21, 2021
packages/driver/cypress/integration/cypress/selector_playground_spec.js
Outdated
Show resolved
Hide resolved
packages/driver/cypress/integration/cypress/selector_playground_spec.js
Outdated
Show resolved
Hide resolved
Co-authored-by: Chris Breiding <[email protected]>
chrisbreiding
approved these changes
Oct 21, 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.
Cypress.SelectorPlayground.defaults - selectorPrioritybreaks the Selector Playground #7745User facing changelog
This introduces validation for the
selectorPriorityconfiguration option. Previously any values were accepted, but any values other thandata-*,id,class,tag,attribute, ornth-childwould cause the selector playground to error out in the cypress app.Additional details
We use a fork of the unique-selector package to generate the selectors for the playground. The unique-selector package only supports the following 'priorities':
data-*idclassattributesnth-childtagAdding the
namepriority causes the getAllSelectors function to blow up because it doesn't have a function to create a selector for that attribute.How has the user experience changed?
The app will now display an exception if the selectorPriority configuration has been setup with unsupported values. This is preferable to having the selector playground cease functioning.
PR Tasks