playwright 1.38.0 → 1.38.1

package/lib/runner/reporters.js

@@ -107,4 +107,7 @@ class ListModeReporter extends _empty.default {
     // eslint-disable-next-line no-console
     console.error('\n' + (0, _base.formatError)(error, false).message);
   }
+  printsToStdio() {
+    return true;
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright",
-  "version": "1.38.0",
+  "version": "1.38.1",
   "description": "A high-level API to automate web browsers",
   "repository": "github:Microsoft/playwright",
   "homepage": "https://playwright.dev",
@@ -51,7 +51,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "playwright-core": "1.38.0"
+    "playwright-core": "1.38.1"
   },
   "optionalDependencies": {
     "fsevents": "2.3.2"

package/types/test.d.ts

@@ -595,8 +595,7 @@ interface TestConfig {
   };
 
   /**
-   * Configuration for the `expect` assertion library. Learn more about
-   * [test configuration](https://playwright.dev/docs/test-configuration#expect-options).
+   * Configuration for the `expect` assertion library. Learn more about [various timeouts](https://playwright.dev/docs/test-timeouts).
    *
    * **Usage**
    *
@@ -607,7 +606,7 @@ interface TestConfig {
    * export default defineConfig({
    *   expect: {
    *     timeout: 10000,
-   *     toHaveScreenshot: {
+   *     toMatchSnapshot: {
    *       maxDiffPixels: 10,
    *     },
    *   },
@@ -628,19 +627,19 @@ interface TestConfig {
      */
     toHaveScreenshot?: {
       /**
-       * An acceptable perceived color difference between the same pixel in compared images, ranging from `0` (strict) and
+       * 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`.
        */
       threshold?: number;
 
       /**
-       * An acceptable amount of pixels that could be different, unset by default.
+       * an acceptable amount of pixels that could be different, unset by default.
        */
       maxDiffPixels?: number;
 
       /**
-       * An acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1` , unset by
+       * an acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1` , unset by
        * default.
        */
       maxDiffPixelRatio?: number;
@@ -666,25 +665,25 @@ interface TestConfig {
 
     /**
      * Configuration for the
-     * [snapshotAssertions.toMatchSnapshot(name)](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1)
+     * [snapshotAssertions.toMatchSnapshot(name[, options])](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1)
      * method.
      */
     toMatchSnapshot?: {
       /**
-       * **Deprecated.** 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
+       * 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`.
        */
       threshold?: number;
 
       /**
-       * **Deprecated.** An acceptable amount of pixels that could be different, unset by default.
+       * an acceptable amount of pixels that could be different, unset by default.
        */
       maxDiffPixels?: number;
 
       /**
-       * **Deprecated.** An acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1`
-       * , unset by default.
+       * an acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1` , unset by
+       * default.
        */
       maxDiffPixelRatio?: number;
     };
@@ -834,10 +833,8 @@ interface TestConfig {
   grepInvert?: RegExp|Array<RegExp>;
 
   /**
-   * Whether to skip snapshot expectations, such as
-   * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
-   * and
-   * [snapshotAssertions.toMatchSnapshot(name)](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1).
+   * Whether to skip snapshot expectations, such as `expect(value).toMatchSnapshot()` and `await
+   * expect(page).toHaveScreenshot()`.
    *
    * **Usage**
    *
@@ -1106,9 +1103,8 @@ interface TestConfig {
    * [testConfig.snapshotPathTemplate](https://playwright.dev/docs/api/class-testconfig#test-config-snapshot-path-template)
    * to configure snapshot paths.
    *
-   * The base directory, relative to the config file, for screenshot files created with
-   * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1).
-   * Defaults to [testConfig.testDir](https://playwright.dev/docs/api/class-testconfig#test-config-test-dir).
+   * The base directory, relative to the config file, for snapshot files created with `toMatchSnapshot`. Defaults to
+   * [testConfig.testDir](https://playwright.dev/docs/api/class-testconfig#test-config-test-dir).
    *
    * **Usage**
    *
@@ -1137,7 +1133,7 @@ interface TestConfig {
    * This option configures a template controlling location of snapshots generated by
    * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
    * and
-   * [snapshotAssertions.toMatchSnapshot(name)](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1).
+   * [snapshotAssertions.toMatchSnapshot(name[, options])](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1).
    *
    * **Usage**
    *
@@ -2271,8 +2267,8 @@ export interface TestInfo {
    *
    * Suffix used to differentiate snapshots between multiple test configurations. For example, if snapshots depend on
    * the platform, you can set `testInfo.snapshotSuffix` equal to `process.platform`. In this case
-   * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
-   * will use different snapshots depending on the platform. Learn more about [snapshots](https://playwright.dev/docs/test-snapshots).
+   * `expect(value).toMatchSnapshot(snapshotName)` will use different snapshots depending on the platform. Learn more
+   * about [snapshots](https://playwright.dev/docs/test-snapshots).
    */
   snapshotSuffix: string;
 
@@ -5075,35 +5071,13 @@ type FunctionAssertions = {
   toPass(options?: { timeout?: number, intervals?: number[] }): Promise<void>;
 };
 
-type BufferAssertions = {
-  /**
-   * Ensures that the passed [Buffer] matches the expected snapshot stored in the test snapshots directory.
-   * @deprecated To avoid flakiness, use
-   * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
-   * instead.
-   * @param name Snapshot name.
-   * @param options
-   */
-  toMatchSnapshot(name: string | Array<string>, options?: { maxDiffPixelRatio?: number, maxDiffPixels?: number, threshold?: number }): void;
-
-  /**
-   * Ensures that the passed [Buffer] matches the expected snapshot stored in the test snapshots directory.
-   * @deprecated To avoid flakiness, use
-   * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
-   * instead.
-   * @param options
-   */
-  toMatchSnapshot(options?: { maxDiffPixelRatio?: number, maxDiffPixels?: number, name?: string|Array<string>, threshold?: number }): void;
-};
-
 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 Buffer ? BufferAssertions & GenericAssertions<R> & PlaywrightTest.Matchers<R, T> :
+  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>;
 
@@ -6247,63 +6221,123 @@ interface PageAssertions {
 }
 
 /**
- * **NOTE** For visual regression testing, use
- * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
- * and
- * [locatorAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-have-screenshot-1)
- * instead.
- *
- * Playwright provides methods for comparing text values with expected values stored in snapshot files.
+ * Playwright provides methods for comparing page and element screenshots with expected values stored in files.
  *
  * ```js
- * expect(text).toMatchSnapshot('snapshot.txt');
+ * expect(screenshot).toMatchSnapshot('landing-page.png');
  * ```
  *
  */
 interface SnapshotAssertions {
   /**
-   * Ensures that the passed [string] matches the expected snapshot stored in the test snapshots directory.
+   * **NOTE** To compare screenshots, use
+   * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
+   * instead.
+   *
+   * Ensures that passed value, either a [string] or a [Buffer], matches the expected snapshot stored in the test
+   * snapshots directory.
    *
    * **Usage**
    *
    * ```js
    * // Basic usage.
-   * expect(await page.title()).toMatchSnapshot('page-title.txt');
+   * expect(await page.screenshot()).toMatchSnapshot('landing-page.png');
+   *
+   * // Pass options to customize the snapshot comparison and have a generated name.
+   * expect(await page.screenshot()).toMatchSnapshot('landing-page.png', {
+   *   maxDiffPixels: 27, // allow no more than 27 different pixels.
+   * });
+   *
+   * // Configure image matching threshold.
+   * expect(await page.screenshot()).toMatchSnapshot('landing-page.png', { threshold: 0.3 });
    *
    * // Bring some structure to your snapshot files by passing file path segments.
-   * expect(await page.title()).toMatchSnapshot(['page-title', 'step1.txt']);
-   * expect(await page.title()).toMatchSnapshot(['page-title', 'step2.txt']);
+   * expect(await page.screenshot()).toMatchSnapshot(['landing', 'step2.png']);
+   * expect(await page.screenshot()).toMatchSnapshot(['landing', 'step3.png']);
    * ```
    *
+   * Learn more about [visual comparisons](https://playwright.dev/docs/test-snapshots).
+   *
    * Note that matching snapshots only work with Playwright test runner.
    * @param name Snapshot name.
+   * @param options
    */
-  toMatchSnapshot(name: string|Array<string>): void;
+  toMatchSnapshot(name: string|Array<string>, options?: {
+    /**
+     * An acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1`. Default is
+     * configurable with `TestConfig.expect`. Unset by default.
+     */
+    maxDiffPixelRatio?: number;
+
+    /**
+     * An acceptable amount of pixels that could be different. Default is configurable with `TestConfig.expect`. Unset by
+     * default.
+     */
+    maxDiffPixels?: number;
+
+    /**
+     * An acceptable perceived color difference in the [YIQ color space](https://en.wikipedia.org/wiki/YIQ) between the
+     * same pixel in compared images, between zero (strict) and one (lax), default is configurable with
+     * `TestConfig.expect`. Defaults to `0.2`.
+     */
+    threshold?: number;
+  }): void;
 
   /**
+   * **NOTE** To compare screenshots, use
+   * [pageAssertions.toHaveScreenshot([options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-2)
+   * instead.
+   *
    * Ensures that passed value, either a [string] or a [Buffer], matches the expected snapshot stored in the test
    * snapshots directory.
    *
    * **Usage**
    *
    * ```js
-   * // Basic usage.
-   * expect(await page.title()).toMatchSnapshot();
+   * // Basic usage and the file name is derived from the test name.
+   * expect(await page.screenshot()).toMatchSnapshot();
    *
-   * // Configure the snapshot name.
-   * expect(await page.title()).toMatchSnapshot({
-   *   name: 'page-title.txt',
+   * // Pass options to customize the snapshot comparison and have a generated name.
+   * expect(await page.screenshot()).toMatchSnapshot({
+   *   maxDiffPixels: 27, // allow no more than 27 different pixels.
+   * });
+   *
+   * // Configure image matching threshold and snapshot name.
+   * expect(await page.screenshot()).toMatchSnapshot({
+   *   name: 'landing-page.png',
+   *   threshold: 0.3,
    * });
    * ```
    *
+   * Learn more about [visual comparisons](https://playwright.dev/docs/test-snapshots).
+   *
    * Note that matching snapshots only work with Playwright test runner.
    * @param options
    */
   toMatchSnapshot(options?: {
+    /**
+     * An acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1`. Default is
+     * configurable with `TestConfig.expect`. Unset by default.
+     */
+    maxDiffPixelRatio?: number;
+
+    /**
+     * An acceptable amount of pixels that could be different. Default is configurable with `TestConfig.expect`. Unset by
+     * default.
+     */
+    maxDiffPixels?: number;
+
     /**
      * Snapshot name. If not passed, the test name and ordinals are used when called multiple times.
      */
     name?: string|Array<string>;
+
+    /**
+     * An acceptable perceived color difference in the [YIQ color space](https://en.wikipedia.org/wiki/YIQ) between the
+     * same pixel in compared images, between zero (strict) and one (lax), default is configurable with
+     * `TestConfig.expect`. Defaults to `0.2`.
+     */
+    threshold?: number;
   }): void;
 }
 
@@ -6439,19 +6473,19 @@ interface TestProject {
      */
     toHaveScreenshot?: {
       /**
-       * An acceptable perceived color difference between the same pixel in compared images, ranging from `0` (strict) and
+       * 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`.
        */
       threshold?: number;
 
       /**
-       * An acceptable amount of pixels that could be different, unset by default.
+       * an acceptable amount of pixels that could be different, unset by default.
        */
       maxDiffPixels?: number;
 
       /**
-       * An acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1` , unset by
+       * an acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1` , unset by
        * default.
        */
       maxDiffPixelRatio?: number;
@@ -6477,25 +6511,25 @@ interface TestProject {
 
     /**
      * Configuration for the
-     * [snapshotAssertions.toMatchSnapshot(name)](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1)
+     * [snapshotAssertions.toMatchSnapshot(name[, options])](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1)
      * method.
      */
     toMatchSnapshot?: {
       /**
-       * **Deprecated.** 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
+       * 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`.
        */
       threshold?: number;
 
       /**
-       * **Deprecated.** An acceptable amount of pixels that could be different, unset by default.
+       * an acceptable amount of pixels that could be different, unset by default.
        */
       maxDiffPixels?: number;
 
       /**
-       * **Deprecated.** An acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1`
-       * , unset by default.
+       * an acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1` , unset by
+       * default.
        */
       maxDiffPixelRatio?: number;
     };
@@ -6605,7 +6639,7 @@ interface TestProject {
    * This option configures a template controlling location of snapshots generated by
    * [pageAssertions.toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
    * and
-   * [snapshotAssertions.toMatchSnapshot(name)](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1).
+   * [snapshotAssertions.toMatchSnapshot(name[, options])](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1).
    *
    * **Usage**
    *