feat: Add assignment policies controllers with jbuilder views (#12199)
## Linear reference: https://linear.app/chatwoot/issue/CW-4649/re-imagine-assignments ## Description This PR introduces the foundation for Assignment V2 system by implementing assignment policies and their association with inboxes. Assignment policies allow configuring how conversations are distributed among agents, with support for different assignment orders (round_robin in community, balanced in enterprise) and conversation prioritization strategies Fixes # (issue) ## Type of change Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected) - [ ] This change requires a documentation update ## How Has This Been Tested? Test Coverage: - Controller specs for assignment policies CRUD operations - Enterprise-specific specs for balanced assignment order - Model specs for community/enterprise separation Manual Testing: 1. Create assignment policy: POST /api/v1/accounts/{id}/assignment_policies 2. List policies: GET /api/v1/accounts/{id}/assignment_policies 3. Assign policy to inbox: POST /api/v1/accounts/{id}/assignment_policies/{id}/inboxes 4. View inbox policy: GET /api/v1/accounts/{id}/inboxes/{id}/assignment_policy 5. Verify community edition ignores "balanced" assignment order 6. Verify enterprise edition supports both "round_robin" and "balanced" - testing the flows after enterprise folder deletion ## 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 --------- Co-authored-by: Pranav <pranavrajs@gmail.com> Co-authored-by: Pranav <pranav@chatwoot.com>
This commit is contained in:
Tanmay Deep Sharma
committed by
GitHub
GitHub
parent
f569ed93ad
commit
341487b93e
@@ -0,0 +1,195 @@
|
||||
require 'rails_helper'
|
||||
|
||||
RSpec.describe 'Inbox Assignment Policies API', type: :request do
|
||||
let(:account) { create(:account) }
|
||||
let(:inbox) { create(:inbox, account: account) }
|
||||
let(:assignment_policy) { create(:assignment_policy, account: account) }
|
||||
|
||||
describe 'GET /api/v1/accounts/{account_id}/inboxes/{inbox_id}/assignment_policy' do
|
||||
context 'when it is an unauthenticated user' do
|
||||
it 'returns unauthorized' do
|
||||
get "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy"
|
||||
expect(response).to have_http_status(:unauthorized)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when it is an authenticated admin' do
|
||||
let(:admin) { create(:user, account: account, role: :administrator) }
|
||||
|
||||
context 'when inbox has an assignment policy' do
|
||||
before do
|
||||
create(:inbox_assignment_policy, inbox: inbox, assignment_policy: assignment_policy)
|
||||
end
|
||||
|
||||
it 'returns the assignment policy for the inbox' do
|
||||
get "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
|
||||
expect(response).to have_http_status(:success)
|
||||
json_response = response.parsed_body
|
||||
expect(json_response['id']).to eq(assignment_policy.id)
|
||||
expect(json_response['name']).to eq(assignment_policy.name)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when inbox has no assignment policy' do
|
||||
it 'returns not found' do
|
||||
get "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
|
||||
expect(response).to have_http_status(:not_found)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when it is an agent' do
|
||||
let(:agent) { create(:user, account: account, role: :agent) }
|
||||
|
||||
it 'returns unauthorized' do
|
||||
get "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
headers: agent.create_new_auth_token,
|
||||
as: :json
|
||||
|
||||
expect(response).to have_http_status(:unauthorized)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe 'POST /api/v1/accounts/{account_id}/inboxes/{inbox_id}/assignment_policy' do
|
||||
context 'when it is an unauthenticated user' do
|
||||
it 'returns unauthorized' do
|
||||
post "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
params: { assignment_policy_id: assignment_policy.id }
|
||||
|
||||
expect(response).to have_http_status(:unauthorized)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when it is an authenticated admin' do
|
||||
let(:admin) { create(:user, account: account, role: :administrator) }
|
||||
|
||||
it 'assigns a policy to the inbox' do
|
||||
expect do
|
||||
post "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
params: { assignment_policy_id: assignment_policy.id },
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
end.to change(InboxAssignmentPolicy, :count).by(1)
|
||||
|
||||
expect(response).to have_http_status(:success)
|
||||
json_response = response.parsed_body
|
||||
expect(json_response['id']).to eq(assignment_policy.id)
|
||||
end
|
||||
|
||||
it 'replaces existing assignment policy for inbox' do
|
||||
other_policy = create(:assignment_policy, account: account)
|
||||
create(:inbox_assignment_policy, inbox: inbox, assignment_policy: other_policy)
|
||||
|
||||
expect do
|
||||
post "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
params: { assignment_policy_id: assignment_policy.id },
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
end.not_to change(InboxAssignmentPolicy, :count)
|
||||
|
||||
expect(response).to have_http_status(:success)
|
||||
expect(inbox.reload.inbox_assignment_policy.assignment_policy).to eq(assignment_policy)
|
||||
end
|
||||
|
||||
it 'returns not found for invalid assignment policy' do
|
||||
post "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
params: { assignment_policy_id: 999_999 },
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
|
||||
expect(response).to have_http_status(:not_found)
|
||||
end
|
||||
|
||||
it 'returns not found for invalid inbox' do
|
||||
post "/api/v1/accounts/#{account.id}/inboxes/999999/assignment_policy",
|
||||
params: { assignment_policy_id: assignment_policy.id },
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
|
||||
expect(response).to have_http_status(:not_found)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when it is an agent' do
|
||||
let(:agent) { create(:user, account: account, role: :agent) }
|
||||
|
||||
it 'returns unauthorized' do
|
||||
post "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
params: { assignment_policy_id: assignment_policy.id },
|
||||
headers: agent.create_new_auth_token,
|
||||
as: :json
|
||||
|
||||
expect(response).to have_http_status(:unauthorized)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe 'DELETE /api/v1/accounts/{account_id}/inboxes/{inbox_id}/assignment_policy' do
|
||||
context 'when it is an unauthenticated user' do
|
||||
it 'returns unauthorized' do
|
||||
delete "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy"
|
||||
expect(response).to have_http_status(:unauthorized)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when it is an authenticated admin' do
|
||||
let(:admin) { create(:user, account: account, role: :administrator) }
|
||||
|
||||
context 'when inbox has an assignment policy' do
|
||||
before do
|
||||
create(:inbox_assignment_policy, inbox: inbox, assignment_policy: assignment_policy)
|
||||
end
|
||||
|
||||
it 'removes the assignment policy from inbox' do
|
||||
expect do
|
||||
delete "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
end.to change(InboxAssignmentPolicy, :count).by(-1)
|
||||
|
||||
expect(response).to have_http_status(:success)
|
||||
expect(inbox.reload.inbox_assignment_policy).to be_nil
|
||||
end
|
||||
end
|
||||
|
||||
context 'when inbox has no assignment policy' do
|
||||
it 'returns error' do
|
||||
expect do
|
||||
delete "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
end.not_to change(InboxAssignmentPolicy, :count)
|
||||
|
||||
expect(response).to have_http_status(:not_found)
|
||||
end
|
||||
end
|
||||
|
||||
it 'returns not found for invalid inbox' do
|
||||
delete "/api/v1/accounts/#{account.id}/inboxes/999999/assignment_policy",
|
||||
headers: admin.create_new_auth_token,
|
||||
as: :json
|
||||
|
||||
expect(response).to have_http_status(:not_found)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when it is an agent' do
|
||||
let(:agent) { create(:user, account: account, role: :agent) }
|
||||
|
||||
it 'returns unauthorized' do
|
||||
delete "/api/v1/accounts/#{account.id}/inboxes/#{inbox.id}/assignment_policy",
|
||||
headers: agent.create_new_auth_token,
|
||||
as: :json
|
||||
|
||||
expect(response).to have_http_status(:unauthorized)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user