chore: reduce dependencies from expect matchers to the rest

Author: dgozman

packages/playwright/src/common/DEPS.list

@@ -7,3 +7,5 @@
 [testType.ts]
 ../matchers/expect.ts
 
+[globals.ts]
+../matchers/expect.ts

packages/playwright/src/common/globals.ts

@@ -14,12 +14,18 @@
  * limitations under the License.
  */
 
+import { setExpectConfig } from '../matchers/expect';
+
 import type { Suite } from './test';
 import type { TestInfoImpl } from '../worker/testInfo';
 
 let currentTestInfoValue: TestInfoImpl | null = null;
 export function setCurrentTestInfo(testInfo: TestInfoImpl | null) {
   currentTestInfoValue = testInfo;
+  setExpectConfig({
+    testInfo: testInfo ?? undefined,
+    ...testInfo?._projectInternal.expect,
+  });
 }
 export function currentTestInfo(): TestInfoImpl | null {
   return currentTestInfoValue;

packages/playwright/src/matchers/DEPS.list

@@ -1,6 +1,4 @@
 [*]
-../common/
-../mcp/test/browserBackend.ts
+../common/expectBundle.ts
 ../util.ts
-../utilsBundle.ts
 ../worker/testInfo.ts

packages/playwright/src/matchers/expect.ts

@@ -19,6 +19,7 @@ import { iso, serverUtils } from 'playwright-core/lib/coreBundle';
 import { ExpectError, isJestError } from './matcherHint';
 import {
   computeMatcherTitleSuffix,
+  defaultDeadlineForMatcher,
   toBeAttached,
   toBeChecked,
   toBeDisabled,
@@ -54,13 +55,47 @@ import { toHaveScreenshot, toMatchSnapshot } from './toMatchSnapshot';
 import {
   expect as expectLibrary,
 } from '../common/expectBundle';
-import { currentTestInfo } from '../common/globals';
 import { filteredStackTrace } from '../util';
-import { TestInfoImpl } from '../worker/testInfo';
 
 import type { ExpectMatcherStateInternal } from './matchers';
 import type { Expect } from '../../types/test';
-import type { TestStepInfoImpl } from '../worker/testInfo';
+import type { TestInfoImpl, TestStepInfoImpl } from '../worker/testInfo';
+
+export type ExpectConfig = {
+  testInfo?: TestInfoImpl;
+  timeout?: number;
+  toHaveScreenshot?: {
+    threshold?: number;
+    maxDiffPixels?: number;
+    maxDiffPixelRatio?: number;
+    animations?: 'allow'|'disabled';
+    caret?: 'hide'|'initial';
+    scale?: 'css'|'device';
+    stylePath?: string|Array<string>;
+    pathTemplate?: string;
+  };
+  toMatchAriaSnapshot?: {
+    pathTemplate?: string;
+    children?: 'contain'|'equal'|'deep-equal';
+  };
+  toMatchSnapshot?: {
+    threshold?: number;
+    maxDiffPixels?: number;
+    maxDiffPixelRatio?: number;
+  };
+  toPass?: {
+    timeout?: number;
+    intervals?: Array<number>;
+  };
+};
+
+let currentConfig: ExpectConfig = {};
+export function setExpectConfig(config: ExpectConfig) {
+  currentConfig = config;
+}
+export function expectConfig(): ExpectConfig {
+  return currentConfig;
+}
 
 type ExpectMessage = string | { message?: string };
 
@@ -152,7 +187,6 @@ function createExpect(info: ExpectMetaInfo, prefix: string[], userMatchers: Reco
 // Rely on sync call sequence to seed each matcher call with the context.
 type MatcherCallContext = {
   expectInfo: ExpectMetaInfo;
-  testInfo: TestInfoImpl | null;
   step?: TestStepInfoImpl;
 };
 
@@ -178,7 +212,7 @@ function wrapPlaywrightMatcherToPassNiceThis(matcher: any) {
   return function(this: any, ...args: any[]) {
     const { isNot, promise, utils } = this;
     const context = takeMatcherCallContext();
-    const timeout = context?.expectInfo.timeout ?? context?.testInfo?._projectInternal?.expect?.timeout ?? defaultExpectTimeout;
+    const timeout = context?.expectInfo.timeout ?? expectConfig().timeout ?? defaultExpectTimeout;
     const newThis: ExpectMatcherStateInternal = {
       isNot,
       promise,
@@ -291,8 +325,8 @@ class ExpectMetaInfoProxyHandler implements ProxyHandler<any> {
       matcher = (...args: any[]) => pollMatcher(resolvedMatcherName, this._info, this._prefix, ...args);
     }
     return (...args: any[]) => {
-      const testInfo = currentTestInfo();
-      setMatcherCallContext({ expectInfo: this._info, testInfo });
+      const testInfo = expectConfig().testInfo;
+      setMatcherCallContext({ expectInfo: this._info });
       if (!testInfo)
         return matcher.call(target, ...args);
 
@@ -344,7 +378,7 @@ class ExpectMetaInfoProxyHandler implements ProxyHandler<any> {
       };
 
       try {
-        setMatcherCallContext({ expectInfo: this._info, testInfo, step: step.info });
+        setMatcherCallContext({ expectInfo: this._info, step: step.info });
         const callback = () => matcher.call(target, ...args);
         const result = serverUtils.currentZone().with('stepZone', step).run(callback);
         if (result instanceof Promise)
@@ -359,13 +393,13 @@ class ExpectMetaInfoProxyHandler implements ProxyHandler<any> {
 }
 
 async function pollMatcher(qualifiedMatcherName: string, info: ExpectMetaInfo, prefix: string[], ...args: any[]) {
-  const testInfo = currentTestInfo();
+  const config = expectConfig();
   const poll = info.poll!;
-  const timeout = poll.timeout ?? info.timeout ?? testInfo?._projectInternal?.expect?.timeout ?? defaultExpectTimeout;
-  const { deadline, timeoutMessage } = testInfo ? testInfo._deadlineForMatcher(timeout) : TestInfoImpl._defaultDeadlineForMatcher(timeout);
+  const timeout = poll.timeout ?? info.timeout ?? config.timeout ?? defaultExpectTimeout;
+  const { deadline, timeoutMessage } = config.testInfo ? config.testInfo._deadlineForMatcher(timeout) : defaultDeadlineForMatcher(timeout);
 
   const result = await iso.pollAgainstDeadline<Error|undefined>(async () => {
-    if (testInfo && currentTestInfo() !== testInfo)
+    if (expectConfig() !== config)
       return { continuePolling: false, result: undefined };
 
     const innerInfo: ExpectMetaInfo = {

packages/playwright/src/matchers/matcherHint.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import util from 'util';
+
 import { iso } from 'playwright-core/lib/coreBundle';
 
 import type { StackFrame } from '@protocol/channels';
@@ -56,3 +58,13 @@ export class ExpectError extends Error {
 export function isJestError(e: unknown): e is JestError {
   return e instanceof Error && 'matcherResult' in e && !!e.matcherResult;
 }
+
+export function expectTypes(receiver: any, types: ('APIResponse' | 'Page' | 'Locator')[], matcherName: string) {
+  if (typeof receiver !== 'object' || !types.includes(receiver._apiName)) {
+    const receiverString = typeof receiver === 'object' && receiver !== null ? `${receiver.constructor.name} ${util.inspect(receiver)}` : String(receiver);
+    const commaSeparated = types.slice();
+    const lastType = commaSeparated.pop();
+    const typesString = commaSeparated.length ? commaSeparated.join(', ') + ' or ' + lastType : lastType;
+    throw new Error(`${matcherName} can be only used with ${typesString} object${types.length > 1 ? 's' : ''}, was called with ${receiverString}`);
+  }
+}

packages/playwright/src/matchers/matchers.ts

@@ -17,16 +17,13 @@
 import { iso, serverUtils } from 'playwright-core/lib/coreBundle';
 import { colors } from 'playwright-core/lib/utilsBundle';
 
-import { expectTypes } from '../util';
 import { toBeTruthy } from './toBeTruthy';
 import { toEqual } from './toEqual';
 import { toHaveURLWithPredicate } from './toHaveURL';
 import { toMatchText } from './toMatchText';
 import { toHaveScreenshotStepTitle } from './toMatchSnapshot';
-import { takeFirst } from '../common/config';
-import { currentTestInfo } from '../common/globals';
-import { TestInfoImpl } from '../worker/testInfo';
-import { MatcherResult } from './matcherHint';
+import { expectConfig } from './expect';
+import { expectTypes, MatcherResult } from './matcherHint';
 
 import type { ExpectMatcherState } from '../../types/test';
 import type { TestStepInfoImpl } from '../worker/testInfo';
@@ -478,13 +475,13 @@ export async function toPass(
     timeout?: number,
   } = {},
 ) {
-  const testInfo = currentTestInfo();
-  const timeout = takeFirst(options.timeout, testInfo?._projectInternal.expect?.toPass?.timeout, 0);
-  const intervals = takeFirst(options.intervals, testInfo?._projectInternal.expect?.toPass?.intervals, [100, 250, 500, 1000]);
+  const config = expectConfig();
+  const timeout = options.timeout ?? config.toPass?.timeout ?? 0;
+  const intervals = options.intervals ?? config.toPass?.intervals ?? [100, 250, 500, 1000];
 
-  const { deadline, timeoutMessage } = testInfo ? testInfo._deadlineForMatcher(timeout) : TestInfoImpl._defaultDeadlineForMatcher(timeout);
+  const { deadline, timeoutMessage } = config.testInfo ? config.testInfo._deadlineForMatcher(timeout) : defaultDeadlineForMatcher(timeout);
   const result = await iso.pollAgainstDeadline<Error|undefined>(async () => {
-    if (testInfo && currentTestInfo() !== testInfo)
+    if (expectConfig() !== config)
       return { continuePolling: false, result: undefined };
     try {
       await callback();
@@ -519,3 +516,7 @@ export function computeMatcherTitleSuffix(matcherName: string, receiver: any, ar
   }
   return {};
 }
+
+export function defaultDeadlineForMatcher(timeout: number): { deadline: number; timeoutMessage: string } {
+  return { deadline: (timeout ? iso.monotonicTime() + timeout : 0), timeoutMessage: `Timeout ${timeout}ms exceeded while waiting on the predicate` };
+}

packages/playwright/src/matchers/toBeTruthy.ts

@@ -16,7 +16,7 @@
 
 import { serverUtils } from 'playwright-core/lib/coreBundle';
 
-import { expectTypes } from '../util';
+import { expectTypes } from './matcherHint';
 
 import type { MatcherResult } from './matcherHint';
 import type { Locator } from 'playwright-core';

packages/playwright/src/matchers/toEqual.ts

@@ -16,7 +16,7 @@
 
 import { iso, serverUtils } from 'playwright-core/lib/coreBundle';
 
-import { expectTypes } from '../util';
+import { expectTypes } from './matcherHint';
 
 import type { MatcherResult } from './matcherHint';
 import type { Locator } from 'playwright-core';

packages/playwright/src/matchers/toMatchAriaSnapshot.ts

@@ -20,8 +20,8 @@ import path from 'path';
 
 import { iso, serverUtils } from 'playwright-core/lib/coreBundle';
 
-import { expectTypes, fileExistsAsync } from '../util';
-import { currentTestInfo } from '../common/globals';
+import { expectConfig } from './expect';
+import { expectTypes } from './matcherHint';
 
 import type { MatcherResult } from './matcherHint';
 import type { ExpectMatcherStateInternal, FrameEx, LocatorEx } from './matchers';
@@ -45,7 +45,7 @@ export async function toMatchAriaSnapshot(
   expectTypes(receiver, ['Page', 'Locator'], matcherName);
   const locator = (receiver as any)._apiName === 'Page' ? undefined : receiver as LocatorEx;
 
-  const testInfo = currentTestInfo();
+  const testInfo = expectConfig().testInfo;
   if (!testInfo)
     throw new Error(`${matcherName}() must be called during the test`);
 
@@ -186,3 +186,12 @@ function unshift(snapshot: string): string {
 function indent(snapshot: string, indent: string): string {
   return snapshot.split('\n').map(line => indent + line).join('\n');
 }
+
+async function fileExistsAsync(resolved: string) {
+  try {
+    const stat = await fs.promises.stat(resolved);
+    return stat.isFile();
+  } catch {
+    return false;
+  }
+}

packages/playwright/src/matchers/toMatchSnapshot.ts

@@ -21,12 +21,12 @@ import { iso, serverUtils } from 'playwright-core/lib/coreBundle';
 import { colors } from 'playwright-core/lib/utilsBundle';
 import { mime } from 'playwright-core/lib/utilsBundle';
 
-import { addSuffixToFilePath, expectTypes } from '../util';
-import { currentTestInfo } from '../common/globals';
+import { expectTypes } from './matcherHint';
+import { expectConfig } from './expect';
 
 import type { MatcherResult } from './matcherHint';
 import type { ExpectMatcherStateInternal } from './matchers';
-import type { FullProjectInternal } from '../common/config';
+import type { ExpectConfig } from './expect';
 import type { TestInfoImpl, TestStepInfoImpl } from '../worker/testInfo';
 import type { Locator, Page } from 'playwright-core';
 import type { ExpectScreenshotOptions, Page as PageEx } from 'playwright-core/lib/client/page';
@@ -37,7 +37,7 @@ type NameOrSegments = string | string[];
 
 type ImageMatcherResult = MatcherResult<string, string> & { diff?: string };
 
-type ToHaveScreenshotConfigOptions = NonNullable<NonNullable<FullProjectInternal['expect']>['toHaveScreenshot']> & {
+type ToHaveScreenshotConfigOptions = NonNullable<ExpectConfig['toHaveScreenshot']> & {
   _comparator?: string;
 };
 
@@ -255,7 +255,7 @@ export function toMatchSnapshot(
   nameOrOptions: NameOrSegments | { name?: NameOrSegments } & ImageComparatorOptions = {},
   optOptions: ImageComparatorOptions = {}
 ): MatcherResult<NameOrSegments | { name?: NameOrSegments }, string> {
-  const testInfo = currentTestInfo();
+  const testInfo = expectConfig().testInfo;
   if (!testInfo)
     throw new Error(`toMatchSnapshot() must be called during the test`);
   if (received instanceof Promise)
@@ -326,7 +326,7 @@ export async function toHaveScreenshot(
   nameOrOptions: NameOrSegments | { name?: NameOrSegments } & ToHaveScreenshotOptions = {},
   optOptions: ToHaveScreenshotOptions = {}
 ): Promise<MatcherResult<NameOrSegments | { name?: NameOrSegments }, string>> {
-  const testInfo = currentTestInfo();
+  const testInfo = expectConfig().testInfo;
   if (!testInfo)
     throw new Error(`toHaveScreenshot() must be called during the test`);
 
@@ -470,3 +470,9 @@ async function loadScreenshotStyles(stylePath?: string | string[]): Promise<stri
   }));
   return styles.join('\n').trim() || undefined;
 }
+
+function addSuffixToFilePath(filePath: string, suffix: string): string {
+  const ext = path.extname(filePath);
+  const base = filePath.substring(0, filePath.length - ext.length);
+  return base + suffix + ext;
+}