@zapo-js/fake-server 0.3.0 → 1.1.0

package/dist/esm/api/FakeWaServer.js

@@ -0,0 +1,528 @@
+import { Agent as HttpsAgent } from 'node:https';
+import { WaFakeConnectionPipeline } from '../infra/WaFakeConnectionPipeline.js';
+import { WaFakeMediaHttpsServer } from '../infra/WaFakeMediaHttpsServer.js';
+import { WaFakeWsServer } from '../infra/WaFakeWsServer.js';
+import { generateFakeNoiseRootCa } from '../protocol/auth/cert-chain.js';
+import { FakeMediaStore } from '../state/fake-media-store.js';
+import { X25519 } from '../transport/crypto.js';
+import { FakePairingDriver } from './FakePairingDriver.js';
+import { FakePeer } from './FakePeer.js';
+import { FakeServerSession } from './FakeServerSession.js';
+import { Scenario } from './Scenario.js';
+export { FakeServerSession } from './FakeServerSession.js';
+export class FakeWaServer {
+    constructor(options = {}) {
+        this.pipelines = new Set();
+        this.pipelineSessions = new WeakMap();
+        this.authenticatedListeners = new Set();
+        this.sessions = new Map();
+        this.globalIqHandlers = new Set();
+        this.rootCa = null;
+        this.serverStaticKeyPair = null;
+        this.listenInfo = null;
+        this.pipelineListeners = new Set();
+        this.rejectMode = null;
+        this.mediaStore = new FakeMediaStore();
+        this.mediaHttpsServer = new WaFakeMediaHttpsServer();
+        this.capturedMediaUploads = [];
+        this.nextUploadCounter = 0;
+        this.cachedMediaProxyAgent = null;
+        this.options = options;
+        this.wsServer = new WaFakeWsServer(options);
+        this.wsServer.onConnection((connection) => this.handleConnection(connection));
+        this.defaultSession = this.createSession('__default__');
+    }
+    /** 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(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 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.defaultSession.routeIq(iq);
+    }
+    onOutboundGroupOp(listener) {
+        return this.registries.onOutboundGroupOp(listener);
+    }
+    onOutboundPrivacySet(listener) {
+        return this.registries.onOutboundPrivacySet(listener);
+    }
+    onOutboundBlocklistChange(listener) {
+        return this.registries.onOutboundBlocklistChange(listener);
+    }
+    onOutboundProfilePictureSet(listener) {
+        return this.registries.onOutboundProfilePictureSet(listener);
+    }
+    onOutboundStatusSet(listener) {
+        return this.registries.onOutboundStatusSet(listener);
+    }
+    onLogout(listener) {
+        return this.registries.onLogout(listener);
+    }
+    onOutboundPrivacyTokenIssue(listener) {
+        return this.registries.onOutboundPrivacyTokenIssue(listener);
+    }
+    onOutboundDirtyBitsClear(listener) {
+        return this.registries.onOutboundDirtyBitsClear(listener);
+    }
+    privacyTokensIssuedSnapshot() {
+        return this.registries.privacyTokensIssuedSnapshot();
+    }
+    privacySettingsSnapshot() {
+        return this.registries.privacySettingsSnapshot();
+    }
+    blocklistSnapshot() {
+        return this.registries.blocklistSnapshot();
+    }
+    latestStatusSnapshot() {
+        return this.registries.latestStatusSnapshot();
+    }
+    groupRegistrySnapshot() {
+        return this.registries.groupRegistrySnapshot();
+    }
+    setAbProps(input) {
+        this.registries.setAbProps(input);
+    }
+    setPrivacyDisallowedList(category, jids) {
+        this.registries.setPrivacyDisallowedList(category, jids);
+    }
+    setProfilePictureRecord(jid, picture) {
+        this.registries.setProfilePictureRecord(jid, picture);
+    }
+    setBusinessProfileRecord(jid, profile) {
+        this.registries.setBusinessProfileRecord(jid, profile);
+    }
+    createFakeGroup(input) {
+        return this.registries.createFakeGroup(input);
+    }
+    async triggerPreKeyUpload(pipeline, options = {}) {
+        return this.sessionFor(pipeline).preKeyDispenser.triggerPreKeyUpload(pipeline, options);
+    }
+    awaitPreKeyBundle(timeoutMs = 15000) {
+        return this.preKeyDispenser.awaitPreKeyBundle(timeoutMs);
+    }
+    capturedPreKeyBundleSnapshot() {
+        return this.preKeyDispenser.capturedPreKeyBundleSnapshot();
+    }
+    dispenseOneTimePreKey() {
+        return this.preKeyDispenser.dispenseOneTimePreKey();
+    }
+    preKeyDispenserMissesSnapshot() {
+        return this.preKeyDispenser.preKeyDispenserMissesSnapshot();
+    }
+    preKeysAvailable() {
+        return this.preKeyDispenser.preKeysAvailable();
+    }
+    registerAppStateSyncKey(keyId, keyData) {
+        this.appStateSync.registerAppStateSyncKey(keyId, keyData);
+    }
+    onOutboundAppStateMutation(listener) {
+        return this.appStateSync.onOutboundAppStateMutation(listener);
+    }
+    expectAppStateMutation(predicate, timeoutMs = 15000) {
+        return this.appStateSync.expectAppStateMutation(predicate, timeoutMs);
+    }
+    provideAppStateCollection(name, provider) {
+        return this.appStateSync.provideAppStateCollection(name, provider);
+    }
+    async pushServerSyncNotification(pipeline, input) {
+        return this.sessionFor(pipeline).appStateSync.pushServerSyncNotification(pipeline, input);
+    }
+    onAuthenticatedPipeline(listener) {
+        this.authenticatedListeners.add(listener);
+        return () => this.authenticatedListeners.delete(listener);
+    }
+    scenario(configure) {
+        configure(new Scenario(this));
+    }
+    expectIq(matcher, options = {}) {
+        return this.defaultSession.expectIq(matcher, options);
+    }
+    capturedStanzaSnapshot() {
+        return this.defaultSession.capturedStanzaSnapshot();
+    }
+    /**
+     * 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) {
+        return this.defaultSession.onCapturedStanza(listener);
+    }
+    expectStanza(matcher, options = {}) {
+        return this.defaultSession.expectStanza(matcher, options);
+    }
+    async broadcastStanza(node) {
+        const tasks = [];
+        for (const pipeline of this.pipelines) {
+            tasks.push(pipeline.sendStanza(node).catch(() => undefined));
+        }
+        await Promise.all(tasks);
+        return tasks.length;
+    }
+    waitForAuthenticatedPipeline(timeoutMs = 60000) {
+        for (const pipeline of this.pipelines) {
+            if (pipeline.isAuthenticated()) {
+                return Promise.resolve(pipeline);
+            }
+        }
+        return this.waitForNextAuthenticatedPipeline(timeoutMs);
+    }
+    waitForNextAuthenticatedPipeline(timeoutMs = 60000) {
+        return new Promise((resolve, reject) => {
+            const timer = setTimeout(() => reject(new Error(`waitForNextAuthenticatedPipeline timed out after ${timeoutMs}ms`)), timeoutMs);
+            const unregister = this.onAuthenticatedPipeline((pipeline) => {
+                clearTimeout(timer);
+                unregister();
+                resolve(pipeline);
+            });
+        });
+    }
+    async publishMediaBlob(input) {
+        return this.mediaStore.publish(input);
+    }
+    mediaUrl(path) {
+        const info = this.requireMediaHttpsInfo();
+        const normalized = path.startsWith('/') ? path : `/${path}`;
+        return `https://${info.host}:${info.port}${normalized}`;
+    }
+    requireMediaHttpsInfo() {
+        const info = this.mediaHttpsServer.info;
+        if (!info) {
+            throw new Error('fake media https server is not listening');
+        }
+        return info;
+    }
+    get mediaProxyAgent() {
+        if (!this.cachedMediaProxyAgent) {
+            // keepAlive is required for representative perf measurements
+            // and matches what real-world WhatsApp clients do – every
+            // media upload/download would otherwise pay a full TLS
+            // handshake. The `src/media/__tests__/media.test.ts` fixtures
+            // and a production-quality `proxy.mediaUpload` configuration
+            // all set this; mirroring it here keeps benches in line.
+            this.cachedMediaProxyAgent = new HttpsAgent({
+                rejectUnauthorized: false,
+                keepAlive: true
+            });
+        }
+        return this.cachedMediaProxyAgent;
+    }
+    capturedMediaUploadSnapshot() {
+        return this.capturedMediaUploads.slice();
+    }
+    async createFakePeer(options, pipeline) {
+        const session = this.sessionFor(pipeline);
+        const peer = await FakePeer.create(options, this.buildFakePeerDeps(pipeline, session));
+        session.registries.registerPeer(peer);
+        return peer;
+    }
+    async createFakePeerWithDevices(input, pipeline) {
+        if (input.deviceIds.length === 0) {
+            throw new Error('createFakePeerWithDevices requires at least one deviceId');
+        }
+        const atIdx = input.userJid.indexOf('@');
+        if (atIdx < 0) {
+            throw new Error(`invalid userJid ${input.userJid}`);
+        }
+        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}`;
+            const peer = await FakePeer.create({
+                jid: deviceJid,
+                displayName: input.displayName,
+                skipOneTimePreKey: input.skipOneTimePreKey
+            }, this.buildFakePeerDeps(pipeline, session));
+            session.registries.registerPeer(peer);
+            peers.push(peer);
+        }
+        return peers;
+    }
+    buildFakePeerDeps(pipeline, session) {
+        return {
+            bundleResolver: () => session.preKeyDispenser.awaitPreKeyBundle(),
+            reserveOneTimePreKey: () => session.preKeyDispenser.dispenseOneTimePreKey(),
+            pushStanza: (stanza) => pipeline.sendStanza(stanza),
+            subscribeInboundMessages: (listener) => session.subscribeInboundMessages(listener)
+        };
+    }
+    async runPairing(pipeline, options, companionMaterialResolver) {
+        const session = this.sessionFor(pipeline);
+        const driver = new FakePairingDriver(options, {
+            pipeline,
+            companionMaterialResolver,
+            waitForPairDeviceAck: async (pairDeviceIqId) => {
+                await session.expectIq({
+                    id: pairDeviceIqId
+                }, {
+                    timeoutMs: 15000
+                });
+            }
+        });
+        await driver.run();
+    }
+    setRejectMode(info) {
+        if (info === null) {
+            this.rejectMode = null;
+            return;
+        }
+        this.rejectMode = {
+            code: info.code ?? 1011,
+            reason: info.reason ?? 'fake-server reject mode'
+        };
+    }
+    static async start(options = {}) {
+        const server = new FakeWaServer(options);
+        await server.listen();
+        return server;
+    }
+    get url() {
+        return this.requireListening().url;
+    }
+    get host() {
+        return this.requireListening().host;
+    }
+    get port() {
+        return this.requireListening().port;
+    }
+    get noiseRootCa() {
+        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.pipelineListeners.add(listener);
+        return () => {
+            this.pipelineListeners.delete(listener);
+        };
+    }
+    async listen() {
+        if (this.listenInfo) {
+            return;
+        }
+        ;
+        [this.rootCa, this.serverStaticKeyPair] = await Promise.all([
+            generateFakeNoiseRootCa(),
+            X25519.generateKeyPair()
+        ]);
+        const mediaHandler = this.buildMediaRequestHandler();
+        this.wsServer.setHttpRequestHandler(mediaHandler);
+        this.mediaHttpsServer.setRequestHandler(mediaHandler);
+        this.listenInfo = await this.wsServer.listen();
+        await this.mediaHttpsServer.listen('127.0.0.1');
+    }
+    async stop() {
+        this.pipelines.clear();
+        await this.wsServer.close();
+        await this.mediaHttpsServer.close();
+        if (this.cachedMediaProxyAgent) {
+            this.cachedMediaProxyAgent.destroy();
+            this.cachedMediaProxyAgent = null;
+        }
+        this.listenInfo = null;
+        this.rootCa = null;
+        this.serverStaticKeyPair = null;
+    }
+    handleConnection(connection) {
+        if (this.rejectMode) {
+            connection.close(this.rejectMode.code, this.rejectMode.reason);
+            return;
+        }
+        if (!this.rootCa || !this.serverStaticKeyPair) {
+            connection.close(1011, 'fake server not initialized');
+            return;
+        }
+        const pipeline = new WaFakeConnectionPipeline({
+            connection,
+            rootCa: this.rootCa,
+            serverStaticKeyPair: this.serverStaticKeyPair,
+            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) {
+                    try {
+                        void Promise.resolve(listener(pipeline)).catch(() => undefined);
+                    }
+                    catch {
+                        /* ignore */
+                    }
+                }
+            },
+            onStanza: (node) => this.sessionFor(pipeline).handleCapturedStanza(node),
+            onClose: () => this.pipelines.delete(pipeline)
+        });
+        for (const listener of this.pipelineListeners) {
+            try {
+                void Promise.resolve(listener(pipeline)).catch(() => undefined);
+            }
+            catch {
+                /* ignore */
+            }
+        }
+    }
+    /**
+     * 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;
+        }
+        const id = resolveKey({ clientPayload, pipeline });
+        this.pipelineSessions.set(pipeline, this.session(id));
+    }
+    buildMediaRequestHandler() {
+        return (req, res) => {
+            const rawUrl = req.url ?? '';
+            const [path, query] = rawUrl.split('?');
+            const method = (req.method ?? 'GET').toUpperCase();
+            if (method === 'POST') {
+                this.handleMediaUpload(req, res, path, query);
+                return;
+            }
+            const blob = this.mediaStore.get(path);
+            if (!blob) {
+                res.statusCode = 404;
+                res.end();
+                return;
+            }
+            res.statusCode = 200;
+            res.setHeader('content-type', 'application/octet-stream');
+            res.setHeader('content-length', String(blob.encryptedBytes.byteLength));
+            res.end(Buffer.from(blob.encryptedBytes));
+        };
+    }
+    handleMediaUpload(req, res, path, query) {
+        const chunks = [];
+        req.on('data', (chunk) => {
+            chunks.push(chunk);
+        });
+        req.on('end', () => {
+            const encryptedBytes = new Uint8Array(Buffer.concat(chunks));
+            const segments = path.split('/').filter(Boolean);
+            const mediaType = segments[1] ?? 'unknown';
+            const auth = parseQueryParam(query, 'auth');
+            const upload = {
+                path,
+                mediaType,
+                encryptedBytes,
+                contentType: req.headers['content-type'],
+                auth,
+                receivedAtMs: Date.now()
+            };
+            this.capturedMediaUploads.push(upload);
+            this.mediaStore.setRaw(path, encryptedBytes, mediaType);
+            this.nextUploadCounter += 1;
+            const downloadUrl = this.mediaUrl(path);
+            const responseBody = JSON.stringify({
+                url: downloadUrl,
+                direct_path: path
+            });
+            res.statusCode = 200;
+            res.setHeader('content-type', 'application/json');
+            res.setHeader('content-length', String(Buffer.byteLength(responseBody)));
+            res.end(responseBody);
+        });
+        req.on('error', (error) => {
+            if (!res.headersSent) {
+                res.statusCode = 500;
+            }
+            res.end(error.message);
+        });
+    }
+    requireListening() {
+        if (!this.listenInfo) {
+            throw new Error('fake server is not listening');
+        }
+        return this.listenInfo;
+    }
+    requireRootCa() {
+        if (!this.rootCa) {
+            throw new Error('fake server is not listening');
+        }
+        return this.rootCa;
+    }
+}
+function parseQueryParam(query, name) {
+    if (!query)
+        return undefined;
+    for (const pair of query.split('&')) {
+        const eq = pair.indexOf('=');
+        if (eq < 0)
+            continue;
+        const key = decodeURIComponent(pair.slice(0, eq));
+        if (key !== name)
+            continue;
+        return decodeURIComponent(pair.slice(eq + 1));
+    }
+    return undefined;
+}

package/dist/esm/api/PreKeyDispenser.js

@@ -0,0 +1,93 @@
+import { buildNotification } from '../protocol/push/notification.js';
+export class PreKeyDispenser {
+    constructor() {
+        this.capturedPreKeyBundle = null;
+        this.preKeyDispenserCursor = 0;
+        this.preKeyDispenserMisses = 0;
+        this.nextPreKeyNotificationId = 1;
+        this.preKeyBundleWaiters = new Set();
+    }
+    captureBundle(bundle) {
+        this.capturedPreKeyBundle = bundle;
+        this.preKeyDispenserCursor = 0;
+        this.preKeyDispenserMisses = 0;
+        for (const waiter of this.preKeyBundleWaiters) {
+            waiter.resolve(bundle);
+        }
+        this.preKeyBundleWaiters.clear();
+    }
+    awaitPreKeyBundle(timeoutMs = 15000) {
+        if (this.capturedPreKeyBundle) {
+            return Promise.resolve(this.capturedPreKeyBundle);
+        }
+        return new Promise((resolve, reject) => {
+            const waiter = {
+                resolve: (bundle) => {
+                    clearTimeout(waiter.timer);
+                    this.preKeyBundleWaiters.delete(waiter);
+                    resolve(bundle);
+                },
+                reject: (error) => {
+                    clearTimeout(waiter.timer);
+                    this.preKeyBundleWaiters.delete(waiter);
+                    reject(error);
+                },
+                timer: setTimeout(() => {
+                    this.preKeyBundleWaiters.delete(waiter);
+                    reject(new Error(`awaitPreKeyBundle timed out after ${timeoutMs}ms`));
+                }, timeoutMs)
+            };
+            this.preKeyBundleWaiters.add(waiter);
+        });
+    }
+    capturedPreKeyBundleSnapshot() {
+        return this.capturedPreKeyBundle;
+    }
+    dispenseOneTimePreKey() {
+        const bundle = this.capturedPreKeyBundle;
+        if (!bundle) {
+            this.preKeyDispenserMisses += 1;
+            return null;
+        }
+        if (this.preKeyDispenserCursor >= bundle.preKeys.length) {
+            this.preKeyDispenserMisses += 1;
+            return null;
+        }
+        const entry = bundle.preKeys[this.preKeyDispenserCursor];
+        this.preKeyDispenserCursor += 1;
+        return { keyId: entry.keyId, publicKey: entry.publicKey };
+    }
+    preKeysAvailable() {
+        const bundle = this.capturedPreKeyBundle;
+        if (!bundle)
+            return 0;
+        return Math.max(0, bundle.preKeys.length - this.preKeyDispenserCursor);
+    }
+    preKeyDispenserMissesSnapshot() {
+        return this.preKeyDispenserMisses;
+    }
+    async triggerPreKeyUpload(pipeline, options = {}) {
+        const opts = typeof options === 'number' ? { timeoutMs: options } : options;
+        const timeoutMs = opts.timeoutMs ?? 15000;
+        if (!opts.force && this.capturedPreKeyBundle) {
+            return this.capturedPreKeyBundle;
+        }
+        if (opts.force) {
+            this.capturedPreKeyBundle = null;
+            this.preKeyDispenserCursor = 0;
+        }
+        const bundlePromise = this.awaitPreKeyBundle(timeoutMs);
+        const id = `prekey-low-${this.nextPreKeyNotificationId++}`;
+        await pipeline.sendStanza(buildNotification({
+            id,
+            type: 'encrypt',
+            content: [
+                {
+                    tag: 'count',
+                    attrs: { value: '0' }
+                }
+            ]
+        }));
+        return bundlePromise;
+    }
+}

package/dist/esm/api/Scenario.js

@@ -0,0 +1,32 @@
+export class Scenario {
+    constructor(server) {
+        this.server = server;
+    }
+    onIq(matcher) {
+        return new IqExpectation(this.server, matcher);
+    }
+    afterAuth(listener) {
+        this.server.onAuthenticatedPipeline(listener);
+    }
+}
+export class IqExpectation {
+    constructor(server, matcher) {
+        this.server = server;
+        this.matcher = matcher;
+    }
+    respondWith(response) {
+        this.server.registerIqHandler(this.matcher, () => response);
+        return this;
+    }
+    respond(responder) {
+        this.server.registerIqHandler(this.matcher, responder);
+        return this;
+    }
+    respondOnce(response) {
+        const unregister = this.server.registerIqHandler(this.matcher, async (iq) => {
+            unregister();
+            return typeof response === 'function' ? response(iq) : response;
+        });
+        return this;
+    }
+}