@juzi/wechaty-puppet-service 1.0.105 → 1.0.107

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-puppet-service",
-  "version": "1.0.105",
+  "version": "1.0.107",
   "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.94",
+    "@juzi/wechaty-puppet": "^1.0.105",
     "@juzi/wechaty-puppet-mock": "^1.0.1",
     "@swc/core": "1.3.39",
     "@types/google-protobuf": "^3.15.5",
@@ -73,7 +73,7 @@
     "@juzi/wechaty-puppet": "^1.0.84"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.90",
+    "@juzi/wechaty-grpc": "^1.0.93",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",
     "file-box": "^1.5.5",

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, chatHistoryPbToPayload, postPayloadToPb, urlLinkPbToPayload } from '../utils/pb-payload-helper.js'
+import { OptionalBooleanUnwrapper, OptionalBooleanWrapper, callRecordPbToPayload, channelPayloadToPb, channelPbToPayload, chatHistoryPbToPayload, contactPbToPayload, postPayloadToPb, roomMemberPbToPayload, 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'
@@ -763,6 +763,49 @@ class PuppetService extends PUPPET.Puppet {
     return payload
   }
 
+  override async batchContactRawPayload (contactIdList: string[]): Promise<Map<string, PUPPET.payloads.Contact>> {
+    log.verbose('PuppetService', 'batchContactRawPayload(%s)', contactIdList)
+
+    const result = new Map<string, PUPPET.payloads.Contact>()
+    const contactIdSet = new Set<string>(contactIdList)
+    const needGetSet = new Set<string>()
+    for (const contactId of contactIdSet) {
+      const cachedContactPayload = await this._payloadStore.contact?.get(contactId)
+      if (cachedContactPayload) {
+        result.set(contactId, cachedContactPayload)
+      } else {
+        needGetSet.add(contactId)
+      }
+    }
+
+    if (needGetSet.size > 0) {
+      try {
+        const request = new grpcPuppet.BatchContactPayloadRequest()
+        request.setIdsList(Array.from(needGetSet))
+
+        const response = await util.promisify(
+          this.grpcManager.client.batchContactPayload
+            .bind(this.grpcManager.client),
+        )(request)
+
+        const payloads = response.getContactPayloadsList()
+        for (const payload of payloads) {
+          const contactId = payload.getId()
+          const puppetPayload = contactPbToPayload(payload)
+          result.set(contactId, puppetPayload)
+          await this._payloadStore.contact?.set(contactId, puppetPayload)
+        }
+      } catch (e) {
+        log.error('PuppetService', 'batchContactRawPayload(%s, %s) error: %s, use one by one method', contactIdList, needGetSet, e)
+        for (const contactId of needGetSet) {
+          const payload = await this.contactRawPayload(contactId)
+          result.set(contactId, payload)
+        }
+      }
+    }
+    return result
+  }
+
   override async contactPayloadModify (contactId: string, payload: Partial<PUPPET.payloads.Contact>): Promise<void> {
     log.verbose('PuppetService', 'contactPayloadModify(%s, %s)', contactId, JSON.stringify(payload))
 
@@ -1942,6 +1985,56 @@ class PuppetService extends PUPPET.Puppet {
     return payload
   }
 
+  override async batchRoomMemberRawPayload (roomId: string, contactIdList: string[]): Promise<Map<string, PUPPET.payloads.RoomMember>> {
+    log.verbose('PuppetService', 'batchRoomMemberRawPayload(%s, %s)', roomId, contactIdList)
+
+    const result = new Map<string, PUPPET.payloads.RoomMember>()
+    const contactIdSet = new Set<string>(contactIdList)
+    let needGetSet = new Set<string>()
+    const cachedPayload = await this._payloadStore.roomMember?.get(roomId) || {}
+    if (Object.keys(cachedPayload).length > 0) {
+      for (const contactId of contactIdSet) {
+        const cachedRoomMemberPayload = cachedPayload[contactId]
+        if (cachedRoomMemberPayload) {
+          result.set(contactId, cachedRoomMemberPayload)
+        } else {
+          needGetSet.add(contactId)
+        }
+      }
+    } else {
+      needGetSet = contactIdSet
+    }
+
+    if (needGetSet.size > 0) {
+      try {
+        const request = new grpcPuppet.BatchRoomMemberPayloadRequest()
+        request.setId(roomId)
+        request.setMemberIdsList(Array.from(needGetSet))
+
+        const response = await util.promisify(
+          this.grpcManager.client.batchRoomMemberPayload
+            .bind(this.grpcManager.client),
+        )(request)
+
+        const payloads = response.getMemberPayloadsList()
+        for (const payload of payloads) {
+          const contactId = payload.getId()
+          const puppetPayload = roomMemberPbToPayload(payload)
+          result.set(contactId, puppetPayload)
+          cachedPayload[contactId] = puppetPayload
+        }
+        await this._payloadStore.roomMember?.set(roomId, cachedPayload)
+      } catch (e) {
+        log.error('PuppetService', 'batchRoomMemberRawPayload(%s, %s) error: %s, use one by one method', roomId, needGetSet, e)
+        for (const contactId of needGetSet) {
+          const payload = await this.roomMemberRawPayload(roomId, contactId)
+          result.set(contactId, payload)
+        }
+      }
+    }
+    return result
+  }
+
   override async roomAnnounce (roomId: string)                : Promise<string>
   override async roomAnnounce (roomId: string, text: string)  : Promise<void>
 

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.105",
+  "version": "1.0.107",
   "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.94",
+    "@juzi/wechaty-puppet": "^1.0.105",
     "@juzi/wechaty-puppet-mock": "^1.0.1",
     "@swc/core": "1.3.39",
     "@types/google-protobuf": "^3.15.5",
@@ -77,7 +77,7 @@ export const packageJson: PackageJson = {
     "@juzi/wechaty-puppet": "^1.0.84"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.90",
+    "@juzi/wechaty-grpc": "^1.0.93",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",
     "file-box": "^1.5.5",

package/src/server/puppet-implementation.ts

@@ -293,6 +293,57 @@ function puppetImplementation (
       }
     },
 
+    batchContactPayload: async (call, callback) => {
+      log.verbose('PuppetServiceImpl', 'batchContactPayload()')
+
+      try {
+        const contactIdList = call.request.getIdsList()
+
+        const payloadMap = await puppet.batchContactPayload(contactIdList)
+
+        const response = new grpcPuppet.BatchContactPayloadResponse()
+
+        const payloads: grpcPuppet.ContactPayloadResponse[] = []
+        for (const [ _, payload ] of payloadMap.entries()) {
+          const pb = new grpcPuppet.ContactPayloadResponse()
+          pb.setAddress(payload.address || '')
+          pb.setAlias(payload.alias || '')
+          pb.setAvatar(payload.avatar)
+          pb.setCity(payload.city || '')
+          pb.setFriend(payload.friend || false)
+          pb.setGender(payload.gender)
+          pb.setId(payload.id)
+          pb.setName(payload.name)
+          pb.setProvince(payload.province || '')
+          pb.setSignature(payload.signature || '')
+          pb.setStar(payload.star || false)
+          pb.setType(payload.type)
+          /**
+           * @deprecated `payload.weixin` will be removed in v2.0
+           *  @link https://github.com/wechaty/grpc/issues/174
+           */
+          pb.setWeixin(payload.handle || payload.weixin || '')
+          pb.setPhonesList(payload.phone)
+          pb.setCoworker(payload.coworker || false)
+          pb.setCorporation(payload.corporation || '')
+          pb.setTitle(payload.title || '')
+          pb.setDescription(payload.description || '')
+          pb.setAdditionalInfo(payload.additionalInfo || '')
+          pb.setTagIdsList(payload.tags || [])
+          pb.setRealName(payload.realName || '')
+          pb.setAka(payload.aka || '')
+          payloads.push(pb)
+        }
+
+        response.setContactPayloadsList(payloads)
+
+        return callback(null, response)
+
+      } catch (e) {
+        return grpcError('batchContactPayload', e, callback)
+      }
+    },
+
     contactPayloadModify: async (call, callback) => {
       log.verbose('PuppetServiceImpl', 'contactPayloadModify()')
 
@@ -1437,7 +1488,7 @@ function puppetImplementation (
         const roomId = call.request.getId()
 
         const fileBox           = await puppet.roomAvatar(roomId)
-        const serializedFileBox = await serializeFileBox(fileBox)
+        const serializedFileBox = await serializeFileBox(fileBox!)
 
         const response = new grpcPuppet.RoomAvatarResponse()
         response.setFileBox(serializedFileBox)
@@ -1653,6 +1704,40 @@ function puppetImplementation (
       }
     },
 
+    batchRoomMemberPayload: async (call, callback) => {
+      log.verbose('PuppetServiceImpl', 'batchRoomMemberPayload()')
+
+      try {
+        const roomId = call.request.getId()
+        const contactIdList = call.request.getMemberIdsList()
+
+        const payloadMap = await puppet.batchRoomMemberPayload(roomId, contactIdList)
+
+        const response = new grpcPuppet.BatchRoomMemberPayloadResponse()
+
+        const payloads: grpcPuppet.RoomMemberPayloadResponse[] = []
+        for (const [ _, payload ] of payloadMap.entries()) {
+          const pb = new grpcPuppet.RoomMemberPayloadResponse()
+          pb.setAvatar(payload.avatar)
+          pb.setId(payload.id)
+          pb.setInviterId(payload.inviterId || '')
+          pb.setName(payload.name)
+          pb.setRoomAlias(payload.roomAlias || '')
+          pb.setAdditionalInfo(payload.additionalInfo || '')
+          pb.setJoinScene(payload.joinScene || PUPPET.types.RoomMemberJoinScene.Unknown)
+          pb.setJoinTime(payload.joinTime || 0)
+          payloads.push(pb)
+        }
+
+        response.setMemberPayloadsList(payloads)
+
+        return callback(null, response)
+
+      } catch (e) {
+        return grpcError('batchRoomMemberPayload', e, callback)
+      }
+    },
+
     roomPayload: async (call, callback) => {
       log.verbose('PuppetServiceImpl', 'roomPayload()')
 

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

@@ -374,3 +374,55 @@ export const chatHistoryPayloadToPb = async (grpcPuppet: grpcPuppet, chatHistory
 
   return list
 }
+
+export const roomMemberPbToPayload = (pb: puppet.RoomMemberPayloadResponse) => {
+  const payload: PUPPET.payloads.RoomMember = {
+    avatar        : pb.getAvatar(),
+    id            : pb.getId(),
+    inviterId     : pb.getInviterId(),
+    name          : pb.getName(),
+    roomAlias     : pb.getRoomAlias(),
+    additionalInfo: pb.getAdditionalInfo(),
+    joinScene     : pb.getJoinScene(),
+    joinTime      : pb.getJoinTime(),
+  }
+
+  return payload
+}
+
+export const contactPbToPayload = (pb: puppet.ContactPayloadResponse) => {
+  const payload: PUPPET.payloads.Contact = {
+    address     : pb.getAddress(),
+    alias       : pb.getAlias(),
+    avatar      : pb.getAvatar(),
+    city        : pb.getCity(),
+    corporation : pb.getCorporation(),
+    coworker    : pb.getCoworker(),
+    description : pb.getDescription(),
+    friend      : pb.getFriend(),
+    gender      : pb.getGender() as number,
+    /**
+     * Huan(202203): rename `getWeixin()` to `getHandle()` in v2.0.0
+     *  @link https://github.com/wechaty/grpc/issues/174
+     */
+    handle      : pb.getWeixin(),
+    id          : pb.getId(),
+    name        : pb.getName(),
+    phone       : pb.getPhonesList(),
+    province    : pb.getProvince(),
+    signature   : pb.getSignature(),
+    star        : pb.getStar(),
+    title       : pb.getTitle(),
+    type        : pb.getType() as number,
+    /**
+     * `weixin` is deprecated, will be removed after Dec 31, 2022
+     * use `handle` instead.
+     */
+    weixin        : pb.getWeixin(),
+    additionalInfo: pb.getAdditionalInfo(),
+    tags          : pb.getTagIdsList(),
+    realName      : pb.getRealName(),
+    aka           : pb.getAka(),
+  }
+  return payload
+}