Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore: hide locator(':root') in Steps for toHaveTitle/URL (#36213)
Max Schmitt764dedac6653
diff --git a/packages/injected/src/injectedScript.ts b/packages/injected/src/injectedScript.tsindex 5155204e2b..b18251f836 100644--- a/packages/injected/src/injectedScript.ts+++ b/packages/injected/src/injectedScript.ts@@ -1348,6 +1348,16 @@ export class InjectedScript {// expect(locator).not.toBeInViewport() passes when there is no element.if (options.isNot && options.expression === 'to.be.in.viewport')return { matches: false };+ if (options.expression === 'to.have.title' && options?.expectedText?.[0]) {+ const matcher = new ExpectedTextMatcher(options.expectedText[0]);+ const received = this.document.title;+ return { received, matches: matcher.matches(received) };+ }+ if (options.expression === 'to.have.url' && options?.expectedText?.[0]) {+ const matcher = new ExpectedTextMatcher(options.expectedText[0]);+ const received = this.document.location.href;+ return { received, matches: matcher.matches(received) };+ }// When none of the above applies, expect does not match.return { matches: options.isNot, missingReceived: true };}@@ -1497,10 +1507,6 @@ export class InjectedScript {received = getElementAccessibleErrorMessage(element);} else if (expression === 'to.have.role') {received = getAriaRole(element) || '';- } else if (expression === 'to.have.title') {- received = this.document.title;- } else if (expression === 'to.have.url') {- received = this.document.location.href;} else if (expression === 'to.have.value') {element = this.retarget(element, 'follow-label')!;if (element.nodeName !== 'INPUT' && element.nodeName !== 'TEXTAREA' && element.nodeName !== 'SELECT')diff --git a/packages/playwright-core/src/client/frame.ts b/packages/playwright-core/src/client/frame.tsindex 32fa6b0997..780d3680ee 100644--- a/packages/playwright-core/src/client/frame.ts+++ b/packages/playwright-core/src/client/frame.ts@@ -460,6 +460,15 @@ export class Frame extends ChannelOwner<channels.FrameChannel> implements api.Frasync title(): Promise<string> {return (await this._channel.title()).value;}++ async _expect(expression: string, options: Omit<channels.FrameExpectParams, 'expression'>): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }> {+ const params: channels.FrameExpectParams = { expression, ...options, isNot: !!options.isNot };+ params.expectedValue = serializeArgument(options.expectedValue);+ const result = (await this._channel.expect(params));+ if (result.received !== undefined)+ result.received = parseResult(result.received);+ return result;+ }}export function verifyLoadState(name: string, waitUntil: LifecycleEvent): LifecycleEvent {diff --git a/packages/playwright-core/src/client/locator.ts b/packages/playwright-core/src/client/locator.tsindex 9e759c2f34..ea780c2fbe 100644--- a/packages/playwright-core/src/client/locator.ts+++ b/packages/playwright-core/src/client/locator.ts@@ -15,7 +15,6 @@*/import { ElementHandle } from './elementHandle';-import { parseResult, serializeArgument } from './jsHandle';import { asLocator } from '../utils/isomorphic/locatorGenerators';import { getByAltTextSelector, getByLabelSelector, getByPlaceholderSelector, getByRoleSelector, getByTestIdSelector, getByTextSelector, getByTitleSelector } from '../utils/isomorphic/locatorUtils';import { escapeForTextSelector } from '../utils/isomorphic/stringUtils';@@ -374,12 +373,10 @@ export class Locator implements api.Locator {}async _expect(expression: string, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }> {- const params: channels.FrameExpectParams = { selector: this._selector, expression, ...options, isNot: !!options.isNot };- params.expectedValue = serializeArgument(options.expectedValue);- const result = (await this._frame._channel.expect(params));- if (result.received !== undefined)- result.received = parseResult(result.received);- return result;+ return this._frame._expect(expression, {+ ...options,+ selector: this._selector,+ });}private _inspect() {diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex 71903879ce..7e9073a251 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -1882,7 +1882,7 @@ scheme.FrameWaitForSelectorResult = tObject({element: tOptional(tChannel(['ElementHandle'])),});scheme.FrameExpectParams = tObject({- selector: tString,+ selector: tOptional(tString),expression: tString,expressionArg: tOptional(tAny),expectedText: tOptional(tArray(tType('ExpectedTextValue'))),diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.tsindex 11981950fc..2ed8ca96b1 100644--- a/packages/playwright-core/src/server/frames.ts+++ b/packages/playwright-core/src/server/frames.ts@@ -1375,7 +1375,7 @@ export class Frame extends SdkObject {}, options.timeout);}- async expect(metadata: CallMetadata, selector: string, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }> {+ async expect(metadata: CallMetadata, selector: string | undefined, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }> {const result = await this._expectImpl(metadata, selector, options);// Library mode special case for the expect errors which are return values, not exceptions.if (result.matches === options.isNot)@@ -1383,7 +1383,7 @@ export class Frame extends SdkObject {return result;}- private async _expectImpl(metadata: CallMetadata, selector: string, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }> {+ private async _expectImpl(metadata: CallMetadata, selector: string | undefined, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }> {const lastIntermediateResult: { received?: any, isSet: boolean } = { isSet: false };try {let timeout = options.timeout;@@ -1392,7 +1392,8 @@ export class Frame extends SdkObject {// Step 1: perform locator handlers checkpoint with a specified timeout.await (new ProgressController(metadata, this)).run(async progress => {progress.log(`${renderTitleForCall(metadata)}${timeout ? ` with timeout ${timeout}ms` : ''}`);- progress.log(`waiting for ${this._asLocator(selector)}`);+ if (selector)+ progress.log(`waiting for ${this._asLocator(selector)}`);await this._page.performActionPreChecks(progress);}, timeout);@@ -1445,8 +1446,8 @@ export class Frame extends SdkObject {}}- private async _expectInternal(progress: Progress, selector: string, options: FrameExpectParams, lastIntermediateResult: { received?: any, isSet: boolean }) {- const selectorInFrame = await this.selectors.resolveFrameForSelector(selector, { strict: true });+ private async _expectInternal(progress: Progress, selector: string | undefined, options: FrameExpectParams, lastIntermediateResult: { received?: any, isSet: boolean }) {+ const selectorInFrame = selector ? await this.selectors.resolveFrameForSelector(selector, { strict: true }) : undefined;progress.throwIfAborted();const { frame, info } = selectorInFrame || { frame: this, info: undefined };diff --git a/packages/playwright/src/matchers/matchers.ts b/packages/playwright/src/matchers/matchers.tsindex 5dbd98ee77..c3097ff604 100644--- a/packages/playwright/src/matchers/matchers.ts+++ b/packages/playwright/src/matchers/matchers.ts@@ -28,7 +28,7 @@ import { TestInfoImpl } from '../worker/testInfo';import type { ExpectMatcherState } from '../../types/test';import type { TestStepInfoImpl } from '../worker/testInfo';-import type { APIResponse, Locator, Page } from 'playwright-core';+import type { APIResponse, Locator, Frame, Page } from 'playwright-core';import type { FrameExpectParams } from 'playwright-core/lib/client/types';export type ExpectMatcherStateInternal = ExpectMatcherState & { _stepInfo?: TestStepInfoImpl };@@ -37,6 +37,10 @@ export interface LocatorEx extends Locator {_expect(expression: string, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }>;}+export interface FrameEx extends Frame {+ _expect(expression: string, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }>;+}+interface APIResponseEx extends APIResponse {_fetchLog(): Promise<string[]>;}@@ -401,10 +405,9 @@ export function toHaveTitle(expected: string | RegExp,options: { timeout?: number } = {},) {- const locator = page.locator(':root') as LocatorEx;- return toMatchText.call(this, 'toHaveTitle', locator, 'Locator', async (isNot, timeout) => {+ return toMatchText.call(this, 'toHaveTitle', page, 'Page', async (isNot, timeout) => {const expectedText = serializeExpectedTextValues([expected], { normalizeWhiteSpace: true });- return await locator._expect('to.have.title', { expectedText, isNot, timeout });+ return await (page.mainFrame() as FrameEx)._expect('to.have.title', { expectedText, isNot, timeout });}, expected, { receiverLabel: 'page', ...options });}@@ -420,11 +423,10 @@ export function toHaveURL(const baseURL = (page.context() as any)._options.baseURL;expected = typeof expected === 'string' ? constructURLBasedOnBaseURL(baseURL, expected) : expected;- const locator = page.locator(':root') as LocatorEx;- return toMatchText.call(this, 'toHaveURL', locator, 'Locator', async (isNot, timeout) => {+ return toMatchText.call(this, 'toHaveURL', page, 'Page', async (isNot, timeout) => {const expectedText = serializeExpectedTextValues([expected], { ignoreCase: options?.ignoreCase });- return await locator._expect('to.have.url', { expectedText, isNot, timeout });- }, expected, options);+ return await (page.mainFrame() as FrameEx)._expect('to.have.url', { expectedText, isNot, timeout });+ }, expected, { receiverLabel: 'page', ...options });}export async function toBeOK(diff --git a/packages/playwright/src/matchers/toMatchText.ts b/packages/playwright/src/matchers/toMatchText.tsindex 6aa1c111f8..45fe4fb996 100644--- a/packages/playwright/src/matchers/toMatchText.ts+++ b/packages/playwright/src/matchers/toMatchText.ts@@ -27,13 +27,13 @@ import { EXPECTED_COLOR } from '../common/expectBundle';import type { MatcherResult } from './matcherHint';import type { ExpectMatcherState } from '../../types/test';-import type { Locator } from 'playwright-core';+import type { Page, Locator } from 'playwright-core';export async function toMatchText(this: ExpectMatcherState,matcherName: string,- receiver: Locator,- receiverType: string,+ receiver: Locator | Page,+ receiverType: 'Locator' | 'Page',query: (isNot: boolean, timeout: number) => Promise<{ matches: boolean, received?: string, log?: string[], timedOut?: boolean }>,expected: string | RegExp,options: { timeout?: number, matchSubstring?: boolean, receiverLabel?: string } = {},@@ -51,7 +51,7 @@ export async function toMatchText() {// Same format as jest's matcherErrorMessagethrow new Error([- matcherHint(this, receiver, matcherName, receiver, expected, matcherOptions),+ matcherHint(this, receiverType === 'Locator' ? receiver as Locator : undefined, matcherName, options.receiverLabel ?? receiver, expected, matcherOptions),`${colors.bold('Matcher error')}: ${EXPECTED_COLOR('expected',)} value must be a string or regular expression`,this.utils.printWithType('Expected', expected, this.utils.printExpected)].join('\n\n'));@@ -71,7 +71,7 @@ export async function toMatchText(const stringSubstring = options.matchSubstring ? 'substring' : 'string';const receivedString = received || '';- const messagePrefix = matcherHint(this, receiver, matcherName, options.receiverLabel ?? 'locator', undefined, matcherOptions, timedOut ? timeout : undefined);+ const messagePrefix = matcherHint(this, receiverType === 'Locator' ? receiver as Locator : undefined, matcherName, options.receiverLabel ?? 'locator', undefined, matcherOptions, timedOut ? timeout : undefined);const notFound = received === kNoElementsFoundError;let printedReceived: string | undefined;diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 90ab1680d9..1afeaeec8b 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -3238,7 +3238,7 @@ export type FrameWaitForSelectorResult = {element?: ElementHandleChannel,};export type FrameExpectParams = {- selector: string,+ selector?: string,expression: string,expressionArg?: any,expectedText?: ExpectedTextValue[],@@ -3249,6 +3249,7 @@ export type FrameExpectParams = {timeout: number,};export type FrameExpectOptions = {+ selector?: string,expressionArg?: any,expectedText?: ExpectedTextValue[],expectedNumber?: number,diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex 8e85b73422..849bc91305 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -2659,7 +2659,7 @@ Frame:expect:title: Expect "{expression}"parameters:- selector: string+ selector: string?expression: stringexpressionArg: json?expectedText:diff --git a/tests/library/trace-viewer.spec.ts b/tests/library/trace-viewer.spec.tsindex 16a36e5d59..71dc0c70f6 100644--- a/tests/library/trace-viewer.spec.ts+++ b/tests/library/trace-viewer.spec.ts@@ -40,7 +40,9 @@ test.beforeAll(async function recordTrace({ browser, browserName, browserType, s});await context.tracing.start({ name: 'test', screenshots: true, snapshots: true, sources: true });const page = await context.newPage();- await page.goto(`data:text/html,<!DOCTYPE html><html>Hello world</html>`);+ await page.goto(`data:text/html,<!DOCTYPE html><html><title>Hello</title><body>Hello world</body></html>`);+ await expect(page).toHaveTitle('Hello');+ await expect(page).toHaveURL('data:text/html,<!DOCTYPE html><html><title>Hello</title><body>Hello world</body></html>');await page.setContent('<!DOCTYPE html><button>Click</button>');await expect(page.locator('button')).toHaveText('Click');await expect(page.getByTestId('amazing-btn')).toBeHidden();@@ -151,6 +153,8 @@ test('should open simple trace viewer', async ({ showTraceViewer }) => {await expect(traceViewer.actionTitles).toHaveText([/Create page/,/Navigate to "data:"/,+ /^Expect "toHaveTitle"[\d]+ms$/,+ /^Expect "toHaveURL"[\d]+ms$/,/Set content/,/toHaveText.*locator/,/toBeHidden.*getByTestId/,@@ -1826,6 +1830,8 @@ test('should render blob trace received from message', async ({ showTraceViewerawait expect(traceViewer.actionTitles).toHaveText([/Create page/,/Navigate to "data:"/,+ /toHaveTitle/,+ /toHaveURL/,/Set content/,/toHaveText.*locator/,/toBeHidden.*getByTestId/,diff --git a/tests/page/expect-misc.spec.ts b/tests/page/expect-misc.spec.tsindex bf963f36fe..37cbdb1c0c 100644--- a/tests/page/expect-misc.spec.ts+++ b/tests/page/expect-misc.spec.ts@@ -296,7 +296,7 @@ test.describe('toHaveURL', () => {test('fail string', async ({ page }) => {await page.goto('data:text/html,<div>A</div>');const error = await expect(page).toHaveURL('wrong', { timeout: 1000 }).catch(e => e);- expect(stripVTControlCharacters(error.message)).toContain('Timed out 1000ms waiting for expect(locator).toHaveURL(expected)');+ expect(stripVTControlCharacters(error.message)).toContain('Timed out 1000ms waiting for expect(page).toHaveURL(expected)');expect(stripVTControlCharacters(error.message)).toContain('Expected string: "wrong"\nReceived string: "data:text/html,<div>A</div>"');});@@ -304,7 +304,7 @@ test.describe('toHaveURL', () => {await page.goto('data:text/html,<div>A</div>');// @ts-expect-errorconst error = await expect(page).toHaveURL({}).catch(e => e);- expect(stripVTControlCharacters(error.message)).toContain(`expect(locator(':root')).toHaveURL([object Object])`);+ expect(stripVTControlCharacters(error.message)).toContain(`expect(page).toHaveURL([object Object])`);expect(stripVTControlCharacters(error.message)).toContain('Expected has type: object\nExpected has value: {}');});diff --git a/tests/playwright-test/expect.spec.ts b/tests/playwright-test/expect.spec.tsindex 187746c607..45698ce7d6 100644--- a/tests/playwright-test/expect.spec.ts+++ b/tests/playwright-test/expect.spec.ts@@ -548,7 +548,7 @@ test('should respect expect.timeout', async ({ runInlineTest }) => {test('timeout', async ({ page }) => {await page.goto('data:text/html,<div>A</div>');const error = await expect(page).toHaveURL('data:text/html,<div>B</div>').catch(e => e);- expect(stripVTControlCharacters(error.message)).toContain('Timed out 1000ms waiting for expect(locator).toHaveURL(expected)');+ expect(stripVTControlCharacters(error.message)).toContain('Timed out 1000ms waiting for expect(page).toHaveURL(expected)');expect(error.message).toContain('data:text/html,<div>');});`,