c9823d9409
## 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
0ebe187c8a. 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>
86 lines
3.3 KiB
Ruby
86 lines
3.3 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe AutoAssignment::AssignmentJob, type: :job do
|
|
let(:account) { create(:account) }
|
|
let(:inbox) { create(:inbox, account: account, enable_auto_assignment: true) }
|
|
let(:agent) { create(:user, account: account, role: :agent, availability: :online) }
|
|
|
|
before do
|
|
create(:inbox_member, inbox: inbox, user: agent)
|
|
end
|
|
|
|
describe '#perform' do
|
|
context 'when inbox exists' do
|
|
context 'when auto assignment is enabled' do
|
|
it 'calls the assignment service' do
|
|
service = instance_double(AutoAssignment::AssignmentService)
|
|
allow(AutoAssignment::AssignmentService).to receive(:new).with(inbox: inbox).and_return(service)
|
|
expect(service).to receive(:perform_bulk_assignment).with(limit: 100).and_return(5)
|
|
|
|
described_class.new.perform(inbox_id: inbox.id)
|
|
end
|
|
|
|
it 'logs the assignment count' do
|
|
service = instance_double(AutoAssignment::AssignmentService)
|
|
allow(AutoAssignment::AssignmentService).to receive(:new).and_return(service)
|
|
allow(service).to receive(:perform_bulk_assignment).and_return(3)
|
|
|
|
expect(Rails.logger).to receive(:info).with("Assigned 3 conversations for inbox #{inbox.id}")
|
|
|
|
described_class.new.perform(inbox_id: inbox.id)
|
|
end
|
|
|
|
it 'uses custom bulk limit from environment' do
|
|
allow(ENV).to receive(:fetch).with('AUTO_ASSIGNMENT_BULK_LIMIT', 100).and_return('50')
|
|
|
|
service = instance_double(AutoAssignment::AssignmentService)
|
|
allow(AutoAssignment::AssignmentService).to receive(:new).with(inbox: inbox).and_return(service)
|
|
expect(service).to receive(:perform_bulk_assignment).with(limit: 50).and_return(2)
|
|
|
|
described_class.new.perform(inbox_id: inbox.id)
|
|
end
|
|
end
|
|
|
|
context 'when auto assignment is disabled' do
|
|
before { inbox.update!(enable_auto_assignment: false) }
|
|
|
|
it 'calls the service which handles the disabled state' do
|
|
service = instance_double(AutoAssignment::AssignmentService)
|
|
allow(AutoAssignment::AssignmentService).to receive(:new).with(inbox: inbox).and_return(service)
|
|
expect(service).to receive(:perform_bulk_assignment).with(limit: 100).and_return(0)
|
|
|
|
described_class.new.perform(inbox_id: inbox.id)
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when inbox does not exist' do
|
|
it 'returns early without processing' do
|
|
expect(AutoAssignment::AssignmentService).not_to receive(:new)
|
|
|
|
described_class.new.perform(inbox_id: 999_999)
|
|
end
|
|
end
|
|
|
|
context 'when an error occurs' do
|
|
it 'logs the error and re-raises in test environment' do
|
|
service = instance_double(AutoAssignment::AssignmentService)
|
|
allow(AutoAssignment::AssignmentService).to receive(:new).and_return(service)
|
|
allow(service).to receive(:perform_bulk_assignment).and_raise(StandardError, 'Something went wrong')
|
|
|
|
expect(Rails.logger).to receive(:error).with("Bulk assignment failed for inbox #{inbox.id}: Something went wrong")
|
|
|
|
expect do
|
|
described_class.new.perform(inbox_id: inbox.id)
|
|
end.to raise_error(StandardError, 'Something went wrong')
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'job configuration' do
|
|
it 'is queued in the default queue' do
|
|
expect(described_class.queue_name).to eq('default')
|
|
end
|
|
end
|
|
end
|