## 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.
111 lines
3.5 KiB
Ruby
111 lines
3.5 KiB
Ruby
class Whatsapp::OneoffCampaignService
|
|
pattr_initialize [:campaign!]
|
|
|
|
def perform
|
|
validate_campaign!
|
|
process_audience(extract_audience_labels)
|
|
campaign.completed!
|
|
end
|
|
|
|
private
|
|
|
|
delegate :inbox, to: :campaign
|
|
delegate :channel, to: :inbox
|
|
|
|
def validate_campaign_type!
|
|
raise "Invalid campaign #{campaign.id}" unless whatsapp_campaign? && campaign.one_off?
|
|
end
|
|
|
|
def whatsapp_campaign?
|
|
campaign.inbox.inbox_type == 'Whatsapp'
|
|
end
|
|
|
|
def validate_campaign_status!
|
|
raise 'Completed Campaign' if campaign.completed?
|
|
end
|
|
|
|
def validate_provider!
|
|
raise 'WhatsApp Cloud provider required' if channel.provider != 'whatsapp_cloud'
|
|
end
|
|
|
|
def validate_feature_flag!
|
|
raise 'WhatsApp campaigns feature not enabled' unless campaign.account.feature_enabled?(:whatsapp_campaign)
|
|
end
|
|
|
|
def validate_campaign!
|
|
validate_campaign_type!
|
|
validate_campaign_status!
|
|
validate_provider!
|
|
validate_feature_flag!
|
|
end
|
|
|
|
def extract_audience_labels
|
|
audience_label_ids = campaign.audience.select { |audience| audience['type'] == 'Label' }.pluck('id')
|
|
campaign.account.labels.where(id: audience_label_ids).pluck(:title)
|
|
end
|
|
|
|
def process_contact(contact)
|
|
Rails.logger.info "Processing contact: #{contact.name} (#{contact.phone_number})"
|
|
|
|
if contact.phone_number.blank?
|
|
Rails.logger.info "Skipping contact #{contact.name} - no phone number"
|
|
return
|
|
end
|
|
|
|
if campaign.template_params.blank?
|
|
Rails.logger.error "Skipping contact #{contact.name} - no template_params found for WhatsApp campaign"
|
|
return
|
|
end
|
|
|
|
processed_template_params = process_liquid_template_params(contact)
|
|
return if processed_template_params.nil?
|
|
|
|
send_whatsapp_template_message(to: contact.phone_number, template_params: processed_template_params)
|
|
end
|
|
|
|
def process_audience(audience_labels)
|
|
contacts = campaign.account.contacts.tagged_with(audience_labels, any: true)
|
|
Rails.logger.info "Processing #{contacts.count} contacts for campaign #{campaign.id}"
|
|
|
|
contacts.each { |contact| process_contact(contact) }
|
|
|
|
Rails.logger.info "Campaign #{campaign.id} processing completed"
|
|
end
|
|
|
|
def process_liquid_template_params(contact)
|
|
liquid_processor = Whatsapp::LiquidTemplateProcessorService.new(campaign: campaign, contact: contact)
|
|
processed_template_params = liquid_processor.process_template_params(campaign.template_params)
|
|
|
|
Rails.logger.info "Skipping contact #{contact.name} - liquid variables resolved to blank values" if processed_template_params.nil?
|
|
|
|
processed_template_params
|
|
rescue StandardError => e
|
|
Rails.logger.error "Failed to process liquid template params for contact #{contact.name}: #{e.message}"
|
|
nil
|
|
end
|
|
|
|
def send_whatsapp_template_message(to:, template_params:)
|
|
processor = Whatsapp::TemplateProcessorService.new(
|
|
channel: channel,
|
|
template_params: template_params
|
|
)
|
|
|
|
name, namespace, lang_code, processed_parameters = processor.call
|
|
|
|
return if name.blank?
|
|
|
|
channel.send_template(to, {
|
|
name: name,
|
|
namespace: namespace,
|
|
lang_code: lang_code,
|
|
parameters: processed_parameters
|
|
}, nil)
|
|
|
|
rescue StandardError => e
|
|
Rails.logger.error "Failed to send WhatsApp template message to #{to}: #{e.message}"
|
|
Rails.logger.error "Backtrace: #{e.backtrace.first(5).join('\n')}"
|
|
# continue processing remaining contacts
|
|
nil
|
|
end
|
|
end
|