@zapo-js/fake-server 0.3.0 → 1.1.0

package/dist/api/FakeServerSession.js

@@ -0,0 +1,293 @@
+"use strict";
+/** Per-session isolated server state: registries, prekeys, app-state, IQ routing, capture. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FakeServerSession = void 0;
+exports.matchesIq = matchesIq;
+exports.matchesStanza = matchesStanza;
+const router_1 = require("../protocol/iq/router");
+const AppStateSyncManager_1 = require("./AppStateSyncManager");
+const iq_handlers_1 = require("./iq-handlers");
+const PreKeyDispenser_1 = require("./PreKeyDispenser");
+const ServerRegistries_1 = require("./ServerRegistries");
+/**
+ * One isolated logical device's worth of server state. Every `WaClient`
+ * connected to a `FakeWaServer` is bound to exactly one session; peers,
+ * groups, privacy, prekeys, app-state, and captured stanzas never leak across
+ * sessions. A single-client server uses one default session, which is why the
+ * legacy `FakeWaServer` surface delegates straight through to it.
+ */
+class FakeServerSession {
+    constructor(id, host, options) {
+        this.registries = new ServerRegistries_1.ServerRegistries();
+        this.preKeyDispenser = new PreKeyDispenser_1.PreKeyDispenser();
+        this.appStateSync = new AppStateSyncManager_1.AppStateSyncManager();
+        this.iqRouter = new router_1.WaFakeIqRouter();
+        this.capturedStanzas = [];
+        this.pendingIqExpectations = new Set();
+        this.pendingStanzaExpectations = new Set();
+        this.capturedStanzaListeners = new Set();
+        this.inboundStanzaListeners = new Set();
+        this.id = id;
+        if (options.defaultIqHandlers) {
+            (0, iq_handlers_1.registerDefaultIqHandlers)(this.iqRouter, this.buildIqHandlerDeps(host));
+        }
+    }
+    registerIqHandler(matcher, respond, label) {
+        const handler = { matcher, respond, label };
+        return this.iqRouter.register(handler, { priority: 'high' });
+    }
+    routeIq(iq) {
+        return this.iqRouter.route(iq);
+    }
+    handleCapturedStanza(node) {
+        this.capturedStanzas.push(node);
+        for (const listener of this.capturedStanzaListeners) {
+            try {
+                listener(node);
+            }
+            catch (error) {
+                void error;
+            }
+        }
+        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') {
+            return;
+        }
+        for (const expectation of this.pendingIqExpectations) {
+            if (matchesIq(node, expectation.matcher)) {
+                expectation.resolve(node);
+                return;
+            }
+        }
+    }
+    subscribeInboundMessages(listener) {
+        const wrapped = (node) => {
+            if (node.tag !== 'message')
+                return;
+            listener(node);
+        };
+        this.inboundStanzaListeners.add(wrapped);
+        return () => {
+            this.inboundStanzaListeners.delete(wrapped);
+        };
+    }
+    onCapturedStanza(listener) {
+        this.capturedStanzaListeners.add(listener);
+        return () => {
+            this.capturedStanzaListeners.delete(listener);
+        };
+    }
+    capturedStanzaSnapshot() {
+        return this.capturedStanzas.slice();
+    }
+    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);
+        });
+    }
+    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);
+        });
+    }
+    buildIqHandlerDeps(host) {
+        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),
+            countServerPreKeys: () => preKey.preKeysAvailable(),
+            consumeOutboundAppStatePatches: (iq) => appState.consumeOutboundAppStatePatches(iq),
+            get appStateCollectionProviders() {
+                return appState.appStateCollectionProviders;
+            },
+            requireMediaHttpsInfo: () => host.requireMediaHttpsInfo()
+        };
+    }
+}
+exports.FakeServerSession = FakeServerSession;
+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/FakeWaServer.d.ts

@@ -1,47 +1,65 @@
 import { Agent as HttpsAgent } from 'node:https';
 import { type WaFakeAuthenticatedInfo, WaFakeConnectionPipeline } from '../infra/WaFakeConnectionPipeline';
+import type { ParsedClientPayload } from '../protocol/auth/client-payload-validate';
+import type { BuildSuccessNodeInput } from '../protocol/auth/success-node';
 import type { BuildAbPropsResultInput } from '../protocol/iq/abprops';
 import { type BuildServerSyncNotificationInput, type FakeAppStateCollectionPayload } from '../protocol/iq/appstate-sync';
 import type { FakeBusinessProfile } from '../protocol/iq/business';
 import type { FakePrivacyCategoryName, FakePrivacySettingsState } from '../protocol/iq/privacy';
 import type { FakePrivacyTokenIssue } from '../protocol/iq/privacy-token';
 import type { FakeProfilePictureResult } from '../protocol/iq/profile';
-import { type WaFakeIqMatcher, type WaFakeIqResponder } from '../protocol/iq/router';
+import type { WaFakeIqMatcher, WaFakeIqResponder } from '../protocol/iq/router';
 import type { ClientPreKeyBundle } from '../protocol/signal/prekey-upload';
 import { type PublishedMediaBlob, type PublishMediaInput } from '../state/fake-media-store';
 import { type BinaryNode } from '../transport/codec';
-import { AppStateSyncManager, type CapturedAppStateMutation } from './AppStateSyncManager';
+import { type AppStateSyncManager, type CapturedAppStateMutation } from './AppStateSyncManager';
 import { type FakePairingDriverOptions } from './FakePairingDriver';
 import { type CreateFakePeerOptions, FakePeer } from './FakePeer';
-import { PreKeyDispenser } from './PreKeyDispenser';
+import { type ExpectIqOptions, type ExpectStanzaOptions, FakeServerSession, type StanzaMatcher } from './FakeServerSession';
+import type { PreKeyDispenser } from './PreKeyDispenser';
 import { type AuthenticatedPipelineListener, Scenario } from './Scenario';
-import { type CapturedBlocklistChange, type CapturedDirtyBitsClear, type CapturedGroupOp, type CapturedPrivacySet, type CapturedProfilePictureSet, type CapturedStatusSet, type FakeGroupMetadata, ServerRegistries } from './ServerRegistries';
+import type { CapturedBlocklistChange, CapturedDirtyBitsClear, CapturedGroupOp, CapturedPrivacySet, CapturedProfilePictureSet, CapturedStatusSet, FakeGroupMetadata, ServerRegistries } from './ServerRegistries';
 export type { FakeGroupMetadata, CapturedGroupOp, CapturedPrivacySet, CapturedBlocklistChange, CapturedProfilePictureSet, CapturedStatusSet, CapturedDirtyBitsClear } from './ServerRegistries';
 export type { CapturedAppStateMutation } from './AppStateSyncManager';
 export interface FakeWaServerOptions {
     readonly host?: string;
     readonly port?: number;
     readonly path?: string;
+    /**
+     * Attributes stamped on the post-handshake `<success/>` node of every
+     * authenticated connection (lid, display name, props versions, ...).
+     */
+    readonly successNodeAttributes?: BuildSuccessNodeInput;
+    /**
+     * Register the built-in IQ auto-handlers that answer everything the lib
+     * emits during normal operation. Default `true`; pass `false` to start
+     * with an empty router and wire every response via `registerIqHandler`.
+     */
+    readonly defaultIqHandlers?: boolean;
+    /**
+     * Assigns each authenticated connection to an isolated session, keyed by
+     * the returned id. Two connections that resolve to different ids share no
+     * peers, groups, prekeys, app-state, or captured stanzas. When omitted,
+     * every connection uses one shared default session (single-client mode).
+     *
+     * The resolver runs once per connection, right after authentication, so
+     * `info.clientPayload` is available for keying by login identity, e.g.
+     * `sessionKey: ({ clientPayload }) => clientPayload.kind === 'login' ?
+     * clientPayload.username : 'pending'`.
+     */
+    readonly sessionKey?: (info: FakeSessionKeyInfo) => string;
+}
+export interface FakeSessionKeyInfo {
+    readonly clientPayload: ParsedClientPayload;
+    readonly pipeline: WaFakeConnectionPipeline;
 }
 export interface FakeWaServerNoiseRootCa {
     readonly publicKey: Uint8Array;
     readonly serial: number;
 }
 export type FakeWaServerPipelineListener = (pipeline: WaFakeConnectionPipeline) => void;
-export interface ExpectIqOptions {
-    readonly timeoutMs?: number;
-}
-export interface ExpectStanzaOptions {
-    readonly timeoutMs?: number;
-}
-export interface StanzaMatcher {
-    readonly tag?: string;
-    readonly type?: string;
-    readonly xmlns?: string;
-    readonly from?: string;
-    readonly to?: string;
-    readonly childTag?: string;
-}
+export { FakeServerSession } from './FakeServerSession';
+export type { ExpectIqOptions, ExpectStanzaOptions, StanzaMatcher } from './FakeServerSession';
 export interface CapturedMediaUpload {
     readonly path: string;
     readonly mediaType: string;
@@ -51,21 +69,18 @@ export interface CapturedMediaUpload {
     readonly receivedAtMs: number;
 }
 export declare class FakeWaServer {
-    readonly registries: ServerRegistries;
-    readonly preKeyDispenser: PreKeyDispenser;
-    readonly appStateSync: AppStateSyncManager;
     private readonly wsServer;
     private readonly pipelines;
-    private readonly iqRouter;
-    private readonly capturedStanzas;
-    private readonly pendingIqExpectations;
-    private readonly pendingStanzaExpectations;
+    private readonly defaultSession;
+    private readonly pipelineSessions;
     private readonly authenticatedListeners;
-    private readonly inboundStanzaListeners;
+    private readonly sessions;
+    private readonly globalIqHandlers;
+    private readonly options;
     private rootCa;
     private serverStaticKeyPair;
     private listenInfo;
-    private pipelineListener;
+    private readonly pipelineListeners;
     private rejectMode;
     private readonly mediaStore;
     private readonly mediaHttpsServer;
@@ -73,7 +88,20 @@ export declare class FakeWaServer {
     private nextUploadCounter;
     private cachedMediaProxyAgent;
     constructor(options?: FakeWaServerOptions);
-    private buildIqHandlerDeps;
+    /** State of the single default session (the only session for one client). */
+    get registries(): ServerRegistries;
+    get preKeyDispenser(): PreKeyDispenser;
+    get appStateSync(): AppStateSyncManager;
+    /**
+     * 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: string): FakeServerSession;
+    /** The session a connection is bound to (default before authentication). */
+    sessionFor(pipeline: WaFakeConnectionPipeline): FakeServerSession;
+    private createSession;
     registerIqHandler(matcher: WaFakeIqMatcher, respond: WaFakeIqResponder, label?: string): () => void;
     routeIqForTest(iq: BinaryNode): Promise<BinaryNode | null>;
     onOutboundGroupOp(listener: (op: CapturedGroupOp) => void): () => void;
@@ -122,6 +150,15 @@ export declare class FakeWaServer {
     scenario(configure: (s: Scenario) => void): void;
     expectIq(matcher: WaFakeIqMatcher, options?: ExpectIqOptions): Promise<BinaryNode>;
     capturedStanzaSnapshot(): readonly BinaryNode[];
+    /**
+     * 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: (node: BinaryNode) => void): () => void;
     expectStanza(matcher: StanzaMatcher, options?: ExpectStanzaOptions): Promise<BinaryNode>;
     broadcastStanza(node: BinaryNode): Promise<number>;
     waitForAuthenticatedPipeline(timeoutMs?: number): Promise<WaFakeConnectionPipeline>;
@@ -152,11 +189,21 @@ export declare class FakeWaServer {
     get host(): string;
     get port(): number;
     get noiseRootCa(): FakeWaServerNoiseRootCa;
-    onPipeline(listener: FakeWaServerPipelineListener): void;
+    /**
+     * Subscribes to every new connection pipeline (pre-auth). Listeners
+     * fan out; returns an unsubscribe function.
+     */
+    onPipeline(listener: FakeWaServerPipelineListener): () => void;
     listen(): Promise<void>;
     stop(): Promise<void>;
     private handleConnection;
-    private handleCapturedStanza;
+    /**
+     * 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).
+     */
+    private bindPipelineSession;
     private buildMediaRequestHandler;
     private handleMediaUpload;
     private requireListening;
@@ -164,4 +211,3 @@ export declare class FakeWaServer {
 }
 export type { WaFakeAuthenticatedInfo, WaFakeConnectionPipeline };
 export type { BinaryNode };
-//# sourceMappingURL=FakeWaServer.d.ts.map