yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(types): explicit ExpectMatcherState type, optional Expect arg (#28119)

Browse Source 
Fixes #28035.
This commit is contained in:
Dmitry Gozman 2023-11-13 18:37:50 -08:00 committed by GitHub
parent 16aee8b5d0
commit bf4c315b09
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
packages/playwright/types/test.d.ts vendored
View File

@ -5236,7 +5236,7 @@ export interface ExpectMatcherUtils {
stringify(object: unknown, maxDepth?: number, maxWidth?: number): string; stringify(object: unknown, maxDepth?: number, maxWidth?: number): string;
} }
type State = { export type ExpectMatcherState = {
isNot: boolean; isNot: boolean;
promise: 'rejects' | 'resolves' | ''; promise: 'rejects' | 'resolves' | '';
utils: ExpectMatcherUtils; utils: ExpectMatcherUtils;
@ -5268,7 +5268,7 @@ type MakeMatchers<R, T, ExtendedMatchers> = {
rejects: MakeMatchers<Promise<R>, any, ExtendedMatchers>; rejects: MakeMatchers<Promise<R>, any, ExtendedMatchers>;
} & IfAny<T, AllMatchers<R, T>, SpecificMatchers<R, T> & ToUserMatcherObject<ExtendedMatchers, T>>; } & IfAny<T, AllMatchers<R, T>, SpecificMatchers<R, T> & ToUserMatcherObject<ExtendedMatchers, T>>;
export type Expect<ExtendedMatchers> = { export type Expect<ExtendedMatchers = {}> = {
<T = unknown>(actual: T, messageOrOptions?: string | { message?: string }): MakeMatchers<void, T, ExtendedMatchers>; <T = unknown>(actual: T, messageOrOptions?: string | { message?: string }): MakeMatchers<void, T, ExtendedMatchers>;
soft: <T = unknown>(actual: T, messageOrOptions?: string | { message?: string }) => MakeMatchers<void, T, ExtendedMatchers>; soft: <T = unknown>(actual: T, messageOrOptions?: string | { message?: string }) => MakeMatchers<void, T, ExtendedMatchers>;
poll: <T = unknown>(actual: () => T | Promise<T>, messageOrOptions?: string | { message?: string, timeout?: number, intervals?: number[] }) => BaseMatchers<Promise<void>, T> & { poll: <T = unknown>(actual: () => T | Promise<T>, messageOrOptions?: string | { message?: string, timeout?: number, intervals?: number[] }) => BaseMatchers<Promise<void>, T> & {
@ -5277,18 +5277,13 @@ export type Expect<ExtendedMatchers> = {
*/ */
not: BaseMatchers<Promise<void>, T>; not: BaseMatchers<Promise<void>, T>;
}; };
extend<MoreMatchers extends Record<string, (this: State, receiver: any, ...args: any[]) => MatcherReturnType | Promise<MatcherReturnType>>>(matchers: MoreMatchers): Expect<ExtendedMatchers & MoreMatchers>; extend<MoreMatchers extends Record<string, (this: ExpectMatcherState, receiver: any, ...args: any[]) => MatcherReturnType | Promise<MatcherReturnType>>>(matchers: MoreMatchers): Expect<ExtendedMatchers & MoreMatchers>;
configure: (configuration: { configure: (configuration: {
message?: string, message?: string,
timeout?: number, timeout?: number,
soft?: boolean, soft?: boolean,
}) => Expect<ExtendedMatchers>; }) => Expect<ExtendedMatchers>;
getState(): { getState(): ExpectMatcherState;
expand?: boolean;
isNot?: boolean;
promise?: string;
utils: any;
};
not: Omit<AsymmetricMatchers, 'any' | 'anything'>; not: Omit<AsymmetricMatchers, 'any' | 'anything'>;
} & AsymmetricMatchers; } & AsymmetricMatchers;

9
tests/playwright-test/expect.spec.ts
View File

@ -713,7 +713,7 @@ test('should chain expect matchers and expose matcher utils (TSC)', async ({ run
const result = await runTSC({ const result = await runTSC({
'a.spec.ts': ` 'a.spec.ts': `
import { test, expect as baseExpect } from '@playwright/test'; import { test, expect as baseExpect } from '@playwright/test';
import type { Page, Locator } from '@playwright/test'; import type { Page, Locator, ExpectMatcherState, Expect } from '@playwright/test';
function callLogText(log: string[] | undefined): string { function callLogText(log: string[] | undefined): string {
if (!log) if (!log)
@ -721,8 +721,15 @@ test('should chain expect matchers and expose matcher utils (TSC)', async ({ run
return log.join('\\n'); return log.join('\\n');
} }
const dummy: Expect = baseExpect;
const dummy2: Expect<{}> = baseExpect;
const expect = baseExpect.extend({ const expect = baseExpect.extend({
async toHaveAmount(locator: Locator, expected: string, options?: { timeout?: number }) { async toHaveAmount(locator: Locator, expected: string, options?: { timeout?: number }) {
// Make sure "this" is inferred as ExpectMatcherState.
const self: ExpectMatcherState = this;
const self2: ReturnType<Expect['getState']> = self;
const baseAmount = locator.locator('.base-amount'); const baseAmount = locator.locator('.base-amount');
let pass: boolean; let pass: boolean;

13
utils/generate_types/overrides-test.d.ts vendored
View File

@ -370,7 +370,7 @@ export interface ExpectMatcherUtils {
stringify(object: unknown, maxDepth?: number, maxWidth?: number): string; stringify(object: unknown, maxDepth?: number, maxWidth?: number): string;
} }
type State = { export type ExpectMatcherState = {
isNot: boolean; isNot: boolean;
promise: 'rejects' | 'resolves' | ''; promise: 'rejects' | 'resolves' | '';
utils: ExpectMatcherUtils; utils: ExpectMatcherUtils;
@ -402,7 +402,7 @@ type MakeMatchers<R, T, ExtendedMatchers> = {
rejects: MakeMatchers<Promise<R>, any, ExtendedMatchers>; rejects: MakeMatchers<Promise<R>, any, ExtendedMatchers>;
} & IfAny<T, AllMatchers<R, T>, SpecificMatchers<R, T> & ToUserMatcherObject<ExtendedMatchers, T>>; } & IfAny<T, AllMatchers<R, T>, SpecificMatchers<R, T> & ToUserMatcherObject<ExtendedMatchers, T>>;
export type Expect<ExtendedMatchers> = { export type Expect<ExtendedMatchers = {}> = {
<T = unknown>(actual: T, messageOrOptions?: string | { message?: string }): MakeMatchers<void, T, ExtendedMatchers>; <T = unknown>(actual: T, messageOrOptions?: string | { message?: string }): MakeMatchers<void, T, ExtendedMatchers>;
soft: <T = unknown>(actual: T, messageOrOptions?: string | { message?: string }) => MakeMatchers<void, T, ExtendedMatchers>; soft: <T = unknown>(actual: T, messageOrOptions?: string | { message?: string }) => MakeMatchers<void, T, ExtendedMatchers>;
poll: <T = unknown>(actual: () => T | Promise<T>, messageOrOptions?: string | { message?: string, timeout?: number, intervals?: number[] }) => BaseMatchers<Promise<void>, T> & { poll: <T = unknown>(actual: () => T | Promise<T>, messageOrOptions?: string | { message?: string, timeout?: number, intervals?: number[] }) => BaseMatchers<Promise<void>, T> & {
@ -411,18 +411,13 @@ export type Expect<ExtendedMatchers> = {
*/ */
not: BaseMatchers<Promise<void>, T>; not: BaseMatchers<Promise<void>, T>;
}; };
extend<MoreMatchers extends Record<string, (this: State, receiver: any, ...args: any[]) => MatcherReturnType | Promise<MatcherReturnType>>>(matchers: MoreMatchers): Expect<ExtendedMatchers & MoreMatchers>; extend<MoreMatchers extends Record<string, (this: ExpectMatcherState, receiver: any, ...args: any[]) => MatcherReturnType | Promise<MatcherReturnType>>>(matchers: MoreMatchers): Expect<ExtendedMatchers & MoreMatchers>;
configure: (configuration: { configure: (configuration: {
message?: string, message?: string,
timeout?: number, timeout?: number,
soft?: boolean, soft?: boolean,
}) => Expect<ExtendedMatchers>; }) => Expect<ExtendedMatchers>;
getState(): { getState(): ExpectMatcherState;
expand?: boolean;
isNot?: boolean;
promise?: string;
utils: any;
};
not: Omit<AsymmetricMatchers, 'any' | 'anything'>; not: Omit<AsymmetricMatchers, 'any' | 'anything'>;
} & AsymmetricMatchers; } & AsymmetricMatchers;