Refactor to move validateAndEmit() logic to common.js

celestebancos · celestebancos · commit 27b61b802ef1 · 2021-12-11T18:54:54.000-05:00
diff --git a/components/quickbooks/sources/common.js b/components/quickbooks/sources/common.js
@@ -1,6 +1,10 @@
 const quickbooks = require("../quickbooks.app");
 const { createHmac } = require("crypto");
-const { SUPPORTED_WEBHOOK_OPERATIONS } = require("../constants");
+const {
+  WEBHOOK_ENTITIES,
+  WEBHOOK_OPERATIONS,
+  SUPPORTED_WEBHOOK_OPERATIONS,
+} = require("../constants");
 
 module.exports = {
   props: {
@@ -19,6 +23,9 @@ module.exports = {
     },
   },
   methods: {
+    companyId(event) {
+      return event.body.eventNotifications[0].realmId;
+    },
     getSupportedOperations(entityName) {
       return SUPPORTED_WEBHOOK_OPERATIONS[entityName];
     },
@@ -37,23 +44,24 @@ module.exports = {
         return pastTenseVersion[operations];
       }
     },
-    sendHttpResponse(event, entities) {
-      this.http.respond({
-        status: 200,
-        body: entities,
-        headers: {
-          "Content-Type": event.headers["Content-Type"],
-        },
-      });
+    verifyWebhookRequest(event) {
+      const token = this.webhookVerifierToken;
+      const payload = event.bodyRaw;
+      const header = event.headers["intuit-signature"];
+      const hash = createHmac("sha256", token).update(payload)
+        .digest("hex");
+      const convertedHeader = Buffer.from(header, "base64").toString("hex");
+      return hash === convertedHeader;
     },
-    isValidSource(event, webhookCompanyId) {
+    isValidSource(event) {
       const isWebhookValid = this.verifyWebhookRequest(event);
       if (!isWebhookValid) {
         console.log(`Error: Webhook did not pass verification. Try reentering the verifier token, 
         making sure it's from the correct section on the Intuit Developer Dashboard.`);
         return false;
       }
 
+      const webhookCompanyId = this.companyId(event);
       const connectedCompanyId = this.quickbooks.companyId();
       if (webhookCompanyId !== connectedCompanyId) {
         console.log(`Error: Cannot retrieve record details for incoming webhook. The QuickBooks company id 
@@ -63,36 +71,54 @@ module.exports = {
       }
       return true;
     },
-    verifyWebhookRequest(event) {
-      const token = this.webhookVerifierToken;
-      const payload = event.bodyRaw;
-      const header = event.headers["intuit-signature"];
-      const hash = createHmac("sha256", token).update(payload)
-        .digest("hex");
-      const convertedHeader = Buffer.from(header, "base64").toString("hex");
-      return hash === convertedHeader;
+    getEntities() {
+      return WEBHOOK_ENTITIES;
     },
-    async validateAndEmit(entity) {
-      // individual source modules can redefine this method to specify criteria
-      // for which events to emit
-      await this.processEvent(entity);
+    getOperations() {
+      return WEBHOOK_OPERATIONS;
     },
-    async processEvent(entity) {
+    isEntityRelevant(entity) {
       const {
         name,
-        id,
         operation,
-        lastUpdated,
       } = entity;
-      // Unless the record has been deleted, use the id received in the webhook
-      // to get the full record data
-      const eventToEmit = {
-        event_notification: entity,
-        record_details: operation === "Delete"
-          ? {}
-          : await this.quickbooks.getRecordDetails(name, id),
+      const relevantEntities = this.getEntities();
+      const relevantOperations = this.getOperations();
+
+      if (!relevantEntities.includes(name)) {
+        console.log(`Skipping '${operation} ${name}' event. (Accepted entities: ${relevantEntities.join(", ")})`);
+        return false;
+      }
+      if (!relevantOperations.includes(operation)) {
+        console.log(`Skipping '${operation} ${name}' event. (Accepted operations: ${relevantOperations.join(", ")})`);
+        return false;
+      }
+      return true;
+    },
+    async generateEvent(entity, event) {
+      const eventDetails = {
+        ...entity,
+        companyId: this.companyId(event),
       };
 
+      // Unless the record has been deleted, use the id received in the webhook
+      // to get the full record data from QuickBooks
+      const recordDetails = entity.operation === "Delete"
+        ? {}
+        : await this.quickbooks.getRecordDetails(entity.name, entity.id);
+
+      return {
+        eventDetails,
+        recordDetails,
+      };
+    },
+    generateMeta(event) {
+      const {
+        name,
+        id,
+        operation,
+        lastUpdated,
+      } = event.eventDetails;
       const summary = `${name} ${id} ${this.toPastTense(operation)}`;
       const ts = lastUpdated
         ? Date.parse(lastUpdated)
@@ -103,26 +129,35 @@ module.exports = {
         operation,
         ts,
       ].join("-");
-      this.$emit(eventToEmit, {
+      return {
         id: eventId,
         summary,
         ts,
+      };
+    },
+    async processEvent(event) {
+      const { entities } = event.body.eventNotifications[0].dataChangeEvent;
+
+      const events = await Promise.all(entities
+        .filter(this.isEntityRelevant)
+        .map(async (entity) => {
+          // Generate events asynchronously to fetch multiple records from the API at the same time
+          return await this.generateEvent(entity, event);
+        }));
+
+      events.forEach((event) => {
+        const meta = this.generateMeta(event);
+        this.$emit(event, meta);
       });
     },
+
   },
   async run(event) {
-    const { entities } = event.body.eventNotifications[0].dataChangeEvent;
-    this.sendHttpResponse(event, entities);
-
-    const webhookCompanyId = event.body.eventNotifications[0].realmId;
-    if (!this.isValidSource(event, webhookCompanyId)) {
+    if (!this.isValidSource(event)) {
       console.log("Skipping event from unrecognized source.");
       return;
     }
 
-    await Promise.all(entities.map((entity) => {
-      entity.realmId = webhookCompanyId;
-      return this.validateAndEmit(entity);
-    }));
+    return this.processEvent(event);
   },
 };
diff --git a/components/quickbooks/sources/custom-webhook-events/custom-webhook-events.js b/components/quickbooks/sources/custom-webhook-events/custom-webhook-events.js
@@ -10,7 +10,7 @@ module.exports = {
   type: "source",
   props: {
     ...common.props,
-    namesToEmit: {
+    entitiesToEmit: {
       propDefinition: [
         quickbooks,
         "webhookNames",
@@ -25,20 +25,11 @@ module.exports = {
   },
   methods: {
     ...common.methods,
-    async validateAndEmit(entity) {
-      // only emit events that match the entity names and operations indicated by the user
-      // but if the props are left empty, emit all events rather than filtering them all out
-      // (it would a hassle for the user to select every option if they wanted to emit everything)
-      if (this.namesToEmit.length > 0 && !this.namesToEmit.includes(entity.name)) {
-        console.log(`Entity Type '${entity.name}' not found in list of selected Entity Types`);
-        return;
-      }
-      if (this.operationsToEmit.length > 0
-        && !this.operationsToEmit.includes(entity.operation)) {
-        console.log(`Operation '${entity.operation}' not found in list of selected Operations`);
-        return;
-      }
-      await this.processEvent(entity);
+    getEntities() {
+      return this.entitiesToEmit;
+    },
+    getOperations() {
+      return this.operationsToEmit;
     },
   },
 };
diff --git a/components/quickbooks/sources/new-or-modified-customer/new-or-modified-customer.js b/components/quickbooks/sources/new-or-modified-customer/new-or-modified-customer.js
@@ -27,22 +27,11 @@ module.exports = {
   },
   methods: {
     ...common.methods,
-    async validateAndEmit(entity) {
-      // only emit events that match the specified entity name and operation
-      // but if the operations prop is left empty, emit all events rather
-      // than filtering them all out
-      // (it would a hassle for the user to select every single option
-      // if they wanted to emit everything)
-      if (entity.name !== sourceEntity) {
-        console.log(`${entity.name} webhook received and ignored, since it is not a Customer`);
-        return;
-      }
-      if (this.operationsToEmit.length > 0
-        && !this.operationsToEmit.includes(entity.operation)) {
-        console.log(`Operation '${entity.operation}' not found in list of selected Operations`);
-        return;
-      }
-      await this.processEvent(entity);
+    getEntities() {
+      return [sourceEntity];
+    },
+    getOperations() {
+      return this.operationsToEmit;
     },
   },
 };
