Add a webhook log success field to allow filtering in the UI (#2061)

* Add a success field to allow filtering in the UI

* add test assertions

Author: mjh1

packages/api/src/controllers/webhook-log.ts

@@ -26,6 +26,7 @@ const requestsFieldsMap: FieldsMap = {
   userId: `webhook_log.data->>'userId'`,
   event: `webhook_log.data->>'event'`,
   statusCode: `webhook_log.data->'response'->>'status'`,
+  success: `webhook_log.data->>'success'`,
   resourceId: {
     val: `webhook_log.data->'request'->>'body'`,
     type: "full-text",

packages/api/src/controllers/webhook.test.js

@@ -350,7 +350,15 @@ describe("controllers/webhook", () => {
       expect(resent.webhookId).toBe(webhookRequest.webhookId);
       expect(resent.id).not.toBe(webhookRequest.id);
 
-      const logRes = await client.get(`/webhook/${generatedWebhook.id}/log`);
+      let logRes = await client.get(`/webhook/${generatedWebhook.id}/log`);
+      expect(logRes.status).toBe(200);
+      logJson = await logRes.json();
+      expect(logJson.length).toBe(2);
+
+      // try query filters
+      logRes = await client.get(
+        `/webhook/${generatedWebhook.id}/log?filters=[{"id":"success","value":"false"}]`
+      );
       expect(logRes.status).toBe(200);
       logJson = await logRes.json();
       expect(logJson.length).toBe(2);

packages/api/src/schema/api-schema.yaml

@@ -244,6 +244,9 @@ components:
         duration:
           type: number
           description: The time taken (in seconds) to make the webhook request
+        success:
+          type: boolean
+          description: Whether the webhook request was successful
         request:
           type: object
           properties:

packages/api/src/schema/db-schema.yaml

@@ -614,6 +614,8 @@ components:
           index: true
         createdAt:
           index: true
+        success:
+          index: true
         response:
           type: object
           properties:

packages/api/src/webhooks/cannon.ts

@@ -413,7 +413,7 @@ export default class WebhookCannon {
         responseBody = await resp.text();
         statusCode = resp.status;
 
-        if (resp.status >= 200 && resp.status < 300) {
+        if (isSuccess(resp)) {
           // 2xx requests are cool. all is good
           logger.info(`webhook ${webhook.id} fired successfully`);
           return true;
@@ -449,7 +449,7 @@ export default class WebhookCannon {
           );
         } catch (e) {
           console.log(
-            `Unable to store response of webhook ${webhook.id} url: ${webhook.url}`
+            `Unable to store response of webhook ${webhook.id} url: ${webhook.url} error: ${e}`
           );
         }
         await this.storeTriggerStatus(
@@ -585,6 +585,10 @@ export default class WebhookCannon {
   }
 }
 
+function isSuccess(resp: Response) {
+  return resp?.status >= 200 && resp?.status < 300;
+}
+
 async function storeResponse(
   webhook: DBWebhook,
   eventId: string,
@@ -596,9 +600,12 @@ async function storeResponse(
   params
 ): Promise<WebhookLog> {
   const hrDuration = process.hrtime(startTime);
-  const encodedResponseBody = Buffer.from(
-    responseBody.substring(0, 1024)
-  ).toString("base64");
+  let encodedResponseBody = "";
+  if (responseBody) {
+    encodedResponseBody = Buffer.from(responseBody.substring(0, 1024)).toString(
+      "base64"
+    );
+  }
 
   const webhookLog = {
     id: uuid(),
@@ -608,11 +615,12 @@ async function storeResponse(
     userId: webhook.userId,
     createdAt: Date.now(),
     duration: hrDuration[0] + hrDuration[1] / 1e9,
+    success: isSuccess(resp),
     response: {
       body: encodedResponseBody,
-      redirected: resp.redirected,
-      status: resp.status,
-      statusText: resp.statusText,
+      redirected: resp?.redirected,
+      status: resp?.status,
+      statusText: resp?.statusText,
     },
     request: {
       url: webhook.url,
@@ -694,7 +702,9 @@ export async function storeTriggerStatus(
 ): Promise<void> {
   try {
     let status: DBWebhook["status"] = { lastTriggeredAt: triggerTime };
-    let encodedResponseBody = Buffer.from(responseBody).toString("base64");
+    let encodedResponseBody = responseBody
+      ? Buffer.from(responseBody).toString("base64")
+      : "";
     if (statusCode >= 300 || !statusCode) {
       status = {
         ...status,