@badzz88/baileys 8.5.4 → 8.5.5

package/lib/Utils/event-buffer.js

@@ -26,18 +26,21 @@ const BUFFERABLE_EVENT = [
 	'groups.update'
 ]
 const BUFFERABLE_EVENT_SET = new Set(BUFFERABLE_EVENT)
-
+/**
+ * The event buffer logically consolidates different events into a single event
+ * making the data processing more efficient.
+ */
 const makeEventBuffer = logger => {
 	const ev = new events_1.default()
 	const historyCache = new Set()
 	let data = makeBufferData()
 	let isBuffering = false
 	let bufferTimeout = null
-	let flushPendingTimeout = null 
+	let flushPendingTimeout = null // Add a specific timer for the debounced flush to prevent leak
 	let bufferCount = 0
-	const MAX_HISTORY_CACHE_SIZE = 10000 
-	const BUFFER_TIMEOUT_MS = 30000 
-	
+	const MAX_HISTORY_CACHE_SIZE = 10000 // Limit the history cache size to prevent memory bloat
+	const BUFFER_TIMEOUT_MS = 30000 // 30 seconds
+	// take the generic event and fire it as a baileys event
 	ev.on('event', map => {
 		for (const event in map) {
 			ev.emit(event, map[event])
@@ -58,7 +61,7 @@ const makeEventBuffer = logger => {
 				}
 			}, BUFFER_TIMEOUT_MS)
 		}
-		
+		// Always increment count when requested
 		bufferCount++
 	}
 	function flush() {
@@ -68,7 +71,7 @@ const makeEventBuffer = logger => {
 		logger.debug({ bufferCount }, 'Flushing event buffer')
 		isBuffering = false
 		bufferCount = 0
-		
+		// Clear timeout
 		if (bufferTimeout) {
 			clearTimeout(bufferTimeout)
 			bufferTimeout = null
@@ -77,7 +80,7 @@ const makeEventBuffer = logger => {
 			clearTimeout(flushPendingTimeout)
 			flushPendingTimeout = null
 		}
-		
+		// Clear history cache if it exceeds the max size
 		if (historyCache.size > MAX_HISTORY_CACHE_SIZE) {
 			logger.debug({ cacheSize: historyCache.size }, 'Clearing history cache')
 			historyCache.clear()
@@ -111,8 +114,8 @@ const makeEventBuffer = logger => {
 			}
 		},
 		emit(event, evData) {
-			
-			
+			// Check if this is a messages.upsert with a different type than what's buffered
+			// If so, flush the buffered messages first to avoid type overshadowing
 			if (event === 'messages.upsert') {
 				const { type } = evData
 				const existingUpserts = Object.values(data.messageUpserts)
@@ -120,14 +123,14 @@ const makeEventBuffer = logger => {
 					const bufferedType = existingUpserts[0].type
 					if (bufferedType !== type) {
 						logger.debug({ bufferedType, newType: type }, 'messages.upsert type mismatch, emitting buffered messages')
-						
+						// Emit the buffered messages with their correct type
 						ev.emit('event', {
 							'messages.upsert': {
 								messages: existingUpserts.map(m => m.message),
 								type: bufferedType
 							}
 						})
-						
+						// Clear the message upserts from the buffer
 						data.messageUpserts = {}
 					}
 				}
@@ -148,13 +151,13 @@ const makeEventBuffer = logger => {
 				buffer()
 				try {
 					const result = await work(...args)
-					
+					// If this is the only buffer, flush after a small delay
 					if (bufferCount === 1) {
 						setTimeout(() => {
 							if (isBuffering && bufferCount === 1) {
 								flush()
 							}
-						}, 100) 
+						}, 100) // Small delay to allow nested buffers
 					}
 					return result
 				} catch (error) {
@@ -162,7 +165,7 @@ const makeEventBuffer = logger => {
 				} finally {
 					bufferCount = Math.max(0, bufferCount - 1)
 					if (bufferCount === 0) {
-						
+						// Only schedule ONE timeout, not 10,000
 						if (!flushPendingTimeout) {
 							flushPendingTimeout = setTimeout(flush, 100)
 						}
@@ -172,7 +175,6 @@ const makeEventBuffer = logger => {
 		},
 		on: (...args) => ev.on(...args),
 		off: (...args) => ev.off(...args),
-		once: (...args) => ev.once(...args),
 		removeAllListeners: (...args) => ev.removeAllListeners(...args)
 	}
 }
@@ -203,7 +205,7 @@ function append(
 	data,
 	historyCache,
 	event,
-	
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	eventData,
 	logger
 ) {
@@ -244,6 +246,30 @@ function append(
 			}
 			data.historySets.empty = false
 			data.historySets.syncType = eventData.syncType
+			if (eventData.pastParticipants?.length) {
+				const merged = new Map()
+				const sigOf = p => `${p.userJid || ''}:${p.leaveTs || ''}:${p.leaveReason || ''}`
+				const ingest = entry => {
+					const key = entry.groupJid ?? JSON.stringify(entry)
+					const existing = merged.get(key)
+					if (!existing) {
+						merged.set(key, { ...entry, pastParticipants: [...(entry.pastParticipants || [])] })
+						return
+					}
+					const seen = new Set((existing.pastParticipants || []).map(sigOf))
+					for (const p of entry.pastParticipants || []) {
+						const sig = sigOf(p)
+						if (!seen.has(sig)) {
+							existing.pastParticipants.push(p)
+							seen.add(sig)
+						}
+					}
+				}
+				for (const entry of data.historySets.pastParticipants || []) ingest(entry)
+				for (const entry of eventData.pastParticipants) ingest(entry)
+				data.historySets.pastParticipants = [...merged.values()]
+			}
+			data.historySets.chunkOrder = eventData.chunkOrder
 			data.historySets.progress = eventData.progress
 			data.historySets.peerDataRequestSessionId = eventData.peerDataRequestSessionId
 			data.historySets.isLatest = eventData.isLatest || data.historySets.isLatest
@@ -276,22 +302,22 @@ function append(
 				const conditionMatches = update.conditional ? update.conditional(data) : true
 				if (conditionMatches) {
 					delete update.conditional
-					
+					// if there is an existing upsert, merge the update into it
 					const upsert = data.historySets.chats[chatId] || data.chatUpserts[chatId]
 					if (upsert) {
 						concatChats(upsert, update)
 					} else {
-						
+						// merge the update into the existing update
 						const chatUpdate = data.chatUpdates[chatId] || {}
 						data.chatUpdates[chatId] = concatChats(chatUpdate, update)
 					}
 				} else if (conditionMatches === undefined) {
-					
+					// condition yet to be fulfilled
 					data.chatUpdates[chatId] = update
 				}
-				
-				
-				
+				// otherwise -- condition not met, update is invalid
+				// if the chat has been updated
+				// ignore any existing chat delete
 				if (data.chatDeletes.has(chatId)) {
 					data.chatDeletes.delete(chatId)
 				}
@@ -302,7 +328,7 @@ function append(
 				if (!data.chatDeletes.has(chatId)) {
 					data.chatDeletes.add(chatId)
 				}
-				
+				// remove any prior updates & upserts
 				if (data.chatUpdates[chatId]) {
 					delete data.chatUpdates[chatId]
 				}
@@ -339,12 +365,12 @@ function append(
 			const contactUpdates = eventData
 			for (const update of contactUpdates) {
 				const id = update.id
-				
+				// merge into prior upsert
 				const upsert = data.historySets.contacts[id] || data.contactUpserts[id]
 				if (upsert) {
 					Object.assign(upsert, update)
 				} else {
-					
+					// merge into prior update
 					const contactUpdate = data.contactUpdates[id] || {}
 					data.contactUpdates[id] = Object.assign(contactUpdate, update)
 				}
@@ -386,9 +412,9 @@ function append(
 				const existing = data.historySets.messages[keyStr] || data.messageUpserts[keyStr]?.message
 				if (existing) {
 					Object.assign(existing, update)
-					
-					
-					
+					// if the message was received & read by us
+					// the chat counter must have been incremented
+					// so we need to decrement it
 					if (update.status === Types_1.WAMessageStatus.READ && !key.fromMe) {
 						decrementChatReadCounterIfMsgDidUnread(existing)
 					}
@@ -416,11 +442,7 @@ function append(
 					}
 				}
 			} else {
-				
-				
-				
-				
-				
+				// TODO: add support
 			}
 			break
 		case 'messages.reaction':
@@ -479,8 +501,8 @@ function append(
 		}
 	}
 	function decrementChatReadCounterIfMsgDidUnread(message) {
-		
-		
+		// decrement chat unread counter
+		// if the message has already been marked read by us
 		const chatId = message.key.remoteJid
 		const chat = data.chatUpdates[chatId] || data.chatUpserts[chatId]
 		if (
@@ -504,9 +526,11 @@ function consolidateEvents(data) {
 			chats: Object.values(data.historySets.chats),
 			messages: Object.values(data.historySets.messages),
 			contacts: Object.values(data.historySets.contacts),
+			pastParticipants: data.historySets.pastParticipants,
 			syncType: data.historySets.syncType,
 			progress: data.historySets.progress,
 			isLatest: data.historySets.isLatest,
+			chunkOrder: data.historySets.chunkOrder,
 			peerDataRequestSessionId: data.historySets.peerDataRequestSessionId
 		}
 	}
@@ -566,7 +590,7 @@ function consolidateEvents(data) {
 }
 function concatChats(a, b) {
 	if (
-		b.unreadCount === null && 
+		b.unreadCount === null && // neutralize unread counter
 		a.unreadCount < 0
 	) {
 		a.unreadCount = undefined