548 lines
22 KiB
JavaScript
548 lines
22 KiB
JavaScript
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',
|
|
'chats.update',
|
|
'chats.delete',
|
|
'contacts.upsert',
|
|
'contacts.update',
|
|
'messages.upsert',
|
|
'messages.update',
|
|
'messages.delete',
|
|
'messages.reaction',
|
|
'message-receipt.update',
|
|
'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.
|
|
*/
|
|
export const makeEventBuffer = (logger) => {
|
|
const ev = new EventEmitter();
|
|
const historyCache = new Set();
|
|
let data = makeBufferData();
|
|
let isBuffering = false;
|
|
let bufferTimeout = null;
|
|
let bufferCount = 0;
|
|
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]);
|
|
}
|
|
});
|
|
function buffer() {
|
|
if (!isBuffering) {
|
|
logger.debug('Event buffer activated');
|
|
isBuffering = true;
|
|
bufferCount++;
|
|
// Auto-flush after a timeout to prevent infinite buffering
|
|
if (bufferTimeout) {
|
|
clearTimeout(bufferTimeout);
|
|
}
|
|
bufferTimeout = setTimeout(() => {
|
|
if (isBuffering) {
|
|
logger.warn('Buffer timeout reached, auto-flushing');
|
|
flush();
|
|
}
|
|
}, BUFFER_TIMEOUT_MS);
|
|
}
|
|
else {
|
|
bufferCount++;
|
|
}
|
|
}
|
|
function flush() {
|
|
if (!isBuffering) {
|
|
return false;
|
|
}
|
|
logger.debug({ bufferCount }, 'Flushing event buffer');
|
|
isBuffering = false;
|
|
bufferCount = 0;
|
|
// Clear timeout
|
|
if (bufferTimeout) {
|
|
clearTimeout(bufferTimeout);
|
|
bufferTimeout = 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();
|
|
}
|
|
const newData = makeBufferData();
|
|
const chatUpdates = Object.values(data.chatUpdates);
|
|
let conditionalChatUpdatesLeft = 0;
|
|
for (const update of chatUpdates) {
|
|
if (update.conditional) {
|
|
conditionalChatUpdatesLeft += 1;
|
|
newData.chatUpdates[update.id] = update;
|
|
delete data.chatUpdates[update.id];
|
|
}
|
|
}
|
|
const consolidatedData = consolidateEvents(data);
|
|
if (Object.keys(consolidatedData).length) {
|
|
ev.emit('event', consolidatedData);
|
|
}
|
|
data = newData;
|
|
logger.trace({ conditionalChatUpdatesLeft }, 'released buffered events');
|
|
return true;
|
|
}
|
|
return {
|
|
process(handler) {
|
|
const listener = async (map) => {
|
|
await handler(map);
|
|
};
|
|
ev.on('event', listener);
|
|
return () => {
|
|
ev.off('event', listener);
|
|
};
|
|
},
|
|
emit(event, evData) {
|
|
if (isBuffering && BUFFERABLE_EVENT_SET.has(event)) {
|
|
append(data, historyCache, event, evData, logger);
|
|
return true;
|
|
}
|
|
return ev.emit('event', { [event]: evData });
|
|
},
|
|
isBuffering() {
|
|
return isBuffering;
|
|
},
|
|
buffer,
|
|
flush,
|
|
createBufferedFunction(work) {
|
|
return async (...args) => {
|
|
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); // Small delay to allow nested buffers
|
|
}
|
|
return result;
|
|
}
|
|
catch (error) {
|
|
throw error;
|
|
}
|
|
finally {
|
|
bufferCount = Math.max(0, bufferCount - 1);
|
|
if (bufferCount === 0) {
|
|
// Auto-flush when no other buffers are active
|
|
setTimeout(flush, 100);
|
|
}
|
|
}
|
|
};
|
|
},
|
|
on: (...args) => ev.on(...args),
|
|
off: (...args) => ev.off(...args),
|
|
removeAllListeners: (...args) => ev.removeAllListeners(...args)
|
|
};
|
|
};
|
|
const makeBufferData = () => {
|
|
return {
|
|
historySets: {
|
|
chats: {},
|
|
messages: {},
|
|
contacts: {},
|
|
isLatest: false,
|
|
empty: true
|
|
},
|
|
chatUpserts: {},
|
|
chatUpdates: {},
|
|
chatDeletes: new Set(),
|
|
contactUpserts: {},
|
|
contactUpdates: {},
|
|
messageUpserts: {},
|
|
messageUpdates: {},
|
|
messageReactions: {},
|
|
messageDeletes: {},
|
|
messageReceipts: {},
|
|
groupUpdates: {}
|
|
};
|
|
};
|
|
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) {
|
|
const id = chat.id || '';
|
|
const existingChat = data.historySets.chats[id];
|
|
if (existingChat) {
|
|
existingChat.endOfHistoryTransferType = chat.endOfHistoryTransferType;
|
|
}
|
|
if (!existingChat && !historyCache.has(id)) {
|
|
data.historySets.chats[id] = chat;
|
|
historyCache.add(id);
|
|
absorbingChatUpdate(chat);
|
|
}
|
|
}
|
|
for (const contact of eventData.contacts) {
|
|
const existingContact = data.historySets.contacts[contact.id];
|
|
if (existingContact) {
|
|
Object.assign(existingContact, trimUndefined(contact));
|
|
}
|
|
else {
|
|
const historyContactId = `c:${contact.id}`;
|
|
const hasAnyName = contact.notify || contact.name || contact.verifiedName;
|
|
if (!historyCache.has(historyContactId) || hasAnyName) {
|
|
data.historySets.contacts[contact.id] = contact;
|
|
historyCache.add(historyContactId);
|
|
}
|
|
}
|
|
}
|
|
for (const message of eventData.messages) {
|
|
const key = stringifyMessageKey(message.key);
|
|
const existingMsg = data.historySets.messages[key];
|
|
if (!existingMsg && !historyCache.has(key)) {
|
|
data.historySets.messages[key] = message;
|
|
historyCache.add(key);
|
|
}
|
|
}
|
|
data.historySets.empty = false;
|
|
data.historySets.syncType = eventData.syncType;
|
|
data.historySets.progress = eventData.progress;
|
|
data.historySets.peerDataRequestSessionId = eventData.peerDataRequestSessionId;
|
|
data.historySets.isLatest = eventData.isLatest || data.historySets.isLatest;
|
|
break;
|
|
case 'chats.upsert':
|
|
for (const chat of eventData) {
|
|
const id = chat.id || '';
|
|
let upsert = data.chatUpserts[id];
|
|
if (id && !upsert) {
|
|
upsert = data.historySets.chats[id];
|
|
if (upsert) {
|
|
logger.debug({ chatId: id }, 'absorbed chat upsert in chat set');
|
|
}
|
|
}
|
|
if (upsert) {
|
|
upsert = concatChats(upsert, chat);
|
|
}
|
|
else {
|
|
upsert = chat;
|
|
data.chatUpserts[id] = upsert;
|
|
}
|
|
absorbingChatUpdate(upsert);
|
|
if (data.chatDeletes.has(id)) {
|
|
data.chatDeletes.delete(id);
|
|
}
|
|
}
|
|
break;
|
|
case 'chats.update':
|
|
for (const update of eventData) {
|
|
const chatId = update.id;
|
|
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);
|
|
}
|
|
}
|
|
break;
|
|
case 'chats.delete':
|
|
for (const chatId of eventData) {
|
|
if (!data.chatDeletes.has(chatId)) {
|
|
data.chatDeletes.add(chatId);
|
|
}
|
|
// remove any prior updates & upserts
|
|
if (data.chatUpdates[chatId]) {
|
|
delete data.chatUpdates[chatId];
|
|
}
|
|
if (data.chatUpserts[chatId]) {
|
|
delete data.chatUpserts[chatId];
|
|
}
|
|
if (data.historySets.chats[chatId]) {
|
|
delete data.historySets.chats[chatId];
|
|
}
|
|
}
|
|
break;
|
|
case 'contacts.upsert':
|
|
for (const contact of eventData) {
|
|
let upsert = data.contactUpserts[contact.id];
|
|
if (!upsert) {
|
|
upsert = data.historySets.contacts[contact.id];
|
|
if (upsert) {
|
|
logger.debug({ contactId: contact.id }, 'absorbed contact upsert in contact set');
|
|
}
|
|
}
|
|
if (upsert) {
|
|
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], trimUndefined(contact));
|
|
delete data.contactUpdates[contact.id];
|
|
}
|
|
}
|
|
break;
|
|
case 'contacts.update':
|
|
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);
|
|
}
|
|
}
|
|
break;
|
|
case 'messages.upsert':
|
|
const { messages, type } = eventData;
|
|
for (const message of messages) {
|
|
const key = stringifyMessageKey(message.key);
|
|
let existing = data.messageUpserts[key]?.message;
|
|
if (!existing) {
|
|
existing = data.historySets.messages[key];
|
|
if (existing) {
|
|
logger.debug({ messageId: key }, 'absorbed message upsert in message set');
|
|
}
|
|
}
|
|
if (existing) {
|
|
message.messageTimestamp = existing.messageTimestamp;
|
|
}
|
|
if (data.messageUpdates[key]) {
|
|
logger.debug('absorbed prior message update in message upsert');
|
|
Object.assign(message, data.messageUpdates[key].update);
|
|
delete data.messageUpdates[key];
|
|
}
|
|
if (data.historySets.messages[key]) {
|
|
data.historySets.messages[key] = message;
|
|
}
|
|
else {
|
|
data.messageUpserts[key] = {
|
|
message,
|
|
type: type === 'notify' || data.messageUpserts[key]?.type === 'notify' ? 'notify' : type
|
|
};
|
|
}
|
|
}
|
|
break;
|
|
case 'messages.update':
|
|
const msgUpdates = eventData;
|
|
for (const { key, update } of msgUpdates) {
|
|
const keyStr = stringifyMessageKey(key);
|
|
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 === WAMessageStatus.READ && !key.fromMe) {
|
|
decrementChatReadCounterIfMsgDidUnread(existing);
|
|
}
|
|
}
|
|
else {
|
|
const msgUpdate = data.messageUpdates[keyStr] || { key, update: {} };
|
|
Object.assign(msgUpdate.update, update);
|
|
data.messageUpdates[keyStr] = msgUpdate;
|
|
}
|
|
}
|
|
break;
|
|
case 'messages.delete':
|
|
const deleteData = eventData;
|
|
if ('keys' in deleteData) {
|
|
const { keys } = deleteData;
|
|
for (const key of keys) {
|
|
const keyStr = stringifyMessageKey(key);
|
|
if (!data.messageDeletes[keyStr]) {
|
|
data.messageDeletes[keyStr] = key;
|
|
}
|
|
if (data.messageUpserts[keyStr]) {
|
|
delete data.messageUpserts[keyStr];
|
|
}
|
|
if (data.messageUpdates[keyStr]) {
|
|
delete data.messageUpdates[keyStr];
|
|
}
|
|
}
|
|
}
|
|
else {
|
|
// TODO: add support
|
|
}
|
|
break;
|
|
case 'messages.reaction':
|
|
const reactions = eventData;
|
|
for (const { key, reaction } of reactions) {
|
|
const keyStr = stringifyMessageKey(key);
|
|
const existing = data.messageUpserts[keyStr];
|
|
if (existing) {
|
|
updateMessageWithReaction(existing.message, reaction);
|
|
}
|
|
else {
|
|
data.messageReactions[keyStr] = data.messageReactions[keyStr] || { key, reactions: [] };
|
|
updateMessageWithReaction(data.messageReactions[keyStr], reaction);
|
|
}
|
|
}
|
|
break;
|
|
case 'message-receipt.update':
|
|
const receipts = eventData;
|
|
for (const { key, receipt } of receipts) {
|
|
const keyStr = stringifyMessageKey(key);
|
|
const existing = data.messageUpserts[keyStr];
|
|
if (existing) {
|
|
updateMessageWithReceipt(existing.message, receipt);
|
|
}
|
|
else {
|
|
data.messageReceipts[keyStr] = data.messageReceipts[keyStr] || { key, userReceipt: [] };
|
|
updateMessageWithReceipt(data.messageReceipts[keyStr], receipt);
|
|
}
|
|
}
|
|
break;
|
|
case 'groups.update':
|
|
const groupUpdates = eventData;
|
|
for (const update of groupUpdates) {
|
|
const id = update.id;
|
|
const groupUpdate = data.groupUpdates[id] || {};
|
|
if (!data.groupUpdates[id]) {
|
|
data.groupUpdates[id] = Object.assign(groupUpdate, update);
|
|
}
|
|
}
|
|
break;
|
|
default:
|
|
throw new Error(`"${event}" cannot be buffered`);
|
|
}
|
|
function absorbingChatUpdate(existing) {
|
|
const chatId = existing.id || '';
|
|
const update = data.chatUpdates[chatId];
|
|
if (update) {
|
|
const conditionMatches = update.conditional ? update.conditional(data) : true;
|
|
if (conditionMatches) {
|
|
delete update.conditional;
|
|
logger.debug({ chatId }, 'absorbed chat update in existing chat');
|
|
Object.assign(existing, concatChats(update, existing));
|
|
delete data.chatUpdates[chatId];
|
|
}
|
|
else if (conditionMatches === false) {
|
|
logger.debug({ chatId }, 'chat update condition fail, removing');
|
|
delete data.chatUpdates[chatId];
|
|
}
|
|
}
|
|
}
|
|
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 (isRealMessage(message) &&
|
|
shouldIncrementChatUnread(message) &&
|
|
typeof chat?.unreadCount === 'number' &&
|
|
chat.unreadCount > 0) {
|
|
logger.debug({ chatId: chat.id }, 'decrementing chat counter');
|
|
chat.unreadCount -= 1;
|
|
if (chat.unreadCount === 0) {
|
|
delete chat.unreadCount;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
function consolidateEvents(data) {
|
|
const map = {};
|
|
if (!data.historySets.empty) {
|
|
map['messaging-history.set'] = {
|
|
chats: Object.values(data.historySets.chats),
|
|
messages: Object.values(data.historySets.messages),
|
|
contacts: Object.values(data.historySets.contacts),
|
|
syncType: data.historySets.syncType,
|
|
progress: data.historySets.progress,
|
|
isLatest: data.historySets.isLatest,
|
|
peerDataRequestSessionId: data.historySets.peerDataRequestSessionId
|
|
};
|
|
}
|
|
const chatUpsertList = Object.values(data.chatUpserts);
|
|
if (chatUpsertList.length) {
|
|
map['chats.upsert'] = chatUpsertList;
|
|
}
|
|
const chatUpdateList = Object.values(data.chatUpdates);
|
|
if (chatUpdateList.length) {
|
|
map['chats.update'] = chatUpdateList;
|
|
}
|
|
const chatDeleteList = Array.from(data.chatDeletes);
|
|
if (chatDeleteList.length) {
|
|
map['chats.delete'] = chatDeleteList;
|
|
}
|
|
const messageUpsertList = Object.values(data.messageUpserts);
|
|
if (messageUpsertList.length) {
|
|
const type = messageUpsertList[0].type;
|
|
map['messages.upsert'] = {
|
|
messages: messageUpsertList.map(m => m.message),
|
|
type
|
|
};
|
|
}
|
|
const messageUpdateList = Object.values(data.messageUpdates);
|
|
if (messageUpdateList.length) {
|
|
map['messages.update'] = messageUpdateList;
|
|
}
|
|
const messageDeleteList = Object.values(data.messageDeletes);
|
|
if (messageDeleteList.length) {
|
|
map['messages.delete'] = { keys: messageDeleteList };
|
|
}
|
|
const messageReactionList = Object.values(data.messageReactions).flatMap(({ key, reactions }) => reactions.flatMap(reaction => ({ key, reaction })));
|
|
if (messageReactionList.length) {
|
|
map['messages.reaction'] = messageReactionList;
|
|
}
|
|
const messageReceiptList = Object.values(data.messageReceipts).flatMap(({ key, userReceipt }) => userReceipt.flatMap(receipt => ({ key, receipt })));
|
|
if (messageReceiptList.length) {
|
|
map['message-receipt.update'] = messageReceiptList;
|
|
}
|
|
const contactUpsertList = Object.values(data.contactUpserts);
|
|
if (contactUpsertList.length) {
|
|
map['contacts.upsert'] = contactUpsertList;
|
|
}
|
|
const contactUpdateList = Object.values(data.contactUpdates);
|
|
if (contactUpdateList.length) {
|
|
map['contacts.update'] = contactUpdateList;
|
|
}
|
|
const groupUpdateList = Object.values(data.groupUpdates);
|
|
if (groupUpdateList.length) {
|
|
map['groups.update'] = groupUpdateList;
|
|
}
|
|
return map;
|
|
}
|
|
function concatChats(a, b) {
|
|
if (b.unreadCount === null && // neutralize unread counter
|
|
a.unreadCount < 0) {
|
|
a.unreadCount = undefined;
|
|
b.unreadCount = undefined;
|
|
}
|
|
if (typeof a.unreadCount === 'number' && typeof b.unreadCount === 'number') {
|
|
b = { ...b };
|
|
if (b.unreadCount >= 0) {
|
|
b.unreadCount = Math.max(b.unreadCount, 0) + Math.max(a.unreadCount, 0);
|
|
}
|
|
}
|
|
return Object.assign(a, b);
|
|
}
|
|
const stringifyMessageKey = (key) => `${key.remoteJid},${key.id},${key.fromMe ? '1' : '0'}`;
|
|
//# sourceMappingURL=event-buffer.js.map
|