mirror of
https://github.com/lingble/chatwoot.git
synced 2025-12-07 21:35:38 +00:00
## Summary - handle Twilio failures per contact when running one-off SMS campaigns - rescue errors in WhatsApp and generic SMS one-off campaigns so they continue - add specs confirming campaigns continue sending when a single contact fails fixes: https://github.com/chatwoot/chatwoot/issues/9000 Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
106 lines
4.3 KiB
Ruby
106 lines
4.3 KiB
Ruby
require 'rails_helper'
|
|
|
|
describe Twilio::OneoffSmsCampaignService do
|
|
subject(:sms_campaign_service) { described_class.new(campaign: campaign) }
|
|
|
|
let(:account) { create(:account) }
|
|
let!(:twilio_sms) { create(:channel_twilio_sms, account: account) }
|
|
let!(:twilio_inbox) { create(:inbox, channel: twilio_sms, account: account) }
|
|
let(:label1) { create(:label, account: account) }
|
|
let(:label2) { create(:label, account: account) }
|
|
let!(:campaign) do
|
|
create(:campaign, inbox: twilio_inbox, account: account,
|
|
audience: [{ type: 'Label', id: label1.id }, { type: 'Label', id: label2.id }])
|
|
end
|
|
let(:twilio_client) { double }
|
|
let(:twilio_messages) { double }
|
|
|
|
describe 'perform' do
|
|
before do
|
|
allow(Twilio::REST::Client).to receive(:new).and_return(twilio_client)
|
|
allow(twilio_client).to receive(:messages).and_return(twilio_messages)
|
|
end
|
|
|
|
it 'raises error if the campaign is completed' do
|
|
campaign.completed!
|
|
|
|
expect { sms_campaign_service.perform }.to raise_error 'Completed Campaign'
|
|
end
|
|
|
|
it 'raises error invalid campaign when its not a oneoff sms campaign' do
|
|
campaign = create(:campaign)
|
|
|
|
expect { described_class.new(campaign: campaign).perform }.to raise_error "Invalid campaign #{campaign.id}"
|
|
end
|
|
|
|
it 'send messages to contacts in the audience and marks the campaign completed' do
|
|
contact_with_label1, contact_with_label2, contact_with_both_labels = FactoryBot.create_list(:contact, 3, :with_phone_number, account: account)
|
|
contact_with_label1.update_labels([label1.title])
|
|
contact_with_label2.update_labels([label2.title])
|
|
contact_with_both_labels.update_labels([label1.title, label2.title])
|
|
expect(twilio_messages).to receive(:create).with(
|
|
body: campaign.message,
|
|
messaging_service_sid: twilio_sms.messaging_service_sid,
|
|
to: contact_with_label1.phone_number,
|
|
status_callback: 'http://localhost:3000/twilio/delivery_status'
|
|
).once
|
|
expect(twilio_messages).to receive(:create).with(
|
|
body: campaign.message,
|
|
messaging_service_sid: twilio_sms.messaging_service_sid,
|
|
to: contact_with_label2.phone_number,
|
|
status_callback: 'http://localhost:3000/twilio/delivery_status'
|
|
).once
|
|
expect(twilio_messages).to receive(:create).with(
|
|
body: campaign.message,
|
|
messaging_service_sid: twilio_sms.messaging_service_sid,
|
|
to: contact_with_both_labels.phone_number,
|
|
status_callback: 'http://localhost:3000/twilio/delivery_status'
|
|
).once
|
|
|
|
sms_campaign_service.perform
|
|
expect(campaign.reload.completed?).to be true
|
|
end
|
|
|
|
it 'uses liquid template service to process campaign message' do
|
|
contact = create(:contact, :with_phone_number, account: account)
|
|
contact.update_labels([label1.title])
|
|
|
|
expect(Liquid::CampaignTemplateService).to receive(:new).with(campaign: campaign, contact: contact).and_call_original
|
|
expect(twilio_messages).to receive(:create).once
|
|
|
|
sms_campaign_service.perform
|
|
end
|
|
|
|
it 'continues processing contacts when Twilio raises an error' do
|
|
contact_error, contact_success = FactoryBot.create_list(:contact, 2, :with_phone_number, account: account)
|
|
contact_error.update_labels([label1.title])
|
|
contact_success.update_labels([label1.title])
|
|
|
|
error = Twilio::REST::TwilioError.new("The 'To' number #{contact_error.phone_number} is not a valid phone number.")
|
|
|
|
allow(twilio_messages).to receive(:create).and_return(nil)
|
|
|
|
expect(twilio_messages).to receive(:create).with(
|
|
body: campaign.message,
|
|
messaging_service_sid: twilio_sms.messaging_service_sid,
|
|
to: contact_error.phone_number,
|
|
status_callback: 'http://localhost:3000/twilio/delivery_status'
|
|
).and_raise(error)
|
|
|
|
expect(twilio_messages).to receive(:create).with(
|
|
body: campaign.message,
|
|
messaging_service_sid: twilio_sms.messaging_service_sid,
|
|
to: contact_success.phone_number,
|
|
status_callback: 'http://localhost:3000/twilio/delivery_status'
|
|
).once
|
|
|
|
expect(Rails.logger).to receive(:error).with(
|
|
"[Twilio Campaign #{campaign.id}] Failed to send to #{contact_error.phone_number}: #{error.message}"
|
|
)
|
|
|
|
sms_campaign_service.perform
|
|
expect(campaign.reload.completed?).to be true
|
|
end
|
|
end
|
|
end
|