@bigbinary/neeto-playwright-commons 1.8.31 → 1.8.32

package/index.d.ts

@@ -1,8 +1,9 @@
 import * as _playwright_test from '@playwright/test';
-import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions, Browser, Locator, FrameLocator, BrowserContext } from '@playwright/test';
+import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions, Browser, Locator, FrameLocator, BrowserContext, CDPSession } from '@playwright/test';
 import MailosaurClient from 'mailosaur';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 import { TFunction } from 'i18next';
+import { Protocol } from 'playwright-core/types/protocol';
 import * as playwright_core from 'playwright-core';
 import { Secret, TOTP } from 'otpauth';
 
@@ -316,6 +317,8 @@ declare const THIRD_PARTY_ROUTES: {
     };
 };
 
+declare const networkConditions: Record<"Slow 3G" | "Fast 3G" | "No Throttling", Protocol.Network.emulateNetworkConditionsParameters>;
+
 declare const COMMON_SELECTORS: {
     spinner: string;
     subheaderText: string;
@@ -715,6 +718,26 @@ declare const initializeTotp: ({ issuer, secret, }: {
     secret: string | Secret;
 }) => TOTP;
 
+type EmulateNetworkConditionsParameters = Protocol.Network.emulateNetworkConditionsParameters;
+type NetworkThrottlingUsingCdpParams = {
+    cdpSession: CDPSession;
+    emulateNetworkConditionsParameters?: EmulateNetworkConditionsParameters;
+};
+declare const networkThrottlingUsingCDP: ({ cdpSession, emulateNetworkConditionsParameters, }: NetworkThrottlingUsingCdpParams) => Promise<Protocol.Network.emulateNetworkConditionsReturnValue>;
+type CpuThrottlingUsingCdpParams = {
+    cdpSession: CDPSession;
+    rate?: number;
+};
+declare const cpuThrottlingUsingCDP: ({ cdpSession, rate, }: CpuThrottlingUsingCdpParams) => Promise<Protocol.Emulation.setCPUThrottlingRateReturnValue>;
+interface ExecuteWithThrottledResourcesParams {
+    kind?: "both" | "network" | "cpu";
+    code: () => Promise<void>;
+    networkCondition?: EmulateNetworkConditionsParameters;
+    cpuThrottlingRate?: number;
+    cdpSession: CDPSession;
+}
+declare const executeWithThrottledResources: ({ code: emulatedCode, kind, networkCondition, cpuThrottlingRate, cdpSession, }: ExecuteWithThrottledResourcesParams) => Promise<void>;
+
 interface CurrentsOverrides {
     projectId: string;
 }
@@ -727,4 +750,4 @@ interface Overrides {
 }
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, decodeQRCodeFromFile, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, headerUtils, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, cpuThrottlingUsingCDP, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, generateStagingData, getGlobalUserState, headerUtils, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, updateCredentials, writeDataToFile };

package/index.js

@@ -12985,6 +12985,27 @@ const USER_AGENTS = {
     mac: "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
 };
 
+const networkConditions = {
+    "Slow 3G": {
+        downloadThroughput: ((500 * 1000) / 8) * 0.8,
+        uploadThroughput: ((500 * 1000) / 8) * 0.8,
+        latency: 400 * 5,
+        offline: false,
+    },
+    "Fast 3G": {
+        downloadThroughput: ((1.6 * 1000 * 1000) / 8) * 0.9,
+        uploadThroughput: ((750 * 1000) / 8) * 0.9,
+        latency: 150 * 3.75,
+        offline: false,
+    },
+    "No Throttling": {
+        downloadThroughput: -1,
+        uploadThroughput: -1,
+        latency: 0,
+        offline: false,
+    },
+};
+
 const NEETO_EDITOR_SELECTORS = {
     boldOption: "neeto-editor-fixed-menu-bold-option",
     italicOption: "neeto-editor-fixed-menu-italic-option",
@@ -146029,6 +146050,32 @@ const initializeTotp = ({ issuer, secret, }) => {
     });
 };
 
+// Util to throttle network via CDP (only available for chrome)
+// Based on https://github.com/microsoft/playwright/issues/6038#issuecomment-812521882
+// Feature request issue: https://github.com/microsoft/playwright/issues/8622
+const networkThrottlingUsingCDP = ({ cdpSession, emulateNetworkConditionsParameters = networkConditions["Fast 3G"], }) => cdpSession.send("Network.emulateNetworkConditions", emulateNetworkConditionsParameters);
+// Util to throttle CPU via CDP (only available for chrome)
+// Throttling rate as a slowdown factor
+// Default value is 1.25; means it will slow down CPU by 1.25 times
+const cpuThrottlingUsingCDP = ({ cdpSession, rate = 1.25, }) => cdpSession.send("Emulation.setCPUThrottlingRate", { rate });
+const executeWithThrottledResources = async ({ code: emulatedCode, kind = "both", networkCondition, cpuThrottlingRate, cdpSession, }) => {
+    if (kind === "network" || kind === "both") {
+        await networkThrottlingUsingCDP({
+            cdpSession,
+            emulateNetworkConditionsParameters: networkCondition,
+        });
+    }
+    else if (kind === "cpu" || kind === "both") {
+        await cpuThrottlingUsingCDP({ cdpSession, rate: cpuThrottlingRate });
+    }
+    await emulatedCode();
+    await networkThrottlingUsingCDP({
+        cdpSession,
+        emulateNetworkConditionsParameters: networkConditions["No Throttling"],
+    });
+    await cpuThrottlingUsingCDP({ cdpSession, rate: 1 });
+};
+
 var main$2 = {exports: {}};
 
 var name = "dotenv";
@@ -146568,5 +146615,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, decodeQRCodeFromFile, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, headerUtils, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, stealth as stealthTest, tableUtils, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, cpuThrottlingUsingCDP, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, generateStagingData, getGlobalUserState, headerUtils, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, stealth as stealthTest, tableUtils, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map