Sony MathewandGitHub
b8b62ad0f1
## Description Hardens the Captain model override preferences API so account-level overrides follow the same feature-router contract used by runtime LLM calls. The API now permits model and feature keys from `llm.yml`, removes blank model overrides, rejects invalid saved model combinations, and returns each feature's effective model, provider, and source for UI clients. Fixes https://linear.app/chatwoot/issue/CW-7425/test-new-models ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [x] 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? Verified the account preferences API and account model validation behavior for valid overrides, invalid model values, unknown feature keys, blank override removal, and effective model/provider/source payload metadata. - `eval "$(rbenv init -)" && bundle exec rspec spec/controllers/api/v1/accounts/captain/preferences_controller_spec.rb spec/models/account_spec.rb spec/models/concerns/captain_featurable_spec.rb spec/lib/llm/feature_router_spec.rb` - `eval "$(rbenv init -)" && bundle exec rubocop app/controllers/api/v1/accounts/captain/preferences_controller.rb app/models/concerns/account_settings_schema.rb app/models/concerns/captain_featurable.rb spec/controllers/api/v1/accounts/captain/preferences_controller_spec.rb spec/models/account_spec.rb spec/models/concerns/captain_featurable_spec.rb spec/lib/llm/feature_router_spec.rb` - `git diff --check` ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] 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 - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules
235 lines
8.9 KiB
Ruby
235 lines
8.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'rails_helper'
|
|
|
|
RSpec.describe 'Api::V1::Accounts::Captain::Preferences', type: :request do
|
|
let(:account) { create(:account) }
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
let(:agent) { create(:user, account: account, role: :agent) }
|
|
|
|
def json_response
|
|
JSON.parse(response.body, symbolize_names: true)
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/captain/preferences' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an agent' do
|
|
it 'returns captain config' do
|
|
get "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: agent.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response).to have_key(:providers)
|
|
expect(json_response).to have_key(:models)
|
|
expect(json_response).to have_key(:features)
|
|
end
|
|
end
|
|
|
|
context 'when it is an admin' do
|
|
it 'returns captain config' do
|
|
get "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response).to have_key(:providers)
|
|
expect(json_response).to have_key(:models)
|
|
expect(json_response).to have_key(:features)
|
|
end
|
|
|
|
it 'returns effective model provider and source for each feature' do
|
|
account.update!(captain_models: { 'editor' => 'gpt-4.1' })
|
|
|
|
get "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response.dig(:features, :editor)).to include(
|
|
model: 'gpt-4.1',
|
|
selected: 'gpt-4.1',
|
|
provider: 'openai',
|
|
source: 'account_override'
|
|
)
|
|
expect(json_response.dig(:features, :label_suggestion)).to include(
|
|
model: Llm::Models.default_model_for('label_suggestion'),
|
|
selected: Llm::Models.default_model_for('label_suggestion'),
|
|
provider: 'openai',
|
|
source: 'default'
|
|
)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'PUT /api/v1/accounts/{account.id}/captain/preferences' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
params: { captain_models: { editor: 'gpt-4.1-mini' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an agent' do
|
|
it 'returns forbidden' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: agent.create_new_auth_token,
|
|
params: { captain_models: { editor: 'gpt-4.1-mini' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an admin' do
|
|
it 'updates captain_models' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_models: { editor: 'gpt-4.1-mini' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response).to have_key(:providers)
|
|
expect(json_response).to have_key(:models)
|
|
expect(json_response).to have_key(:features)
|
|
expect(account.reload.captain_models['editor']).to eq('gpt-4.1-mini')
|
|
end
|
|
|
|
it 'does not persist unknown captain model feature keys' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_models: { editor: 'gpt-4.1-mini', unknown_feature: 'gpt-4.1' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(account.reload.captain_models).to eq('editor' => 'gpt-4.1-mini')
|
|
end
|
|
|
|
it 'rejects invalid captain model values for the feature' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_models: { label_suggestion: 'gpt-5.1' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
expect(json_response[:message]).to include('not a valid model for label_suggestion')
|
|
expect(account.reload.captain_models).to be_nil
|
|
end
|
|
|
|
it 'removes blank captain model overrides' do
|
|
account.update!(captain_models: { 'editor' => 'gpt-4.1' })
|
|
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_models: { editor: '' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(account.reload.captain_models).to be_nil
|
|
expect(json_response.dig(:features, :editor)).to include(
|
|
selected: Llm::Models.default_model_for('editor'),
|
|
source: 'default'
|
|
)
|
|
end
|
|
|
|
it 'updates captain_models for document FAQ generation' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_models: { document_faq_generation: 'gpt-5.2' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response.dig(:features, :document_faq_generation, :selected)).to eq('gpt-5.2')
|
|
expect(account.reload.captain_models['document_faq_generation']).to eq('gpt-5.2')
|
|
end
|
|
|
|
it 'updates captain_models for PDF FAQ generation' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_models: { pdf_faq_generation: 'gpt-5.2' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response.dig(:features, :pdf_faq_generation, :selected)).to eq('gpt-5.2')
|
|
expect(account.reload.captain_models['pdf_faq_generation']).to eq('gpt-5.2')
|
|
end
|
|
|
|
it 'updates captain_features' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_features: { editor: true } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response).to have_key(:providers)
|
|
expect(json_response).to have_key(:models)
|
|
expect(json_response).to have_key(:features)
|
|
expect(account.reload.captain_features['editor']).to be true
|
|
end
|
|
|
|
it 'merges with existing captain_models' do
|
|
account.update!(captain_models: { 'editor' => 'gpt-4.1-mini', 'assistant' => 'gpt-5.1' })
|
|
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_models: { editor: 'gpt-4.1' } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response).to have_key(:providers)
|
|
expect(json_response).to have_key(:models)
|
|
expect(json_response).to have_key(:features)
|
|
models = account.reload.captain_models
|
|
expect(models['editor']).to eq('gpt-4.1')
|
|
expect(models['assistant']).to eq('gpt-5.1') # Preserved
|
|
end
|
|
|
|
it 'merges with existing captain_features' do
|
|
account.update!(captain_features: { 'editor' => true, 'assistant' => false })
|
|
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: { captain_features: { editor: false } },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response).to have_key(:providers)
|
|
expect(json_response).to have_key(:models)
|
|
expect(json_response).to have_key(:features)
|
|
features = account.reload.captain_features
|
|
expect(features['editor']).to be false
|
|
expect(features['assistant']).to be false # Preserved
|
|
end
|
|
|
|
it 'updates both models and features in single request' do
|
|
put "/api/v1/accounts/#{account.id}/captain/preferences",
|
|
headers: admin.create_new_auth_token,
|
|
params: {
|
|
captain_models: { editor: 'gpt-4.1-mini' },
|
|
captain_features: { editor: true }
|
|
},
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(json_response).to have_key(:providers)
|
|
expect(json_response).to have_key(:models)
|
|
expect(json_response).to have_key(:features)
|
|
account.reload
|
|
expect(account.captain_models['editor']).to eq('gpt-4.1-mini')
|
|
expect(account.captain_features['editor']).to be true
|
|
end
|
|
end
|
|
end
|
|
end
|