@d0v3riz/baileys 6.7.25 → 7.0.0-rc.8

package/lib/Socket/socket.js

@@ -3,10 +3,13 @@ import { randomBytes } from 'crypto';
 import { URL } from 'url';
 import { promisify } from 'util';
 import { proto } from '../../WAProto/index.js';
-import { DEF_CALLBACK_PREFIX, DEF_TAG_PREFIX, INITIAL_PREKEY_COUNT, MIN_PREKEY_COUNT, NOISE_WA_HEADER } from '../Defaults/index.js';
+import { DEF_CALLBACK_PREFIX, DEF_TAG_PREFIX, INITIAL_PREKEY_COUNT, MIN_PREKEY_COUNT, MIN_UPLOAD_INTERVAL, NOISE_WA_HEADER, UPLOAD_TIMEOUT } from '../Defaults/index.js';
 import { DisconnectReason } from '../Types/index.js';
-import { addTransactionCapability, aesEncryptCTR, bindWaitForConnectionUpdate, bytesToCrockford, configureSuccessfulPairing, Curve, derivePairingCodeKey, generateLoginNode, generateMdTagPrefix, generateRegistrationNode, getCodeFromWSError, getErrorCodeFromStreamError, getNextPreKeysNode, getPlatformId, makeEventBuffer, makeNoiseHandler, promiseTimeout } from '../Utils/index.js';
-import { assertNodeErrorFree, binaryNodeToString, encodeBinaryNode, getBinaryNodeChild, getBinaryNodeChildren, jidEncode, S_WHATSAPP_NET } from '../WABinary/index.js';
+import { addTransactionCapability, aesEncryptCTR, bindWaitForConnectionUpdate, bytesToCrockford, configureSuccessfulPairing, Curve, derivePairingCodeKey, generateLoginNode, generateMdTagPrefix, generateRegistrationNode, getCodeFromWSError, getErrorCodeFromStreamError, getNextPreKeysNode, makeEventBuffer, makeNoiseHandler, promiseTimeout, signedKeyPair, xmppSignedPreKey } from '../Utils/index.js';
+import { getPlatformId } from '../Utils/browser-utils.js';
+import { assertNodeErrorFree, binaryNodeToString, encodeBinaryNode, getAllBinaryNodeChildren, getBinaryNodeChild, getBinaryNodeChildren, isLidUser, jidDecode, jidEncode, S_WHATSAPP_NET } from '../WABinary/index.js';
+import { BinaryInfo } from '../WAM/BinaryInfo.js';
+import { USyncQuery, USyncUser } from '../WAUSync/index.js';
 import { WebSocketClient } from './Client/index.js';
 /**
  * Connects to WA servers and performs:
@@ -16,6 +19,9 @@ import { WebSocketClient } from './Client/index.js';
  */
 export const makeSocket = (config) => {
     const { waWebSocketUrl, connectTimeoutMs, logger, keepAliveIntervalMs, browser, auth: authState, printQRInTerminal, defaultQueryTimeoutMs, transactionOpts, qrTimeout, makeSignalRepository } = config;
+    const publicWAMBuffer = new BinaryInfo();
+    const uqTagId = generateMdTagPrefix();
+    const generateMessageTag = () => `${uqTagId}${epoch++}`;
     if (printQRInTerminal) {
         console.warn('⚠️ The printQRInTerminal option has been deprecated. You will no longer receive QR codes in the terminal automatically. Please listen to the connection.update event yourself and handle the QR your way. You can remove this message by removing this opttion. This message will be removed in a future version.');
     }
@@ -26,9 +32,6 @@ export const makeSocket = (config) => {
     if (url.protocol === 'wss' && authState?.creds?.routingInfo) {
         url.searchParams.append('ED', authState.creds.routingInfo.toString('base64url'));
     }
-    const ws = new WebSocketClient(url, config);
-    ws.connect();
-    const ev = makeEventBuffer(logger);
     /** ephemeral key pair used to encrypt/decrypt communication. Unique for each connection */
     const ephemeralKeyPair = Curve.generateKeyPair();
     /** WA noise protocol wrapper */
@@ -38,17 +41,8 @@ export const makeSocket = (config) => {
         logger,
         routingInfo: authState?.creds?.routingInfo
     });
-    const { creds } = authState;
-    // add transaction capability
-    const keys = addTransactionCapability(authState.keys, logger, transactionOpts);
-    const signalRepository = makeSignalRepository({ creds, keys });
-    let lastDateRecv;
-    let epoch = 1;
-    let keepAliveReq;
-    let qrTimer;
-    let closed = false;
-    const uqTagId = generateMdTagPrefix();
-    const generateMessageTag = () => `${uqTagId}${epoch++}`;
+    const ws = new WebSocketClient(url, config);
+    ws.connect();
     const sendPromise = promisify(ws.send);
     /** send a raw buffer */
     const sendRawMessage = async (data) => {
@@ -74,35 +68,6 @@ export const makeSocket = (config) => {
         const buff = encodeBinaryNode(frame);
         return sendRawMessage(buff);
     };
-    /** log & process any unexpected errors */
-    const onUnexpectedError = (err, msg) => {
-        logger.error({ err }, `unexpected error in '${msg}'`);
-    };
-    /** await the next incoming message */
-    const awaitNextMessage = async (sendMsg) => {
-        if (!ws.isOpen) {
-            throw new Boom('Connection Closed', {
-                statusCode: DisconnectReason.connectionClosed
-            });
-        }
-        let onOpen;
-        let onClose;
-        const result = promiseTimeout(connectTimeoutMs, (resolve, reject) => {
-            onOpen = resolve;
-            onClose = mapWebSocketError(reject);
-            ws.on('frame', onOpen);
-            ws.on('close', onClose);
-            ws.on('error', onClose);
-        }).finally(() => {
-            ws.off('frame', onOpen);
-            ws.off('close', onClose);
-            ws.off('error', onClose);
-        });
-        if (sendMsg) {
-            sendRawMessage(sendMsg).catch(onClose);
-        }
-        return result;
-    };
     /**
      * Wait for a message with a certain tag to be received
      * @param msgId the message tag to await
@@ -113,20 +78,37 @@ export const makeSocket = (config) => {
         let onErr;
         try {
             const result = await promiseTimeout(timeoutMs, (resolve, reject) => {
-                onRecv = resolve;
+                onRecv = data => {
+                    resolve(data);
+                };
                 onErr = err => {
-                    reject(err || new Boom('Connection Closed', { statusCode: DisconnectReason.connectionClosed }));
+                    reject(err ||
+                        new Boom('Connection Closed', {
+                            statusCode: DisconnectReason.connectionClosed
+                        }));
                 };
                 ws.on(`TAG:${msgId}`, onRecv);
-                ws.on('close', onErr); // if the socket closes, you'll never receive the message
-                ws.off('error', onErr);
+                ws.on('close', onErr);
+                ws.on('error', onErr);
+                return () => reject(new Boom('Query Cancelled'));
             });
             return result;
         }
+        catch (error) {
+            // Catch timeout and return undefined instead of throwing
+            if (error instanceof Boom && error.output?.statusCode === DisconnectReason.timedOut) {
+                logger?.warn?.({ msgId }, 'timed out waiting for message');
+                return undefined;
+            }
+            throw error;
+        }
         finally {
-            ws.off(`TAG:${msgId}`, onRecv);
-            ws.off('close', onErr); // if the socket closes, you'll never receive the message
-            ws.off('error', onErr);
+            if (onRecv)
+                ws.off(`TAG:${msgId}`, onRecv);
+            if (onErr) {
+                ws.off('close', onErr);
+                ws.off('error', onErr);
+            }
         }
     };
     /** send a query, and wait for its response. auto-generates message ID if not provided */
@@ -135,12 +117,182 @@ export const makeSocket = (config) => {
             node.attrs.id = generateMessageTag();
         }
         const msgId = node.attrs.id;
-        const [result] = await Promise.all([waitForMessage(msgId, timeoutMs), sendNode(node)]);
-        if ('tag' in result) {
+        const result = await promiseTimeout(timeoutMs, async (resolve, reject) => {
+            const result = waitForMessage(msgId, timeoutMs).catch(reject);
+            sendNode(node)
+                .then(async () => resolve(await result))
+                .catch(reject);
+        });
+        if (result && 'tag' in result) {
             assertNodeErrorFree(result);
         }
         return result;
     };
+    // Validate current key-bundle on server; on failure, trigger pre-key upload and rethrow
+    const digestKeyBundle = async () => {
+        const res = await query({
+            tag: 'iq',
+            attrs: { to: S_WHATSAPP_NET, type: 'get', xmlns: 'encrypt' },
+            content: [{ tag: 'digest', attrs: {} }]
+        });
+        const digestNode = getBinaryNodeChild(res, 'digest');
+        if (!digestNode) {
+            await uploadPreKeys();
+            throw new Error('encrypt/get digest returned no digest node');
+        }
+    };
+    // Rotate our signed pre-key on server; on failure, run digest as fallback and rethrow
+    const rotateSignedPreKey = async () => {
+        const newId = (creds.signedPreKey.keyId || 0) + 1;
+        const skey = await signedKeyPair(creds.signedIdentityKey, newId);
+        await query({
+            tag: 'iq',
+            attrs: { to: S_WHATSAPP_NET, type: 'set', xmlns: 'encrypt' },
+            content: [
+                {
+                    tag: 'rotate',
+                    attrs: {},
+                    content: [xmppSignedPreKey(skey)]
+                }
+            ]
+        });
+        // Persist new signed pre-key in creds
+        ev.emit('creds.update', { signedPreKey: skey });
+    };
+    const executeUSyncQuery = async (usyncQuery) => {
+        if (usyncQuery.protocols.length === 0) {
+            throw new Boom('USyncQuery must have at least one protocol');
+        }
+        // todo: validate users, throw WARNING on no valid users
+        // variable below has only validated users
+        const validUsers = usyncQuery.users;
+        const userNodes = validUsers.map(user => {
+            return {
+                tag: 'user',
+                attrs: {
+                    jid: !user.phone ? user.id : undefined
+                },
+                content: usyncQuery.protocols.map(a => a.getUserElement(user)).filter(a => a !== null)
+            };
+        });
+        const listNode = {
+            tag: 'list',
+            attrs: {},
+            content: userNodes
+        };
+        const queryNode = {
+            tag: 'query',
+            attrs: {},
+            content: usyncQuery.protocols.map(a => a.getQueryElement())
+        };
+        const iq = {
+            tag: 'iq',
+            attrs: {
+                to: S_WHATSAPP_NET,
+                type: 'get',
+                xmlns: 'usync'
+            },
+            content: [
+                {
+                    tag: 'usync',
+                    attrs: {
+                        context: usyncQuery.context,
+                        mode: usyncQuery.mode,
+                        sid: generateMessageTag(),
+                        last: 'true',
+                        index: '0'
+                    },
+                    content: [queryNode, listNode]
+                }
+            ]
+        };
+        const result = await query(iq);
+        return usyncQuery.parseUSyncQueryResult(result);
+    };
+    const onWhatsApp = async (...phoneNumber) => {
+        let usyncQuery = new USyncQuery();
+        let contactEnabled = false;
+        for (const jid of phoneNumber) {
+            if (isLidUser(jid)) {
+                logger?.warn('LIDs are not supported with onWhatsApp');
+                continue;
+            }
+            else {
+                if (!contactEnabled) {
+                    contactEnabled = true;
+                    usyncQuery = usyncQuery.withContactProtocol();
+                }
+                const phone = `+${jid.replace('+', '').split('@')[0]?.split(':')[0]}`;
+                usyncQuery.withUser(new USyncUser().withPhone(phone));
+            }
+        }
+        if (usyncQuery.users.length === 0) {
+            return []; // return early without forcing an empty query
+        }
+        const results = await executeUSyncQuery(usyncQuery);
+        if (results) {
+            return results.list.filter(a => !!a.contact).map(({ contact, id }) => ({ jid: id, exists: contact }));
+        }
+    };
+    const pnFromLIDUSync = async (jids) => {
+        const usyncQuery = new USyncQuery().withLIDProtocol().withContext('background');
+        for (const jid of jids) {
+            if (isLidUser(jid)) {
+                logger?.warn('LID user found in LID fetch call');
+                continue;
+            }
+            else {
+                usyncQuery.withUser(new USyncUser().withId(jid));
+            }
+        }
+        if (usyncQuery.users.length === 0) {
+            return []; // return early without forcing an empty query
+        }
+        const results = await executeUSyncQuery(usyncQuery);
+        if (results) {
+            return results.list.filter(a => !!a.lid).map(({ lid, id }) => ({ pn: id, lid: lid }));
+        }
+        return [];
+    };
+    const ev = makeEventBuffer(logger);
+    const { creds } = authState;
+    // add transaction capability
+    const keys = addTransactionCapability(authState.keys, logger, transactionOpts);
+    const signalRepository = makeSignalRepository({ creds, keys }, logger, pnFromLIDUSync);
+    let lastDateRecv;
+    let epoch = 1;
+    let keepAliveReq;
+    let qrTimer;
+    let closed = false;
+    /** log & process any unexpected errors */
+    const onUnexpectedError = (err, msg) => {
+        logger.error({ err }, `unexpected error in '${msg}'`);
+    };
+    /** await the next incoming message */
+    const awaitNextMessage = async (sendMsg) => {
+        if (!ws.isOpen) {
+            throw new Boom('Connection Closed', {
+                statusCode: DisconnectReason.connectionClosed
+            });
+        }
+        let onOpen;
+        let onClose;
+        const result = promiseTimeout(connectTimeoutMs, (resolve, reject) => {
+            onOpen = resolve;
+            onClose = mapWebSocketError(reject);
+            ws.on('frame', onOpen);
+            ws.on('close', onClose);
+            ws.on('error', onClose);
+        }).finally(() => {
+            ws.off('frame', onOpen);
+            ws.off('close', onClose);
+            ws.off('error', onClose);
+        });
+        if (sendMsg) {
+            sendRawMessage(sendMsg).catch(onClose);
+        }
+        return result;
+    };
     /** connection handshake */
     const validateConnection = async () => {
         let helloMsg = {
@@ -169,7 +321,7 @@ export const makeSocket = (config) => {
                 payload: payloadEnc
             }
         }).finish());
-        noise.finishInit();
+        await noise.finishInit();
         startKeepAliveRequest();
     };
     const getAvailablePreKeysOnServer = async () => {
@@ -186,25 +338,107 @@ export const makeSocket = (config) => {
         const countChild = getBinaryNodeChild(result, 'count');
         return +countChild.attrs.value;
     };
+    // Pre-key upload state management
+    let uploadPreKeysPromise = null;
+    let lastUploadTime = 0;
     /** generates and uploads a set of pre-keys to the server */
-    const uploadPreKeys = async (count = INITIAL_PREKEY_COUNT) => {
-        await keys.transaction(async () => {
-            logger.info({ count }, 'uploading pre-keys');
-            const { update, node } = await getNextPreKeysNode({ creds, keys }, count);
-            await query(node);
-            ev.emit('creds.update', update);
-            logger.info({ count }, 'uploaded pre-keys');
-        });
+    const uploadPreKeys = async (count = MIN_PREKEY_COUNT, retryCount = 0) => {
+        // Check minimum interval (except for retries)
+        if (retryCount === 0) {
+            const timeSinceLastUpload = Date.now() - lastUploadTime;
+            if (timeSinceLastUpload < MIN_UPLOAD_INTERVAL) {
+                logger.debug(`Skipping upload, only ${timeSinceLastUpload}ms since last upload`);
+                return;
+            }
+        }
+        // Prevent multiple concurrent uploads
+        if (uploadPreKeysPromise) {
+            logger.debug('Pre-key upload already in progress, waiting for completion');
+            await uploadPreKeysPromise;
+        }
+        const uploadLogic = async () => {
+            logger.info({ count, retryCount }, 'uploading pre-keys');
+            // Generate and save pre-keys atomically (prevents ID collisions on retry)
+            const node = await keys.transaction(async () => {
+                logger.debug({ requestedCount: count }, 'generating pre-keys with requested count');
+                const { update, node } = await getNextPreKeysNode({ creds, keys }, count);
+                // Update credentials immediately to prevent duplicate IDs on retry
+                ev.emit('creds.update', update);
+                return node; // Only return node since update is already used
+            }, creds?.me?.id || 'upload-pre-keys');
+            // Upload to server (outside transaction, can fail without affecting local keys)
+            try {
+                await query(node);
+                logger.info({ count }, 'uploaded pre-keys successfully');
+                lastUploadTime = Date.now();
+            }
+            catch (uploadError) {
+                logger.error({ uploadError: uploadError.toString(), count }, 'Failed to upload pre-keys to server');
+                // Exponential backoff retry (max 3 retries)
+                if (retryCount < 3) {
+                    const backoffDelay = Math.min(1000 * Math.pow(2, retryCount), 10000);
+                    logger.info(`Retrying pre-key upload in ${backoffDelay}ms`);
+                    await new Promise(resolve => setTimeout(resolve, backoffDelay));
+                    return uploadPreKeys(count, retryCount + 1);
+                }
+                throw uploadError;
+            }
+        };
+        // Add timeout protection
+        uploadPreKeysPromise = Promise.race([
+            uploadLogic(),
+            new Promise((_, reject) => setTimeout(() => reject(new Boom('Pre-key upload timeout', { statusCode: 408 })), UPLOAD_TIMEOUT))
+        ]);
+        try {
+            await uploadPreKeysPromise;
+        }
+        finally {
+            uploadPreKeysPromise = null;
+        }
+    };
+    const verifyCurrentPreKeyExists = async () => {
+        const currentPreKeyId = creds.nextPreKeyId - 1;
+        if (currentPreKeyId <= 0) {
+            return { exists: false, currentPreKeyId: 0 };
+        }
+        const preKeys = await keys.get('pre-key', [currentPreKeyId.toString()]);
+        const exists = !!preKeys[currentPreKeyId.toString()];
+        return { exists, currentPreKeyId };
     };
     const uploadPreKeysToServerIfRequired = async () => {
-        const preKeyCount = await getAvailablePreKeysOnServer();
-        logger.info(`${preKeyCount} pre-keys found on server`);
-        if (preKeyCount <= MIN_PREKEY_COUNT) {
-            await uploadPreKeys();
+        try {
+            let count = 0;
+            const preKeyCount = await getAvailablePreKeysOnServer();
+            if (preKeyCount === 0)
+                count = INITIAL_PREKEY_COUNT;
+            else
+                count = MIN_PREKEY_COUNT;
+            const { exists: currentPreKeyExists, currentPreKeyId } = await verifyCurrentPreKeyExists();
+            logger.info(`${preKeyCount} pre-keys found on server`);
+            logger.info(`Current prekey ID: ${currentPreKeyId}, exists in storage: ${currentPreKeyExists}`);
+            const lowServerCount = preKeyCount <= count;
+            const missingCurrentPreKey = !currentPreKeyExists && currentPreKeyId > 0;
+            const shouldUpload = lowServerCount || missingCurrentPreKey;
+            if (shouldUpload) {
+                const reasons = [];
+                if (lowServerCount)
+                    reasons.push(`server count low (${preKeyCount})`);
+                if (missingCurrentPreKey)
+                    reasons.push(`current prekey ${currentPreKeyId} missing from storage`);
+                logger.info(`Uploading PreKeys due to: ${reasons.join(', ')}`);
+                await uploadPreKeys(count);
+            }
+            else {
+                logger.info(`PreKey validation passed - Server: ${preKeyCount}, Current prekey ${currentPreKeyId} exists`);
+            }
+        }
+        catch (error) {
+            logger.error({ error }, 'Failed to check/upload pre-keys during initialization');
+            // Don't throw - allow connection to continue even if pre-key check fails
         }
     };
-    const onMessageReceived = (data) => {
-        noise.decodeFrame(data, frame => {
+    const onMessageReceived = async (data) => {
+        await noise.decodeFrame(data, frame => {
             // reset ping timeout
             lastDateRecv = new Date();
             let anyTriggered = false;
@@ -425,7 +659,7 @@ export const makeSocket = (config) => {
             content: [
                 {
                     tag: 'add',
-                    attrs: {},
+                    attrs: { t: Math.round(Date.now() / 1000) + '' },
                     content: wamBuffer
                 }
             ]
@@ -497,17 +731,53 @@ export const makeSocket = (config) => {
     });
     // login complete
     ws.on('CB:success', async (node) => {
-        await uploadPreKeysToServerIfRequired();
-        await sendPassiveIq('active');
+        try {
+            await uploadPreKeysToServerIfRequired();
+            await sendPassiveIq('active');
+            // After successful login, validate our key-bundle against server
+            try {
+                await digestKeyBundle();
+            }
+            catch (e) {
+                logger.warn({ e }, 'failed to run digest after login');
+            }
+        }
+        catch (err) {
+            logger.warn({ err }, 'failed to send initial passive iq');
+        }
         logger.info('opened connection to WA');
         clearTimeout(qrTimer); // will never happen in all likelyhood -- but just in case WA sends success on first try
         ev.emit('creds.update', { me: { ...authState.creds.me, lid: node.attrs.lid } });
         ev.emit('connection.update', { connection: 'open' });
+        if (node.attrs.lid && authState.creds.me?.id) {
+            const myLID = node.attrs.lid;
+            process.nextTick(async () => {
+                try {
+                    const myPN = authState.creds.me.id;
+                    // Store our own LID-PN mapping
+                    await signalRepository.lidMapping.storeLIDPNMappings([{ lid: myLID, pn: myPN }]);
+                    // Create device list for our own user (needed for bulk migration)
+                    const { user, device } = jidDecode(myPN);
+                    await authState.keys.set({
+                        'device-list': {
+                            [user]: [device?.toString() || '0']
+                        }
+                    });
+                    // migrate our own session
+                    await signalRepository.migrateSession(myPN, myLID);
+                    logger.info({ myPN, myLID }, 'Own LID session created successfully');
+                }
+                catch (error) {
+                    logger.error({ error, lid: myLID }, 'Failed to create own LID session');
+                }
+            });
+        }
     });
     ws.on('CB:stream:error', (node) => {
-        logger.error({ node }, 'stream errored out');
+        const [reasonNode] = getAllBinaryNodeChildren(node);
+        logger.error({ reasonNode, fullErrorNode: node }, 'stream errored out');
         const { reason, statusCode } = getErrorCodeFromStreamError(node);
-        end(new Boom(`Stream Errored (${reason})`, { statusCode, data: node }));
+        end(new Boom(`Stream Errored (${reason})`, { statusCode, data: reasonNode || node }));
     });
     // stream fail, possible logout
     ws.on('CB:failure', (node) => {
@@ -517,9 +787,9 @@ export const makeSocket = (config) => {
     ws.on('CB:ib,,downgrade_webclient', () => {
         end(new Boom('Multi-device beta not joined', { statusCode: DisconnectReason.multideviceMismatch }));
     });
-    ws.on('CB:ib,,offline_preview', (node) => {
+    ws.on('CB:ib,,offline_preview', async (node) => {
         logger.info('offline preview received', JSON.stringify(node));
-        sendNode({
+        await sendNode({
             tag: 'ib',
             attrs: {},
             content: [{ tag: 'offline_batch', attrs: { count: '100' } }]
@@ -589,10 +859,15 @@ export const makeSocket = (config) => {
         onUnexpectedError,
         uploadPreKeys,
         uploadPreKeysToServerIfRequired,
+        digestKeyBundle,
+        rotateSignedPreKey,
         requestPairingCode,
+        wamBuffer: publicWAMBuffer,
         /** Waits for the connection to WA to reach a state */
         waitForConnectionUpdate: bindWaitForConnectionUpdate(ev),
-        sendWAMBuffer
+        sendWAMBuffer,
+        executeUSyncQuery,
+        onWhatsApp
     };
 };
 /**