@gravity-ui/playwright-tools 0.4.1

package/actions/setGlobalSettings.d.ts

@@ -0,0 +1,12 @@
+import type { PartialGlobalSettings } from '../data/globalSettings';
+/**
+ * Sets global settings for commands
+ *
+ * The section settings object is shallowly merged,
+ * without deep merging.
+ *
+ * That is, the settings object
+ * `{ matchScreenshot: { options: { threshold: 0.2 } } }`
+ * will overwrite the entire value of `options` in the `matchScreenshot` section.
+ */
+export declare function setGlobalSettings(settings: PartialGlobalSettings): void;

package/actions/setGlobalSettings.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setGlobalSettings = setGlobalSettings;
+const globalSettings_1 = require("../data/globalSettings");
+/**
+ * Sets global settings for commands
+ *
+ * The section settings object is shallowly merged,
+ * without deep merging.
+ *
+ * That is, the settings object
+ * `{ matchScreenshot: { options: { threshold: 0.2 } } }`
+ * will overwrite the entire value of `options` in the `matchScreenshot` section.
+ */
+function setGlobalSettings(settings) {
+    for (const section of Object.keys(settings)) {
+        Object.assign(globalSettings_1.globalSettings[section], settings[section]);
+    }
+}

package/actions/setTestSlug.d.ts

@@ -0,0 +1,9 @@
+import type { Page } from '@playwright/test';
+/**
+ * Sets the test slug
+ *
+ * @param page
+ * @param title The name of the test from which the slug will be extracted
+ * @param required Requires the slug to be specified in a specific way in the title (otherwise the title itself will be used)
+ */
+export declare function setTestSlug(page: Page, title: string, required?: boolean): void;

package/actions/setTestSlug.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setTestSlug = setTestSlug;
+const testSlugs_1 = require("../data/testSlugs");
+const extractTestSlug_1 = require("../utils/extractTestSlug");
+/**
+ * Sets the test slug
+ *
+ * @param page
+ * @param title The name of the test from which the slug will be extracted
+ * @param required Requires the slug to be specified in a specific way in the title (otherwise the title itself will be used)
+ */
+function setTestSlug(page, title, required = false) {
+    let slug = (0, extractTestSlug_1.extractTestSlug)(title, !required);
+    if (!slug) {
+        if (required) {
+            throw new Error(`Can't extract slug from title "${title}"`);
+        }
+        slug = title.replace(/<>:"\/\\\|\?\*/, '_');
+    }
+    testSlugs_1.testSlugs.set(page, slug);
+}

package/actions/waitForNetworkSettled.d.ts

@@ -0,0 +1,7 @@
+import type { Page } from '@playwright/test';
+/**
+ * Count page requests after performing given `action`, and resolves after all requests finished
+ */
+export declare function waitForNetworkSettled(page: Page, action: () => Promise<void>, { networkSettleDelay }?: {
+    networkSettleDelay?: number | undefined;
+}): Promise<void>;

package/actions/waitForNetworkSettled.js

@@ -0,0 +1,48 @@
+"use strict";
+// https://gist.github.com/dgozman/d1c46f966eb9854ee1fe24960b603b28
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForNetworkSettled = waitForNetworkSettled;
+const globalSettings_1 = require("../data/globalSettings");
+function getDeferredPromise() {
+    let resolveFn;
+    const promise = new Promise((resolve) => {
+        resolveFn = resolve;
+    });
+    return { promise, resolve: resolveFn };
+}
+/**
+ * Count page requests after performing given `action`, and resolves after all requests finished
+ */
+async function waitForNetworkSettled(page, action, { networkSettleDelay = globalSettings_1.globalSettings.waitForNetworkSettled.delay } = {}) {
+    const { resolve: networkSettledCallback, promise: networkSettledPromise } = getDeferredPromise();
+    let requestCounter = 0;
+    let actionDone = false;
+    const maybeSettle = () => {
+        if (actionDone && requestCounter <= 0) {
+            networkSettledCallback();
+        }
+    };
+    const onRequest = () => {
+        ++requestCounter;
+    };
+    const onRequestDone = () => {
+        void page
+            .evaluate((timeout) => new Promise((resolve) => setTimeout(resolve, timeout)), networkSettleDelay)
+            .catch(() => null)
+            .then(() => {
+            --requestCounter;
+            maybeSettle();
+        });
+    };
+    page.on('request', onRequest);
+    page.on('requestfinished', onRequestDone);
+    page.on('requestfailed', onRequestDone);
+    const result = await action();
+    actionDone = true;
+    maybeSettle();
+    await networkSettledPromise;
+    page.removeListener('request', onRequest);
+    page.removeListener('requestfinished', onRequestDone);
+    page.removeListener('requestfailed', onRequestDone);
+    return result;
+}

package/auth/storage/applyStorageState.d.ts

@@ -0,0 +1,10 @@
+import type { BrowserContext } from '@playwright/test';
+import type { StorageState } from '../../data/storageStates';
+/**
+ * Restores saved browser storage
+ *
+ * @param context Browser context
+ * @param storageState Browser Storage Snapshot
+ * @param append Append to existing storage (otherwise - clean first)
+ */
+export declare function applyStorageState(context: BrowserContext, storageState: StorageState, append?: boolean): Promise<void>;

package/auth/storage/applyStorageState.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyStorageState = applyStorageState;
+const restoreCookies_1 = require("./restoreCookies");
+const restoreLocalStorage_1 = require("./restoreLocalStorage");
+/**
+ * Restores saved browser storage
+ *
+ * @param context Browser context
+ * @param storageState Browser Storage Snapshot
+ * @param append Append to existing storage (otherwise - clean first)
+ */
+async function applyStorageState(context, storageState, append = false) {
+    await (0, restoreCookies_1.restoreCookies)(context, storageState.cookies, append);
+    await (0, restoreLocalStorage_1.restoreLocalStorage)(context, storageState.origins, append);
+}

package/auth/storage/applyStorageStateFor.d.ts

@@ -0,0 +1,9 @@
+import type { BrowserContext } from '@playwright/test';
+/**
+ * Restores saved browser storage by the given key
+ *
+ * @param key The key by which the snapshot of the browser storage is saved
+ * @param context Browser context
+ * @param append Add to existing storage (otherwise - clean first)
+ */
+export declare function applyStorageStateFor(key: string, context: BrowserContext, append?: boolean): Promise<void>;

package/auth/storage/applyStorageStateFor.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyStorageStateFor = applyStorageStateFor;
+const storageStates_1 = require("../../data/storageStates");
+const applyStorageState_1 = require("./applyStorageState");
+/**
+ * Restores saved browser storage by the given key
+ *
+ * @param key The key by which the snapshot of the browser storage is saved
+ * @param context Browser context
+ * @param append Add to existing storage (otherwise - clean first)
+ */
+async function applyStorageStateFor(key, context, append = false) {
+    const storageState = await (0, storageStates_1.getState)(key);
+    if (!storageState) {
+        throw new Error(`Can't find storageState for "${key}"`);
+    }
+    await (0, applyStorageState_1.applyStorageState)(context, storageState, append);
+}

package/auth/storage/deleteStorageStateFor.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Deletes a snapshot of the browser storage for the given key.
+ *
+ * @param key The key by which the snapshot of the browser storage is saved
+ */
+export declare function deleteStorageStateFor(key: string): void;

package/auth/storage/deleteStorageStateFor.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteStorageStateFor = deleteStorageStateFor;
+const storageStates_1 = require("../../data/storageStates");
+/**
+ * Deletes a snapshot of the browser storage for the given key.
+ *
+ * @param key The key by which the snapshot of the browser storage is saved
+ */
+function deleteStorageStateFor(key) {
+    return (0, storageStates_1.deleteState)(key);
+}

package/auth/storage/getStorageState.d.ts

@@ -0,0 +1,27 @@
+import type { Page } from '@playwright/test';
+export type AuthActions = (page: Page) => Promise<void>;
+/**
+ * Performs authentication in a separate browser context and returns
+ * a snapshot of the browser storage
+ *
+ * @param authActions Authentication actions
+ */
+export declare function getStorageState(authActions: AuthActions): Promise<{
+    cookies: Array<{
+        name: string;
+        value: string;
+        domain: string;
+        path: string;
+        expires: number;
+        httpOnly: boolean;
+        secure: boolean;
+        sameSite: "Strict" | "Lax" | "None";
+    }>;
+    origins: Array<{
+        origin: string;
+        localStorage: Array<{
+            name: string;
+            value: string;
+        }>;
+    }>;
+}>;

package/auth/storage/getStorageState.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStorageState = getStorageState;
+const test_1 = require("@playwright/test");
+/**
+ * Performs authentication in a separate browser context and returns
+ * a snapshot of the browser storage
+ *
+ * @param authActions Authentication actions
+ */
+async function getStorageState(authActions) {
+    const browser = await test_1.chromium.launch();
+    const page = await browser.newPage();
+    await authActions(page);
+    const storageState = await page.context().storageState();
+    await browser.close();
+    return storageState;
+}

package/auth/storage/getStorageStateFor.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Returns a snapshot of the browser storage for the given key.
+ *
+ * @param key The key by which the snapshot of the browser storage is saved
+ */
+export declare function getStorageStateFor(key: string): Promise<{
+    cookies: Array<{
+        name: string;
+        value: string;
+        domain: string;
+        path: string;
+        expires: number;
+        httpOnly: boolean;
+        secure: boolean;
+        sameSite: "Strict" | "Lax" | "None";
+    }>;
+    origins: Array<{
+        origin: string;
+        localStorage: Array<{
+            name: string;
+            value: string;
+        }>;
+    }>;
+} | undefined>;

package/auth/storage/getStorageStateFor.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStorageStateFor = getStorageStateFor;
+const storageStates_1 = require("../../data/storageStates");
+/**
+ * Returns a snapshot of the browser storage for the given key.
+ *
+ * @param key The key by which the snapshot of the browser storage is saved
+ */
+function getStorageStateFor(key) {
+    return (0, storageStates_1.getState)(key);
+}

package/auth/storage/hasStorageStateFor.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Checks if there is a snapshot of the browser storage for the given key
+ *
+ * @param key The key by which the snapshot of the browser storage is saved
+ */
+export declare function hasStorageStateFor(key: string): Promise<boolean>;

package/auth/storage/hasStorageStateFor.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasStorageStateFor = hasStorageStateFor;
+const storageStates_1 = require("../../data/storageStates");
+/**
+ * Checks if there is a snapshot of the browser storage for the given key
+ *
+ * @param key The key by which the snapshot of the browser storage is saved
+ */
+function hasStorageStateFor(key) {
+    return (0, storageStates_1.hasState)(key);
+}

package/auth/storage/index.d.ts

@@ -0,0 +1,9 @@
+export { applyStorageState } from './applyStorageState';
+export { applyStorageStateFor } from './applyStorageStateFor';
+export { deleteStorageStateFor } from './deleteStorageStateFor';
+export { getStorageState } from './getStorageState';
+export { getStorageStateFor } from './getStorageStateFor';
+export { hasStorageStateFor } from './hasStorageStateFor';
+export { restoreCookies } from './restoreCookies';
+export { restoreLocalStorage } from './restoreLocalStorage';
+export { saveStorageStateFor } from './saveStorageStateFor';

package/auth/storage/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveStorageStateFor = exports.restoreLocalStorage = exports.restoreCookies = exports.hasStorageStateFor = exports.getStorageStateFor = exports.getStorageState = exports.deleteStorageStateFor = exports.applyStorageStateFor = exports.applyStorageState = void 0;
+var applyStorageState_1 = require("./applyStorageState");
+Object.defineProperty(exports, "applyStorageState", { enumerable: true, get: function () { return applyStorageState_1.applyStorageState; } });
+var applyStorageStateFor_1 = require("./applyStorageStateFor");
+Object.defineProperty(exports, "applyStorageStateFor", { enumerable: true, get: function () { return applyStorageStateFor_1.applyStorageStateFor; } });
+var deleteStorageStateFor_1 = require("./deleteStorageStateFor");
+Object.defineProperty(exports, "deleteStorageStateFor", { enumerable: true, get: function () { return deleteStorageStateFor_1.deleteStorageStateFor; } });
+var getStorageState_1 = require("./getStorageState");
+Object.defineProperty(exports, "getStorageState", { enumerable: true, get: function () { return getStorageState_1.getStorageState; } });
+var getStorageStateFor_1 = require("./getStorageStateFor");
+Object.defineProperty(exports, "getStorageStateFor", { enumerable: true, get: function () { return getStorageStateFor_1.getStorageStateFor; } });
+var hasStorageStateFor_1 = require("./hasStorageStateFor");
+Object.defineProperty(exports, "hasStorageStateFor", { enumerable: true, get: function () { return hasStorageStateFor_1.hasStorageStateFor; } });
+var restoreCookies_1 = require("./restoreCookies");
+Object.defineProperty(exports, "restoreCookies", { enumerable: true, get: function () { return restoreCookies_1.restoreCookies; } });
+var restoreLocalStorage_1 = require("./restoreLocalStorage");
+Object.defineProperty(exports, "restoreLocalStorage", { enumerable: true, get: function () { return restoreLocalStorage_1.restoreLocalStorage; } });
+var saveStorageStateFor_1 = require("./saveStorageStateFor");
+Object.defineProperty(exports, "saveStorageStateFor", { enumerable: true, get: function () { return saveStorageStateFor_1.saveStorageStateFor; } });

package/auth/storage/restoreCookies.d.ts

@@ -0,0 +1,10 @@
+import type { BrowserContext } from '@playwright/test';
+import type { StorageState } from '../../data/storageStates';
+/**
+ * Restores saved cookies in the browser
+ *
+ * @param context Browser context
+ * @param cookies List of cookies to restore
+ * @param append Add to existing cookies (otherwise - clear first)
+ */
+export declare function restoreCookies(context: BrowserContext, cookies: StorageState['cookies'], append?: boolean): Promise<void>;

package/auth/storage/restoreCookies.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.restoreCookies = restoreCookies;
+/**
+ * Restores saved cookies in the browser
+ *
+ * @param context Browser context
+ * @param cookies List of cookies to restore
+ * @param append Add to existing cookies (otherwise - clear first)
+ */
+async function restoreCookies(context, cookies, append = false) {
+    if (!append) {
+        await context.clearCookies();
+    }
+    await context.addCookies(cookies);
+}

package/auth/storage/restoreLocalStorage.d.ts

@@ -0,0 +1,10 @@
+import type { BrowserContext } from '@playwright/test';
+import type { StorageState } from '../../data/storageStates';
+/**
+ * Restores saved localStorage records in the browser
+ *
+ * @param context Browser context
+ * @param origins List of localStorage entries to restore
+ * @param append Append to existing entries (otherwise - clear first)
+ */
+export declare function restoreLocalStorage(context: BrowserContext, origins: StorageState['origins'], append?: boolean): Promise<void>;

package/auth/storage/restoreLocalStorage.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.restoreLocalStorage = restoreLocalStorage;
+/**
+ * Restores saved localStorage records in the browser
+ *
+ * @param context Browser context
+ * @param origins List of localStorage entries to restore
+ * @param append Append to existing entries (otherwise - clear first)
+ */
+async function restoreLocalStorage(context, origins, append = false) {
+    await context.addInitScript(({ origins, append }) => {
+        const currentOrigin = `${location.protocol}://${location.hostname}`;
+        if (!append) {
+            window.localStorage.clear();
+        }
+        for (const { origin, localStorage } of origins) {
+            if (origin !== currentOrigin) {
+                continue;
+            }
+            for (const { name, value } of localStorage) {
+                window.localStorage.setItem(name, value);
+            }
+        }
+    }, { origins, append });
+}

package/auth/storage/saveStorageStateFor.d.ts

@@ -0,0 +1,8 @@
+import type { AuthActions } from './getStorageState';
+/**
+ * Performs authentication in a separate browser context and saves a snapshot of the browser storage by the given key
+ *
+ * @param key The key to save the browser storage state with
+ * @param authActions Authentication actions
+ */
+export declare function saveStorageStateFor(key: string, authActions: AuthActions): Promise<void>;

package/auth/storage/saveStorageStateFor.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveStorageStateFor = saveStorageStateFor;
+const storageStates_1 = require("../../data/storageStates");
+const getStorageState_1 = require("./getStorageState");
+/**
+ * Performs authentication in a separate browser context and saves a snapshot of the browser storage by the given key
+ *
+ * @param key The key to save the browser storage state with
+ * @param authActions Authentication actions
+ */
+async function saveStorageStateFor(key, authActions) {
+    const storageState = await (0, getStorageState_1.getStorageState)(authActions);
+    (0, storageStates_1.setState)(key, storageState);
+}

package/config/browsers.d.ts

@@ -0,0 +1,24 @@
+export declare const projects: ({
+    name: string;
+    use: {
+        projectName: "Chrome" | "Safari" | "Firefox";
+        viewport: import("playwright-core").ViewportSize;
+        userAgent: string;
+        deviceScaleFactor: number;
+        isMobile: boolean;
+        hasTouch: boolean;
+        defaultBrowserType: "chromium" | "firefox" | "webkit";
+    };
+} | {
+    name: string;
+    use: {
+        projectName: "Android" | "iPhone";
+        viewport: import("playwright-core").ViewportSize;
+        userAgent: string;
+        deviceScaleFactor: number;
+        isMobile: boolean;
+        hasTouch: boolean;
+        defaultBrowserType: "chromium" | "firefox" | "webkit";
+    };
+})[];
+export default projects;

package/config/browsers.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.projects = void 0;
+const browsersDesktop_1 = require("./browsersDesktop");
+const browsersMobile_1 = require("./browsersMobile");
+exports.projects = [...browsersDesktop_1.projects, ...browsersMobile_1.projects];
+exports.default = exports.projects;

package/config/browsersDesktop.d.ts

@@ -0,0 +1,14 @@
+type ProjectName = 'Chrome' | 'Safari' | 'Firefox';
+export declare const projects: {
+    name: string;
+    use: {
+        projectName: ProjectName;
+        viewport: import("@playwright/test").ViewportSize;
+        userAgent: string;
+        deviceScaleFactor: number;
+        isMobile: boolean;
+        hasTouch: boolean;
+        defaultBrowserType: "chromium" | "firefox" | "webkit";
+    };
+}[];
+export default projects;

package/config/browsersDesktop.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.projects = void 0;
+const test_1 = require("@playwright/test");
+exports.projects = [
+    {
+        name: 'Chrome',
+        use: {
+            ...test_1.devices['Desktop Chrome'],
+            projectName: 'Chrome',
+        },
+    },
+    {
+        name: 'Safari',
+        use: {
+            ...test_1.devices['Desktop Safari'],
+            projectName: 'Safari',
+        },
+    },
+    {
+        name: 'Firefox',
+        use: {
+            ...test_1.devices['Desktop Firefox'],
+            projectName: 'Firefox',
+        },
+    },
+];
+exports.default = exports.projects;

package/config/browsersMobile.d.ts

@@ -0,0 +1,14 @@
+type ProjectName = 'Android' | 'iPhone';
+export declare const projects: {
+    name: string;
+    use: {
+        projectName: ProjectName;
+        viewport: import("@playwright/test").ViewportSize;
+        userAgent: string;
+        deviceScaleFactor: number;
+        isMobile: boolean;
+        hasTouch: boolean;
+        defaultBrowserType: "chromium" | "firefox" | "webkit";
+    };
+}[];
+export default projects;

package/config/browsersMobile.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.projects = void 0;
+const test_1 = require("@playwright/test");
+exports.projects = [
+    {
+        name: 'Android',
+        use: {
+            ...test_1.devices['Pixel 5'],
+            projectName: 'Android',
+        },
+    },
+    {
+        name: 'iPhone',
+        use: {
+            ...test_1.devices['iPhone 12'],
+            projectName: 'iPhone',
+        },
+    },
+];
+exports.default = exports.projects;

package/data/cacheSettings.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Location of data cache on file system
+ */
+export declare const cacheSettings: {
+    /**
+     * Caching authentication data
+     */
+    auth: {
+        /**
+         * Path to the directory where the cache files should be stored
+         */
+        path: string | undefined;
+        /**
+         * Cache TTL
+         */
+        ttl: number;
+    };
+};
+export type CacheSettings = typeof cacheSettings;

package/data/cacheSettings.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cacheSettings = void 0;
+/**
+ * Location of data cache on file system
+ */
+exports.cacheSettings = {
+    /**
+     * Caching authentication data
+     */
+    auth: {
+        /**
+         * Path to the directory where the cache files should be stored
+         */
+        path: undefined,
+        /**
+         * Cache TTL
+         */
+        ttl: 30 * 60 * 1000,
+    },
+};

package/data/extraHttpHeaders.d.ts

@@ -0,0 +1,5 @@
+import type { BrowserContext } from '@playwright/test';
+/**
+ * Store for all current extra HTTP headers per browser context (= test)
+ */
+export declare const extraHttpHeaders: WeakMap<BrowserContext, Map<string, string>>;

package/data/extraHttpHeaders.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extraHttpHeaders = void 0;
+/**
+ * Store for all current extra HTTP headers per browser context (= test)
+ */
+exports.extraHttpHeaders = new WeakMap();