feat: pusher event integration

Author: DavidsonGomes

.env.example

@@ -88,6 +88,41 @@ SQS_REGION=
 WEBSOCKET_ENABLED=false
 WEBSOCKET_GLOBAL_EVENTS=false
 
+# Pusher - Environment variables
+PUSHER_ENABLED=false
+PUSHER_GLOBAL_ENABLED=false
+PUSHER_GLOBAL_APP_ID=
+PUSHER_GLOBAL_KEY=
+PUSHER_GLOBAL_SECRET=
+PUSHER_GLOBAL_CLUSTER=
+PUSHER_GLOBAL_USE_TLS=true
+# Choose the events you want to send to Pusher
+PUSHER_EVENTS_APPLICATION_STARTUP=true
+PUSHER_EVENTS_QRCODE_UPDATED=true
+PUSHER_EVENTS_MESSAGES_SET=true
+PUSHER_EVENTS_MESSAGES_UPSERT=true
+PUSHER_EVENTS_MESSAGES_EDITED=true
+PUSHER_EVENTS_MESSAGES_UPDATE=true
+PUSHER_EVENTS_MESSAGES_DELETE=true
+PUSHER_EVENTS_SEND_MESSAGE=true
+PUSHER_EVENTS_CONTACTS_SET=true
+PUSHER_EVENTS_CONTACTS_UPSERT=true
+PUSHER_EVENTS_CONTACTS_UPDATE=true
+PUSHER_EVENTS_PRESENCE_UPDATE=true
+PUSHER_EVENTS_CHATS_SET=true
+PUSHER_EVENTS_CHATS_UPSERT=true
+PUSHER_EVENTS_CHATS_UPDATE=true
+PUSHER_EVENTS_CHATS_DELETE=true
+PUSHER_EVENTS_GROUPS_UPSERT=true
+PUSHER_EVENTS_GROUPS_UPDATE=true
+PUSHER_EVENTS_GROUP_PARTICIPANTS_UPDATE=true
+PUSHER_EVENTS_CONNECTION_UPDATE=true
+PUSHER_EVENTS_LABELS_EDIT=true
+PUSHER_EVENTS_LABELS_ASSOCIATION=true
+PUSHER_EVENTS_CALL=true
+PUSHER_EVENTS_TYPEBOT_START=false
+PUSHER_EVENTS_TYPEBOT_CHANGE_STATUS=false
+
 # WhatsApp Business API - Environment variables
 # Token used to validate the webhook on the Facebook APP
 WA_BUSINESS_TOKEN_WEBHOOK=evolution

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Fake Call function
 * Added unreadMessages to chats
+* Pusher event integration
 
 ### Fixed
 

package.json

@@ -82,6 +82,7 @@
     "pg": "^8.11.3",
     "pino": "^8.11.0",
     "prisma": "^5.15.0",
+    "pusher": "^5.2.0",
     "qrcode": "^1.5.1",
     "qrcode-terminal": "^0.12.0",
     "redis": "^4.6.5",

prisma/mysql-schema.prisma

@@ -104,6 +104,7 @@ model Instance {
   EvolutionBotSetting     EvolutionBotSetting?
   Flowise                 Flowise[]
   FlowiseSetting          FlowiseSetting?
+  Pusher                  Pusher?
 }
 
 model Session {
@@ -289,6 +290,21 @@ model Websocket {
   instanceId String    @unique
 }
 
+model Pusher {
+  id         String    @id @default(cuid())
+  enabled    Boolean   @default(false)
+  appId      String    @db.VarChar(100)
+  key        String    @db.VarChar(100)
+  secret     String    @db.VarChar(100)
+  cluster    String    @db.VarChar(100)
+  useTLS     Boolean   @default(false)
+  events     Json      @db.Json
+  createdAt  DateTime? @default(dbgenerated("CURRENT_TIMESTAMP")) @db.Timestamp
+  updatedAt  DateTime  @updatedAt @db.Timestamp
+  Instance   Instance  @relation(fields: [instanceId], references: [id], onDelete: Cascade)
+  instanceId String    @unique
+}
+
 model Typebot {
   id              String           @id @default(cuid())
   enabled         Boolean          @default(true)

prisma/postgresql-migrations/20241011085129_create_pusher_table/migration.sql

@@ -0,0 +1,22 @@
+-- CreateTable
+CREATE TABLE "Pusher" (
+    "id" TEXT NOT NULL,
+    "enabled" BOOLEAN NOT NULL DEFAULT false,
+    "appId" VARCHAR(100) NOT NULL,
+    "key" VARCHAR(100) NOT NULL,
+    "secret" VARCHAR(100) NOT NULL,
+    "cluster" VARCHAR(100) NOT NULL,
+    "useTLS" BOOLEAN NOT NULL DEFAULT false,
+    "events" JSONB NOT NULL,
+    "createdAt" TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP NOT NULL,
+    "instanceId" TEXT NOT NULL,
+
+    CONSTRAINT "Pusher_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Pusher_instanceId_key" ON "Pusher"("instanceId");
+
+-- AddForeignKey
+ALTER TABLE "Pusher" ADD CONSTRAINT "Pusher_instanceId_fkey" FOREIGN KEY ("instanceId") REFERENCES "Instance"("id") ON DELETE CASCADE ON UPDATE CASCADE;

prisma/postgresql-schema.prisma

@@ -104,6 +104,7 @@ model Instance {
   EvolutionBotSetting     EvolutionBotSetting?
   Flowise                 Flowise[]
   FlowiseSetting          FlowiseSetting?
+  Pusher                  Pusher?
 }
 
 model Session {
@@ -115,15 +116,15 @@ model Session {
 }
 
 model Chat {
-  id         String    @id @default(cuid())
-  remoteJid  String    @db.VarChar(100)
-  name       String?   @db.VarChar(100)
-  labels     Json?     @db.JsonB
-  createdAt  DateTime? @default(now()) @db.Timestamp
-  updatedAt  DateTime? @updatedAt @db.Timestamp
-  Instance   Instance  @relation(fields: [instanceId], references: [id], onDelete: Cascade)
-  instanceId String
-  unreadMessages Int @default(0)
+  id             String    @id @default(cuid())
+  remoteJid      String    @db.VarChar(100)
+  name           String?   @db.VarChar(100)
+  labels         Json?     @db.JsonB
+  createdAt      DateTime? @default(now()) @db.Timestamp
+  updatedAt      DateTime? @updatedAt @db.Timestamp
+  Instance       Instance  @relation(fields: [instanceId], references: [id], onDelete: Cascade)
+  instanceId     String
+  unreadMessages Int       @default(0)
 }
 
 model Contact {
@@ -291,6 +292,21 @@ model Websocket {
   instanceId String    @unique
 }
 
+model Pusher {
+  id         String    @id @default(cuid())
+  enabled    Boolean   @default(false) @db.Boolean
+  appId      String    @db.VarChar(100)
+  key        String    @db.VarChar(100)
+  secret     String    @db.VarChar(100)
+  cluster    String    @db.VarChar(100)
+  useTLS     Boolean   @default(false) @db.Boolean
+  events     Json      @db.JsonB
+  createdAt  DateTime? @default(now()) @db.Timestamp
+  updatedAt  DateTime  @updatedAt @db.Timestamp
+  Instance   Instance  @relation(fields: [instanceId], references: [id], onDelete: Cascade)
+  instanceId String    @unique
+}
+
 model Typebot {
   id              String           @id @default(cuid())
   enabled         Boolean          @default(true) @db.Boolean

src/api/integrations/event/event.controller.ts

@@ -7,7 +7,7 @@ export type EmitData = {
   instanceName: string;
   origin: string;
   event: string;
-  data: Object;
+  data: any;
   serverUrl: string;
   dateTime: string;
   sender: string;
@@ -22,7 +22,7 @@ export interface EventControllerInterface {
 }
 
 export class EventController {
-  private prismaRepository: PrismaRepository;
+  public prismaRepository: PrismaRepository;
   private waMonitor: WAMonitoringService;
   private integrationStatus: boolean;
   private integrationName: string;

src/api/integrations/event/event.dto.ts

@@ -25,6 +25,16 @@ export class EventDto {
     enabled?: boolean;
     events?: string[];
   };
+
+  pusher?: {
+    enabled?: boolean;
+    appId?: string;
+    key?: string;
+    secret?: string;
+    cluster?: string;
+    useTLS?: boolean;
+    events?: string[];
+  };
 }
 
 export function EventInstanceMixin<TBase extends Constructor>(Base: TBase) {
@@ -52,5 +62,15 @@ export function EventInstanceMixin<TBase extends Constructor>(Base: TBase) {
       enabled?: boolean;
       events?: string[];
     };
+
+    pusher?: {
+      enabled?: boolean;
+      appId?: string;
+      key?: string;
+      secret?: string;
+      cluster?: string;
+      useTLS?: boolean;
+      events?: string[];
+    };
   };
 }

src/api/integrations/event/event.manager.ts

@@ -1,3 +1,4 @@
+import { PusherController } from '@api/integrations/event/pusher/pusher.controller';
 import { RabbitmqController } from '@api/integrations/event/rabbitmq/rabbitmq.controller';
 import { SqsController } from '@api/integrations/event/sqs/sqs.controller';
 import { WebhookController } from '@api/integrations/event/webhook/webhook.controller';
@@ -13,6 +14,7 @@ export class EventManager {
   private webhookController: WebhookController;
   private rabbitmqController: RabbitmqController;
   private sqsController: SqsController;
+  private pusherController: PusherController;
 
   constructor(prismaRepository: PrismaRepository, waMonitor: WAMonitoringService) {
     this.prisma = prismaRepository;
@@ -22,6 +24,7 @@ export class EventManager {
     this.webhook = new WebhookController(prismaRepository, waMonitor);
     this.rabbitmq = new RabbitmqController(prismaRepository, waMonitor);
     this.sqs = new SqsController(prismaRepository, waMonitor);
+    this.pusher = new PusherController(prismaRepository, waMonitor);
   }
 
   public set prisma(prisma: PrismaRepository) {
@@ -72,10 +75,18 @@ export class EventManager {
     return this.sqsController;
   }
 
+  public set pusher(pusher: PusherController) {
+    this.pusherController = pusher;
+  }
+  public get pusher() {
+    return this.pusherController;
+  }
+
   public init(httpServer: Server): void {
     this.websocket.init(httpServer);
     this.rabbitmq.init();
     this.sqs.init();
+    this.pusher.init();
   }
 
   public async emit(eventData: {
@@ -93,6 +104,7 @@ export class EventManager {
     await this.rabbitmq.emit(eventData);
     await this.sqs.emit(eventData);
     await this.webhook.emit(eventData);
+    await this.pusher.emit(eventData);
   }
 
   public async setInstance(instanceName: string, data: any): Promise<any> {
@@ -131,5 +143,18 @@ export class EventManager {
           byEvents: data.webhook?.byEvents,
         },
       });
+
+    if (data.pusher)
+      await this.pusher.set(instanceName, {
+        pusher: {
+          enabled: true,
+          events: data.pusher?.events,
+          appId: data.pusher?.appId,
+          key: data.pusher?.key,
+          secret: data.pusher?.secret,
+          cluster: data.pusher?.cluster,
+          useTLS: data.pusher?.useTLS,
+        },
+      });
   }
 }

src/api/integrations/event/event.router.ts

@@ -1,3 +1,4 @@
+import { PusherRouter } from '@api/integrations/event/pusher/pusher.router';
 import { RabbitmqRouter } from '@api/integrations/event/rabbitmq/rabbitmq.router';
 import { SqsRouter } from '@api/integrations/event/sqs/sqs.router';
 import { WebhookRouter } from '@api/integrations/event/webhook/webhook.router';
@@ -13,6 +14,7 @@ export class EventRouter {
     this.router.use('/webhook', new WebhookRouter(configService, ...guards).router);
     this.router.use('/websocket', new WebsocketRouter(...guards).router);
     this.router.use('/rabbitmq', new RabbitmqRouter(...guards).router);
+    this.router.use('/pusher', new PusherRouter(...guards).router);
     this.router.use('/sqs', new SqsRouter(...guards).router);
   }
 }