[Cases] Create internal endpoint to get user action stats (#149863)

adcoelho · web-flow · commit 7ae33a75ac64 · 2023-02-01T18:50:53.000+01:00
Fixes #149390 ## Summary This PR creates an internal API to get the count of the different user actions associated with the current case. This will be used to help filter and paginate the case activity. <img width="1025" alt="aux" src="https://user-images.githubusercontent.com/1533137/215549427-373f1626-3f7a-417d-ad95-ddb47b259617.png"> **Endpoint:** `GET /internal/cases/<case_id>/user_actions/_stats` Example Response: ``` { total: 3 total_comments: 2 total_other_actions: 1 } ``` ### Checklist Delete any items that are not applicable to this PR. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
diff --git a/x-pack/plugins/cases/common/api/cases/user_actions/response.ts b/x-pack/plugins/cases/common/api/cases/user_actions/response.ts
@@ -8,6 +8,7 @@
 import * as rt from 'io-ts';
 
 import type { ActionsRt, ActionTypeValues } from './common';
+
 import {
   CaseUserActionInjectedIdsRt,
   CaseUserActionInjectedDeprecatedIdsRt,
@@ -25,6 +26,7 @@ import { StatusUserActionRt } from './status';
 import { DeleteCaseUserActionRt } from './delete_case';
 import { SeverityUserActionRt } from './severity';
 import { AssigneesUserActionRt } from './assignees';
+import { CaseUserActionStatsRt } from './stats';
 
 const CommonUserActionsRt = rt.union([
   DescriptionUserActionRt,
@@ -83,11 +85,13 @@ const CaseUserActionResponseRt = rt.intersection([
 const CaseUserActionAttributesRt = CaseUserActionBasicRt;
 export const CaseUserActionsResponseRt = rt.array(CaseUserActionResponseRt);
 export const CaseUserActionsDeprecatedResponseRt = rt.array(CaseUserActionDeprecatedResponseRt);
+export const CaseUserActionStatsResponseRt = CaseUserActionStatsRt;
 
 export type CaseUserActionAttributes = rt.TypeOf<typeof CaseUserActionAttributesRt>;
 export type CaseUserActionAttributesWithoutConnectorId = rt.TypeOf<
   typeof CaseUserActionBasicWithoutConnectorIdRt
 >;
+export type CaseUserActionStatsResponse = rt.TypeOf<typeof CaseUserActionStatsRt>;
 export type CaseUserActionsResponse = rt.TypeOf<typeof CaseUserActionsResponseRt>;
 export type CaseUserActionResponse = rt.TypeOf<typeof CaseUserActionResponseRt>;
 export type CaseUserActionsDeprecatedResponse = rt.TypeOf<
diff --git a/x-pack/plugins/cases/common/api/cases/user_actions/stats.ts b/x-pack/plugins/cases/common/api/cases/user_actions/stats.ts
@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import * as rt from 'io-ts';
+
+export const CaseUserActionStatsRt = rt.type({
+  total: rt.number,
+  total_comments: rt.number,
+  total_other_actions: rt.number,
+});
+
+export type CaseUserActionStats = rt.TypeOf<typeof CaseUserActionStatsRt>;
diff --git a/x-pack/plugins/cases/common/api/helpers.ts b/x-pack/plugins/cases/common/api/helpers.ts
@@ -16,6 +16,7 @@ import {
   CASE_ALERTS_URL,
   CASE_COMMENT_DELETE_URL,
   CASE_FIND_USER_ACTIONS_URL,
+  INTERNAL_GET_CASE_USER_ACTIONS_STATS_URL,
   INTERNAL_BULK_GET_ATTACHMENTS_URL,
   INTERNAL_CONNECTORS_URL,
 } from '../constants';
@@ -44,6 +45,10 @@ export const getCaseUserActionUrl = (id: string): string => {
   return CASE_USER_ACTIONS_URL.replace('{case_id}', id);
 };
 
+export const getCaseUserActionStatsUrl = (id: string): string => {
+  return INTERNAL_GET_CASE_USER_ACTIONS_STATS_URL.replace('{case_id}', id);
+};
+
 export const getCaseFindUserActionsUrl = (id: string): string => {
   return CASE_FIND_USER_ACTIONS_URL.replace('{case_id}', id);
 };
diff --git a/x-pack/plugins/cases/common/constants.ts b/x-pack/plugins/cases/common/constants.ts
@@ -94,6 +94,8 @@ export const INTERNAL_SUGGEST_USER_PROFILES_URL =
   `${CASES_INTERNAL_URL}/_suggest_user_profiles` as const;
 export const INTERNAL_CONNECTORS_URL = `${CASES_INTERNAL_URL}/{case_id}/_connectors` as const;
 export const INTERNAL_BULK_GET_CASES_URL = `${CASES_INTERNAL_URL}/_bulk_get` as const;
+export const INTERNAL_GET_CASE_USER_ACTIONS_STATS_URL =
+  `${CASES_INTERNAL_URL}/{case_id}/user_actions/_stats` as const;
 
 /**
  * Action routes
diff --git a/x-pack/plugins/cases/server/authorization/__snapshots__/audit_logger.test.ts.snap b/x-pack/plugins/cases/server/authorization/__snapshots__/audit_logger.test.ts.snap
diff --git a/x-pack/plugins/cases/server/authorization/index.ts b/x-pack/plugins/cases/server/authorization/index.ts
@@ -359,4 +359,12 @@ export const Operations: Record<ReadOperations | WriteOperations, OperationDetai
     docType: 'user actions',
     savedObjectType: CASE_USER_ACTION_SAVED_OBJECT,
   },
+  [ReadOperations.GetUserActionStats]: {
+    ecsType: EVENT_TYPES.access,
+    name: ACCESS_USER_ACTION_OPERATION,
+    action: 'case_user_action_get_stats',
+    verbs: accessVerbs,
+    docType: 'user actions',
+    savedObjectType: CASE_USER_ACTION_SAVED_OBJECT,
+  },
 };
diff --git a/x-pack/plugins/cases/server/authorization/types.ts b/x-pack/plugins/cases/server/authorization/types.ts
@@ -47,6 +47,7 @@ export enum ReadOperations {
   GetCaseMetrics = 'getCaseMetrics',
   GetCasesMetrics = 'getCasesMetrics',
   GetUserActionMetrics = 'getUserActionMetrics',
+  GetUserActionStats = 'getUserActionStats',
 }
 
 /**
diff --git a/x-pack/plugins/cases/server/client/mocks.ts b/x-pack/plugins/cases/server/client/mocks.ts
@@ -91,9 +91,10 @@ type UserActionsSubClientMock = jest.Mocked<UserActionsSubClient>;
 
 const createUserActionsSubClientMock = (): UserActionsSubClientMock => {
   return {
+    find: jest.fn(),
     getAll: jest.fn(),
     getConnectors: jest.fn(),
-    find: jest.fn(),
+    stats: jest.fn(),
   };
 };
 
diff --git a/x-pack/plugins/cases/server/client/user_actions/client.ts b/x-pack/plugins/cases/server/client/user_actions/client.ts
@@ -7,12 +7,14 @@
 
 import type {
   GetCaseConnectorsResponse,
+  CaseUserActionStatsResponse,
   UserActionFindResponse,
   CaseUserActionsDeprecatedResponse,
 } from '../../../common/api';
 import type { CasesClientArgs } from '../types';
 import { get } from './get';
 import { getConnectors } from './connectors';
+import { getStats } from './stats';
 import type { GetConnectorsRequest, UserActionFind, UserActionGet } from './types';
 import { find } from './find';
 import type { CasesClient } from '../client';
@@ -30,6 +32,11 @@ export interface UserActionsSubClient {
    * Retrieves all the connectors used within a given case
    */
   getConnectors(params: GetConnectorsRequest): Promise<GetCaseConnectorsResponse>;
+
+  /**
+   * Retrieves the total of comments and user actions in a given case
+   */
+  stats(params: UserActionGet): Promise<CaseUserActionStatsResponse>;
 }
 
 /**
@@ -43,6 +50,7 @@ export const createUserActionsSubClient = (
     find: (params) => find(params, casesClient, clientArgs),
     getAll: (params) => get(params, clientArgs),
     getConnectors: (params) => getConnectors(params, clientArgs),
+    stats: (params) => getStats(params, casesClient, clientArgs),
   };
 
   return Object.freeze(attachmentSubClient);
diff --git a/x-pack/plugins/cases/server/client/user_actions/stats.ts b/x-pack/plugins/cases/server/client/user_actions/stats.ts
@@ -0,0 +1,39 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { CaseUserActionStatsResponse } from '../../../common/api';
+import { CaseUserActionStatsResponseRt } from '../../../common/api';
+import { createCaseError } from '../../common/error';
+import type { CasesClientArgs } from '..';
+import type { UserActionGet } from './types';
+import type { CasesClient } from '../client';
+
+export const getStats = async (
+  { caseId }: UserActionGet,
+  casesClient: CasesClient,
+  clientArgs: CasesClientArgs
+): Promise<CaseUserActionStatsResponse> => {
+  const {
+    services: { userActionService },
+    logger,
+  } = clientArgs;
+
+  try {
+    await casesClient.cases.resolve({ id: caseId, includeComments: false });
+    const totals = await userActionService.getCaseUserActionStats({
+      caseId,
+    });
+
+    return CaseUserActionStatsResponseRt.encode(totals);
+  } catch (error) {
+    throw createCaseError({
+      message: `Failed to retrieve user action stats for case id: ${caseId}: ${error}`,
+      error,
+      logger,
+    });
+  }
+};
diff --git a/x-pack/plugins/cases/server/routes/api/get_internal_routes.ts b/x-pack/plugins/cases/server/routes/api/get_internal_routes.ts
@@ -7,6 +7,7 @@
 
 import type { UserProfileService } from '../../services';
 import { getConnectorsRoute } from './internal/get_connectors';
+import { getCaseUserActionStatsRoute } from './internal/get_case_user_actions_stats';
 import { bulkCreateAttachmentsRoute } from './internal/bulk_create_attachments';
 import { bulkGetCasesRoute } from './internal/bulk_get_cases';
 import { suggestUserProfilesRoute } from './internal/suggest_user_profiles';
@@ -19,5 +20,6 @@ export const getInternalRoutes = (userProfileService: UserProfileService) =>
     suggestUserProfilesRoute(userProfileService),
     getConnectorsRoute,
     bulkGetCasesRoute,
+    getCaseUserActionStatsRoute,
     bulkGetAttachmentsRoute,
   ] as CaseRoute[];
diff --git a/x-pack/plugins/cases/server/routes/api/internal/get_case_user_actions_stats.ts b/x-pack/plugins/cases/server/routes/api/internal/get_case_user_actions_stats.ts
@@ -0,0 +1,36 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+import { schema } from '@kbn/config-schema';
+import { INTERNAL_GET_CASE_USER_ACTIONS_STATS_URL } from '../../../../common/constants';
+import { createCaseError } from '../../../common/error';
+import { createCasesRoute } from '../create_cases_route';
+
+export const getCaseUserActionStatsRoute = createCasesRoute({
+  method: 'get',
+  path: INTERNAL_GET_CASE_USER_ACTIONS_STATS_URL,
+  params: {
+    params: schema.object({
+      case_id: schema.string(),
+    }),
+  },
+  handler: async ({ context, request, response }) => {
+    try {
+      const casesContext = await context.cases;
+      const casesClient = await casesContext.getCasesClient();
+      const caseId = request.params.case_id;
+
+      return response.ok({
+        body: await casesClient.userActions.stats({ caseId }),
+      });
+    } catch (error) {
+      throw createCaseError({
+        message: `Failed to retrieve stats in route case id: ${request.params.case_id}: ${error}`,
+        error,
+      });
+    }
+  },
+});
diff --git a/x-pack/plugins/cases/server/services/mocks.ts b/x-pack/plugins/cases/server/services/mocks.ts
@@ -124,6 +124,7 @@ export const createUserActionServiceMock = (): CaseUserActionServiceMock => {
     getAll: jest.fn(),
     getUniqueConnectors: jest.fn(),
     getUserActionIdsForCases: jest.fn(),
+    getCaseUserActionStats: jest.fn(),
   };
 
   // the cast here is required because jest.Mocked tries to include private members and would throw an error
diff --git a/x-pack/plugins/cases/server/services/user_actions/index.ts b/x-pack/plugins/cases/server/services/user_actions/index.ts
@@ -88,6 +88,16 @@ interface ConnectorFieldsBeforePushAggsResult {
   };
 }
 
+interface UserActionsStatsAggsResult {
+  total: number;
+  totals: {
+    buckets: Array<{
+      key: string;
+      doc_count: number;
+    }>;
+  };
+}
+
 export class CaseUserActionService {
   private readonly _creator: UserActionPersister;
   private readonly _finder: UserActionFinder;
@@ -661,4 +671,48 @@ export class CaseUserActionService {
       },
     };
   }
+
+  public async getCaseUserActionStats({ caseId }: { caseId: string }) {
+    const response = await this.context.unsecuredSavedObjectsClient.find<
+      CaseUserActionAttributesWithoutConnectorId,
+      UserActionsStatsAggsResult
+    >({
+      type: CASE_USER_ACTION_SAVED_OBJECT,
+      hasReference: { type: CASE_SAVED_OBJECT, id: caseId },
+      page: 1,
+      perPage: 1,
+      sortField: defaultSortField,
+      aggs: CaseUserActionService.buildUserActionStatsAgg(),
+    });
+
+    const result = {
+      total: response.total,
+      total_comments: 0,
+      total_other_actions: 0,
+    };
+
+    response.aggregations?.totals.buckets.forEach(({ key, doc_count: docCount }) => {
+      if (key === 'user') {
+        result.total_comments = docCount;
+      }
+    });
+
+    result.total_other_actions = result.total - result.total_comments;
+
+    return result;
+  }
+
+  private static buildUserActionStatsAgg(): Record<
+    string,
+    estypes.AggregationsAggregationContainer
+  > {
+    return {
+      totals: {
+        terms: {
+          field: `${CASE_USER_ACTION_SAVED_OBJECT}.attributes.payload.comment.type`,
+          size: 100,
+        },
+      },
+    };
+  }
 }
diff --git a/x-pack/test/cases_api_integration/common/lib/user_actions.ts b/x-pack/test/cases_api_integration/common/lib/user_actions.ts
diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts
diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/user_actions/get_user_action_stats.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/user_actions/get_user_action_stats.ts
diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/trial/index.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/trial/index.ts
diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/trial/internal/get_user_action_stats.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/trial/internal/get_user_action_stats.ts

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ export enum ReadOperations {`
`47`	`47`	`GetCaseMetrics = 'getCaseMetrics',`
`48`	`48`	`GetCasesMetrics = 'getCasesMetrics',`
`49`	`49`	`GetUserActionMetrics = 'getUserActionMetrics',`
	`50`	`+ GetUserActionStats = 'getUserActionStats',`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`/**`