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
fix(test): keep builtin expect matchers on base extend (#41367)
mehmet turacf777a8456173
diff --git a/packages/playwright/src/matchers/expect.ts b/packages/playwright/src/matchers/expect.tsindex 72a6c424e5..412196154e 100644--- a/packages/playwright/src/matchers/expect.ts+++ b/packages/playwright/src/matchers/expect.ts@@ -286,9 +286,12 @@ function createExpect(info: ExpectMetaInfo): Expect<{}> {}// Legacy behavior: `expect.extend({...})` without capturing the return value- // must make the new matchers available on the same expect instance.- Object.assign(info.userMatchers, matchers);+ // must make the new matchers available on the same expect instance. However,+ // built-in matcher names should only be overridden on the returned expect.for (const [name, matcher] of Object.entries(matchers)) {+ if (name in allBuiltinMatchers)+ continue;+ info.userMatchers[name] = matcher;const { positive, inverse } = buildCustomAsymmetricMatcher(name, matcher);expectFn[name] = positive;notAsymmetric[name] = inverse;diff --git a/tests/playwright-test/expect.spec.ts b/tests/playwright-test/expect.spec.tsindex 14da2c3681..25bf26e86b 100644--- a/tests/playwright-test/expect.spec.ts+++ b/tests/playwright-test/expect.spec.ts@@ -940,6 +940,32 @@ test('should support mergeExpects', async ({ runInlineTest }) => {expect(result.exitCode).toBe(0);});+test('should support mergeExpects with builtin matcher overrides', async ({ runInlineTest }) => {+ const result = await runInlineTest({+ 'a.spec.ts': `+ import { test, mergeExpects, expect as baseExpect } from '@playwright/test';++ const expect1 = baseExpect.extend({+ async toBeVisible(locator) {+ await baseExpect(locator).toBeVisible();+ console.log('%%merged custom');+ return { pass: true, message: () => '' };+ }+ });++ const expect = mergeExpects(expect1);++ test('custom matcher', async ({ page }) => {+ await page.setContent('<h1>Installation</h1>');+ await expect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();+ await baseExpect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();+ });+ `+ }, { workers: 1 });+ expect(result.outputLines).toEqual(['merged custom']);+ expect(result.exitCode).toBe(0);+});+test('should respect timeout from configured expect when used outside of the test runner', async ({ runInlineTest, writeFiles, runTSC }) => {const files = {@@ -1114,6 +1140,52 @@ test('expect.extend should fall back to legacy behavior', async ({ runInlineTest]);});+test('expect.extend should not override builtin matchers on base expect', async ({ runInlineTest }) => {+ const result = await runInlineTest({+ 'expect-test.spec.ts': `+ import { test, expect } from '@playwright/test';++ const customExpect = expect.extend({+ async toBeVisible(locator) {+ await expect(locator).toBeVisible();+ console.log('%%custom');+ return { pass: true, message: () => 'custom matcher' };+ },+ });++ test('custom matcher can call builtin matcher with the same name', async ({ page }) => {+ await page.setContent('<h1>Installation</h1>');+ await customExpect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();+ });+ `+ });+ expect(result.exitCode).toBe(0);+ expect(result.outputLines).toEqual(['custom']);+});++test('expect.extend should not override builtin matchers through legacy behavior', async ({ runInlineTest }) => {+ const result = await runInlineTest({+ 'expect-test.spec.ts': `+ import { test, expect } from '@playwright/test';++ expect.extend({+ async toBeVisible(locator) {+ await expect(locator).toBeVisible();+ console.log('%%legacy custom');+ return { pass: true, message: () => 'custom matcher' };+ },+ });++ test('base expect keeps builtin matcher', async ({ page }) => {+ await page.setContent('<h1>Installation</h1>');+ await expect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();+ });+ `+ });+ expect(result.exitCode).toBe(0);+ expect(result.outputLines).toEqual([]);+});+test('custom asymmetric matchers should work with expect.extend', async ({ runInlineTest }) => {const result = await runInlineTest({'expect-test.spec.ts': `