@zapo-js/fake-server 1.0.0 → 1.1.0

package/dist/api/FakeWaServer.js

@@ -1,127 +1,98 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FakeWaServer = void 0;
+exports.FakeWaServer = exports.FakeServerSession = void 0;
 const node_https_1 = require("node:https");
 const WaFakeConnectionPipeline_1 = require("../infra/WaFakeConnectionPipeline");
 const WaFakeMediaHttpsServer_1 = require("../infra/WaFakeMediaHttpsServer");
 const WaFakeWsServer_1 = require("../infra/WaFakeWsServer");
 const cert_chain_1 = require("../protocol/auth/cert-chain");
-const router_1 = require("../protocol/iq/router");
 const fake_media_store_1 = require("../state/fake-media-store");
 const crypto_1 = require("../transport/crypto");
-const AppStateSyncManager_1 = require("./AppStateSyncManager");
 const FakePairingDriver_1 = require("./FakePairingDriver");
 const FakePeer_1 = require("./FakePeer");
-const iq_handlers_1 = require("./iq-handlers");
-const PreKeyDispenser_1 = require("./PreKeyDispenser");
+const FakeServerSession_1 = require("./FakeServerSession");
 const Scenario_1 = require("./Scenario");
-const ServerRegistries_1 = require("./ServerRegistries");
+var FakeServerSession_2 = require("./FakeServerSession");
+Object.defineProperty(exports, "FakeServerSession", { enumerable: true, get: function () { return FakeServerSession_2.FakeServerSession; } });
 class FakeWaServer {
     constructor(options = {}) {
-        this.registries = new ServerRegistries_1.ServerRegistries();
-        this.preKeyDispenser = new PreKeyDispenser_1.PreKeyDispenser();
-        this.appStateSync = new AppStateSyncManager_1.AppStateSyncManager();
         this.pipelines = new Set();
-        this.iqRouter = new router_1.WaFakeIqRouter();
-        this.capturedStanzas = [];
-        this.pendingIqExpectations = new Set();
-        this.pendingStanzaExpectations = new Set();
+        this.pipelineSessions = new WeakMap();
         this.authenticatedListeners = new Set();
-        this.inboundStanzaListeners = new Set();
-        this.capturedStanzaListeners = new Set();
+        this.sessions = new Map();
+        this.globalIqHandlers = new Set();
         this.rootCa = null;
         this.serverStaticKeyPair = null;
         this.listenInfo = null;
-        this.pipelineListener = null;
+        this.pipelineListeners = new Set();
         this.rejectMode = null;
         this.mediaStore = new fake_media_store_1.FakeMediaStore();
         this.mediaHttpsServer = new WaFakeMediaHttpsServer_1.WaFakeMediaHttpsServer();
         this.capturedMediaUploads = [];
         this.nextUploadCounter = 0;
         this.cachedMediaProxyAgent = null;
+        this.options = options;
         this.wsServer = new WaFakeWsServer_1.WaFakeWsServer(options);
         this.wsServer.onConnection((connection) => this.handleConnection(connection));
-        (0, iq_handlers_1.registerDefaultIqHandlers)(this.iqRouter, this.buildIqHandlerDeps());
+        this.defaultSession = this.createSession('__default__');
     }
-    buildIqHandlerDeps() {
-        const reg = this.registries;
-        const preKey = this.preKeyDispenser;
-        const appState = this.appStateSync;
-        return {
-            get peerRegistry() {
-                return reg.peerRegistry;
-            },
-            get groupRegistry() {
-                return reg.groupRegistry;
-            },
-            get privacySettings() {
-                return reg.privacySettings;
-            },
-            get blocklistJids() {
-                return reg.blocklistJids;
-            },
-            get profilePicturesByJid() {
-                return reg.profilePicturesByJid;
-            },
-            get businessProfilesByJid() {
-                return reg.businessProfilesByJid;
-            },
-            get abPropsInput() {
-                return reg.abPropsInput;
-            },
-            get issuedPrivacyTokens() {
-                return reg.issuedPrivacyTokens;
-            },
-            get latestStatusText() {
-                return reg.latestStatusText;
-            },
-            setLatestStatusText: (text) => {
-                reg.latestStatusText = text;
-            },
-            lookupDeviceIdsForUser: (userJid) => reg.lookupDeviceIdsForUser(userJid),
-            notifyGroupOp: (op) => reg.notifyGroupOp(op),
-            mutatePrivacySettings: (category, value) => reg.mutatePrivacySettings(category, value),
-            mutateBlocklist: (action, jid) => reg.mutateBlocklist(action, jid),
-            notifyProfilePictureSet: (op) => reg.notifyProfilePictureSet(op),
-            handleProfilePictureSet: (targetJid, newId) => reg.handleProfilePictureSet(targetJid, newId),
-            notifyStatusSet: (text) => reg.notifyStatusSet(text),
-            notifyLogout: () => reg.notifyLogout(),
-            notifyPrivacyTokenIssue: (token) => reg.notifyPrivacyTokenIssue(token),
-            notifyDirtyBitsClear: (op) => reg.notifyDirtyBitsClear(op),
-            notifyPrivacySet: (change) => {
-                for (const listener of reg.privacySetListeners) {
-                    try {
-                        listener(change);
-                    }
-                    catch (error) {
-                        void error;
-                    }
-                }
-            },
-            notifyBlocklistChange: (change) => {
-                for (const listener of reg.blocklistChangeListeners) {
-                    try {
-                        listener(change);
-                    }
-                    catch (error) {
-                        void error;
-                    }
-                }
-            },
-            capturePreKeyBundle: (bundle) => preKey.captureBundle(bundle),
-            consumeOutboundAppStatePatches: (iq) => appState.consumeOutboundAppStatePatches(iq),
-            get appStateCollectionProviders() {
-                return appState.appStateCollectionProviders;
-            },
-            requireMediaHttpsInfo: () => this.requireMediaHttpsInfo()
-        };
+    /** State of the single default session (the only session for one client). */
+    get registries() {
+        return this.defaultSession.registries;
+    }
+    get preKeyDispenser() {
+        return this.defaultSession.preKeyDispenser;
+    }
+    get appStateSync() {
+        return this.defaultSession.appStateSync;
+    }
+    /**
+     * Returns the isolated session for `id`, creating it on first use. Every
+     * session gets its own registries, prekey dispenser, app-state, IQ router,
+     * and stanza capture. Use with the `sessionKey` option to run several
+     * `WaClient`s against one server without them sharing any state.
+     */
+    session(id) {
+        const existing = this.sessions.get(id);
+        if (existing) {
+            return existing;
+        }
+        return this.createSession(id);
+    }
+    /** The session a connection is bound to (default before authentication). */
+    sessionFor(pipeline) {
+        return this.pipelineSessions.get(pipeline) ?? this.defaultSession;
+    }
+    createSession(id) {
+        const session = new FakeServerSession_1.FakeServerSession(id, { requireMediaHttpsInfo: () => this.requireMediaHttpsInfo() }, { defaultIqHandlers: this.options.defaultIqHandlers !== false });
+        this.sessions.set(id, session);
+        // Server-level custom handlers apply to every session, present and future.
+        for (const handler of this.globalIqHandlers) {
+            handler.unregisterBySession.set(session, session.registerIqHandler(handler.matcher, handler.respond, handler.label));
+        }
+        return session;
     }
     registerIqHandler(matcher, respond, label) {
-        const handler = { matcher, respond, label };
-        return this.iqRouter.register(handler, { priority: 'high' });
+        const entry = {
+            matcher,
+            respond,
+            label,
+            unregisterBySession: new Map()
+        };
+        for (const session of this.sessions.values()) {
+            entry.unregisterBySession.set(session, session.registerIqHandler(matcher, respond, label));
+        }
+        this.globalIqHandlers.add(entry);
+        return () => {
+            for (const unregister of entry.unregisterBySession.values()) {
+                unregister();
+            }
+            entry.unregisterBySession.clear();
+            this.globalIqHandlers.delete(entry);
+        };
     }
     async routeIqForTest(iq) {
-        return this.iqRouter.route(iq);
+        return this.defaultSession.routeIq(iq);
     }
     onOutboundGroupOp(listener) {
         return this.registries.onOutboundGroupOp(listener);
@@ -178,7 +149,7 @@ class FakeWaServer {
         return this.registries.createFakeGroup(input);
     }
     async triggerPreKeyUpload(pipeline, options = {}) {
-        return this.preKeyDispenser.triggerPreKeyUpload(pipeline, options);
+        return this.sessionFor(pipeline).preKeyDispenser.triggerPreKeyUpload(pipeline, options);
     }
     awaitPreKeyBundle(timeoutMs = 15000) {
         return this.preKeyDispenser.awaitPreKeyBundle(timeoutMs);
@@ -208,7 +179,7 @@ class FakeWaServer {
         return this.appStateSync.provideAppStateCollection(name, provider);
     }
     async pushServerSyncNotification(pipeline, input) {
-        return this.appStateSync.pushServerSyncNotification(pipeline, input);
+        return this.sessionFor(pipeline).appStateSync.pushServerSyncNotification(pipeline, input);
     }
     onAuthenticatedPipeline(listener) {
         this.authenticatedListeners.add(listener);
@@ -218,78 +189,24 @@ class FakeWaServer {
         configure(new Scenario_1.Scenario(this));
     }
     expectIq(matcher, options = {}) {
-        const timeoutMs = options.timeoutMs ?? 2000;
-        for (const captured of this.capturedStanzas) {
-            if (matchesIq(captured, matcher)) {
-                return Promise.resolve(captured);
-            }
-        }
-        return new Promise((resolve, reject) => {
-            const expectation = {
-                matcher,
-                resolve: (iq) => {
-                    this.pendingIqExpectations.delete(expectation);
-                    clearTimeout(expectation.timer);
-                    resolve(iq);
-                },
-                reject: (error) => {
-                    this.pendingIqExpectations.delete(expectation);
-                    clearTimeout(expectation.timer);
-                    reject(error);
-                },
-                timer: setTimeout(() => {
-                    this.pendingIqExpectations.delete(expectation);
-                    reject(new Error(`expectIq timed out after ${timeoutMs}ms (${describeMatcher(matcher)})`));
-                }, timeoutMs)
-            };
-            this.pendingIqExpectations.add(expectation);
-        });
+        return this.defaultSession.expectIq(matcher, options);
     }
     capturedStanzaSnapshot() {
-        return this.capturedStanzas.slice();
+        return this.defaultSession.capturedStanzaSnapshot();
     }
     /**
-     * Subscribes to every stanza captured from the client side (the lib).
-     * The listener is called synchronously for each new stanza as it
-     * arrives, in addition to `capturedStanzas` being appended. Returns
-     * an unsubscribe function. Useful for benches that need to count or
-     * react to a stream of receipts/messages without paying the O(N²)
-     * cost of polling `capturedStanzaSnapshot()` or queuing one
-     * `expectStanza(...)` per iteration.
+     * Subscribes to every stanza captured from the client side (the lib) of
+     * the default session. The listener is called synchronously for each new
+     * stanza as it arrives. Returns an unsubscribe function. Useful for
+     * benches that need to count or react to a stream of receipts/messages
+     * without paying the O(N²) cost of polling `capturedStanzaSnapshot()` or
+     * queuing one `expectStanza(...)` per iteration.
      */
     onCapturedStanza(listener) {
-        this.capturedStanzaListeners.add(listener);
-        return () => {
-            this.capturedStanzaListeners.delete(listener);
-        };
+        return this.defaultSession.onCapturedStanza(listener);
     }
     expectStanza(matcher, options = {}) {
-        const timeoutMs = options.timeoutMs ?? 2000;
-        for (const captured of this.capturedStanzas) {
-            if (matchesStanza(captured, matcher)) {
-                return Promise.resolve(captured);
-            }
-        }
-        return new Promise((resolve, reject) => {
-            const expectation = {
-                matcher,
-                resolve: (node) => {
-                    this.pendingStanzaExpectations.delete(expectation);
-                    clearTimeout(expectation.timer);
-                    resolve(node);
-                },
-                reject: (error) => {
-                    this.pendingStanzaExpectations.delete(expectation);
-                    clearTimeout(expectation.timer);
-                    reject(error);
-                },
-                timer: setTimeout(() => {
-                    this.pendingStanzaExpectations.delete(expectation);
-                    reject(new Error(`expectStanza timed out after ${timeoutMs}ms (${describeStanzaMatcher(matcher)})`));
-                }, timeoutMs)
-            };
-            this.pendingStanzaExpectations.add(expectation);
-        });
+        return this.defaultSession.expectStanza(matcher, options);
     }
     async broadcastStanza(node) {
         const tasks = [];
@@ -351,8 +268,9 @@ class FakeWaServer {
         return this.capturedMediaUploads.slice();
     }
     async createFakePeer(options, pipeline) {
-        const peer = await FakePeer_1.FakePeer.create(options, this.buildFakePeerDeps(pipeline));
-        this.registries.registerPeer(peer);
+        const session = this.sessionFor(pipeline);
+        const peer = await FakePeer_1.FakePeer.create(options, this.buildFakePeerDeps(pipeline, session));
+        session.registries.registerPeer(peer);
         return peer;
     }
     async createFakePeerWithDevices(input, pipeline) {
@@ -365,6 +283,7 @@ class FakeWaServer {
         }
         const userPart = input.userJid.slice(0, atIdx);
         const server = input.userJid.slice(atIdx + 1);
+        const session = this.sessionFor(pipeline);
         const peers = [];
         for (const deviceId of input.deviceIds) {
             const deviceJid = deviceId === 0 ? input.userJid : `${userPart}:${deviceId}@${server}`;
@@ -372,36 +291,27 @@ class FakeWaServer {
                 jid: deviceJid,
                 displayName: input.displayName,
                 skipOneTimePreKey: input.skipOneTimePreKey
-            }, this.buildFakePeerDeps(pipeline));
-            this.registries.registerPeer(peer);
+            }, this.buildFakePeerDeps(pipeline, session));
+            session.registries.registerPeer(peer);
             peers.push(peer);
         }
         return peers;
     }
-    buildFakePeerDeps(pipeline) {
+    buildFakePeerDeps(pipeline, session) {
         return {
-            bundleResolver: () => this.preKeyDispenser.awaitPreKeyBundle(),
-            reserveOneTimePreKey: () => this.preKeyDispenser.dispenseOneTimePreKey(),
+            bundleResolver: () => session.preKeyDispenser.awaitPreKeyBundle(),
+            reserveOneTimePreKey: () => session.preKeyDispenser.dispenseOneTimePreKey(),
             pushStanza: (stanza) => pipeline.sendStanza(stanza),
-            subscribeInboundMessages: (listener) => {
-                const wrapped = (node) => {
-                    if (node.tag !== 'message')
-                        return;
-                    listener(node);
-                };
-                this.inboundStanzaListeners.add(wrapped);
-                return () => {
-                    this.inboundStanzaListeners.delete(wrapped);
-                };
-            }
+            subscribeInboundMessages: (listener) => session.subscribeInboundMessages(listener)
         };
     }
     async runPairing(pipeline, options, companionMaterialResolver) {
+        const session = this.sessionFor(pipeline);
         const driver = new FakePairingDriver_1.FakePairingDriver(options, {
             pipeline,
             companionMaterialResolver,
             waitForPairDeviceAck: async (pairDeviceIqId) => {
-                await this.expectIq({
+                await session.expectIq({
                     id: pairDeviceIqId
                 }, {
                     timeoutMs: 15000
@@ -438,8 +348,15 @@ class FakeWaServer {
         const root = this.requireRootCa();
         return { publicKey: root.publicKey, serial: root.serial };
     }
+    /**
+     * Subscribes to every new connection pipeline (pre-auth). Listeners
+     * fan out; returns an unsubscribe function.
+     */
     onPipeline(listener) {
-        this.pipelineListener = listener;
+        this.pipelineListeners.add(listener);
+        return () => {
+            this.pipelineListeners.delete(listener);
+        };
     }
     async listen() {
         if (this.listenInfo) {
@@ -481,53 +398,51 @@ class FakeWaServer {
             connection,
             rootCa: this.rootCa,
             serverStaticKeyPair: this.serverStaticKeyPair,
-            iqRouter: this.iqRouter
+            routeIq: (node) => this.sessionFor(pipeline).routeIq(node),
+            ...(this.options.successNodeAttributes !== undefined
+                ? { successNodeAttributes: this.options.successNodeAttributes }
+                : {})
         });
         this.pipelines.add(pipeline);
+        this.pipelineSessions.set(pipeline, this.defaultSession);
         pipeline.setEvents({
             onAuthenticated: () => {
+                this.bindPipelineSession(pipeline);
                 for (const listener of this.authenticatedListeners) {
-                    void listener(pipeline);
+                    try {
+                        void Promise.resolve(listener(pipeline)).catch(() => undefined);
+                    }
+                    catch {
+                        /* ignore */
+                    }
                 }
             },
-            onStanza: (node) => this.handleCapturedStanza(node),
+            onStanza: (node) => this.sessionFor(pipeline).handleCapturedStanza(node),
             onClose: () => this.pipelines.delete(pipeline)
         });
-        this.pipelineListener?.(pipeline);
-    }
-    handleCapturedStanza(node) {
-        this.capturedStanzas.push(node);
-        for (const listener of this.capturedStanzaListeners) {
+        for (const listener of this.pipelineListeners) {
             try {
-                listener(node);
+                void Promise.resolve(listener(pipeline)).catch(() => undefined);
             }
-            catch (error) {
-                void error;
+            catch {
+                /* ignore */
             }
         }
-        for (const listener of this.inboundStanzaListeners) {
-            try {
-                listener(node);
-            }
-            catch (error) {
-                void error;
-            }
-        }
-        for (const expectation of this.pendingStanzaExpectations) {
-            if (matchesStanza(node, expectation.matcher)) {
-                expectation.resolve(node);
-                break;
-            }
-        }
-        if (node.tag !== 'iq') {
+    }
+    /**
+     * Rebinds a connection to its keyed session once authenticated. Runs
+     * before user `onAuthenticated` listeners and before any client stanza, so
+     * captures and IQ routing land in the right session from the first frame.
+     * No-op without a `sessionKey` resolver (single default session).
+     */
+    bindPipelineSession(pipeline) {
+        const resolveKey = this.options.sessionKey;
+        const clientPayload = pipeline.clientPayload;
+        if (!resolveKey || !clientPayload) {
             return;
         }
-        for (const expectation of this.pendingIqExpectations) {
-            if (matchesIq(node, expectation.matcher)) {
-                expectation.resolve(node);
-                return;
-            }
-        }
+        const id = resolveKey({ clientPayload, pipeline });
+        this.pipelineSessions.set(pipeline, this.session(id));
     }
     buildMediaRequestHandler() {
         return (req, res) => {
@@ -616,69 +531,3 @@ function parseQueryParam(query, name) {
     }
     return undefined;
 }
-function matchesIq(iq, matcher) {
-    if (iq.tag !== 'iq')
-        return false;
-    if (matcher.id !== undefined && iq.attrs.id !== matcher.id)
-        return false;
-    if (matcher.type !== undefined && iq.attrs.type !== matcher.type)
-        return false;
-    if (matcher.xmlns !== undefined && iq.attrs.xmlns !== matcher.xmlns)
-        return false;
-    if (matcher.childTag !== undefined) {
-        const children = Array.isArray(iq.content) ? iq.content : null;
-        if (!children || children.length === 0)
-            return false;
-        if (children[0].tag !== matcher.childTag)
-            return false;
-    }
-    return true;
-}
-function describeMatcher(matcher) {
-    const parts = [];
-    if (matcher.id !== undefined)
-        parts.push(`id=${matcher.id}`);
-    if (matcher.type !== undefined)
-        parts.push(`type=${matcher.type}`);
-    if (matcher.xmlns !== undefined)
-        parts.push(`xmlns=${matcher.xmlns}`);
-    if (matcher.childTag !== undefined)
-        parts.push(`childTag=${matcher.childTag}`);
-    return parts.length > 0 ? parts.join(', ') : 'any iq';
-}
-function matchesStanza(node, matcher) {
-    if (matcher.tag !== undefined && node.tag !== matcher.tag)
-        return false;
-    if (matcher.type !== undefined && node.attrs.type !== matcher.type)
-        return false;
-    if (matcher.xmlns !== undefined && node.attrs.xmlns !== matcher.xmlns)
-        return false;
-    if (matcher.from !== undefined && node.attrs.from !== matcher.from)
-        return false;
-    if (matcher.to !== undefined && node.attrs.to !== matcher.to)
-        return false;
-    if (matcher.childTag !== undefined) {
-        const children = Array.isArray(node.content) ? node.content : null;
-        if (!children || children.length === 0)
-            return false;
-        if (children[0].tag !== matcher.childTag)
-            return false;
-    }
-    return true;
-}
-function describeStanzaMatcher(matcher) {
-    const parts = [];
-    if (matcher.tag !== undefined)
-        parts.push(`tag=${matcher.tag}`);
-    if (matcher.type !== undefined)
-        parts.push(`type=${matcher.type}`);
-    if (matcher.xmlns !== undefined)
-        parts.push(`xmlns=${matcher.xmlns}`);
-    if (matcher.from !== undefined)
-        parts.push(`from=${matcher.from}`);
-    if (matcher.to !== undefined)
-        parts.push(`to=${matcher.to}`);
-    if (matcher.childTag !== undefined)
-        parts.push(`childTag=${matcher.childTag}`);
-    return parts.length > 0 ? parts.join(', ') : 'any stanza';
-}

package/dist/api/iq-handlers.d.ts

@@ -34,6 +34,7 @@ export interface IqHandlerDeps {
     notifyPrivacySet(change: CapturedPrivacySet): void;
     notifyBlocklistChange(change: CapturedBlocklistChange): void;
     capturePreKeyBundle(bundle: ClientPreKeyBundle): void;
+    countServerPreKeys(): number;
     consumeOutboundAppStatePatches(iq: BinaryNode): Promise<void>;
     readonly appStateCollectionProviders: ReadonlyMap<string, () => Promise<FakeAppStateCollectionPayload | null> | FakeAppStateCollectionPayload | null>;
     requireMediaHttpsInfo(): {

package/dist/api/iq-handlers.js

@@ -98,6 +98,29 @@ function registerDefaultIqHandlers(router, deps) {
         matcher: { xmlns: 'encrypt', type: 'get', childTag: 'digest' },
         respond: (iq) => (0, router_1.buildIqError)(iq, { code: 404, text: 'item-not-found' })
     });
+    // Baileys-family and whatsmeow clients block on this query before
+    // reporting the connection as open; zapo-js uses <digest> instead.
+    router.register({
+        label: 'prekey-count',
+        matcher: { xmlns: 'encrypt', type: 'get', childTag: 'count' },
+        respond: (iq) => {
+            const result = (0, router_1.buildIqResult)(iq);
+            return {
+                ...result,
+                content: [
+                    {
+                        tag: 'count',
+                        attrs: { value: String(deps.countServerPreKeys()) }
+                    }
+                ]
+            };
+        }
+    });
+    router.register({
+        label: 'passive-mode',
+        matcher: { xmlns: 'passive', type: 'set' },
+        respond: (iq) => (0, router_1.buildIqResult)(iq)
+    });
     router.register({
         label: 'media-conn',
         matcher: { xmlns: 'w:m', type: 'set', childTag: 'media_conn' },