2b37fef0e0
Fixes company-contact name drift when a company is renamed or deleted. Closes: N/A ## Why Contacts keep a denormalized `additional_attributes.company_name` for display and filtering. Company rename/delete flows could leave that copied value stale even though the actual `company_id` relationship changed. ## What changed - Enqueues an async company contact-name sync job when a company name changes. - Moves company deletion into `Companies::DeleteJob`. - The delete job unlinks linked contacts, clears only the copied `company_name`, and then deletes the company. - Uses bulk JSON updates for the cleanup path so contact records are not saved, which avoids contact update callbacks, webhook dispatch, and automation side effects. ## How to test - Link a contact to a company, rename the company, and confirm the contact company name updates after the job runs. - Delete a company with linked contacts and confirm the delete job removes the company, unassigns linked contacts, and preserves other contact additional attributes. --------- Co-authored-by: Sony Mathew <sony@chatwoot.com> Co-authored-by: Sony Mathew <2040199+sony-mathew@users.noreply.github.com>
412 lines
16 KiB
Ruby
412 lines
16 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe 'Companies API', type: :request do
|
|
let(:account) { create(:account) }
|
|
|
|
before { account.enable_features!(:companies) }
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/companies' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/companies"
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
let!(:company1) { create(:company, name: 'Company 1', account: account) }
|
|
let!(:company2) { create(:company, account: account) }
|
|
|
|
it 'returns all companies' do
|
|
get "/api/v1/accounts/#{account.id}/companies",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload'].size).to eq(2)
|
|
expect(response_body['payload'].map { |c| c['name'] }).to contain_exactly(company1.name, company2.name)
|
|
end
|
|
|
|
it 'returns companies with pagination' do
|
|
create_list(:company, 30, account: account)
|
|
|
|
get "/api/v1/accounts/#{account.id}/companies",
|
|
params: { page: 1 },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload'].size).to eq(25)
|
|
expect(response_body['meta']['total_count']).to eq(32)
|
|
expect(response_body['meta']['page']).to eq(1)
|
|
end
|
|
|
|
it 'returns second page of companies' do
|
|
create_list(:company, 30, account: account)
|
|
get "/api/v1/accounts/#{account.id}/companies",
|
|
params: { page: 2 },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload'].size).to eq(7)
|
|
expect(response_body['meta']['total_count']).to eq(32)
|
|
expect(response_body['meta']['page']).to eq(2)
|
|
end
|
|
|
|
it 'returns companies with contacts_count' do
|
|
company_with_contacts = create(:company, name: 'Company With Contacts', account: account)
|
|
create_list(:contact, 5, company: company_with_contacts, account: account)
|
|
|
|
get "/api/v1/accounts/#{account.id}/companies",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
company_data = response_body['payload'].find { |c| c['id'] == company_with_contacts.id }
|
|
expect(company_data['contacts_count']).to eq(5)
|
|
end
|
|
|
|
it 'does not return companies from other accounts' do
|
|
other_account = create(:account)
|
|
create(:company, name: 'Other Account Company', account: other_account)
|
|
create(:company, name: 'My Company', account: account)
|
|
get "/api/v1/accounts/#{account.id}/companies",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload'].size).to eq(3)
|
|
expect(response_body['payload'].map { |c| c['name'] }).not_to include('Other Account Company')
|
|
end
|
|
|
|
it 'sorts companies by contacts_count in ascending order' do
|
|
company_with_5 = create(:company, name: 'Company with 5', account: account)
|
|
company_with_2 = create(:company, name: 'Company with 2', account: account)
|
|
company_with_10 = create(:company, name: 'Company with 10', account: account)
|
|
create_list(:contact, 5, company: company_with_5, account: account)
|
|
create_list(:contact, 2, company: company_with_2, account: account)
|
|
create_list(:contact, 10, company: company_with_10, account: account)
|
|
|
|
get "/api/v1/accounts/#{account.id}/companies",
|
|
params: { sort: 'contacts_count' },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
company_ids = response_body['payload'].map { |c| c['id'] }
|
|
|
|
expect(company_ids.index(company_with_2.id)).to be < company_ids.index(company_with_5.id)
|
|
expect(company_ids.index(company_with_5.id)).to be < company_ids.index(company_with_10.id)
|
|
end
|
|
|
|
it 'sorts companies by contacts_count in descending order' do
|
|
company_with_5 = create(:company, name: 'Company with 5', account: account)
|
|
company_with_2 = create(:company, name: 'Company with 2', account: account)
|
|
company_with_10 = create(:company, name: 'Company with 10', account: account)
|
|
create_list(:contact, 5, company: company_with_5, account: account)
|
|
create_list(:contact, 2, company: company_with_2, account: account)
|
|
create_list(:contact, 10, company: company_with_10, account: account)
|
|
|
|
get "/api/v1/accounts/#{account.id}/companies",
|
|
params: { sort: '-contacts_count' },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
company_ids = response_body['payload'].map { |c| c['id'] }
|
|
|
|
expect(company_ids.index(company_with_10.id)).to be < company_ids.index(company_with_5.id)
|
|
expect(company_ids.index(company_with_5.id)).to be < company_ids.index(company_with_2.id)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/companies/search' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/companies/search"
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
|
|
it 'returns error when q parameter is missing' do
|
|
get "/api/v1/accounts/#{account.id}/companies/search",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
expect(response.parsed_body['error']).to eq('Specify search string with parameter q')
|
|
end
|
|
|
|
it 'searches companies by name' do
|
|
create(:company, name: 'Acme Corp', domain: 'acme.com', account: account)
|
|
create(:company, name: 'Tech Solutions', domain: 'tech.com', account: account)
|
|
create(:company, name: 'Global Inc', domain: 'global.com', account: account)
|
|
|
|
get "/api/v1/accounts/#{account.id}/companies/search",
|
|
params: { q: 'tech' },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload'].size).to eq(1)
|
|
expect(response_body['payload'].first['name']).to eq('Tech Solutions')
|
|
end
|
|
|
|
it 'searches companies by domain' do
|
|
create(:company, name: 'Acme Corp', domain: 'acme.com', account: account)
|
|
create(:company, name: 'Tech Solutions', domain: 'tech.com', account: account)
|
|
create(:company, name: 'Global Inc', domain: 'global.com', account: account)
|
|
|
|
get "/api/v1/accounts/#{account.id}/companies/search",
|
|
params: { q: 'acme.com' },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload'].size).to eq(1)
|
|
expect(response_body['payload'].first['domain']).to eq('acme.com')
|
|
end
|
|
|
|
it 'search is case insensitive' do
|
|
create(:company, name: 'Acme Corp', domain: 'acme.com', account: account)
|
|
get "/api/v1/accounts/#{account.id}/companies/search",
|
|
params: { q: 'ACME' },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
|
|
expect(response_body['payload'].size).to eq(1)
|
|
end
|
|
|
|
it 'returns empty array when no companies match search' do
|
|
create(:company, name: 'Acme Corp', domain: 'acme.com', account: account)
|
|
get "/api/v1/accounts/#{account.id}/companies/search",
|
|
params: { q: 'nonexistent' },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload'].size).to eq(0)
|
|
expect(response_body['meta']['total_count']).to eq(0)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/companies/{id}' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
company = create(:company, account: account)
|
|
get "/api/v1/accounts/#{account.id}/companies/#{company.id}"
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
let(:company) { create(:company, account: account) }
|
|
|
|
it 'returns the company' do
|
|
get "/api/v1/accounts/#{account.id}/companies/#{company.id}",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload']['name']).to eq(company.name)
|
|
expect(response_body['payload']['id']).to eq(company.id)
|
|
end
|
|
|
|
it 'returns company custom attributes' do
|
|
company.update!(custom_attributes: { 'plan' => 'enterprise' })
|
|
|
|
get "/api/v1/accounts/#{account.id}/companies/#{company.id}",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(response.parsed_body['payload']['custom_attributes']).to eq('plan' => 'enterprise')
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'POST /api/v1/accounts/{account.id}/companies' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
post "/api/v1/accounts/#{account.id}/companies"
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
let(:valid_params) do
|
|
{
|
|
company: {
|
|
name: 'New Company',
|
|
domain: 'newcompany.com',
|
|
description: 'A new company'
|
|
}
|
|
}
|
|
end
|
|
|
|
it 'creates a new company' do
|
|
expect do
|
|
post "/api/v1/accounts/#{account.id}/companies",
|
|
params: valid_params,
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
end.to change(Company, :count).by(1)
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload']['name']).to eq('New Company')
|
|
expect(response_body['payload']['domain']).to eq('newcompany.com')
|
|
end
|
|
|
|
it 'returns error for invalid params' do
|
|
invalid_params = { company: { name: '' } }
|
|
|
|
post "/api/v1/accounts/#{account.id}/companies",
|
|
params: invalid_params,
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'PATCH /api/v1/accounts/{account.id}/companies/{id}' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
company = create(:company, account: account)
|
|
patch "/api/v1/accounts/#{account.id}/companies/#{company.id}"
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
let(:company) { create(:company, account: account) }
|
|
let(:update_params) do
|
|
{
|
|
company: {
|
|
name: 'Updated Company Name',
|
|
domain: 'updated.com'
|
|
}
|
|
}
|
|
end
|
|
|
|
it 'updates the company' do
|
|
patch "/api/v1/accounts/#{account.id}/companies/#{company.id}",
|
|
params: update_params,
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
response_body = response.parsed_body
|
|
expect(response_body['payload']['name']).to eq('Updated Company Name')
|
|
expect(response_body['payload']['domain']).to eq('updated.com')
|
|
end
|
|
|
|
it 'merges custom attributes without removing existing attributes' do
|
|
company.update!(custom_attributes: { 'plan' => 'startup', 'region' => 'us' })
|
|
|
|
patch "/api/v1/accounts/#{account.id}/companies/#{company.id}",
|
|
params: { company: { custom_attributes: { 'plan' => 'enterprise' } } },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(company.reload.custom_attributes).to eq('plan' => 'enterprise', 'region' => 'us')
|
|
expect(response.parsed_body['payload']['custom_attributes']).to eq('plan' => 'enterprise', 'region' => 'us')
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'POST /api/v1/accounts/{account.id}/companies/{id}/destroy_custom_attributes' do
|
|
let(:company) { create(:company, account: account, custom_attributes: { 'plan' => 'enterprise', 'region' => 'us' }) }
|
|
|
|
context 'when it is an authenticated user' do
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
|
|
it 'removes selected company custom attributes' do
|
|
post "/api/v1/accounts/#{account.id}/companies/#{company.id}/destroy_custom_attributes",
|
|
params: { custom_attributes: ['plan'] },
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(company.reload.custom_attributes).to eq('region' => 'us')
|
|
expect(response.parsed_body['payload']['custom_attributes']).to eq('region' => 'us')
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'DELETE /api/v1/accounts/{account.id}/companies/{id}/avatar' do
|
|
let(:company) { create(:company, account: account) }
|
|
|
|
context 'when it is an authenticated administrator' do
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
|
|
before do
|
|
company.avatar.attach(io: Rails.root.join('spec/assets/avatar.png').open, filename: 'avatar.png', content_type: 'image/png')
|
|
end
|
|
|
|
it 'deletes the company avatar' do
|
|
delete "/api/v1/accounts/#{account.id}/companies/#{company.id}/avatar",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect { company.avatar.attachment.reload }.to raise_error(ActiveRecord::RecordNotFound)
|
|
expect(response.parsed_body['payload']['avatar_url']).to be_blank
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'DELETE /api/v1/accounts/{account.id}/companies/{id}' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
company = create(:company, account: account)
|
|
delete "/api/v1/accounts/#{account.id}/companies/#{company.id}"
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated administrator' do
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
let(:company) { create(:company, account: account) }
|
|
|
|
it 'enqueues company deletion' do
|
|
expect do
|
|
delete "/api/v1/accounts/#{account.id}/companies/#{company.id}",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
end.to have_enqueued_job(Companies::DeleteJob).with(company_id: company.id)
|
|
|
|
expect(response).to have_http_status(:ok)
|
|
end
|
|
end
|
|
|
|
context 'when it is a regular agent' do
|
|
let(:agent) { create(:user, account: account, role: :agent) }
|
|
let(:company) { create(:company, account: account) }
|
|
|
|
it 'returns unauthorized' do
|
|
delete "/api/v1/accounts/#{account.id}/companies/#{company.id}",
|
|
headers: agent.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
end
|
|
end
|