fix: baileys send message with jid #32

CayoPOliveira · 2025-04-27T04:50:56Z

…hanges

Pull Request Template

Description

Please include a summary of the change and issue(s) fixed. Also, mention relevant motivation, context, and any dependencies that this change requires.
Fixes # (issue)

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality not to work as expected)
This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented on my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

This change is

Summary by CodeRabbit

Refactor
- Streamlined WhatsApp message sending by unifying attachment and text handling into a single process.
- Enhanced unsupported message detection, preventing their sending and clearly marking them.
- Updated message sending to use a new recipient format for improved delivery.
Tests
- Updated tests to align with the unified message sending approach and improved unsupported message handling.
- Modified test cases to use the new WhatsApp recipient format.

…anges

coderabbitai · 2025-04-27T04:51:02Z

Walkthrough

This update refactors the message sending logic in the WhatsappBaileysService by consolidating separate methods for sending text and attachment messages into a unified approach. The new implementation prepares the message content based on whether it contains text or attachments and sends it through a single request method. Unsupported messages are now flagged by updating their content attributes and status instead of returning early without content. Corresponding tests have been updated to reflect these changes, including the handling of unsupported messages and the use of WhatsApp JID formatting in API requests.

Changes

File(s)	Change Summary
`app/services/whatsapp/providers/whatsapp_baileys_service.rb`	Refactored message sending logic to use a unified method for both text and attachments, removed `send_attachment_message` and `send_text_message`, added new methods for preparing attachment content, sending the message request, and formatting the contact JID. Unsupported messages are now flagged by setting content attributes and status to `failed`. The API request field `recipient` was replaced by `jid` formatted as `<phone_number>@s.whatsapp.net`.
`spec/services/whatsapp/providers/whatsapp_baileys_service_spec.rb`	Updated tests to match the new unified message sending logic, added tests for unsupported messages setting content and status, removed old unsupported message tests, and updated HTTP request stubs to use the `jid` field with WhatsApp JID formatting consistently across all scenarios, including error cases.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WhatsappBaileysService
    participant HTTParty

    User->>WhatsappBaileysService: send_message(phone_number, message)
    alt message has attachments
        WhatsappBaileysService->>WhatsappBaileysService: attachment_message_content(message)
        WhatsappBaileysService->>WhatsappBaileysService: contact_jid(phone_number)
        WhatsappBaileysService->>HTTParty: send_message_request(jid, attachment_content)
    else message has text
        WhatsappBaileysService->>WhatsappBaileysService: contact_jid(phone_number)
        WhatsappBaileysService->>HTTParty: send_message_request(jid, text_content)
    else unsupported message
        WhatsappBaileysService->>WhatsappBaileysService: set content_attributes['is_unsupported'] = true
        WhatsappBaileysService->>WhatsappBaileysService: update status to failed
        WhatsappBaileysService-->>User: return nil
    end
    HTTParty-->>WhatsappBaileysService: response
    WhatsappBaileysService-->>User: message_id or error

Possibly related PRs

feat: baileys unsupported message alert #27: Adds explicit unsupported message handling and status updates in WhatsappBaileysService, overlapping with the main PR’s unsupported message logic changes.
chore: change baileys contact name preferences #30: Modifies WhatsappBaileysService by splitting sending logic into separate methods and adding error classes, related to the main PR’s refactor of message sending.
feat: baileys support to send attachments #28: Introduces separate methods for sending attachments and text messages, differing from the main PR’s consolidation but modifying the same service and functionality.

Suggested labels

bug

Suggested reviewers

gabrieljablonski

Poem

In the warren of code, a new path we send,
Messages unified, old branches now end.
Attachments or text, all hop in one flow,
Unsupported ones flagged, so everyone knows.
With JIDs in our paws and requests sent with cheer,
This bunny says, "Great work—let's ship it this year!" 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 RuboCop (1.73)

app/services/whatsapp/providers/whatsapp_baileys_service.rb

Error: RSpec/FactoryBot/* has been extracted to the rubocop-factory_bot gem.
(obsolete configuration found in .rubocop.yml, please update it)

spec/services/whatsapp/providers/whatsapp_baileys_service_spec.rb

Error: RSpec/FactoryBot/* has been extracted to the rubocop-factory_bot gem.
(obsolete configuration found in .rubocop.yml, please update it)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d982fb5 and 5f17f91.

📒 Files selected for processing (2)

app/services/whatsapp/providers/whatsapp_baileys_service.rb (3 hunks)
spec/services/whatsapp/providers/whatsapp_baileys_service_spec.rb (5 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

spec/services/whatsapp/providers/whatsapp_baileys_service_spec.rb
app/services/whatsapp/providers/whatsapp_baileys_service.rb

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

…update message status

gabrieljablonski

Reviewed 1 of 2 files at r1, 1 of 1 files at r2, 2 of 2 files at r3, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @CayoPOliveira)

fix: update send_message method to handle baileys-api send-message ch…

bb2b97f

…anges

CayoPOliveira added enhancement New feature or request review needed labels Apr 27, 2025

CayoPOliveira requested review from gabrieljablonski and Copilot April 27, 2025 04:50

CayoPOliveira self-assigned this Apr 27, 2025

Copilot AI reviewed Apr 27, 2025

View reviewed changes

CayoPOliveira and others added 2 commits April 27, 2025 02:11

chore: simplify update of is_unsupported

681ab84

refactor: remove useless helper

70baa65

gabrieljablonski approved these changes Apr 28, 2025

View reviewed changes

gabrieljablonski added approved for merge and removed review needed labels Apr 28, 2025

CayoPOliveira added 2 commits April 29, 2025 20:39

fix: update send_message method to handle unsupported message content

d982fb5

chore: handle unsupported message content in send_message method and …

5f17f91

…update message status

gabrieljablonski approved these changes Apr 29, 2025

View reviewed changes

CayoPOliveira merged commit 8dc893d into fazer-ai/main Apr 29, 2025
2 checks passed

CayoPOliveira deleted the fix/baileys-api-send-message-jid branch April 29, 2025 23:52

This was referenced Apr 29, 2025

feat: baileys messages reactions #33

Merged

feat: mark recorded audio messages #36

Merged

coderabbitai bot mentioned this pull request May 8, 2025

feat: mark message as read #43

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: baileys send message with jid #32

fix: baileys send message with jid #32

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

fix: baileys send message with jid #32

fix: baileys send message with jid #32

Conversation

Pull Request Template

Description

Type of change

How Has This Been Tested?

Checklist:

Summary by CodeRabbit

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CodeRabbit Configuration File (`.coderabbit.yaml`)