@bigbinary/neeto-playwright-commons 1.8.42 → 1.8.44

package/index.cjs.js

@@ -88,6 +88,7 @@ const CREDENTIALS = {
 };
 const OTP_EMAIL_PATTERN = "is your login code";
 const SLACK_DEFAULT_CHANNEL = "general";
+const ZAPIER_TEST_EMAIL = (product) => `neeto-${product}-zapier-test@${process.env.INTEGRATION_MAILOSAUR_SERVER_ID}.mailosaur.net`;
 
 /* eslint-disable playwright/no-skipped-test */
 const execCommand = (command) => child_process.execSync(command)
@@ -12589,12 +12590,22 @@ const API_ROUTES = {
         index: "/team_members/teams",
         show: (id) => `/team_members/teams/${id}`,
     },
+    integrations: {
+        zapier: {
+            api_keys: "/neeto_integrations/zapier/api_keys",
+        },
+    },
 };
 const THIRD_PARTY_ROUTES = {
     webhooks: { site: "https://webhook.site/" },
     slack: {
         loginWithPassword: (workspace) => `https://${workspace}.slack.com/sign_in_with_password`,
     },
+    zapier: {
+        login: "https://zapier.com/app/login",
+        logOut: "https://zapier.com/logout",
+        zapEditor: (zapId) => `https://zapier.com/editor/${zapId}`,
+    },
 };
 
 const CHAT_WIDGET_TEXTS = {
@@ -12617,6 +12628,34 @@ const SLACK_WEB_TEXTS = {
     permanentlyDeleteTheChannel: "Yes, permanently delete the channel",
     deleteChannel: "Delete channel",
 };
+const ZAPIER_WEB_TEXTS = {
+    account: "Account",
+    email: "Email",
+    continue: "Continue",
+    statusLabel: "Status",
+    password: "Password",
+    editExistingDraft: "Edit existing draft",
+    signInTo: "Sign in to *",
+    yesContinueTo: "Yes, Continue to *",
+    testTrigger: "Test trigger",
+    editStep: "Edit step",
+    continueWithSelectedRecord: "Continue with selected record",
+    publish: "Publish",
+    delete: "Delete",
+    loading: "Loading",
+    subdomain: "Subdomain",
+    apiKey: "API key",
+    publishingZapHeading: "Preparing Zap to go live",
+    connectionListMenu: "Connection List Item Menu",
+    usageRegExp: "Usage resets in *",
+    trialEndsRegExp: "Trial ends on",
+    testCurrentlyInQueue: "Test currently in queue",
+    welcomeText: (zapierLoginEmail) => `Welcome back ${zapierLoginEmail}`,
+};
+const TOASTR_MESSAGES = {
+    zapierApiKeyGenerated: "Zapier API key is generated successfully!",
+};
+const ZAPIER_LIMIT_EXHAUSTED_MESSAGE = "Zapier free task limit is exhausted. Test will be aborted";
 
 const HELP_CENTER_SELECTORS = {
     helpButton: "help-button",
@@ -13229,6 +13268,228 @@ class WebhooksPage {
     }
 }
 
+const ZAPIER_SELECTORS = {
+    zapTriggerStep: (zapId) => `[data-testid='step-node-${zapId}']`,
+    zapAccountSubstep: "[data-testid='substep-Account']",
+    zapOpenSubstepContainer: "[data-testid='open-sub-step-container']",
+    modal: "[data-testid='Modal']",
+    fmPrettytext: ".fm-prettytext",
+    spinner: "[data-testid='spinner']",
+    skeletonBlock: "[data-testid='SkeletonBlock']",
+    accountsLoader: "[data-testid='accounts-loader']",
+    floatingBox: "[data-testid='floating-box']",
+    connection: "[data-testid='Connection']",
+    deleteConnectionModal: "[data-testid='DeleteAuthModal-root']",
+    deleteConnectionDropdownButton: "[data-testid='connection-list-item-dropdown-item-Delete']",
+    usageAmounts: "css=[class$=UsageBar__amounts]",
+    universalSidebar: "[data-testid='universalSidebar']",
+    sidebarFooter: "css=[class$=InAppSidebarFooter__footerWrapper]",
+    contextualSideBar: "[data-testid='contextual-sidebar']",
+};
+
+class ZapierPage extends IntegrationBase {
+    constructor({ page, neetoPlaywrightUtilities, integrationRouteIndex, }) {
+        super({
+            page,
+            integration: "zapier",
+            neetoPlaywrightUtilities,
+            integrationRouteIndex,
+        });
+        this.loginToZapier = async (zapierWebPage) => {
+            this.zapierWebPage = zapierWebPage;
+            this.continueButton = this.zapierWebPage.getByRole("button", {
+                name: ZAPIER_WEB_TEXTS.continue,
+                exact: true,
+            });
+            await this.zapierWebPage.goto(THIRD_PARTY_ROUTES.zapier.login);
+            await this.zapierWebPage
+                .getByLabel(ZAPIER_WEB_TEXTS.email)
+                .pressSequentially(process.env.ZAPIER_LOGIN_EMAIL, { delay: 100 });
+            await this.continueButton.click();
+            await test$1.expect(this.zapierWebPage.getByText(ZAPIER_WEB_TEXTS.welcomeText(process.env.ZAPIER_LOGIN_EMAIL))).toBeVisible();
+            await this.zapierWebPage
+                .getByLabel(ZAPIER_WEB_TEXTS.password)
+                .pressSequentially(process.env.ZAPIER_LOGIN_PASSWORD, { delay: 100 });
+            await this.continueButton.click();
+        };
+        this.logoutFromZapier = async () => {
+            await this.zapierWebPage.goto(THIRD_PARTY_ROUTES.zapier.logOut, {
+                waitUntil: "commit",
+            });
+            await this.zapierWebPage.close();
+        };
+        this.reconnectAccountAndPublish = async (zapierApiKey) => {
+            var _a;
+            await this.zapierWebPage.goto(THIRD_PARTY_ROUTES.zapier.zapEditor(process.env.ZAP_ID));
+            await this.zapierWebPage
+                .locator(ZAPIER_SELECTORS.zapTriggerStep(process.env.ZAP_ID))
+                .getByLabel(ZAPIER_WEB_TEXTS.editStep)
+                .click();
+            if (await this.zapierWebPage.locator(ZAPIER_SELECTORS.modal).isVisible()) {
+                await this.zapierWebPage
+                    .getByRole("button", { name: ZAPIER_WEB_TEXTS.editExistingDraft })
+                    .click();
+            }
+            await this.zapierWebPage
+                .getByRole("link", { name: ZAPIER_WEB_TEXTS.account })
+                .or(this.zapierWebPage.locator(ZAPIER_SELECTORS.zapAccountSubstep))
+                .click();
+            const signInPagePromise = this.zapierWebPage.waitForEvent("popup");
+            await this.zapierWebPage
+                .getByLabel(RegExp(ZAPIER_WEB_TEXTS.signInTo))
+                .click();
+            const signInPage = await signInPagePromise;
+            await signInPage.waitForLoadState();
+            await test$1.expect(signInPage.getByRole("heading", { name: ZAPIER_WEB_TEXTS.loading })).toBeHidden({ timeout: 10000 });
+            // The zapier connect page have two custom fm-prettytext boxes
+            // (not an input/textarea) without aria-label or data-cy
+            const subdomainBox = signInPage
+                .locator(ZAPIER_SELECTORS.fmPrettytext)
+                // eslint-disable-next-line playwright/no-nth-methods
+                .nth(0);
+            // eslint-disable-next-line playwright/no-nth-methods
+            const apiKeyBox = signInPage.locator(ZAPIER_SELECTORS.fmPrettytext).nth(1);
+            await subdomainBox.click();
+            await subdomainBox.pressSequentially((_a = getGlobalUserState()) === null || _a === void 0 ? void 0 : _a.subdomainName, {
+                delay: 100,
+            });
+            await apiKeyBox.click();
+            await apiKeyBox.pressSequentially(zapierApiKey, { delay: 100 });
+            await signInPage
+                .getByRole("button", {
+                name: RegExp(ZAPIER_WEB_TEXTS.yesContinueTo),
+            })
+                .click();
+            await this.continueButton.click({ timeout: 30000 });
+            await test$1.expect(this.zapierWebPage.locator(ZAPIER_SELECTORS.spinner)).toBeHidden({ timeout: 10000 });
+            await test$1.expect(this.zapierWebPage.locator(ZAPIER_SELECTORS.skeletonBlock)).toHaveCount(0, { timeout: 10000 });
+            const testTriggerButton = this.zapierWebPage.getByRole("button", {
+                name: ZAPIER_WEB_TEXTS.testTrigger,
+            });
+            await test$1.expect(testTriggerButton).toBeVisible();
+            await testTriggerButton.click();
+            await test$1.expect(this.zapierWebPage.getByText(ZAPIER_WEB_TEXTS.testCurrentlyInQueue)).toBeHidden({ timeout: 20000 });
+            await test$1.expect(this.zapierWebPage.getByLabel(ZAPIER_WEB_TEXTS.statusLabel, {
+                exact: true,
+            })).toBeVisible({ timeout: 10000 });
+            await this.zapierWebPage
+                .getByRole("button", {
+                name: ZAPIER_WEB_TEXTS.continueWithSelectedRecord,
+            })
+                .click({ timeout: 20000 });
+            await this.continueButton.click();
+            await this.continueButton.click();
+            await this.zapierWebPage
+                .locator(ZAPIER_SELECTORS.contextualSideBar)
+                .getByLabel(ZAPIER_WEB_TEXTS.publish)
+                .or(this.zapierWebPage
+                .locator(ZAPIER_SELECTORS.zapOpenSubstepContainer)
+                .getByRole("button", { name: ZAPIER_WEB_TEXTS.publish }))
+                .click();
+            await this.zapierWebPage
+                .locator(ZAPIER_SELECTORS.modal)
+                .getByLabel(ZAPIER_WEB_TEXTS.publish)
+                .or(this.zapierWebPage
+                .locator(ZAPIER_SELECTORS.modal)
+                .getByRole("button", { name: ZAPIER_WEB_TEXTS.publish, exact: true }))
+                .click();
+            await this.zapierWebPage
+                .getByLabel(ZAPIER_WEB_TEXTS.publishingZapHeading)
+                .waitFor();
+            await test$1.expect(this.zapierWebPage.getByLabel(ZAPIER_WEB_TEXTS.publishingZapHeading)).toBeHidden({ timeout: 15000 });
+        };
+        this.deleteAllConnections = async (zapierAppLink) => {
+            await this.zapierWebPage.goto(zapierAppLink);
+            await this.zapierWebPage.waitForLoadState();
+            await test$1.expect(this.zapierWebPage.locator(ZAPIER_SELECTORS.accountsLoader)).toBeHidden();
+            await test$1.expect(this.zapierWebPage.locator(ZAPIER_SELECTORS.skeletonBlock)).toHaveCount(0);
+            const connectionLocator = this.zapierWebPage.locator(ZAPIER_SELECTORS.connection);
+            const connections = await connectionLocator.all();
+            const deleteButton = this.zapierWebPage
+                .locator(ZAPIER_SELECTORS.floatingBox)
+                .locator(ZAPIER_SELECTORS.deleteConnectionDropdownButton);
+            for (const connection of connections) {
+                await test$1.expect(async () => {
+                    await connection
+                        .getByLabel(ZAPIER_WEB_TEXTS.connectionListMenu)
+                        .click();
+                    await deleteButton.click();
+                    await this.zapierWebPage
+                        .locator(ZAPIER_SELECTORS.deleteConnectionModal)
+                        .getByRole("button", { name: ZAPIER_WEB_TEXTS.delete })
+                        .click();
+                }).toPass({ timeout: 20000 });
+            }
+            // eslint-disable-next-line playwright/no-standalone-expect
+            await test$1.expect(connectionLocator).toHaveCount(0, {
+                timeout: 10000,
+            });
+        };
+        this.verifyZapIsTriggered = ({ productName, submittedEmail, zapTriggeredAfter, }) => this.mailosaur.messages.get(process.env.INTEGRATION_MAILOSAUR_SERVER_ID, { sentTo: ZAPIER_TEST_EMAIL(productName), body: submittedEmail }, { timeout: 2 * 60000, receivedAfter: zapTriggeredAfter });
+        this.skipIfTaskLimitIsExhausted = async () => {
+            var _a;
+            // Zapier provides 100 free task limit for free account; skip test if it's exhausted
+            await test$1.expect(this.zapierWebPage.locator(ZAPIER_SELECTORS.universalSidebar)).toBeVisible({ timeout: 15000 });
+            await test$1.expect(this.zapierWebPage.locator(ZAPIER_SELECTORS.sidebarFooter)).toBeVisible({ timeout: 10000 });
+            if (await this.zapierWebPage
+                .getByText(RegExp(ZAPIER_WEB_TEXTS.trialEndsRegExp))
+                .isVisible()) {
+                return;
+            }
+            await test$1.expect(this.zapierWebPage.getByText(RegExp(ZAPIER_WEB_TEXTS.usageRegExp))).toBeVisible({ timeout: 30000 });
+            const freeTaskLimit = (_a = (await this.zapierWebPage
+                .locator(ZAPIER_SELECTORS.usageAmounts)
+                // There are two usageAmount span elements
+                // and there is no better approach than to use first()
+                // eslint-disable-next-line playwright/no-nth-methods
+                .first()
+                .textContent())) !== null && _a !== void 0 ? _a : "";
+            const [taskRunCount, taskLimitForMonth] = freeTaskLimit
+                .split("/")
+                .map(str => parseInt(str));
+            // eslint-disable-next-line playwright/no-skipped-test
+            test__default["default"].skip(taskRunCount >= taskLimitForMonth, ZAPIER_LIMIT_EXHAUSTED_MESSAGE);
+        };
+        this.connectAndVerify = async ({ apiKeyLabel }) => {
+            await this.connect();
+            await this.page.getByTestId(COMMON_SELECTORS.inputField).fill(apiKeyLabel);
+            await this.page
+                .getByRole("button", {
+                name: this.t("neetoIntegrations.zapier.generateApiKey"),
+            })
+                .click();
+            await this.neetoPlaywrightUtilities.verifySuccessToast({
+                message: TOASTR_MESSAGES.zapierApiKeyGenerated,
+            });
+            await this.page
+                .getByRole("button", {
+                name: this.t("neetoIntegrations.zapier.copyApiKey"),
+            })
+                .click();
+            const apiKey = await this.page.evaluate(() => navigator.clipboard.readText());
+            await this.verifyIntegrationStatus();
+            return apiKey;
+        };
+        this.disconnectAndVerify = async () => {
+            await this.disconnect({
+                times: 1,
+                responseUrl: API_ROUTES.integrations.zapier.api_keys,
+            });
+            await this.verifyIntegrationStatus("disconnected");
+        };
+        if (ramda.isNil(process.env.INTEGRATION_MAILOSAUR_API_KEY) ||
+            ramda.isNil(process.env.INTEGRATION_MAILOSAUR_SERVER_ID)) {
+            throw new Error("ENV variable INTEGRATION_MAILOSAUR_API_KEY or INTEGRATION_MAILOSAUR_SERVER_ID is not properly configured");
+        }
+        if (ramda.isNil(process.env.ZAPIER_LOGIN_PASSWORD) ||
+            ramda.isNil(process.env.ZAPIER_LOGIN_EMAIL) ||
+            ramda.isNil(process.env.ZAP_ID)) {
+            throw new Error("ENV variable ZAPIER_LOGIN_PASSWORD or ZAPIER_LOGIN_EMAIL or ZAP_ID is not properly configured");
+        }
+        this.mailosaur = new MailosaurClient__default["default"](process.env.INTEGRATION_MAILOSAUR_API_KEY);
+    }
+}
+
 const SIGNUP_SELECTORS = {
     emailTextField: "signup-email-text-field",
     firstNameTextField: "signup-profile-first-name-text-field",
@@ -13605,6 +13866,7 @@ const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, loginPath = "/"
 };
 const login = async ({ page, neetoPlaywrightUtilities, loginPath, }) => !IS_STAGING_ENV &&
     (await loginWithoutSSO({ page, neetoPlaywrightUtilities, loginPath }));
+const generateRandomBypassEmail = () => `cpt${process.env.OTP_BYPASS_KEY}+${faker.faker.number.int()}@bigbinary.com`;
 
 const addMemberViaRequest = ({ email, role = MEMBER_TEXTS.agent, appName, neetoPlaywrightUtilities, }) => neetoPlaywrightUtilities.apiRequest({
     method: "post",
@@ -147217,8 +147479,14 @@ exports.SidebarSection = SidebarSection;
 exports.SlackPage = SlackPage;
 exports.TAGS_SELECTORS = TAGS_SELECTORS;
 exports.THIRD_PARTY_ROUTES = THIRD_PARTY_ROUTES;
+exports.TOASTR_MESSAGES = TOASTR_MESSAGES;
 exports.USER_AGENTS = USER_AGENTS;
 exports.WebhooksPage = WebhooksPage;
+exports.ZAPIER_LIMIT_EXHAUSTED_MESSAGE = ZAPIER_LIMIT_EXHAUSTED_MESSAGE;
+exports.ZAPIER_SELECTORS = ZAPIER_SELECTORS;
+exports.ZAPIER_TEST_EMAIL = ZAPIER_TEST_EMAIL;
+exports.ZAPIER_WEB_TEXTS = ZAPIER_WEB_TEXTS;
+exports.ZapierPage = ZapierPage;
 exports.basicHTMLContent = basicHTMLContent;
 exports.clearCredentials = clearCredentials;
 exports.commands = commands;
@@ -147227,6 +147495,7 @@ exports.decodeQRCodeFromFile = decodeQRCodeFromFile;
 exports.definePlaywrightConfig = definePlaywrightConfig;
 exports.executeWithThrottledResources = executeWithThrottledResources;
 exports.extractSubdomainFromError = extractSubdomainFromError;
+exports.generateRandomBypassEmail = generateRandomBypassEmail;
 exports.generateStagingData = generateStagingData;
 exports.getByDataQA = getByDataQA;
 exports.getGlobalUserState = getGlobalUserState;