feat: allow querying reporting events via the API (#12832)

2025-11-13 12:46:55 +05:30
parent f455e7994e
commit 4f09c2203c
22 changed files with 1373 additions and 5 deletions
--- a/spec/enterprise/controllers/api/v1/accounts/conversations_controller_spec.rb
+++ b/spec/enterprise/controllers/api/v1/accounts/conversations_controller_spec.rb
@@ -102,4 +102,146 @@ RSpec.describe 'Conversations API', type: :request do
      end
    end
  end
+
+  describe 'GET /api/v1/accounts/{account.id}/conversations/:id/reporting_events' do
+    let(:conversation) { create(:conversation, account: account) }
+    let(:inbox) { conversation.inbox }
+    let(:agent) { administrator }
+
+    before do
+      # Create reporting events for this conversation
+      @event1 = create(:reporting_event,
+                       account: account,
+                       conversation: conversation,
+                       inbox: inbox,
+                       user: agent,
+                       name: 'first_response',
+                       value: 120,
+                       created_at: 3.hours.ago)
+
+      @event2 = create(:reporting_event,
+                       account: account,
+                       conversation: conversation,
+                       inbox: inbox,
+                       user: agent,
+                       name: 'reply_time',
+                       value: 45,
+                       created_at: 2.hours.ago)
+
+      @event3 = create(:reporting_event,
+                       account: account,
+                       conversation: conversation,
+                       inbox: inbox,
+                       user: agent,
+                       name: 'resolution',
+                       value: 300,
+                       created_at: 1.hour.ago)
+
+      # Create an event for a different conversation (should not be included)
+      other_conversation = create(:conversation, account: account)
+      create(:reporting_event,
+             account: account,
+             conversation: other_conversation,
+             inbox: other_conversation.inbox,
+             user: agent,
+             name: 'other_conversation_event',
+             value: 60)
+    end
+
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/reporting_events",
+            as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user with conversation access' do
+      it 'returns all reporting events for the conversation' do
+        get "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/reporting_events",
+            headers: administrator.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        # Should return array directly (no pagination)
+        expect(json_response).to be_an(Array)
+        expect(json_response.size).to eq(3)
+
+        # Check they are sorted by created_at asc (oldest first)
+        expect(json_response.first['name']).to eq('first_response')
+        expect(json_response.last['name']).to eq('resolution')
+
+        # Verify it doesn't include events from other conversations
+        event_names = json_response.map { |e| e['name'] }
+        expect(event_names).not_to include('other_conversation_event')
+      end
+
+      it 'returns empty array when conversation has no reporting events' do
+        conversation_without_events = create(:conversation, account: account)
+
+        get "/api/v1/accounts/#{account.id}/conversations/#{conversation_without_events.display_id}/reporting_events",
+            headers: administrator.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        expect(json_response).to be_an(Array)
+        expect(json_response).to be_empty
+      end
+    end
+
+    context 'when agent has limited access' do
+      let(:limited_agent) { create(:user, account: account, role: :agent) }
+
+      it 'returns unauthorized for unassigned conversation without permission' do
+        get "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/reporting_events",
+            headers: limited_agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+
+      it 'returns reporting events when agent is assigned to the conversation' do
+        conversation.update!(assignee: limited_agent)
+        # Also create inbox member for the agent
+        create(:inbox_member, user: limited_agent, inbox: conversation.inbox)
+
+        get "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/reporting_events",
+            headers: limited_agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        expect(json_response).to be_an(Array)
+        expect(json_response.size).to eq(3)
+      end
+    end
+
+    context 'when agent has team access' do
+      let(:team_agent) { create(:user, account: account, role: :agent) }
+      let(:team) { create(:team, account: account) }
+
+      before do
+        create(:team_member, team: team, user: team_agent)
+        conversation.update!(team: team)
+      end
+
+      it 'allows accessing conversation reporting events via team membership' do
+        get "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/reporting_events",
+            headers: team_agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        expect(json_response).to be_an(Array)
+        expect(json_response.size).to eq(3)
+      end
+    end
+  end
 end
--- a/spec/enterprise/controllers/api/v1/accounts/reporting_events_controller_spec.rb
+++ b/spec/enterprise/controllers/api/v1/accounts/reporting_events_controller_spec.rb
@@ -0,0 +1,217 @@
+require 'rails_helper'
+
+RSpec.describe 'Enterprise Reporting Events API', type: :request do
+  let!(:account) { create(:account) }
+  let!(:admin) { create(:user, account: account, role: :administrator) }
+  let!(:agent) { create(:user, account: account, role: :agent) }
+  let!(:inbox) { create(:inbox, account: account) }
+  let!(:conversation) { create(:conversation, account: account, inbox: inbox, assignee: agent) }
+
+  describe 'GET /api/v1/accounts/{account.id}/reporting_events' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/reporting_events",
+            as: :json
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated normal agent user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/reporting_events",
+            headers: agent.create_new_auth_token,
+            as: :json
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated admin user' do
+      before do
+        create(:reporting_event,
+               account: account,
+               conversation: conversation,
+               inbox: inbox,
+               user: agent,
+               name: 'first_response',
+               value: 120,
+               created_at: 3.days.ago)
+        create(:reporting_event,
+               account: account,
+               conversation: conversation,
+               inbox: inbox,
+               user: agent,
+               name: 'resolution',
+               value: 300,
+               created_at: 2.days.ago)
+        create(:reporting_event,
+               account: account,
+               conversation: conversation,
+               inbox: inbox,
+               user: agent,
+               name: 'reply_time',
+               value: 45,
+               created_at: 1.day.ago)
+      end
+
+      it 'fetches reporting events with pagination' do
+        get "/api/v1/accounts/#{account.id}/reporting_events",
+            headers: admin.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        # Check structure and pagination
+        expect(json_response).to have_key('payload')
+        expect(json_response).to have_key('meta')
+        expect(json_response['meta']['count']).to eq(3)
+
+        # Check events are sorted by created_at desc (newest first)
+        events = json_response['payload']
+        expect(events.size).to eq(3)
+        expect(events.first['name']).to eq('reply_time')
+        expect(events.last['name']).to eq('first_response')
+      end
+
+      it 'filters reporting events by date range using since and until' do
+        get "/api/v1/accounts/#{account.id}/reporting_events",
+            params: { since: 2.5.days.ago.to_time.to_i.to_s, until: 1.5.days.ago.to_time.to_i.to_s },
+            headers: admin.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        expect(json_response['meta']['count']).to eq(1)
+        expect(json_response['payload'].first['name']).to eq('resolution')
+      end
+
+      it 'filters reporting events by inbox_id' do
+        other_inbox = create(:inbox, account: account)
+        other_conversation = create(:conversation, account: account, inbox: other_inbox)
+        create(:reporting_event,
+               account: account,
+               conversation: other_conversation,
+               inbox: other_inbox,
+               user: agent,
+               name: 'other_inbox_event')
+
+        get "/api/v1/accounts/#{account.id}/reporting_events",
+            params: { inbox_id: inbox.id },
+            headers: admin.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        expect(json_response['meta']['count']).to eq(3)
+        expect(json_response['payload'].map { |e| e['name'] }).not_to include('other_inbox_event')
+      end
+
+      it 'filters reporting events by user_id (agent)' do
+        other_agent = create(:user, account: account, role: :agent)
+        create(:reporting_event,
+               account: account,
+               conversation: conversation,
+               inbox: inbox,
+               user: other_agent,
+               name: 'other_agent_event')
+
+        get "/api/v1/accounts/#{account.id}/reporting_events",
+            params: { user_id: agent.id },
+            headers: admin.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        expect(json_response['meta']['count']).to eq(3)
+        expect(json_response['payload'].map { |e| e['name'] }).not_to include('other_agent_event')
+      end
+
+      it 'filters reporting events by name' do
+        get "/api/v1/accounts/#{account.id}/reporting_events",
+            params: { name: 'first_response' },
+            headers: admin.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        expect(json_response['meta']['count']).to eq(1)
+        expect(json_response['payload'].first['name']).to eq('first_response')
+      end
+
+      it 'supports combining multiple filters' do
+        # Create more test data
+        other_conversation = create(:conversation, account: account, inbox: inbox, assignee: agent)
+        create(:reporting_event,
+               account: account,
+               conversation: other_conversation,
+               inbox: inbox,
+               user: agent,
+               name: 'first_response',
+               value: 90,
+               created_at: 2.days.ago)
+
+        get "/api/v1/accounts/#{account.id}/reporting_events",
+            params: {
+              inbox_id: inbox.id,
+              user_id: agent.id,
+              name: 'first_response',
+              since: 4.days.ago.to_time.to_i.to_s,
+              until: Time.zone.now.to_time.to_i.to_s
+            },
+            headers: admin.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = response.parsed_body
+
+        expect(json_response['meta']['count']).to eq(2)
+        expect(json_response['payload'].map { |e| e['name'] }).to all(eq('first_response'))
+      end
+
+      context 'with pagination' do
+        before do
+          # Create more events to test pagination
+          30.times do |i|
+            create(:reporting_event,
+                   account: account,
+                   conversation: conversation,
+                   inbox: inbox,
+                   user: agent,
+                   name: "event_#{i}",
+                   created_at: i.hours.ago)
+          end
+        end
+
+        it 'returns 25 events per page by default' do
+          get "/api/v1/accounts/#{account.id}/reporting_events",
+              headers: admin.create_new_auth_token,
+              as: :json
+
+          expect(response).to have_http_status(:success)
+          json_response = response.parsed_body
+
+          expect(json_response['payload'].size).to eq(25)
+          expect(json_response['meta']['count']).to eq(33) # 30 + 3 original events
+          expect(json_response['meta']['current_page']).to eq(1)
+        end
+
+        it 'supports page navigation' do
+          get "/api/v1/accounts/#{account.id}/reporting_events",
+              params: { page: 2 },
+              headers: admin.create_new_auth_token,
+              as: :json
+
+          expect(response).to have_http_status(:success)
+          json_response = response.parsed_body
+
+          expect(json_response['payload'].size).to eq(8) # Remaining events
+          expect(json_response['meta']['current_page']).to eq(2)
+        end
+      end
+    end
+  end
+end
--- a/spec/factories/reporting_events.rb
+++ b/spec/factories/reporting_events.rb
@@ -1,11 +1,13 @@
 FactoryBot.define do
  factory :reporting_event do
-    name { 'MyString' }
+    name { 'first_response' }
    value { 1.5 }
    value_in_business_hours { 1 }
-    account_id { 1 }
-    inbox_id { 1 }
-    user_id { 1 }
-    conversation_id { 1 }
+    account
+    inbox { association :inbox, account: account }
+    user { association :user, account: account }
+    conversation { association :conversation, account: account, inbox: inbox }
+    event_start_time { 2.hours.ago }
+    event_end_time { 1.hour.ago }
  end
 end