@gravity-ui/playwright-tools 0.9.2 → 1.1.0

package/README.md

@@ -3,7 +3,7 @@
 A library of additional utilities for writing tests using Playwright Test.
 
 ```
-npm i -D playwright-tools
+npm i -D @gravity-ui/playwright-tools
 ```
 
 The package contains several subdirectories with utilities for different purposes. You should import from these subdirectories, for example:

package/fixtures/mock-network/har-patcher.js

@@ -27,16 +27,20 @@ function harPatcher({ baseURL, headersToRemove: additionalHeadersToRemove = [],
             removeSetCookieFor: setCookieToRemove,
         });
         (0, har_1.replaceBaseUrlInEntry)(entry, baseURL, baseUrlPLaceholder);
-        onHarEntryWillWrite?.(entry);
+        onHarEntryWillWrite?.(entry, baseURL);
     });
     (0, har_1.addHarOpenTransform)((harFile) => {
         const entries = harFile.log.entries;
         for (const entry of entries) {
             (0, har_1.replaceBaseUrlInEntry)(entry, baseUrlPLaceholder, baseURL);
-            onHarEntryWillRead?.(entry);
+            onHarEntryWillRead?.(entry, baseURL);
         }
     });
-    (0, har_1.addHarLookupTransform)(onTransformHarLookupParams, onTransformHarLookupResult);
+    (0, har_1.addHarLookupTransform)(onTransformHarLookupParams
+        ? (params) => onTransformHarLookupParams(params, baseURL)
+        : undefined, onTransformHarLookupResult
+        ? (result, params) => onTransformHarLookupResult(result, params, baseURL)
+        : undefined);
     // Filter out canceled requests before writing to har file
     (0, har_1.addFlushTransform)((entries) => entries.filter((entry) => entry.time !== -1));
 }

package/fixtures/mock-network/mock-network-fixture.d.ts

@@ -1,6 +1,6 @@
 import type { PlaywrightTestArgs, PlaywrightTestOptions, TestFixture } from '@playwright/test';
 import type { MockNetworkFixtureBuilderParams } from './types';
-export declare function mockNetworkFixtureBuilder({ shouldUpdate, forceUpdateIfHarMissing, updateTimeout, zip, url: urlMatcherBuilder, dumpsFilePath, ...harPatcherParams }: MockNetworkFixtureBuilderParams): [TestFixture<boolean, PlaywrightTestArgs & PlaywrightTestOptions>, {
+export declare function mockNetworkFixtureBuilder<TestArgs extends PlaywrightTestArgs & PlaywrightTestOptions = PlaywrightTestArgs & PlaywrightTestOptions>({ shouldUpdate, forceUpdateIfHarMissing, updateTimeout, zip, url: urlMatcherBuilder, dumpsFilePath, enabled, ...harPatcherParams }: MockNetworkFixtureBuilderParams<TestArgs>): [TestFixture<boolean, TestArgs>, {
     auto: boolean;
     scope: "test";
 }];

package/fixtures/mock-network/mock-network-fixture.js

@@ -3,8 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mockNetworkFixtureBuilder = mockNetworkFixtureBuilder;
 const har_1 = require("../../har");
 const har_patcher_1 = require("./har-patcher");
-function mockNetworkFixtureBuilder({ shouldUpdate, forceUpdateIfHarMissing, updateTimeout, zip = true, url: urlMatcherBuilder, dumpsFilePath, ...harPatcherParams }) {
-    const mockNetworkFixture = async ({ baseURL: rawBaseURL, page }, use, testInfo) => {
+function mockNetworkFixtureBuilder({ shouldUpdate, forceUpdateIfHarMissing, updateTimeout, zip = true, url: urlMatcherBuilder, dumpsFilePath, enabled, ...harPatcherParams }) {
+    const mockNetworkFixture = async (options, use, testInfo) => {
+        const { baseURL: rawBaseURL, page } = options;
+        if (enabled && !enabled(options)) {
+            await use(false);
+            return;
+        }
         if (!rawBaseURL) {
             throw new Error('baseURL should be specified in playwright config');
         }

package/fixtures/mock-network/types.d.ts

@@ -1,6 +1,6 @@
-import type { TestInfo } from '@playwright/test';
+import type { PlaywrightTestArgs, PlaywrightTestOptions, TestInfo } from '@playwright/test';
 import type { Entry, HarLookupParamsTransformFunction, HarLookupResultTransformFunction } from '../../har';
-export type MockNetworkFixtureBuilderParams = {
+export type MockNetworkFixtureBuilderParams<TestArgs extends PlaywrightTestArgs & PlaywrightTestOptions = PlaywrightTestArgs & PlaywrightTestOptions> = {
     /**
      * Update dumps or not
      * @defaultValue `false`
@@ -53,21 +53,34 @@ export type MockNetworkFixtureBuilderParams = {
      * Callback for processing requests and responses by saving to .har. Useful for various post-processing of requests: cleaning, changing format, etc.
      * By default, sensitive headers are removed + the base url of the request is changed to a stub
      * @param entry The entry in .har that will be written
+     * @param baseURL The base URL of the test
      */
-    onHarEntryWillWrite?: (entry: Entry) => void;
+    onHarEntryWillWrite?: (entry: Entry, baseURL: string) => void;
     /**
      * Callback to process requests and responses written in .har before they are used
      * Useful for reverting changes made in onHarEntryWillWrite
      * By default, the base url templates are replaced with the actual baseUrl of the test
      * @param entry The entry in .har that will be used
+     * @param baseURL The base URL of the test
      */
-    onHarEntryWillRead?: (entry: Entry) => void;
+    onHarEntryWillRead?: (entry: Entry, baseURL: string) => void;
     /**
      * Callback for changing search parameters of queries in .har
+     * @param params The lookup parameters
+     * @param baseURL The base URL of the test
      */
-    onTransformHarLookupParams?: HarLookupParamsTransformFunction;
+    onTransformHarLookupParams?: (params: Parameters<HarLookupParamsTransformFunction>[0], baseURL: string) => ReturnType<HarLookupParamsTransformFunction>;
     /**
      * Callback for transforming the search query result into .har
+     * @param result The lookup result
+     * @param params The lookup parameters
+     * @param baseURL The base URL of the test
      */
-    onTransformHarLookupResult?: HarLookupResultTransformFunction;
+    onTransformHarLookupResult?: (result: Parameters<HarLookupResultTransformFunction>[0], params: Parameters<HarLookupResultTransformFunction>[1], baseURL: string) => ReturnType<HarLookupResultTransformFunction>;
+    /**
+     * Function to conditionally enable or disable the mock network fixture
+     * @param options Test fixture arguments and options (includes custom test args if extended)
+     * @returns `true` to enable the fixture, `false` to disable it
+     */
+    enabled?: (options: TestArgs) => boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/playwright-tools",
-  "version": "0.9.2",
+  "version": "1.1.0",
   "description": "Tools for Playwright Test",
   "keywords": [
     "playwright",