mirror of
				https://github.com/lingble/chatwoot.git
				synced 2025-10-31 19:17:48 +00:00 
			
		
		
		
	 341487b93e
			
		
	
	341487b93e
	
	
	
		
			
			## 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>
		
			
				
	
	
		
			327 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Ruby
		
	
	
	
	
	
			
		
		
	
	
			327 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Ruby
		
	
	
	
	
	
| require 'rails_helper'
 | |
| 
 | |
| RSpec.describe 'Assignment Policies API', type: :request do
 | |
|   let(:account) { create(:account) }
 | |
| 
 | |
|   describe 'GET /api/v1/accounts/{account.id}/assignment_policies' do
 | |
|     context 'when it is an unauthenticated user' do
 | |
|       it 'returns unauthorized' do
 | |
|         get "/api/v1/accounts/#{account.id}/assignment_policies"
 | |
|         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) }
 | |
| 
 | |
|       before do
 | |
|         create_list(:assignment_policy, 3, account: account)
 | |
|       end
 | |
| 
 | |
|       it 'returns all assignment policies for the account' do
 | |
|         get "/api/v1/accounts/#{account.id}/assignment_policies",
 | |
|             headers: admin.create_new_auth_token,
 | |
|             as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:success)
 | |
|         json_response = response.parsed_body
 | |
|         expect(json_response.length).to eq(3)
 | |
|         expect(json_response.first.keys).to include('id', 'name', 'description')
 | |
|       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}/assignment_policies",
 | |
|             headers: agent.create_new_auth_token,
 | |
|             as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:unauthorized)
 | |
|       end
 | |
|     end
 | |
|   end
 | |
| 
 | |
|   describe 'GET /api/v1/accounts/{account.id}/assignment_policies/:id' do
 | |
|     let(:assignment_policy) { create(:assignment_policy, account: account) }
 | |
| 
 | |
|     context 'when it is an unauthenticated user' do
 | |
|       it 'returns unauthorized' do
 | |
|         get "/api/v1/accounts/#{account.id}/assignment_policies/#{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 'returns the assignment policy' do
 | |
|         get "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|             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
 | |
| 
 | |
|       it 'returns not found for non-existent policy' do
 | |
|         get "/api/v1/accounts/#{account.id}/assignment_policies/999999",
 | |
|             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
 | |
|         get "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|             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}/assignment_policies' do
 | |
|     let(:valid_params) do
 | |
|       {
 | |
|         assignment_policy: {
 | |
|           name: 'New Assignment Policy',
 | |
|           description: 'Policy for new team',
 | |
|           conversation_priority: 'longest_waiting',
 | |
|           fair_distribution_limit: 15,
 | |
|           enabled: true
 | |
|         }
 | |
|       }
 | |
|     end
 | |
| 
 | |
|     context 'when it is an unauthenticated user' do
 | |
|       it 'returns unauthorized' do
 | |
|         post "/api/v1/accounts/#{account.id}/assignment_policies", params: valid_params
 | |
|         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 'creates a new assignment policy' do
 | |
|         expect do
 | |
|           post "/api/v1/accounts/#{account.id}/assignment_policies",
 | |
|                headers: admin.create_new_auth_token,
 | |
|                params: valid_params,
 | |
|                as: :json
 | |
|         end.to change(AssignmentPolicy, :count).by(1)
 | |
| 
 | |
|         expect(response).to have_http_status(:success)
 | |
|         json_response = response.parsed_body
 | |
|         expect(json_response['name']).to eq('New Assignment Policy')
 | |
|         expect(json_response['conversation_priority']).to eq('longest_waiting')
 | |
|       end
 | |
| 
 | |
|       it 'creates policy with minimal required params' do
 | |
|         minimal_params = { assignment_policy: { name: 'Minimal Policy' } }
 | |
| 
 | |
|         expect do
 | |
|           post "/api/v1/accounts/#{account.id}/assignment_policies",
 | |
|                headers: admin.create_new_auth_token,
 | |
|                params: minimal_params,
 | |
|                as: :json
 | |
|         end.to change(AssignmentPolicy, :count).by(1)
 | |
| 
 | |
|         expect(response).to have_http_status(:success)
 | |
|       end
 | |
| 
 | |
|       it 'prevents duplicate policy names within account' do
 | |
|         create(:assignment_policy, account: account, name: 'Duplicate Policy')
 | |
|         duplicate_params = { assignment_policy: { name: 'Duplicate Policy' } }
 | |
| 
 | |
|         expect do
 | |
|           post "/api/v1/accounts/#{account.id}/assignment_policies",
 | |
|                headers: admin.create_new_auth_token,
 | |
|                params: duplicate_params,
 | |
|                as: :json
 | |
|         end.not_to change(AssignmentPolicy, :count)
 | |
| 
 | |
|         expect(response).to have_http_status(:unprocessable_entity)
 | |
|       end
 | |
| 
 | |
|       it 'validates required fields' do
 | |
|         invalid_params = { assignment_policy: { name: '' } }
 | |
| 
 | |
|         post "/api/v1/accounts/#{account.id}/assignment_policies",
 | |
|              headers: admin.create_new_auth_token,
 | |
|              params: invalid_params,
 | |
|              as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:unprocessable_entity)
 | |
|       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}/assignment_policies",
 | |
|              headers: agent.create_new_auth_token,
 | |
|              params: valid_params,
 | |
|              as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:unauthorized)
 | |
|       end
 | |
|     end
 | |
|   end
 | |
| 
 | |
|   describe 'PUT /api/v1/accounts/{account.id}/assignment_policies/:id' do
 | |
|     let(:assignment_policy) { create(:assignment_policy, account: account, name: 'Original Policy') }
 | |
|     let(:update_params) do
 | |
|       {
 | |
|         assignment_policy: {
 | |
|           name: 'Updated Policy',
 | |
|           description: 'Updated description',
 | |
|           fair_distribution_limit: 20
 | |
|         }
 | |
|       }
 | |
|     end
 | |
| 
 | |
|     context 'when it is an unauthenticated user' do
 | |
|       it 'returns unauthorized' do
 | |
|         put "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|             params: update_params
 | |
| 
 | |
|         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 'updates the assignment policy' do
 | |
|         put "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|             headers: admin.create_new_auth_token,
 | |
|             params: update_params,
 | |
|             as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:success)
 | |
|         assignment_policy.reload
 | |
|         expect(assignment_policy.name).to eq('Updated Policy')
 | |
|         expect(assignment_policy.fair_distribution_limit).to eq(20)
 | |
|       end
 | |
| 
 | |
|       it 'allows partial updates' do
 | |
|         partial_params = { assignment_policy: { enabled: false } }
 | |
| 
 | |
|         put "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|             headers: admin.create_new_auth_token,
 | |
|             params: partial_params,
 | |
|             as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:success)
 | |
|         expect(assignment_policy.reload.enabled).to be(false)
 | |
|         expect(assignment_policy.name).to eq('Original Policy') # unchanged
 | |
|       end
 | |
| 
 | |
|       it 'prevents duplicate names during update' do
 | |
|         create(:assignment_policy, account: account, name: 'Existing Policy')
 | |
|         duplicate_params = { assignment_policy: { name: 'Existing Policy' } }
 | |
| 
 | |
|         put "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|             headers: admin.create_new_auth_token,
 | |
|             params: duplicate_params,
 | |
|             as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:unprocessable_entity)
 | |
|       end
 | |
| 
 | |
|       it 'returns not found for non-existent policy' do
 | |
|         put "/api/v1/accounts/#{account.id}/assignment_policies/999999",
 | |
|             headers: admin.create_new_auth_token,
 | |
|             params: update_params,
 | |
|             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
 | |
|         put "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|             headers: agent.create_new_auth_token,
 | |
|             params: update_params,
 | |
|             as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:unauthorized)
 | |
|       end
 | |
|     end
 | |
|   end
 | |
| 
 | |
|   describe 'DELETE /api/v1/accounts/{account.id}/assignment_policies/:id' do
 | |
|     let(:assignment_policy) { create(:assignment_policy, account: account) }
 | |
| 
 | |
|     context 'when it is an unauthenticated user' do
 | |
|       it 'returns unauthorized' do
 | |
|         delete "/api/v1/accounts/#{account.id}/assignment_policies/#{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 'deletes the assignment policy' do
 | |
|         assignment_policy # create it first
 | |
| 
 | |
|         expect do
 | |
|           delete "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|                  headers: admin.create_new_auth_token,
 | |
|                  as: :json
 | |
|         end.to change(AssignmentPolicy, :count).by(-1)
 | |
| 
 | |
|         expect(response).to have_http_status(:ok)
 | |
|       end
 | |
| 
 | |
|       it 'cascades deletion to associated inbox assignment policies' do
 | |
|         inbox = create(:inbox, account: account)
 | |
|         create(:inbox_assignment_policy, inbox: inbox, assignment_policy: assignment_policy)
 | |
| 
 | |
|         expect do
 | |
|           delete "/api/v1/accounts/#{account.id}/assignment_policies/#{assignment_policy.id}",
 | |
|                  headers: admin.create_new_auth_token,
 | |
|                  as: :json
 | |
|         end.to change(InboxAssignmentPolicy, :count).by(-1)
 | |
| 
 | |
|         expect(response).to have_http_status(:ok)
 | |
|       end
 | |
| 
 | |
|       it 'returns not found for non-existent policy' do
 | |
|         delete "/api/v1/accounts/#{account.id}/assignment_policies/999999",
 | |
|                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}/assignment_policies/#{assignment_policy.id}",
 | |
|                headers: agent.create_new_auth_token,
 | |
|                as: :json
 | |
| 
 | |
|         expect(response).to have_http_status(:unauthorized)
 | |
|       end
 | |
|     end
 | |
|   end
 | |
| end
 |