fix: custom expect matchers on Locator/Page/APIResponse instance (#27117

) Fixes #27113
microsoft · Sep 15, 2023 · 0d44405 · 0d44405
1 parent ebf6a08
commit 0d44405
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 9 deletions.
diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.ts
@@ -5072,12 +5072,12 @@ type FunctionAssertions = {
 };
 
 type BaseMatchers<R, T> = GenericAssertions<R> & PlaywrightTest.Matchers<R, T> & SnapshotAssertions;
-type AllowedGenericMatchers<R> = Pick<GenericAssertions<R>, 'toBe' | 'toBeDefined' | 'toBeFalsy' | 'toBeNull' | 'toBeTruthy' | 'toBeUndefined'>;
+type AllowedGenericMatchers<R, T> = PlaywrightTest.Matchers<R, T> & Pick<GenericAssertions<R>, 'toBe' | 'toBeDefined' | 'toBeFalsy' | 'toBeNull' | 'toBeTruthy' | 'toBeUndefined'>;
 
 type SpecificMatchers<R, T> =
-  T extends Page ? PageAssertions & AllowedGenericMatchers<R> :
-  T extends Locator ? LocatorAssertions & AllowedGenericMatchers<R> :
-  T extends APIResponse ? APIResponseAssertions & AllowedGenericMatchers<R> :
+  T extends Page ? PageAssertions & AllowedGenericMatchers<R, T> :
+  T extends Locator ? LocatorAssertions & AllowedGenericMatchers<R, T> :
+  T extends APIResponse ? APIResponseAssertions & AllowedGenericMatchers<R, T> :
   BaseMatchers<R, T> & (T extends Function ? FunctionAssertions : {});
 type AllMatchers<R, T> = PageAssertions & LocatorAssertions & APIResponseAssertions & FunctionAssertions & BaseMatchers<R, T>;
 

diff --git a/tests/playwright-test/expect.spec.ts b/tests/playwright-test/expect.spec.ts
@@ -272,11 +272,21 @@ test('should work with custom PlaywrightTest namespace', async ({ runTSC }) => {
       }
     `,
     'a.spec.ts': `
-      import { test, expect } from '@playwright/test';
+      import { test, expect, type Page, type APIResponse } from '@playwright/test';
       test.expect.extend({
         toBeWithinRange() { },
       });
 
+      const page = {} as Page;
+      const locator = page.locator('');
+      const apiResponse = {} as APIResponse;
+      test.expect(page).toBeEmpty();
+      test.expect(page).not.toBeEmpty();
+      test.expect(locator).toBeEmpty();
+      test.expect(locator).not.toBeEmpty();
+      test.expect(apiResponse).toBeEmpty();
+      test.expect(apiResponse).not.toBeEmpty();
+
       test.expect('').toBeEmpty();
       test.expect('hello').not.toBeEmpty();
       test.expect([]).toBeEmpty();

diff --git a/utils/generate_types/overrides-test.d.ts b/utils/generate_types/overrides-test.d.ts
@@ -330,12 +330,12 @@ type FunctionAssertions = {
 };
 
 type BaseMatchers<R, T> = GenericAssertions<R> & PlaywrightTest.Matchers<R, T> & SnapshotAssertions;
-type AllowedGenericMatchers<R> = Pick<GenericAssertions<R>, 'toBe' | 'toBeDefined' | 'toBeFalsy' | 'toBeNull' | 'toBeTruthy' | 'toBeUndefined'>;
+type AllowedGenericMatchers<R, T> = PlaywrightTest.Matchers<R, T> & Pick<GenericAssertions<R>, 'toBe' | 'toBeDefined' | 'toBeFalsy' | 'toBeNull' | 'toBeTruthy' | 'toBeUndefined'>;
 
 type SpecificMatchers<R, T> =
-  T extends Page ? PageAssertions & AllowedGenericMatchers<R> :
-  T extends Locator ? LocatorAssertions & AllowedGenericMatchers<R> :
-  T extends APIResponse ? APIResponseAssertions & AllowedGenericMatchers<R> :
+  T extends Page ? PageAssertions & AllowedGenericMatchers<R, T> :
+  T extends Locator ? LocatorAssertions & AllowedGenericMatchers<R, T> :
+  T extends APIResponse ? APIResponseAssertions & AllowedGenericMatchers<R, T> :
   BaseMatchers<R, T> & (T extends Function ? FunctionAssertions : {});
 type AllMatchers<R, T> = PageAssertions & LocatorAssertions & APIResponseAssertions & FunctionAssertions & BaseMatchers<R, T>;