@juzi/wechaty-puppet-service 1.0.73 → 1.0.75

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-puppet-service",
-  "version": "1.0.73",
+  "version": "1.0.75",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {
@@ -51,7 +51,7 @@
     "@chatie/eslint-config": "^1.0.4",
     "@chatie/semver": "^0.4.7",
     "@chatie/tsconfig": "^4.6.3",
-    "@juzi/wechaty-puppet": "^1.0.64",
+    "@juzi/wechaty-puppet": "^1.0.66",
     "@juzi/wechaty-puppet-mock": "^1.0.1",
     "@swc/core": "1.3.39",
     "@types/google-protobuf": "^3.15.5",
@@ -68,10 +68,10 @@
     "why-is-node-running": "^2.2.1"
   },
   "peerDependencies": {
-    "@juzi/wechaty-puppet": "^1.0.62"
+    "@juzi/wechaty-puppet": "^1.0.66"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.67",
+    "@juzi/wechaty-grpc": "^1.0.68",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",
     "file-box": "^1.5.5",

package/src/client/payload-store.ts

@@ -51,7 +51,7 @@ class PayloadStore {
   public room?         : FlashStore<string, PUPPET.payloads.Room>
   public tag?          : FlashStore<string, PUPPET.payloads.Tag>
   public tagGroup?     : FlashStore<string, PUPPET.payloads.TagGroup>
-  public miscellaneous : FlashStore<string, string>
+  public miscellaneous?: FlashStore<string, string>
 
   protected storeDir:   string
   protected accountId?: string
@@ -72,7 +72,11 @@ class PayloadStore {
       fs.mkdirSync(this.storeDir, { recursive: true })
     }
 
-    this.miscellaneous = new FlashStore(path.join(this.storeDir, 'miscellaneous')) // account-free data
+    try {
+      this.miscellaneous = new FlashStore(path.join(this.storeDir, 'miscellaneous')) // account-free data
+    } catch (e) {
+      log.error('PayloadStore', 'constructor() store failed to init, will continue without it.')
+    }
   }
 
   /**
@@ -155,7 +159,7 @@ class PayloadStore {
       throw new Error('Can not destroy() a start()-ed store. Call stop() to stop it first')
     }
 
-    await this.miscellaneous.close()
+    await this.miscellaneous?.close()
 
     /**
      * Huan(202108): `fs.rm` was introduced from Node.js v14.14

package/src/client/puppet-service.ts

@@ -50,7 +50,7 @@ import { packageJson }  from '../package-json.js'
 
 import { GrpcManager }  from './grpc-manager.js'
 import { PayloadStore } from './payload-store.js'
-import { OptionalBooleanUnwrapper, OptionalBooleanWrapper, callRecordPbToPayload, channelPayloadToPb, channelPbToPayload, postPayloadToPb, urlLinkPbToPayload } from '../utils/pb-payload-helper.js'
+import { OptionalBooleanUnwrapper, OptionalBooleanWrapper, callRecordPbToPayload, channelPayloadToPb, channelPbToPayload, chatHistoryPbToPayload, postPayloadToPb, urlLinkPbToPayload } from '../utils/pb-payload-helper.js'
 import type { MessageBroadcastTargets } from '@juzi/wechaty-puppet/dist/esm/src/schemas/message.js'
 import { timeoutPromise } from 'gerror'
 import { BooleanIndicator } from 'state-switch'
@@ -143,9 +143,9 @@ class PuppetService extends PUPPET.Puppet {
       this._grpcManager = undefined
     }
 
-    log.verbose('PuppetService', 'start() instanciating GrpcManager ...')
+    log.info('PuppetService', 'start() instanciating GrpcManager ...')
     const grpcManager = new GrpcManager(this.options)
-    log.verbose('PuppetService', 'start() instanciating GrpcManager ... done')
+    log.info('PuppetService', 'start() instanciating GrpcManager ... done')
 
     /**
      * Huan(202108): when we started the event stream,
@@ -153,35 +153,35 @@ class PuppetService extends PUPPET.Puppet {
      */
     this._grpcManager = grpcManager
 
-    log.verbose('PuppetService', 'start() setting up bridge grpc event stream ...')
+    log.info('PuppetService', 'start() setting up bridge grpc event stream ...')
     this.bridgeGrpcEventStream(grpcManager)
-    log.verbose('PuppetService', 'start() setting up bridge grpc event stream ... done')
+    log.info('PuppetService', 'start() setting up bridge grpc event stream ... done')
 
-    log.verbose('PuppetService', 'start() starting grpc manager...')
+    log.info('PuppetService', 'start() starting grpc manager...')
     const { lastEventSeq } = await this.getEventData()
-    const accountId = await this._payloadStore.miscellaneous.get('accountId')
+    const accountId = await this._payloadStore.miscellaneous?.get('accountId') || ''
     await grpcManager.start(lastEventSeq, accountId)
-    log.verbose('PuppetService', 'start() starting grpc manager... done')
+    log.info('PuppetService', 'start() starting grpc manager... done')
 
-    log.verbose('PuppetService', 'start healthCheck')
+    log.info('PuppetService', 'start healthCheck')
     this.startHealthCheck()
 
-    log.verbose('PuppetService', 'onStart() ... done')
+    log.info('PuppetService', 'onStart() ... done')
   }
 
   override async onStop (): Promise<void> {
-    log.verbose('PuppetService', 'onStop()')
+    log.info('PuppetService', 'onStop()')
 
     if (this._grpcManager) {
-      log.verbose('PuppetService', 'onStop() stopping grpc manager ...')
+      log.info('PuppetService', 'onStop() stopping grpc manager ...')
       const grpcManager = this._grpcManager
       this._grpcManager = undefined
       await grpcManager.stop()
-      log.verbose('PuppetService', 'onStop() stopping grpc manager ... done')
+      log.info('PuppetService', 'onStop() stopping grpc manager ... done')
     }
 
-    log.verbose('PuppetService', 'onStop() ... done')
-    log.verbose('PuppetService', 'stop healthCheck')
+    log.info('PuppetService', 'onStop() ... done')
+    log.info('PuppetService', 'stop healthCheck')
     this.stopHealthCheck()
   }
 
@@ -262,10 +262,12 @@ class PuppetService extends PUPPET.Puppet {
     }
 
     if (seq) {
-      const lastEventSeq = await this._payloadStore.miscellaneous.get('eventSeq')
-      if (!lastEventSeq || (seq > Number(lastEventSeq) || seq === 1)) {
-        await this._payloadStore.miscellaneous.set('eventSeq', String(seq))
-        await this._payloadStore.miscellaneous.set('eventTimestamp', timestamp)
+      if (this._payloadStore.miscellaneous) {
+        const lastEventSeq = await this._payloadStore.miscellaneous.get('eventSeq')
+        if (!lastEventSeq || (seq > Number(lastEventSeq) || seq === 1)) {
+          await this._payloadStore.miscellaneous.set('eventSeq', String(seq))
+          await this._payloadStore.miscellaneous.set('eventTimestamp', timestamp)
+        }
       }
     }
 
@@ -289,12 +291,14 @@ class PuppetService extends PUPPET.Puppet {
             return
           }
           const loginPayload = JSON.parse(payload) as PUPPET.payloads.EventLogin
-          const accountId = await this._payloadStore.miscellaneous.get('accountId')
-          if (accountId !== loginPayload.contactId) {
-            await this._payloadStore.miscellaneous.delete('eventSeq')
+          if (this._payloadStore.miscellaneous) {
+            const accountId = await this._payloadStore.miscellaneous.get('accountId')
+            if (accountId !== loginPayload.contactId) {
+              await this._payloadStore.miscellaneous.delete('eventSeq')
+            }
+            await this._payloadStore.miscellaneous.set('accountId', loginPayload.contactId)
           }
-          await this._payloadStore.miscellaneous.set('accountId', loginPayload.contactId)
-          ;(
+          (
             async () => this.login(loginPayload.contactId)
           )().catch(e =>
             log.error('PuppetService', 'onGrpcStreamEvent() this.login() rejection %s',
@@ -306,7 +310,7 @@ class PuppetService extends PUPPET.Puppet {
       case grpcPuppet.EventType.EVENT_TYPE_LOGOUT:
         {
           const logoutPayload = JSON.parse(payload) as PUPPET.payloads.EventLogout
-          await this._payloadStore.miscellaneous.delete('accountId')
+          await this._payloadStore.miscellaneous?.delete('accountId')
           ;(
             async () => this.logout(logoutPayload.data)
           )().catch(e =>
@@ -1017,6 +1021,24 @@ class PuppetService extends PUPPET.Puppet {
     return payload
   }
 
+  override async messageChatHistory (
+    messageId: string,
+  ): Promise<PUPPET.payloads.ChatHistory[]> {
+    log.verbose('PuppetService', 'messageChatHistory(%s)', messageId)
+
+    const request = new grpcPuppet.MessageChatHistoryRequest()
+    request.setId(messageId)
+
+    const response = await util.promisify(
+      this.grpcManager.client.messageChatHistory
+        .bind(this.grpcManager.client),
+    )(request)
+
+    const payload = chatHistoryPbToPayload(this.FileBoxUuid, response.getChatHistoryListList()!)
+
+    return payload
+  }
+
   override async messageSendMiniProgram (
     conversationId     : string,
     miniProgramPayload : PUPPET.payloads.MiniProgram,
@@ -1179,22 +1201,29 @@ class PuppetService extends PUPPET.Puppet {
 
   override async messageForward (
     conversationId: string,
-    messageId: string,
+    messageIds: string | string[],
   ): Promise<string | void> {
-    log.verbose('PuppetService', 'messageForward(%s, %s)', conversationId, messageId)
+    log.verbose('PuppetService', 'messageForward(%s, %s)', conversationId, messageIds)
 
     const request = new grpcPuppet.MessageForwardRequest()
     request.setConversationId(conversationId)
-    request.setMessageId(messageId)
+    if (Array.isArray(messageIds)) {
+      request.setMessageIdsList(messageIds)
+      if (messageIds.length === 1) {
+        request.setMessageId(messageIds[0] as string)
+      }
+    } else {
+      request.setMessageId(messageIds)
+    }
 
-    log.info('PuppetService', `messageForward(${conversationId}, ${messageId}) about to call grpc`)
+    log.info('PuppetService', `messageForward(${conversationId}, ${messageIds}) 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}`)
+    log.info('PuppetService', `messageForward(${conversationId}, ${messageIds}) grpc called, messageId: ${forwardedMessageId}`)
 
     if (forwardedMessageId) {
       return forwardedMessageId
@@ -2649,7 +2678,7 @@ class PuppetService extends PUPPET.Puppet {
     return contactIdsList
   }
 
-  healthCheckInterval?: NodeJS.Timer
+  healthCheckInterval?: NodeJS.Timeout
   startHealthCheck () {
     this.healthCheckInterval = setInterval(() => {
       this.ding('healthCheck')
@@ -2686,7 +2715,7 @@ class PuppetService extends PUPPET.Puppet {
 
     this.grpcManager.stopStream()
     const { lastEventSeq } = await this.getEventData()
-    const accountId = await this._payloadStore.miscellaneous.get('accountId')
+    const accountId = await this._payloadStore.miscellaneous?.get('accountId') || ''
 
     const onLoginResolve = (resolve: () => void) => {
       const onLogin = (event: grpcPuppet.EventResponse) => {
@@ -2771,8 +2800,8 @@ class PuppetService extends PUPPET.Puppet {
   }
 
   async getEventData () {
-    const lastEventTimestamp = await this._payloadStore.miscellaneous.get('eventTimestamp')
-    let lastEventSeq = await this._payloadStore.miscellaneous.get('eventSeq')
+    const lastEventTimestamp = await this._payloadStore.miscellaneous?.get('eventTimestamp') || 0
+    let lastEventSeq = await this._payloadStore.miscellaneous?.get('eventSeq')
     if ((Date.now() - Number(lastEventTimestamp || 0)) > this.timeoutMilliseconds) {
       log.warn(`last event was ${(Date.now() - Number(lastEventTimestamp || 0)) / 1000} seconds ago, will not request event cache`)
       lastEventSeq = undefined

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.73",
+  "version": "1.0.75",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {
@@ -55,7 +55,7 @@ export const packageJson: PackageJson = {
     "@chatie/eslint-config": "^1.0.4",
     "@chatie/semver": "^0.4.7",
     "@chatie/tsconfig": "^4.6.3",
-    "@juzi/wechaty-puppet": "^1.0.64",
+    "@juzi/wechaty-puppet": "^1.0.66",
     "@juzi/wechaty-puppet-mock": "^1.0.1",
     "@swc/core": "1.3.39",
     "@types/google-protobuf": "^3.15.5",
@@ -72,10 +72,10 @@ export const packageJson: PackageJson = {
     "why-is-node-running": "^2.2.1"
   },
   "peerDependencies": {
-    "@juzi/wechaty-puppet": "^1.0.62"
+    "@juzi/wechaty-puppet": "^1.0.66"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.67",
+    "@juzi/wechaty-grpc": "^1.0.68",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",
     "file-box": "^1.5.5",

package/src/server/puppet-implementation.ts

@@ -43,7 +43,7 @@ import {
 import { log } from '../config.js'
 import { grpcError }          from './grpc-error.js'
 import { EventStreamManager } from './event-stream-manager.js'
-import { OptionalBooleanUnwrapper, OptionalBooleanWrapper, callRecordPayloadToPb, channelPayloadToPb, postPbToPayload, urlLinkPayloadToPb } from '../utils/pb-payload-helper.js'
+import { OptionalBooleanUnwrapper, OptionalBooleanWrapper, callRecordPayloadToPb, channelPayloadToPb, chatHistoryPayloadToPb, postPbToPayload, urlLinkPayloadToPb } from '../utils/pb-payload-helper.js'
 
 function puppetImplementation (
   puppet      : PUPPET.impls.PuppetInterface,
@@ -701,8 +701,14 @@ function puppetImplementation (
       try {
         const conversationId = call.request.getConversationId()
         const messageId = call.request.getMessageId()
+        const messageIds = call.request.getMessageIdsList()
 
         const id = await puppet.messageForward(conversationId, messageId)
+        if (messageIds.length > 1) {
+          await puppet.messageForward(conversationId, messageIds)
+        } else {
+          await puppet.messageForward(conversationId, messageId || messageId[0] || '')
+        }
 
         const response = new grpcPuppet.MessageForwardResponse()
         if (id) {
@@ -843,6 +849,27 @@ function puppetImplementation (
       }
     },
 
+    messageChatHistory: async (call, callback) => {
+      log.verbose('PuppetServiceImpl', 'messageChatHistory()')
+
+      try {
+        const id = call.request.getId()
+
+        const payloadList = await puppet.messageChatHistory(id)
+
+        const response = new grpcPuppet.MessageChatHistoryResponse()
+
+        const pbChatHistoryPayloadList = await chatHistoryPayloadToPb(grpcPuppet, payloadList, serializeFileBox)
+
+        response.setChatHistoryListList(pbChatHistoryPayloadList)
+
+        return callback(null, response)
+
+      } catch (e) {
+        return grpcError('messageMiniProgram', e, callback)
+      }
+    },
+
     messagePayload: async (call, callback) => {
       log.verbose('PuppetServiceImpl', 'messagePayload()')
 

package/src/utils/pb-payload-helper.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-case-declarations */
 import {
   puppet,
 } from '@juzi/wechaty-grpc'
@@ -39,6 +40,25 @@ export const urlLinkPayloadToPb = (grpcPuppet: grpcPuppet, urlLinkPayload: PUPPE
   return pbUrlLinkPayload
 }
 
+export const locationPayloadToPb = (grpcPuppet: grpcPuppet, locationPayload: PUPPET.payloads.Location) => {
+  const pbLocationPayload = new grpcPuppet.LocationPayload()
+  pbLocationPayload.setLatitude(locationPayload.latitude)
+  pbLocationPayload.setLongitude(locationPayload.longitude)
+  pbLocationPayload.setAccuracy(locationPayload.accuracy)
+  pbLocationPayload.setAddress(locationPayload.address)
+  pbLocationPayload.setName(locationPayload.name)
+  return pbLocationPayload
+}
+
+export const locationPbToPayload = (locationPayloadPb: puppet.LocationPayload) => {
+  const _locationPayloadPb = locationPayloadPb.toObject()
+  const payload: PUPPET.payloads.Location = {
+    ..._locationPayloadPb,
+  }
+
+  return payload
+}
+
 export const urlLinkPbToPayload = (urlLinkPayloadPb: puppet.UrlLinkPayload) => {
   const _urlLinkPayloadPb = urlLinkPayloadPb.toObject()
   const urlLinkPayload: PUPPET.payloads.UrlLink = {
@@ -116,13 +136,8 @@ export const postPayloadToPb = async (grpcPuppet: grpcPuppet, payload: PUPPET.pa
   if (payload.rootId) { pb.setRootId(payload.rootId) }
   if (payload.parentId) { pb.setParentId(payload.parentId) }
   if (payload.location) {
-    const location = new grpcPuppet.LocationPayload()
-    location.setAccuracy(payload.location.accuracy)
-    location.setAddress(payload.location.address)
-    location.setName(payload.location.name)
-    location.setLatitude(payload.location.latitude)
-    location.setLongitude(payload.location.longitude)
-    pb.setLocation(location)
+    const pbLocationPayload = locationPayloadToPb(grpcPuppet, payload.location)
+    pb.setLocation(pbLocationPayload)
   }
   pb.setVisibleListList(payload.visibleList || [])
   return pb
@@ -243,3 +258,115 @@ export const callRecordPayloadToPb = (grpcPuppet: grpcPuppet, callRecordPayload:
 
   return pbCallRecordPayload
 }
+
+export const chatHistoryPbToPayload = (FileBoxUuid: typeof FileBox, chatHistoryPb: puppet.ChatHistoryPayload[]) => {
+  const chatHistoryPayloadList: PUPPET.payloads.ChatHistory[] = []
+  for (const payload of chatHistoryPb) {
+    const jsonText = payload.getAvatar()
+
+    const chatHistoryContent = payload.getMessage()
+
+    if (!chatHistoryContent) {
+      continue
+    }
+
+    let message: any
+    switch (chatHistoryContent.getType()) {
+      case puppet.ChatHistoryContentType.TEXT:
+        message = chatHistoryContent.getText()!
+        break
+      case puppet.ChatHistoryContentType.FILE:
+        message = chatHistoryContent.getFileBox()!
+        break
+      case puppet.ChatHistoryContentType.LOCATION:
+        message = locationPbToPayload(chatHistoryContent.getLocation()!)
+        break
+      case puppet.ChatHistoryContentType.URL:
+        message = urlLinkPbToPayload(chatHistoryContent.getUrlLink()!)
+        break
+      case puppet.ChatHistoryContentType.MINI_PROGRAM:
+        message = miniProgramPbToPayload(chatHistoryContent.getMiniProgram()!)
+        break
+      case puppet.ChatHistoryContentType.CHANNEL:
+        message = channelPbToPayload(chatHistoryContent.getChannel()!)
+        break
+      case puppet.ChatHistoryContentType.CHAT_HISTORY:
+        message = chatHistoryPbToPayload(FileBoxUuid, chatHistoryContent.getChatHistoryList()!)
+        break
+      default:
+        throw new Error(`Invalid chat history content type: ${chatHistoryContent.getType()}`)
+    }
+
+    const chatHistoryPayload: PUPPET.payloads.ChatHistory = {
+      type: payload.getType(),
+      avatar: FileBoxUuid.fromJSON(jsonText),
+      senderName: payload.getSenderName(),
+      corpName: payload.getCorpName(),
+      time: payload.getTime(),
+      message,
+    }
+    chatHistoryPayloadList.push(chatHistoryPayload)
+  }
+  return chatHistoryPayloadList
+}
+
+export const chatHistoryPayloadToPb = async (grpcPuppet: grpcPuppet, chatHistoryPayloadList: PUPPET.payloads.ChatHistory[], serializeFileBox: (fileBox: FileBoxInterface) => Promise<string>) => {
+  const list = []
+  for (const chatHistoryPayload of chatHistoryPayloadList) {
+    const pbChatHistoryPayload = new grpcPuppet.ChatHistoryPayload()
+
+    pbChatHistoryPayload.setType(chatHistoryPayload.type)
+    const avatarSerializedFileBox = await serializeFileBox(chatHistoryPayload.avatar)
+    pbChatHistoryPayload.setAvatar(avatarSerializedFileBox)
+    pbChatHistoryPayload.setSenderName(chatHistoryPayload.senderName)
+    pbChatHistoryPayload.setCorpName(chatHistoryPayload.corpName)
+    pbChatHistoryPayload.setTime(chatHistoryPayload.time)
+
+    const pbChatHistoryContent = new grpcPuppet.ChatHistoryContent()
+    switch (chatHistoryPayload.type) {
+      case PUPPET.types.Message.Text:
+      case PUPPET.types.Message.Contact:
+        pbChatHistoryContent.setType(grpcPuppet.ChatHistoryContentType.TEXT)
+        pbChatHistoryContent.setText(chatHistoryPayload.message)
+        break
+      case PUPPET.types.Message.Image:
+      case PUPPET.types.Message.Attachment:
+      case PUPPET.types.Message.Video:
+        pbChatHistoryContent.setType(grpcPuppet.ChatHistoryContentType.FILE)
+        pbChatHistoryContent.setFileBox(await serializeFileBox(chatHistoryPayload.message))
+        break
+      case PUPPET.types.Message.Location:
+        pbChatHistoryContent.setType(grpcPuppet.ChatHistoryContentType.LOCATION)
+        const pbLocationPayload = locationPayloadToPb(grpcPuppet, chatHistoryPayload.message)
+        pbChatHistoryContent.setLocation(pbLocationPayload)
+        break
+      case PUPPET.types.Message.Url:
+        pbChatHistoryContent.setType(grpcPuppet.ChatHistoryContentType.URL)
+        const pbUrlLinkPayload = urlLinkPayloadToPb(grpcPuppet, chatHistoryPayload.message)
+        pbChatHistoryContent.setUrlLink(pbUrlLinkPayload)
+        break
+      case PUPPET.types.Message.MiniProgram:
+        pbChatHistoryContent.setType(grpcPuppet.ChatHistoryContentType.MINI_PROGRAM)
+        const pbMiniProgramPayload = miniProgramPayloadToPb(grpcPuppet, chatHistoryPayload.message)
+        pbChatHistoryContent.setMiniProgram(pbMiniProgramPayload)
+        break
+      case PUPPET.types.Message.Channel:
+        pbChatHistoryContent.setType(grpcPuppet.ChatHistoryContentType.CHANNEL)
+        const pbChannelPayload = channelPayloadToPb(grpcPuppet, chatHistoryPayload.message)
+        pbChatHistoryContent.setChannel(pbChannelPayload)
+        break
+      case PUPPET.types.Message.ChatHistory:
+        pbChatHistoryContent.setType(grpcPuppet.ChatHistoryContentType.CHAT_HISTORY)
+        const pbChatHistoryPayload = await chatHistoryPayloadToPb(grpcPuppet, chatHistoryPayload.message, serializeFileBox)
+        pbChatHistoryContent.setChatHistoryList(pbChatHistoryPayload)
+        break
+      default:
+        throw new Error(`ChatHistoryContent unsupported type ${chatHistoryPayload.type}`)
+    }
+    pbChatHistoryPayload.setMessage(pbChatHistoryContent)
+
+    list.push(pbChatHistoryPayload)
+  }
+
+  return list
+}