fix(baileys): improve error logging for fetching latest WaWeb version #2360
+62
−5
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 GuideAdds error-aware logging after fetching the latest WhatsApp Web (Baileys) version so failures in the version fetch are surfaced without changing existing behavior when the fetch succeeds. Sequence diagram for Baileys version fetch and error loggingsequenceDiagram
participant BaileysStartupService
participant BaileysLibrary as BaileysLibrary
participant Logger
BaileysStartupService->>BaileysLibrary: fetchLatestWaWebVersion()
BaileysLibrary-->>BaileysStartupService: baileysVersion(version, error?)
BaileysStartupService->>Logger: info("Baileys version: " + version.join('.'))
alt error present on baileysVersion
BaileysStartupService->>Logger: error("Fetch latest WaWeb version error: " + error.message)
else no error
BaileysStartupService->>Logger: info("Group Ignore: " + localSettings.groupsIgnore)
end
BaileysStartupService->>Logger: info("Group Ignore: " + localSettings.groupsIgnore)
Flow diagram for Baileys WaWeb version error-aware loggingflowchart TD
A[Start BaileysStartupService startup] --> B[Call fetchLatestWaWebVersion]
B --> C[Receive baileysVersion with version and optional error]
C --> D[Log info Baileys version]
D --> E{baileysVersion.error is not null?}
E -- Yes --> F[Log error Fetch latest WaWeb version error with error.message]
E -- No --> G[Skip error logging]
F --> H[Log info Group Ignore settings]
G --> H[Log info Group Ignore settings]
H --> I[Continue startup process]
File-Level Changes
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 - I've found 1 issue, and left some high level feedback:
- Consider handling cases where
baileysVersion?.erroris not anErrorinstance (e.g., string or unknown) by safely stringifying it or using a type guard, instead of assuming.messageexists. - If your logger supports structured logging, it may be more useful to pass the full
errorobject (and possibly the requested version/URL) as metadata rather than only loggingerror.messagein the string.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider handling cases where `baileysVersion?.error` is not an `Error` instance (e.g., string or unknown) by safely stringifying it or using a type guard, instead of assuming `.message` exists.
- If your logger supports structured logging, it may be more useful to pass the full `error` object (and possibly the requested version/URL) as metadata rather than only logging `error.message` in the string.
## Individual Comments
### Comment 1
<location> `src/api/integrations/channel/whatsapp/whatsapp.baileys.service.ts:649-651` </location>
<code_context>
const log = `Baileys version: ${version.join('.')}`;
this.logger.info(log);
+ const error = baileysVersion?.error ?? null;
+ if (error) {
+ this.logger.error(`Fetch latest WaWeb version error: ${error.message}`);
+ }
+
</code_context>
<issue_to_address>
**suggestion:** Log the error object (and/or stack) in addition to the message for better diagnostics.
Currently only `error.message` is logged, which loses useful context (e.g. stack trace or custom fields on non-standard error objects). Instead, log the full error object and/or stack, e.g.:
```ts
const error = baileysVersion?.error;
if (error) {
this.logger.error('Fetch latest WaWeb version error', { error });
}
```
so failures in fetching the latest WaWeb version are easier to diagnose.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
src/api/integrations/channel/whatsapp/whatsapp.baileys.service.ts
Outdated
Show resolved
Hide resolved
…etching latest WaWeb version
- Added caching mechanism to store and retrieve the latest WhatsApp Web version - Enhanced error handling to utilize cached fallback versions when fetching fails - Updated the fetchLatestWaWebVersion function to accept a cache service as an optional parameter
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 implements two improvements to the WhatsApp Web version fetching mechanism:
1. Caching Mechanism
Added caching functionality to
fetchLatestWaWebVersionto reduce unnecessary HTTP requests tohttps://web.whatsapp.com/sw.js. The implementation:CacheServiceparameter for dependency injection, maintaining backward compatibilityCacheServicewithCacheEngine)2. Error Logging
Added error logging for WhatsApp Web version fetch operations to improve debugging capabilities. When the request fails (e.g., due to network issues, rate limiting, or API changes), the error is now logged with detailed information. This helps identify when Baileys might be using an outdated version due to fetch failures.
Benefits:
fetchLatestBaileysVersion()when the WhatsApp Web domain is blocked🔗 Related Issue
🧪 Type of Change
🧪 Testing
Test Scenarios:
📸 Screenshots (if applicable)
Example log output when error occurs:
✅ Checklist
📝 Additional Notes
Implementation Details
Cache Keys:
whatsapp_web_version: Stores the successfully fetched WhatsApp Web versionbaileys_fallback_version: Stores the Baileys fallback version when HTTP request failsCache Configuration:
whatsapp-version(uses project's cache infrastructure)Code Changes:
src/utils/fetchLatestWaWebVersion.ts: Added caching logic and error loggingsrc/api/integrations/channel/whatsapp/whatsapp.baileys.service.ts: Updated to passcacheto the functionKnown Issues
Note: The TypeScript compilation errors shown in the build are pre-existing issues in the codebase and are not related to this PR. The modified files (
fetchLatestWaWebVersion.tsand the single line change inwhatsapp.baileys.service.ts) have no TypeScript errors.The errors are in:
whatsapp.business.service.ts(1 error)whatsapp.baileys.service.ts(15 errors - unrelated to this change)chatwoot.service.ts(4 errors)channel.service.ts(8 errors)onWhatsappCache.ts(2 errors)These should be addressed in separate PRs.