Files
leadchat/spec/finders/conversation_finder_spec.rb
Vishnu Narayanan 2441487a76 perf: skip conversation loading in /meta endpoint (#13564)
# Pull Request Template

## Summary
- Adds `perform_meta_only` method to `ConversationFinder` that runs
setup and counts without loading the paginated conversation list
- Updates `/api/v1/conversations/meta` to use `perform_meta_only`
instead of `perform`

## Problem
The `/meta` endpoint calls `ConversationFinder#perform` which:
1. Runs all filters and setup (`set_up`)
2. Computes 3 COUNT queries (`set_count_for_all_conversations`)
3. Filters by assignee type
4. **Builds the full paginated conversation list** with
`.includes(:taggings, :inbox, {assignee: {avatar_attachment: [:blob]}},
{contact: {avatar_attachment: [:blob]}}, :team, :contact_inbox)` +
sorting + pagination

The controller then **discards the conversations** and only uses the
counts:
```ruby
def meta
result = conversation_finder.perform
@conversations_count = result[:count]  # conversations thrown away
end
```

## Type of change

- [x] Performance fix

## How Has This Been Tested?

- [ ] Verify /meta returns correct mine/unassigned/assigned/all counts
- [ ] Verify counts update when switching inbox, team, or status filters
- [ ] Verify conversation list still loads correctly (uses perform, not
affected)
- [ ] Monitor response time reduction for /meta in NewRelic after deploy

## 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 <pranav@chatwoot.com>
2026-02-20 21:20:19 +05:30

234 lines
8.9 KiB
Ruby

require 'rails_helper'
describe ConversationFinder do
subject(:conversation_finder) { described_class.new(user_1, params) }
let!(:account) { create(:account) }
let!(:user_1) { create(:user, account: account) }
let!(:user_2) { create(:user, account: account) }
let!(:admin) { create(:user, account: account, role: :administrator) }
let!(:inbox) { create(:inbox, account: account, enable_auto_assignment: false) }
let!(:contact_inbox) { create(:contact_inbox, inbox: inbox, source_id: 'testing_source_id') }
let!(:restricted_inbox) { create(:inbox, account: account) }
before do
create(:inbox_member, user: user_1, inbox: inbox)
create(:inbox_member, user: user_2, inbox: inbox)
create(:conversation, account: account, inbox: inbox, assignee: user_1)
create(:conversation, account: account, inbox: inbox, assignee: user_1)
create(:conversation, account: account, inbox: inbox, assignee: user_1, status: 'resolved')
create(:conversation, account: account, inbox: inbox, assignee: user_2, contact_inbox: contact_inbox)
# unassigned conversation
create(:conversation, account: account, inbox: inbox)
Current.account = account
end
describe '#perform' do
context 'with status' do
let(:params) { { status: 'open', assignee_type: 'me' } }
it 'filter conversations by status' do
result = conversation_finder.perform
expect(result[:conversations].length).to be 2
end
end
context 'with inbox' do
let!(:restricted_conversation) { create(:conversation, account: account, inbox_id: restricted_inbox.id) }
it 'returns conversation from any inbox if its admin' do
params = { inbox_id: restricted_inbox.id }
result = described_class.new(admin, params).perform
expect(result[:conversations].map(&:id)).to include(restricted_conversation.id)
end
it 'returns conversation from inbox if agent is its member' do
params = { inbox_id: restricted_inbox.id }
create(:inbox_member, user: user_1, inbox: restricted_inbox)
result = described_class.new(user_1, params).perform
expect(result[:conversations].map(&:id)).to include(restricted_conversation.id)
end
it 'does not return conversations from inboxes where agent is not a member' do
params = { inbox_id: restricted_inbox.id }
result = described_class.new(user_1, params).perform
expect(result[:conversations].map(&:id)).not_to include(restricted_conversation.id)
end
it 'returns only the conversations from the inbox if inbox_id filter is passed' do
conversation = create(:conversation, account: account, inbox_id: inbox.id)
params = { inbox_id: restricted_inbox.id }
result = described_class.new(admin, params).perform
conversation_ids = result[:conversations].map(&:id)
expect(conversation_ids).not_to include(conversation.id)
expect(conversation_ids).to include(restricted_conversation.id)
end
end
context 'with assignee_type all' do
let(:params) { { assignee_type: 'all' } }
it 'filter conversations by assignee type all' do
result = conversation_finder.perform
expect(result[:conversations].length).to be 4
end
end
context 'with assignee_type unassigned' do
let(:params) { { assignee_type: 'unassigned' } }
it 'filter conversations by assignee type unassigned' do
result = conversation_finder.perform
expect(result[:conversations].length).to be 1
end
end
context 'with status all' do
let(:params) { { status: 'all' } }
it 'returns all conversations' do
result = conversation_finder.perform
expect(result[:conversations].length).to be 5
end
end
context 'with assignee_type assigned' do
let(:params) { { assignee_type: 'assigned' } }
it 'filter conversations by assignee type assigned' do
result = conversation_finder.perform
expect(result[:conversations].length).to be 3
end
it 'returns the correct meta' do
result = conversation_finder.perform
expect(result[:count]).to eq({
mine_count: 2,
assigned_count: 3,
unassigned_count: 1,
all_count: 4
})
end
end
context 'with team' do
let(:team) { create(:team, account: account) }
let(:params) { { team_id: team.id } }
it 'filter conversations by team' do
create(:conversation, account: account, inbox: inbox, team: team)
result = conversation_finder.perform
expect(result[:conversations].length).to be 1
end
end
context 'with labels' do
let(:params) { { labels: ['resolved'] } }
it 'filter conversations by labels' do
conversation = inbox.conversations.first
conversation.update_labels('resolved')
result = conversation_finder.perform
expect(result[:conversations].length).to be 1
end
end
context 'with source_id' do
let(:params) { { source_id: 'testing_source_id' } }
it 'filter conversations by source id' do
result = conversation_finder.perform
expect(result[:conversations].length).to be 1
end
end
context 'without source' do
let(:params) { {} }
it 'returns conversations with any source' do
result = conversation_finder.perform
expect(result[:conversations].length).to be 4
end
end
context 'with updated_within' do
let(:params) { { updated_within: 20, assignee_type: 'unassigned', sort_by: 'created_at_asc' } }
it 'filters based on params, sort order but returns all conversations without pagination with in time range' do
# value of updated_within is in seconds
# write spec based on that
conversations = create_list(:conversation, 50, account: account,
inbox: inbox, assignee: nil,
updated_at: Time.now.utc - 30.seconds,
created_at: Time.now.utc - 30.seconds)
# update updated_at of 27 conversations to be with in 20 seconds
conversations[0..27].each do |conversation|
conversation.update(updated_at: Time.now.utc - 10.seconds)
end
result = conversation_finder.perform
# pagination is not applied
# filters are applied
# modified conversations + 1 conversation created during set up
expect(result[:conversations].length).to be 29
# ensure that the conversations are sorted by created_at
expect(result[:conversations].first.created_at).to be < result[:conversations].last.created_at
end
end
context 'with pagination' do
let(:params) { { status: 'open', assignee_type: 'me', page: 1 } }
it 'returns paginated conversations' do
create_list(:conversation, 50, account: account, inbox: inbox, assignee: user_1)
result = conversation_finder.perform
expect(result[:conversations].length).to be 25
end
end
context 'with perform_meta_only' do
let(:params) { { assignee_type: 'assigned' } }
it 'returns only count without conversations' do
result = conversation_finder.perform_meta_only
expect(result).to have_key(:count)
expect(result).not_to have_key(:conversations)
end
it 'returns the correct counts' do
result = conversation_finder.perform_meta_only
expect(result[:count]).to eq({
mine_count: 2,
assigned_count: 3,
unassigned_count: 1,
all_count: 4
})
end
it 'returns same counts as perform' do
meta_result = conversation_finder.perform_meta_only
full_result = conversation_finder.perform
expect(meta_result[:count]).to eq(full_result[:count])
end
end
context 'with unattended' do
let(:params) { { status: 'open', assignee_type: 'me', conversation_type: 'unattended' } }
it 'returns unattended conversations' do
create(:conversation, account: account, first_reply_created_at: Time.now.utc, assignee: user_1) # attended_conversation
create(:conversation, account: account, first_reply_created_at: nil, assignee: user_1) # unattended_conversation_no_first_reply
create(:conversation, account: account, first_reply_created_at: Time.now.utc,
assignee: user_1, waiting_since: Time.now.utc) # unattended_conversation_waiting_since
result = conversation_finder.perform
expect(result[:conversations].length).to be 2
end
end
end
end