@bigbinary/neeto-playwright-commons 1.8.10 → 1.8.12

package/index.cjs.js

@@ -14,6 +14,7 @@ var require$$0$2 = require('util');
 var require$$0$3 = require('stream');
 var require$$0$4 = require('events');
 var playwrightI18nextFixture = require('playwright-i18next-fixture');
+var neetoCist = require('@bigbinary/neeto-cist');
 var require$$3 = require('crypto');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
@@ -63,6 +64,7 @@ const CREDENTIALS = {
     password: "welcome",
 };
 const OTP_EMAIL_PATTERN = "is your login code";
+const SLACK_DEFAULT_CHANNEL = "general";
 
 /* eslint-disable playwright/no-skipped-test */
 const joinString = (string1, string2, string3 = "", separator = " ") => {
@@ -172,6 +174,7 @@ const COMMON_SELECTORS = {
     modalHeader: "modal-header",
     nameInputError: "name-input-error",
     selectContainer: "nui-select-container",
+    selectValueContainer: "nui-select-value-container",
     dropdownMenu: "nui-select-menu",
     sidebarToggle: "neeto-molecules-sidebar-toggler",
     subheader: "subheader",
@@ -184,6 +187,8 @@ const COMMON_SELECTORS = {
     homeButton: "home-button",
     neetoUiSwitch: "nui-switch",
     floatingActionMenuButton: "floating-action-menu-container",
+    columnsDropdownContainer: "columns-dropdown-container",
+    columnsDropdownButton: "columns-dropdown-button",
 };
 
 class CustomCommands {
@@ -7213,6 +7218,9 @@ const API_ROUTES = {
 };
 const THIRD_PARTY_ROUTES = {
     webhooks: { site: "https://webhook.site/" },
+    slack: {
+        loginWithPassword: (workspace) => `https://${workspace}.slack.com/sign_in_with_password`,
+    },
 };
 
 const CHAT_WIDGET_TEXTS = {
@@ -7222,6 +7230,14 @@ const CHAT_WIDGET_TEXTS = {
 const MEMBER_TEXTS = {
     agent: "Agent",
 };
+const INTEGRATIONS_TEXTS = {
+    connectHeader: (integration) => `Connect your ${neetoCist.humanize(integration)} account`,
+    connectedHeader: (integration) => `You are connected to ${neetoCist.humanize(integration)}`,
+};
+const SLACK_WEB_TEXTS = {
+    signOut: "Sign out",
+    allow: "Allow",
+};
 
 const HELP_CENTER_SELECTORS = {
     helpButton: "help-button",
@@ -7658,6 +7674,199 @@ class HelpAndProfilePage {
     }
 }
 
+const INTEGRATION_SELECTORS = {
+    integrationCard: (integration) => `${integration}-integration-card`,
+    connectButton: "connect-button",
+    integrationStatusTag: "integration-status-tag",
+    disconnectButton: "disconnect-button",
+    manageButton: "manage-button",
+};
+
+class IntegrationBase {
+    constructor({ page, neetoPlaywrightUtilities, integration, integrationRouteIndex, connectHeader, connectedHeader, }) {
+        this.disconnect = async (interceptMultipleResponsesParams = {}) => {
+            await this.gotoIntegrationIndex();
+            await this.clickOnIntegrationCard();
+            await this.page.getByTestId(INTEGRATION_SELECTORS.disconnectButton).click();
+            const disconnectPromise = this.neetoPlaywrightUtilities.interceptMultipleResponses({
+                times: 0,
+                ...interceptMultipleResponsesParams,
+            });
+            await this.page
+                .getByTestId(COMMON_SELECTORS.alertModalSubmitButton)
+                .click();
+            await disconnectPromise;
+        };
+        this.connect = async (skipGoTo) => {
+            !skipGoTo && (await this.gotoIntegrationIndex());
+            await this.clickOnIntegrationCard();
+            await test.expect(this.page.getByRole("heading", {
+                name: this.connectHeader,
+            })).toBeVisible();
+            await this.page.getByTestId(INTEGRATION_SELECTORS.connectButton).click();
+        };
+        this.verifyIntegrationStatus = async (status = "connected") => {
+            await this.gotoIntegrationIndex();
+            if (status === "connected") {
+                await test.expect(this.integrationCard.getByTestId(INTEGRATION_SELECTORS.integrationStatusTag)).toBeVisible({ timeout: 10000 });
+            }
+            await this.clickOnIntegrationCard();
+            const header = status === "connected" ? this.connectedHeader : this.connectHeader;
+            await test.expect(this.page.getByRole("heading", { name: header })).toBeVisible();
+        };
+        this.clickOnIntegrationCard = async () => {
+            await test.expect(this.page.getByTestId(COMMON_SELECTORS.spinner)).toHaveCount(0);
+            await this.integrationCard.scrollIntoViewIfNeeded();
+            await this.integrationCard.click();
+            await test.expect(this.page.getByTestId(COMMON_SELECTORS.pageLoader)).toBeHidden();
+        };
+        this.gotoIntegrationIndex = async () => {
+            neetoCist.isNotEmpty(this.integrationRouteIndex) &&
+                (await this.page.goto(this.integrationRouteIndex));
+        };
+        this.page = page;
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.t = playwrightI18nextFixture.getI18nInstance().t;
+        this.integration = integration;
+        this.integrationCard = this.page.getByTestId(INTEGRATION_SELECTORS.integrationCard(integration));
+        this.integrationRouteIndex = integrationRouteIndex || "";
+        this.connectHeader =
+            connectHeader || INTEGRATIONS_TEXTS.connectHeader(this.integration);
+        this.connectedHeader =
+            connectedHeader || INTEGRATIONS_TEXTS.connectedHeader(this.integration);
+    }
+}
+
+const SLACK_SELECTORS = {
+    messageContainer: "[data-qa='message_container']",
+    loginEmail: "[data-qa='login_email']",
+    loginPassword: "[data-qa='login_password']",
+    signInButton: "[data-qa='signin_button']",
+    teamPicketButtonContent: "[data-qa='team-picker-button-content']",
+    redirectOpenInBrowser: "[data-qa='ssb_redirect_open_in_browser']",
+    workspaceActionsButton: "[data-qa='workspace_actions_button']",
+    teamMenuTrigger: "[data-qa='team-menu-trigger']",
+    menuItemButton: "[data-qa='menu_item_button']",
+    threadsFlexpane: "[data-qa='threads_flexpane']",
+    replyBar: "[data-qa='reply_bar']",
+    markdownElement: "[data-qa='bk_markdown_element']",
+    virtualListItem: "[data-qa='virtual-list-item']",
+};
+
+/* eslint-disable playwright/no-raw-locators */
+class SlackPage extends IntegrationBase {
+    constructor({ page, neetoPlaywrightUtilities, integrationRouteIndex, }) {
+        super({
+            page,
+            neetoPlaywrightUtilities,
+            integration: "slack",
+            integrationRouteIndex,
+        });
+        this.connectAndVerifyIntegration = async (redirectUrl, customSteps) => {
+            await this.connect();
+            await this.page
+                .getByRole("button", {
+                name: this.t("neetoSlack.slack.connect.loginButton"),
+            })
+                .click({ delay: 5000 });
+            await this.page.waitForURL(RegExp("(.*)slack.com/.*"));
+            const allowButton = this.page.getByRole("button", {
+                name: SLACK_WEB_TEXTS.allow,
+            });
+            await test.expect(allowButton).toBeEnabled({ timeout: 20000 });
+            const currentWorkspace = (await this.page
+                .locator(SLACK_SELECTORS.teamPicketButtonContent)
+                .textContent()) || "";
+            await allowButton.click();
+            await this.page.waitForURL(redirectUrl);
+            await test.expect(this.page.getByTestId(COMMON_SELECTORS.pageLoader)).toBeHidden({ timeout: 10000 });
+            await test.expect(this.page.getByRole("heading", {
+                name: this.t("neetoSlack.slack.configure.title", {
+                    teamName: currentWorkspace,
+                }),
+            })).toBeVisible();
+            await test.expect(this.page.getByTestId(COMMON_SELECTORS.selectValueContainer)).toContainText(SLACK_DEFAULT_CHANNEL);
+            await this.page
+                .getByRole("button", { name: this.t("neetoSlack.common.continue") })
+                .click();
+            if (customSteps) {
+                await customSteps();
+            }
+            else {
+                await test.expect(this.page.getByRole("heading", {
+                    name: this.t("neetoSlack.slack.finish.title", {
+                        teamName: currentWorkspace,
+                    }),
+                })).toBeVisible();
+                await this.page
+                    .getByRole("button", { name: this.t("neetoSlack.common.done") })
+                    .click();
+            }
+            await this.verifyIntegrationStatus();
+        };
+        this.disconnectAndVerifyIntegration = async () => {
+            await this.disconnect();
+            await this.verifyIntegrationStatus("disconnected");
+        };
+        this.updateConfigureSlackChannel = async ({ newSlackChannel = "random", interceptMultipleResponsesParams = {}, }) => {
+            await this.page.getByTestId(INTEGRATION_SELECTORS.manageButton).click();
+            await this.page
+                .getByRole("button", { name: this.t("neetoSlack.common.edit") })
+                .click();
+            await this.page.getByTestId(COMMON_SELECTORS.selectContainer).click();
+            await this.page
+                .getByTestId(COMMON_SELECTORS.dropdownMenu)
+                .getByText(newSlackChannel)
+                .click();
+            const savePromise = this.neetoPlaywrightUtilities.interceptMultipleResponses({
+                times: 0,
+                ...interceptMultipleResponsesParams,
+            });
+            await this.page
+                .getByRole("button", { name: this.t("neetoSlack.common.save") })
+                .click();
+            await savePromise;
+        };
+        this.loginToSlackWebapp = async (slackWebappPage) => {
+            this.slackWebappPage = slackWebappPage;
+            if (ramda.isNotNil(process.env.SLACK_WORKSPACE) &&
+                ramda.isNotNil(process.env.SLACK_LOGIN_PASSWORD) &&
+                ramda.isNotNil(process.env.SLACK_LOGIN_EMAIL)) {
+                await slackWebappPage.goto(THIRD_PARTY_ROUTES.slack.loginWithPassword(process.env.SLACK_WORKSPACE));
+                await slackWebappPage
+                    .locator(SLACK_SELECTORS.loginEmail)
+                    .pressSequentially(process.env.SLACK_LOGIN_EMAIL, { delay: 10 });
+                await slackWebappPage
+                    .locator(SLACK_SELECTORS.loginPassword)
+                    .pressSequentially(process.env.SLACK_LOGIN_PASSWORD, { delay: 10 });
+                await slackWebappPage.locator(SLACK_SELECTORS.signInButton).click();
+                await slackWebappPage
+                    .locator(SLACK_SELECTORS.redirectOpenInBrowser)
+                    .click();
+            }
+            else {
+                throw new Error("ENV variable SLACK_LOGIN_EMAIL or SLACK_LOGIN_PASSWORD or SLACK_WORKSPACE is not defined. Please add the API key to use this fixture.");
+            }
+        };
+        this.logoutFromSlackWebApp = async () => {
+            await this.slackWebappPage
+                .locator(SLACK_SELECTORS.workspaceActionsButton)
+                .or(this.slackWebappPage.locator(SLACK_SELECTORS.teamMenuTrigger))
+                .click();
+            await this.slackWebappPage
+                .locator(SLACK_SELECTORS.menuItemButton, {
+                hasText: SLACK_WEB_TEXTS.signOut,
+            })
+                .click();
+        };
+        this.goToSlackChannel = async (slackChannel) => {
+            await this.slackWebappPage
+                .locator(SLACK_SELECTORS.virtualListItem, { hasText: slackChannel })
+                .click();
+        };
+    }
+}
+
 const WEBHOOK_SELECTORS = {
     addNewWebhook: "add-new-webhook-button",
     endpointInputField: "endpoint-input-field",
@@ -8107,6 +8316,40 @@ const memberUtils = {
     deactivateMemberViaRequest,
 };
 
+const assertColumnHeaderVisibility = async ({ page, columnName, shouldBeVisible, }) => {
+    const visibilityAssertion = shouldBeVisible ? "toBeVisible" : "toBeHidden";
+    await test.expect(page.getByRole("columnheader", { name: columnName }))[visibilityAssertion]();
+};
+const toggleColumnCheckboxAndVerifyVisibility = async ({ page, tableColumns, shouldBeChecked, }) => {
+    await page.getByTestId(COMMON_SELECTORS.columnsDropdownButton).click();
+    for (const columnName of tableColumns) {
+        const checkbox = page
+            .getByTestId(COMMON_SELECTORS.columnsDropdownContainer)
+            .getByRole("listitem")
+            .filter({ hasText: columnName })
+            .getByRole("checkbox");
+        const isCheckBoxChecked = await checkbox.isChecked();
+        if (isCheckBoxChecked !== shouldBeChecked) {
+            await checkbox.click();
+        }
+        shouldBeChecked
+            ? await test.expect(checkbox).toBeChecked()
+            : await test.expect(checkbox).not.toBeChecked();
+    }
+    await page.getByTestId(COMMON_SELECTORS.columnsDropdownButton).click();
+    for (const columnName of tableColumns) {
+        await assertColumnHeaderVisibility({
+            page,
+            columnName,
+            shouldBeVisible: shouldBeChecked,
+        });
+    }
+};
+const tableUtils = {
+    assertColumnHeaderVisibility,
+    toggleColumnCheckboxAndVerifyVisibility,
+};
+
 var main$2 = {exports: {}};
 
 var name = "dotenv";
@@ -8655,6 +8898,7 @@ exports.GLOBAL_TRANSLATIONS_PATTERN = GLOBAL_TRANSLATIONS_PATTERN;
 exports.HELP_CENTER_SELECTORS = HELP_CENTER_SELECTORS;
 exports.HelpAndProfilePage = HelpAndProfilePage;
 exports.IS_STAGING_ENV = IS_STAGING_ENV;
+exports.IntegrationBase = IntegrationBase;
 exports.KEYBOARD_SHORTCUTS_SELECTORS = KEYBOARD_SHORTCUTS_SELECTORS;
 exports.LOGIN_SELECTORS = LOGIN_SELECTORS;
 exports.MEMBER_FORM_SELECTORS = MEMBER_FORM_SELECTORS;
@@ -8671,7 +8915,9 @@ exports.PROJECT_TRANSLATIONS_PATH = PROJECT_TRANSLATIONS_PATH;
 exports.ROLES_SELECTORS = ROLES_SELECTORS;
 exports.ROUTES = ROUTES;
 exports.SIGNUP_SELECTORS = SIGNUP_SELECTORS;
+exports.SLACK_DEFAULT_CHANNEL = SLACK_DEFAULT_CHANNEL;
 exports.STORAGE_STATE = STORAGE_STATE;
+exports.SlackPage = SlackPage;
 exports.TAGS_SELECTORS = TAGS_SELECTORS;
 exports.THIRD_PARTY_ROUTES = THIRD_PARTY_ROUTES;
 exports.USER_AGENTS = USER_AGENTS;
@@ -8694,6 +8940,7 @@ exports.readFileSyncIfExists = readFileSyncIfExists;
 exports.removeCredentialFile = removeCredentialFile;
 exports.shouldSkipSetupAndTeardown = shouldSkipSetupAndTeardown;
 exports.skipTest = skipTest;
+exports.tableUtils = tableUtils;
 exports.updateCredentials = updateCredentials;
 exports.writeDataToFile = writeDataToFile;
 //# sourceMappingURL=index.cjs.js.map