@juzi/wechaty 1.0.158 → 1.0.160

package/src/wechaty-mixins/puppet-mixin.ts

@@ -1,5 +1,5 @@
 import * as PUPPET      from '@juzi/wechaty-puppet'
-import { log }          from '@juzi/wechaty-puppet'
+import { log, type LoggerLike } from '@juzi/wechaty-puppet'
 import {
   GError,
   timeoutPromise,
@@ -18,12 +18,8 @@ import type {
   CallImpl,
   ContactImpl,
   ContactInterface,
-  MessageImpl,
-  RoomImpl,
   TagGroupInterface,
   TagInterface,
-  WxxdOrderImpl,
-  WxxdProductImpl,
 }                               from '../user-modules/mod.js'
 
 import type {
@@ -85,11 +81,11 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
     }
 
     override async start (): Promise<void> {
-      log.verbose('WechatyPuppetMixin', 'start()')
+      this.log.verbose('WechatyPuppetMixin', 'start()')
 
-      log.verbose('WechatyPuppetMixin', 'start() super.start() ...')
+      this.log.verbose('WechatyPuppetMixin', 'start() super.start() ...')
       await super.start()
-      log.verbose('WechatyPuppetMixin', 'start() super.start() ... done')
+      this.log.verbose('WechatyPuppetMixin', 'start() super.start() ... done')
 
       try {
         /**
@@ -101,12 +97,12 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
         }
 
         try {
-          log.verbose('WechatyPuppetMixin', 'start() starting puppet ...')
+          this.log.verbose('WechatyPuppetMixin', 'start() starting puppet ...')
           await timeoutPromise(
             this.puppet.start(),
             15 * 1000,  // 15 seconds timeout
           )
-          log.verbose('WechatyPuppetMixin', 'start() starting puppet ... done')
+          this.log.verbose('WechatyPuppetMixin', 'start() starting puppet ... done')
         } catch (e) {
           if (e instanceof TimeoutPromiseGError) {
             /**
@@ -119,8 +115,8 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
              *
              * e.g. after resolve @issue https://github.com/padlocal/wechaty-puppet-padlocal/issues/116
              */
-            log.warn('WechatyPuppetMixin', 'start() starting puppet ... timeout')
-            log.warn('WechatyPuppetMixin', 'start() puppet info: %s', this.puppet)
+            this.log.warn('WechatyPuppetMixin', 'start() starting puppet ... timeout')
+            this.log.warn('WechatyPuppetMixin', 'start() puppet info: %s', this.puppet)
           } else {
             throw e
           }
@@ -132,88 +128,116 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
     }
 
     override async stop (): Promise<void> {
-      log.verbose('WechatyPuppetMixin', 'stop()')
+      this.log.verbose('WechatyPuppetMixin', 'stop()')
 
       try {
-        log.verbose('WechatyPuppetMixin', 'stop() stopping puppet ...')
+        this.log.verbose('WechatyPuppetMixin', 'stop() stopping puppet ...')
         await timeoutPromise(
           this.puppet.stop(),
           15 * 1000,  // 15 seconds timeout
         )
-        log.verbose('WechatyPuppetMixin', 'stop() stopping puppet ... done')
+        this.log.verbose('WechatyPuppetMixin', 'stop() stopping puppet ... done')
       } catch (e) {
         if (e instanceof TimeoutPromiseGError) {
-          log.warn('WechatyPuppetMixin', 'stop() stopping puppet ... timeout')
-          log.warn('WechatyPuppetMixin', 'stop() puppet info: %s', this.puppet)
+          this.log.warn('WechatyPuppetMixin', 'stop() stopping puppet ... timeout')
+          this.log.warn('WechatyPuppetMixin', 'stop() puppet info: %s', this.puppet)
         }
         this.emitError(e)
       }
 
-      log.verbose('WechatyPuppetMixin', 'stop() super.stop() ...')
+      this.log.verbose('WechatyPuppetMixin', 'stop() super.stop() ...')
       await super.stop()
-      log.verbose('WechatyPuppetMixin', 'stop() super.stop() ... done')
+      this.log.verbose('WechatyPuppetMixin', 'stop() super.stop() ... done')
 
       this.__callPool.clear()
     }
 
     async ready (): Promise<void> {
-      log.verbose('WechatyPuppetMixin', 'ready()')
+      this.log.verbose('WechatyPuppetMixin', 'ready()')
       await this.__readyState.stable('active')
-      log.silly('WechatyPuppetMixin', 'ready() this.readyState.stable(on) resolved')
+      this.log.silly('WechatyPuppetMixin', 'ready() this.readyState.stable(on) resolved')
     }
 
     override async init (): Promise<void> {
-      log.verbose('WechatyPuppetMixin', 'init()')
+      this.log.verbose('WechatyPuppetMixin', 'init()')
       await super.init()
 
       if (this.__puppetMixinInited) {
-        log.verbose('WechatyPuppetMixin', 'init() skipped because this puppet has already been inited before.')
+        this.log.verbose('WechatyPuppetMixin', 'init() skipped because this puppet has already been inited before.')
         return
       }
       this.__puppetMixinInited = true
 
-      log.verbose('WechatyPuppetMixin', 'init() instanciating puppet instance ...')
+      this.log.verbose('WechatyPuppetMixin', 'init() instanciating puppet instance ...')
+      /**
+       * Forward `WechatyOptions.logger` down into `PuppetOptions.logger` so
+       * that the puppet layer emits logs through the same logger the caller
+       * supplied to Wechaty.
+       */
+      const basePuppetOptions = 'puppetOptions' in this.__options
+        ? this.__options.puppetOptions
+        : undefined
+      const mergedPuppetOptions = this.__options.logger
+        ? { ...(basePuppetOptions ?? {}), logger: this.__options.logger }
+        : basePuppetOptions
       const puppetInstance = await PUPPET.helpers.resolvePuppet({
         puppet: this.__options.puppet || config.systemPuppetName(),
-        puppetOptions: 'puppetOptions' in this.__options
-          ? this.__options.puppetOptions
-          : undefined,
+        puppetOptions: mergedPuppetOptions,
       })
-      log.verbose('WechatyPuppetMixin', 'init() instanciating puppet instance ... done')
+
+      /**
+       * Adopt the puppet's effective logger onto the Wechaty side, so that
+       * `wechaty.log` and, via the accessory chain, every user module
+       * (`Contact.log`, `Message.log`, ...) route through it. `PuppetInterface`
+       * hides `log` (via `PuppetSkeletonProtectedProperty`), so a structural
+       * cast is required. The `??` guards third-party puppets that never
+       * adopted the pluggable logger — those fall back to the brolog `log`
+       * already assigned in WechatySkeleton.
+       *
+       * Adopted immediately after `resolvePuppet` so the rest of init() —
+       * setMemory / setupPuppetEvents / the sync `emit('puppet')` listeners —
+       * all route through the caller-supplied logger, not brolog.
+       */
+      const puppetLog = (puppetInstance as unknown as { log?: LoggerLike }).log
+      if (puppetLog) {
+        this.__log = puppetLog
+      }
+
+      this.log.verbose('WechatyPuppetMixin', 'init() instanciating puppet instance ... done')
 
       /**
        * Plug the Memory Card to Puppet
        */
-      log.verbose('WechatyPuppetMixin', 'init() setting memory ...')
+      this.log.verbose('WechatyPuppetMixin', 'init() setting memory ...')
       const puppetMemory = this.memory.multiplex(PUPPET_MEMORY_NAME)
       puppetInstance.setMemory(puppetMemory)
-      log.verbose('WechatyPuppetMixin', 'init() setting memory ... done')
+      this.log.verbose('WechatyPuppetMixin', 'init() setting memory ... done')
 
       /**
        * Propagate Puppet Events to Wechaty
        */
-      log.verbose('WechatyPuppetMixin', 'init() setting up events ...')
+      this.log.verbose('WechatyPuppetMixin', 'init() setting up events ...')
       this.__setupPuppetEvents(puppetInstance)
-      log.verbose('WechatyPuppetMixin', 'init() setting up events ... done')
+      this.log.verbose('WechatyPuppetMixin', 'init() setting up events ... done')
 
       /**
         * Private Event
         *   - Huan(202005): emit puppet when set
         *   - Huan(202110): @see https://github.com/wechaty/redux/blob/16af0ae01f72e37f0ee286b49fa5ccf69850323d/src/wechaty-redux.ts#L82-L98
         */
-      log.verbose('WechatyPuppetMixin', 'init() emitting "puppet" event ...')
+      this.log.verbose('WechatyPuppetMixin', 'init() emitting "puppet" event ...')
       ;(this.emit as any)('puppet', puppetInstance)
-      log.verbose('WechatyPuppetMixin', 'init() emitting "puppet" event ... done')
+      this.log.verbose('WechatyPuppetMixin', 'init() emitting "puppet" event ... done')
 
       this.__puppet = puppetInstance
     }
 
     __setupPuppetEvents (puppet: PUPPET.impls.PuppetInterface): void {
-      log.verbose('WechatyPuppetMixin', '__setupPuppetEvents(%s)', puppet)
+      this.log.verbose('WechatyPuppetMixin', '__setupPuppetEvents(%s)', puppet)
 
       const eventNameList: PUPPET.types.PuppetEventName[] = Object.keys(PUPPET.types.PUPPET_EVENT_DICT) as PUPPET.types.PuppetEventName[]
       for (const eventName of eventNameList) {
-        log.verbose('PuppetMixin',
+        this.log.verbose('PuppetMixin',
           '__setupPuppetEvents() puppet.on(%s) (listenerCount:%s) registering...',
           eventName,
           puppet.listenerCount(eventName),
@@ -293,7 +317,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                 if (contact) {
                   this.emit('logout', contact, payload.data)
                 } else {
-                  log.verbose('PuppetMixin',
+                  this.log.verbose('PuppetMixin',
                     '__setupPuppetEvents() logout event contact self not found for id: %s',
                     payload.contactId,
                   )
@@ -390,7 +414,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
 
           case 'ready':
             puppet.on('ready', async () => {
-              log.silly('WechatyPuppetMixin', '__setupPuppetEvents() puppet.on(ready)')
+              this.log.silly('WechatyPuppetMixin', '__setupPuppetEvents() puppet.on(ready)')
 
               // ready event should be emitted 15s after login
               let onceLogout: () => void
@@ -419,7 +443,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                   this.__readyState.active(true)
                 }
               } catch (e) {
-                log.error(`ready error: ${(e as Error).message}, will emit event anyway if it's logged in now`)
+                this.log.error(`ready error: ${(e as Error).message}, will emit event anyway if it's logged in now`)
                 if (this.puppet.isLoggedIn) {
                   this.emit('ready')
                   this.__loginIndicator.value(true)
@@ -541,7 +565,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                     changer = await this.Contact.find({ id: payload.changerId })
                   }
                 } catch (e) {
-                  log.warn('room-announce', 'room-announce event error: %s', (e as Error).message)
+                  this.log.warn('room-announce', 'room-announce event error: %s', (e as Error).message)
                 }
                 const date = timestampToDate(payload.timestamp)
                 this.emit('room-announce', room, payload.newAnnounce, changer, payload.oldAnnounce, date)
@@ -588,7 +612,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                       return tag.name() === oldName
                     })
                     if (!result) {
-                      log.warn('WechatyPuppetMixin', 'tagRenameEvent still get old name after %s retries for tag %s', PUPPET_PAYLOAD_SYNC_MAX_RETRY, tag.id)
+                      this.log.warn('WechatyPuppetMixin', 'tagRenameEvent still get old name after %s retries for tag %s', PUPPET_PAYLOAD_SYNC_MAX_RETRY, tag.id)
                     }
                   }))
                   this.emit('tag', payload.type, renamedTags, date)
@@ -634,7 +658,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                       return tagGroup.name() === oldName
                     })
                     if (!result) {
-                      log.warn('WechatyPuppetMixin', 'tagGroupRenameEvent still get old name after %s retries for tagGroup %s', PUPPET_PAYLOAD_SYNC_MAX_RETRY, tagGroup.id)
+                      this.log.warn('WechatyPuppetMixin', 'tagGroupRenameEvent still get old name after %s retries for tagGroup %s', PUPPET_PAYLOAD_SYNC_MAX_RETRY, tagGroup.id)
                     }
                   }))
                   this.emit('tag-group', payload.type, renamedTagGroups, date)
@@ -668,7 +692,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                 this.emit('contact-enter-conversation', contact, date, payload.scene)
                 contact.emit('enter-conversation', date, payload.scene)
               } else {
-                log.verbose('PuppetMixin',
+                this.log.verbose('PuppetMixin',
                   '__setupPuppetEvents() contact-enter-conversation event contact not found for id: %s',
                   payload.contactId,
                 )
@@ -685,7 +709,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                 this.emit('contact-lead-filled', contact, leads, date)
                 contact.emit('lead-filled', leads, date)
               } else {
-                log.verbose('PuppetMixin',
+                this.log.verbose('PuppetMixin',
                   '__setupPuppetEvents() contact-lead-filled event contact not found for id: %s',
                   payload.contactId,
                 )
@@ -700,26 +724,46 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
           case 'dirty':
             /**
              * https://github.com/wechaty/wechaty-puppet-service/issues/43
+             *
+             * `dirty` semantics: the puppet-service told us the cached payload
+             * for this id is stale. It is NOT a request to load the payload.
+             *
+             * The old handler used `this.Xxx.find({ id })` which, on pool miss,
+             * constructs a fresh user-layer instance AND calls `.ready()` — a
+             * puppet-side gRPC round-trip. For a `dirty` event about an id
+             * that no business code has ever touched, this turned a passive
+             * "invalidate if cached" signal into an active fetch, amplifying
+             * dirty-event bursts (e.g. during message storms) into extra
+             * puppet-service QPS.
+             *
+             * Fix: for pooled user-modules, look the instance up in the pool
+             * directly and only call `.ready(true)` when it is already there.
+             * The Call branch (below) already follows this shape via
+             * `__callPool.get(...)`. Message has no pool, so its branch is a
+             * no-op break (any caller wanting a Message must load it itself).
              */
             puppet.on('dirty', async ({ payloadType, payloadId }) => {
               try {
                 switch (payloadType) {
                   case PUPPET.types.Payload.Contact: {
-                    const contact = await this.Contact.find({ id: payloadId }) as unknown as undefined | ContactImpl
-                    await contact?.ready(true)
+                    const cached = this.Contact.pool.get(payloadId)
+                    if (cached) await cached.ready(true)
                     break
                   }
                   case PUPPET.types.Payload.Room: {
-                    const room = await this.Room.find({ id: payloadId })  as unknown as undefined | RoomImpl
-                    await room?.ready(true)
+                    const cached = this.Room.pool.get(payloadId)
+                    if (cached) await cached.ready(true)
                     break
                   }
                   case PUPPET.types.Payload.RoomMember: {
                     if (payloadId.includes(PUPPET.STRING_SPLITTER)) {
                       break
                     }
-                    const room = await this.Room.find({ id: payloadId }) as unknown as undefined | RoomImpl
-                    await room?.ready()
+                    // A bare (non-composite) RoomMember dirty id addresses the
+                    // whole room, mirroring the Room branch — but never load
+                    // a new Room here.
+                    const cached = this.Room.pool.get(payloadId)
+                    if (cached) await cached.ready()
                     break
                   }
 
@@ -729,12 +773,13 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                   case PUPPET.types.Payload.Friendship:
                     // Friendship has no payload
                     break
-                  case PUPPET.types.Payload.Message: {
-                    // Message does not need to dirty (?)
-                    const message = await this.Message.find({ id: payloadId }) as unknown as undefined | MessageImpl
-                    await message?.ready(true)
+                  case PUPPET.types.Payload.Message:
+                    // Message has no user-layer pool (see message.ts: `load`
+                    // constructs a fresh instance every call). Dirty for a
+                    // Message id is therefore a no-op at this layer — the
+                    // cache-mixin listener still invalidates the puppet-side
+                    // payload cache alongside this handler.
                     break
-                  }
                   case PUPPET.types.Payload.Tag:
                     break
                   case PUPPET.types.Payload.TagGroup:
@@ -742,13 +787,13 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                   case PUPPET.types.Payload.Post:
                     break
                   case PUPPET.types.Payload.WxxdProduct: {
-                    const product = await this.WxxdProduct.find({ id: payloadId }) as unknown as undefined | WxxdProductImpl
-                    await product?.ready(true)
+                    const cached = this.WxxdProduct.pool.get(payloadId)
+                    if (cached) await cached.ready(true)
                     break
                   }
                   case PUPPET.types.Payload.WxxdOrder: {
-                    const order = await this.WxxdOrder.find({ id: payloadId }) as unknown as undefined | WxxdOrderImpl
-                    await order?.ready(true)
+                    const cached = this.WxxdOrder.pool.get(payloadId)
+                    if (cached) await cached.ready(true)
                     break
                   }
                   case PUPPET.types.Payload.Call: {
@@ -773,7 +818,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                       try {
                         await call.ready(true)
                       } catch (e) {
-                        log.warn(
+                        this.log.warn(
                           'WechatyPuppetMixin',
                           'dirty(Call) ready failed for callId=%s: %s',
                           payloadId,
@@ -786,7 +831,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
 
                   case PUPPET.types.Payload.Unspecified:
                   default:
-                    log.warn('unknown payload type: ' + payloadType)
+                    this.log.warn('unknown payload type: ' + payloadType)
                 }
                 this.emit('dirty', payloadId, payloadType)
               } catch (e) {
@@ -834,7 +879,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
               try {
                 if (payload.signal === PUPPET.types.CallSignal.Invite) {
                   if (this.__callPool.has(payload.callId)) {
-                    log.warn('WechatyPuppetMixin', '__setupPuppetEvents() duplicate Invite for callId=%s, ignoring', payload.callId)
+                    this.log.warn('WechatyPuppetMixin', '__setupPuppetEvents() duplicate Invite for callId=%s, ignoring', payload.callId)
                     return
                   }
                   const call = new (this.Call as any)({
@@ -853,13 +898,13 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
                   // are expected within race windows (e.g. a Ringing ack arriving
                   // before callInvite returns) or after the Call has been finalized
                   // and removed from the pool. Drop silently — log.warn, not error.
-                  log.warn('WechatyPuppetMixin', '__setupPuppetEvents() call event for unknown callId=%s, dropping', payload.callId)
+                  this.log.warn('WechatyPuppetMixin', '__setupPuppetEvents() call event for unknown callId=%s, dropping', payload.callId)
                   return
                 }
 
                 const actor = await (this.Contact as typeof ContactImpl).find({ id: payload.contactId })
                 if (!actor) {
-                  log.warn('WechatyPuppetMixin', '__setupPuppetEvents() actor contact not found for callId=%s contactId=%s, dropping', payload.callId, payload.contactId)
+                  this.log.warn('WechatyPuppetMixin', '__setupPuppetEvents() actor contact not found for callId=%s contactId=%s, dropping', payload.callId, payload.contactId)
                   return
                 }
 
@@ -904,7 +949,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
         }
       }
 
-      log.verbose('WechatyPuppetMixin', '__setupPuppetEvents() ... done')
+      this.log.verbose('WechatyPuppetMixin', '__setupPuppetEvents() ... done')
     }
 
     /**
@@ -942,7 +987,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
             await call.sync()
             ended = !!call.endTime()
           } catch (e) {
-            log.warn(
+            this.log.warn(
               'WechatyPuppetMixin',
               '__finalizeIfEnded() sync attempt %d failed for callId=%s: %s',
               attempt + 1,
@@ -960,7 +1005,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
         try {
           const participants = await call.participants()
           if (participants.length === 2) {
-            log.warn(
+            this.log.warn(
               'WechatyPuppetMixin',
               '__finalizeIfEnded() 1v1 fallback after sync failure for callId=%s (rosterLength=%d)',
               call.id,
@@ -968,7 +1013,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
             )
             ended = true
           } else {
-            log.error(
+            this.log.error(
               'WechatyPuppetMixin',
               '__finalizeIfEnded() sync failed, leaving callId=%s in pool for next dirty signal (rosterLength=%d)',
               call.id,
@@ -976,7 +1021,7 @@ const puppetMixin = <MixinBase extends WechatifyUserModuleMixin & GErrorMixin &
             )
           }
         } catch (e) {
-          log.error(
+          this.log.error(
             'WechatyPuppetMixin',
             '__finalizeIfEnded() participants lookup failed for callId=%s: %s',
             call.id,

package/src/wechaty-mixins/wechatify-user-module-mixin.ts

@@ -134,18 +134,18 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
     get WxxdOrder ()                     : WxxdOrderConstructor                     { return guardWechatify(this.__wechatifiedWxxdOrder)       }
 
     override async init (): Promise<void> {
-      log.verbose('WechatifyUserModuleMixin', 'init()')
+      this.log.verbose('WechatifyUserModuleMixin', 'init()')
       await super.init()
 
       /**
        * Skip if already wechatified
        */
       if (this.__wechatifiedMessage) {
-        log.verbose('WechatifyUserModuleMixin', 'init() Wechaty User Module (WUM)s have already wechatified: skip')
+        this.log.verbose('WechatifyUserModuleMixin', 'init() Wechaty User Module (WUM)s have already wechatified: skip')
         return
       }
 
-      log.verbose('WechatifyUserModuleMixin', 'init() initializing Wechaty User Module (WUM) ...')
+      this.log.verbose('WechatifyUserModuleMixin', 'init() initializing Wechaty User Module (WUM) ...')
 
       /**
        * Wechatify User Classes
@@ -182,7 +182,7 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
       this.__wechatifiedWxxdProduct                   = wechatifyUserModule(WxxdProductImpl)(this as any)
       this.__wechatifiedWxxdOrder                     = wechatifyUserModule(WxxdOrderImpl)(this as any)
 
-      log.verbose('WechatifyUserModuleMixin', 'init() initializing Wechaty User Module (WUM) ... done')
+      this.log.verbose('WechatifyUserModuleMixin', 'init() initializing Wechaty User Module (WUM) ... done')
     }
 
   }