@hansaka02/baileys 7.3.4 → 7.3.6

package/lib/Utils/auth-utils.js

@@ -3,8 +3,10 @@
 Object.defineProperty(exports, "__esModule", { value: true })
 
 const { randomBytes } = require("crypto")
+const { default: PQueue } = require("p-queue") 
 const { default: NodeCache } = require("@cacheable/node-cache")
 const { DEFAULT_CACHE_TTLS } = require("../Defaults/constants")
+const { AsyncLocalStorage } = require("async_hooks")
 const { LRUCache } = require("lru-cache") 
 const { Mutex }= require("async-mutex") 
 const {
@@ -15,6 +17,7 @@ const {
   delay, 
   generateRegistrationId
 } = require("./generics")
+const { PreKeyManager } = require("./pre-key-manager") 
 
 /**
  * Adds caching capability to a SignalKeyStore
@@ -83,413 +86,244 @@ function makeCacheableSignalKeyStore(store, logger, _cache) {
     }
 }
 
-// Module-level specialized mutexes for pre-key operations
-const preKeyMutex = new Mutex()
-const signedPreKeyMutex = new Mutex()
-
-/**
- * Get the appropriate mutex for the key type
- */
-const getPreKeyMutex = (keyType) => {
-    return keyType === 'signed-pre-key' ? signedPreKeyMutex : preKeyMutex
-}
-
-/**
- * Handles pre-key operations with mutex protection
- */
-async function handlePreKeyOperations(data, keyType, transactionCache, mutations, logger, isInTransaction, state) {
-    const mutex = getPreKeyMutex(keyType)
-    await mutex.runExclusive(async () => {
-        const keyData = data[keyType]
-        if (!keyData)
-            return
-            
-        // Ensure structures exist
-        transactionCache[keyType] = transactionCache[keyType] || {}
-        mutations[keyType] = mutations[keyType] || {}
-        
-        // Separate deletions from updates for batch processing
-        const deletionKeys = []
-        const updateKeys = []
-        
-        for (const keyId in keyData) {
-            if (keyData[keyId] === null) {
-                deletionKeys.push(keyId)
-            }
-            else {
-                updateKeys.push(keyId)
-            }
-        }
-        
-        // Process updates first (no validation needed)
-        for (const keyId of updateKeys) {
-            if (transactionCache[keyType]) {
-                transactionCache[keyType][keyId] = keyData[keyId]
-            }
-            if (mutations[keyType]) {
-                mutations[keyType][keyId] = keyData[keyId]
-            }
-        }
-        
-        // Process deletions with validation
-        if (deletionKeys.length === 0)
-            return
-            
-        if (isInTransaction) {
-            // In transaction, only allow deletion if key exists in cache
-            for (const keyId of deletionKeys) {
-                if (transactionCache[keyType]) {
-                    transactionCache[keyType][keyId] = null
-                    if (mutations[keyType]) {
-                        // Mark for deletion in mutations
-                        mutations[keyType][keyId] = null
-                    }
-                }
-                else {
-                    logger.warn(`Skipping deletion of non-existent ${keyType} in transaction: ${keyId}`)
-                }
-            }
-            return
-        }
-        
-        // Outside transaction, batch validate all deletions
-        if (!state)
-            return
-            
-        const existingKeys = await state.get(keyType, deletionKeys)
-        for (const keyId of deletionKeys) {
-            if (existingKeys[keyId]) {
-                if (transactionCache[keyType])
-                    transactionCache[keyType][keyId] = null
-                if (mutations[keyType])
-                    mutations[keyType][keyId] = null
-            }
-            else {
-                logger.warn(`Skipping deletion of non-existent ${keyType}: ${keyId}`)
-            }
-        }
-    })
-}
-
-/**
- * Handles normal key operations for transactions
- */
-function handleNormalKeyOperations(data, key, transactionCache, mutations) {
-    Object.assign(transactionCache[key], data[key])
-    mutations[key] = mutations[key] || {}
-    Object.assign(mutations[key], data[key])
-}
-
-/**
- * Process pre-key deletions with validation
- */
-async function processPreKeyDeletions(data, keyType, state, logger) {
-    const mutex = getPreKeyMutex(keyType)
-    await mutex.runExclusive(async () => {
-        const keyData = data[keyType]
-        if (!keyData)
-            return
-            
-        // Validate deletions
-        for (const keyId in keyData) {
-            if (keyData[keyId] === null) {
-                const existingKeys = await state.get(keyType, [keyId])
-                if (!existingKeys[keyId]) {
-                    logger.warn(`Skipping deletion of non-existent ${keyType}: ${keyId}`)
-                    if (data[keyType])
-                        delete data[keyType][keyId]
-                }
-            }
-        }
-    })
-}
-
 /**
- * Executes a function with mutexes acquired for given key types
- * Uses async-mutex's runExclusive with efficient batching
- */
-async function withMutexes(keyTypes, getKeyTypeMutex, fn) {
-    if (keyTypes.length === 0) {
-        return fn()
-    }
-    
-    if (keyTypes.length === 1) {
-        return getKeyTypeMutex(keyTypes[0]).runExclusive(fn)
-    }
-    
-    // For multiple mutexes, sort by key type to prevent deadlocks
-    // Then acquire all mutexes in order using Promise.all for better efficiency
-    const sortedKeyTypes = [...keyTypes].sort()
-    const mutexes = sortedKeyTypes.map(getKeyTypeMutex)
-    
-    // Acquire all mutexes in order to prevent deadlocks
-    const releases = []
-    try {
-        for (const mutex of mutexes) {
-            releases.push(await mutex.acquire())
-        }
-        return await fn()
-    }
-    finally {
-        // Release in reverse order
-        while (releases.length > 0) {
-            const release = releases.pop()
-            if (release)
-                release()
-        }
-    }
-}
-
-/**
- * Adds DB like transaction capability (https://en.wikipedia.org/wiki/Database_transaction) to the SignalKeyStore,
- * this allows batch read & write operations & improves the performance of the lib
+ * Adds DB-like transaction capability to the SignalKeyStore
+ * Uses AsyncLocalStorage for automatic context management
  * @param state the key store to apply this capability to
  * @param logger logger to log events
  * @returns SignalKeyStore with transaction capability
  */
 const addTransactionCapability = (state, logger, { maxCommitRetries, delayBetweenTriesMs }) => {
-    // number of queries made to the DB during the transaction
-    // only there for logging purposes
-    let dbQueriesInTransaction = 0
-    let transactionCache = {}
-    let mutations = {}
+    const txStorage = new AsyncLocalStorage()
     
-    // LRU Cache to hold mutexes for different key types
-    const mutexCache = new LRUCache({
-        ttl: 60 * 60 * 1000, // 1 hour
-        ttlAutopurge: true,
-        updateAgeOnGet: true
-    })
+    // Queues for concurrency control (keyed by signal data type - bounded set)
+    const keyQueues = new Map()
     
-    let transactionsInProgress = 0
+    // Transaction mutexes with reference counting for cleanup
+    const txMutexes = new Map()
     
-    function getKeyTypeMutex(type) {
-        return getMutex(`keytype:${type}`)
-    }
+    const txMutexRefCounts = new Map()
     
-    function getSenderKeyMutex(senderKeyName) {
-        return getMutex(`senderkey:${senderKeyName}`)
-    }
+    // Pre-key manager for specialized operations
+    const preKeyManager = new PreKeyManager(state, logger)
     
-    function getTransactionMutex(key) {
-        return getMutex(`transaction:${key}`)
+    /**
+     * Get or create a queue for a specific key type
+     */
+    function getQueue(key) {
+        if (!keyQueues.has(key)) {
+            keyQueues.set(key, new PQueue({ concurrency: 1 }))
+        }
+        
+        return keyQueues.get(key)
     }
     
-    // Get or create a mutex for a specific key name
-    function getMutex(key) {
-        let mutex = mutexCache.get(key)
-        if (!mutex) {
-            mutex = new Mutex()
-            mutexCache.set(key, mutex)
-            logger.info({ key }, 'created new mutex')
+    /**
+     * Get or create a transaction mutex
+     */
+    function getTxMutex(key) {
+        if (!txMutexes.has(key)) {
+            txMutexes.set(key, new Mutex())
+            txMutexRefCounts.set(key, 0)
         }
-        return mutex
+        
+        return txMutexes.get(key)
     }
     
-    // Sender key operations with proper mutex sequencing
-    function queueSenderKeyOperation(senderKeyName, operation) {
-        return getSenderKeyMutex(senderKeyName).runExclusive(operation)
+    /**
+     * Acquire a reference to a transaction mutex
+     */
+    function acquireTxMutexRef(key) {
+        const count = txMutexRefCounts.get(key) ?? 0
+        txMutexRefCounts.set(key, count + 1)
     }
     
-    // Check if we are currently in a transaction
+    /**
+     * Release a reference to a transaction mutex and cleanup if no longer needed
+     */
+    function releaseTxMutexRef(key) {
+        const count = (txMutexRefCounts.get(key) ?? 1) - 1
+        
+        txMutexRefCounts.set(key, count)
+        
+        // Cleanup if no more references and mutex is not locked
+        if (count <= 0) {
+            const mutex = txMutexes.get(key)
+            
+            if (mutex && !mutex.isLocked()) {
+                txMutexes.delete(key)
+                txMutexRefCounts.delete(key)
+            }
+        }
+    }
+    
+    /**
+     * Check if currently in a transaction
+     */
     function isInTransaction() {
-        return transactionsInProgress > 0
+        return !!txStorage.getStore()
     }
     
-    // Helper function to handle transaction commit with retries
-    async function commitTransaction() {
-        if (!Object.keys(mutations).length) {
+    /**
+     * Commit transaction with retries
+     */
+    async function commitWithRetry(mutations) {
+        if (Object.keys(mutations).length === 0) {
             logger.trace('no mutations in transaction')
             return
         }
-        logger.trace('committing transaction');
-        let tries = maxCommitRetries
-        while (tries > 0) {
-            tries -= 1;
+        
+        logger.trace('committing transaction')
+        
+        for (let attempt = 0; attempt < maxCommitRetries; attempt++) {
             try {
                 await state.set(mutations)
-                logger.trace({ dbQueriesInTransaction }, 'committed transaction')
+                logger.trace({ mutationCount: Object.keys(mutations).length }, 'committed transaction')
                 return
             }
+            
             catch (error) {
-                logger.warn(`failed to commit ${Object.keys(mutations).length} mutations, tries left=${tries}`)
-                if (tries > 0) {
-                    await delay(delayBetweenTriesMs)
+                const retriesLeft = maxCommitRetries - attempt - 1
+                
+                logger.warn(`failed to commit mutations, retries left=${retriesLeft}`)
+                
+                if (retriesLeft === 0) {
+                    throw error
                 }
+                
+                await delay(delayBetweenTriesMs)
             }
         }
     }
     
-    // Helper function to clean up transaction state
-    function cleanupTransactionState() {
-        transactionsInProgress -= 1
-        if (transactionsInProgress === 0) {
-            transactionCache = {}
-            mutations = {}
-            dbQueriesInTransaction = 0
-        }
-    }
-    
-    // Helper function to execute work within transaction
-    async function executeTransactionWork(work) {
-        const result = await work()
-        // commit if this is the outermost transaction
-        if (transactionsInProgress === 1) {
-            await commitTransaction()
-        }
-        return result
-    }
-    
     return {
         get: async (type, ids) => {
-            if (isInTransaction()) {
-                const dict = transactionCache[type]
-                const idsRequiringFetch = dict ? ids.filter(item => typeof dict[item] === 'undefined') : ids
+            const ctx = txStorage.getStore()
+            
+            if (!ctx) {
+                // No transaction - direct read without exclusive lock for concurrency
+                return state.get(type, ids)
+            }
+            
+            // In transaction - check cache first
+            const cached = ctx.cache[type] || {}
+            const missing = ids.filter(id => !(id in cached))
+            
+            if (missing.length > 0) {
+                ctx.dbQueries++
                 
-                // only fetch if there are any items to fetch
-                if (idsRequiringFetch.length) {
-                    dbQueriesInTransaction += 1
-                    
-                    // Use per-sender-key queue for sender-key operations when possible
-                    if (type === 'sender-key') {
-                        logger.info({ idsRequiringFetch }, 'processing sender keys in transaction')
-                        // For sender keys, process each one with queued operations to maintain serialization
-                        for (const senderKeyName of idsRequiringFetch) {
-                            await queueSenderKeyOperation(senderKeyName, async () => {
-                                logger.info({ senderKeyName }, 'fetching sender key in transaction')
-                                const result = await state.get(type, [senderKeyName])
-                                // Update transaction cache
-                                transactionCache[type] || (transactionCache[type] = {})
-                                Object.assign(transactionCache[type], result)
-                                logger.info({ senderKeyName, hasResult: !!result[senderKeyName] }, 'sender key fetch complete')
-                            })
-                        }
-                    }
-                    else {
-                        // Use runExclusive for cleaner mutex handling
-                        await getKeyTypeMutex(type).runExclusive(async () => {
-                            const result = await state.get(type, idsRequiringFetch)
-                            // Update transaction cache
-                            transactionCache[type] || (transactionCache[type] = {})
-                            Object.assign(transactionCache[type], result)
-                        })
-                    }
-                }
-                return ids.reduce((dict, id) => {
-                    const value = transactionCache[type]?.[id]
-                    if (value) {
-                        dict[id] = value
-                    }
-                    return dict
-                }, {})
+                logger.trace({ type, count: missing.length }, 'fetching missing keys in transaction')
+                
+                const fetched = await getTxMutex(type).runExclusive(() => state.get(type, missing))
+                
+                // Update cache
+                ctx.cache[type] = ctx.cache[type] || {};
+                Object.assign(ctx.cache[type], fetched);
             }
-            else {
-                // Not in transaction, fetch directly with queue protection
-                if (type === 'sender-key') {
-                    // For sender keys, use individual queues to maintain per-key serialization
-                    const results = {}
-                    for (const senderKeyName of ids) {
-                        const result = await queueSenderKeyOperation(senderKeyName, async () => await state.get(type, [senderKeyName]))
-                        Object.assign(results, result)
-                    }
-                    return results
-                }
-                else {
-                    return await getKeyTypeMutex(type).runExclusive(() => state.get(type, ids))
+            
+            // Return requested ids from cache
+            const result = {}
+            
+            for (const id of ids) {
+                const value = ctx.cache[type]?.[id]
+                
+                if (value !== undefined && value !== null) {
+                    result[id] = value;
                 }
             }
+            
+            return result
         },
         set: async (data) => {
-            if (isInTransaction()) {
-                logger.trace({ types: Object.keys(data) }, 'caching in transaction')
-                for (const key_ in data) {
-                    const key = key_
-                    transactionCache[key] = transactionCache[key] || {}
-                    // Special handling for pre-keys and signed-pre-keys
-                    if (key === 'pre-key') {
-                        await handlePreKeyOperations(data, key, transactionCache, mutations, logger, true)
-                    }
-                    else {
-                        // Normal handling for other key types
-                        handleNormalKeyOperations(data, key, transactionCache, mutations)
+            const ctx = txStorage.getStore()
+            
+            if (!ctx) {
+                // No transaction - direct write with queue protection
+                const types = Object.keys(data)
+                
+                // Process pre-keys with validation
+                for (const type_ of types) {
+                    const type = type_
+                    if (type === 'pre-key') {
+                        await preKeyManager.validateDeletions(data, type)
                     }
                 }
+                
+                // Write all data in parallel
+                await Promise.all(types.map(type => getQueue(type).add(async () => {
+                    const typeData = { [type]: data[type] }
+                    await state.set(typeData)
+                })))
+                
+                return
             }
-            else {
-                // Not in transaction, apply directly with mutex protection
-                const hasSenderKeys = 'sender-key' in data
-                const senderKeyNames = hasSenderKeys ? Object.keys(data['sender-key'] || {}) : []
-                if (hasSenderKeys) {
-                    logger.info({ senderKeyNames }, 'processing sender key set operations')
-                    // Handle sender key operations with per-key queues
-                    for (const senderKeyName of senderKeyNames) {
-                        await queueSenderKeyOperation(senderKeyName, async () => {
-                            // Create data subset for this specific sender key
-                            const senderKeyData = {
-                                'sender-key': {
-                                    [senderKeyName]: data['sender-key'][senderKeyName]
-                                }
-                            };
-                            logger.trace({ senderKeyName }, 'storing sender key')
-                            // Apply changes to the store
-                            await state.set(senderKeyData)
-                            logger.trace({ senderKeyName }, 'sender key stored')
-                        })
-                    }
-                    // Handle any non-sender-key data with regular mutexes
-                    const nonSenderKeyData = { ...data }
-                    delete nonSenderKeyData['sender-key']
-                    if (Object.keys(nonSenderKeyData).length > 0) {
-                        await withMutexes(Object.keys(nonSenderKeyData), getKeyTypeMutex, async () => {
-                            // Process pre-keys and signed-pre-keys separately with specialized mutexes
-                            for (const key_ in nonSenderKeyData) {
-                                const keyType = key_
-                                if (keyType === 'pre-key') {
-                                    await processPreKeyDeletions(nonSenderKeyData, keyType, state, logger)
-                                }
-                            }
-                            // Apply changes to the store
-                            await state.set(nonSenderKeyData)
-                        })
-                    }
+            
+            // In transaction - update cache and mutations
+            logger.trace({ types: Object.keys(data) }, 'caching in transaction')
+            
+            for (const key_ in data) {
+                const key = key_
+                
+                // Ensure structures exist
+                ctx.cache[key] = ctx.cache[key] || {}
+                ctx.mutations[key] = ctx.mutations[key] || {}
+                
+                // Special handling for pre-keys
+                if (key === 'pre-key') {
+                    await preKeyManager.processOperations(data, key, ctx.cache, ctx.mutations, true)
                 }
+                
                 else {
-                    // No sender keys - use original logic
-                    await withMutexes(Object.keys(data), getKeyTypeMutex, async () => {
-                        // Process pre-keys and signed-pre-keys separately with specialized mutexes
-                        for (const key_ in data) {
-                            const keyType = key_
-                            if (keyType === 'pre-key') {
-                                await processPreKeyDeletions(data, keyType, state, logger)
-                            }
-                        }
-                        // Apply changes to the store
-                        await state.set(data)
-                    })
+                    // Normal key types
+                    Object.assign(ctx.cache[key], data[key])
+                    Object.assign(ctx.mutations[key], data[key])
                 }
             }
         },
         isInTransaction,
-        async transaction(work, key) {
-            const releaseTxMutex = await getTransactionMutex(key).acquire()
+        transaction: async (work, key) => {
+            const existing = txStorage.getStore()
+            
+            // Nested transaction - reuse existing context
+            if (existing) {
+                logger.trace('reusing existing transaction context')
+                return work()
+            }
+            
+            // New transaction - acquire mutex and create context
+            const mutex = getTxMutex(key)
+            
+            acquireTxMutexRef(key)
+            
             try {
-                transactionsInProgress += 1;
-                if (transactionsInProgress === 1) {
+                return await mutex.runExclusive(async () => {
+                    const ctx = {
+                        cache: {},
+                        mutations: {},
+                        dbQueries: 0
+                    }
+                    
                     logger.trace('entering transaction')
-                }
-                // Release the transaction mutex now that we've updated the counter
-                // This allows other transactions to start preparing
-                releaseTxMutex()
-                try {
-                    return await executeTransactionWork(work)
-                }
-                finally {
-                    cleanupTransactionState();
-                }
+                    
+                    try {
+                        const result = await txStorage.run(ctx, work)
+                        
+                        // Commit mutations
+                        await commitWithRetry(ctx.mutations)
+                        
+                        logger.trace({ dbQueries: ctx.dbQueries }, 'transaction completed')
+                        
+                        return result
+                    }
+                    
+                    catch (error) {
+                        logger.error({ error }, 'transaction failed, rolling back')
+                        throw error
+                    }
+                })
             }
-            catch (error) {
-                releaseTxMutex()
-                throw error
+            finally {
+                releaseTxMutexRef(key)
             }
         }
     }
@@ -514,7 +348,8 @@ const initAuthCreds = () => {
         registered: false,
         pairingCode: undefined,
         lastPropHash: undefined,
-        routingInfo: undefined
+        routingInfo: undefined,
+        additionalData: undefined
     }
 }
 

package/lib/Utils/browser-utils.js

@@ -0,0 +1,43 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const { 
+  platform, 
+  release 
+} = require("os") 
+const { proto } = require("../../WAProto")
+
+const PLATFORM_MAP = {
+    aix: 'AIX',
+    darwin: 'Mac OS',
+    win32: 'Windows',
+    android: 'Android',
+    freebsd: 'FreeBSD',
+    openbsd: 'OpenBSD',
+    sunos: 'Solaris',
+    linux: undefined,
+    haiku: undefined,
+    cygwin: undefined,
+    netbsd: undefined
+}
+
+const Browsers = {
+    ubuntu: browser => ['Ubuntu', browser, '22.04.4'],
+    macOS: browser => ['Mac OS', browser, '14.4.1'],
+    baileys: browser => ['Baileys', browser, '6.5.0'],
+    windows: browser => ['Windows', browser, '10.0.22631'],
+    //android: browser => [browser, 'Android', ''],
+    /** The appropriate browser based on your OS & release */
+    appropriate: browser => [PLATFORM_MAP[platform()] || 'Ubuntu', browser, release()]
+}
+
+const getPlatformId = (browser) => {
+    const platformType = proto.DeviceProps.PlatformType[browser.toUpperCase()]
+    return platformType ? platformType.toString() : '1' //chrome
+}
+
+module.exports = {
+  Browsers, 
+  getPlatformId
+}