@juzi/wechaty-puppet-service 1.0.123 → 1.0.125

package/dist/esm/tests/dirty-gen-guard.spec.js

@@ -0,0 +1,178 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+/**
+ * Regression tests for the FlashStore write-back generation guard.
+ *
+ * `_payloadStore` (FlashStore, on disk) is a cache layer independent of
+ * the puppet-side LRU. Before this fix it had no protection against the
+ * "dirty lands during a raw fetch" race:
+ *
+ *   1. A raw fetch (e.g. `contactRawPayload`) starts a gRPC round-trip.
+ *   2. An EVENT_TYPE_DIRTY arrives; `fastDirty` deletes the FlashStore row.
+ *   3. The in-flight fetch resolves and writes the *pre-dirty* payload
+ *      back into the FlashStore -- re-poisoning the row that was just
+ *      cleared. The value then only refreshes after a *second* dirty.
+ *
+ * The fix snapshots a per-(type, id) generation counter before the raw
+ * fetch and re-checks it with `isFreshWrite` before every FlashStore
+ * write-back; the EVENT_TYPE_DIRTY handler bumps that counter before it
+ * even awaits `fastDirty`, so the whole delete window is covered.
+ */
+import { test } from 'tstest';
+import os from 'os';
+import path from 'path';
+import fs from 'fs';
+import * as PUPPET from '@juzi/wechaty-puppet';
+import { puppet as grpcPuppet } from '@juzi/wechaty-grpc';
+import { PuppetService } from '../src/mod.js';
+const makePuppet = async () => {
+    const token = `puppet_service_test_${Date.now()}_${Math.floor(Math.random() * 1e6)}`;
+    const puppet = new PuppetService({ token });
+    const accountId = 'acct-test';
+    await puppet._payloadStore.start(accountId);
+    return { puppet, token };
+};
+const cleanup = async (puppet, token) => {
+    await puppet._payloadStore.stop();
+    try {
+        await fs.promises.rm(path.join(os.homedir(), '.wechaty', 'wechaty-puppet-service', token), { recursive: true, force: true });
+    }
+    catch (_) { /* ignore */ }
+};
+/**
+ * A one-shot gate for a fake gRPC method. The method resolves `entered`
+ * as soon as it is invoked (by which point the caller's gen snapshot has
+ * already been taken, since the snapshot precedes the fetch call), then
+ * holds its callback until `release()` is called. This lets the test slot
+ * a dirty deterministically between the fetch start (gen snapshot) and
+ * the fetch resolution (write-back) -- no timers, no flakiness.
+ */
+const makeGate = () => {
+    let release = () => { };
+    let markEntered = () => { };
+    const gate = new Promise(resolve => { release = resolve; });
+    const entered = new Promise(resolve => { markEntered = resolve; });
+    return { gate, entered, enter: () => markEntered(), release: () => release() };
+};
+test('contactRawPayload: a dirty mid-fetch skips the stale FlashStore write-back', async (t) => {
+    const { puppet, token } = await makePuppet();
+    const contactId = 'contact-race';
+    const response = new grpcPuppet.ContactPayloadResponse();
+    response.setId(contactId);
+    response.setName('stale-name-from-inflight-fetch');
+    const { gate, entered, enter, release } = makeGate();
+    puppet._grpcManager = {
+        client: {
+            contactPayload: (_req, cb) => {
+                enter();
+                void (async () => {
+                    await gate;
+                    cb(null, response);
+                })();
+            },
+        },
+    };
+    // Start the fetch: it snapshots the gen, then blocks on the gate.
+    const fetchPromise = puppet.contactRawPayload(contactId);
+    // Deterministic: once the fake method is entered, the snapshot is taken.
+    await entered;
+    // A dirty arrives while the fetch is in flight: bump gen + clear store,
+    // exactly as the EVENT_TYPE_DIRTY handler does.
+    puppet.cache.bumpGen(PUPPET.types.Dirty.Contact, contactId);
+    await puppet.fastDirty({ payloadType: PUPPET.types.Dirty.Contact, payloadId: contactId });
+    // Now let the stale fetch resolve into the write-back path.
+    release();
+    const returned = await fetchPromise;
+    t.equal(returned.id, contactId, 'raw fetch still returns its payload to the caller');
+    const stored = await puppet._payloadStore.contact.get(contactId);
+    t.notOk(stored, 'stale in-flight fetch must NOT re-poison the FlashStore after the dirty');
+    await cleanup(puppet, token);
+});
+test('contactRawPayload: no dirty means the write-back proceeds as usual', async (t) => {
+    const { puppet, token } = await makePuppet();
+    const contactId = 'contact-happy';
+    const response = new grpcPuppet.ContactPayloadResponse();
+    response.setId(contactId);
+    response.setName('fresh-name');
+    puppet._grpcManager = {
+        client: {
+            contactPayload: (_req, cb) => cb(null, response),
+        },
+    };
+    const returned = await puppet.contactRawPayload(contactId);
+    t.equal(returned.id, contactId, 'raw fetch returns its payload');
+    const stored = await puppet._payloadStore.contact.get(contactId);
+    t.ok(stored, 'without a racing dirty the payload is written to the FlashStore');
+    t.equal(stored && stored.id, contactId, 'stored payload matches the fetched id');
+    await cleanup(puppet, token);
+});
+test('EVENT_TYPE_DIRTY bumps gen before awaiting fastDirty so pre-event snapshots are stale', async (t) => {
+    const { puppet, token } = await makePuppet();
+    const contactId = 'contact-bump';
+    // A getter that snapshotted just before the event arrived.
+    const snapshot = puppet.cache.snapshotGen(PUPPET.types.Dirty.Contact, contactId);
+    const dirtyJson = JSON.stringify({
+        payloadType: PUPPET.types.Dirty.Contact,
+        payloadId: contactId,
+    });
+    await puppet.onGrpcStreamEvent({
+        getType: () => grpcPuppet.EventType.EVENT_TYPE_DIRTY,
+        getPayload: () => dirtyJson,
+        getSeq: () => 0,
+    });
+    t.notOk(puppet.cache.isFreshWrite(PUPPET.types.Dirty.Contact, contactId, snapshot), 'a snapshot taken before the dirty event must be judged stale afterwards');
+    await cleanup(puppet, token);
+});
+test('EVENT_TYPE_DIRTY compound RoomMember bumps both the compound and the room-level gen', async (t) => {
+    const { puppet, token } = await makePuppet();
+    const roomId = 'room-bump';
+    const memberId = 'member-bump';
+    const compoundId = `${roomId}${PUPPET.STRING_SPLITTER}${memberId}`;
+    const compoundSnap = puppet.cache.snapshotGen(PUPPET.types.Dirty.RoomMember, compoundId);
+    const roomSnap = puppet.cache.snapshotGen(PUPPET.types.Dirty.RoomMember, roomId);
+    const dirtyJson = JSON.stringify({
+        payloadType: PUPPET.types.Dirty.RoomMember,
+        payloadId: compoundId,
+    });
+    await puppet.onGrpcStreamEvent({
+        getType: () => grpcPuppet.EventType.EVENT_TYPE_DIRTY,
+        getPayload: () => dirtyJson,
+        getSeq: () => 0,
+    });
+    t.notOk(puppet.cache.isFreshWrite(PUPPET.types.Dirty.RoomMember, compoundId, compoundSnap), 'the compound (roomId+SEP+memberId) key must be bumped');
+    t.notOk(puppet.cache.isFreshWrite(PUPPET.types.Dirty.RoomMember, roomId, roomSnap), 'the bare room-level key must also be bumped so row-level write-backs are guarded');
+    await cleanup(puppet, token);
+});
+test('roomMemberRawPayload: a room-level dirty mid-fetch skips the row write-back', async (t) => {
+    const { puppet, token } = await makePuppet();
+    const roomId = 'room-member-race';
+    const contactId = 'member-race';
+    const response = new grpcPuppet.RoomMemberPayloadResponse();
+    response.setId(contactId);
+    response.setName('stale-member-from-inflight-fetch');
+    const { gate, entered, enter, release } = makeGate();
+    puppet._grpcManager = {
+        client: {
+            roomMemberPayload: (_req, cb) => {
+                enter();
+                void (async () => {
+                    await gate;
+                    cb(null, response);
+                })();
+            },
+        },
+    };
+    // Start the fetch: it snapshots the room-level gen before reading the
+    // row, then blocks on the gate.
+    const fetchPromise = puppet.roomMemberRawPayload(roomId, contactId);
+    await entered;
+    // A bare-roomId dirty lands mid-fetch: the whole member set is stale.
+    puppet.cache.bumpGen(PUPPET.types.Dirty.RoomMember, roomId);
+    await puppet.fastDirty({ payloadType: PUPPET.types.Dirty.RoomMember, payloadId: roomId });
+    release();
+    const returned = await fetchPromise;
+    t.equal(returned.id, contactId, 'raw fetch still returns its member payload to the caller');
+    const stored = await puppet._payloadStore.roomMember.get(roomId);
+    t.notOk(stored, 'stale in-flight member fetch must NOT re-create the row after the dirty');
+    await cleanup(puppet, token);
+});
+//# sourceMappingURL=dirty-gen-guard.spec.js.map

package/dist/esm/tests/dirty-gen-guard.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dirty-gen-guard.spec.js","sourceRoot":"","sources":["../../../tests/dirty-gen-guard.spec.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,MAAM,IAAI,CAAA;AAEnB,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,MAAM,UAAU,GAAG,KAAK,IAAI,EAAE;IAC5B,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;IAClD,MAAM,SAAS,GAAG,WAAW,CAAA;IAC7B,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IAC3C,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;AAC1B,CAAC,CAAA;AAED,MAAM,OAAO,GAAG,KAAK,EAAE,MAAW,EAAE,KAAa,EAAE,EAAE;IACnD,MAAM,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,CAAA;IACjC,IAAI;QACF,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAClB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,UAAU,EAAE,wBAAwB,EAAE,KAAK,CAAC,EACpE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CACjC,CAAA;KACF;IAAC,OAAO,CAAC,EAAE,EAAE,YAAY,EAAE;AAC9B,CAAC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,QAAQ,GAAG,GAAG,EAAE;IACpB,IAAI,OAAO,GAAe,GAAG,EAAE,GAAE,CAAC,CAAA;IAClC,IAAI,WAAW,GAAe,GAAG,EAAE,GAAE,CAAC,CAAA;IACtC,MAAM,IAAI,GAAM,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE,GAAG,OAAO,GAAG,OAAO,CAAA,CAAC,CAAC,CAAC,CAAA;IACnE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE,GAAG,WAAW,GAAG,OAAO,CAAA,CAAC,CAAC,CAAC,CAAA;IACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAA;AAChF,CAAC,CAAA;AAED,IAAI,CAAC,4EAA4E,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC3F,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,UAAU,EAAE,CAAA;IAE5C,MAAM,SAAS,GAAG,cAAc,CAAA;IAChC,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,sBAAsB,EAAE,CAAA;IACxD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IACzB,QAAQ,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAA;IAElD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,CAAA;IACpD,MAAM,CAAC,YAAY,GAAG;QACpB,MAAM,EAAE;YACN,cAAc,EAAE,CAAC,IAAS,EAAE,EAA8B,EAAE,EAAE;gBAC5D,KAAK,EAAE,CAAA;gBACP,KAAK,CAAC,KAAK,IAAI,EAAE;oBACf,MAAM,IAAI,CAAA;oBACV,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;gBACpB,CAAC,CAAC,EAAE,CAAA;YACN,CAAC;SACF;KACF,CAAA;IAED,kEAAkE;IAClE,MAAM,YAAY,GAAG,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;IACxD,yEAAyE;IACzE,MAAM,OAAO,CAAA;IAEb,wEAAwE;IACxE,gDAAgD;IAChD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAC3D,MAAM,MAAM,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAA;IAEzF,4DAA4D;IAC5D,OAAO,EAAE,CAAA;IACT,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAA;IAEnC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,mDAAmD,CAAC,CAAA;IACpF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IAChE,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,yEAAyE,CAAC,CAAA;IAE1F,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC9B,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,oEAAoE,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACnF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,UAAU,EAAE,CAAA;IAE5C,MAAM,SAAS,GAAG,eAAe,CAAA;IACjC,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,sBAAsB,EAAE,CAAA;IACxD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IACzB,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;IAE9B,MAAM,CAAC,YAAY,GAAG;QACpB,MAAM,EAAE;YACN,cAAc,EAAE,CAAC,IAAS,EAAE,EAA8B,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC;SAClF;KACF,CAAA;IAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;IAC1D,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,+BAA+B,CAAC,CAAA;IAEhE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IAChE,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,iEAAiE,CAAC,CAAA;IAC/E,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,uCAAuC,CAAC,CAAA;IAEhF,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC9B,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,uFAAuF,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACtG,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,UAAU,EAAE,CAAA;IAE5C,MAAM,SAAS,GAAG,cAAc,CAAA;IAChC,2DAA2D;IAC3D,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAEhF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO;QACvC,SAAS,EAAI,SAAS;KACvB,CAAC,CAAA;IACF,MAAM,MAAM,CAAC,iBAAiB,CAAC;QAC7B,OAAO,EAAK,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,gBAAgB;QACvD,UAAU,EAAE,GAAG,EAAE,CAAC,SAAS;QAC3B,MAAM,EAAM,GAAG,EAAE,CAAC,CAAC;KACpB,CAAC,CAAA;IAEF,CAAC,CAAC,KAAK,CACL,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,EAC1E,yEAAyE,CAC1E,CAAA;IAED,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC9B,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,qFAAqF,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACpG,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,UAAU,EAAE,CAAA;IAE5C,MAAM,MAAM,GAAO,WAAW,CAAA;IAC9B,MAAM,QAAQ,GAAK,aAAa,CAAA;IAChC,MAAM,UAAU,GAAG,GAAG,MAAM,GAAG,MAAM,CAAC,eAAe,GAAG,QAAQ,EAAE,CAAA;IAElE,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;IACxF,MAAM,QAAQ,GAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IAEpF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU;QAC1C,SAAS,EAAI,UAAU;KACxB,CAAC,CAAA;IACF,MAAM,MAAM,CAAC,iBAAiB,CAAC;QAC7B,OAAO,EAAK,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,gBAAgB;QACvD,UAAU,EAAE,GAAG,EAAE,CAAC,SAAS;QAC3B,MAAM,EAAM,GAAG,EAAE,CAAC,CAAC;KACpB,CAAC,CAAA;IAEF,CAAC,CAAC,KAAK,CACL,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC,EAClF,uDAAuD,CACxD,CAAA;IACD,CAAC,CAAC,KAAK,CACL,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC1E,kFAAkF,CACnF,CAAA;IAED,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC9B,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,6EAA6E,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC5F,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,UAAU,EAAE,CAAA;IAE5C,MAAM,MAAM,GAAM,kBAAkB,CAAA;IACpC,MAAM,SAAS,GAAG,aAAa,CAAA;IAE/B,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,yBAAyB,EAAE,CAAA;IAC3D,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IACzB,QAAQ,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAA;IAEpD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,CAAA;IACpD,MAAM,CAAC,YAAY,GAAG;QACpB,MAAM,EAAE;YACN,iBAAiB,EAAE,CAAC,IAAS,EAAE,EAA8B,EAAE,EAAE;gBAC/D,KAAK,EAAE,CAAA;gBACP,KAAK,CAAC,KAAK,IAAI,EAAE;oBACf,MAAM,IAAI,CAAA;oBACV,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;gBACpB,CAAC,CAAC,EAAE,CAAA;YACN,CAAC;SACF;KACF,CAAA;IAED,sEAAsE;IACtE,gCAAgC;IAChC,MAAM,YAAY,GAAG,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACnE,MAAM,OAAO,CAAA;IAEb,sEAAsE;IACtE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IAC3D,MAAM,MAAM,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAA;IAEzF,OAAO,EAAE,CAAA;IACT,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAA;IAEnC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,0DAA0D,CAAC,CAAA;IAC3F,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAChE,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,yEAAyE,CAAC,CAAA;IAE1F,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC9B,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-puppet-service",
-  "version": "1.0.123",
+  "version": "1.0.125",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {
@@ -51,11 +51,12 @@
     "@chatie/eslint-config": "^1.0.4",
     "@chatie/semver": "^0.4.7",
     "@chatie/tsconfig": "^4.6.3",
-    "@juzi/wechaty-puppet": "^1.0.146",
+    "@juzi/wechaty-puppet": "^1.0.150",
     "@juzi/wechaty-puppet-mock": "^1.0.1",
     "@swc/core": "1.3.39",
     "@types/google-protobuf": "^3.15.5",
     "@types/lru-cache": "^7.5.0",
+    "@types/node": "^20",
     "@types/semver": "^7.3.9",
     "@types/temp": "^0.9.1",
     "@types/uuid": "^8.3.4",
@@ -70,7 +71,7 @@
     "why-is-node-running": "^2.2.1"
   },
   "peerDependencies": {
-    "@juzi/wechaty-puppet": "^1.0.143"
+    "@juzi/wechaty-puppet": "^1.0.150"
   },
   "dependencies": {
     "@juzi/wechaty-grpc": "^1.0.106",

package/src/client/grpc-manager.ts

@@ -21,7 +21,10 @@ import util from 'util'
 import EventEmitter from 'events'
 import crypto from 'crypto'
 
-import { log } from '@juzi/wechaty-puppet'
+import {
+  log,
+  type LoggerLike,
+}                     from '@juzi/wechaty-puppet'
 import {
   grpc,
   puppet,
@@ -78,14 +81,17 @@ class GrpcManager extends EventEmitter {
   serverName : string
   token      : WechatyToken
 
+  private readonly _log: LoggerLike
+
   constructor (private options: PuppetServiceOptions) {
     super()
-    log.verbose('GrpcManager', 'constructor(%s)', JSON.stringify(options))
+    this._log = options.logger ?? log
+    this._log.verbose('GrpcManager', 'constructor(%s)', JSON.stringify(options))
 
     this.caCert = Buffer.from(
       envVars.WECHATY_PUPPET_SERVICE_TLS_CA_CERT(this.options.tls?.caCert) || TLS_CA_CERT,
     )
-    log.verbose('GrpcManager', 'constructor() tlsRootCert(hash): "%s"',
+    this._log.verbose('GrpcManager', 'constructor() tlsRootCert(hash): "%s"',
       crypto.createHash('sha256')
         .update(this.caCert)
         .digest('hex'),
@@ -97,7 +103,7 @@ class GrpcManager extends EventEmitter {
     this.token = new WechatyToken(
       envVars.WECHATY_PUPPET_SERVICE_TOKEN(this.options.token),
     )
-    log.verbose('GrpcManager', 'constructor() token: "%s"', this.token)
+    this._log.verbose('GrpcManager', 'constructor() token: "%s"', this.token)
 
     this.endpoint = envVars.WECHATY_PUPPET_SERVICE_ENDPOINT(this.options.endpoint)
       /**
@@ -110,13 +116,13 @@ class GrpcManager extends EventEmitter {
         '/',
         this.token,
       ].join('')
-    log.verbose('GrpcManager', 'constructor() endpoint: "%s"', this.endpoint)
+    this._log.verbose('GrpcManager', 'constructor() endpoint: "%s"', this.endpoint)
 
     /**
      * Disable TLS
      */
     this.disableTls = envVars.WECHATY_PUPPET_SERVICE_NO_TLS_INSECURE_CLIENT(this.options.tls?.disable)
-    log.verbose('GrpcManager', 'constructor() disableTls: "%s"', this.disableTls)
+    this._log.verbose('GrpcManager', 'constructor() disableTls: "%s"', this.disableTls)
 
     /**
      * for Node.js TLS SNI
@@ -141,59 +147,59 @@ class GrpcManager extends EventEmitter {
     }
 
     this.serverName = serverNameIndication
-    log.verbose('GrpcManager', 'constructor() serverName(SNI): "%s"', this.serverName)
+    this._log.verbose('GrpcManager', 'constructor() serverName(SNI): "%s"', this.serverName)
   }
 
   async start (lastEventSeq?: string, accountId?: string): Promise<void> {
-    log.verbose('GrpcManager', 'start()')
+    this._log.verbose('GrpcManager', 'start()')
 
     /**
      * 1. Init grpc client
      */
-    log.verbose('GrpcManager', 'start() initializing client ...')
+    this._log.verbose('GrpcManager', 'start() initializing client ...')
     await this.initClient()
-    log.verbose('GrpcManager', 'start() initializing client ... done')
+    this._log.verbose('GrpcManager', 'start() initializing client ... done')
 
     /**
      * 2. Connect to stream
      */
-    log.verbose('GrpcManager', 'start() starting stream ...')
+    this._log.verbose('GrpcManager', 'start() starting stream ...')
     await this.startStream(lastEventSeq, accountId)
-    log.verbose('GrpcManager', 'start() starting stream ... done')
+    this._log.verbose('GrpcManager', 'start() starting stream ... done')
 
     /**
      * 3. Start the puppet
      */
-    log.verbose('GrpcManager', 'start() calling grpc server: start() ...')
+    this._log.verbose('GrpcManager', 'start() calling grpc server: start() ...')
     await util.promisify(
       this.client.start
         .bind(this.client),
     )(new puppet.StartRequest())
-    log.verbose('GrpcManager', 'start() calling grpc server: start() ... done')
+    this._log.verbose('GrpcManager', 'start() calling grpc server: start() ... done')
 
-    log.verbose('GrpcManager', 'start() ... done')
+    this._log.verbose('GrpcManager', 'start() ... done')
   }
 
   async stop (): Promise<void> {
-    log.verbose('GrpcManager', 'stop()')
+    this._log.verbose('GrpcManager', 'stop()')
 
     /**
      * 1. Disconnect from stream
      */
-    log.verbose('GrpcManager', 'stop() stop stream ...')
+    this._log.verbose('GrpcManager', 'stop() stop stream ...')
     this.stopStream()
-    log.verbose('GrpcManager', 'stop() stop stream ... done')
+    this._log.verbose('GrpcManager', 'stop() stop stream ... done')
 
     /**
      * 2. Stop the puppet
      */
     try {
-      log.verbose('GrpcManager', 'stop() stop client ...')
+      this._log.verbose('GrpcManager', 'stop() stop client ...')
       await util.promisify(
         this.client.stop
           .bind(this.client),
       )(new puppet.StopRequest())
-      log.verbose('GrpcManager', 'stop() stop client ... done')
+      this._log.verbose('GrpcManager', 'stop() stop client ... done')
     } catch (e) {
       this.emit('error', e)
     }
@@ -202,18 +208,18 @@ class GrpcManager extends EventEmitter {
      * 3. Destroy grpc client
      */
     try {
-      log.verbose('GrpcManager', 'stop() destroy client ...')
+      this._log.verbose('GrpcManager', 'stop() destroy client ...')
       this.destroyClient()
-      log.verbose('GrpcManager', 'stop() destroy client ... done')
+      this._log.verbose('GrpcManager', 'stop() destroy client ... done')
     } catch (e) {
       this.emit('error', e)
     }
 
-    log.verbose('GrpcManager', 'stop() ... done')
+    this._log.verbose('GrpcManager', 'stop() ... done')
   }
 
   protected async initClient (): Promise<void> {
-    log.verbose('GrpcManager', 'initClient()')
+    this._log.verbose('GrpcManager', 'initClient()')
 
     /**
      * Huan(202108): for maximum compatible with the non-tls community servers/clients,
@@ -222,10 +228,10 @@ class GrpcManager extends EventEmitter {
      */
     let credential
     if (this.disableTls) {
-      log.warn('GrpcManager', 'initClient() TLS: disabled (INSECURE)')
+      this._log.warn('GrpcManager', 'initClient() TLS: disabled (INSECURE)')
       credential = grpc.credentials.createInsecure()
     } else {
-      log.verbose('GrpcManager', 'initClient() TLS: enabled')
+      this._log.verbose('GrpcManager', 'initClient() TLS: enabled')
       const callCred    = callCredToken(this.token.token)
       const channelCred = grpc.credentials.createSsl(this.caCert)
       const combCreds   = grpc.credentials.combineChannelCredentials(channelCred, callCred)
@@ -252,7 +258,7 @@ class GrpcManager extends EventEmitter {
     }
 
     if (this._client) {
-      log.warn('GrpcManager', 'initClient() this.#client exists? Old client has been dropped.')
+      this._log.warn('GrpcManager', 'initClient() this.#client exists? Old client has been dropped.')
       this._client = undefined
     }
 
@@ -262,14 +268,14 @@ class GrpcManager extends EventEmitter {
       clientOptions,
     )
 
-    log.verbose('GrpcManager', 'initClient() ... done')
+    this._log.verbose('GrpcManager', 'initClient() ... done')
   }
 
   protected destroyClient (): void {
-    log.verbose('GrpcManager', 'destroyClient()')
+    this._log.verbose('GrpcManager', 'destroyClient()')
 
     if (!this._client) {
-      log.warn('GrpcManager', 'destroyClient() this.#client not exist')
+      this._log.warn('GrpcManager', 'destroyClient() this.#client not exist')
       return
     }
 
@@ -283,19 +289,19 @@ class GrpcManager extends EventEmitter {
     try {
       client.close()
     } catch (e) {
-      log.error('GrpcManager', 'destroyClient() client.close() rejection: %s\n%s', e && (e as Error).message, (e as Error).stack)
+      this._log.error('GrpcManager', 'destroyClient() client.close() rejection: %s\n%s', e && (e as Error).message, (e as Error).stack)
     }
   }
 
   async startStream (lastEventSeq?: string, accountId?: string): Promise<void> {
-    log.verbose('GrpcManager', 'startStream()')
+    this._log.verbose('GrpcManager', 'startStream()')
 
     if (this.eventStream) {
-      log.verbose('GrpcManager', 'startStream() this.eventStream exists, dropped.')
+      this._log.verbose('GrpcManager', 'startStream() this.eventStream exists, dropped.')
       this.eventStream = undefined
     }
 
-    log.verbose('GrpcManager', 'startStream() grpc -> event() ...')
+    this._log.verbose('GrpcManager', 'startStream() grpc -> event() ...')
 
     const eventRequest = new puppet.EventRequest()
     if (lastEventSeq) {
@@ -304,10 +310,10 @@ class GrpcManager extends EventEmitter {
     if (accountId) {
       eventRequest.setAccountId(accountId)
     }
-    log.info('GrpcManager', `startStream() connecting event stream with account ${accountId} and seq ${lastEventSeq}`)
+    this._log.info('GrpcManager', `startStream() connecting event stream with account ${accountId} and seq ${lastEventSeq}`)
 
     const eventStream = this.client.event(eventRequest)
-    log.verbose('GrpcManager', 'startStream() grpc -> event() ... done')
+    this._log.verbose('GrpcManager', 'startStream() grpc -> event() ... done')
 
     /**
      * Store the event data from the stream when we test connection,
@@ -374,13 +380,13 @@ class GrpcManager extends EventEmitter {
      *  if a puppet service provider is coming from the community, it might not follow the protocol specification.
      * So we need a timeout for compatible with those providers
      */
-    log.verbose('GrpcManager', 'startStream() grpc -> event peeking data or timeout ...')
+    this._log.verbose('GrpcManager', 'startStream() grpc -> event peeking data or timeout ...')
     try {
       await timeoutPromise(future, 5 * 1000)  // 5 seconds
     } catch (_) {
-      log.verbose('GrpcManager', 'startStream() grpc -> event peeking data or timeout ... timeout')
+      this._log.verbose('GrpcManager', 'startStream() grpc -> event peeking data or timeout ... timeout')
     }
-    log.verbose('GrpcManager', 'startStream() grpc -> event peeking data or timeout ... data peeked')
+    this._log.verbose('GrpcManager', 'startStream() grpc -> event peeking data or timeout ... data peeked')
 
     /**
      * Bridge the events
@@ -389,7 +395,7 @@ class GrpcManager extends EventEmitter {
      *  so that if there's any `error` event,
      *  it will be triggered already.
      */
-    log.verbose('GrpcManager', 'startStream() initializing event stream ...')
+    this._log.verbose('GrpcManager', 'startStream() initializing event stream ...')
     eventStream
       .on('cancel',   (...args) => this.emit('cancel',    ...args))
       .on('data',     (...args) => this.emit('data',      ...args))
@@ -399,26 +405,26 @@ class GrpcManager extends EventEmitter {
       .on('status',   (...args) => this.emit('status',    ...args))
 
     this.eventStream = eventStream
-    log.verbose('GrpcManager', 'startStream() initializing event stream ... done')
+    this._log.verbose('GrpcManager', 'startStream() initializing event stream ... done')
 
     /**
      * Re-emit the peeked data if there' s any
      */
     if (peekedData) {
-      log.verbose('GrpcManager', 'startStream() sending back the peeked data ...')
+      this._log.verbose('GrpcManager', 'startStream() sending back the peeked data ...')
       this.emit('data', peekedData)
       peekedData = undefined
-      log.verbose('GrpcManager', 'startStream() sending back the peeked data ... done')
+      this._log.verbose('GrpcManager', 'startStream() sending back the peeked data ... done')
     }
 
-    log.verbose('GrpcManager', 'startStream() ... done')
+    this._log.verbose('GrpcManager', 'startStream() ... done')
   }
 
   stopStream (): void {
-    log.verbose('GrpcManager', 'stopStream()')
+    this._log.verbose('GrpcManager', 'stopStream()')
 
     if (!this.eventStream) {
-      log.verbose('GrpcManager', 'stopStream() no eventStream when stop, skip destroy.')
+      this._log.verbose('GrpcManager', 'stopStream() no eventStream when stop, skip destroy.')
       return
     }
     /**
@@ -436,9 +442,9 @@ class GrpcManager extends EventEmitter {
     // this.eventStream.cancel()
 
     try {
-      log.verbose('GrpcManager', 'stopStream() destroying event stream ...')
+      this._log.verbose('GrpcManager', 'stopStream() destroying event stream ...')
       eventStream.destroy()
-      log.verbose('GrpcManager', 'stopStream() destroying event stream ... done')
+      this._log.verbose('GrpcManager', 'stopStream() destroying event stream ... done')
     } catch (e) {
       this.emit('error', e)
     }

package/src/client/payload-store.ts

@@ -33,10 +33,13 @@ import {
 }             from '../config.js'
 import { WECHATY_PUPPET_SERVICE_DISABLE_EVENT_CACHE } from '../env-vars.js'
 
+type LoggerLike = PUPPET.LoggerLike
+
 const { major, minor } = semverPkg
 
 interface PayloadStoreOptions {
-  token: string
+  token   : string
+  logger? : LoggerLike
 }
 
 interface StoreRoomMemberPayload {
@@ -57,8 +60,11 @@ class PayloadStore {
   protected storeDir:   string
   protected accountId?: string
 
+  private readonly _log: LoggerLike
+
   constructor (private options: PayloadStoreOptions) {
-    log.verbose('PayloadStore', 'constructor(%s)', JSON.stringify(options))
+    this._log = options.logger ?? log
+    this._log.verbose('PayloadStore', 'constructor(%s)', JSON.stringify(options))
 
     this.storeDir = path.join(
       os.homedir(),
@@ -67,7 +73,7 @@ class PayloadStore {
       this.options.token,
       `v${major(VERSION)}.${minor(VERSION)}`,
     )
-    log.silly('PayloadStore', 'constructor() storeDir: "%s"', this.storeDir)
+    this._log.silly('PayloadStore', 'constructor() storeDir: "%s"', this.storeDir)
 
     if (!fs.existsSync(this.storeDir)) {
       fs.mkdirSync(this.storeDir, { recursive: true })
@@ -83,7 +89,7 @@ class PayloadStore {
    *  so that we can save the payloads under a specific account folder.
    */
   async start (accountId: string): Promise<void> {
-    log.verbose('PayloadStore', 'start(%s)', accountId)
+    this._log.verbose('PayloadStore', 'start(%s)', accountId)
 
     if (this.accountId) {
       throw new Error('PayloadStore should be stop() before start() again.')
@@ -112,7 +118,7 @@ class PayloadStore {
      */
     // const lruOptions: LRU.Options<string, MessagePayload> = {
     //   dispose (key, val) {
-    //     log.silly('PayloadStore', `constructor() lruOptions.dispose(${key}, ${JSON.stringify(val)})`)
+    //     this._log.silly('PayloadStore', `constructor() lruOptions.dispose(${key}, ${JSON.stringify(val)})`)
     //   },
     //   max    : 1000,  // 1000 messages
     //   maxAge : 60 * 60 * 1000,  // 1 hour
@@ -121,7 +127,7 @@ class PayloadStore {
   }
 
   async stop (): Promise<void> {
-    log.verbose('PayloadStore', 'stop()')
+    this._log.verbose('PayloadStore', 'stop()')
 
     const contactStore    = this.contact
     const roomMemberStore = this.roomMember
@@ -153,7 +159,7 @@ class PayloadStore {
   }
 
   async destroy (): Promise<void> {
-    log.verbose('PayloadStore', 'destroy()')
+    this._log.verbose('PayloadStore', 'destroy()')
     if (this.accountId) {
       throw new Error('Can not destroy() a start()-ed store. Call stop() to stop it first')
     }