@badzz88/baileys 8.5.6 → 8.5.8

package/{src → lib}/Utils/event-buffer.js

@@ -1,15 +1,8 @@
-'use strict';
-var __importDefault = (this && this.__importDefault) ||
-    function (mod) {
-        return mod && mod.__esModule ? mod : { default: mod };
-    };
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.makeEventBuffer = void 0;
-const events_1 = __importDefault(require('events'));
-const Types_1 = require('../Types');
-const generics_1 = require('./generics');
-const messages_1 = require('./messages');
-const process_message_1 = require('./process-message');
+import EventEmitter from 'events';
+import { WAMessageStatus } from '../Types/index.js';
+import { trimUndefined } from './generics.js';
+import { updateMessageWithReaction, updateMessageWithReceipt } from './messages.js';
+import { isRealMessage, shouldIncrementChatUnread } from './process-message.js';
 const BUFFERABLE_EVENT = [
     'messaging-history.set',
     'chats.upsert',
@@ -25,17 +18,22 @@ const BUFFERABLE_EVENT = [
     'groups.update'
 ];
 const BUFFERABLE_EVENT_SET = new Set(BUFFERABLE_EVENT);
-const makeEventBuffer = logger => {
-    const ev = new events_1.default();
+/**
+ * The event buffer logically consolidates different events into a single event
+ * making the data processing more efficient.
+ */
+export const makeEventBuffer = (logger) => {
+    const ev = new EventEmitter();
     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;
-    ev.on('event', map => {
+    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]);
         }
@@ -55,6 +53,7 @@ const makeEventBuffer = logger => {
                 }
             }, BUFFER_TIMEOUT_MS);
         }
+        // Always increment count when requested
         bufferCount++;
     }
     function flush() {
@@ -64,6 +63,7 @@ const makeEventBuffer = logger => {
         logger.debug({ bufferCount }, 'Flushing event buffer');
         isBuffering = false;
         bufferCount = 0;
+        // Clear timeout
         if (bufferTimeout) {
             clearTimeout(bufferTimeout);
             bufferTimeout = null;
@@ -72,6 +72,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();
@@ -105,6 +106,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);
@@ -112,12 +115,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 = {};
                     }
                 }
@@ -138,12 +143,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;
                 }
@@ -153,6 +159,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);
                         }
@@ -162,10 +169,29 @@ const makeEventBuffer = logger => {
         },
         on: (...args) => ev.on(...args),
         off: (...args) => ev.off(...args),
-        removeAllListeners: (...args) => ev.removeAllListeners(...args)
+        removeAllListeners: (...args) => ev.removeAllListeners(...args),
+        destroy() {
+            // Clear buffer timeout
+            if (bufferTimeout) {
+                clearTimeout(bufferTimeout);
+                bufferTimeout = null;
+            }
+            if (flushPendingTimeout) {
+                clearTimeout(flushPendingTimeout);
+                flushPendingTimeout = null;
+            }
+            // Clear history cache
+            historyCache.clear();
+            // Reset buffer data
+            data = makeBufferData();
+            isBuffering = false;
+            bufferCount = 0;
+            // Remove all listeners
+            ev.removeAllListeners();
+            logger.debug('Event buffer destroyed');
+        }
     };
 };
-exports.makeEventBuffer = makeEventBuffer;
 const makeBufferData = () => {
     return {
         historySets: {
@@ -188,7 +214,9 @@ const makeBufferData = () => {
         groupUpdates: {}
     };
 };
-function append(data, historyCache, event, eventData, logger) {
+function append(data, historyCache, event, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+eventData, logger) {
     switch (event) {
         case 'messaging-history.set':
             for (const chat of eventData.chats) {
@@ -206,7 +234,7 @@ function append(data, historyCache, event, eventData, logger) {
             for (const contact of eventData.contacts) {
                 const existingContact = data.historySets.contacts[contact.id];
                 if (existingContact) {
-                    Object.assign(existingContact, (0, generics_1.trimUndefined)(contact));
+                    Object.assign(existingContact, trimUndefined(contact));
                 }
                 else {
                     const historyContactId = `c:${contact.id}`;
@@ -229,8 +257,8 @@ function append(data, historyCache, event, eventData, logger) {
             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 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) {
@@ -252,8 +280,8 @@ function append(data, historyCache, event, eventData, logger) {
                     ingest(entry);
                 data.historySets.pastParticipants = [...merged.values()];
             }
-            data.historySets.chunkOrder = eventData.chunkOrder;
             data.historySets.progress = eventData.progress;
+            data.historySets.chunkOrder = eventData.chunkOrder;
             data.historySets.peerDataRequestSessionId = eventData.peerDataRequestSessionId;
             data.historySets.isLatest = eventData.isLatest || data.historySets.isLatest;
             break;
@@ -286,18 +314,24 @@ function append(data, historyCache, event, eventData, logger) {
                 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);
                 }
@@ -308,6 +342,7 @@ function append(data, historyCache, event, eventData, logger) {
                 if (!data.chatDeletes.has(chatId)) {
                     data.chatDeletes.add(chatId);
                 }
+                // remove any prior updates & upserts
                 if (data.chatUpdates[chatId]) {
                     delete data.chatUpdates[chatId];
                 }
@@ -329,14 +364,14 @@ function append(data, historyCache, event, eventData, logger) {
                     }
                 }
                 if (upsert) {
-                    upsert = Object.assign(upsert, (0, generics_1.trimUndefined)(contact));
+                    upsert = Object.assign(upsert, trimUndefined(contact));
                 }
                 else {
                     upsert = contact;
                     data.contactUpserts[contact.id] = upsert;
                 }
                 if (data.contactUpdates[contact.id]) {
-                    upsert = Object.assign(data.contactUpdates[contact.id], (0, generics_1.trimUndefined)(contact));
+                    upsert = Object.assign(data.contactUpdates[contact.id], trimUndefined(contact));
                     delete data.contactUpdates[contact.id];
                 }
             }
@@ -345,11 +380,13 @@ function append(data, historyCache, event, eventData, logger) {
             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);
                 }
@@ -392,7 +429,10 @@ function append(data, historyCache, event, eventData, logger) {
                 const existing = data.historySets.messages[keyStr] || data.messageUpserts[keyStr]?.message;
                 if (existing) {
                     Object.assign(existing, update);
-                    if (update.status === Types_1.WAMessageStatus.READ && !key.fromMe) {
+                    // if the message was received & read by us
+                    // the chat counter must have been incremented
+                    // so we need to decrement it
+                    if (update.status === WAMessageStatus.READ && !key.fromMe) {
                         decrementChatReadCounterIfMsgDidUnread(existing);
                     }
                 }
@@ -421,6 +461,7 @@ function append(data, historyCache, event, eventData, logger) {
                 }
             }
             else {
+                // TODO: add support
             }
             break;
         case 'messages.reaction':
@@ -429,12 +470,11 @@ function append(data, historyCache, event, eventData, logger) {
                 const keyStr = stringifyMessageKey(key);
                 const existing = data.messageUpserts[keyStr];
                 if (existing) {
-                    ;
-                    (0, messages_1.updateMessageWithReaction)(existing.message, reaction);
+                    updateMessageWithReaction(existing.message, reaction);
                 }
                 else {
                     data.messageReactions[keyStr] = data.messageReactions[keyStr] || { key, reactions: [] };
-                    (0, messages_1.updateMessageWithReaction)(data.messageReactions[keyStr], reaction);
+                    updateMessageWithReaction(data.messageReactions[keyStr], reaction);
                 }
             }
             break;
@@ -444,12 +484,11 @@ function append(data, historyCache, event, eventData, logger) {
                 const keyStr = stringifyMessageKey(key);
                 const existing = data.messageUpserts[keyStr];
                 if (existing) {
-                    ;
-                    (0, messages_1.updateMessageWithReceipt)(existing.message, receipt);
+                    updateMessageWithReceipt(existing.message, receipt);
                 }
                 else {
                     data.messageReceipts[keyStr] = data.messageReceipts[keyStr] || { key, userReceipt: [] };
-                    (0, messages_1.updateMessageWithReceipt)(data.messageReceipts[keyStr], receipt);
+                    updateMessageWithReceipt(data.messageReceipts[keyStr], receipt);
                 }
             }
             break;
@@ -484,10 +523,12 @@ function append(data, historyCache, event, eventData, logger) {
         }
     }
     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 ((0, process_message_1.isRealMessage)(message) &&
-            (0, process_message_1.shouldIncrementChatUnread)(message) &&
+        if (isRealMessage(message) &&
+            shouldIncrementChatUnread(message) &&
             typeof chat?.unreadCount === 'number' &&
             chat.unreadCount > 0) {
             logger.debug({ chatId: chat.id }, 'decrementing chat counter');
@@ -564,7 +605,7 @@ function consolidateEvents(data) {
     return map;
 }
 function concatChats(a, b) {
-    if (b.unreadCount === null &&
+    if (b.unreadCount === null && // neutralize unread counter
         a.unreadCount < 0) {
         a.unreadCount = undefined;
         b.unreadCount = undefined;
@@ -577,4 +618,5 @@ function concatChats(a, b) {
     }
     return Object.assign(a, b);
 }
-const stringifyMessageKey = key => `${key.remoteJid},${key.id},${key.fromMe ? '1' : '0'}`;
+const stringifyMessageKey = (key) => `${key.remoteJid},${key.id},${key.fromMe ? '1' : '0'}`;
+//# sourceMappingURL=event-buffer.js.map