mirror of
https://github.com/chatwoot/chatwoot.git
synced 2026-06-04 21:02:35 +08:00
Adds the server-side flow that turns Meta WhatsApp Cloud Calling webhooks into Chatwoot Calls, conversations, voice_call message bubbles, and ActionCable broadcasts. Stacked on top of #14312 (PR-2 — provider methods); intentionally does not include the HTTP controller, routes, or frontend (those land in PR-4 and PR-9). ## Closes - Part of the WhatsApp Cloud Calling rollout. Linear: TBD ## What changed **Webhook routing** - `app/jobs/webhooks/whatsapp_events_job.rb` — append `prepend_mod_with('Webhooks::WhatsappEventsJob')` so EE can extend it without forking. - `enterprise/app/jobs/enterprise/webhooks/whatsapp_events_job.rb` (new) — overlay that prepends `handle_message_events` to intercept `field: 'calls'` payloads (route to `Whatsapp::IncomingCallService`) and `interactive.call_permission_reply` messages (route to `Whatsapp::CallPermissionReplyService`); falls through with `super` for regular messages. **Services** - `enterprise/app/services/whatsapp/incoming_call_service.rb` (new) — gated on `provider_config['calling_enabled']`; processes `connect` (creates inbound call via `Voice::InboundCallBuilder` or transitions an existing outbound call to `in_progress`) and `terminate` events; updates conversation `additional_attributes` and broadcasts `voice_call.incoming`/`voice_call.outbound_connected`/`voice_call.ended`. - `enterprise/app/services/whatsapp/call_permission_reply_service.rb` (new) — handles WhatsApp interactive `call_permission_reply` replies; clears the conversation's `call_permission_requested_at` flag and broadcasts `voice_call.permission_granted` so the agent UI can re-enable the call button. **Builder/model adjustments** - `enterprise/app/services/voice/inbound_call_builder.rb` — provider-agnostic; accepts `provider:` and `extra_meta:` kwargs, drops `account:` (now derived from `inbox.account` to keep the param count under rubocop's ceiling without disabling cops), uses digits-only `source_id` for WhatsApp ContactInbox (validation requires `^\d{1,15}\z`), skips Twilio-only `conference_sid` for non-Twilio providers. - `enterprise/app/services/voice/call_message_builder.rb` — adds `create!`/`update_status!` API and `CALL_TO_VOICE_STATUS` map; uses direct `Message.create!` (bypasses `Messages::MessageBuilder`'s incoming-on-non-Api-inbox guard, which would otherwise reject the system bubble); content is `'WhatsApp Call'` for WhatsApp and `'Voice Call'` for Twilio. Backwards-compatible `perform!` retained for the existing Twilio call sites. - `enterprise/app/models/call.rb` — adds `default_ice_servers` (driven by `VOICE_CALL_STUN_URLS` env), `direction_label` alias for the `inbound`/`outbound` strings the FE expects, and `ringing?`/`in_progress?`/`terminal?` predicates used throughout the pipeline. **Outgoing-channel guard** - `app/services/base/send_on_channel_service.rb` — extends `invalid_message?` to skip messages with `content_type == 'voice_call'`. Without this, agent-initiated outbound calls (PR-4) would deliver \"WhatsApp Call\" as a text message to the contact every time. **Twilio call-site update** - `enterprise/app/controllers/twilio/voice_controller.rb` — drops the now-redundant `account: current_account` kwarg from the `Voice::InboundCallBuilder.perform!` call. **Tests** - New: `spec/enterprise/services/whatsapp/incoming_call_service_spec.rb` (5 examples — calling-disabled, inbound connect, outbound connect, terminate completed, terminate no-answer, unknown event). - New: `spec/enterprise/services/whatsapp/call_permission_reply_service_spec.rb` (3 examples — accept, reject, calling-disabled). - Updated: `spec/enterprise/services/voice/inbound_call_builder_spec.rb` and `spec/enterprise/controllers/twilio/voice_controller_spec.rb` to drop the `account:` kwarg from call expectations. ## How to test In `rails console` against an account with a WhatsApp inbox where `provider_config['calling_enabled']` is true: ```ruby inbox = Inbox.find(<id>) params = { calls: [{ id: 'wacid_test', from: '15550001111', event: 'connect', session: { sdp: 'v=0...', sdp_type: 'offer' } }] } Whatsapp::IncomingCallService.new(inbox: inbox, params: params).perform # => Conversation + Call (status: 'ringing', provider: 'whatsapp') + voice_call message bubble # => ActionCable broadcasts `voice_call.incoming` to the assignee or account-wide # Then terminate it: Whatsapp::IncomingCallService.new(inbox: inbox, params: { calls: [{ id: 'wacid_test', event: 'terminate', duration: 0, terminate_reason: 'no_answer' }] } ).perform # => Call status flips to 'no_answer', message bubble updates, `voice_call.ended` broadcast fires ``` End-to-end browser flow (Meta → cable → UI) requires the controller from PR-4 and the frontend from PR-9. --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
133 lines
5.4 KiB
Ruby
133 lines
5.4 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe Telegram::SendAttachmentsService do
|
|
describe '#perform' do
|
|
let(:channel) { create(:channel_telegram) }
|
|
let(:message) { build(:message, conversation: create(:conversation, inbox: channel.inbox)) }
|
|
let(:service) { described_class.new(message: message) }
|
|
let(:telegram_api_url) { channel.telegram_api_url }
|
|
|
|
before do
|
|
allow(channel).to receive(:chat_id).and_return('chat123')
|
|
|
|
stub_request(:post, "#{telegram_api_url}/sendMediaGroup")
|
|
.to_return(status: 200, body: { ok: true, result: [{ message_id: 'media' }] }.to_json, headers: { 'Content-Type' => 'application/json' })
|
|
|
|
stub_request(:post, "#{telegram_api_url}/sendDocument")
|
|
.to_return(status: 200, body: { ok: true, result: { message_id: 'document' } }.to_json, headers: { 'Content-Type' => 'application/json' })
|
|
end
|
|
|
|
it 'sends all types of attachments in seperate groups and returns the last successful message ID from the batch' do
|
|
attach_files(message)
|
|
result = service.perform
|
|
expect(result).to eq('document')
|
|
# videos and images are sent in a media group
|
|
# audio is sent in another group
|
|
expect(a_request(:post, "#{telegram_api_url}/sendMediaGroup")).to have_been_made.times(2)
|
|
expect(a_request(:post, "#{telegram_api_url}/sendDocument")).to have_been_made.once
|
|
end
|
|
|
|
context 'when all attachments are documents' do
|
|
before do
|
|
2.times { attach_file_to_message(message, 'file', 'sample.pdf', 'application/pdf') }
|
|
message.save!
|
|
end
|
|
|
|
it 'sends documents individually and returns the message ID of the first successful document' do
|
|
result = service.perform
|
|
expect(result).to eq('document')
|
|
expect(a_request(:post, "#{telegram_api_url}/sendDocument")).to have_been_made.times(2)
|
|
end
|
|
end
|
|
|
|
context 'when this is business chat' do
|
|
before do
|
|
message.conversation.update!(additional_attributes: { 'business_connection_id' => 'eooW3KF5WB5HxTD7T826' })
|
|
end
|
|
|
|
it 'sends all types of attachments in seperate groups and returns the last successful message ID from the batch' do
|
|
attach_files(message)
|
|
service.perform
|
|
expect(a_request(:post, "#{telegram_api_url}/sendMediaGroup")
|
|
.with { |req| req.body =~ /business_connection_id.+eooW3KF5WB5HxTD7T826/m })
|
|
.to have_been_made.times(2)
|
|
|
|
expect(a_request(:post, "#{telegram_api_url}/sendDocument")
|
|
.with { |req| req.body =~ /business_connection_id.+eooW3KF5WB5HxTD7T826/m })
|
|
.to have_been_made.once
|
|
end
|
|
end
|
|
|
|
context 'when all attachments are photo and video' do
|
|
before do
|
|
2.times { attach_file_to_message(message, 'image', 'sample.png', 'image/png') }
|
|
attach_file_to_message(message, 'video', 'sample.mp4', 'video/mp4')
|
|
message.save!
|
|
end
|
|
|
|
it 'sends in a single media group and returns the message ID' do
|
|
result = service.perform
|
|
expect(result).to eq('media')
|
|
expect(a_request(:post, "#{telegram_api_url}/sendMediaGroup")).to have_been_made.once
|
|
end
|
|
end
|
|
|
|
context 'when all attachments are audio' do
|
|
before do
|
|
2.times { attach_file_to_message(message, 'audio', 'sample.mp3', 'audio/mpeg') }
|
|
message.save!
|
|
end
|
|
|
|
it 'sends audio messages in single media group and returns the message ID' do
|
|
result = service.perform
|
|
expect(result).to eq('media')
|
|
expect(a_request(:post, "#{telegram_api_url}/sendMediaGroup")).to have_been_made.once
|
|
end
|
|
end
|
|
|
|
context 'when all attachments are photos, videos, and audio' do
|
|
before do
|
|
attach_file_to_message(message, 'image', 'sample.png', 'image/png')
|
|
attach_file_to_message(message, 'video', 'sample.mp4', 'video/mp4')
|
|
attach_file_to_message(message, 'audio', 'sample.mp3', 'audio/mpeg')
|
|
message.save!
|
|
end
|
|
|
|
it 'sends photos and videos in a media group and audio in a separate group' do
|
|
result = service.perform
|
|
expect(result).to eq('media')
|
|
expect(a_request(:post, "#{telegram_api_url}/sendMediaGroup")).to have_been_made.times(2)
|
|
end
|
|
end
|
|
|
|
context 'when an attachment fails to send' do
|
|
before do
|
|
stub_request(:post, "#{telegram_api_url}/sendDocument")
|
|
.to_return(status: 500, body: { ok: false,
|
|
description: 'Internal server error' }.to_json, headers: { 'Content-Type' => 'application/json' })
|
|
end
|
|
|
|
it 'logs an error, stops processing, and returns nil' do
|
|
attach_files(message)
|
|
expect(Rails.logger).to receive(:error).at_least(:once)
|
|
result = service.perform
|
|
expect(result).to be_nil
|
|
expect(a_request(:post, "#{telegram_api_url}/sendDocument")).to have_been_made.once
|
|
end
|
|
end
|
|
|
|
def attach_files(message)
|
|
attach_file_to_message(message, 'file', 'sample.pdf', 'application/pdf')
|
|
attach_file_to_message(message, 'image', 'sample.png', 'image/png')
|
|
attach_file_to_message(message, 'video', 'sample.mp4', 'video/mp4')
|
|
attach_file_to_message(message, 'audio', 'sample.mp3', 'audio/mpeg')
|
|
message.save!
|
|
end
|
|
|
|
def attach_file_to_message(message, type, filename, content_type)
|
|
attachment = message.attachments.new(account_id: message.account_id, file_type: type)
|
|
attachment.file.attach(io: Rails.root.join("spec/assets/#{filename}").open, filename: filename, content_type: content_type)
|
|
end
|
|
end
|
|
end
|