feat: implement disable/enable linkPreview support for Evolution Bot #1908
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
- Add linkPreview extraction from webhook/n8n response
- Implement linkPreview parameter in textMessage calls
- Add debug logging for linkPreview functionality
- Support for disabling link previews when linkPreview: false
- Add comprehensive documentation for linkPreview feature
Usage:
- Return { "message": "text", "linkPreview": false } from webhook to disable preview
- Return { "message": "text", "linkPreview": true } from webhook to enable preview
- Omit linkPreview for default WhatsApp behavior
- Remove evolution-bot-documentation.md - Remove evolution-bot-linkpreview-example.md - Remove send-text-api-documentation.md - Keep only the core linkPreview implementation
Contributor
Reviewer's GuideThis PR enriches the Evolution Bot integration by extracting and honoring a linkPreview flag from webhook responses, replacing the legacy sendMessageWhatsApp call with a direct textMessage invocation that includes link preview control, and adding extensive debug logging while preserving backward compatibility. 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 there - I've reviewed your changes - here's some feedback:
- Consider defaulting linkPreview to true when the webhook doesn’t specify it so you don’t pass undefined to textMessage and preserve backward compatibility.
- The large number of debug logs can clutter output and may expose sensitive data—consider consolidating related logs into structured entries and sanitizing payloads before logging.
- Validate that linkPreview is actually a boolean before passing it to textMessage, and fall back to a safe default if it isn’t.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider defaulting linkPreview to true when the webhook doesn’t specify it so you don’t pass undefined to textMessage and preserve backward compatibility.
- The large number of debug logs can clutter output and may expose sensitive data—consider consolidating related logs into structured entries and sanitizing payloads before logging.
- Validate that linkPreview is actually a boolean before passing it to textMessage, and fall back to a safe default if it isn’t.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
dersonbsb2022
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR implements link preview control functionality for Evolution Bot webhooks, allowing dynamic control over whether link previews are displayed in WhatsApp messages through webhook responses.
- Adds extraction of
linkPreviewparameter from webhook responses - Replaces the base class
sendMessageWhatsAppmethod with directtextMessagecalls to support linkPreview - Introduces comprehensive debug logging for webhook requests and responses
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| number: remoteJid.split('@')[0], | ||
| delay: settings?.delayMessage || 1000, | ||
| text: message, | ||
| linkPreview: linkPreview, // Use linkPreview from n8n response |
There was a problem hiding this comment.
The property assignment uses redundant syntax. Use shorthand property notation: linkPreview, instead of linkPreview: linkPreview,
Suggested change
| linkPreview: linkPreview, // Use linkPreview from n8n response | |
| linkPreview, // Use linkPreview from n8n response |
| } | ||
|
|
||
| let message = response?.data?.message; | ||
| const linkPreview = response?.data?.linkPreview; // Extract linkPreview from n8n response |
There was a problem hiding this comment.
The comment incorrectly refers to 'n8n response' but this is a generic webhook response that could come from any webhook endpoint, not specifically n8n. Update the comment to be more generic: // Extract linkPreview from webhook response
Suggested change
| const linkPreview = response?.data?.linkPreview; // Extract linkPreview from n8n response | |
| const linkPreview = response?.data?.linkPreview; // Extract linkPreview from webhook response |
- Default linkPreview to true when not specified for backward compatibility - Validate linkPreview is boolean before passing to textMessage - Consolidate debug logs and remove sensitive data from logging - Sanitize API keys in debug output ([REDACTED]) - Reduce log verbosity while maintaining debugging capability - Ensure robust fallback behavior for malformed responses Addresses PR feedback regarding: - Backward compatibility preservation - Security considerations in logging - Input validation and error handling
- Remove unnecessary trailing whitespace - Use shorthand property syntax for linkPreview parameter - Apply ESLint formatting standards - Maintain code consistency and readability
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
📋 Summary
This PR implements linkPreview support for Evolution Bot integration, allowing webhooks/n8n workflows to control whether link previews are displayed in WhatsApp messages.
✨ What's New
linkPreview: falseto disable link previews{ "message": "text", "linkPreview": boolean }response format🔧 Implementation Details
src/api/integrations/chatbot/evolutionBot/services/evolutionBot.service.tslinkPreviewfrom webhook response and pass totextMessagelinkPreview: falsefrom webhook to disable link previews in WhatsApp📖 Usage Example
Webhook Response:
{ "message": "Check this link: https://example.com", "linkPreview": false } ## Summary by Sourcery Implement link preview support in the Evolution Bot integration to allow webhooks or n8n workflows to dynamically enable or disable link previews in WhatsApp messages, while adding comprehensive debug logging and maintaining backward compatibility. New Features: - Allow webhook responses to include a linkPreview flag to control whether link previews are displayed in WhatsApp messages Enhancements: - Add detailed debug logs around HTTP requests, responses, message cleanup, and message sending - Refactor message dispatch to use textMessage with the linkPreview option instead of the base sendMessageWhatsApp method