@bigbinary/neeto-playwright-commons 1.8.9 → 1.8.11

package/index.d.ts

@@ -141,6 +141,54 @@ declare class HelpAndProfilePage {
     verifyLogoutV2: () => Promise<void>;
 }
 
+type Integration = "dailyco" | "github" | "google-calendar" | "google-analytics" | "google-sheets" | "microsoft-teams" | "neeto-chat" | "neeto-crm" | "slack" | "twilio" | "whereby" | "zapier" | "zoom";
+type IntegrationStatus = "connected" | "disconnected";
+interface IntegrationBaseParams {
+    page: Page;
+    neetoPlaywrightUtilities: CustomCommands;
+    integration: Integration;
+    integrationRouteIndex?: string;
+    connectedHeader?: string;
+    connectHeader?: string;
+}
+declare class IntegrationBase {
+    readonly page: Page;
+    readonly neetoPlaywrightUtilities: CustomCommands;
+    readonly t: TFunction;
+    readonly integration: Integration;
+    readonly integrationCard: Locator;
+    readonly connectHeader: string;
+    readonly connectedHeader: string;
+    integrationRouteIndex: string;
+    constructor({ page, neetoPlaywrightUtilities, integration, integrationRouteIndex, connectHeader, connectedHeader, }: IntegrationBaseParams);
+    disconnect: (interceptMultipleResponsesParams?: Partial<InterceptMultipleResponsesParams>) => Promise<void>;
+    connect: (skipGoTo?: boolean) => Promise<void>;
+    verifyIntegrationStatus: (status?: IntegrationStatus) => Promise<void>;
+    clickOnIntegrationCard: () => Promise<void>;
+    private gotoIntegrationIndex;
+}
+
+type AsyncNoArgsFunction = () => Promise<void>;
+type RedirectUrl = string | RegExp | ((url: URL) => boolean);
+type SlackPageParams = {
+    page: Page;
+    neetoPlaywrightUtilities: CustomCommands;
+    integrationRouteIndex?: string;
+};
+declare class SlackPage extends IntegrationBase {
+    slackWebappPage: Page;
+    constructor({ page, neetoPlaywrightUtilities, integrationRouteIndex, }: SlackPageParams);
+    connectAndVerifyIntegration: (redirectUrl: RedirectUrl, customSteps?: AsyncNoArgsFunction) => Promise<void>;
+    disconnectAndVerifyIntegration: () => Promise<void>;
+    updateConfigureSlackChannel: ({ newSlackChannel, interceptMultipleResponsesParams, }: {
+        newSlackChannel: string;
+        interceptMultipleResponsesParams?: Partial<InterceptMultipleResponsesParams> | undefined;
+    }) => Promise<void>;
+    loginToSlackWebapp: (slackWebappPage: Page) => Promise<void>;
+    logoutFromSlackWebApp: () => Promise<void>;
+    goToSlackChannel: (slackChannel: string) => Promise<void>;
+}
+
 interface WebhooksPageParams {
     page: Page;
     request: APIRequestContext;
@@ -211,6 +259,7 @@ declare const CREDENTIALS: {
     password: string;
 };
 declare const OTP_EMAIL_PATTERN = "is your login code";
+declare const SLACK_DEFAULT_CHANNEL = "general";
 
 declare const USER_AGENTS: {
     windows: string;
@@ -251,6 +300,9 @@ declare const THIRD_PARTY_ROUTES: {
     webhooks: {
         site: string;
     };
+    slack: {
+        loginWithPassword: (workspace: string) => string;
+    };
 };
 
 declare const COMMON_SELECTORS: {
@@ -298,6 +350,7 @@ declare const COMMON_SELECTORS: {
     modalHeader: string;
     nameInputError: string;
     selectContainer: string;
+    selectValueContainer: string;
     dropdownMenu: string;
     sidebarToggle: string;
     subheader: string;
@@ -573,4 +626,4 @@ interface Overrides {
 }
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, 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, STORAGE_STATE, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, 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, STORAGE_STATE, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };

package/index.js

@@ -11,6 +11,7 @@ import require$$0$2 from 'util';
 import require$$0$3 from 'stream';
 import require$$0$4 from 'events';
 import { getI18nInstance, initI18n } from 'playwright-i18next-fixture';
+import { humanize, isNotEmpty } from '@bigbinary/neeto-cist';
 import require$$3 from 'crypto';
 
 const ENVIRONMENT = {
@@ -28,6 +29,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 = " ") => {
@@ -137,6 +139,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",
@@ -145,7 +148,7 @@ const COMMON_SELECTORS = {
     appSwitcherButton: "app-switcher-button",
     appSwitcherWrapper: "switcher-wrapper",
     tableSpinner: ".ant-spin",
-    pageLoader: "neeto-molecules-page-loader",
+    pageLoader: "neeto-molecules-pageloader",
     homeButton: "home-button",
     neetoUiSwitch: "nui-switch",
     floatingActionMenuButton: "floating-action-menu-container",
@@ -7178,6 +7181,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 = {
@@ -7187,6 +7193,14 @@ const CHAT_WIDGET_TEXTS = {
 const MEMBER_TEXTS = {
     agent: "Agent",
 };
+const INTEGRATIONS_TEXTS = {
+    connectHeader: (integration) => `Connect your ${humanize(integration)} account`,
+    connectedHeader: (integration) => `You are connected to ${humanize(integration)}`,
+};
+const SLACK_WEB_TEXTS = {
+    signOut: "Sign out",
+    allow: "Allow",
+};
 
 const HELP_CENTER_SELECTORS = {
     helpButton: "help-button",
@@ -7623,6 +7637,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 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 expect(this.integrationCard.getByTestId(INTEGRATION_SELECTORS.integrationStatusTag)).toBeVisible({ timeout: 10000 });
+            }
+            await this.clickOnIntegrationCard();
+            const header = status === "connected" ? this.connectedHeader : this.connectHeader;
+            await expect(this.page.getByRole("heading", { name: header })).toBeVisible();
+        };
+        this.clickOnIntegrationCard = async () => {
+            await expect(this.page.getByTestId(COMMON_SELECTORS.spinner)).toHaveCount(0);
+            await this.integrationCard.scrollIntoViewIfNeeded();
+            await this.integrationCard.click();
+            await expect(this.page.getByTestId(COMMON_SELECTORS.pageLoader)).toBeHidden();
+        };
+        this.gotoIntegrationIndex = async () => {
+            isNotEmpty(this.integrationRouteIndex) &&
+                (await this.page.goto(this.integrationRouteIndex));
+        };
+        this.page = page;
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.t = 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 expect(allowButton).toBeEnabled({ timeout: 20000 });
+            const currentWorkspace = (await this.page
+                .locator(SLACK_SELECTORS.teamPicketButtonContent)
+                .textContent()) || "";
+            await allowButton.click();
+            await this.page.waitForURL(redirectUrl);
+            await expect(this.page.getByTestId(COMMON_SELECTORS.pageLoader)).toBeHidden({ timeout: 10000 });
+            await expect(this.page.getByRole("heading", {
+                name: this.t("neetoSlack.slack.configure.title", {
+                    teamName: currentWorkspace,
+                }),
+            })).toBeVisible();
+            await 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 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 (isNotNil(process.env.SLACK_WORKSPACE) &&
+                isNotNil(process.env.SLACK_LOGIN_PASSWORD) &&
+                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",
@@ -8608,5 +8815,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, 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, STORAGE_STATE, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, 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, STORAGE_STATE, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map