♻️ Add new ContactChangeEvent type

Author: MalteSehmer

src/index.ts

@@ -132,7 +132,10 @@ export function start(
   app.get('/account/id', (req, res, next) =>
     controller.getAccountId(req, res, next),
   );
-  app.post('/webhook', (req, res, next) => controller.handleWebhook(req, res));
+
+  app.post('/webhook', (req, res, next) =>
+    controller.handleWebhook(req, res, next),
+  );
 
   app.use(errorHandlerMiddleware);
 

src/models/adapter.model.ts

@@ -14,7 +14,7 @@ import {
   LoggedIntegrationEntity,
 } from '.';
 import { IntegrationEntityType } from './integration-entity.model';
-import { ContactsChangedData } from './contacts-changed.model';
+import { ContactChangeEvent } from './contacts-changed.model';
 
 export interface Adapter {
   getToken?: (config: Config) => Promise<{ apiKey: string }>;
@@ -84,6 +84,6 @@ export interface Adapter {
     req: Request,
     res?: Response,
   ) => Promise<{ apiKey: string; apiUrl: string }>;
-  handleWebhook?: (req: Request) => Promise<ContactsChangedData>;
+  handleWebhook?: (req: Request) => Promise<ContactChangeEvent[]>;
   verifyWebhookRequest?: (req: Request) => Promise<boolean>;
 }

src/models/contacts-changed.model.ts

@@ -1,17 +1,14 @@
 import { IntegrationEntityType } from './integration-entity.model';
 
-export type ContactsChangedData = {
-  integrationName: string;
-  data: {
-    integrationAccountId: string;
-    type: ContactsChangedDataType;
-    contactId: string;
-    contactType: IntegrationEntityType;
-  }[];
+export type ContactChangeEvent = {
+  accountId: string;
+  changeType: ContactChangeEventType;
+  contactId: string;
+  contactType: IntegrationEntityType;
 };
 
-export enum ContactsChangedDataType {
-  UPDATE = 'UPDATE',
-  CREATE = 'CREATE',
-  DELETE = 'DELETE',
+export enum ContactChangeEventType {
+  CREATED = 'CREATED',
+  UPDATED = 'UPDATED',
+  DELETED = 'DELETED',
 }

src/models/controller.model.ts

@@ -9,10 +9,10 @@ import {
   CallEventWithIntegrationEntities,
   Contact,
   ContactCache,
+  ContactChangeEvent,
   ContactDelta,
   ContactTemplate,
   ContactUpdate,
-  ContactsChangedData,
   ServerError,
 } from '.';
 import { calendarEventsSchema, contactsSchema } from '../schemas';
@@ -36,6 +36,7 @@ import {
   PubSubContactsState,
 } from './pubsub-contacts-message.model';
 import { PubSubContactsChangedClient } from './pubsub-contacts-changed-client.model';
+import { PubSubContactChangeEventMessage } from './pubsub-contacts-changed-message.model';
 
 const CONTACT_FETCH_TIMEOUT = 5000;
 
@@ -1354,7 +1355,11 @@ export class Controller {
     }
   }
 
-  public async handleWebhook(req: Request, res: Response): Promise<void> {
+  public async handleWebhook(
+    req: Request,
+    res: Response,
+    next: NextFunction,
+  ): Promise<void> {
     if (!this.adapter.handleWebhook) {
       throw new ServerError(501, 'Webhook handling not implemented');
     }
@@ -1371,16 +1376,29 @@ export class Controller {
     infoLogger('handleWebhook', 'START', '');
 
     try {
-      const contactsChangedData: ContactsChangedData =
+      const changeEvents: ContactChangeEvent[] =
         await this.adapter.handleWebhook(req);
 
       infoLogger(
         'handleWebhook',
-        `Got ${contactsChangedData.data.length} changed contacts`,
+        `Got ${changeEvents.length} changed contacts`,
         '',
       );
 
-      this.pubSubContactsChangedClient?.publishMessage(contactsChangedData);
+      changeEvents.map((changeEvent: ContactChangeEvent) => {
+        infoLogger(
+          'handleWebhook',
+          `Publishing contact change event with accountId ${changeEvent.accountId} and contactId ${changeEvent.contactId}`,
+          '',
+        );
+
+        const message: PubSubContactChangeEventMessage = {
+          integrationName: this.integrationName,
+          ...changeEvent,
+        };
+
+        this.pubSubContactsChangedClient?.publishMessage(message);
+      });
 
       infoLogger('handleWebhook', 'END', '');
       res.sendStatus(200);
@@ -1391,7 +1409,7 @@ export class Controller {
         '',
         error || 'Unknown',
       );
-      res.sendStatus(500);
+      next(error);
     }
   }
 }

src/models/pubsub-contacts-changed-client.model.ts

@@ -1,6 +1,6 @@
 import { PubSub } from '@google-cloud/pubsub';
 import { timeout } from '../util/timeout';
-import { PubSubContactsChangedMessage } from './pubsub-contacts-changed-message.model';
+import { PubSubContactChangeEventMessage } from './pubsub-contacts-changed-message.model';
 
 const PUBLISH_TIMEOUT = 10_000;
 
@@ -13,7 +13,7 @@ export class PubSubContactsChangedClient {
     this.topicName = topicName;
   }
 
-  async publishMessage(message: PubSubContactsChangedMessage) {
+  async publishMessage(message: PubSubContactChangeEventMessage) {
     if (!this.topicName) {
       throw new Error('No pubsub topic name provided.');
     }

src/models/pubsub-contacts-changed-message.model.ts

@@ -1,3 +1,5 @@
-import { ContactsChangedData } from './contacts-changed.model';
+import { ContactChangeEvent } from './contacts-changed.model';
 
-export type PubSubContactsChangedMessage = ContactsChangedData;
+export type PubSubContactChangeEventMessage = {
+  integrationName: string;
+} & ContactChangeEvent;