feat: initDumps -> removed deprecated dumpsPath (#31)

Added default for dumpsFilePath
Default is formed as testInfo.titlePath with some alternations
Removed slugs from initDumps. If user want to include slug in
dumps file path, he must override dumpsFilePath manually

Author: SwinX

fixtures/README.md

@@ -234,28 +234,15 @@ type MockNetworkFixtureBuilderParams = {
      */
     url: (baseURL: string) => string | RegExp;
 
-    /**
-     * Custom path to dumps directory. By default, the path is calculated as
-     * testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug)
-     * @param testInfo TestInfo information about current test
-     * @param slug test slug
-     *
-     * @returns string path to dumps directory
-     *
-     * @deprecated Use dumpsFilePath.
-     */
-    dumpsPath?: (testInfo: TestInfo, slug: string) => string;
-
     /**
      * Custom path to dumps file. Overrides the path formed through dumpsPath.
      * @param params Parameters for building the path:
      * @param params.testInfo TestInfo information about current test
-     * @param params.slug test slug
      * @param params.zip Flag for using zip archive for .har
      *
      * @returns string path to dumps file
      */
-    dumpsFilePath?: (params: { testInfo: TestInfo; slug: string; zip: boolean }) => string;
+    dumpsFilePath?: (params: { testInfo: TestInfo; zip: boolean }) => string;
 
     /**
      * Additional headers to be removed before recording request to .har

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

@@ -11,7 +11,6 @@ export function mockNetworkFixtureBuilder({
     updateTimeout,
     zip = true,
     url: urlMatcherBuilder,
-    dumpsPath,
     dumpsFilePath,
 
     ...harPatcherParams
@@ -36,7 +35,6 @@ export function mockNetworkFixtureBuilder({
         const url = urlMatcherBuilder(baseURL);
 
         await initDumps(page, testInfo, {
-            dumpsPath,
             dumpsFilePath,
             forceUpdateIfHarMissing,
             updateTimeout,

fixtures/mock-network/types.ts

@@ -38,28 +38,15 @@ export type MockNetworkFixtureBuilderParams = {
      */
     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;
+    dumpsFilePath?: (params: { testInfo: TestInfo; zip: boolean }) => string;
 
     /**
      * Additional headers that will be removed before writing the request to .har

har/README.md

@@ -227,28 +227,15 @@ async function initDumps(page: Page, testInfo: TestInfo, options?: InitDumpsOpti
 
 ```ts
 type InitDumpsOptions = {
-  /**
-   * Custom path to dumps directory. By default, the path is calculated as
-   * testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug)
-   * @param testInfo TestInfo information about current test
-   * @param slug test slug
-   *
-   * @returns string path to dumps directory
-   *
-   * @deprecated Use dumpsFilePath.
-   */
-  dumpsPath?: (testInfo: TestInfo, slug: string) => string;
-
   /**
    * Custom path to dumps file. Overrides the path formed through dumpsPath.
    * @param params Parameters for building the path:
    * @param params.testInfo TestInfo information about current test
-   * @param params.slug test slug
    * @param params.zip Flag for using zip archive for .har
    *
    * @returns string path to dumps file
    */
-  dumpsFilePath?: (params: { testInfo: TestInfo; slug: string; zip: boolean }) => string;
+  dumpsFilePath?: (params: { testInfo: TestInfo; zip: boolean }) => string;
 
   /**
    * Path to project root directory, relative to which the path to the dumps

har/dumpsFilePathBulders.ts

@@ -0,0 +1,36 @@
+import type { TestInfo } from '@playwright/test';
+
+import { extractTestSlug } from '../utils';
+
+export function defaultDumpsFilePathBuilder({
+    testInfo,
+    zip,
+}: {
+    testInfo: TestInfo;
+    zip: boolean;
+}) {
+    const filePath = testInfo.snapshotPath(
+        testInfo.titlePath
+            .slice(1)
+            .join('-')
+            .replace(/ /g, '-')
+            .replace(/[^a-zA-Z0-9\-_]/g, ''), // Removing characters which are not supported as filename
+    );
+
+    return zip ? `${filePath}.zip` : `${filePath}.har`;
+}
+
+// previous implementation, includes slug in the path
+export function dumpsPathBuldeWithSlugBuilder({
+    testInfo,
+    zip,
+}: {
+    testInfo: TestInfo;
+    zip: boolean;
+}) {
+    const slug = extractTestSlug(testInfo.title, true);
+
+    const filePath = testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug);
+
+    return zip ? `${filePath}.zip` : `${filePath}.har`;
+}

har/index.ts

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

har/initDumps.ts

@@ -1,10 +1,9 @@
 import { access } from 'node:fs/promises';
-import { join, relative, resolve } from 'node:path';
+import { relative, resolve } from 'node:path';
 
 import type { Page, TestInfo } from '@playwright/test';
 
-import { getTestSlug } from '../actions';
-import { extractTestSlug } from '../utils/extractTestSlug';
+import { defaultDumpsFilePathBuilder } from './dumpsFilePathBulders';
 
 export type InitDumpsOptions = {
     /**
@@ -48,28 +47,15 @@ export type InitDumpsOptions = {
      */
     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;
+    dumpsFilePath?: (params: { testInfo: TestInfo; zip: boolean }) => string;
 };
 
 /**
@@ -79,8 +65,7 @@ export async function initDumps(
     page: Page,
     testInfo: TestInfo,
     {
-        dumpsPath: dumpsPathBuilder = defaultPathBuilder,
-        dumpsFilePath: dumpsFilePathBuilder,
+        dumpsFilePath: dumpsFilePathBuilder = defaultDumpsFilePathBuilder,
         rootPath,
         forceUpdateIfHarMissing = false,
         updateTimeout,
@@ -90,25 +75,9 @@ export async function initDumps(
         update = false,
     }: InitDumpsOptions = {},
 ) {
-    let slug: string;
-
-    try {
-        slug = getTestSlug(page);
-    } catch (error) {
-        console.warn(error);
-        // Backward compatibility
-        slug = extractTestSlug(testInfo.title, true);
-    }
-
     let harPath: string;
 
-    if (dumpsFilePathBuilder) {
-        harPath = dumpsFilePathBuilder({ testInfo, slug, zip });
-    } else {
-        const dumpsPath = dumpsPathBuilder(testInfo, slug);
-
-        harPath = join(dumpsPath, zip ? 'har.zip' : 'har.har');
-    }
+    harPath = dumpsFilePathBuilder({ testInfo, zip });
 
     if (rootPath) {
         harPath = relative(rootPath, harPath);
@@ -137,7 +106,3 @@ export async function initDumps(
         url,
     });
 }
-
-function defaultPathBuilder(testInfo: TestInfo, slug: string) {
-    return testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug);
-}