mirror of
https://github.com/chatwoot/chatwoot.git
synced 2026-06-04 21:02:35 +08:00
## Summary One-off SMS and WhatsApp campaigns now show a `Processing` state while the audience send is in progress. The campaign moves to `Completed` after processing finishes, and already-processing campaigns are skipped by the scheduler to avoid duplicate sends. ## Closes - [CW-6037: feat: Introduce an in-progress status for campaigns](https://linear.app/chatwoot/issue/CW-6037/feat-introduce-an-in-progress-status-for-campaigns) ## Screenshot SMS campaign card showing the new `Processing` status. <img width="3840" height="2160" alt="framed-campaign-processing-status" src="https://github.com/user-attachments/assets/de7913b5-65fb-4121-9034-24a568eb0382" /> ## What changed - Added `processing` as a campaign status. - Mark one-off campaigns as `processing` under a row lock before the send service runs. - Complete SMS, Twilio SMS, and WhatsApp one-off campaigns after audience processing finishes. - Keep campaigns in `processing` if an unexpected service error escapes, so the scheduler does not automatically resend the audience. - Added the `Processing` label for SMS and WhatsApp campaign cards. ## Known operational behavior If a worker is interrupted or an unexpected service error escapes after a campaign is marked `processing`, the campaign can remain in `processing`. This is intentional for now to avoid automatic full-audience resends. Installation admins can decide whether to mark the campaign completed or restart it manually from the Rails console after checking what was sent. ## How to test - Create a one-off SMS or WhatsApp campaign scheduled for now. - Run the scheduled job or trigger the campaign job. - Confirm the campaign card shows `Processing` while the audience is being processed. For small audiences, refresh during processing or use a larger audience so the state is observable. - Confirm the campaign moves to `Completed` after audience processing finishes. - Confirm an already-processing campaign is not enqueued again by the scheduled job.
212 lines
7.5 KiB
Ruby
212 lines
7.5 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'rails_helper'
|
|
|
|
RSpec.describe Campaign do
|
|
describe 'associations' do
|
|
it { is_expected.to belong_to(:account) }
|
|
it { is_expected.to belong_to(:inbox) }
|
|
end
|
|
|
|
describe '.before_create' do
|
|
let(:account) { create(:account) }
|
|
let(:website_channel) { create(:channel_widget, account: account) }
|
|
let(:website_inbox) { create(:inbox, channel: website_channel, account: account) }
|
|
let(:campaign) { build(:campaign, account: account, inbox: website_inbox, display_id: nil, trigger_rules: { url: 'https://test.com' }) }
|
|
|
|
before do
|
|
campaign.save!
|
|
campaign.reload
|
|
end
|
|
|
|
it 'runs before_create callbacks' do
|
|
expect(campaign.display_id).to eq(1)
|
|
end
|
|
end
|
|
|
|
context 'when Inbox other then Website or Twilio SMS' do
|
|
before do
|
|
stub_request(:post, /graph.facebook.com/)
|
|
end
|
|
|
|
let(:account) { create(:account) }
|
|
let!(:facebook_channel) { create(:channel_facebook_page, account: account) }
|
|
let!(:facebook_inbox) { create(:inbox, channel: facebook_channel, account: account) }
|
|
let(:campaign) { build(:campaign, inbox: facebook_inbox, account: account) }
|
|
|
|
it 'would not save the campaigns' do
|
|
expect(campaign.save).to be false
|
|
expect(campaign.errors.full_messages.first).to eq 'Inbox Unsupported Inbox type'
|
|
end
|
|
end
|
|
|
|
context 'when a campaign is completed' do
|
|
let(:account) { create(:account) }
|
|
let(:web_widget) { create(:channel_widget, account: account) }
|
|
let!(:campaign) { create(:campaign, account: account, inbox: web_widget.inbox, campaign_status: :completed, trigger_rules: { url: 'https://test.com' }) }
|
|
|
|
it 'would prevent further updates' do
|
|
campaign.title = 'new name'
|
|
expect(campaign.save).to be false
|
|
expect(campaign.errors.full_messages.first).to eq 'Status The campaign is already completed'
|
|
end
|
|
|
|
it 'can be deleted' do
|
|
campaign.destroy!
|
|
expect(described_class.exists?(campaign.id)).to be false
|
|
end
|
|
|
|
it 'cant be triggered' do
|
|
expect(Twilio::OneoffSmsCampaignService).not_to receive(:new).with(campaign: campaign)
|
|
expect(campaign.trigger!).to be_nil
|
|
end
|
|
end
|
|
|
|
describe 'ensure_correct_campaign_attributes' do
|
|
context 'when Twilio SMS campaign' do
|
|
let(:account) { create(:account) }
|
|
let!(:twilio_sms) { create(:channel_twilio_sms, account: account) }
|
|
let!(:twilio_inbox) { create(:inbox, channel: twilio_sms, account: account) }
|
|
let(:campaign) { build(:campaign, account: account, inbox: twilio_inbox) }
|
|
|
|
it 'only saves campaign type as oneoff and wont leave scheduled_at empty' do
|
|
campaign.campaign_type = 'ongoing'
|
|
campaign.save!
|
|
expect(campaign.reload.campaign_type).to eq 'one_off'
|
|
expect(campaign.scheduled_at.present?).to be true
|
|
end
|
|
|
|
it 'calls twilio service on trigger!' do
|
|
sms_service = double
|
|
expect(Twilio::OneoffSmsCampaignService).to receive(:new).with(campaign: campaign).and_return(sms_service)
|
|
expect(sms_service).to receive(:perform)
|
|
campaign.save!
|
|
campaign.trigger!
|
|
end
|
|
|
|
it 'marks the campaign as processing before triggering the service' do
|
|
campaign.save!
|
|
sms_service = double
|
|
|
|
expect(Twilio::OneoffSmsCampaignService).to receive(:new).with(campaign: campaign).and_return(sms_service)
|
|
expect(sms_service).to receive(:perform) do
|
|
expect(campaign.reload.processing?).to be true
|
|
end
|
|
|
|
campaign.trigger!
|
|
end
|
|
|
|
it 'does not trigger a processing campaign again' do
|
|
campaign.save!
|
|
campaign.processing!
|
|
|
|
expect(Twilio::OneoffSmsCampaignService).not_to receive(:new)
|
|
|
|
campaign.trigger!
|
|
end
|
|
|
|
it 'keeps the campaign processing when triggering fails' do
|
|
campaign.save!
|
|
sms_service = double
|
|
|
|
expect(Twilio::OneoffSmsCampaignService).to receive(:new).with(campaign: campaign).and_return(sms_service)
|
|
expect(sms_service).to receive(:perform).and_raise(StandardError, 'provider error')
|
|
|
|
expect { campaign.trigger! }.to raise_error(StandardError, 'provider error')
|
|
expect(campaign.reload.processing?).to be true
|
|
end
|
|
end
|
|
|
|
context 'when SMS campaign' do
|
|
let(:account) { create(:account) }
|
|
let!(:sms_channel) { create(:channel_sms, account: account) }
|
|
let!(:sms_inbox) { create(:inbox, channel: sms_channel, account: account) }
|
|
let(:campaign) { build(:campaign, account: account, inbox: sms_inbox) }
|
|
|
|
it 'only saves campaign type as oneoff and wont leave scheduled_at empty' do
|
|
campaign.campaign_type = 'ongoing'
|
|
campaign.save!
|
|
expect(campaign.reload.campaign_type).to eq 'one_off'
|
|
expect(campaign.scheduled_at.present?).to be true
|
|
end
|
|
|
|
it 'calls sms service on trigger!' do
|
|
sms_service = double
|
|
expect(Sms::OneoffSmsCampaignService).to receive(:new).with(campaign: campaign).and_return(sms_service)
|
|
expect(sms_service).to receive(:perform)
|
|
campaign.save!
|
|
campaign.trigger!
|
|
end
|
|
end
|
|
|
|
context 'when WhatsApp campaign feature is disabled' do
|
|
let(:account) { create(:account) }
|
|
let(:whatsapp_channel) do
|
|
create(:channel_whatsapp, account: account, provider: 'whatsapp_cloud', validate_provider_config: false, sync_templates: false)
|
|
end
|
|
let(:campaign) { create(:campaign, account: account, inbox: whatsapp_channel.inbox) }
|
|
|
|
it 'does not mark the campaign as processing' do
|
|
expect(Whatsapp::OneoffCampaignService).not_to receive(:new)
|
|
|
|
campaign.trigger!
|
|
|
|
expect(campaign.reload.active?).to be true
|
|
end
|
|
end
|
|
|
|
context 'when Website campaign' do
|
|
let(:campaign) { build(:campaign) }
|
|
|
|
it 'only saves campaign type as ongoing' do
|
|
campaign.campaign_type = 'one_off'
|
|
campaign.save!
|
|
expect(campaign.reload.campaign_type).to eq 'ongoing'
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when validating sender' do
|
|
let(:account) { create(:account) }
|
|
let(:user) { create(:user, account: account) }
|
|
let(:web_widget) { create(:channel_widget, account: account) }
|
|
let(:inbox) { create(:inbox, channel: web_widget, account: account) }
|
|
|
|
it 'allows sender from the same account' do
|
|
campaign = build(:campaign, inbox: inbox, account: account, sender: user)
|
|
expect(campaign).to be_valid
|
|
end
|
|
|
|
it 'does not allow sender from different account' do
|
|
other_account = create(:account)
|
|
other_user = create(:user, account: other_account)
|
|
campaign = build(:campaign, inbox: inbox, account: account, sender: other_user)
|
|
expect(campaign).not_to be_valid
|
|
expect(campaign.errors[:sender_id]).to include(
|
|
'must belong to the same account as the campaign'
|
|
)
|
|
end
|
|
end
|
|
|
|
context 'when validating inbox' do
|
|
let(:account) { create(:account) }
|
|
let(:other_account) { create(:account) }
|
|
let(:web_widget) { create(:channel_widget, account: account) }
|
|
let(:inbox) { create(:inbox, channel: web_widget, account: account) }
|
|
let(:other_account_inbox) { create(:inbox, account: other_account) }
|
|
|
|
it 'allows inbox from the same account' do
|
|
campaign = build(:campaign, inbox: inbox, account: account)
|
|
expect(campaign).to be_valid
|
|
end
|
|
|
|
it 'does not allow inbox from different account' do
|
|
campaign = build(:campaign, inbox: other_account_inbox, account: account)
|
|
expect(campaign).not_to be_valid
|
|
expect(campaign.errors[:inbox_id]).to include(
|
|
'must belong to the same account as the campaign'
|
|
)
|
|
end
|
|
end
|
|
end
|