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>
275 lines
9.9 KiB
Ruby
275 lines
9.9 KiB
Ruby
require 'rails_helper'
|
|
|
|
describe Whatsapp::FacebookApiClient do
|
|
let(:access_token) { 'test_access_token' }
|
|
let(:api_client) { described_class.new(access_token) }
|
|
let(:api_version) { 'v22.0' }
|
|
let(:app_id) { 'test_app_id' }
|
|
let(:app_secret) { 'test_app_secret' }
|
|
|
|
before do
|
|
allow(GlobalConfigService).to receive(:load).with('WHATSAPP_API_VERSION', 'v22.0').and_return(api_version)
|
|
allow(GlobalConfigService).to receive(:load).with('WHATSAPP_APP_ID', '').and_return(app_id)
|
|
allow(GlobalConfigService).to receive(:load).with('WHATSAPP_APP_SECRET', '').and_return(app_secret)
|
|
end
|
|
|
|
describe '#exchange_code_for_token' do
|
|
let(:code) { 'test_code' }
|
|
|
|
context 'when successful' do
|
|
before do
|
|
stub_request(:get, "https://graph.facebook.com/#{api_version}/oauth/access_token")
|
|
.with(query: { client_id: app_id, client_secret: app_secret, code: code })
|
|
.to_return(
|
|
status: 200,
|
|
body: { access_token: 'new_token' }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'returns the response data' do
|
|
result = api_client.exchange_code_for_token(code)
|
|
expect(result['access_token']).to eq('new_token')
|
|
end
|
|
end
|
|
|
|
context 'when failed' do
|
|
before do
|
|
stub_request(:get, "https://graph.facebook.com/#{api_version}/oauth/access_token")
|
|
.with(query: { client_id: app_id, client_secret: app_secret, code: code })
|
|
.to_return(status: 400, body: { error: 'Invalid code' }.to_json)
|
|
end
|
|
|
|
it 'raises an error' do
|
|
expect { api_client.exchange_code_for_token(code) }.to raise_error(/Token exchange failed/)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#fetch_phone_numbers' do
|
|
let(:waba_id) { 'test_waba_id' }
|
|
|
|
context 'when successful' do
|
|
before do
|
|
stub_request(:get, "https://graph.facebook.com/#{api_version}/#{waba_id}/phone_numbers")
|
|
.with(query: { access_token: access_token })
|
|
.to_return(
|
|
status: 200,
|
|
body: { data: [{ id: '123', display_phone_number: '1234567890' }] }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'returns the phone numbers data' do
|
|
result = api_client.fetch_phone_numbers(waba_id)
|
|
expect(result['data']).to be_an(Array)
|
|
expect(result['data'].first['id']).to eq('123')
|
|
end
|
|
end
|
|
|
|
context 'when failed' do
|
|
before do
|
|
stub_request(:get, "https://graph.facebook.com/#{api_version}/#{waba_id}/phone_numbers")
|
|
.with(query: { access_token: access_token })
|
|
.to_return(status: 403, body: { error: 'Access denied' }.to_json)
|
|
end
|
|
|
|
it 'raises an error' do
|
|
expect { api_client.fetch_phone_numbers(waba_id) }.to raise_error(/WABA phone numbers fetch failed/)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#debug_token' do
|
|
let(:input_token) { 'test_input_token' }
|
|
let(:app_access_token) { "#{app_id}|#{app_secret}" }
|
|
|
|
context 'when successful' do
|
|
before do
|
|
stub_request(:get, "https://graph.facebook.com/#{api_version}/debug_token")
|
|
.with(query: { input_token: input_token, access_token: app_access_token })
|
|
.to_return(
|
|
status: 200,
|
|
body: { data: { app_id: app_id, is_valid: true } }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'returns the debug token data' do
|
|
result = api_client.debug_token(input_token)
|
|
expect(result['data']['is_valid']).to be(true)
|
|
end
|
|
end
|
|
|
|
context 'when failed' do
|
|
before do
|
|
stub_request(:get, "https://graph.facebook.com/#{api_version}/debug_token")
|
|
.with(query: { input_token: input_token, access_token: app_access_token })
|
|
.to_return(status: 400, body: { error: 'Invalid token' }.to_json)
|
|
end
|
|
|
|
it 'raises an error' do
|
|
expect { api_client.debug_token(input_token) }.to raise_error(/Token validation failed/)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#register_phone_number' do
|
|
let(:phone_number_id) { 'test_phone_id' }
|
|
let(:pin) { '123456' }
|
|
|
|
context 'when successful' do
|
|
before do
|
|
stub_request(:post, "https://graph.facebook.com/#{api_version}/#{phone_number_id}/register")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' },
|
|
body: { messaging_product: 'whatsapp', pin: pin }.to_json
|
|
)
|
|
.to_return(
|
|
status: 200,
|
|
body: { success: true }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'returns success response' do
|
|
result = api_client.register_phone_number(phone_number_id, pin)
|
|
expect(result['success']).to be(true)
|
|
end
|
|
end
|
|
|
|
context 'when failed' do
|
|
before do
|
|
stub_request(:post, "https://graph.facebook.com/#{api_version}/#{phone_number_id}/register")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' },
|
|
body: { messaging_product: 'whatsapp', pin: pin }.to_json
|
|
)
|
|
.to_return(status: 400, body: { error: 'Registration failed' }.to_json)
|
|
end
|
|
|
|
it 'raises an error' do
|
|
expect { api_client.register_phone_number(phone_number_id, pin) }.to raise_error(/Phone registration failed/)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#subscribe_waba_webhook' do
|
|
let(:waba_id) { 'test_waba_id' }
|
|
let(:callback_url) { 'https://example.com/webhook' }
|
|
let(:verify_token) { 'test_verify_token' }
|
|
|
|
context 'when successful' do
|
|
before do
|
|
# Step 1: Subscribe app to WABA (no body)
|
|
stub_request(:post, "https://graph.facebook.com/#{api_version}/#{waba_id}/subscribed_apps")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' }
|
|
)
|
|
.to_return(
|
|
status: 200,
|
|
body: { success: true }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
|
|
# Step 2: Override callback URL (with body)
|
|
stub_request(:post, "https://graph.facebook.com/#{api_version}/#{waba_id}/subscribed_apps")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' },
|
|
body: { override_callback_uri: callback_url, verify_token: verify_token,
|
|
subscribed_fields: %w[messages smb_message_echoes calls] }.to_json
|
|
)
|
|
.to_return(
|
|
status: 200,
|
|
body: { success: true }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'returns success response' do
|
|
result = api_client.subscribe_waba_webhook(waba_id, callback_url, verify_token)
|
|
expect(result['success']).to be(true)
|
|
end
|
|
end
|
|
|
|
context 'when app subscription fails' do
|
|
before do
|
|
stub_request(:post, "https://graph.facebook.com/#{api_version}/#{waba_id}/subscribed_apps")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' }
|
|
)
|
|
.to_return(status: 400, body: { error: 'App subscription to WABA failed' }.to_json)
|
|
end
|
|
|
|
it 'raises an error' do
|
|
expect { api_client.subscribe_waba_webhook(waba_id, callback_url, verify_token) }.to raise_error(/App subscription to WABA failed/)
|
|
end
|
|
end
|
|
|
|
context 'when callback override fails' do
|
|
before do
|
|
# Step 1 succeeds
|
|
stub_request(:post, "https://graph.facebook.com/#{api_version}/#{waba_id}/subscribed_apps")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' }
|
|
)
|
|
.to_return(
|
|
status: 200,
|
|
body: { success: true }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
|
|
# Step 2 fails
|
|
stub_request(:post, "https://graph.facebook.com/#{api_version}/#{waba_id}/subscribed_apps")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' },
|
|
body: { override_callback_uri: callback_url, verify_token: verify_token,
|
|
subscribed_fields: %w[messages smb_message_echoes calls] }.to_json
|
|
)
|
|
.to_return(status: 400, body: { error: 'Webhook callback override failed' }.to_json)
|
|
end
|
|
|
|
it 'raises an error' do
|
|
expect { api_client.subscribe_waba_webhook(waba_id, callback_url, verify_token) }.to raise_error(/Webhook callback override failed/)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#unsubscribe_waba_webhook' do
|
|
let(:waba_id) { 'test_waba_id' }
|
|
|
|
context 'when successful' do
|
|
before do
|
|
stub_request(:delete, "https://graph.facebook.com/#{api_version}/#{waba_id}/subscribed_apps")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' }
|
|
)
|
|
.to_return(
|
|
status: 200,
|
|
body: { success: true }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'returns success response' do
|
|
result = api_client.unsubscribe_waba_webhook(waba_id)
|
|
expect(result['success']).to be(true)
|
|
end
|
|
end
|
|
|
|
context 'when failed' do
|
|
before do
|
|
stub_request(:delete, "https://graph.facebook.com/#{api_version}/#{waba_id}/subscribed_apps")
|
|
.with(
|
|
headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' }
|
|
)
|
|
.to_return(status: 400, body: { error: 'Webhook unsubscription failed' }.to_json)
|
|
end
|
|
|
|
it 'raises an error' do
|
|
expect { api_client.unsubscribe_waba_webhook(waba_id) }.to raise_error(/Webhook unsubscription failed/)
|
|
end
|
|
end
|
|
end
|
|
end
|