## Description This PR introduces WhatsApp Embedded Signup functionality, enabling users to connect their WhatsApp Business accounts through Meta's streamlined OAuth flow without manual webhook configuration. This significantly improves the user experience by automating the entire setup process. **Key Features:** - Embedded signup flow using Facebook SDK and Meta's OAuth 2.0 - Automatic webhook registration and phone number configuration - Enhanced provider selection UI with card-based design - Real-time progress tracking during signup process - Comprehensive error handling and user feedback ## Required Configuration The following environment variables must be configured by administrators before this feature can be used: Super Admin Configuration (via super_admin/app_config?config=whatsapp_embedded) - `WHATSAPP_APP_ID`: The Facebook App ID for WhatsApp Business API integration - `WHATSAPP_CONFIGURATION_ID`: The Configuration ID for WhatsApp Embedded Signup flow (obtained from Meta Developer Portal) - `WHATSAPP_APP_SECRET`: The App Secret for WhatsApp Embedded Signup flow (required for token exchange)  ## How Has This Been Tested? #### Backend Tests (RSpec): - Authentication validation for embedded signup endpoints - Authorization code validation and error handling - Missing business parameter validation - Proper response format for configuration endpoint - Unauthorized access prevention #### Manual Test Cases: - Complete embedded signup flow (happy path) - Provider selection UI navigation - Facebook authentication popup handling - Error scenarios (cancelled auth, invalid business data, API failures) - Configuration presence/absence behavior ## Related Screenshots:      Fixes https://linear.app/chatwoot/issue/CW-2131/spec-for-whatsapp-cloud-channels-sign-in-with-facebook --------- Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: iamsivin <iamsivin@gmail.com> Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com> Co-authored-by: Sojan Jose <sojan@pepalo.com>
120 lines
4.3 KiB
Ruby
120 lines
4.3 KiB
Ruby
require 'rails_helper'
|
|
|
|
describe Whatsapp::WebhookSetupService do
|
|
let(:channel) do
|
|
create(:channel_whatsapp,
|
|
phone_number: '+1234567890',
|
|
provider_config: {
|
|
'phone_number_id' => 'test_phone_id',
|
|
'webhook_verify_token' => 'test_verify_token'
|
|
},
|
|
provider: 'whatsapp_cloud',
|
|
sync_templates: false,
|
|
validate_provider_config: false)
|
|
end
|
|
let(:waba_id) { 'test_waba_id' }
|
|
let(:access_token) { 'test_access_token' }
|
|
let(:service) { described_class.new(channel, waba_id, access_token) }
|
|
let(:api_client) { instance_double(Whatsapp::FacebookApiClient) }
|
|
|
|
before do
|
|
# Clean up any existing channels to avoid phone number conflicts
|
|
Channel::Whatsapp.destroy_all
|
|
allow(Whatsapp::FacebookApiClient).to receive(:new).and_return(api_client)
|
|
end
|
|
|
|
describe '#perform' do
|
|
context 'when all operations succeed' do
|
|
before do
|
|
allow(SecureRandom).to receive(:random_number).with(900_000).and_return(123_456)
|
|
allow(api_client).to receive(:register_phone_number).with('123456789', 223_456)
|
|
allow(api_client).to receive(:subscribe_waba_webhook)
|
|
.with(waba_id, anything, 'test_verify_token')
|
|
.and_return({ 'success' => true })
|
|
allow(channel).to receive(:save!)
|
|
end
|
|
|
|
it 'registers the phone number' do
|
|
with_modified_env FRONTEND_URL: 'https://app.chatwoot.com' do
|
|
expect(api_client).to receive(:register_phone_number).with('123456789', 223_456)
|
|
service.perform
|
|
end
|
|
end
|
|
|
|
it 'sets up webhook subscription' do
|
|
with_modified_env FRONTEND_URL: 'https://app.chatwoot.com' do
|
|
expect(api_client).to receive(:subscribe_waba_webhook)
|
|
.with(waba_id, 'https://app.chatwoot.com/webhooks/whatsapp/+1234567890', 'test_verify_token')
|
|
service.perform
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when phone registration fails' do
|
|
before do
|
|
allow(SecureRandom).to receive(:random_number).with(900_000).and_return(123_456)
|
|
allow(api_client).to receive(:register_phone_number)
|
|
.and_raise('Registration failed')
|
|
allow(api_client).to receive(:subscribe_waba_webhook)
|
|
.and_return({ 'success' => true })
|
|
end
|
|
|
|
it 'continues with webhook setup' do
|
|
with_modified_env FRONTEND_URL: 'https://app.chatwoot.com' do
|
|
expect(api_client).to receive(:subscribe_waba_webhook)
|
|
expect { service.perform }.not_to raise_error
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when webhook setup fails' do
|
|
before do
|
|
allow(SecureRandom).to receive(:random_number).with(900_000).and_return(123_456)
|
|
allow(api_client).to receive(:register_phone_number)
|
|
allow(api_client).to receive(:subscribe_waba_webhook)
|
|
.and_raise('Webhook failed')
|
|
end
|
|
|
|
it 'raises an error' do
|
|
with_modified_env FRONTEND_URL: 'https://app.chatwoot.com' do
|
|
expect { service.perform }.to raise_error(/Webhook setup failed/)
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when required parameters are missing' do
|
|
it 'raises error when channel is nil' do
|
|
service = described_class.new(nil, waba_id, access_token)
|
|
expect { service.perform }.to raise_error(ArgumentError, 'Channel is required')
|
|
end
|
|
|
|
it 'raises error when waba_id is blank' do
|
|
service = described_class.new(channel, '', access_token)
|
|
expect { service.perform }.to raise_error(ArgumentError, 'WABA ID is required')
|
|
end
|
|
|
|
it 'raises error when access_token is blank' do
|
|
service = described_class.new(channel, waba_id, '')
|
|
expect { service.perform }.to raise_error(ArgumentError, 'Access token is required')
|
|
end
|
|
end
|
|
|
|
context 'when PIN already exists' do
|
|
before do
|
|
channel.provider_config['verification_pin'] = 123_456
|
|
allow(api_client).to receive(:register_phone_number)
|
|
allow(api_client).to receive(:subscribe_waba_webhook).and_return({ 'success' => true })
|
|
allow(channel).to receive(:save!)
|
|
end
|
|
|
|
it 'reuses existing PIN' do
|
|
with_modified_env FRONTEND_URL: 'https://app.chatwoot.com' do
|
|
expect(api_client).to receive(:register_phone_number).with('123456789', 123_456)
|
|
expect(SecureRandom).not_to receive(:random_number)
|
|
service.perform
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|