Bug Fix: QR Code Infinite Reconnection Loop #2365
Open
+11
−0
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
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdjusts Baileys WhatsApp connection handling to avoid reconnecting during the very first, unauthenticated connection so QR codes can be generated, while preserving existing reconnection behavior for authenticated/normal sessions. Sequence diagram for updated Baileys connection close handlingsequenceDiagram
participant BaileysSocket as BaileysSocket
participant BaileysStartupService as BaileysStartupService
participant WhatsappAPI as WhatsappAPI
BaileysSocket->>BaileysStartupService: connectionUpdate(connection close, lastDisconnect)
activate BaileysStartupService
BaileysStartupService->>BaileysStartupService: read lastDisconnect.error.statusCode
BaileysStartupService->>BaileysStartupService: compute isInitialConnection = !instance.wuid && instance.qrcode.count == 0
alt initial_unauthenticated_connection
BaileysStartupService->>BaileysStartupService: logger.info(Initial connection closed, waiting for QR code generation...)
BaileysStartupService-->>BaileysSocket: return (no reconnect)
else authenticated_or_qr_generated
BaileysStartupService->>BaileysStartupService: compute shouldReconnect based on statusCode
alt shouldReconnect
BaileysStartupService->>BaileysStartupService: logger.warn(Connection lost, reconnecting...)
BaileysStartupService->>WhatsappAPI: connectToWhatsapp(phoneNumber)
WhatsappAPI-->>BaileysStartupService: connection established or closed
else shouldNotReconnect
BaileysStartupService->>BaileysStartupService: sendDataWebhook(STATUS_INSTANCE, disconnected)
end
end
deactivate BaileysStartupService
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The
isInitialConnectioncheck assumesthis.instance.qrcodeis always defined; consider using optional chaining or a default (this.instance.qrcode?.count ?? 0) to avoid potential runtime errors ifqrcodeis undefined on some paths. - The new inline comments are in Portuguese while surrounding code and logs are in English; consider standardizing the comment language to match the rest of the file for consistency.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `isInitialConnection` check assumes `this.instance.qrcode` is always defined; consider using optional chaining or a default (`this.instance.qrcode?.count ?? 0`) to avoid potential runtime errors if `qrcode` is undefined on some paths.
- The new inline comments are in Portuguese while surrounding code and logs are in English; consider standardizing the comment language to match the rest of the file for consistency.
## Individual Comments
### Comment 1
<location> `src/api/integrations/channel/whatsapp/whatsapp.baileys.service.ts:441` </location>
<code_context>
+
const shouldReconnect = !codesToNotReconnect.includes(statusCode);
if (shouldReconnect) {
+ this.logger.warn(`Connection lost (status: ${statusCode}), reconnecting...`);
await this.connectToWhatsapp(this.phoneNumber);
} else {
</code_context>
<issue_to_address>
**suggestion:** Consider symmetric logging when opting not to reconnect
When `shouldReconnect` is false there’s no corresponding log explaining that reconnection is being skipped and why. Please add a log in the `else` branch (e.g. info/warn) that includes the `statusCode` and mentions that reconnect is skipped because it’s in `codesToNotReconnect`, to improve debugging and correlation with webhook events.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| const shouldReconnect = !codesToNotReconnect.includes(statusCode); | ||
| if (shouldReconnect) { | ||
| this.logger.warn(`Connection lost (status: ${statusCode}), reconnecting...`); |
Contributor
There was a problem hiding this comment.
suggestion: Consider symmetric logging when opting not to reconnect
When shouldReconnect is false there’s no corresponding log explaining that reconnection is being skipped and why. Please add a log in the else branch (e.g. info/warn) that includes the statusCode and mentions that reconnect is skipped because it’s in codesToNotReconnect, to improve debugging and correlation with webhook events.
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
This PR fixes the infinite reconnection loop that prevents QR code generation in Evolution API versions v2.1.0, v2.1.1, and v2.2.0.
Problem:
When attempting to generate a QR code for WhatsApp connection, the Baileys integration enters an infinite reconnection loop. The
connectionUpdateevent handler triggers reconnection immediately when the connection closes (which is normal during initial QR code generation), preventing the QR code from ever being generated and displayed.Root Cause:
The issue occurs in
whatsapp.baileys.service.tswhere the connection close event triggersshouldReconnectlogic before the initial QR code is generated. SincestatusCodeisundefinedduring the first connection attempt, the code incorrectly attempts to reconnect, creating an endless loop.Solution:
Added an
isInitialConnectioncheck that prevents reconnection attempts when:!this.instance.wuid)this.instance.qrcode.count === 0)This allows the first connection to close gracefully so the QR code can be generated and sent to the client.
Changes:
connectionUpdatemethod insrc/api/integrations/channel/whatsapp/whatsapp.baileys.service.ts(lines 421-440)🔗 Related Issue
Closes #2341
🧪 Type of Change
🧪 Testing
Test Results:
Testing Environment:
📸 Screenshots (if applicable)
Before Fix:
After Fix:
✅ Checklist
📝 Additional Notes
Impact: This is a critical bug fix that restores QR code generation functionality for new WhatsApp connections. Without this fix, users cannot establish new WhatsApp connections in affected versions.
Backward Compatibility: This fix is fully backward compatible. It only affects the initial connection flow and does not change behavior for already authenticated instances.
Code Changes Summary:
Versions Affected: v2.1.0, v2.1.1, v2.2.0
Fix Verified In: v2.3.7
Summary by Sourcery
Prevent infinite reconnection loops during initial WhatsApp QR code setup by adjusting Baileys connection handling.
Bug Fixes:
Enhancements: