Adjusting event format for record-based sources

Author: GTFalcao

components/airtable_oauth/sources/common/common-webhook-field.mjs

@@ -1,4 +1,3 @@
-import airtable from "../../airtable_oauth.app.mjs";
 import common from "./common-webhook.mjs";
 
 export default {
@@ -21,7 +20,7 @@ export default {
         this.db.set("tableSchemas", filteredData);
       }
     },
-    async emitEvent(payload) {
+    emitEvent(payload) {
       const [tableId, tableData] = Object.entries(payload.changedTablesById)[0];
       const [operation, fieldObj] = Object.entries(tableData)[0];
       const [fieldId, fieldUpdateInfo] = Object.entries(fieldObj)[0];

components/airtable_oauth/sources/common/common-webhook-record.mjs

@@ -1,4 +1,4 @@
-import airtable from "../../airtable_oauth.app.mjs";
+
 import common from "./common-webhook.mjs";
 
 export default {
@@ -10,42 +10,40 @@ export default {
         "tableData",
       ];
     },
-  },
-  props: {
-    ...common.props,
-    watchDataInFieldIds: {
-      propDefinition: [
-        airtable,
-        "sortFieldId",
-        (c) => ({
-          baseId: c.baseId,
-          tableId: c.tableId,
-        }),
-      ],
-      type: "string[]",
-      label: "Watch Data In Field Ids",
-      description:
-        "Only emit events for updates that modify values in cells in these fields. If omitted, all fields within the table/view/base are watched",
-    },
-    includeCellValuesInFieldIds: {
-      propDefinition: [
-        airtable,
-        "sortFieldId",
-        (c) => ({
-          baseId: c.baseId,
-          tableId: c.tableId,
-        }),
-      ],
-      type: "string[]",
-      label: "Include Cell Values in Field Ids",
-      description: "Fields to include in the event payload, regardless of whether or not they changed",
-    },
-    includePreviousCellValues: {
-      type: "boolean",
-      label: "Include Previous Cell Values",
-      description:
-        "If true, include the previous cell value in the event payload",
-      optional: true,
+    async emitEvent(payload) {
+      const [tableId, tableData] = Object.entries(payload.changedTablesById)[0];
+      let [operation, recordObj] = Object.entries(tableData)[0];
+      if (operation === 'changedViewsById') {
+        const changedRecord = Object.entries(recordObj)[0];
+        operation = changedRecord[0];
+        recordObj = changedRecord[1];
+      }
+      const [recordId, recordUpdateInfo] = Object.entries(recordObj)[0];
+
+      let updateType = 'updated';
+      if (operation === "createdRecordsById") {
+        updateType = "created";
+      } else if (operation === "deletedRecordsById") {
+        updateType = "deleted";
+      }
+
+      const { fields } = await this.airtable.getRecord({
+        baseId: this.baseId,
+        tableId,
+        recordId
+      });
+
+      const summary = `Record ${updateType}: ${fields?.name ?? recordId}`
+
+      this.$emit({
+        originalPayload: payload,
+        tableId,
+        record: {
+          id: recordId,
+          fields,
+        },
+        recordUpdateInfo,
+      }, this.generateMeta(payload, summary));
     },
   },
 };

components/airtable_oauth/sources/common/common-webhook.mjs

@@ -114,10 +114,10 @@ export default {
       const meta = this.generateMeta(payload);
       this.$emit(payload, meta);
     },
-    emitEvent(payload) {
+    async emitEvent(payload) {
       // sources may call this to customize event emission, but it is
       // a separate method so that the source may fall back to default
-      this.emitDefaultEvent(payload);
+      return this.emitDefaultEvent(payload);
     },
     async saveAdditionalData() {
       // sources may call this to fetch additional data (e.g. field schemas)
@@ -149,7 +149,7 @@ export default {
       });
       for (const payload of payloads) {
         try {
-          this.emitEvent(payload);
+          await this.emitEvent(payload);
         } catch (err) {
           console.log('Error emitting event, defaulting to default emission');
           console.log(err);

components/airtable_oauth/sources/new-modified-or-deleted-records-instant/new-modified-or-deleted-records-instant.mjs

@@ -1,6 +1,7 @@
 import common from "../common/common-webhook-record.mjs";
 import constants from "../common/constants.mjs";
 import sampleEmit from "./test-event.mjs";
+import airtable from "../../airtable_oauth.app.mjs";
 
 export default {
   ...common,
@@ -19,6 +20,20 @@ export default {
       options: constants.CHANGE_TYPES,
       optional: true,
     },
+    watchDataInFieldIds: {
+      propDefinition: [
+        airtable,
+        "sortFieldId",
+        (c) => ({
+          baseId: c.baseId,
+          tableId: c.tableId,
+        }),
+      ],
+      type: "string[]",
+      label: "Watch Data In Field Ids",
+      description:
+        "Only emit events for updates that modify values in cells in these fields. If omitted, all fields within the table/view/base are watched",
+    },
   },
   methods: {
     ...common.methods,

components/airtable_oauth/sources/new-or-modified-records/new-or-modified-records.mjs

@@ -1,11 +1,12 @@
 import common from "../common/common-webhook-record.mjs";
+import airtable from "../../airtable_oauth.app.mjs";
 
 export default {
   ...common,
   name: "New or Modified Records (Instant)",
   key: "airtable_oauth-new-or-modified-records",
   description: "Emit new event for each new or modified record in a table or view",
-  version: "1.0.0",
+  version: "1.0.{{ts}}",
   type: "source",
   dedupe: "unique",
   methods: {
@@ -17,4 +18,21 @@ export default {
       ];
     },
   },
+  props: {
+    ...common.props,
+    watchDataInFieldIds: {
+      propDefinition: [
+        airtable,
+        "sortFieldId",
+        (c) => ({
+          baseId: c.baseId,
+          tableId: c.tableId,
+        }),
+      ],
+      type: "string[]",
+      label: "Watch Data In Field Ids",
+      description:
+        "Only emit events for updates that modify values in cells in these fields. If omitted, all fields within the table/view/base are watched",
+    },
+  },
 };