@bigbinary/neeto-playwright-commons 1.27.1 → 1.28.0

package/index.d.ts

@@ -963,6 +963,7 @@ declare class SlackApi {
   fetchMessages: (channelId: string, unixTimestamp: number) => Promise<playwright_core.APIResponse | undefined>;
   createChannel: (channelName: string) => Promise<playwright_core.APIResponse | undefined>;
   addUser: (channelId: string, userId: string) => Promise<playwright_core.APIResponse | undefined>;
+  mockChannelDeleted: (channelId: string) => Promise<playwright_core.APIResponse | undefined>;
 }
 declare class WebhookSiteApi {
   private readonly request;
@@ -2688,6 +2689,9 @@ interface CreateNewSlackChannelParams {
 declare class SlackPage extends IntegrationBase {
   slackWebappPage: Page;
   slackWebappPageDataQa: (dataQa: string | [string, string]) => Locator;
+  allowButton: Locator;
+  callbackUrl: string;
+  currentWorkspace: string;
   constructor({
     page,
     neetoPlaywrightUtilities,
@@ -2705,15 +2709,40 @@ declare class SlackPage extends IntegrationBase {
    * @endexample
   */
   setupCloseHandlers: (slackWebappPage?: Page) => Promise<void>;
+  private initializeSlackPermissionPage;
   /**
    *
-   * Connects to slack integration and verifies the connection. It takes the following parameters:
+   * Navigates the page to the captured Slack OAuth callback URL. Uses HTTP in place of HTTPS for local/dev. Call captureCallbackUrl before starting the OAuth flow so the callback URL is set. Used when running test against
    *
-   * redirectUrl: URL to redirect after connecting.
+   * dev env.
+   *
+   * @example 
+   *
+   * await slackPage.navigateToCallbackUrl();
+   * @endexample
+  */
+  navigateToCallbackUrl: () => Promise<void>;
+  /**
+   *
+   * Registers a request listener that captures the Slack OAuth callback URL when a request to /neeto_slack/api/v2/slack/callbacks is made. The URL is stored for use by navigateToCallbackUrl. Call this before starting the OAuth flow (e.g. before clicking the Slack "Allow" button in dev).
+   *
+   * @example 
+   *
+   * slackPage.captureCallbackUrl();
+   * @endexample
+  */
+  captureCallbackUrl: () => Page;
+  private connectAndVerifyInDev;
+  private connectAndVerifyInStaging;
+  /**
+   *
+   * Completes the Slack OAuth flow and verifies the integration is connected. In dev, captures the callback URL and navigates to it; in staging, relies on redirect. Then configures the given channel and runs optional custom steps.
+   *
+   * redirectUrl: URL or pattern to wait for after OAuth redirect.
    *
    * customSteps (optional): Custom steps to perform after connection.
    *
-   * channelToConfigure (optional): Channel to configure.
+   * channelToConfigure (optional): Slack channel to select in the configure step. Defaults to SLACK_DEFAULT_CHANNEL.
    *
    * @example 
    *
@@ -2725,6 +2754,7 @@ declare class SlackPage extends IntegrationBase {
    * @endexample
   */
   connectAndVerifyIntegration: (redirectUrl: RedirectUrl, customSteps?: AsyncNoArgsFunction, channelToConfigure?: string) => Promise<void>;
+  private completeSlackChannelSetup;
   /**
    *
    * Disconnects from Slack integration and verifies disconnection.

package/index.js

@@ -521,6 +521,14 @@ class SlackApi {
         this.fetchMessages = (channelId, unixTimestamp) => this.apiRequest("history", { channel: channelId, oldest: unixTimestamp });
         this.createChannel = (channelName) => this.apiRequest("create", { name: channelName });
         this.addUser = (channelId, userId) => this.apiRequest("invite", { channel: channelId, users: userId });
+        this.mockChannelDeleted = (channelId) => this.neetoPlaywrightUtilities.apiRequest({
+            url: "/neeto_slack/api/v1/testing/webhooks",
+            method: "post",
+            data: keysToSnakeCase({
+                eventType: "channel_deleted",
+                notificationChannelId: channelId,
+            }),
+        });
         if (!process.env.SLACK_BOT_TOKEN) {
             throw new Error("SLACK_BOT_TOKEN is not set");
         }
@@ -116887,11 +116895,17 @@ class GooglePage extends IntegrationBase {
                     totpToken = this.totp.generate({ timestamp: Date.now() });
                 }
                 previousToken = totpToken;
+                if (await codeInput.isHidden())
+                    return;
                 await codeInput.fill(totpToken);
                 expect(this.totp.validate({ token: totpToken })).not.toBeNull();
                 await this.page.locator(GOOGLE_LOGIN_SELECTORS.totpNext).click();
-                await expect(this.page.getByText(GOOGLE_LOGIN_TEXTS.wrongCode)).toBeHidden({ timeout: 10000 });
-                await expect(codeInput).toBeHidden({ timeout: 15000 });
+                await Promise.all([
+                    expect(codeInput).toBeHidden({ timeout: 20000 }),
+                    expect(this.page.getByText(GOOGLE_LOGIN_TEXTS.wrongCode)).toBeHidden({
+                        timeout: 20000,
+                    }),
+                ]);
             }).toPass({ timeout: 2 * 60 * 1000 });
         };
         this.logoutFromGoogle = async () => {
@@ -117088,32 +117102,58 @@ class SlackPage extends IntegrationBase {
             await slackWebappPage.addLocatorHandler(slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.messagePaneBannerCloseIcon), locator => locator.click(), { times: 1 });
             await slackWebappPage.addLocatorHandler(slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.permissionBannerCloseIcon), locator => locator.click(), { noWaitAfter: true, times: 2 });
         };
-        this.connectAndVerifyIntegration = async (redirectUrl, customSteps, channelToConfigure = SLACK_DEFAULT_CHANNEL) => {
+        this.initializeSlackPermissionPage = async () => {
             await this.connect();
-            const loginButton = this.page.getByRole("button", {
-                name: this.t("neetoSlack.slack.connect.loginButton"),
-            });
-            const installButton = this.page.locator(SLACK_SELECTORS.installButton);
-            const allowButton = this.page.getByRole("button", {
-                name: SLACK_WEB_TEXTS.allow,
-            });
-            const button = installButton.or(allowButton);
-            if (await loginButton.isVisible()) {
-                await loginButton.click({ delay: 5000 });
-                await this.page.waitForURL(RegExp("(.*)slack.com/.*"));
-            }
             await this.page.waitForLoadState("domcontentloaded", { timeout: 25000 });
-            await expect(button).toBeVisible({ timeout: 25000 });
-            await expect(button).toBeEnabled({ timeout: 25000 });
-            const currentWorkspace = (await this.page
+            await expect(this.allowButton).toBeVisible({ timeout: 25000 });
+            await expect(this.allowButton).toBeEnabled({ timeout: 25000 });
+            return await this.page
                 .locator(SLACK_SELECTORS.teamPicketButtonContent)
-                .textContent()) || "";
-            await button.click({ timeout: 25000 });
-            await this.page.waitForURL(redirectUrl);
+                .textContent();
+        };
+        this.navigateToCallbackUrl = async () => {
+            await this.page.goto(this.callbackUrl.replace(/^https:/, "http:"));
+            await this.neetoPlaywrightUtilities.waitForPageLoad();
+        };
+        this.captureCallbackUrl = () => this.page.on("request", (request) => {
+            const url = request.url();
+            if (url.includes("/neeto_slack/api/v2/slack/callbacks") &&
+                url.startsWith("https:")) {
+                this.callbackUrl = url;
+            }
+        });
+        this.connectAndVerifyInDev = async (redirectUrl, channelToConfigure, customSteps) => {
+            this.currentWorkspace = (await this.initializeSlackPermissionPage()) || "";
+            this.captureCallbackUrl();
+            await this.allowButton.click({ timeout: 25000 });
+            await expect(this.allowButton).toBeHidden({ timeout: 25000 });
+            await this.page.waitForLoadState("domcontentloaded", { timeout: 20000 });
+            await this.navigateToCallbackUrl();
+            await this.page.waitForURL(redirectUrl, {
+                timeout: 15000,
+            });
+            await this.completeSlackChannelSetup(channelToConfigure, customSteps);
+        };
+        this.connectAndVerifyInStaging = async (redirectUrl, channelToConfigure, customSteps) => {
+            this.currentWorkspace = (await this.initializeSlackPermissionPage()) || "";
+            await this.allowButton.click({ timeout: 25000 });
+            await expect(this.allowButton).toBeHidden({ timeout: 25000 });
+            await this.page.waitForLoadState("domcontentloaded", { timeout: 20000 });
+            await this.page.waitForURL(redirectUrl, {
+                timeout: 15000,
+            });
+            await this.completeSlackChannelSetup(channelToConfigure, customSteps);
+        };
+        this.connectAndVerifyIntegration = async (redirectUrl, customSteps, channelToConfigure = SLACK_DEFAULT_CHANNEL) => {
+            IS_DEV_ENV
+                ? await this.connectAndVerifyInDev(redirectUrl, channelToConfigure, customSteps)
+                : await this.connectAndVerifyInStaging(redirectUrl, channelToConfigure, customSteps);
+        };
+        this.completeSlackChannelSetup = async (channelToConfigure, customSteps) => {
             await this.neetoPlaywrightUtilities.waitForPageLoad();
             await expect(this.page.getByRole("heading", {
                 name: this.t("neetoSlack.slack.configure.title", {
-                    teamName: currentWorkspace,
+                    teamName: this.currentWorkspace,
                 }),
             })).toBeVisible({ timeout: 10000 });
             await this.neetoPlaywrightUtilities.selectOptionFromDropdown({
@@ -117122,14 +117162,17 @@ class SlackPage extends IntegrationBase {
             await this.page
                 .getByRole("button", { name: this.t("neetoSlack.common.continue") })
                 .click();
-            await this.neetoPlaywrightUtilities.waitForPageLoad();
+            await Promise.all([
+                this.neetoPlaywrightUtilities.waitForPageLoad(),
+                this.neetoPlaywrightUtilities.verifyToast(),
+            ]);
             if (customSteps) {
                 await customSteps();
             }
             else {
                 await expect(this.page.getByRole("heading", {
                     name: this.t("neetoSlack.slack.finish.title", {
-                        teamName: currentWorkspace,
+                        teamName: this.currentWorkspace,
                     }),
                 })).toBeVisible();
                 await this.page
@@ -117256,6 +117299,9 @@ class SlackPage extends IntegrationBase {
                 .click();
             await expect(channelItem).toBeHidden();
         };
+        this.allowButton = this.page.getByRole("button", {
+            name: SLACK_WEB_TEXTS.allow,
+        });
     }
 }
 
@@ -119388,7 +119434,9 @@ class CustomDomainPage {
             ]);
             await this.neetoPlaywrightUtilities.waitForPageLoad();
             await validateButton.click();
-            await expect(this.page.getByTestId(COMMON_SELECTORS.calloutElement)).toBeVisible({ timeout: 15000 });
+            await expect
+                .soft(this.page.getByTestId(COMMON_SELECTORS.calloutElement))
+                .toBeVisible({ timeout: 15000 });
             let isCertificateLimitExceeded = false;
             await expect(async () => {
                 isCertificateLimitExceeded = await this.isCertificateLimitExceeded();