feat: Rename SelectorPlayground API to ElementSelector API #31889
Conversation
BREAKING: Rename SelectorPriority API to ElementSelector API
jennifer-shehane
changed the title
…/github.com/cypress-io/cypress into selector-playground-api-to-element-selector
cypress
|
||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
selector-playground-api-to-element-selector
|
| Run status |
|
| Run duration | 17m 07s |
| Commit |
|
| Committer | Jennifer Shehane |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
3
|
Pending
|
133
|
Skipped
|
0
|
Passing
|
5553
|
| View all changes introduced in this branch ↗︎ | |
| @@ -0,0 +1,86 @@ | |||
| /// <reference types="cypress" /> | |||
There was a problem hiding this comment.
Converted to TypeScript - the tests are the same except for removing tests around onElement
| @@ -0,0 +1,81 @@ | |||
| /// <reference types="cypress" /> | |||
There was a problem hiding this comment.
Also converted to TS. The content is the same except for removing onElement and renaming element_selector
|
|
||
| const VALID_SELECTOR_PRIORITY_REGEX = /^(data\-.+|id|class|tag|attributes|nth\-child|attribute:(.+)|name)$/ | ||
|
|
||
| export const DEFAULT_SELECTOR_PRIORITIES = [ |
There was a problem hiding this comment.
Should the values here match the type we export in cypress.d.ts - Cypress.SelectorPriority[]?
There was a problem hiding this comment.
I'll take another look at these comments. I added the cypress types after the fact so probably should have looked back at the code to make sure they make sense together.
There was a problem hiding this comment.
No, this is actually the exact selectorPriority that Cypress will pass by default to the unique-selector, not just the TYPE of selector priorities accepted.
| 'nth-child', | ||
| ] as const | ||
|
|
||
| export type SelectorType = string |
There was a problem hiding this comment.
Instead of this type, we should probably use Cypress.SelectorPriority, unless we accept strings that are not included in that union.
There was a problem hiding this comment.
Updated the Cypress.SelectorPriority to be used everywhere.
|
Pausing on merging this until the Studio side updates handling Cypress.ElementSelector to address the test failure. |
Additional details
SelectorPlaygroundAPI toElementSelector- an error is thrown when users use theSelectorPlaygroundAPI.unique-selectorpackage to latest - this should bring in smarter selectors and an expanded API.nameandattribute:*selectors as they are accepted inunique-selector. Types are now more specific also.Steps to test
experimentalStudioUI - ensuring it adds selectors properly - accepting selectorPriority.How has the user experience changed?
Cypress.SelectorPlayground errors when called
Can now use
nameattribute inselectorPriority!Can now use
attribute:*inselectorPriority!Current studio selector generation still works!
PR Tasks
cypress-documentation? Updates for renaming SelectorPlayground to ElementSelector API cypress-documentation#6212type definitions?