@juzi/wechaty-puppet-service 1.0.18 → 1.0.19

package/src/client/payload-store.ts

@@ -49,6 +49,8 @@ class PayloadStore {
   public contact?    : FlashStore<string, PUPPET.payloads.Contact>
   public roomMember? : FlashStore<string, StoreRoomMemberPayload>
   public room?       : FlashStore<string, PUPPET.payloads.Room>
+  public tag?        : FlashStore<string, PUPPET.payloads.Tag>
+  public tagGroup?   : FlashStore<string, PUPPET.payloads.TagGroup>
 
   protected storeDir:   string
   protected accountId?: string
@@ -87,6 +89,8 @@ class PayloadStore {
     this.contact    = new FlashStore(path.join(accountDir, 'contact-payload'))
     this.roomMember = new FlashStore(path.join(accountDir, 'room-member-payload'))
     this.room       = new FlashStore(path.join(accountDir, 'room-payload'))
+    this.tag        = new FlashStore(path.join(accountDir, 'tag-payload'))
+    this.tagGroup   = new FlashStore(path.join(accountDir, 'tag-group'))
 
     /**
      * LRU
@@ -112,6 +116,8 @@ class PayloadStore {
     const contactStore    = this.contact
     const roomMemberStore = this.roomMember
     const roomStore       = this.room
+    const tagStore        = this.tag
+    const tagGroupStore   = this.tagGroup
     /**
       * Huan(202108): we must set all the instances of the store to underfined
       *   in the current event loop as soon as possible
@@ -120,6 +126,8 @@ class PayloadStore {
     this.contact    = undefined
     this.roomMember = undefined
     this.room       = undefined
+    this.tag        = undefined
+    this.tagGroup   = undefined
 
     // LRU
     // this.message    = undefined
@@ -130,6 +138,8 @@ class PayloadStore {
     await contactStore?.close()
     await roomMemberStore?.close()
     await roomStore?.close()
+    await tagStore?.close()
+    await tagGroupStore?.close()
   }
 
   async destroy (): Promise<void> {

package/src/client/puppet-service.ts

@@ -57,6 +57,7 @@ import {
 }                       from '../file-box-helper/mod.js'
 import {
   envVars,
+  FOUR_PER_EM_SPACE,
   log,
   NO_LOG_EVENTS,
   VERSION,
@@ -348,6 +349,9 @@ class PuppetService extends PUPPET.Puppet {
       case grpcPuppet.EventType.EVENT_TYPE_SCAN:
         this.emit('scan', JSON.parse(payload) as PUPPET.payloads.EventScan)
         break
+      case grpcPuppet.EventType.EVENT_TYPE_TAG:
+        this.emit('tag', JSON.parse(payload) as PUPPET.payloads.EventTag)
+        break
       case grpcPuppet.EventType.EVENT_TYPE_RESET:
         log.warn('PuppetService', 'onGrpcStreamEvent() got an EventType.EVENT_TYPE_RESET ?')
         // the `reset` event should be dealed not send out
@@ -1975,7 +1979,7 @@ class PuppetService extends PUPPET.Puppet {
 
   override async tagGroupAdd (
     tagGroupName: string,
-  ): Promise<PUPPET.payloads.TagGroup | void> {
+  ): Promise<string | void> {
     log.verbose('PuppetService', 'tagGroupAdd(%s)', tagGroupName)
 
     const request = new grpcPuppet.TagGroupAddRequest()
@@ -1987,18 +1991,9 @@ class PuppetService extends PUPPET.Puppet {
         .bind(this.grpcManager.client),
     )(request)
 
-    const grpcPayload = result.getPayload()
-    const id = grpcPayload?.getId()
-    const name = grpcPayload?.getName()
-
-    if (id && name) {
-      const payload: PUPPET.payloads.TagGroup = {
-        id,
-        name,
-      }
-      return payload
-    }
+    const id = result.getTagGroupId()
 
+    return id
   }
 
   override async tagGroupDelete (
@@ -2020,7 +2015,7 @@ class PuppetService extends PUPPET.Puppet {
   override async tagTagAdd (
     tagName: string,
     tagGroupId?: string,
-  ): Promise<PUPPET.payloads.Tag | void> {
+  ): Promise<PUPPET.filters.TagIdentifier | void> {
     log.verbose('PuppetService', 'tagTagAdd(%s, %s)', tagName, tagGroupId)
 
     const request = new grpcPuppet.TagTagAddRequest()
@@ -2035,22 +2030,16 @@ class PuppetService extends PUPPET.Puppet {
         .bind(this.grpcManager.client),
     )(request)
 
-    const grpcPayload = result.getPayload()
-    const id = grpcPayload?.getId()
-    const name = grpcPayload?.getName()
-    const groupId = grpcPayload?.getGroupId()
-    const type = grpcPayload?.getType()
+    const tag = result.getTag()
+    const id = tag?.getId()
+    const groupId = tag?.getGroupId()
 
-    if (id && name && (typeof type !== 'undefined')) {
-      const payload: PUPPET.payloads.Tag = {
+    if (id) {
+      return {
         id,
-        name,
         groupId,
-        type,
       }
-      return payload
     }
-
   }
 
   override async tagTagDelete (
@@ -2074,7 +2063,7 @@ class PuppetService extends PUPPET.Puppet {
 
   }
 
-  override async tagGroupList (): Promise<PUPPET.payloads.TagGroup[]> {
+  override async tagGroupList (): Promise<string[]> {
     log.verbose('PuppetService', 'tagGroupList()')
 
     const request = new grpcPuppet.TagGroupListRequest()
@@ -2084,19 +2073,13 @@ class PuppetService extends PUPPET.Puppet {
         .bind(this.grpcManager.client),
     )(request)
 
-    const grpcPayloads = result.getPayloadsList()
-    const payloads: PUPPET.payloads.TagGroup[] = grpcPayloads.map(payload => {
-      return {
-        id: payload.getId(),
-        name: payload.getName(),
-      } as PUPPET.payloads.TagGroup
-    })
-    return payloads
+    const groupIds = result.getTagGroupIdsList()
+    return groupIds
   }
 
   override async tagGroupTagList (
     tagGroupId?: string,
-  ): Promise<PUPPET.payloads.Tag[]> {
+  ): Promise<PUPPET.filters.TagIdentifier[]> {
     log.verbose('PuppetService', 'tagGroupTagList(%s)', tagGroupId)
 
     const request = new grpcPuppet.TagGroupTagListRequest()
@@ -2109,20 +2092,18 @@ class PuppetService extends PUPPET.Puppet {
         .bind(this.grpcManager.client),
     )(request)
 
-    const grpcPayloads = result.getPayloadsList()
-    const payloads: PUPPET.payloads.Tag[] = grpcPayloads.map(payload => {
+    const tags = result.getTagsList()
+    const tagIdentifiers = tags.map(tag => {
       return {
-        id: payload.getId(),
-        name: payload.getName(),
-        groupId: payload.getGroupId(),
-        type: payload.getType(),
-      } as PUPPET.payloads.Tag
+        id: tag.getId(),
+        groupId: tag.getGroupId(),
+      }
     })
-    return payloads
+    return tagIdentifiers
   }
 
   override async tagTagList (
-  ): Promise<PUPPET.payloads.Tag[]> {
+  ): Promise<PUPPET.filters.TagIdentifier[]> {
     log.verbose('PuppetService', 'tagTagList()')
 
     const request = new grpcPuppet.TagTagListRequest()
@@ -2132,21 +2113,19 @@ class PuppetService extends PUPPET.Puppet {
         .bind(this.grpcManager.client),
     )(request)
 
-    const grpcPayloads = result.getPayloadsList()
-    const payloads: PUPPET.payloads.Tag[] = grpcPayloads.map(payload => {
+    const tags = result.getTagsList()
+    const tagIdentifiers = tags.map(tag => {
       return {
-        id: payload.getId(),
-        name: payload.getName(),
-        groupId: payload.getGroupId(),
-        type: payload.getType(),
-      } as PUPPET.payloads.Tag
+        id: tag.getId(),
+        groupId: tag.getGroupId(),
+      }
     })
-    return payloads
+    return tagIdentifiers
   }
 
   override async tagContactTagList (
     contactId: string,
-  ): Promise<PUPPET.payloads.Tag[]> {
+  ): Promise<PUPPET.filters.TagIdentifier[]> {
     log.verbose('PuppetService', 'tagContactTagList(%s)', contactId)
 
     const request = new grpcPuppet.TagContactTagListRequest()
@@ -2157,16 +2136,14 @@ class PuppetService extends PUPPET.Puppet {
         .bind(this.grpcManager.client),
     )(request)
 
-    const grpcPayloads = result.getPayloadsList()
-    const payloads: PUPPET.payloads.Tag[] = grpcPayloads.map(payload => {
+    const grpcPayloads = result.getTagsList()
+    const tags: PUPPET.filters.TagIdentifier[] = grpcPayloads.map(tag => {
       return {
-        id: payload.getId(),
-        name: payload.getName(),
-        groupId: payload.getGroupId(),
-        type: payload.getType(),
-      } as PUPPET.payloads.Tag
+        id: tag.getId(),
+        groupId: tag.getGroupId(),
+      }
     })
-    return payloads
+    return tags
   }
 
   override async tagTagContactList (
@@ -2186,8 +2163,82 @@ class PuppetService extends PUPPET.Puppet {
         .bind(this.grpcManager.client),
     )(request)
 
-    const payloads = result.getPayloadsList()
-    return payloads
+    const contactIds = result.getContactIdsList()
+    return contactIds
+  }
+
+  override async tagGroupPayloadPuppet (id: string): Promise<PUPPET.payloads.TagGroup> {
+    log.verbose('PuppetService', 'tagGroupPayload(%s)', id)
+
+    const cachedPayload = await this._payloadStore.tagGroup?.get(id)
+    if (cachedPayload) {
+      log.silly('PuppetService', 'tagGroupPayload(%s) cache HIT', id)
+      return cachedPayload
+    }
+
+    const request = new grpcPuppet.TagGroupPayloadRequest()
+    request.setGroupId(id)
+
+    const response = await util.promisify(
+      this.grpcManager.client.tagGroupPayload
+        .bind(this.grpcManager.client),
+    )(request)
+    const grpcPayload = response.getPayload()
+
+    if (!grpcPayload) {
+      throw new Error(`tagGroup ${id} got no payload!`)
+    }
+
+    const payload: PUPPET.payloads.TagGroup = {
+      id: grpcPayload.getId(),
+      name: grpcPayload.getName(),
+    }
+
+    await this._payloadStore.tagGroup?.set(id, payload)
+    log.silly('PuppetService', 'tagGroupPayloadPuppet(%s) cache SET', id)
+
+    return payload
+  }
+
+  override async tagPayloadPuppet (tag: PUPPET.filters.TagIdentifier): Promise<PUPPET.payloads.Tag> {
+    log.verbose('PuppetService', 'tagPayloadPuppet(%s)', JSON.stringify(tag))
+
+    const key = tag.groupId || '' + FOUR_PER_EM_SPACE + tag.id
+    const cachedPayload = await this._payloadStore.tag?.get(key)
+    if (cachedPayload) {
+      log.silly('PuppetService', 'tagPayloadPuppet(%s) cache HIT', tag)
+      return cachedPayload
+    }
+
+    const tagIdentifier = new grpcPuppet.TagIdentifier()
+    tagIdentifier.setId(tag.id)
+    if (tag.groupId) {
+      tagIdentifier.setGroupId(tag.groupId)
+    }
+    const request = new grpcPuppet.TagPayloadRequest()
+    request.setTag(tagIdentifier)
+
+    const response = await util.promisify(
+      this.grpcManager.client.tagPayload
+        .bind(this.grpcManager.client),
+    )(request)
+    const grpcPayload = response.getPayload()
+
+    if (!grpcPayload) {
+      throw new Error(`tag ${JSON.stringify(tag)} got no payload!`)
+    }
+
+    const payload: PUPPET.payloads.Tag = {
+      id: grpcPayload.getId(),
+      name: grpcPayload.getName(),
+      groupId: grpcPayload.getGroupId(),
+      type: grpcPayload.getType(),
+    }
+
+    await this._payloadStore.tag?.set(key, payload)
+    log.silly('PuppetService', 'tagPayloadPuppet(%s) cache SET', JSON.stringify(tag))
+
+    return payload
   }
 
   /**

package/src/config.ts

@@ -12,6 +12,7 @@ import {
 } from '@juzi/wechaty-grpc'
 
 const VERSION = packageJson.version || '0.0.0'
+export const FOUR_PER_EM_SPACE = String.fromCharCode(0x2005)
 
 const envVars = {
   ...rootEnvVars,

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.18",
+  "version": "1.0.19",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {
@@ -55,6 +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-mock": "^1.0.1",
     "@types/google-protobuf": "^3.15.5",
     "@types/lru-cache": "^7.5.0",
     "@types/semver": "^7.3.9",
@@ -65,14 +66,14 @@ export const packageJson: PackageJson = {
     "temp": "^0.9.4",
     "typed-emitter": "^1.5.0-from-event",
     "utility-types": "^3.10.0",
-    "@juzi/wechaty-puppet-mock": "^1.0.1",
     "why-is-node-running": "^2.2.1"
   },
   "peerDependencies": {
-    "@juzi/wechaty-puppet": "^1.0.15"
+    "@juzi/wechaty-puppet": "^1.0.22"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.12",
+    "@juzi/wechaty-grpc": "^1.0.13",
+    "@juzi/wechaty-redux": "^1.0.1",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",
     "file-box": "^1.5.5",
@@ -83,7 +84,6 @@ export const packageJson: PackageJson = {
     "semver": "^7.3.5",
     "stronger-typed-streams": "^0.2.0",
     "uuid": "^8.3.2",
-    "@juzi/wechaty-redux": "^1.0.1",
     "wechaty-token": "^1.0.6"
   },
   "publishConfig": {

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

@@ -273,6 +273,13 @@ class EventStreamManager {
           this.offCallbackList.push(off)
           break
         }
+        case 'tag': {
+          const listener = (payload: PUPPET.payloads.EventTag) => this.grpcEmit(grpcPuppet.EventType.EVENT_TYPE_TAG, payload)
+          this.puppet.on('tag', listener)
+          const off = () => this.puppet.off('tag', listener)
+          this.offCallbackList.push(off)
+          break
+        }
         case 'reset':
           // the `reset` event should be dealed internally, should not send out
           break

package/src/server/puppet-implementation.ts

@@ -1552,13 +1552,11 @@ function puppetImplementation (
         const tagGroupName = call.request.getTagGroupName()
 
         const result = await puppet.tagGroupAdd(tagGroupName)
-        const payload = new grpcPuppet.TagGroupPayload()
+
         const response = new grpcPuppet.TagGroupAddResponse()
 
         if (result) {
-          payload.setId(result.id)
-          payload.setName(result.name)
-          response.setPayload(payload)
+          response.setTagGroupId(result)
         }
 
         return callback(null, response)
@@ -1589,17 +1587,15 @@ function puppetImplementation (
         const tagName = call.request.getTagName()
 
         const result = await puppet.tagTagAdd(tagName, tagGroupId)
-        const payload = new grpcPuppet.TagPayload()
+        const tagIdentifier = new grpcPuppet.TagIdentifier()
         const response = new grpcPuppet.TagTagAddResponse()
 
         if (result) {
-          payload.setId(result.id)
-          payload.setName(result.name)
-          payload.setType(result.type)
+          tagIdentifier.setId(result.id)
           if (result.groupId) {
-            payload.setGroupId(result.groupId)
+            tagIdentifier.setGroupId(result.groupId)
           }
-          response.setPayload(payload)
+          response.setTag(tagIdentifier)
         }
 
         return callback(null, response)
@@ -1630,14 +1626,8 @@ function puppetImplementation (
 
       try {
         const result = await puppet.tagGroupList()
-        const payloads = result.map(tagGroup => {
-          const payload = new grpcPuppet.TagGroupPayload()
-          payload.setId(tagGroup.id)
-          payload.setName(tagGroup.name)
-          return payload
-        })
         const response = new grpcPuppet.TagGroupListResponse()
-        response.setPayloadsList(payloads)
+        response.setTagGroupIdsList(result)
 
         return callback(null, response)
       } catch (e) {
@@ -1652,18 +1642,16 @@ function puppetImplementation (
         const tagGroupId = call.request.getTagGroupId()
 
         const result = await puppet.tagGroupTagList(tagGroupId)
-        const payloads = result.map(tag => {
-          const payload = new grpcPuppet.TagPayload()
-          payload.setId(tag.id)
-          payload.setName(tag.name)
-          payload.setType(tag.type)
+        const tagIdentifiers = result.map(tag => {
+          const tagIdentifier = new grpcPuppet.TagIdentifier()
+          tagIdentifier.setId(tag.id)
           if (tag.groupId) {
-            payload.setGroupId(tag.groupId)
+            tagIdentifier.setGroupId(tag.groupId)
           }
-          return payload
+          return tagIdentifier
         })
         const response = new grpcPuppet.TagGroupTagListResponse()
-        response.setPayloadsList(payloads)
+        response.setTagsList(tagIdentifiers)
 
         return callback(null, response)
       } catch (e) {
@@ -1677,18 +1665,16 @@ function puppetImplementation (
 
       try {
         const result = await puppet.tagTagList()
-        const payloads = result.map(tag => {
-          const payload = new grpcPuppet.TagPayload()
-          payload.setId(tag.id)
-          payload.setName(tag.name)
-          payload.setType(tag.type)
+        const tagIdentifiers = result.map(tag => {
+          const tagIdentifier = new grpcPuppet.TagIdentifier()
+          tagIdentifier.setId(tag.id)
           if (tag.groupId) {
-            payload.setGroupId(tag.groupId)
+            tagIdentifier.setGroupId(tag.groupId)
           }
-          return payload
+          return tagIdentifier
         })
         const response = new grpcPuppet.TagTagListResponse()
-        response.setPayloadsList(payloads)
+        response.setTagsList(tagIdentifiers)
 
         return callback(null, response)
       } catch (e) {
@@ -1703,18 +1689,16 @@ function puppetImplementation (
         const contactId = call.request.getContactId()
 
         const result = await puppet.tagContactTagList(contactId)
-        const payloads = result.map(tag => {
-          const payload = new grpcPuppet.TagPayload()
-          payload.setId(tag.id)
-          payload.setName(tag.name)
-          payload.setType(tag.type)
+        const tagIdentifiers = result.map(tag => {
+          const tagIdentifier = new grpcPuppet.TagIdentifier()
+          tagIdentifier.setId(tag.id)
           if (tag.groupId) {
-            payload.setGroupId(tag.groupId)
+            tagIdentifier.setGroupId(tag.groupId)
           }
-          return payload
+          return tagIdentifier
         })
         const response = new grpcPuppet.TagContactTagListResponse()
-        response.setPayloadsList(payloads)
+        response.setTagsList(tagIdentifiers)
 
         return callback(null, response)
       } catch (e) {
@@ -1733,9 +1717,55 @@ function puppetImplementation (
         const result = await puppet.tagTagContactList({ id, groupId })
 
         const response = new grpcPuppet.TagTagContactListResponse()
-        response.setPayloadsList(result)
+        response.setContactIdsList(result)
+
+        return callback(null, response)
+      } catch (e) {
+        return grpcError('tagTagContactList', e, callback)
+      }
+    },
+
+    tagGroupPayload: async (call, callback) => {
+      log.verbose('PuppetServiceImpl', 'tagGroupPayload()')
+
+      try {
+        const id = call.request.getGroupId()
+
+        const result = await puppet.tagGroupPayloadPuppet(id)
+        const response = new grpcPuppet.TagGroupPayloadResponse()
+        const payload = new grpcPuppet.TagGroupPayload()
+        payload.setId(result.id)
+        payload.setName(result.name)
+        response.setPayload(payload)
 
         return callback(null, response)
+
+      } catch (e) {
+        return grpcError('tagTagContactList', e, callback)
+      }
+    },
+
+    tagPayload: async (call, callback) => {
+      log.verbose('PuppetServiceImpl', 'tagPayload()')
+
+      try {
+        const tag = call.request.getTag()!
+        const id = tag.getId()
+        const groupId = tag.getGroupId() || ''
+
+        const result = await puppet.tagPayloadPuppet({ id, groupId })
+        const response = new grpcPuppet.TagPayloadResponse()
+        const payload = new grpcPuppet.TagPayload()
+        payload.setId(result.id)
+        payload.setName(result.name)
+        payload.setType(result.type)
+        if (result.groupId) {
+          payload.setGroupId(result.groupId)
+        }
+        response.setPayload(payload)
+
+        return callback(null, response)
+
       } catch (e) {
         return grpcError('tagTagContactList', e, callback)
       }