@gravity-ui/playwright-tools 0.4.1

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

@@ -0,0 +1,86 @@
+import type { TestInfo } from '@playwright/test';
+import type { Entry, HarLookupParamsTransformFunction, HarLookupResultTransformFunction } from '../../har';
+export type MockNetworkFixtureBuilderParams = {
+    /**
+     * Update dumps or not
+     * @defaultValue `false`
+     */
+    shouldUpdate: boolean;
+    /**
+     * Always update dumps if they are missing
+     * @defaultValue `false`
+     */
+    forceUpdateIfHarMissing?: boolean;
+    /**
+     * Custom timeout for updating tests. Milliseconds.
+     * Useful for long updates
+     */
+    updateTimeout?: number;
+    /**
+     * Archive dumps
+     * @defaultValue true
+     */
+    zip?: boolean;
+    /**
+     *The address pattern of requests that will be written to .har. Inappropriate requests will be skipped.
+     * @param baseURL string The base address of the page.
+     * @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;
+    /**
+     * Additional headers that will be removed before writing the request to .har
+     * By default, the following headers are removed: `cookie`, `x-csrf-token`, `content-security-policy`, `Session_id`
+     */
+    headersToRemove?: string[];
+    /**
+     * Additional set-cookie values for which set-cookie headers will be removed
+     * By default, set-cookies are removed for the following values: with`CSRF-TOKEN`
+     */
+    setCookieToRemove?: string[];
+    /**
+     * 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
+     */
+    onHarEntryWillWrite?: (entry: Entry) => 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
+     */
+    onHarEntryWillRead?: (entry: Entry) => void;
+    /**
+     * Callback for changing search parameters of queries in .har
+     */
+    onTransformHarLookupParams?: HarLookupParamsTransformFunction;
+    /**
+     * Callback for transforming the search query result into .har
+     */
+    onTransformHarLookupResult?: HarLookupResultTransformFunction;
+};

package/fixtures/mock-network/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/fixtures/testSlug.d.ts

@@ -0,0 +1,12 @@
+import type { TestFixture } from '@playwright/test';
+import type { PlaywrightTestArgsBase } from './types';
+export type TestSlugResult = string;
+declare const testSlugValue: TestFixture<TestSlugResult, PlaywrightTestArgsBase>;
+declare const fixtureOptions: {
+    auto: boolean;
+};
+/**
+ * Automatically sets and adds the current slug value for the test to the test fixtures
+ */
+export declare const testSlug: [typeof testSlugValue, typeof fixtureOptions];
+export {};

package/fixtures/testSlug.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testSlug = void 0;
+const actions_1 = require("../actions");
+const testSlugValue = async ({ page }, use, testInfo) => {
+    (0, actions_1.setTestSlug)(page, testInfo.title, true);
+    const slug = (0, actions_1.getTestSlug)(page);
+    await use(slug);
+};
+const fixtureOptions = {
+    auto: true,
+};
+/**
+ * Automatically sets and adds the current slug value for the test to the test fixtures
+ */
+exports.testSlug = [
+    testSlugValue,
+    fixtureOptions,
+];

package/fixtures/types.d.ts

@@ -0,0 +1,4 @@
+import type { PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions } from '@playwright/test';
+export type AllPlaywrightTestFixtures = PlaywrightTestArgs & PlaywrightTestOptions;
+export type AllPlaywrightWorkerFixtures = PlaywrightWorkerArgs & PlaywrightWorkerOptions;
+export type PlaywrightTestArgsBase = AllPlaywrightTestFixtures & AllPlaywrightWorkerFixtures;

package/fixtures/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/har/addHarLookupTransform.d.ts

@@ -0,0 +1,9 @@
+import type { LocalUtilsHarLookupParams, LocalUtilsHarLookupResult } from './types';
+export type HarLookupParamsTransformFunction = (params: LocalUtilsHarLookupParams) => LocalUtilsHarLookupParams;
+export type HarLookupResultTransformFunction = (result: LocalUtilsHarLookupResult, params: LocalUtilsHarLookupParams) => LocalUtilsHarLookupResult | Promise<LocalUtilsHarLookupResult>;
+/**
+ * Allows you to make modifications at the stage of searching for a record in the dump that matches the request
+ * @param transformParams Function for changing the parameters on the basis of which the search will be performed
+ * @param transformResult Function for changing the search result (here you can change the parameters of the found answer, for example its body)
+ */
+export declare function addHarLookupTransform(transformParams?: HarLookupParamsTransformFunction, transformResult?: HarLookupResultTransformFunction): void;

package/har/addHarLookupTransform.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addHarLookupTransform = addHarLookupTransform;
+const getPlaywrightCoreModule_1 = require("./getPlaywrightCoreModule");
+function wrapLocalUtilsDispatcherMethods(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+LocalUtilsDispatcher, transformParams, transformResult) {
+    const originalHarLookup = LocalUtilsDispatcher.prototype.harLookup;
+    if (originalHarLookup) {
+        // eslint-disable-next-line no-param-reassign
+        LocalUtilsDispatcher.prototype.harLookup = async function harLookup(params, metadata, ...rest) {
+            if (transformParams) {
+                // eslint-disable-next-line no-param-reassign
+                params = transformParams(params);
+            }
+            let result = await originalHarLookup.call(this, params, metadata, ...rest);
+            if (transformResult) {
+                result = transformResult(result, params);
+            }
+            return result;
+        };
+    }
+    else {
+        throw new Error('Can\'t find "harLookup" method in "LocalUtilsDispatcher" class.');
+    }
+}
+let patchInited = false;
+function initLocalUtilsDispatcherPatch(transformParams, transformResult) {
+    patchInited = true;
+    const modules = (0, getPlaywrightCoreModule_1.getPlaywrightCoreModule)('lib/server/dispatchers/localUtilsDispatcher');
+    for (const module of modules) {
+        wrapLocalUtilsDispatcherMethods(module.LocalUtilsDispatcher, transformParams, transformResult);
+    }
+}
+/**
+ * Allows you to make modifications at the stage of searching for a record in the dump that matches the request
+ * @param transformParams Function for changing the parameters on the basis of which the search will be performed
+ * @param transformResult Function for changing the search result (here you can change the parameters of the found answer, for example its body)
+ */
+function addHarLookupTransform(transformParams, transformResult) {
+    if (!patchInited) {
+        initLocalUtilsDispatcherPatch(transformParams, transformResult);
+    }
+}

package/har/addHarOpenTransform.d.ts

@@ -0,0 +1,6 @@
+import type { HARFile } from './types';
+export type HarTransformFunction = (harFile: HARFile) => void;
+/**
+ * Allows you to make changes to the JSON read from an open HAR file
+ */
+export declare function addHarOpenTransform(transform: HarTransformFunction): void;

package/har/addHarOpenTransform.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addHarOpenTransform = addHarOpenTransform;
+const getPlaywrightCoreModule_1 = require("./getPlaywrightCoreModule");
+function wrapLocalUtilsDispatcherMethods(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+LocalUtilsDispatcher, transform) {
+    const originalHarOpen = LocalUtilsDispatcher.prototype.harOpen;
+    if (originalHarOpen) {
+        // eslint-disable-next-line no-param-reassign
+        LocalUtilsDispatcher.prototype.harOpen = async function harOpen(...rest) {
+            const result = await originalHarOpen.apply(this, rest);
+            const harBackends = this._harBackends || this._harBakends;
+            const harBackend = harBackends.get(result.harId);
+            const harFile = harBackend._harFile;
+            if (harFile) {
+                transform(harFile);
+            }
+            return result;
+        };
+    }
+    else {
+        throw new Error('Can\'t find "harOpen" method in "LocalUtilsDispatcher" class.');
+    }
+}
+let patchInited = false;
+function initLocalUtilsDispatcherPatch(transform) {
+    patchInited = true;
+    const modules = (0, getPlaywrightCoreModule_1.getPlaywrightCoreModule)('lib/server/dispatchers/localUtilsDispatcher');
+    for (const module of modules) {
+        wrapLocalUtilsDispatcherMethods(module.LocalUtilsDispatcher, transform);
+    }
+}
+/**
+ * Allows you to make changes to the JSON read from an open HAR file
+ */
+function addHarOpenTransform(transform) {
+    if (!patchInited) {
+        initLocalUtilsDispatcherPatch(transform);
+    }
+}

package/har/addHarRecorderTransform.d.ts

@@ -0,0 +1,6 @@
+import type { Entry } from './types';
+export type EntryTransformFunction = (entry: Entry) => void;
+/**
+ * Allows you to make changes to the JSON that will be written to the HAR file
+ */
+export declare function addHarRecorderTransform(transform: EntryTransformFunction): void;

package/har/addHarRecorderTransform.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addHarRecorderTransform = addHarRecorderTransform;
+const getPlaywrightCoreModule_1 = require("./getPlaywrightCoreModule");
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function wrapHarRecorderMethods(HarRecorder, transform) {
+    const originalOnEntryFinished = HarRecorder.prototype.onEntryFinished;
+    if (originalOnEntryFinished) {
+        // eslint-disable-next-line no-param-reassign
+        HarRecorder.prototype.onEntryFinished = function onEntryFinished(entry, ...rest) {
+            if (entry) {
+                transform(entry);
+            }
+            return originalOnEntryFinished(entry, rest);
+        };
+    }
+    else {
+        throw new Error('Can\'t find "onEntryFinished" method in "HarRecorder" class.');
+    }
+}
+let patchInited = false;
+function initHarRecorderPatch(transform) {
+    patchInited = true;
+    const modules = (0, getPlaywrightCoreModule_1.getPlaywrightCoreModule)('lib/server/har/harRecorder');
+    for (const module of modules) {
+        wrapHarRecorderMethods(module.HarRecorder, transform);
+    }
+}
+/**
+ * Allows you to make changes to the JSON that will be written to the HAR file
+ */
+function addHarRecorderTransform(transform) {
+    if (!patchInited) {
+        initHarRecorderPatch(transform);
+    }
+}

package/har/clearHeaders.d.ts

@@ -0,0 +1,11 @@
+import type { Header } from './types';
+export type ClearHeadersOptions = {
+    removeHeaders?: Set<string>;
+    removeSetCookieFor?: Set<string>;
+};
+/**
+ * Cleans the specified headers
+ *
+ * Convenient to use in `addHarRecorderTransform` to remove private headers and cookies.
+ */
+export declare function clearHeaders(headers: Header[], { removeHeaders, removeSetCookieFor }: ClearHeadersOptions): Header[];

package/har/clearHeaders.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearHeaders = clearHeaders;
+/**
+ * Cleans the specified headers
+ *
+ * Convenient to use in `addHarRecorderTransform` to remove private headers and cookies.
+ */
+function clearHeaders(headers, { removeHeaders, removeSetCookieFor }) {
+    const nextHeaders = [];
+    for (const header of headers) {
+        const name = header.name.toLowerCase();
+        if (removeHeaders?.has(name)) {
+            continue;
+        }
+        if (name === 'set-cookie' && removeSetCookieFor) {
+            const cookieName = header.value.split('=', 1)[0];
+            if (cookieName && removeSetCookieFor.has(cookieName)) {
+                continue;
+            }
+        }
+        nextHeaders.push(header);
+    }
+    return nextHeaders;
+}

package/har/getPlaywrightCoreModule.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Finds the location of the internal playwright-core module for patching
+ */
+export declare function getPlaywrightCoreModule(path: string): any[];

package/har/getPlaywrightCoreModule.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPlaywrightCoreModule = getPlaywrightCoreModule;
+const path_1 = require("path");
+/**
+ * Finds the location of the internal playwright-core module for patching
+ */
+function getPlaywrightCoreModule(path) {
+    let globalModule;
+    try {
+        const globalModulePath = (0, path_1.dirname)(require.resolve('playwright-core'));
+        globalModule = require((0, path_1.resolve)(globalModulePath, path));
+    }
+    catch {
+        // Do nothing
+    }
+    let internalModule;
+    try {
+        const playwrightTestsPath = (0, path_1.dirname)(require.resolve('@playwright/test'));
+        const harRecorderPath = (0, path_1.resolve)(playwrightTestsPath, 'node_modules/playwright-core/' + path);
+        internalModule = require(harRecorderPath);
+    }
+    catch {
+        // Do nothing
+    }
+    if (!globalModule && !internalModule) {
+        throw new Error(`Can't find "playwright-core/${path}" module.`);
+    }
+    if (globalModule === internalModule) {
+        return [globalModule];
+    }
+    return [globalModule, internalModule].filter((item) => item !== undefined);
+}

package/har/index.d.ts

@@ -0,0 +1,11 @@
+export type { HarLookupParamsTransformFunction, HarLookupResultTransformFunction, } from './addHarLookupTransform';
+export { addHarLookupTransform } from './addHarLookupTransform';
+export type { HarTransformFunction } from './addHarOpenTransform';
+export { addHarOpenTransform } from './addHarOpenTransform';
+export type { EntryTransformFunction } from './addHarRecorderTransform';
+export { addHarRecorderTransform } from './addHarRecorderTransform';
+export { clearHeaders } from './clearHeaders';
+export { initDumps } from './initDumps';
+export { replaceBaseUrlInEntry } from './replaceBaseUrlInEntry';
+export { setExtraHash } from './setExtraHash';
+export type { HARFile, Entry } from './types';

package/har/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setExtraHash = exports.replaceBaseUrlInEntry = exports.initDumps = exports.clearHeaders = 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");
+Object.defineProperty(exports, "addHarOpenTransform", { enumerable: true, get: function () { return addHarOpenTransform_1.addHarOpenTransform; } });
+var addHarRecorderTransform_1 = require("./addHarRecorderTransform");
+Object.defineProperty(exports, "addHarRecorderTransform", { enumerable: true, get: function () { return addHarRecorderTransform_1.addHarRecorderTransform; } });
+var clearHeaders_1 = require("./clearHeaders");
+Object.defineProperty(exports, "clearHeaders", { enumerable: true, get: function () { return clearHeaders_1.clearHeaders; } });
+var initDumps_1 = require("./initDumps");
+Object.defineProperty(exports, "initDumps", { enumerable: true, get: function () { return initDumps_1.initDumps; } });
+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; } });

package/har/initDumps.d.ts

@@ -0,0 +1,66 @@
+import type { Page, TestInfo } from '@playwright/test';
+export type InitDumpsOptions = {
+    /**
+     * Path to the root directory of the project, relative to which the calculation will be made
+     * path to the dump directory (if not specified, the path is absolute)
+     */
+    rootPath?: string;
+    /**
+     * Mode of writing requests to a file instead of reading from it
+     * @defaultValue `false`
+     */
+    update?: boolean;
+    /**
+     * Always update dumps if they are missing
+     * @defaultValue `false`
+     */
+    forceUpdateIfHarMissing?: boolean;
+    /**
+     * Custom timeout for updating tests. Milliseconds.
+     * Useful for long updates
+     */
+    updateTimeout?: number;
+    /**
+     * Operating mode for requests not found in the archive
+     * @defaultValue `'abort'`
+     */
+    notFound?: 'abort' | 'fallback';
+    /**
+     * The address template of the requests to be processed
+     */
+    url?: string | RegExp;
+    /**
+     * Pack the result into an archive
+     * @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>;

package/har/initDumps.js

@@ -0,0 +1,54 @@
+"use strict";
+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");
+/**
+ * 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);
+    }
+    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');
+    }
+    if (rootPath) {
+        harPath = (0, node_path_1.relative)(rootPath, harPath);
+    }
+    harPath = (0, node_path_1.resolve)(harPath);
+    if (forceUpdateIfHarMissing) {
+        try {
+            await (0, promises_1.access)(harPath);
+        }
+        catch {
+            // eslint-disable-next-line no-param-reassign
+            update = true;
+        }
+    }
+    if (update && updateTimeout) {
+        testInfo.setTimeout(updateTimeout);
+    }
+    console.info(update ? 'Write requests to' : 'Read requests from', harPath);
+    await page.context().routeFromHAR(harPath, {
+        update,
+        notFound,
+        url,
+    });
+}
+function defaultPathBuilder(testInfo, slug) {
+    return testInfo.snapshotPath('').replace(/-snapshots\/[^/]+$/, '-data/' + slug);
+}

package/har/replaceBaseUrlInEntry.d.ts

@@ -0,0 +1,9 @@
+import type { Entry } from './types';
+/**
+ * Replaces the base URL in the HAR file request entry
+ *
+ * @param entry ЗRecording from HAR file
+ * @param fromUrl URL to replace
+ * @param toUrl URL to replace with
+ */
+export declare function replaceBaseUrlInEntry(entry: Entry, fromUrl: string, toUrl: string): void;

package/har/replaceBaseUrlInEntry.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceBaseUrlInEntry = replaceBaseUrlInEntry;
+const escape_string_regexp_1 = __importDefault(require("escape-string-regexp"));
+/**
+ * Replaces the base URL in the HAR file request entry
+ *
+ * @param entry ЗRecording from HAR file
+ * @param fromUrl URL to replace
+ * @param toUrl URL to replace with
+ */
+function replaceBaseUrlInEntry(entry, fromUrl, toUrl) {
+    const fromUrlRegExp = new RegExp((0, escape_string_regexp_1.default)(fromUrl), 'g');
+    // eslint-disable-next-line no-param-reassign
+    entry.request.url = entry.request.url.replace(fromUrl, toUrl);
+    if (entry.response.redirectURL) {
+        entry.response.redirectURL.replace(fromUrl, toUrl);
+    }
+    const replaceBaseUrlInHeaders = (headers) => {
+        for (const header of headers) {
+            header.value = header.value.replace(fromUrlRegExp, toUrl);
+        }
+    };
+    replaceBaseUrlInHeaders(entry.request.headers);
+    replaceBaseUrlInHeaders(entry.response.headers);
+}

package/har/setExtraHash.d.ts

@@ -0,0 +1,5 @@
+import type { Page } from '@playwright/test';
+/**
+ * Sets a header that can help differentiate requests with the same parameters.
+ */
+export declare function setExtraHash(page: Page, value: string | null): Promise<void>;

package/har/setExtraHash.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setExtraHash = setExtraHash;
+const addExtraHttpHeader_1 = require("../actions/addExtraHttpHeader");
+const removeExtraHttpHeader_1 = require("../actions/removeExtraHttpHeader");
+const HEADER_NAME = 'x-tests-extra-hash';
+/**
+ * Sets a header that can help differentiate requests with the same parameters.
+ */
+async function setExtraHash(page, value) {
+    const context = page.context();
+    if (value === null) {
+        await (0, removeExtraHttpHeader_1.removeExtraHttpHeader)(context, HEADER_NAME);
+    }
+    else {
+        await (0, addExtraHttpHeader_1.addExtraHttpHeader)(context, HEADER_NAME, value);
+    }
+}