feat(messaging): support receiving proactive messages (#5728)

* feat(messaging): support receiving proactive messages

* proactive-trigger

* add schema validation

* remove proactive-trigger change

packages/bp/src/core/messaging/messaging-router.ts

@@ -30,6 +30,13 @@ export class MessagingRouter extends CustomRouter {
           }
 
           await this.messaging.receive(event.data as MessageNewEventData)
+        } else if (event.type === 'conversation.started') {
+          const { error } = ConversationStartedEventSchema.validate(event.data)
+          if (error) {
+            return res.status(400).send(error.message)
+          }
+
+          await this.messaging.conversationStarted(event.data as ConversationStartedEventData)
         } else if (event.type === 'user.new') {
           this.messaging.incrementNewUsersCount()
         }
@@ -69,8 +76,15 @@ export interface MessageNewEventData {
   collect: boolean
 }
 
+export interface ConversationStartedEventData {
+  clientId: string
+  userId: string
+  conversationId: string
+  channel: string
+}
+
 interface MessagingEvent {
-  type: 'message.new' | 'user.new'
+  type: 'message.new' | 'conversation.started' | 'user.new'
   data: any
 }
 
@@ -92,3 +106,12 @@ const MessageNewEventSchema = joi
       .required()
   })
   .required()
+
+const ConversationStartedEventSchema = joi
+  .object({
+    clientId: joi.string().required(),
+    userId: joi.string().required(),
+    conversationId: joi.string().required(),
+    channel: joi.string().required()
+  })
+  .required()

packages/bp/src/core/messaging/messaging-service.ts

@@ -10,7 +10,7 @@ import { AppLifecycle, AppLifecycleEvents } from 'lifecycle'
 import LRUCache from 'lru-cache'
 import ms from 'ms'
 import yn from 'yn'
-import { MessageNewEventData } from './messaging-router'
+import { MessageNewEventData, ConversationStartedEventData } from './messaging-router'
 
 @injectable()
 export class MessagingService {
@@ -158,6 +158,24 @@ export class MessagingService {
     return this.eventEngine.sendEvent(event)
   }
 
+  async conversationStarted(msg: ConversationStartedEventData) {
+    if (!this.channelNames.includes(msg.channel)) {
+      return
+    }
+
+    const event = Event({
+      direction: 'incoming',
+      type: 'proactive-trigger',
+      payload: {},
+      channel: msg.channel,
+      threadId: msg.conversationId,
+      target: msg.userId,
+      botId: this.botsByClientId[msg.clientId]
+    })
+
+    return this.eventEngine.sendEvent(event)
+  }
+
   private async fixOutgoingUrls(event: IO.OutgoingEvent, next: IO.MiddlewareNextCallback) {
     this.fixPayloadUrls(event.payload)
     next()