@juzi/wechaty-puppet-service 1.0.119 → 1.0.120

package/dist/esm/tests/grpc-stream-dirty-parse.spec.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+/**
+ * Regression test for the double JSON.parse on every EVENT_TYPE_DIRTY
+ * stream event.
+ *
+ * The previous implementation was:
+ *
+ *   case grpcPuppet.EventType.EVENT_TYPE_DIRTY:
+ *     await this.fastDirty(JSON.parse(payload))
+ *     this.emit('dirty', JSON.parse(payload) as PUPPET.payloads.EventDirty)
+ *
+ * which parses the same JSON string twice for every dirty event on the
+ * hot stream path. Parse the payload once and reuse the resulting object.
+ */
+import { test, sinon } from 'tstest';
+import * as PUPPET from '@juzi/wechaty-puppet';
+import { puppet as grpcPuppet } from '@juzi/wechaty-grpc';
+import { PuppetService } from '../src/mod.js';
+test('onGrpcStreamEvent must parse a DIRTY payload only once', async (t) => {
+    const token = `puppet_service_test_${Date.now()}_${Math.floor(Math.random() * 1e6)}`;
+    const puppet = new PuppetService({ token });
+    // Force the fastDirty branch to be a no-op so we measure only the
+    // parsing cost in the dispatch case.
+    puppet.fastDirty = async (_) => { };
+    const dirtyPayload = JSON.stringify({
+        payloadType: PUPPET.types.Dirty.Contact,
+        payloadId: 'x',
+    });
+    // Build a minimal grpcPuppet.EventResponse shape -- only the getters
+    // touched by `onGrpcStreamEvent` are needed.
+    const fakeEvent = {
+        getType: () => grpcPuppet.EventType.EVENT_TYPE_DIRTY,
+        getPayload: () => dirtyPayload,
+        getSeq: () => 0,
+    };
+    const parseSpy = sinon.spy(JSON, 'parse');
+    try {
+        const baseline = parseSpy.callCount;
+        await puppet.onGrpcStreamEvent(fakeEvent);
+        const delta = parseSpy.callCount - baseline;
+        t.equal(delta, 1, `EVENT_TYPE_DIRTY should JSON.parse(payload) only once, observed ${delta}`);
+    }
+    finally {
+        parseSpy.restore();
+    }
+});
+//# sourceMappingURL=grpc-stream-dirty-parse.spec.js.map

package/dist/esm/tests/grpc-stream-dirty-parse.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grpc-stream-dirty-parse.spec.js","sourceRoot":"","sources":["../../../tests/grpc-stream-dirty-parse.spec.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAEpC,OAAO,KAAK,MAAM,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAE7C,IAAI,CAAC,wDAAwD,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACvE,MAAM,KAAK,GAAG,uBAAuB,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,CAAA;IACpF,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,EAAE,KAAK,EAAE,CAAQ,CAAA;IAElD,kEAAkE;IAClE,qCAAqC;IACrC,MAAM,CAAC,SAAS,GAAG,KAAK,EAAE,CAAM,EAAE,EAAE,GAAE,CAAC,CAAA;IAEvC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO;QACvC,SAAS,EAAI,GAAG;KACjB,CAAC,CAAA;IAEF,qEAAqE;IACrE,6CAA6C;IAC7C,MAAM,SAAS,GAAG;QAChB,OAAO,EAAK,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,gBAAgB;QACvD,UAAU,EAAE,GAAG,EAAE,CAAC,YAAY;QAC9B,MAAM,EAAM,GAAG,EAAE,CAAC,CAAC;KACpB,CAAA;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACzC,IAAI;QACF,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAA;QACnC,MAAM,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;QACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAA;QAC3C,CAAC,CAAC,KAAK,CACL,KAAK,EACL,CAAC,EACD,mEAAmE,KAAK,EAAE,CAC3E,CAAA;KACF;YAAS;QACR,QAAQ,CAAC,OAAO,EAAE,CAAA;KACnB;AACH,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-puppet-service",
-  "version": "1.0.119",
+  "version": "1.0.120",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {

package/src/client/puppet-service.ts

@@ -367,10 +367,12 @@ class PuppetService extends PUPPET.Puppet {
           )
         }
         break
-      case grpcPuppet.EventType.EVENT_TYPE_DIRTY:
-        await this.fastDirty(JSON.parse(payload))
-        this.emit('dirty', JSON.parse(payload) as PUPPET.payloads.EventDirty)
+      case grpcPuppet.EventType.EVENT_TYPE_DIRTY: {
+        const dirtyPayload = JSON.parse(payload) as PUPPET.payloads.EventDirty
+        await this.fastDirty(dirtyPayload)
+        this.emit('dirty', dirtyPayload)
         break
+      }
       case grpcPuppet.EventType.EVENT_TYPE_MESSAGE:
         this.emit('message', JSON.parse(payload) as PUPPET.payloads.EventMessage)
         break
@@ -495,6 +497,44 @@ class PuppetService extends PUPPET.Puppet {
     }
   }
 
+  /**
+   * Dirty handler registry, keyed by every `PUPPET.types.Dirty` value.
+   *
+   * Using a full `Record<...>` (rather than `Partial<...>`) means
+   * TypeScript catches a missing entry at compile time -- so when a
+   * new DirtyType is added to wechaty-puppet, callers get a build
+   * error instead of a silent runtime no-op.
+   *
+   * Note: `Unspecified` is treated as an upstream contract violation,
+   * not a benign no-op -- it logs an error and emits 'error' so hosts
+   * notice.
+   */
+  private get _dirtyHandlerMap (): Record<PUPPET.types.Dirty, (id: string) => Promise<unknown>> {
+    return {
+      [PUPPET.types.Dirty.Contact]:      async (id: string) => this._payloadStore.contact?.delete(id),
+      [PUPPET.types.Dirty.Friendship]:   async (_: string) => {},
+      [PUPPET.types.Dirty.Message]:      async (_: string) => {},
+      [PUPPET.types.Dirty.Post]:         async (_: string) => {},
+      [PUPPET.types.Dirty.Room]:         async (id: string) => this._payloadStore.room?.delete(id),
+      [PUPPET.types.Dirty.RoomMember]:   async (id: string) => {
+        const [ roomId ] = id.split(PUPPET.STRING_SPLITTER)
+        if (roomId) {
+          await this._payloadStore.roomMember?.delete(roomId)
+        }
+      },
+      [PUPPET.types.Dirty.Tag]:          async (id: string) => this._payloadStore.tag?.delete(id),
+      [PUPPET.types.Dirty.TagGroup]:     async (id: string) => this._payloadStore.tagGroup?.delete(id),
+      [PUPPET.types.Dirty.WxxdProduct]:  async (_: string) => {},
+      [PUPPET.types.Dirty.WxxdOrder]:    async (_: string) => {},
+      [PUPPET.types.Dirty.Call]:         async (_: string) => {},
+      [PUPPET.types.Dirty.Unspecified]:  async (id: string) => {
+        const msg = `fastDirty() received Unspecified dirty type (id=${id}); upstream puppet is leaking protobuf default — this is a server-side contract bug`
+        log.error('PuppetService', msg)
+        this.emit('error', new Error(msg))
+      },
+    }
+  }
+
   /**
    * `onDirty()` is called when the puppet emit `dirty` event.
    *  the event listener will be registered in `start()` from the `PuppetAbstract` class
@@ -507,20 +547,18 @@ class PuppetService extends PUPPET.Puppet {
   ): Promise<void> {
     log.verbose('PuppetService', 'fastDirty(%s<%s>, %s)', PUPPET.types.Dirty[payloadType], payloadType, payloadId)
 
-    const dirtyMap: Partial<Record<PUPPET.types.Dirty, (id: string) => Promise<unknown>>> = {
-      [PUPPET.types.Dirty.Contact]:      async (id: string) => this._payloadStore.contact?.delete(id),
-      [PUPPET.types.Dirty.Friendship]:   async (_: string) => {},
-      [PUPPET.types.Dirty.Message]:      async (_: string) => {},
-      [PUPPET.types.Dirty.Post]:         async (_: string) => {},
-      [PUPPET.types.Dirty.Room]:         async (id: string) => this._payloadStore.room?.delete(id),
-      [PUPPET.types.Dirty.RoomMember]:   async (id: string) => this._payloadStore.roomMember?.delete(id),
-      [PUPPET.types.Dirty.Tag]:          async (id: string) => this._payloadStore.tag?.delete(id),
-      [PUPPET.types.Dirty.TagGroup]:     async (id: string) => this._payloadStore.tagGroup?.delete(id),
-      [PUPPET.types.Dirty.Unspecified]:  async (id: string) => { throw new Error('Unspecified type with id: ' + id) },
+    // payloadType is typed as the enum, but at runtime the server may emit a
+    // value outside our enum (forward-compat). Look it up via a
+    // possibly-undefined view so the runtime guard stays meaningful.
+    const lookup = this._dirtyHandlerMap as Partial<Record<PUPPET.types.Dirty, (id: string) => Promise<unknown>>>
+    const handler = lookup[payloadType]
+    if (!handler) {
+      log.warn('PuppetService', 'fastDirty() no handler for payloadType=%s', payloadType)
+      return
     }
 
     try {
-      await dirtyMap[payloadType]?.(payloadId)
+      await handler(payloadId)
     } catch (error) {
       this.emit('error', error)
     }

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.119",
+  "version": "1.0.120",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {