From 005a22fd69ffb5a318756eae06a732f77d1ae3f7 Mon Sep 17 00:00:00 2001 From: Vinay Keerthi <11478411+stonecharioteer@users.noreply.github.com> Date: Sat, 10 Jan 2026 04:50:08 +0530 Subject: [PATCH] feat: Add sorting by contacts count to companies list (#13012) ## Description Adds the ability to sort companies by the number of contacts they have (contacts_count) in ascending or descending order. This is part of the Chatwoot 5.0 release requirements for the companies feature. The implementation uses a scope-based approach consistent with other sorting implementations in the codebase (e.g., contacts sorting by last_activity_at). ## Type of change - [x] New feature (non-breaking change which adds functionality) ## Available Sorting Options After this change, the Companies API supports the following sorting options: | Sort Field | Type | Ascending | Descending | |------------|------|-----------|------------| | `name` | string | `?sort=name` | `?sort=-name` | | `domain` | string | `?sort=domain` | `?sort=-domain` | | `created_at` | datetime | `?sort=created_at` | `?sort=-created_at` | | `contacts_count` | integer (scope) | `?sort=contacts_count` | `?sort=-contacts_count` | **Note:** Prefix with `-` for descending order. Companies with NULL contacts_count will appear last (NULLS LAST). ## CURL Examples **Sort by contacts count (ascending):** ```bash curl -X GET 'https://app.chatwoot.com/api/v1/accounts/{account_id}/companies?sort=contacts_count' \ -H 'api_access_token: YOUR_API_TOKEN' ``` **Sort by contacts count (descending):** ```bash curl -X GET 'https://app.chatwoot.com/api/v1/accounts/{account_id}/companies?sort=-contacts_count' \ -H 'api_access_token: YOUR_API_TOKEN' ``` **Sort by name (ascending):** ```bash curl -X GET 'https://app.chatwoot.com/api/v1/accounts/{account_id}/companies?sort=name' \ -H 'api_access_token: YOUR_API_TOKEN' ``` **Sort by created_at (descending):** ```bash curl -X GET 'https://app.chatwoot.com/api/v1/accounts/{account_id}/companies?sort=-created_at' \ -H 'api_access_token: YOUR_API_TOKEN' ``` **With pagination:** ```bash curl -X GET 'https://app.chatwoot.com/api/v1/accounts/{account_id}/companies?sort=-contacts_count&page=2' \ -H 'api_access_token: YOUR_API_TOKEN' ``` ## How Has This Been Tested? - Added RSpec tests for both ascending and descending sort - All 24 existing specs pass - Manually tested the sorting functionality with test data **Test configuration:** - Ruby 3.4.4 - Rails 7.1.5.2 - PostgreSQL (test database) **To reproduce:** 1. Run `bundle exec rspec spec/enterprise/controllers/api/v1/accounts/companies_controller_spec.rb` 2. All tests should pass (24 examples, 0 failures) ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] 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 ## Technical Details **Backend changes:** - Controller: Added `sort_on :contacts_count` with scope-based sorting - Model: Added `order_on_contacts_count` scope using `Arel::Nodes::SqlLiteral` and `sanitize_sql_for_order` with `NULLS LAST` for consistent NULL handling - Specs: Added 2 new tests for ascending/descending sort validation **Files changed:** - `enterprise/app/controllers/api/v1/accounts/companies_controller.rb` - `enterprise/app/models/company.rb` - `spec/enterprise/controllers/api/v1/accounts/companies_controller_spec.rb` **Note:** This PR only includes the backend implementation. Frontend changes (sort menu UI + i18n) will follow in a separate commit. --------- Co-authored-by: Muhsin Keloth Co-authored-by: iamsivin Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com> Co-authored-by: Pranav --- .../components/CompanySortMenu.vue | 4 ++ .../dashboard/i18n/locale/en/companies.json | 3 +- .../companies/pages/CompaniesIndex.vue | 4 +- .../api/v1/accounts/companies_controller.rb | 1 + enterprise/app/models/company.rb | 7 ++++ .../v1/accounts/companies_controller_spec.rb | 40 +++++++++++++++++++ 6 files changed, 56 insertions(+), 3 deletions(-) diff --git a/app/javascript/dashboard/components-next/Companies/CompaniesHeader/components/CompanySortMenu.vue b/app/javascript/dashboard/components-next/Companies/CompaniesHeader/components/CompanySortMenu.vue index 768123b9f..8cf75d555 100644 --- a/app/javascript/dashboard/components-next/Companies/CompaniesHeader/components/CompanySortMenu.vue +++ b/app/javascript/dashboard/components-next/Companies/CompaniesHeader/components/CompanySortMenu.vue @@ -35,6 +35,10 @@ const sortMenus = [ label: t('COMPANIES.SORT_BY.OPTIONS.CREATED_AT'), value: 'created_at', }, + { + label: t('COMPANIES.SORT_BY.OPTIONS.CONTACTS_COUNT'), + value: 'contacts_count', + }, ]; const orderingMenus = [ diff --git a/app/javascript/dashboard/i18n/locale/en/companies.json b/app/javascript/dashboard/i18n/locale/en/companies.json index 86190831b..0d64a4abd 100644 --- a/app/javascript/dashboard/i18n/locale/en/companies.json +++ b/app/javascript/dashboard/i18n/locale/en/companies.json @@ -6,7 +6,8 @@ "OPTIONS": { "NAME": "Name", "DOMAIN": "Domain", - "CREATED_AT": "Created at" + "CREATED_AT": "Created at", + "CONTACTS_COUNT": "Contacts count" } }, "ORDER": { diff --git a/app/javascript/dashboard/routes/dashboard/companies/pages/CompaniesIndex.vue b/app/javascript/dashboard/routes/dashboard/companies/pages/CompaniesIndex.vue index cab05b8f4..236de594a 100644 --- a/app/javascript/dashboard/routes/dashboard/companies/pages/CompaniesIndex.vue +++ b/app/javascript/dashboard/routes/dashboard/companies/pages/CompaniesIndex.vue @@ -9,7 +9,7 @@ import { useCompaniesStore } from 'dashboard/stores/companies'; import CompaniesListLayout from 'dashboard/components-next/Companies/CompaniesListLayout.vue'; import CompaniesCard from 'dashboard/components-next/Companies/CompaniesCard/CompaniesCard.vue'; -const DEFAULT_SORT_FIELD = 'created_at'; +const DEFAULT_SORT_FIELD = 'name'; const DEBOUNCE_DELAY = 300; const companiesStore = useCompaniesStore(); @@ -37,7 +37,7 @@ const parseSortSettings = (sortString = '') => { }; }; -const { companies_sort_by: companySortBy = `-${DEFAULT_SORT_FIELD}` } = +const { companies_sort_by: companySortBy = DEFAULT_SORT_FIELD } = uiSettings.value ?? {}; const { sort: initialSort, order: initialOrder } = parseSortSettings(companySortBy); diff --git a/enterprise/app/controllers/api/v1/accounts/companies_controller.rb b/enterprise/app/controllers/api/v1/accounts/companies_controller.rb index 86216b03c..3ec547cda 100644 --- a/enterprise/app/controllers/api/v1/accounts/companies_controller.rb +++ b/enterprise/app/controllers/api/v1/accounts/companies_controller.rb @@ -3,6 +3,7 @@ class Api::V1::Accounts::CompaniesController < Api::V1::Accounts::EnterpriseAcco sort_on :name, type: :string sort_on :domain, type: :string sort_on :created_at, type: :datetime + sort_on :contacts_count, internal_name: :order_on_contacts_count, type: :scope, scope_params: [:direction] RESULTS_PER_PAGE = 25 diff --git a/enterprise/app/models/company.rb b/enterprise/app/models/company.rb index 9fa18b8ad..d96344f9b 100644 --- a/enterprise/app/models/company.rb +++ b/enterprise/app/models/company.rb @@ -35,4 +35,11 @@ class Company < ApplicationRecord scope :search_by_name_or_domain, lambda { |query| where('name ILIKE :search OR domain ILIKE :search', search: "%#{query.strip}%") } + scope :order_on_contacts_count, lambda { |direction| + order( + Arel::Nodes::SqlLiteral.new( + sanitize_sql_for_order("\"companies\".\"contacts_count\" #{direction} NULLS LAST") + ) + ) + } end diff --git a/spec/enterprise/controllers/api/v1/accounts/companies_controller_spec.rb b/spec/enterprise/controllers/api/v1/accounts/companies_controller_spec.rb index f5d82310a..3dadcec43 100644 --- a/spec/enterprise/controllers/api/v1/accounts/companies_controller_spec.rb +++ b/spec/enterprise/controllers/api/v1/accounts/companies_controller_spec.rb @@ -81,6 +81,46 @@ RSpec.describe 'Companies API', type: :request do 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