Introduce a daily cap on non-channel outbound emails to prevent abuse. Fixes https://linear.app/chatwoot/issue/CW-6418/ses-incident-jan-28 ## Type of change - [x] New feature (non-breaking change which adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality not to work as expected) ## Summary - Adds a Redis-based daily counter to rate limit outbound emails per account, preventing email abuse - Covers continuity emails (WebWidget/API), conversation transcripts, and agent notifications - Email channel replies are excluded (paid feature, not abusable) - Adds account suspension check in `ConversationReplyMailer` to block already-queued emails for suspended accounts ## Limit Resolution Hierarchy 1. Per-account override (`account.limits['emails']`) — SuperAdmin configurable 2. Enterprise plan-based (`ACCOUNT_EMAILS_PLAN_LIMITS` InstallationConfig) 3. Global default (`ACCOUNT_EMAILS_LIMIT` InstallationConfig, default: 100) 4. Fallback (`ChatwootApp.max_limit` — effectively unlimited) ## Enforcement Points | Path | Where | Behavior | |------|-------|----------| | WebWidget/API continuity | `SendEmailNotificationService#should_send_email_notification?` | Silently skipped | | Widget transcript | `Widget::ConversationsController#transcript` | Returns 429 | | API transcript | `ConversationsController#transcript` | Returns 429 | | Agent notifications | `Notification::EmailNotificationService#perform` | Silently skipped | | Email channel replies | Not rate limited | Paid feature | | Suspended accounts | `ConversationReplyMailer` | Blocked at mailer level |
193 lines
7.3 KiB
Ruby
193 lines
7.3 KiB
Ruby
require 'rails_helper'
|
|
|
|
describe Messages::SendEmailNotificationService do
|
|
let(:account) { create(:account) }
|
|
let(:conversation) { create(:conversation, account: account) }
|
|
let(:message) { create(:message, conversation: conversation, message_type: 'outgoing') }
|
|
let(:service) { described_class.new(message: message) }
|
|
|
|
describe '#perform' do
|
|
context 'when email notification should be sent' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_widget, account: account, continuity_via_email: true)) }
|
|
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
|
|
|
|
before do
|
|
conversation.contact.update!(email: 'test@example.com')
|
|
allow(Redis::Alfred).to receive(:set).and_return(true)
|
|
ActiveJob::Base.queue_adapter = :test
|
|
end
|
|
|
|
it 'enqueues ConversationReplyEmailJob' do
|
|
expect { service.perform }.to have_enqueued_job(ConversationReplyEmailJob).with(conversation.id, message.id).on_queue('mailers')
|
|
end
|
|
|
|
it 'atomically sets redis key to prevent duplicate emails' do
|
|
expected_key = format(Redis::Alfred::CONVERSATION_MAILER_KEY, conversation_id: conversation.id)
|
|
|
|
service.perform
|
|
|
|
expect(Redis::Alfred).to have_received(:set).with(expected_key, message.id, nx: true, ex: 1.hour.to_i)
|
|
end
|
|
|
|
context 'when redis key already exists' do
|
|
before do
|
|
allow(Redis::Alfred).to receive(:set).and_return(false)
|
|
end
|
|
|
|
it 'does not enqueue job' do
|
|
expect { service.perform }.not_to have_enqueued_job(ConversationReplyEmailJob)
|
|
end
|
|
|
|
it 'attempts atomic set once' do
|
|
service.perform
|
|
|
|
expect(Redis::Alfred).to have_received(:set).once
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when handling concurrent requests' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_widget, account: account, continuity_via_email: true)) }
|
|
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
|
|
|
|
before do
|
|
conversation.contact.update!(email: 'test@example.com')
|
|
end
|
|
|
|
it 'prevents duplicate jobs under race conditions' do
|
|
# Create 5 threads that simultaneously try to enqueue workers for the same conversation
|
|
threads = Array.new(5) do
|
|
Thread.new do
|
|
msg = create(:message, conversation: conversation, message_type: 'outgoing')
|
|
described_class.new(message: msg).perform
|
|
end
|
|
end
|
|
|
|
threads.each(&:join)
|
|
|
|
# Only ONE job should be scheduled despite 5 concurrent attempts
|
|
jobs_for_conversation = ActiveJob::Base.queue_adapter.enqueued_jobs.select do |job|
|
|
job[:job] == ConversationReplyEmailJob && job[:args].first == conversation.id
|
|
end
|
|
expect(jobs_for_conversation.size).to eq(1)
|
|
end
|
|
end
|
|
|
|
context 'when email notification should not be sent' do
|
|
before do
|
|
ActiveJob::Base.queue_adapter = :test
|
|
end
|
|
|
|
context 'when message is not email notifiable' do
|
|
let(:message) { create(:message, conversation: conversation, message_type: 'incoming') }
|
|
|
|
it 'does not enqueue job' do
|
|
expect { service.perform }.not_to have_enqueued_job(ConversationReplyEmailJob)
|
|
end
|
|
end
|
|
|
|
context 'when contact has no email' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_widget, account: account, continuity_via_email: true)) }
|
|
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
|
|
|
|
before do
|
|
conversation.contact.update!(email: nil)
|
|
end
|
|
|
|
it 'does not enqueue job' do
|
|
expect { service.perform }.not_to have_enqueued_job(ConversationReplyEmailJob)
|
|
end
|
|
end
|
|
|
|
context 'when account email rate limit is exceeded' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_widget, account: account, continuity_via_email: true)) }
|
|
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
|
|
|
|
before do
|
|
conversation.contact.update!(email: 'test@example.com')
|
|
allow_any_instance_of(Account).to receive(:within_email_rate_limit?).and_return(false) # rubocop:disable RSpec/AnyInstance
|
|
end
|
|
|
|
it 'does not enqueue job' do
|
|
expect { service.perform }.not_to have_enqueued_job(ConversationReplyEmailJob)
|
|
end
|
|
end
|
|
|
|
context 'when channel does not support email notifications' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_sms, account: account)) }
|
|
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
|
|
|
|
before do
|
|
conversation.contact.update!(email: 'test@example.com')
|
|
end
|
|
|
|
it 'does not enqueue job' do
|
|
expect { service.perform }.not_to have_enqueued_job(ConversationReplyEmailJob)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#should_send_email_notification?' do
|
|
context 'with WebWidget channel' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_widget, account: account, continuity_via_email: true)) }
|
|
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
|
|
|
|
before do
|
|
conversation.contact.update!(email: 'test@example.com')
|
|
end
|
|
|
|
it 'returns true when continuity_via_email is enabled' do
|
|
expect(service.send(:should_send_email_notification?)).to be true
|
|
end
|
|
|
|
context 'when continuity_via_email is disabled' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_widget, account: account, continuity_via_email: false)) }
|
|
|
|
it 'returns false' do
|
|
expect(service.send(:should_send_email_notification?)).to be false
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'with API channel' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_api, account: account)) }
|
|
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
|
|
|
|
before do
|
|
conversation.contact.update!(email: 'test@example.com')
|
|
allow(account).to receive(:feature_enabled?).and_return(false)
|
|
allow(account).to receive(:feature_enabled?).with('email_continuity_on_api_channel').and_return(true)
|
|
end
|
|
|
|
it 'returns true when email_continuity_on_api_channel feature is enabled' do
|
|
expect(service.send(:should_send_email_notification?)).to be true
|
|
end
|
|
|
|
context 'when email_continuity_on_api_channel feature is disabled' do
|
|
before do
|
|
allow(account).to receive(:feature_enabled?).and_return(false)
|
|
allow(account).to receive(:feature_enabled?).with('email_continuity_on_api_channel').and_return(false)
|
|
end
|
|
|
|
it 'returns false' do
|
|
expect(service.send(:should_send_email_notification?)).to be false
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'with other channels' do
|
|
let(:inbox) { create(:inbox, account: account, channel: create(:channel_email, account: account)) }
|
|
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
|
|
|
|
before do
|
|
conversation.contact.update!(email: 'test@example.com')
|
|
end
|
|
|
|
it 'returns false' do
|
|
expect(service.send(:should_send_email_notification?)).to be false
|
|
end
|
|
end
|
|
end
|
|
end
|