(core) deleting queue from single webhook

Summary: Using standard tost notification, message about webhook queue being overflown was added. message is permanent as long as queue is full. Message contains linkt to the webhook setings

Test Plan: two nbrowser test was added - one to check if message is show when queue is full, and second to check if message is dismiss when queue was cleaned.

Reviewers: georgegevoian

Reviewed By: georgegevoian

Subscribers: jarek

Differential Revision: https://phab.getgrist.com/D3929

test/nbrowser/WebhookOverflow.ts

@@ -0,0 +1,117 @@
+import {DocCreationInfo} from 'app/common/DocListAPI';
+import {DocAPI} from 'app/common/UserAPI';
+import {assert, driver, Key} from 'mocha-webdriver';
+import * as gu from 'test/nbrowser/gristUtils';
+import {server, setupTestSuite} from 'test/nbrowser/testUtils';
+import {EnvironmentSnapshot} from 'test/server/testUtils';
+import {WebhookFields} from "../../app/common/Triggers";
+
+describe('WebhookOverflow', function () {
+  this.timeout(30000);
+  const cleanup = setupTestSuite();
+  let session: gu.Session;
+  let oldEnv: EnvironmentSnapshot;
+  let doc: DocCreationInfo;
+  let docApi: DocAPI;
+
+  before(async function () {
+    oldEnv = new EnvironmentSnapshot();
+    //host = new URL(server.getHost()).host;
+    process.env.ALLOWED_WEBHOOK_DOMAINS = '*';
+    process.env.GRIST_MAX_QUEUE_SIZE = '2';
+    await server.restart();
+    session = await gu.session().teamSite.login();
+    const api = session.createHomeApi();
+    doc = await session.tempDoc(cleanup, 'Hello.grist');
+    docApi = api.getDocAPI(doc.id);
+    await api.applyUserActions(doc.id, [
+      ['AddTable', 'Table2', [{id: 'A'}, {id: 'B'}, {id: 'C'}, {id: 'D'}, {id: 'E'}]],
+    ]);
+    const webhookDetails: WebhookFields = {
+      url: 'https://localhost/WrongWebhook',
+      eventTypes: ["add", "update"],
+      enabled: true,
+      name: 'test webhook',
+      tableId: 'Table2',
+    };
+    await docApi.addWebhook(webhookDetails);
+  });
+
+  after(async function () {
+    oldEnv.restore();
+    await server.restart();
+  });
+
+  async function enterCellWithoutWaitingOnServer(...keys: string[]) {
+    const lastKey = keys[keys.length - 1];
+    if (![Key.ENTER, Key.TAB, Key.DELETE].includes(lastKey)) {
+      keys.push(Key.ENTER);
+    }
+    await driver.sendKeys(...keys);
+  }
+
+  it('should show a message when overflown', async function () {
+    await gu.openPage('Table2');
+    await gu.getCell('A', 1).click();
+    await gu.enterCell('123');
+    await gu.getCell('B', 1).click();
+    await enterCellWithoutWaitingOnServer('124');
+    const toast = await driver.wait(() => gu.getToasts(), 10000);
+    assert.include(toast, 'New changes are temporarily suspended. Webhooks queue overflowed.' +
+      ' Please check webhooks settings, remove invalid webhooks, and clean the queue.\ngo to webhook settings');
+  });
+
+  it('message should disappear after clearing queue', async function () {
+    await openWebhookPageWithoutWaitForServer();
+    await driver.findContent('button', /Clear Queue/).click();
+    await gu.waitForServer();
+    await waitForOverflownMessageToDisappear();
+    const toast = await driver.wait(() => gu.getToasts());
+    assert.notInclude(toast, 'New changes are temporarily suspended. Webhooks queue overflowed.' +
+      ' Please check webhooks settings, remove invalid webhooks, and clean the queue.\ngo to webhook settings');
+  });
+});
+
+async function waitForOverflownMessageToDisappear(maxWait = 12500) {
+  await driver.wait(async () => {
+    try {
+      for (;;) {
+        const toasts = await gu.getToasts();
+        const filteredToasts = toasts.find(t => t=='New changes are temporarily suspended. Webhooks queue overflowed.' +
+          ' Please check webhooks settings, remove invalid webhooks, and clean the queue.\ngo to webhook settings');
+        if (!filteredToasts) {
+          return true;
+        }
+      }
+    } catch (e) {
+      return false;
+    }
+  }, maxWait, 'Overflown message did not disappear');
+}
+
+async function openWebhookPageWithoutWaitForServer() {
+  await openDocumentSettings();
+  const button = await driver.findContentWait('a', /Manage Webhooks/, 3000);
+  await gu.scrollIntoView(button).click();
+  await waitForWebhookPage();
+}
+
+async function waitForWebhookPage() {
+  await driver.findContentWait('button', /Clear Queue/, 3000);
+  // No section, so no easy utility for setting focus. Click on a random cell.
+  await gu.getDetailCell({col: 'Webhook Id', rowNum: 1}).click();
+}
+
+export async function openAccountMenu() {
+  await driver.findWait('.test-dm-account', 1000).click();
+  // Since the AccountWidget loads orgs and the user data asynchronously, the menu
+  // can expand itself causing the click to land on a wrong button.
+  await driver.findWait('.test-site-switcher-org', 1000);
+  await driver.sleep(250);  // There's still some jitter (scroll-bar? other user accounts?)
+}
+
+export async function openDocumentSettings() {
+  await openAccountMenu();
+  await driver.findContent('.grist-floating-menu a', 'Document Settings').click();
+  await gu.waitForUrl(/settings/, 5000);
+}

test/nbrowser/WebhookPage.ts

@@ -1,11 +1,9 @@
-import { DocCreationInfo } from 'app/common/DocListAPI';
-import { DocAPI } from 'app/common/UserAPI';
-import { assert, driver, Key } from 'mocha-webdriver';
+import {DocCreationInfo} from 'app/common/DocListAPI';
+import {DocAPI} from 'app/common/UserAPI';
+import {assert, driver, Key} from 'mocha-webdriver';
 import * as gu from 'test/nbrowser/gristUtils';
-import { setupTestSuite } from 'test/nbrowser/testUtils';
-import { EnvironmentSnapshot } from 'test/server/testUtils';
-import { server } from 'test/nbrowser/testUtils';
-//import { Deps as TriggersDeps } from 'app/server/lib/Triggers';
+import {server, setupTestSuite} from 'test/nbrowser/testUtils';
+import {EnvironmentSnapshot} from 'test/server/testUtils';
 
 describe('WebhookPage', function () {
   this.timeout(60000);