feat(expect): add toPass option to playwright config file

dev-jonghoonpark · Nov 18, 2023 · 041785f · injae-kim · Nov 19, 2023 · injae-kim
1 parent 3f55587
commit 041785f
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 1 deletion.
diff --git a/docs/src/test-api/class-testconfig.md b/docs/src/test-api/class-testconfig.md
@@ -51,6 +51,9 @@ export default defineConfig({
     - `threshold` ?<[float]> an acceptable perceived color difference between the same pixel in compared images, ranging from `0` (strict) and `1` (lax). `"pixelmatch"` comparator computes color difference in [YIQ color space](https://en.wikipedia.org/wiki/YIQ) and defaults `threshold` value to `0.2`.
     - `maxDiffPixels` ?<[int]> an acceptable amount of pixels that could be different, unset by default.
     - `maxDiffPixelRatio` ?<[float]> an acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1` , unset by default.
+  - `toPass` ?<[Object]> Configuration for the [expect(value).toPass([, options])](https://playwright.dev/docs/test-assertions#expecttopass) method.
+    - `timeout` ?<[int]> timeout for toPass method in milliseconds.
+    - `intervals` ?<[Array]<[int]>> set custom retry intervals.
 
 Configuration for the `expect` assertion library. Learn more about [various timeouts](../test-timeouts.md).
 

diff --git a/docs/src/test-api/class-testproject.md b/docs/src/test-api/class-testproject.md
@@ -101,6 +101,9 @@ export default defineConfig({
     - `threshold` ?<[float]> an acceptable perceived color difference between the same pixel in compared images, ranging from `0` (strict) and `1` (lax). `"pixelmatch"` comparator computes color difference in [YIQ color space](https://en.wikipedia.org/wiki/YIQ) and defaults `threshold` value to `0.2`.
     - `maxDiffPixels` ?<[int]> an acceptable amount of pixels that could be different, unset by default.
     - `maxDiffPixelRatio` ?<[float]> an acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1` , unset by default.
+  - `toPass` ?<[Object]> Configuration for the [expect(value).toPass([, options])](https://playwright.dev/docs/test-assertions#expecttopass) method.
+    - `timeout` ?<[int]> timeout for toPass method in milliseconds.
+    - `intervals` ?<[Array]<[int]>> set custom retry intervals.
 
 Configuration for the `expect` assertion library.
 

diff --git a/packages/playwright/src/matchers/matchers.ts b/packages/playwright/src/matchers/matchers.ts
@@ -25,6 +25,7 @@ import { captureRawStack, constructURLBasedOnBaseURL, isRegExp, isTextualMimeTyp
 import { currentTestInfo } from '../common/globals';
 import { TestInfoImpl, type TestStepInternal } from '../worker/testInfo';
 import type { ExpectMatcherContext } from './expect';
+import { takeFirst } from '../common/config';
 
 interface LocatorEx extends Locator {
   _expect(expression: string, options: Omit<FrameExpectOptions, 'expectedValue'> & { expectedValue?: any }): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }>;
@@ -367,7 +368,7 @@ export async function toPass(
   } = {},
 ) {
   const testInfo = currentTestInfo();
-  const timeout = options.timeout !== undefined ? options.timeout : 0;
+  const timeout = takeFirst(options.timeout, testInfo?._projectInternal.expect?.toPass?.timeout, 0);
 
   const rawStack = captureRawStack();
   const stackFrames = filteredStackTrace(rawStack);

diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.ts
@@ -688,6 +688,22 @@ interface TestConfig {
        */
       maxDiffPixelRatio?: number;
     };
+
+    /**
+     * Configuration for the [expect(value).toPass([, options])](https://playwright.dev/docs/test-assertions#expecttopass)
+     * method.
+     */
+    toPass?: {
+      /**
+       * timeout for toPass method in milliseconds.
+       */
+      timeout?: number;
+
+      /**
+       * set custom retry intervals.
+       */
+      intervals?: Array<number>;
+    };
   };
 
   /**
@@ -6763,6 +6779,22 @@ interface TestProject {
        */
       maxDiffPixelRatio?: number;
     };
+
+    /**
+     * Configuration for the [expect(value).toPass([, options])](https://playwright.dev/docs/test-assertions#expecttopass)
+     * method.
+     */
+    toPass?: {
+      /**
+       * timeout for toPass method in milliseconds.
+       */
+      timeout?: number;
+
+      /**
+       * set custom retry intervals.
+       */
+      intervals?: Array<number>;
+    };
   };
 
   /**

diff --git a/tests/playwright-test/expect-to-pass.spec.ts b/tests/playwright-test/expect-to-pass.spec.ts
@@ -220,3 +220,25 @@ test('should show intermediate result for toPass that spills over test time', as
   expect(result.output).toContain('Expected: 2');
   expect(result.output).toContain('Received: 3');
 });
+
+test('should respect timeout in config file', async ({ runInlineTest }) => {
+  const result = await runInlineTest({
+    'playwright.config.js': `module.exports = { expect: { toPass: { timeout: 100 } } }`,
+    'a.spec.ts': `
+      import { test, expect } from '@playwright/test';
+      test('should fail', async () => {
+        await test.expect(() => {
+          expect(1).toBe(2);
+        }).toPass();
+      });
+    `
+  });
+  expect(result.exitCode).toBe(1);
+  expect(result.output).toContain('Timeout 100ms exceeded while waiting on the predicate');
+  expect(result.output).toContain('Received: 1');
+  expect(result.output).toContain(`
+  4 |         await test.expect(() => {
+  `.trim());
+});
+
+