Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: do not escape css selectors for .css syntax (#36081)

Pavel Feldman817e1727fb59
diff --git a/packages/injected/src/selectorGenerator.ts b/packages/injected/src/selectorGenerator.ts
index d106a3a752..8410d7dc7d 100644
--- a/packages/injected/src/selectorGenerator.ts
+++ b/packages/injected/src/selectorGenerator.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import { cssEscape, escapeForAttributeSelector, escapeForTextSelector, escapeRegExp, quoteCSSAttributeValue } from '@isomorphic/stringUtils';
+import { escapeForAttributeSelector, escapeForTextSelector, escapeRegExp, quoteCSSAttributeValue } from '@isomorphic/stringUtils';
import { closestCrossShadow, isElementVisible, isInsideScope, parentElementOrShadowHost } from './domUtils';
import { beginAriaCaches, endAriaCaches, getAriaRole, getElementAccessibleName } from './roleUtils';
@@ -245,13 +245,13 @@ function buildNoTextCandidates(injectedScript: InjectedScript, element: Element,
candidates.push({ engine: 'css', selector: makeSelectorForId(idAttr), score: kCSSIdScore });
}
- candidates.push({ engine: 'css', selector: cssEscape(element.nodeName.toLowerCase()), score: kCSSTagNameScore });
+ candidates.push({ engine: 'css', selector: escapeNodeName(element), score: kCSSTagNameScore });
}
if (element.nodeName === 'IFRAME') {
for (const attribute of ['name', 'title']) {
if (element.getAttribute(attribute))
- candidates.push({ engine: 'css', selector: `${cssEscape(element.nodeName.toLowerCase())}[${attribute}=${quoteCSSAttributeValue(element.getAttribute(attribute)!)}]`, score: kIframeByAttributeScore });
+ candidates.push({ engine: 'css', selector: `${escapeNodeName(element)}[${attribute}=${quoteCSSAttributeValue(element.getAttribute(attribute)!)}]`, score: kIframeByAttributeScore });
}
// Locate by testId via CSS selector.
@@ -288,15 +288,15 @@ function buildNoTextCandidates(injectedScript: InjectedScript, element: Element,
candidates.push({ engine: 'internal:role', selector: ariaRole, score: kRoleWithoutNameScore });
if (element.getAttribute('name') && ['BUTTON', 'FORM', 'FIELDSET', 'FRAME', 'IFRAME', 'INPUT', 'KEYGEN', 'OBJECT', 'OUTPUT', 'SELECT', 'TEXTAREA', 'MAP', 'META', 'PARAM'].includes(element.nodeName))
- candidates.push({ engine: 'css', selector: `${cssEscape(element.nodeName.toLowerCase())}[name=${quoteCSSAttributeValue(element.getAttribute('name')!)}]`, score: kCSSInputTypeNameScore });
+ candidates.push({ engine: 'css', selector: `${escapeNodeName(element)}[name=${quoteCSSAttributeValue(element.getAttribute('name')!)}]`, score: kCSSInputTypeNameScore });
if (['INPUT', 'TEXTAREA'].includes(element.nodeName) && element.getAttribute('type') !== 'hidden') {
if (element.getAttribute('type'))
- candidates.push({ engine: 'css', selector: `${cssEscape(element.nodeName.toLowerCase())}[type=${quoteCSSAttributeValue(element.getAttribute('type')!)}]`, score: kCSSInputTypeNameScore });
+ candidates.push({ engine: 'css', selector: `${escapeNodeName(element)}[type=${quoteCSSAttributeValue(element.getAttribute('type')!)}]`, score: kCSSInputTypeNameScore });
}
if (['INPUT', 'TEXTAREA', 'SELECT'].includes(element.nodeName) && element.getAttribute('type') !== 'hidden')
- candidates.push({ engine: 'css', selector: cssEscape(element.nodeName.toLowerCase()), score: kCSSInputTypeNameScore + 1 });
+ candidates.push({ engine: 'css', selector: escapeNodeName(element), score: kCSSInputTypeNameScore + 1 });
penalizeScoreForLength([candidates]);
return candidates;
@@ -330,7 +330,7 @@ function buildTextCandidates(injectedScript: InjectedScript, element: Element, i
for (const alternative of textAlternatives)
candidates.push([{ engine: 'internal:text', selector: escapeForTextSelector(alternative.text, false), score: kTextScore - alternative.scoreBonus }]);
}
- const cssToken: SelectorToken = { engine: 'css', selector: cssEscape(element.nodeName.toLowerCase()), score: kCSSTagNameScore };
+ const cssToken: SelectorToken = { engine: 'css', selector: escapeNodeName(element), score: kCSSTagNameScore };
for (const alternative of textAlternatives)
candidates.push([cssToken, { engine: 'internal:has-text', selector: escapeForTextSelector(alternative.text, false), score: kTextScore - alternative.scoreBonus }]);
if (text.length <= 80) {
@@ -363,7 +363,7 @@ function buildTextCandidates(injectedScript: InjectedScript, element: Element, i
}
function makeSelectorForId(id: string) {
- return /^[a-zA-Z][a-zA-Z0-9\-\_]+$/.test(id) ? '#' + id : `[id="${cssEscape(id)}"]`;
+ return /^[a-zA-Z][a-zA-Z0-9\-\_]+$/.test(id) ? '#' + id : `[id=${quoteCSSAttributeValue(id)}]`;
}
function hasCSSIdToken(tokens: SelectorToken[]) {
@@ -395,8 +395,6 @@ function cssFallback(injectedScript: InjectedScript, targetElement: Element, opt
}
for (let element: Element | undefined = targetElement; element && element !== root; element = parentElementOrShadowHost(element)) {
- const nodeName = element.nodeName.toLowerCase();
-
let bestTokenForLevel: string = '';
// Element ID is the strongest signal, use it.
@@ -411,9 +409,9 @@ function cssFallback(injectedScript: InjectedScript, targetElement: Element, opt
const parent = element.parentNode as (Element | ShadowRoot);
// Combine class names until unique.
- const classes = [...element.classList];
+ const classes = [...element.classList].map(escapeClassName);
for (let i = 0; i < classes.length; ++i) {
- const token = '.' + cssEscape(classes.slice(0, i + 1).join('.'));
+ const token = '.' + classes.slice(0, i + 1).join('.');
const selector = uniqueCSSSelector(token);
if (selector)
return makeStrict(selector);
@@ -428,15 +426,16 @@ function cssFallback(injectedScript: InjectedScript, targetElement: Element, opt
// Ordinal is the weakest signal.
if (parent) {
const siblings = [...parent.children];
- const sameTagSiblings = siblings.filter(sibling => (sibling).nodeName.toLowerCase() === nodeName);
- const token = sameTagSiblings.indexOf(element) === 0 ? cssEscape(nodeName) : `${cssEscape(nodeName)}:nth-child(${1 + siblings.indexOf(element)})`;
+ const nodeName = element.nodeName;
+ const sameTagSiblings = siblings.filter(sibling => sibling.nodeName === nodeName);
+ const token = sameTagSiblings.indexOf(element) === 0 ? escapeNodeName(element) : `${escapeNodeName(element)}:nth-child(${1 + siblings.indexOf(element)})`;
const selector = uniqueCSSSelector(token);
if (selector)
return makeStrict(selector);
if (!bestTokenForLevel)
bestTokenForLevel = token;
} else if (!bestTokenForLevel) {
- bestTokenForLevel = cssEscape(nodeName);
+ bestTokenForLevel = escapeNodeName(element);
}
tokens.unshift(bestTokenForLevel);
}
@@ -572,3 +571,13 @@ function suitableTextAlternatives(text: string) {
return result;
}
+
+function escapeNodeName(node: Node): string {
+ // We are escaping it for document.querySelectorAll, not for usage in CSS file.
+ return node.nodeName.toLocaleLowerCase().replace(/[:\.]/g, char => '\\' + char);
+}
+
+function escapeClassName(className: string): string {
+ // We are escaping it for document.querySelectorAll, not for usage in CSS file.
+ return className.replace(/[:\.]/g, char => '\\' + char);
+}
diff --git a/packages/playwright-core/src/utils/isomorphic/stringUtils.ts b/packages/playwright-core/src/utils/isomorphic/stringUtils.ts
index 5a7602c97a..6cbab2670f 100644
--- a/packages/playwright-core/src/utils/isomorphic/stringUtils.ts
+++ b/packages/playwright-core/src/utils/isomorphic/stringUtils.ts
@@ -47,31 +47,8 @@ export function toSnakeCase(name: string): string {
return name.replace(/([a-z0-9])([A-Z])/g, '$1_$2').replace(/([A-Z])([A-Z][a-z])/g, '$1_$2').toLowerCase();
}
-export function cssEscape(s: string): string {
- let result = '';
- for (let i = 0; i < s.length; i++)
- result += cssEscapeOne(s, i);
- return result;
-}
-
export function quoteCSSAttributeValue(text: string): string {
- return `"${cssEscape(text).replace(/\\ /g, ' ')}"`;
-}
-
-function cssEscapeOne(s: string, i: number): string {
- // https://drafts.csswg.org/cssom/#serialize-an-identifier
- const c = s.charCodeAt(i);
- if (c === 0x0000)
- return '\uFFFD';
- if ((c >= 0x0001 && c <= 0x001f) ||
- (c >= 0x0030 && c <= 0x0039 && (i === 0 || (i === 1 && s.charCodeAt(0) === 0x002d))))
- return '\\' + c.toString(16) + ' ';
- if (i === 0 && c === 0x002d && s.length === 1)
- return '\\' + s.charAt(i);
- if (c >= 0x0080 || c === 0x002d || c === 0x005f || (c >= 0x0030 && c <= 0x0039) ||
- (c >= 0x0041 && c <= 0x005a) || (c >= 0x0061 && c <= 0x007a))
- return s.charAt(i);
- return '\\' + s.charAt(i);
+ return `"${text.replace(/["\\]/g, char => '\\' + char)}"`;
}
let normalizedWhitespaceCache: Map<string, string> | undefined;
diff --git a/tests/library/inspector/cli-codegen-3.spec.ts b/tests/library/inspector/cli-codegen-3.spec.ts
index 8bbf111bf9..1521514d79 100644
--- a/tests/library/inspector/cli-codegen-3.spec.ts
+++ b/tests/library/inspector/cli-codegen-3.spec.ts
@@ -316,19 +316,19 @@ await page.Locator("#frame1").ContentFrame.Locator("iframe").ContentFrame.Locato
page.locator('iframe[name="foo<bar\'\\"`>"]').contentFrame().getByRole('button', { name: 'Click me' }).click(),
]);
expect.soft(sources.get('JavaScript')!.text).toContain(`
- await page.locator('iframe[name="foo\\\\<bar\\\\\\'\\\\"\\\\\`\\\\>"]').contentFrame().getByRole('button', { name: 'Click me' }).click();`);
+ await page.locator('iframe[name="foo<bar\\'\\\\\"\`>"]').contentFrame().getByRole('button', { name: 'Click me' }).click()`);
expect.soft(sources.get('Java')!.text).toContain(`
- page.locator("iframe[name=\\"foo\\\\<bar\\\\'\\\\\\"\\\\\`\\\\>\\"]").contentFrame().getByRole(AriaRole.BUTTON, new FrameLocator.GetByRoleOptions().setName("Click me")).click()`);
+ page.locator("iframe[name=\\"foo<bar'\\\\\\"\`>\\"]").contentFrame().getByRole(AriaRole.BUTTON, new FrameLocator.GetByRoleOptions().setName("Click me")).click()`);
expect.soft(sources.get('Python')!.text).toContain(`
- page.locator("iframe[name=\\"foo\\\\<bar\\\\'\\\\\\"\\\\\`\\\\>\\"]").content_frame.get_by_role("button", name="Click me").click()`);
+ page.locator("iframe[name=\\"foo<bar'\\\\\\"\`>\\"]").content_frame.get_by_role("button", name="Click me").click()`);
expect.soft(sources.get('Python Async')!.text).toContain(`
- await page.locator("iframe[name=\\"foo\\\\<bar\\\\'\\\\\\"\\\\\`\\\\>\\"]").content_frame.get_by_role("button", name="Click me").click()`);
+ await page.locator("iframe[name=\\"foo<bar'\\\\\\"\`>\\"]").content_frame.get_by_role("button", name="Click me").click()`);
expect.soft(sources.get('C#')!.text).toContain(`
-await page.Locator("iframe[name=\\"foo\\\\<bar\\\\'\\\\\\"\\\\\`\\\\>\\"]").ContentFrame.GetByRole(AriaRole.Button, new() { Name = "Click me" }).ClickAsync();`);
+await page.Locator("iframe[name=\\"foo<bar'\\\\\\"\`>\\"]").ContentFrame.GetByRole(AriaRole.Button, new() { Name = "Click me" }).ClickAsync()`);
});
test('should generate frame locators with title attribute', async ({ openRecorder, server }) => {
diff --git a/tests/library/selector-generator.spec.ts b/tests/library/selector-generator.spec.ts
index 41348a7c2a..68f0d2fccf 100644
--- a/tests/library/selector-generator.spec.ts
+++ b/tests/library/selector-generator.spec.ts
@@ -17,8 +17,15 @@
import { contextTest as it, expect } from '../config/browserTest';
import type { Page, Frame } from 'playwright-core';
-async function generate(pageOrFrame: Page | Frame, target: string): Promise<string> {
- return pageOrFrame.$eval(target, e => (window as any).playwright.selector(e));
+async function generate(pageOrFrame: Page | Frame, target: string, expected?: string): Promise<string> {
+ return pageOrFrame.$eval(target, (e, expected) => {
+ const playwright = (window as any).playwright;
+ const selector = playwright.selector(e);
+ const expectedTarget = expected ? playwright.$(expected) : e;
+ if (playwright.$(selector) === expectedTarget)
+ return selector;
+ return 'FAILED: ' + selector;
+ }, expected);
}
async function generateMultiple(pageOrFrame: Page | Frame, target: string): Promise<string> {
@@ -38,12 +45,12 @@ it.describe('selector generator', () => {
it('should prefer button over inner span', async ({ page }) => {
await page.setContent(`<button><span>text</span></button>`);
- expect(await generate(page, 'span')).toBe('internal:role=button[name="text"i]');
+ expect(await generate(page, 'span', 'button')).toBe('internal:role=button[name="text"i]');
});
it('should prefer role=button over inner span', async ({ page }) => {
await page.setContent(`<div role=button><span>text</span></div>`);
- expect(await generate(page, 'span')).toBe('internal:role=button[name="text"i]');
+ expect(await generate(page, 'span', 'div')).toBe('internal:role=button[name="text"i]');
});
it('should not prefer zero-sized button over inner span', async ({ page }) => {
@@ -296,6 +303,23 @@ it.describe('selector generator', () => {
expect(await generate(page, 'c[mark="1"]')).toBe('b:nth-child(2) > c');
});
+ it('should prefer class to ordinal', async ({ page }) => {
+ await page.setContent(`
+ <div><c></c><c></c><c></c><c></c><c></c><b></b></div>
+ <div>
+ <b class="foo">
+ <c>
+ </c>
+ </b>
+ <b class="foo bar.baz">
+ <c mark=1></c>
+ </b>
+ </div>
+ <div><b class="foo"></b></div>
+ `);
+ expect(await generate(page, 'c[mark="1"]')).toBe('.foo.bar\\.baz > c');
+ });
+
it('should properly join child selectors under nested ordinals', async ({ page }) => {
await page.setContent(`
<div><c></c><c></c><c></c><c></c><c></c><b></b></div>
@@ -423,19 +447,18 @@ it.describe('selector generator', () => {
it('should work with tricky attributes', async ({ page }) => {
await page.setContent(`<button id="this:is-my-tricky.id"><span></span></button>`);
- expect(await generate(page, 'button')).toBe('[id="this\\:is-my-tricky\\.id"]');
+ expect(await generate(page, 'button')).toBe('[id="this:is-my-tricky.id"]');
await page.setContent(`<ng:switch><span></span></ng:switch>`);
expect(await generate(page, 'ng\\:switch')).toBe('ng\\:switch');
await page.setContent(`<button><span></span></button><button></button>`);
- await page.$eval('span', span => span.textContent = `!#'!?:`);
- expect(await generate(page, 'button')).toBe(`internal:role=button[name="!#'!?:"i]`);
- expect(await page.$(`role=button[name="!#'!?:"]`)).toBeTruthy();
+ await page.$eval('span', span => span.textContent = `!#'!?"\\:`);
+ expect(await generate(page, 'button')).toBe(`internal:role=button[name="!#'!?\\"\\\\:"i]`);
await page.setContent(`<div><span></span></div>`);
- await page.$eval('div', div => div.id = `!#'!?:`);
- expect(await generate(page, 'div')).toBe("[id=\"\\!\\#\\'\\!\\?\\:\"]");
+ await page.$eval('div', div => div.id = `!#'!?"\\:`);
+ expect(await generate(page, 'div')).toBe(`[id="!#'!?\\"\\\\:"]`);
});
it('should work without CSS.escape', async ({ page }) => {
@@ -444,7 +467,12 @@ it.describe('selector generator', () => {
delete window.CSS.escape;
button.setAttribute('name', '-tricky\u0001name');
});
- expect(await generate(page, 'button')).toBe(`button[name="-tricky\\1 name"]`);
+ expect(await generate(page, 'button')).toBe(`button[name="-tricky\u0001name"]`);
+ });
+
+ it('should not over-escape for CSS syntax', async ({ page }) => {
+ await page.setContent(`<button aria-hidden="false" name="123"></button><div role="button"></div>`);
+ expect(await generate(page, 'button')).toBe(`button[name="123"]`);
});
it('should ignore empty aria-label for candidate consideration', async ({ page }) => {