@juzi/wechaty-puppet-service 1.0.51 → 1.0.53

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-puppet-service",
-  "version": "1.0.51",
+  "version": "1.0.53",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {
@@ -70,7 +70,7 @@
     "@juzi/wechaty-puppet": "^1.0.51"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.53",
+    "@juzi/wechaty-grpc": "^1.0.54",
     "@juzi/wechaty-redux": "^1.0.1",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",
@@ -81,6 +81,7 @@
     "rxjs": "^7.5.5",
     "semver": "^7.3.5",
     "stronger-typed-streams": "^0.2.0",
+    "typescript": "^4.7.3",
     "uuid": "^8.3.2",
     "wechaty-token": "^1.0.6"
   },

package/src/client/grpc-manager.ts

@@ -144,7 +144,7 @@ class GrpcManager extends EventEmitter {
     log.verbose('GrpcManager', 'constructor() serverName(SNI): "%s"', this.serverName)
   }
 
-  async start (): Promise<void> {
+  async start (lastEventSeq?: string, accountId?: string): Promise<void> {
     log.verbose('GrpcManager', 'start()')
 
     /**
@@ -158,7 +158,7 @@ class GrpcManager extends EventEmitter {
      * 2. Connect to stream
      */
     log.verbose('GrpcManager', 'start() starting stream ...')
-    await this.startStream()
+    await this.startStream(lastEventSeq, accountId)
     log.verbose('GrpcManager', 'start() starting stream ... done')
 
     /**
@@ -287,7 +287,7 @@ class GrpcManager extends EventEmitter {
     }
   }
 
-  protected async startStream (): Promise<void> {
+  protected async startStream (lastEventSeq?: string, accountId?: string): Promise<void> {
     log.verbose('GrpcManager', 'startStream()')
 
     if (this.eventStream) {
@@ -296,7 +296,15 @@ class GrpcManager extends EventEmitter {
     }
 
     log.verbose('GrpcManager', 'startStream() grpc -> event() ...')
-    const eventStream = this.client.event(new puppet.EventRequest())
+
+    const eventRequest = new puppet.EventRequest()
+    if (lastEventSeq) {
+      eventRequest.setSeq(Number(lastEventSeq))
+    }
+    if (accountId) {
+      eventRequest.setAccountId(accountId)
+    }
+    const eventStream = this.client.event(eventRequest)
     log.verbose('GrpcManager', 'startStream() grpc -> event() ... done')
 
     /**

package/src/client/payload-store.ts

@@ -46,11 +46,12 @@ class PayloadStore {
 
   // public message?    : LRU<string, MessagePayload>
 
-  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>
+  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>
+  public miscellaneous : FlashStore<string, string>
 
   protected storeDir:   string
   protected accountId?: string
@@ -66,6 +67,12 @@ class PayloadStore {
       `v${major(VERSION)}.${minor(VERSION)}`,
     )
     log.silly('PayloadStore', 'constructor() storeDir: "%s"', this.storeDir)
+
+    if (!fs.existsSync(this.storeDir)) {
+      fs.mkdirSync(this.storeDir, { recursive: true })
+    }
+
+    this.miscellaneous = new FlashStore(path.join(this.storeDir, 'miscellaneous')) // account-free data
   }
 
   /**
@@ -148,6 +155,8 @@ class PayloadStore {
       throw new Error('Can not destroy() a start()-ed store. Call stop() to stop it first')
     }
 
+    await this.miscellaneous.close()
+
     /**
      * Huan(202108): `fs.rm` was introduced from Node.js v14.14
      *  https://nodejs.org/api/fs.html#fs_fspromises_rm_path_options

package/src/client/puppet-service.ts

@@ -87,6 +87,8 @@ class PuppetService extends PUPPET.Puppet {
   protected _ducks: Ducks<{ puppet: typeof PuppetDuck }>
   protected _store: Store
 
+  private timeoutMilliseconds: number
+
   protected _grpcManager?: GrpcManager
   get grpcManager (): GrpcManager {
     if (!this._grpcManager) {
@@ -119,6 +121,7 @@ class PuppetService extends PUPPET.Puppet {
     this._cleanupCallbackList = []
 
     this.FileBoxUuid = uuidifyFileBoxGrpc(() => this.grpcManager.client)
+    this.timeoutMilliseconds = (options.timeoutSeconds || 2) * 1000 * 10 // 20min default, 40min for xiaoju-bot
   }
 
   protected async serializeFileBox (fileBox: FileBoxInterface): Promise<string> {
@@ -164,7 +167,10 @@ class PuppetService extends PUPPET.Puppet {
     log.verbose('PuppetService', 'start() setting up bridge grpc event stream ... done')
 
     log.verbose('PuppetService', 'start() starting grpc manager...')
-    await grpcManager.start()
+    const lastEventTimestamp = await this._payloadStore.miscellaneous.get('eventTimestamp')
+    const lastEventSeq = (Date.now() - Number(lastEventTimestamp || 0)) < this.timeoutMilliseconds ? await this._payloadStore.miscellaneous.get('eventSeq') : undefined
+    const accountId = await this._payloadStore.miscellaneous.get('accountId')
+    await grpcManager.start(lastEventSeq, accountId)
     log.verbose('PuppetService', 'start() starting grpc manager... done')
 
     log.verbose('PuppetService', 'start healthCheck')
@@ -228,7 +234,7 @@ class PuppetService extends PUPPET.Puppet {
     log.verbose('PuppetService', 'bridgeGrpcEventStream(client)')
 
     client
-      .on('data', this.onGrpcStreamEvent.bind(this))
+      .on('data', this.onGrpcStreamEvent.bind(this) as any)
       .on('end', () => {
         log.verbose('PuppetService', 'bridgeGrpcEventStream() eventStream.on(end)')
       })
@@ -254,9 +260,11 @@ class PuppetService extends PUPPET.Puppet {
       })
   }
 
-  private onGrpcStreamEvent (event: grpcPuppet.EventResponse): void {
+  private async onGrpcStreamEvent (event: grpcPuppet.EventResponse): Promise<void> {
+
     const type    = event.getType()
     const payload = event.getPayload()
+    const seq     = event.getSeq()
 
     if (!NO_LOG_EVENTS.includes(type)) {
       log.info('PuppetService', `received grpc event ${EventTypeRev[type]} on ${new Date().toString()}, content: ${JSON.stringify(payload)}`)
@@ -275,6 +283,14 @@ 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', String(Date.now()))
+      }
+    }
+
     switch (type) {
       case grpcPuppet.EventType.EVENT_TYPE_DONG:
         this.emit('dong', JSON.parse(payload) as PUPPET.payloads.EventDong)
@@ -291,6 +307,11 @@ class PuppetService extends PUPPET.Puppet {
       case grpcPuppet.EventType.EVENT_TYPE_LOGIN:
         {
           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')
+          }
+          await this._payloadStore.miscellaneous.set('accountId', loginPayload.contactId)
           ;(
             async () => this.login(loginPayload.contactId)
           )().catch(e =>
@@ -303,6 +324,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')
           ;(
             async () => this.logout(logoutPayload.data)
           )().catch(e =>

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.51",
+  "version": "1.0.53",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {
@@ -74,7 +74,7 @@ export const packageJson: PackageJson = {
     "@juzi/wechaty-puppet": "^1.0.51"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.53",
+    "@juzi/wechaty-grpc": "^1.0.54",
     "@juzi/wechaty-redux": "^1.0.1",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",
@@ -85,6 +85,7 @@ export const packageJson: PackageJson = {
     "rxjs": "^7.5.5",
     "semver": "^7.3.5",
     "stronger-typed-streams": "^0.2.0",
+    "typescript": "^4.7.3",
     "uuid": "^8.3.2",
     "wechaty-token": "^1.0.6"
   },