## Description
When a WhatsApp Cloud inbox is deleted,
`Whatsapp::WebhookTeardownService` clears the phone-level webhook
override and unsubscribes the app from the WABA (when it's the last
inbox), but it **never deregisters the phone number**.
Because the number stays registered to the app, Meta reports that the
number is **"already registered to a partner app"** when the user later
tries to re-add it under a different app/BSP — leaving the number
effectively stuck.
This adds a deregister step so the number is released on deletion:
- New `Whatsapp::FacebookApiClient#deregister_phone_number` → `POST
/{phone_number_id}/deregister`.
- `WebhookTeardownService` calls it during teardown (alongside the
existing override-clear and app-unsubscribe), guarded on
`phone_number_id` and wrapped so a failure is logged and never blocks
the channel delete.
Docs:
https://developers.facebook.com/docs/whatsapp/cloud-api/reference/registration
(deregister)
## Type of change
- [x] Bug fix (non-breaking change which fixes an issue)
## How has this been tested?
Unit specs for both the new API client method and the teardown service
(Meta API stubbed with WebMock), mirroring the existing
`register_phone_number` / teardown coverage.
## Checklist
- [x] My code follows the style guidelines of this project
- [x] I have added tests that prove my fix is effective
- [x] New and existing unit tests pass locally with my changes
---------
Co-authored-by: Tanmay Deep Sharma <32020192+tds-1@users.noreply.github.com>
Co-authored-by: Tanmay Deep Sharma <tanmaydeepsharma21@gmail.com>
121 lines
4.4 KiB
Ruby
121 lines
4.4 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe Whatsapp::WebhookTeardownService do
|
|
describe '#perform' do
|
|
let(:channel) { create(:channel_whatsapp, validate_provider_config: false, sync_templates: false) }
|
|
let(:service) { described_class.new(channel) }
|
|
|
|
context 'when channel is whatsapp_cloud with embedded_signup' do
|
|
before do
|
|
# Stub webhook setup to prevent HTTP calls during channel update
|
|
allow(channel).to receive(:setup_webhooks).and_return(true)
|
|
|
|
channel.update!(
|
|
provider: 'whatsapp_cloud',
|
|
provider_config: {
|
|
'source' => 'embedded_signup',
|
|
'phone_number_id' => 'test_phone_id',
|
|
'api_key' => 'test_api_key'
|
|
}
|
|
)
|
|
end
|
|
|
|
it 'calls clear_phone_number_callback_override on Facebook API client' do
|
|
api_client = instance_double(Whatsapp::FacebookApiClient)
|
|
allow(Whatsapp::FacebookApiClient).to receive(:new).with('test_api_key').and_return(api_client)
|
|
allow(api_client).to receive(:clear_phone_number_callback_override).with('test_phone_id')
|
|
allow(api_client).to receive(:deregister_phone_number).with('test_phone_id')
|
|
|
|
service.perform
|
|
|
|
expect(api_client).to have_received(:clear_phone_number_callback_override).with('test_phone_id')
|
|
end
|
|
|
|
it 'deregisters the phone number so it is freed from the app' do
|
|
api_client = instance_double(Whatsapp::FacebookApiClient)
|
|
allow(Whatsapp::FacebookApiClient).to receive(:new).with('test_api_key').and_return(api_client)
|
|
allow(api_client).to receive(:clear_phone_number_callback_override)
|
|
allow(api_client).to receive(:deregister_phone_number).with('test_phone_id')
|
|
|
|
service.perform
|
|
|
|
expect(api_client).to have_received(:deregister_phone_number).with('test_phone_id')
|
|
end
|
|
|
|
it 'handles errors gracefully without raising' do
|
|
api_client = instance_double(Whatsapp::FacebookApiClient)
|
|
allow(Whatsapp::FacebookApiClient).to receive(:new).and_return(api_client)
|
|
allow(api_client).to receive(:clear_phone_number_callback_override).and_raise(StandardError, 'API Error')
|
|
allow(api_client).to receive(:deregister_phone_number)
|
|
|
|
expect { service.perform }.not_to raise_error
|
|
end
|
|
end
|
|
|
|
context 'when channel is not whatsapp_cloud' do
|
|
before do
|
|
channel.update!(provider: 'default')
|
|
end
|
|
|
|
it 'does not attempt to unsubscribe webhook' do
|
|
expect(Whatsapp::FacebookApiClient).not_to receive(:new)
|
|
|
|
service.perform
|
|
end
|
|
end
|
|
|
|
context 'when channel is whatsapp_cloud with manual setup' do
|
|
before do
|
|
allow(channel).to receive(:setup_webhooks).and_return(true)
|
|
|
|
channel.update!(
|
|
provider: 'whatsapp_cloud',
|
|
provider_config: {
|
|
'source' => 'manual',
|
|
'phone_number_id' => 'manual_phone_id',
|
|
'business_account_id' => 'manual_waba_id',
|
|
'api_key' => 'manual_api_key'
|
|
}
|
|
)
|
|
end
|
|
|
|
it 'clears the phone number callback override' do
|
|
api_client = instance_double(Whatsapp::FacebookApiClient)
|
|
allow(Whatsapp::FacebookApiClient).to receive(:new).with('manual_api_key').and_return(api_client)
|
|
allow(api_client).to receive(:clear_phone_number_callback_override).with('manual_phone_id')
|
|
|
|
service.perform
|
|
|
|
expect(api_client).to have_received(:clear_phone_number_callback_override).with('manual_phone_id')
|
|
end
|
|
|
|
# The manual token belongs to the customer's own Meta app, so its WABA subscription is not ours to remove.
|
|
it 'does not unsubscribe the app from the WABA' do
|
|
api_client = instance_double(Whatsapp::FacebookApiClient)
|
|
allow(Whatsapp::FacebookApiClient).to receive(:new).and_return(api_client)
|
|
allow(api_client).to receive(:clear_phone_number_callback_override)
|
|
allow(api_client).to receive(:unsubscribe_app_from_waba)
|
|
|
|
service.perform
|
|
|
|
expect(api_client).not_to have_received(:unsubscribe_app_from_waba)
|
|
end
|
|
end
|
|
|
|
context 'when required config is missing' do
|
|
before do
|
|
channel.update!(
|
|
provider: 'whatsapp_cloud',
|
|
provider_config: { 'source' => 'embedded_signup' }
|
|
)
|
|
end
|
|
|
|
it 'does not attempt to unsubscribe webhook' do
|
|
expect(Whatsapp::FacebookApiClient).not_to receive(:new)
|
|
|
|
service.perform
|
|
end
|
|
end
|
|
end
|
|
end
|