franpcode/Baileys
1
0
Fork 0
mirror of https://github.com/FranP-code/Baileys.git synced 2025-10-13 00:32:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

store: remove built-in store

Browse Source
This commit is contained in:
Rajeh Taher
2025-03-10 17:35:46 +02:00
parent 1c2af09b03
commit 64d09c70b4
7 changed files with 11 additions and 726 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
Example/example.ts
View File

@@ -1,7 +1,7 @@
import { Boom } from '@hapi/boom'
import NodeCache from '@cacheable/node-cache'
import readline from 'readline'
import makeWASocket, { AnyMessageContent, BinaryInfo, delay, DisconnectReason, downloadAndProcessHistorySyncNotification, encodeWAM, fetchLatestBaileysVersion, getAggregateVotesInPollMessage, getHistoryMsg, isJidNewsletter, makeCacheableSignalKeyStore, makeInMemoryStore, proto, useMultiFileAuthState, WAMessageContent, WAMessageKey } from '../src'
import makeWASocket, { AnyMessageContent, BinaryInfo, delay, DisconnectReason, downloadAndProcessHistorySyncNotification, encodeWAM, fetchLatestBaileysVersion, getAggregateVotesInPollMessage, getHistoryMsg, isJidNewsletter, makeCacheableSignalKeyStore, proto, useMultiFileAuthState, WAMessageContent, WAMessageKey } from '../src'
//import MAIN_LOGGER from '../src/Utils/logger'
import open from 'open'
import fs from 'fs'
@@ -10,7 +10,6 @@ import P from 'pino'
const logger = P({ timestamp: () => `,"time":"${new Date().toJSON()}"` }, P.destination('./wa-logs.txt'))
logger.level = 'trace'
const useStore = !process.argv.includes('--no-store')
const doReplies = process.argv.includes('--do-reply')
const usePairingCode = process.argv.includes('--use-pairing-code')
@@ -24,15 +23,6 @@ const onDemandMap = new Map<string, string>()
const rl = readline.createInterface({ input: process.stdin, output: process.stdout })
const question = (text: string) => new Promise<string>((resolve) => rl.question(text, resolve))
// the store maintains the data of the WA connection in memory
// can be written out to a file & read from it
const store = useStore ? makeInMemoryStore({ logger }) : undefined
store?.readFromFile('./baileys_store_multi.json')
// save every 10s
setInterval(() => {
store?.writeToFile('./baileys_store_multi.json')
}, 10_000)
// start a connection
const startSock = async() => {
const { state, saveCreds } = await useMultiFileAuthState('baileys_auth_info')
@@ -58,8 +48,6 @@ const startSock = async() => {
getMessage,
})
store?.bind(sock.ev)
// Pairing code for Web clients
if (usePairingCode && !sock.authState.creds.registered) {
// todo move to QR event
@@ -98,7 +86,7 @@ const startSock = async() => {
console.log('Connection closed. You are logged out.')
}
}
// WARNING: THIS WILL SEND A WAM EXAMPLE AND THIS IS A ****CAPTURED MESSAGE.****
// DO NOT ACTUALLY ENABLE THIS UNLESS YOU MODIFIED THE FILE.JSON!!!!!
// THE ANALYTICS IN THE FILE ARE OLD. DO NOT USE THEM.
@@ -124,7 +112,7 @@ const startSock = async() => {
})
const buffer = encodeWAM(binaryInfo);
const result = await sock.sendWAMBuffer(buffer)
console.log(result)
}
@@ -182,11 +170,11 @@ const startSock = async() => {
{}
)
const chatId = onDemandMap.get(
historySyncNotification!.peerDataRequestSessionId!
)
console.log(messages)
onDemandMap.delete(
@@ -209,7 +197,7 @@ const startSock = async() => {
if (msg.message?.conversation || msg.message?.extendedTextMessage?.text) {
const text = msg.message?.conversation || msg.message?.extendedTextMessage?.text
if (text == "requestPlaceholder" && !upsert.requestId) {
const messageId = await sock.requestPlaceholderResend(msg.key)
const messageId = await sock.requestPlaceholderResend(msg.key)
console.log('requested placeholder resync, id=', messageId)
} else if (upsert.requestId) {
console.log('Message received from phone, id=', upsert.requestId, msg)
@@ -217,7 +205,7 @@ const startSock = async() => {
// go to an old chat and send this
if (text == "onDemandHistSync") {
const messageId = await sock.fetchMessageHistory(50, msg.key, msg.messageTimestamp!)
const messageId = await sock.fetchMessageHistory(50, msg.key, msg.messageTimestamp!)
console.log('requested on-demand sync, id=', messageId)
}
}
@@ -240,7 +228,7 @@ const startSock = async() => {
for(const { key, update } of events['messages.update']) {
if(update.pollUpdates) {
const pollCreation = await getMessage(key)
const pollCreation: proto.IMessage = {} // get the poll creation message somehow
if(pollCreation) {
console.log(
'got poll update, aggregation: ',
@@ -292,14 +280,12 @@ const startSock = async() => {
return sock
async function getMessage(key: WAMessageKey): Promise<WAMessageContent | undefined> {
if(store) {
const msg = await store.loadMessage(key.remoteJid!, key.id!)
return msg?.message || undefined
}
// Implement a way to retreive messages that were upserted from messages.upsert
// up to you
// only if store is present
return proto.Message.fromObject({})
}
}
startSock()
startSock()

3
src/Store/index.ts
View File

@@ -1,3 +0,0 @@
import makeCacheManagerAuthState from './make-cache-manager-store'
import makeInMemoryStore from './make-in-memory-store'
export { makeInMemoryStore, makeCacheManagerAuthState }

100
src/Store/make-cache-manager-store.ts
View File

@@ -1,100 +0,0 @@
import { caching, Store } from 'cache-manager'
import { proto } from '../../WAProto'
import { AuthenticationCreds } from '../Types'
import { BufferJSON, initAuthCreds } from '../Utils'
import logger from '../Utils/logger'
const makeCacheManagerAuthState = async(store: Store, sessionKey: string) => {
const defaultKey = (file: string): string => `${sessionKey}:${file}`
const databaseConn = await caching(store)
const writeData = async(file: string, data: object) => {
let ttl: number | undefined = undefined
if(file === 'creds') {
ttl = 63115200 // 2 years
}
await databaseConn.set(
defaultKey(file),
JSON.stringify(data, BufferJSON.replacer),
ttl
)
}
const readData = async(file: string): Promise<AuthenticationCreds | null> => {
try {
const data = await databaseConn.get(defaultKey(file))
if(data) {
return JSON.parse(data as string, BufferJSON.reviver)
}
return null
} catch(error) {
logger.error(error)
return null
}
}
const removeData = async(file: string) => {
try {
return await databaseConn.del(defaultKey(file))
} catch{
logger.error(`Error removing ${file} from session ${sessionKey}`)
}
}
const clearState = async() => {
try {
const result = await databaseConn.store.keys(`${sessionKey}*`)
await Promise.all(
result.map(async(key) => await databaseConn.del(key))
)
} catch(err) {
}
}
const creds: AuthenticationCreds = (await readData('creds')) || initAuthCreds()
return {
clearState,
saveCreds: () => writeData('creds', creds),
state: {
creds,
keys: {
get: async(type: string, ids: string[]) => {
const data = {}
await Promise.all(
ids.map(async(id) => {
let value: proto.Message.AppStateSyncKeyData | AuthenticationCreds | null =
await readData(`${type}-${id}`)
if(type === 'app-state-sync-key' && value) {
value = proto.Message.AppStateSyncKeyData.fromObject(value)
}
data[id] = value
})
)
return data
},
set: async(data) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const tasks: Promise<any>[] = []
for(const category in data) {
for(const id in data[category]) {
const value = data[category][id]
const key = `${category}-${id}`
tasks.push(value ? writeData(key, value) : removeData(key))
}
}
await Promise.all(tasks)
},
}
}
}
}
export default makeCacheManagerAuthState

479
src/Store/make-in-memory-store.ts
View File

@@ -1,479 +0,0 @@
import type KeyedDB from '@adiwajshing/keyed-db'
import type { Comparable } from '@adiwajshing/keyed-db/lib/Types'
import { proto } from '../../WAProto'
import { DEFAULT_CONNECTION_CONFIG } from '../Defaults'
import type makeMDSocket from '../Socket'
import type { BaileysEventEmitter, Chat, ConnectionState, Contact, GroupMetadata, PresenceData, WAMessage, WAMessageCursor, WAMessageKey } from '../Types'
import { Label } from '../Types/Label'
import { LabelAssociation, LabelAssociationType, MessageLabelAssociation } from '../Types/LabelAssociation'
import { md5, toNumber, updateMessageWithReaction, updateMessageWithReceipt } from '../Utils'
import { ILogger } from '../Utils/logger'
import { jidDecode, jidNormalizedUser } from '../WABinary'
import makeOrderedDictionary from './make-ordered-dictionary'
import { ObjectRepository } from './object-repository'
type WASocket = ReturnType<typeof makeMDSocket>
export const waChatKey = (pin: boolean) => ({
key: (c: Chat) => (pin ? (c.pinned ? '1' : '0') : '') + (c.archived ? '0' : '1') + (c.conversationTimestamp ? c.conversationTimestamp.toString(16).padStart(8, '0') : '') + c.id,
compare: (k1: string, k2: string) => k2.localeCompare(k1)
})
export const waMessageID = (m: WAMessage) => m.key.id || ''
export const waLabelAssociationKey: Comparable<LabelAssociation, string> = {
key: (la: LabelAssociation) => (la.type === LabelAssociationType.Chat ? la.chatId + la.labelId : la.chatId + la.messageId + la.labelId),
compare: (k1: string, k2: string) => k2.localeCompare(k1)
}
export type BaileysInMemoryStoreConfig = {
chatKey?: Comparable<Chat, string>
labelAssociationKey?: Comparable<LabelAssociation, string>
logger?: ILogger
socket?: WASocket
}
const makeMessagesDictionary = () => makeOrderedDictionary(waMessageID)
export default (config: BaileysInMemoryStoreConfig) => {
const socket = config.socket
const chatKey = config.chatKey || waChatKey(true)
const labelAssociationKey = config.labelAssociationKey || waLabelAssociationKey
const logger: ILogger = config.logger || DEFAULT_CONNECTION_CONFIG.logger.child({ stream: 'in-mem-store' })
const KeyedDB = require('@adiwajshing/keyed-db').default
const chats = new KeyedDB(chatKey, c => c.id) as KeyedDB<Chat, string>
const messages: { [_: string]: ReturnType<typeof makeMessagesDictionary> } = {}
const contacts: { [_: string]: Contact } = {}
const groupMetadata: { [_: string]: GroupMetadata } = {}
const presences: { [id: string]: { [participant: string]: PresenceData } } = {}
const state: ConnectionState = { connection: 'close' }
const labels = new ObjectRepository<Label>()
const labelAssociations = new KeyedDB(labelAssociationKey, labelAssociationKey.key) as KeyedDB<LabelAssociation, string>
const assertMessageList = (jid: string) => {
if(!messages[jid]) {
messages[jid] = makeMessagesDictionary()
}
return messages[jid]
}
const contactsUpsert = (newContacts: Contact[]) => {
const oldContacts = new Set(Object.keys(contacts))
for(const contact of newContacts) {
oldContacts.delete(contact.id)
contacts[contact.id] = Object.assign(
contacts[contact.id] || {},
contact
)
}
return oldContacts
}
const labelsUpsert = (newLabels: Label[]) => {
for(const label of newLabels) {
labels.upsertById(label.id, label)
}
}
/**
* binds to a BaileysEventEmitter.
* It listens to all events and constructs a state that you can query accurate data from.
* Eg. can use the store to fetch chats, contacts, messages etc.
* @param ev typically the event emitter from the socket connection
*/
const bind = (ev: BaileysEventEmitter) => {
ev.on('connection.update', update => {
Object.assign(state, update)
})
ev.on('messaging-history.set', ({
chats: newChats,
contacts: newContacts,
messages: newMessages,
isLatest,
syncType
}) => {
if(syncType === proto.HistorySync.HistorySyncType.ON_DEMAND) {
return // FOR NOW,
//TODO: HANDLE
}
if(isLatest) {
chats.clear()
for(const id in messages) {
delete messages[id]
}
}
const chatsAdded = chats.insertIfAbsent(...newChats).length
logger.debug({ chatsAdded }, 'synced chats')
const oldContacts = contactsUpsert(newContacts)
if(isLatest) {
for(const jid of oldContacts) {
delete contacts[jid]
}
}
logger.debug({ deletedContacts: isLatest ? oldContacts.size : 0, newContacts }, 'synced contacts')
for(const msg of newMessages) {
const jid = msg.key.remoteJid!
const list = assertMessageList(jid)
list.upsert(msg, 'prepend')
}
logger.debug({ messages: newMessages.length }, 'synced messages')
})
ev.on('contacts.upsert', contacts => {
contactsUpsert(contacts)
})
ev.on('contacts.update', async updates => {
for(const update of updates) {
let contact: Contact
if(contacts[update.id!]) {
contact = contacts[update.id!]
} else {
const contactHashes = await Promise.all(Object.keys(contacts).map(async contactId => {
const { user } = jidDecode(contactId)!
return [contactId, (await md5(Buffer.from(user + 'WA_ADD_NOTIF', 'utf8'))).toString('base64').slice(0, 3)]
}))
contact = contacts[contactHashes.find(([, b]) => b === update.id)?.[0] || ''] // find contact by attrs.hash, when user is not saved as a contact
}
if(contact) {
if(update.imgUrl === 'changed') {
contact.imgUrl = socket ? await socket?.profilePictureUrl(contact.id) : undefined
} else if(update.imgUrl === 'removed') {
delete contact.imgUrl
}
} else {
return logger.debug({ update }, 'got update for non-existant contact')
}
Object.assign(contacts[contact.id], contact)
}
})
ev.on('chats.upsert', newChats => {
chats.upsert(...newChats)
})
ev.on('chats.update', updates => {
for(let update of updates) {
const result = chats.update(update.id!, chat => {
if(update.unreadCount! > 0) {
update = { ...update }
update.unreadCount = (chat.unreadCount || 0) + update.unreadCount!
}
Object.assign(chat, update)
})
if(!result) {
logger.debug({ update }, 'got update for non-existant chat')
}
}
})
ev.on('labels.edit', (label: Label) => {
if(label.deleted) {
return labels.deleteById(label.id)
}
// WhatsApp can store only up to 20 labels
if(labels.count() < 20) {
return labels.upsertById(label.id, label)
}
logger.error('Labels count exceed')
})
ev.on('labels.association', ({ type, association }) => {
switch (type) {
case 'add':
labelAssociations.upsert(association)
break
case 'remove':
labelAssociations.delete(association)
break
default:
console.error(`unknown operation type [${type}]`)
}
})
ev.on('presence.update', ({ id, presences: update }) => {
presences[id] = presences[id] || {}
Object.assign(presences[id], update)
})
ev.on('chats.delete', deletions => {
for(const item of deletions) {
if(chats.get(item)) {
chats.deleteById(item)
}
}
})
ev.on('messages.upsert', ({ messages: newMessages, type }) => {
switch (type) {
case 'append':
case 'notify':
for(const msg of newMessages) {
const jid = jidNormalizedUser(msg.key.remoteJid!)
const list = assertMessageList(jid)
list.upsert(msg, 'append')
if(type === 'notify' && !chats.get(jid)) {
ev.emit('chats.upsert', [
{
id: jid,
conversationTimestamp: toNumber(msg.messageTimestamp),
unreadCount: 1
}
])
}
}
break
}
})
ev.on('messages.update', updates => {
for(const { update, key } of updates) {
const list = assertMessageList(jidNormalizedUser(key.remoteJid!))
if(update?.status) {
const listStatus = list.get(key.id!)?.status
if(listStatus && update?.status <= listStatus) {
logger.debug({ update, storedStatus: listStatus }, 'status stored newer then update')
delete update.status
logger.debug({ update }, 'new update object')
}
}
const result = list.updateAssign(key.id!, update)
if(!result) {
logger.debug({ update }, 'got update for non-existent message')
}
}
})
ev.on('messages.delete', item => {
if('all' in item) {
const list = messages[item.jid]
list?.clear()
} else {
const jid = item.keys[0].remoteJid!
const list = messages[jid]
if(list) {
const idSet = new Set(item.keys.map(k => k.id))
list.filter(m => !idSet.has(m.key.id))
}
}
})
ev.on('groups.update', updates => {
for(const update of updates) {
const id = update.id!
if(groupMetadata[id]) {
Object.assign(groupMetadata[id], update)
} else {
logger.debug({ update }, 'got update for non-existant group metadata')
}
}
})
ev.on('group-participants.update', ({ id, participants, action }) => {
const metadata = groupMetadata[id]
if(metadata) {
switch (action) {
case 'add':
metadata.participants.push(...participants.map(id => ({ id, isAdmin: false, isSuperAdmin: false })))
break
case 'demote':
case 'promote':
for(const participant of metadata.participants) {
if(participants.includes(participant.id)) {
participant.isAdmin = action === 'promote'
}
}
break
case 'remove':
metadata.participants = metadata.participants.filter(p => !participants.includes(p.id))
break
}
}
})
ev.on('message-receipt.update', updates => {
for(const { key, receipt } of updates) {
const obj = messages[key.remoteJid!]
const msg = obj?.get(key.id!)
if(msg) {
updateMessageWithReceipt(msg, receipt)
}
}
})
ev.on('messages.reaction', (reactions) => {
for(const { key, reaction } of reactions) {
const obj = messages[key.remoteJid!]
const msg = obj?.get(key.id!)
if(msg) {
updateMessageWithReaction(msg, reaction)
}
}
})
}
const toJSON = () => ({
chats,
contacts,
messages,
labels,
labelAssociations
})
const fromJSON = (json: {chats: Chat[], contacts: { [id: string]: Contact }, messages: { [id: string]: WAMessage[] }, labels: { [labelId: string]: Label }, labelAssociations: LabelAssociation[]}) => {
chats.upsert(...json.chats)
labelAssociations.upsert(...json.labelAssociations || [])
contactsUpsert(Object.values(json.contacts))
labelsUpsert(Object.values(json.labels || {}))
for(const jid in json.messages) {
const list = assertMessageList(jid)
for(const msg of json.messages[jid]) {
list.upsert(proto.WebMessageInfo.fromObject(msg), 'append')
}
}
}
return {
chats,
contacts,
messages,
groupMetadata,
state,
presences,
labels,
labelAssociations,
bind,
/** loads messages from the store, if not found -- uses the legacy connection */
loadMessages: async(jid: string, count: number, cursor: WAMessageCursor) => {
const list = assertMessageList(jid)
const mode = !cursor || 'before' in cursor ? 'before' : 'after'
const cursorKey = !!cursor ? ('before' in cursor ? cursor.before : cursor.after) : undefined
const cursorValue = cursorKey ? list.get(cursorKey.id!) : undefined
let messages: WAMessage[]
if(list && mode === 'before' && (!cursorKey || cursorValue)) {
if(cursorValue) {
const msgIdx = list.array.findIndex(m => m.key.id === cursorKey?.id)
messages = list.array.slice(0, msgIdx)
} else {
messages = list.array
}
const diff = count - messages.length
if(diff < 0) {
messages = messages.slice(-count) // get the last X messages
}
} else {
messages = []
}
return messages
},
/**
* Get all available labels for profile
*
* Keep in mind that the list is formed from predefined tags and tags
* that were "caught" during their editing.
*/
getLabels: () => {
return labels
},
/**
* Get labels for chat
*
* @returns Label IDs
**/
getChatLabels: (chatId: string) => {
return labelAssociations.filter((la) => la.chatId === chatId).all()
},
/**
* Get labels for message
*
* @returns Label IDs
**/
getMessageLabels: (messageId: string) => {
const associations = labelAssociations
.filter((la: MessageLabelAssociation) => la.messageId === messageId)
.all()
return associations.map(({ labelId }) => labelId)
},
loadMessage: async(jid: string, id: string) => messages[jid]?.get(id),
mostRecentMessage: async(jid: string) => {
const message: WAMessage | undefined = messages[jid]?.array.slice(-1)[0]
return message
},
fetchImageUrl: async(jid: string, sock: WASocket | undefined) => {
const contact = contacts[jid]
if(!contact) {
return sock?.profilePictureUrl(jid)
}
if(typeof contact.imgUrl === 'undefined') {
contact.imgUrl = await sock?.profilePictureUrl(jid)
}
return contact.imgUrl
},
fetchGroupMetadata: async(jid: string, sock: WASocket | undefined) => {
if(!groupMetadata[jid]) {
const metadata = await sock?.groupMetadata(jid)
if(metadata) {
groupMetadata[jid] = metadata
}
}
return groupMetadata[jid]
},
// fetchBroadcastListInfo: async(jid: string, sock: WASocket | undefined) => {
// if(!groupMetadata[jid]) {
// const metadata = await sock?.getBroadcastListInfo(jid)
// if(metadata) {
// groupMetadata[jid] = metadata
// }
// }
// return groupMetadata[jid]
// },
fetchMessageReceipts: async({ remoteJid, id }: WAMessageKey) => {
const list = messages[remoteJid!]
const msg = list?.get(id!)
return msg?.userReceipt
},
toJSON,
fromJSON,
writeToFile: (path: string) => {
// require fs here so that in case "fs" is not available -- the app does not crash
const { writeFileSync } = require('fs')
writeFileSync(path, JSON.stringify(toJSON()))
},
readFromFile: (path: string) => {
// require fs here so that in case "fs" is not available -- the app does not crash
const { readFileSync, existsSync } = require('fs')
if(existsSync(path)) {
logger.debug({ path }, 'reading from file')
const jsonStr = readFileSync(path, { encoding: 'utf-8' })
const json = JSON.parse(jsonStr)
fromJSON(json)
}
}
}
}

86
src/Store/make-ordered-dictionary.ts
View File

@@ -1,86 +0,0 @@
function makeOrderedDictionary<T>(idGetter: (item: T) => string) {
const array: T[] = []
const dict: { [_: string]: T } = { }
const get = (id: string): T | undefined => dict[id]
const update = (item: T) => {
const id = idGetter(item)
const idx = array.findIndex(i => idGetter(i) === id)
if(idx >= 0) {
array[idx] = item
dict[id] = item
}
return false
}
const upsert = (item: T, mode: 'append' | 'prepend') => {
const id = idGetter(item)
if(get(id)) {
update(item)
} else {
if(mode === 'append') {
array.push(item)
} else {
array.splice(0, 0, item)
}
dict[id] = item
}
}
const remove = (item: T) => {
const id = idGetter(item)
const idx = array.findIndex(i => idGetter(i) === id)
if(idx >= 0) {
array.splice(idx, 1)
delete dict[id]
return true
}
return false
}
return {
array,
get,
upsert,
update,
remove,
updateAssign: (id: string, update: Partial<T>) => {
const item = get(id)
if(item) {
Object.assign(item, update)
delete dict[id]
dict[idGetter(item)] = item
return true
}
return false
},
clear: () => {
array.splice(0, array.length)
for(const key of Object.keys(dict)) {
delete dict[key]
}
},
filter: (contain: (item: T) => boolean) => {
let i = 0
while(i < array.length) {
if(!contain(array[i])) {
delete dict[idGetter(array[i])]
array.splice(i, 1)
} else {
i += 1
}
}
},
toJSON: () => array,
fromJSON: (newItems: T[]) => {
array.splice(0, array.length, ...newItems)
}
}
}
export default makeOrderedDictionary

32
src/Store/object-repository.ts
View File

@@ -1,32 +0,0 @@
export class ObjectRepository<T extends object> {
readonly entityMap: Map<string, T>
constructor(entities: Record<string, T> = {}) {
this.entityMap = new Map(Object.entries(entities))
}
findById(id: string) {
return this.entityMap.get(id)
}
findAll() {
return Array.from(this.entityMap.values())
}
upsertById(id: string, entity: T) {
return this.entityMap.set(id, { ...entity })
}
deleteById(id: string) {
return this.entityMap.delete(id)
}
count() {
return this.entityMap.size
}
toJSON() {
return this.findAll()
}
}

1
src/Utils/generics.ts
View File

@@ -6,7 +6,6 @@ import { proto } from '../../WAProto'
import { version as baileysVersion } from '../Defaults/baileys-version.json'
import { BaileysEventEmitter, BaileysEventMap, BrowsersMap, ConnectionState, DisconnectReason, WACallUpdateType, WAVersion } from '../Types'
import { BinaryNode, getAllBinaryNodeChildren, jidDecode } from '../WABinary'
import { ILogger } from './logger'
const PLATFORM_MAP = {
'aix': 'AIX',