## Linear Link ## Description This PR introduces a new robust auto-assignment system for conversations in Chatwoot. The system replaces the existing round-robin assignment with a more sophisticated service-based architecture that supports multiple assignment strategies, rate limiting, and Enterprise features like capacity-based assignment and balanced distribution. ## Type of change - [ ] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? - Unit test cases - Test conversations getting assigned on status change to open - Test the job directly via rails console ## Checklist: - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Adds a new service-based auto-assignment system with scheduled jobs, rate limiting, enterprise capacity/balanced selection, and wiring via inbox/handler; includes Redis helpers and comprehensive tests. > > - **Auto-assignment v2 (core services)**: > - Add `AutoAssignment::AssignmentService` with bulk assignment, configurable conversation priority, RR selection, and per-agent rate limiting via `AutoAssignment::RateLimiter`. > - Add `AutoAssignment::RoundRobinSelector` for agent selection. > - **Jobs & scheduling**: > - Add `AutoAssignment::AssignmentJob` (per-inbox bulk assign; env-based limit) and `AutoAssignment::PeriodicAssignmentJob` (batch over accounts/inboxes). > - Schedule periodic run in `config/schedule.yml` (`periodic_assignment_job`). > - **Model/concerns wiring**: > - Include `InboxAgentAvailability` in `Inbox`; add `Inbox#auto_assignment_v2_enabled?`. > - Update `AutoAssignmentHandler` to trigger v2 job when `auto_assignment_v2_enabled?`, else fallback to legacy. > - **Enterprise extensions**: > - Add `Enterprise::InboxAgentAvailability` (capacity-aware filtering) and `Enterprise::Concerns::Inbox` association `inbox_capacity_limits`. > - Extend service via `Enterprise::AutoAssignment::AssignmentService` (policy-driven config, capacity filtering, exclusion rules) and add selectors/services: `BalancedSelector`, `CapacityService`. > - **Infrastructure**: > - Enhance `Redis::Alfred` with `expire`, key scan/count, and extended ZSET helpers (`zadd`, `zcount`, `zcard`, `zrangebyscore`). > - **Tests**: > - Add specs for jobs, core service, rate limiter, RR selector, and enterprise features (capacity, balanced selection, exclusions). > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 0ebe187c8aea73765b0122a44b18d6f465c2477f. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com> Co-authored-by: Shivam Mishra <scm.mymail@gmail.com>
124 lines
4.9 KiB
Ruby
124 lines
4.9 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe AutoAssignment::PeriodicAssignmentJob, type: :job do
|
|
let(:account) { create(:account) }
|
|
let(:inbox) { create(:inbox, account: account, enable_auto_assignment: true) }
|
|
let(:assignment_policy) { create(:assignment_policy, account: account) }
|
|
let(:inbox_assignment_policy) { create(:inbox_assignment_policy, inbox: inbox, assignment_policy: assignment_policy) }
|
|
let(:agent) { create(:user, account: account, role: :agent) }
|
|
|
|
before do
|
|
create(:inbox_member, inbox: inbox, user: agent)
|
|
end
|
|
|
|
describe '#perform' do
|
|
context 'when account has assignment_v2 feature enabled' do
|
|
before do
|
|
allow(account).to receive(:feature_enabled?).with('assignment_v2').and_return(true)
|
|
allow(Account).to receive(:find_in_batches).and_yield([account])
|
|
end
|
|
|
|
context 'when inbox has auto_assignment_v2 enabled' do
|
|
before do
|
|
allow(inbox).to receive(:auto_assignment_v2_enabled?).and_return(true)
|
|
inbox_relation = instance_double(ActiveRecord::Relation)
|
|
allow(account).to receive(:inboxes).and_return(inbox_relation)
|
|
allow(inbox_relation).to receive(:joins).with(:assignment_policy).and_return(inbox_relation)
|
|
allow(inbox_relation).to receive(:find_in_batches).and_yield([inbox])
|
|
end
|
|
|
|
it 'queues assignment job for eligible inboxes' do
|
|
inbox_assignment_policy # ensure it exists
|
|
expect(AutoAssignment::AssignmentJob).to receive(:perform_later).with(inbox_id: inbox.id)
|
|
|
|
described_class.new.perform
|
|
end
|
|
|
|
it 'processes multiple accounts' do
|
|
inbox_assignment_policy # ensure it exists
|
|
account2 = create(:account)
|
|
inbox2 = create(:inbox, account: account2, enable_auto_assignment: true)
|
|
policy2 = create(:assignment_policy, account: account2)
|
|
create(:inbox_assignment_policy, inbox: inbox2, assignment_policy: policy2)
|
|
|
|
allow(account2).to receive(:feature_enabled?).with('assignment_v2').and_return(true)
|
|
allow(inbox2).to receive(:auto_assignment_v2_enabled?).and_return(true)
|
|
|
|
inbox_relation2 = instance_double(ActiveRecord::Relation)
|
|
allow(account2).to receive(:inboxes).and_return(inbox_relation2)
|
|
allow(inbox_relation2).to receive(:joins).with(:assignment_policy).and_return(inbox_relation2)
|
|
allow(inbox_relation2).to receive(:find_in_batches).and_yield([inbox2])
|
|
|
|
allow(Account).to receive(:find_in_batches).and_yield([account]).and_yield([account2])
|
|
|
|
expect(AutoAssignment::AssignmentJob).to receive(:perform_later).with(inbox_id: inbox.id)
|
|
expect(AutoAssignment::AssignmentJob).to receive(:perform_later).with(inbox_id: inbox2.id)
|
|
|
|
described_class.new.perform
|
|
end
|
|
end
|
|
|
|
context 'when inbox does not have auto_assignment_v2 enabled' do
|
|
before do
|
|
allow(inbox).to receive(:auto_assignment_v2_enabled?).and_return(false)
|
|
end
|
|
|
|
it 'does not queue assignment job' do
|
|
expect(AutoAssignment::AssignmentJob).not_to receive(:perform_later)
|
|
|
|
described_class.new.perform
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when account does not have assignment_v2 feature enabled' do
|
|
before do
|
|
allow(account).to receive(:feature_enabled?).with('assignment_v2').and_return(false)
|
|
allow(Account).to receive(:find_in_batches).and_yield([account])
|
|
end
|
|
|
|
it 'does not process the account' do
|
|
expect(AutoAssignment::AssignmentJob).not_to receive(:perform_later)
|
|
|
|
described_class.new.perform
|
|
end
|
|
end
|
|
|
|
context 'with batch processing' do
|
|
it 'processes accounts in batches' do
|
|
accounts = []
|
|
# Create multiple accounts
|
|
5.times do |_i|
|
|
acc = create(:account)
|
|
inb = create(:inbox, account: acc, enable_auto_assignment: true)
|
|
policy = create(:assignment_policy, account: acc)
|
|
create(:inbox_assignment_policy, inbox: inb, assignment_policy: policy)
|
|
allow(acc).to receive(:feature_enabled?).with('assignment_v2').and_return(true)
|
|
allow(inb).to receive(:auto_assignment_v2_enabled?).and_return(true)
|
|
|
|
inbox_relation = instance_double(ActiveRecord::Relation)
|
|
allow(acc).to receive(:inboxes).and_return(inbox_relation)
|
|
allow(inbox_relation).to receive(:joins).with(:assignment_policy).and_return(inbox_relation)
|
|
allow(inbox_relation).to receive(:find_in_batches).and_yield([inb])
|
|
|
|
accounts << acc
|
|
end
|
|
|
|
allow(Account).to receive(:find_in_batches) do |&block|
|
|
accounts.each { |acc| block.call([acc]) }
|
|
end
|
|
|
|
expect(Account).to receive(:find_in_batches).and_call_original
|
|
|
|
described_class.new.perform
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'job configuration' do
|
|
it 'is queued in the scheduled_jobs queue' do
|
|
expect(described_class.queue_name).to eq('scheduled_jobs')
|
|
end
|
|
end
|
|
end
|