fix(baileys): prevent message loss from WhatsApp stub placeholders #2259
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mensagens do WhatsApp estavam sendo perdidas e não eram salvas no banco de dados, especialmente mensagens de canais/newsletters (@lid) e mensagens com criptografia complexa. O WhatsApp/Baileys envia mensagens criptografadas em duas etapas: 1. Primeiro: Envia um stub (placeholder) com messageStubParameters: ['Message absent from node'] enquanto descriptografa a mensagem 2. Depois: Envia a mensagem real com o conteúdo descriptografado O problema ocorria porque: - O stub chegava primeiro e era adicionado ao cache de mensagens duplicadas - O stub era descartado (corretamente) por não ter conteúdo (!received?.message) - A mensagem real chegava depois, mas era ignorada como duplicata porque o ID já estava no cache - Resultado: mensagem nunca era salva no banco de dados Solução: - Detectar stubs do WhatsApp através de messageStubParameters contendo 'Message absent from node' - Não adicionar stubs ao cache de mensagens duplicadas - Permitir que a mensagem real seja processada quando chegar - Manter o descarte do stub para evitar salvar placeholders vazios
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideExtends the WhatsApp Baileys decryption error-handling logic to recognize Baileys placeholder stub messages ("Message absent from node") so they are treated as transient decryption issues and not added to the duplicate-message cache, preventing loss of the subsequent real message. Sequence diagram for WhatsApp stub placeholder handling in BaileyssequenceDiagram
participant WhatsAppServer
participant BaileysLibrary
participant BaileysStartupService
participant DuplicateMessageCache
participant Database
rect rgb(235, 245, 255)
Note over WhatsAppServer,BaileysStartupService: Stub placeholder message (Message absent from node)
WhatsAppServer->>BaileysLibrary: sendEncryptedStubMessage
BaileysLibrary->>BaileysStartupService: onMessage(stubWithMessageStubParameters)
BaileysStartupService->>BaileysStartupService: detectStub(messageStubParameters contains Message_absent_from_node)
BaileysStartupService-->>DuplicateMessageCache: doNotAddStubToCache
BaileysStartupService-->>Database: doNotPersistStub
end
rect rgb(235, 255, 235)
Note over WhatsAppServer,BaileysStartupService: Real decrypted message arrives later with same message ID
WhatsAppServer->>BaileysLibrary: sendDecryptedMessage
BaileysLibrary->>BaileysStartupService: onMessage(realMessage)
BaileysStartupService->>DuplicateMessageCache: isDuplicate(messageId)?
DuplicateMessageCache-->>BaileysStartupService: notFound
BaileysStartupService->>Database: saveMessage(realMessage)
BaileysStartupService->>DuplicateMessageCache: addMessageIdToCache
end
Class diagram for updated BaileysStartupService decryption error handlingclassDiagram
class ChannelStartupService {
}
class BaileysStartupService {
- duplicateMessageCache
+ handleIncomingMessage(rawMessage)
+ isDecryptionStub(messageStubParameters) bool
+ shouldSkipDuplicateCache(messageStubParameters) bool
}
class DuplicateMessageCache {
+ has(messageId) bool
+ add(messageId)
}
class IncomingMessage {
+ id
+ message
+ messageStubParameters
}
ChannelStartupService <|-- BaileysStartupService
BaileysStartupService --> DuplicateMessageCache
BaileysStartupService --> IncomingMessage
%% Highlight of logic change
BaileysStartupService : isDecryptionStub(messageStubParameters) checks for
BaileysStartupService : 'Invalid PreKey ID'
BaileysStartupService : 'No session record'
BaileysStartupService : 'No session found to decrypt message'
BaileysStartupService : 'Message absent from node' %% newly added
BaileysStartupService : if isDecryptionStub then
BaileysStartupService : skip adding to duplicateMessageCache
BaileysStartupService : do not persist placeholder message
BaileysStartupService : else
BaileysStartupService : normal duplicate check and persistence flow
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Since this list of Baileys/WhatsApp stub error substrings is growing, consider extracting it to a named constant (e.g.,
WHATSAPP_STUB_MESSAGE_ERRORS) with a short comment explaining the semantics, to make future additions and maintenance clearer. - If Baileys or WhatsApp ever localize or slightly change these stub messages, the current
includes-based matching on fixed English strings may fail silently; it might be worth centralizing this logic with tests or adding a brief note about the dependency on these exact message texts.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Since this list of Baileys/WhatsApp stub error substrings is growing, consider extracting it to a named constant (e.g., `WHATSAPP_STUB_MESSAGE_ERRORS`) with a short comment explaining the semantics, to make future additions and maintenance clearer.
- If Baileys or WhatsApp ever localize or slightly change these stub messages, the current `includes`-based matching on fixed English strings may fail silently; it might be worth centralizing this logic with tests or adding a brief note about the dependency on these exact message texts.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📋 Description
Corrige perda de mensagens do WhatsApp que não eram salvas no banco de dados, especialmente mensagens de canais/newsletters (
@lid) e mensagens com criptografia complexa.🔍 Causa Raiz
O WhatsApp/Baileys envia mensagens criptografadas em duas etapas:
messageStubParameters: ['Message absent from node']enquanto descriptografa a mensagemO problema ocorria porque:
!received?.message)✅ Solução Implementada
messageStubParameterscontendo'Message absent from node'🔗 Related Issue
🧪 Type of Change
🧪 Testing
Cenários Testados:
@lid)✅ Checklist
📝 Additional Notes
O que é "Message absent from node"?
É um placeholder/stub que o WhatsApp envia quando:
Impacto da Mudança
Summary by Sourcery
Bug Fixes: