## 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>
148 lines
4.2 KiB
Ruby
148 lines
4.2 KiB
Ruby
require 'rails_helper'
|
|
|
|
describe Whatsapp::PhoneInfoService do
|
|
let(:waba_id) { 'test_waba_id' }
|
|
let(:phone_number_id) { 'test_phone_number_id' }
|
|
let(:access_token) { 'test_access_token' }
|
|
let(:service) { described_class.new(waba_id, phone_number_id, access_token) }
|
|
let(:api_client) { instance_double(Whatsapp::FacebookApiClient) }
|
|
|
|
before do
|
|
allow(Whatsapp::FacebookApiClient).to receive(:new).with(access_token).and_return(api_client)
|
|
end
|
|
|
|
describe '#perform' do
|
|
let(:phone_response) do
|
|
{
|
|
'data' => [
|
|
{
|
|
'id' => phone_number_id,
|
|
'display_phone_number' => '1234567890',
|
|
'verified_name' => 'Test Business',
|
|
'code_verification_status' => 'VERIFIED'
|
|
}
|
|
]
|
|
}
|
|
end
|
|
|
|
context 'when all parameters are valid' do
|
|
before do
|
|
allow(api_client).to receive(:fetch_phone_numbers).with(waba_id).and_return(phone_response)
|
|
end
|
|
|
|
it 'returns formatted phone info' do
|
|
result = service.perform
|
|
expect(result).to eq({
|
|
phone_number_id: phone_number_id,
|
|
phone_number: '+1234567890',
|
|
verified: true,
|
|
business_name: 'Test Business'
|
|
})
|
|
end
|
|
end
|
|
|
|
context 'when phone_number_id is not provided' do
|
|
let(:phone_number_id) { nil }
|
|
let(:phone_response) do
|
|
{
|
|
'data' => [
|
|
{
|
|
'id' => 'first_phone_id',
|
|
'display_phone_number' => '1234567890',
|
|
'verified_name' => 'Test Business',
|
|
'code_verification_status' => 'VERIFIED'
|
|
}
|
|
]
|
|
}
|
|
end
|
|
|
|
before do
|
|
allow(api_client).to receive(:fetch_phone_numbers).with(waba_id).and_return(phone_response)
|
|
end
|
|
|
|
it 'uses the first available phone number' do
|
|
result = service.perform
|
|
expect(result[:phone_number_id]).to eq('first_phone_id')
|
|
end
|
|
end
|
|
|
|
context 'when specific phone_number_id is not found' do
|
|
let(:phone_number_id) { 'different_id' }
|
|
let(:phone_response) do
|
|
{
|
|
'data' => [
|
|
{
|
|
'id' => 'available_phone_id',
|
|
'display_phone_number' => '9876543210',
|
|
'verified_name' => 'Different Business',
|
|
'code_verification_status' => 'VERIFIED'
|
|
}
|
|
]
|
|
}
|
|
end
|
|
|
|
before do
|
|
allow(api_client).to receive(:fetch_phone_numbers).with(waba_id).and_return(phone_response)
|
|
end
|
|
|
|
it 'uses the first available phone number as fallback' do
|
|
result = service.perform
|
|
expect(result[:phone_number_id]).to eq('available_phone_id')
|
|
expect(result[:phone_number]).to eq('+9876543210')
|
|
end
|
|
end
|
|
|
|
context 'when no phone numbers are available' do
|
|
let(:phone_response) { { 'data' => [] } }
|
|
|
|
before do
|
|
allow(api_client).to receive(:fetch_phone_numbers).with(waba_id).and_return(phone_response)
|
|
end
|
|
|
|
it 'raises an error' do
|
|
expect { service.perform }.to raise_error(/No phone numbers found for WABA/)
|
|
end
|
|
end
|
|
|
|
context 'when waba_id is blank' do
|
|
let(:waba_id) { '' }
|
|
|
|
it 'raises ArgumentError' do
|
|
expect { service.perform }.to raise_error(ArgumentError, 'WABA ID is required')
|
|
end
|
|
end
|
|
|
|
context 'when access_token is blank' do
|
|
let(:access_token) { '' }
|
|
|
|
it 'raises ArgumentError' do
|
|
expect { service.perform }.to raise_error(ArgumentError, 'Access token is required')
|
|
end
|
|
end
|
|
|
|
context 'when phone number has special characters' do
|
|
let(:phone_response) do
|
|
{
|
|
'data' => [
|
|
{
|
|
'id' => phone_number_id,
|
|
'display_phone_number' => '+1 (234) 567-8900',
|
|
'verified_name' => 'Test Business',
|
|
'code_verification_status' => 'VERIFIED'
|
|
}
|
|
]
|
|
}
|
|
end
|
|
|
|
before do
|
|
allow(api_client).to receive(:fetch_phone_numbers).with(waba_id).and_return(phone_response)
|
|
end
|
|
|
|
it 'sanitizes the phone number' do
|
|
result = service.perform
|
|
expect(result[:phone_number]).to eq('+12345678900')
|
|
end
|
|
end
|
|
end
|
|
end
|