@juzi/wechaty-puppet-service 1.0.10 → 1.0.13

package/src/client/puppet-service.ts

@@ -921,12 +921,14 @@ class PuppetService extends PUPPET.Puppet {
      */
     request.setMiniProgramDeprecated(JSON.stringify(miniProgramPayload))
 
+    log.info('PuppetService', `messageSendMiniProgram(${conversationId}, ${miniProgramPayload.description}) about to call grpc`)
     const response = await util.promisify(
       this.grpcManager.client.messageSendMiniProgram
         .bind(this.grpcManager.client),
     )(request)
 
     const messageId = response.getId()
+    log.info('PuppetService', `messageSendMiniProgram(${conversationId}, ${miniProgramPayload.description}) grpc called, messageId: ${messageId}`)
 
     if (messageId) {
       return messageId
@@ -961,12 +963,14 @@ class PuppetService extends PUPPET.Puppet {
     pbLocationPayload.setName(locationPayload.name)
     request.setLocation(pbLocationPayload)
 
+    log.info('PuppetService', `messageSendLocation(${conversationId}, ${locationPayload.name}) about to call grpc`)
     const response = await util.promisify(
       this.grpcManager.client.messageSendLocation
         .bind(this.grpcManager.client),
     )(request)
 
     const id = response.getId()
+    log.info('PuppetService', `messageSendMiniProgram(${conversationId}, ${locationPayload.name}) grpc called, messageId: ${id}`)
 
     if (id) {
       return id
@@ -993,12 +997,14 @@ class PuppetService extends PUPPET.Puppet {
     if (channelPayload.url) { pbChannelPayload.setUrl(channelPayload.url) }
     request.setChannel(pbChannelPayload)
 
+    log.info('PuppetService', `messageSendChannel(${conversationId}, ${channelPayload.desc}) about to call grpc`)
     const response = await util.promisify(
       this.grpcManager.client.messageSendChannel
         .bind(this.grpcManager.client),
     )(request)
 
     const messageId = response.getId()
+    log.info('PuppetService', `messageSendChannel(${conversationId}, ${channelPayload.desc}) grpc called, messageId: ${messageId}`)
 
     if (messageId) {
       return messageId
@@ -1087,12 +1093,14 @@ class PuppetService extends PUPPET.Puppet {
     request.setConversationId(conversationId)
     request.setMessageId(messageId)
 
+    log.info('PuppetService', `messageForward(${conversationId}, ${messageId}) about to call grpc`)
     const response = await util.promisify(
       this.grpcManager.client.messageForward
         .bind(this.grpcManager.client),
     )(request)
 
     const forwardedMessageId = response.getId()
+    log.info('PuppetService', `messageForward(${conversationId}, ${messageId}) grpc called, messageId: ${forwardedMessageId}`)
 
     if (forwardedMessageId) {
       return forwardedMessageId
@@ -1185,12 +1193,14 @@ class PuppetService extends PUPPET.Puppet {
       request.setQuoteId(quoteId)
     }
 
+    log.info('PuppetService', `messageSend(${conversationId}, ${text}) about to call grpc`)
     const response = await util.promisify(
       this.grpcManager.client.messageSendText
         .bind(this.grpcManager.client),
     )(request)
 
     const messageId = response.getId()
+    log.info('PuppetService', `messageSend(${conversationId}, ${text}) grpc called, messageId: ${messageId}`)
 
     if (messageId) {
       return messageId
@@ -1221,12 +1231,14 @@ class PuppetService extends PUPPET.Puppet {
       const serializedFileBox = await this.serializeFileBox(fileBox)
       request.setFileBox(serializedFileBox)
 
+      log.info('PuppetService', `messageSendFile(${conversationId}, ${fileBox}) about to call grpc`)
       const response = await util.promisify(
         this.grpcManager.client.messageSendFile
           .bind(this.grpcManager.client),
       )(request)
 
       const messageId = response.getId()
+      log.info('PuppetService', `messageSendFile(${conversationId}, ${fileBox}) grpc called, messageId: ${messageId}`)
 
       if (messageId) {
         return messageId
@@ -1265,12 +1277,14 @@ class PuppetService extends PUPPET.Puppet {
     request.setConversationId(conversationId)
     request.setContactId(contactId)
 
+    log.info('PuppetService', `messageSendContact(${conversationId}, ${contactId}) about to call grpc`)
     const response = await util.promisify(
       this.grpcManager.client.messageSendContact
         .bind(this.grpcManager.client),
     )(request)
 
     const messageId = response.getId()
+    log.info('PuppetService', `messageSendContact(${conversationId}, ${contactId}) grpc called, messageId: ${messageId}`)
 
     if (messageId) {
       return messageId
@@ -1307,12 +1321,14 @@ class PuppetService extends PUPPET.Puppet {
     // Deprecated: will be removed after Dec 31, 2022
     request.setUrlLinkDeprecated(JSON.stringify(urlLinkPayload))
 
+    log.info('PuppetService', `messageSendUrl(${conversationId}, ${urlLinkPayload}) about to call grpc`)
     const response = await util.promisify(
       this.grpcManager.client.messageSendUrl
         .bind(this.grpcManager.client),
     )(request)
 
     const messageId = response.getId()
+    log.info('PuppetService', `messageSendUrl(${conversationId}, ${urlLinkPayload}) grpc called, messageId: ${messageId}`)
 
     if (messageId) {
       return messageId

package/src/config.ts

@@ -30,6 +30,7 @@ const GRPC_OPTIONS = {
 export const NO_LOG_EVENTS: grpcPuppet.EventTypeMap[keyof grpcPuppet.EventTypeMap][] = [
   grpcPuppet.EventType.EVENT_TYPE_HEARTBEAT,
   grpcPuppet.EventType.EVENT_TYPE_DONG,
+  grpcPuppet.EventType.EVENT_TYPE_DIRTY,
 ]
 
 export {

package/src/package-json.ts

@@ -4,7 +4,7 @@
 import type { PackageJson } from 'type-fest'
 export const packageJson: PackageJson = {
   "name": "@juzi/wechaty-puppet-service",
-  "version": "1.0.10",
+  "version": "1.0.13",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {

package/src/server/event-stream-manager.ts

@@ -34,6 +34,7 @@ class EventStreamManager {
   protected eventStream: undefined | grpc.ServerWritableStream<grpcPuppet.EventRequest, grpcPuppet.EventResponse>
 
   private puppetListening = false
+  private offCallbackList: (() => void)[] = []
 
   constructor (
     public puppet: PUPPET.impls.PuppetInterface,
@@ -53,10 +54,14 @@ class EventStreamManager {
     if (this.eventStream) {
       throw new Error('can not set twice')
     }
+
+    // clear all listeners before load new ones
+    this.removePuppetListeners()
+
     this.eventStream = stream
 
-    const removeAllListeners = this.connectPuppetEventToStreamingCall()
-    this.onStreamingCallEnd(removeAllListeners)
+    this.connectPuppetEventToStreamingCall()
+    this.onStreamingCallEnd()
 
     /**
      * Huan(202108):
@@ -112,6 +117,7 @@ class EventStreamManager {
       throw new Error('no this.eventStream')
     }
 
+    this.removePuppetListeners()
     this.eventStream.end()
     this.eventStream = undefined
   }
@@ -150,19 +156,9 @@ class EventStreamManager {
     }
   }
 
-  public connectPuppetEventToStreamingCall (): () => void {
+  public connectPuppetEventToStreamingCall () {
     log.verbose('EventStreamManager', 'connectPuppetEventToStreamingCall() for %s', this.puppet)
 
-    const offCallbackList = [] as (() => void)[]
-    const offAll = () => {
-      log.verbose('EventStreamManager',
-        'connectPuppetEventToStreamingCall() offAll() %s callbacks',
-        offCallbackList.length,
-      )
-      offCallbackList.forEach(off => off())
-      this.puppetListening = false
-    }
-
     const eventNameList: PUPPET.types.PuppetEventName[] = Object.keys(PUPPET.types.PUPPET_EVENT_DICT) as PUPPET.types.PuppetEventName[]
     for (const eventName of eventNameList) {
       log.verbose('EventStreamManager',
@@ -176,105 +172,105 @@ class EventStreamManager {
           const listener = (payload: PUPPET.payloads.EventDong) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_DONG, payload)
           this.puppet.on('dong', listener)
           const off = () => this.puppet.off('dong', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'dirty': {
           const listener = (payload: PUPPET.payloads.EventDirty) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_DIRTY, payload)
           this.puppet.on('dirty', listener)
           const off = () => this.puppet.off('dirty', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'error': {
           const listener = (payload: PUPPET.payloads.EventError) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_ERROR, payload)
           this.puppet.on('error', listener)
           const off = () => this.puppet.off('error', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'heartbeat': {
           const listener = (payload: PUPPET.payloads.EventHeartbeat) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_HEARTBEAT, payload)
           this.puppet.on('heartbeat', listener)
           const off = () => this.puppet.off('heartbeat', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'friendship': {
           const listener = (payload: PUPPET.payloads.EventFriendship) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_FRIENDSHIP, payload)
           this.puppet.on('friendship', listener)
           const off = () => this.puppet.off('friendship', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'login': {
           const listener = (payload: PUPPET.payloads.EventLogin) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_LOGIN, payload)
           this.puppet.on('login', listener)
           const off = () => this.puppet.off('login', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'logout': {
           const listener = (payload: PUPPET.payloads.EventLogout) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_LOGOUT, payload)
           this.puppet.on('logout', listener)
           const off = () => this.puppet.off('logout', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'message': {
           const listener = (payload: PUPPET.payloads.EventMessage) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_MESSAGE, payload)
           this.puppet.on('message', listener)
           const off = () => this.puppet.off('message', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'post': {
           const listener = (payload: PUPPET.payloads.EventPost) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_POST, payload)
           this.puppet.on('post', listener)
           const off = () => this.puppet.off('post', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'ready': {
           const listener = (payload: PUPPET.payloads.EventReady) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_READY, payload)
           this.puppet.on('ready', listener)
           const off = () => this.puppet.off('ready', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'room-invite': {
           const listener = (payload: PUPPET.payloads.EventRoomInvite) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_ROOM_INVITE, payload)
           this.puppet.on('room-invite', listener)
           const off = () => this.puppet.off('room-invite', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'room-join': {
           const listener = (payload: PUPPET.payloads.EventRoomJoin) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_ROOM_JOIN, payload)
           this.puppet.on('room-join', listener)
           const off = () => this.puppet.off('room-join', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'room-leave': {
           const listener = (payload: PUPPET.payloads.EventRoomLeave) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_ROOM_LEAVE, payload)
           this.puppet.on('room-leave', listener)
           const off = () => this.puppet.off('room-leave', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'room-topic': {
           const listener = (payload: PUPPET.payloads.EventRoomTopic) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_ROOM_TOPIC, payload)
           this.puppet.on('room-topic', listener)
           const off = () => this.puppet.off('room-topic', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'scan': {
           const listener = (payload: PUPPET.payloads.EventScan) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_SCAN, payload)
           this.puppet.on('scan', listener)
           const off = () => this.puppet.off('scan', listener)
-          offCallbackList.push(off)
+          this.offCallbackList.push(off)
           break
         }
         case 'reset':
@@ -288,17 +284,14 @@ class EventStreamManager {
     }
 
     this.puppetListening = true
-    return offAll
   }
 
   /**
    * Detect if the streaming call was gone (GRPC disconnects)
    *  https://github.com/grpc/grpc/issues/8117#issuecomment-362198092
    */
-  private onStreamingCallEnd (
-    removePuppetListeners: () => void,
-  ): void {
-    log.verbose('EventStreamManager', 'onStreamingCallEnd(callback)')
+  private onStreamingCallEnd () {
+    log.verbose('EventStreamManager', 'onStreamingCallEnd()')
 
     if (!this.eventStream) {
       throw new Error('no this.eventStream found')
@@ -324,7 +317,7 @@ class EventStreamManager {
       )
 
       if (this.puppetListening) {
-        removePuppetListeners()
+        this.removePuppetListeners()
       }
       if (this.eventStream) {
         this.eventStream = undefined
@@ -336,7 +329,7 @@ class EventStreamManager {
     this.eventStream.on('error', err => {
       log.verbose('EventStreamManager', 'this.onStreamingCallEnd() this.eventStream.on(error) fired: %s', err)
       if (this.puppetListening) {
-        removePuppetListeners()
+        this.removePuppetListeners()
       }
       if (this.eventStream) {
         this.eventStream = undefined
@@ -348,7 +341,7 @@ class EventStreamManager {
     this.eventStream.on('finish', () => {
       log.verbose('EventStreamManager', 'this.onStreamingCallEnd() this.eventStream.on(finish) fired')
       if (this.puppetListening) {
-        removePuppetListeners()
+        this.removePuppetListeners()
       }
       if (this.eventStream) {
         this.eventStream = undefined
@@ -360,7 +353,7 @@ class EventStreamManager {
     this.eventStream.on('end', () => {
       log.verbose('EventStreamManager', 'this.onStreamingCallEnd() this.eventStream.on(end) fired')
       if (this.puppetListening) {
-        removePuppetListeners()
+        this.removePuppetListeners()
       }
       if (this.eventStream) {
         this.eventStream = undefined
@@ -372,7 +365,7 @@ class EventStreamManager {
     this.eventStream.on('close', () => {
       log.verbose('EventStreamManager', 'this.onStreamingCallEnd() this.eventStream.on(close) fired')
       if (this.puppetListening) {
-        removePuppetListeners()
+        this.removePuppetListeners()
       }
       if (this.eventStream) {
         this.eventStream = undefined
@@ -382,6 +375,13 @@ class EventStreamManager {
     })
   }
 
+  removePuppetListeners () {
+    while (this.offCallbackList.length > 0) {
+      const func = this.offCallbackList.pop()
+      func && func()
+    }
+  }
+
 }
 
 export { EventStreamManager }