[Cases] Fix get case API totalComment to only return user comments (#…

…160167)

This PR fixes a bug so that the get case API `totalComment` field only
includes user comments in the total. Prior to this fix the value
included all comment types.

Fixes: #156361
#158344

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

x-pack/plugins/cases/server/client/cases/get.ts

@@ -32,7 +32,7 @@ import {
   GetCategoriesResponseRt,
 } from '../../../common/api';
 import { createCaseError } from '../../common/error';
-import { countAlertsForID, flattenCaseSavedObject } from '../../common/utils';
+import { countAlertsForID, flattenCaseSavedObject, countUserAttachments } from '../../common/utils';
 import type { CasesClientArgs } from '..';
 import { Operations } from '../../authorization';
 import { combineAuthorizedAndOwnerFilter } from '../utils';
@@ -207,7 +207,7 @@ export const get = async (
     const res = flattenCaseSavedObject({
       savedObject: theCase,
       comments: theComments.saved_objects,
-      totalComment: theComments.total,
+      totalComment: countUserAttachments(theComments.saved_objects),
       totalAlerts: countAlertsForID({ comments: theComments, id }),
     });
 

x-pack/plugins/cases/server/common/utils.test.ts

@@ -33,10 +33,12 @@ import {
   getApplicationRoute,
   getCaseViewPath,
   isSOError,
+  countUserAttachments,
 } from './utils';
 import { newCase } from '../routes/api/__mocks__/request_responses';
 import { CASE_VIEW_PAGE_TABS } from '../../common/types';
 import { mockCases, mockCaseComments } from '../mocks';
+import { createAlertAttachment, createUserAttachment } from '../services/attachments/test_utils';
 
 interface CommentReference {
   ids: string[];
@@ -1332,4 +1334,22 @@ describe('common utils', () => {
       expect(isSOError({})).toBe(false);
     });
   });
+
+  describe('countUserAttachments', () => {
+    it('returns 0 for an empty array', () => {
+      expect(countUserAttachments([])).toBe(0);
+    });
+
+    it('returns 1 when there is only 1 user attachment', () => {
+      const attachments = [createUserAttachment(), createAlertAttachment()];
+
+      expect(countUserAttachments(attachments)).toBe(1);
+    });
+
+    it('returns 0 when there is only alert attachments', () => {
+      const attachments = [createAlertAttachment()];
+
+      expect(countUserAttachments(attachments)).toBe(0);
+    });
+  });
 });

x-pack/plugins/cases/server/common/utils.ts

@@ -460,3 +460,17 @@ export const getCaseViewPath = (params: {
 };
 
 export const isSOError = <T>(so: { error?: unknown }): so is SOWithErrors<T> => so.error != null;
+
+export const countUserAttachments = (
+  attachments: Array<SavedObject<CommentAttributes>>
+): number => {
+  let total = 0;
+
+  for (const attachment of attachments) {
+    if (attachment.attributes.type === CommentType.user) {
+      total += 1;
+    }
+  }
+
+  return total;
+};

x-pack/test/cases_api_integration/security_and_spaces/tests/common/cases/get_case.ts

@@ -16,6 +16,7 @@ import {
   postCaseResp,
   postCommentUserReq,
   getPostCaseRequest,
+  postCommentAlertReq,
 } from '../../../../common/lib/mock';
 import {
   deleteCasesByESQuery,
@@ -25,6 +26,7 @@ import {
   removeServerGeneratedPropertiesFromCase,
   removeServerGeneratedPropertiesFromSavedObject,
   extractWarningValueFromWarningHeader,
+  bulkCreateAttachments,
 } from '../../../../common/lib/api';
 import {
   secOnly,
@@ -81,6 +83,34 @@ export default ({ getService }: FtrProviderContext): void => {
       });
     });
 
+    it('should set totalComment to 0 when all attachments are alerts', async () => {
+      const postedCase = await createCase(supertest, postCaseReq);
+
+      await bulkCreateAttachments({
+        supertest,
+        caseId: postedCase.id,
+        params: [postCommentAlertReq, postCommentAlertReq],
+      });
+
+      const theCase = await getCase({ supertest, caseId: postedCase.id, includeComments: true });
+
+      expect(theCase.totalComment).to.be(0);
+    });
+
+    it('should set totalComment to 1 when there is one user attachment and one alert', async () => {
+      const postedCase = await createCase(supertest, postCaseReq);
+
+      await bulkCreateAttachments({
+        supertest,
+        caseId: postedCase.id,
+        params: [postCommentAlertReq, postCommentUserReq],
+      });
+
+      const theCase = await getCase({ supertest, caseId: postedCase.id, includeComments: true });
+
+      expect(theCase.totalComment).to.be(1);
+    });
+
     it('unhappy path - 404s when case is not there', async () => {
       await supertest.get(`${CASES_URL}/fake-id`).set('kbn-xsrf', 'true').send().expect(404);
     });