@gravity-ui/playwright-tools 0.8.4 → 0.9.0

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, dumpsPath, dumpsFilePath, ...harPatcherParams }: MockNetworkFixtureBuilderParams): [TestFixture<boolean, PlaywrightTestArgs & PlaywrightTestOptions>, {
+export declare function mockNetworkFixtureBuilder({ shouldUpdate, forceUpdateIfHarMissing, updateTimeout, zip, url: urlMatcherBuilder, dumpsFilePath, ...harPatcherParams }: MockNetworkFixtureBuilderParams): [TestFixture<boolean, PlaywrightTestArgs & PlaywrightTestOptions>, {
     auto: boolean;
     scope: "test";
 }];

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

@@ -3,7 +3,7 @@ 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, dumpsPath, dumpsFilePath, ...harPatcherParams }) {
+function mockNetworkFixtureBuilder({ shouldUpdate, forceUpdateIfHarMissing, updateTimeout, zip = true, url: urlMatcherBuilder, dumpsFilePath, ...harPatcherParams }) {
     const mockNetworkFixture = async ({ baseURL: rawBaseURL, page }, use, testInfo) => {
         if (!rawBaseURL) {
             throw new Error('baseURL should be specified in playwright config');
@@ -16,7 +16,6 @@ function mockNetworkFixtureBuilder({ shouldUpdate, forceUpdateIfHarMissing, upda
         const update = Boolean(shouldUpdate);
         const url = urlMatcherBuilder(baseURL);
         await (0, har_1.initDumps)(page, testInfo, {
-            dumpsPath,
             dumpsFilePath,
             forceUpdateIfHarMissing,
             updateTimeout,

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

@@ -27,29 +27,16 @@ export type MockNetworkFixtureBuilderParams = {
      * @returns string | RegExp Regular expression prepared template; Glob or RegExp.
      */
     url: (baseURL: string) => string | RegExp;
-    /**
-     * User path to the directory with dumps. By default, the path is calculated as
-     * testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug)
-     * @param testInfo TestInfo information about the current test
-     * @param slug Test slug
-     *
-     * @returns string path to the directory with dumps
-     *
-     * @deprecated use dumpsFilePath.
-     */
-    dumpsPath?: (testInfo: TestInfo, slug: string) => string;
     /**
      * Custom path to the dump file. Overrides the path generated by dumpsPath.
      * @param params Parameters for constructing a path:
      * @param params.testInfo TestInfo information about the current test
-     * @param params.slug test slug
      * @param params.zip Flag to use zip archive for .har
      *
      * @returns string path to dump file
      */
     dumpsFilePath?: (params: {
         testInfo: TestInfo;
-        slug: string;
         zip: boolean;
     }) => string;
     /**

package/har/dumpsFilePathBulders.d.ts

@@ -0,0 +1,9 @@
+import type { TestInfo } from '@playwright/test';
+export declare function defaultDumpsFilePathBuilder({ testInfo, zip, }: {
+    testInfo: TestInfo;
+    zip: boolean;
+}): string;
+export declare function dumpsPathBuldeWithSlugBuilder({ testInfo, zip, }: {
+    testInfo: TestInfo;
+    zip: boolean;
+}): string;

package/har/dumpsFilePathBulders.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultDumpsFilePathBuilder = defaultDumpsFilePathBuilder;
+exports.dumpsPathBuldeWithSlugBuilder = dumpsPathBuldeWithSlugBuilder;
+const utils_1 = require("../utils");
+function defaultDumpsFilePathBuilder({ testInfo, zip, }) {
+    const filePath = testInfo.snapshotPath(testInfo.titlePath
+        .slice(1)
+        .join('-')
+        .replace(/ /g, '-')
+        .replace(/[^a-zA-Z0-9\-_]/g, ''));
+    return zip ? `${filePath}.zip` : `${filePath}.har`;
+}
+// previous implementation, includes slug in the path
+function dumpsPathBuldeWithSlugBuilder({ testInfo, zip, }) {
+    const slug = (0, utils_1.extractTestSlug)(testInfo.title, true);
+    const filePath = testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug);
+    return zip ? `${filePath}.zip` : `${filePath}.har`;
+}

package/har/index.d.ts

@@ -11,3 +11,4 @@ export { initDumps } from './initDumps';
 export { replaceBaseUrlInEntry } from './replaceBaseUrlInEntry';
 export { setExtraHash } from './setExtraHash';
 export type { HARFile, Entry } from './types';
+export { defaultDumpsFilePathBuilder, dumpsPathBuldeWithSlugBuilder } from './dumpsFilePathBulders';

package/har/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setExtraHash = exports.replaceBaseUrlInEntry = exports.initDumps = exports.clearHeaders = exports.addFlushTransform = exports.addHarRecorderTransform = exports.addHarOpenTransform = exports.addHarLookupTransform = void 0;
+exports.dumpsPathBuldeWithSlugBuilder = exports.defaultDumpsFilePathBuilder = exports.setExtraHash = exports.replaceBaseUrlInEntry = exports.initDumps = exports.clearHeaders = exports.addFlushTransform = exports.addHarRecorderTransform = exports.addHarOpenTransform = exports.addHarLookupTransform = void 0;
 var addHarLookupTransform_1 = require("./addHarLookupTransform");
 Object.defineProperty(exports, "addHarLookupTransform", { enumerable: true, get: function () { return addHarLookupTransform_1.addHarLookupTransform; } });
 var addHarOpenTransform_1 = require("./addHarOpenTransform");
@@ -17,3 +17,6 @@ var replaceBaseUrlInEntry_1 = require("./replaceBaseUrlInEntry");
 Object.defineProperty(exports, "replaceBaseUrlInEntry", { enumerable: true, get: function () { return replaceBaseUrlInEntry_1.replaceBaseUrlInEntry; } });
 var setExtraHash_1 = require("./setExtraHash");
 Object.defineProperty(exports, "setExtraHash", { enumerable: true, get: function () { return setExtraHash_1.setExtraHash; } });
+var dumpsFilePathBulders_1 = require("./dumpsFilePathBulders");
+Object.defineProperty(exports, "defaultDumpsFilePathBuilder", { enumerable: true, get: function () { return dumpsFilePathBulders_1.defaultDumpsFilePathBuilder; } });
+Object.defineProperty(exports, "dumpsPathBuldeWithSlugBuilder", { enumerable: true, get: function () { return dumpsFilePathBulders_1.dumpsPathBuldeWithSlugBuilder; } });

package/har/initDumps.d.ts

@@ -34,33 +34,20 @@ export type InitDumpsOptions = {
      * @defaultValue `true`
      */
     zip?: boolean;
-    /**
-     * User path to the directory with dumps. By default, the path is calculated as
-     * testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug)
-     * @param testInfo TestInfo information about the current test
-     * @param slug test slug
-     *
-     * @returns string path to the directory with dumps
-     *
-     * @deprecated use dumpsFilePath.
-     */
-    dumpsPath?: (testInfo: TestInfo, slug: string) => string;
     /**
      * Custom path to the dump file. Overrides the path generated by dumpsPath.
      * @param params Parameters for constructing a path:
      * @param params.testInfo TestInfo information about the current test
-     * @param params.slug test slug
      * @param params.zip Flag to use zip archive for .har
      *
      * @returns string path to dump file
      */
     dumpsFilePath?: (params: {
         testInfo: TestInfo;
-        slug: string;
         zip: boolean;
     }) => string;
 };
 /**
  * Makes the necessary preparations for saving query dumps
  */
-export declare function initDumps(page: Page, testInfo: TestInfo, { dumpsPath: dumpsPathBuilder, dumpsFilePath: dumpsFilePathBuilder, rootPath, forceUpdateIfHarMissing, updateTimeout, notFound, url, zip, update, }?: InitDumpsOptions): Promise<void>;
+export declare function initDumps(page: Page, testInfo: TestInfo, { dumpsFilePath: dumpsFilePathBuilder, rootPath, forceUpdateIfHarMissing, updateTimeout, notFound, url, zip, update, }?: InitDumpsOptions): Promise<void>;

package/har/initDumps.js

@@ -3,29 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.initDumps = initDumps;
 const promises_1 = require("node:fs/promises");
 const node_path_1 = require("node:path");
-const actions_1 = require("../actions");
-const extractTestSlug_1 = require("../utils/extractTestSlug");
+const dumpsFilePathBulders_1 = require("./dumpsFilePathBulders");
 /**
  * Makes the necessary preparations for saving query dumps
  */
-async function initDumps(page, testInfo, { dumpsPath: dumpsPathBuilder = defaultPathBuilder, dumpsFilePath: dumpsFilePathBuilder, rootPath, forceUpdateIfHarMissing = false, updateTimeout, notFound = 'abort', url, zip = true, update = false, } = {}) {
-    let slug;
-    try {
-        slug = (0, actions_1.getTestSlug)(page);
-    }
-    catch (error) {
-        console.warn(error);
-        // Backward compatibility
-        slug = (0, extractTestSlug_1.extractTestSlug)(testInfo.title, true);
-    }
+async function initDumps(page, testInfo, { dumpsFilePath: dumpsFilePathBuilder = dumpsFilePathBulders_1.defaultDumpsFilePathBuilder, rootPath, forceUpdateIfHarMissing = false, updateTimeout, notFound = 'abort', url, zip = true, update = false, } = {}) {
     let harPath;
-    if (dumpsFilePathBuilder) {
-        harPath = dumpsFilePathBuilder({ testInfo, slug, zip });
-    }
-    else {
-        const dumpsPath = dumpsPathBuilder(testInfo, slug);
-        harPath = (0, node_path_1.join)(dumpsPath, zip ? 'har.zip' : 'har.har');
-    }
+    harPath = dumpsFilePathBuilder({ testInfo, zip });
     if (rootPath) {
         harPath = (0, node_path_1.relative)(rootPath, harPath);
     }
@@ -49,6 +33,3 @@ async function initDumps(page, testInfo, { dumpsPath: dumpsPathBuilder = default
         url,
     });
 }
-function defaultPathBuilder(testInfo, slug) {
-    return testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug);
-}

package/package.json

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