[Cases] Add MTTR metric (elastic#130459)

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

x-pack/plugins/cases/common/api/metrics/case.ts

@@ -7,7 +7,10 @@
 
 import * as rt from 'io-ts';
 
-export type CaseMetricsResponse = rt.TypeOf<typeof CaseMetricsResponseRt>;
+export type SingleCaseMetricsRequest = rt.TypeOf<typeof SingleCaseMetricsRequestRt>;
+export type SingleCaseMetricsResponse = rt.TypeOf<typeof SingleCaseMetricsResponseRt>;
+export type CasesMetricsRequest = rt.TypeOf<typeof CasesMetricsRequestRt>;
+export type CasesMetricsResponse = rt.TypeOf<typeof CasesMetricsResponseRt>;
 export type AlertHostsMetrics = rt.TypeOf<typeof AlertHostsMetricsRt>;
 export type AlertUsersMetrics = rt.TypeOf<typeof AlertUsersMetricsRt>;
 export type StatusInfo = rt.TypeOf<typeof StatusInfoRt>;
@@ -69,7 +72,43 @@ const AlertUsersMetricsRt = rt.type({
   ),
 });
 
-export const CaseMetricsResponseRt = rt.partial(
+export const SingleCaseMetricsRequestRt = rt.type({
+  /**
+   * The ID of the case.
+   */
+  caseId: rt.string,
+  /**
+   * The metrics to retrieve.
+   */
+  features: rt.array(rt.string),
+});
+
+export const CasesMetricsRequestRt = rt.intersection([
+  rt.type({
+    /**
+     * The metrics to retrieve.
+     */
+    features: rt.array(rt.string),
+  }),
+  rt.partial({
+    /**
+     * A KQL date. If used all cases created after (gte) the from date will be returned
+     */
+    from: rt.string,
+    /**
+     * A KQL date. If used all cases created before (lte) the to date will be returned.
+     */
+    to: rt.string,
+    /**
+     * The owner(s) to filter by. The user making the request must have privileges to retrieve cases of that
+     * ownership or they will be ignored. If no owner is included, then all ownership types will be included in the response
+     * that the user has access to.
+     */
+    owner: rt.union([rt.array(rt.string), rt.string]),
+  }),
+]);
+
+export const SingleCaseMetricsResponseRt = rt.partial(
   rt.type({
     alerts: rt.partial(
       rt.type({
@@ -142,3 +181,9 @@ export const CaseMetricsResponseRt = rt.partial(
     }),
   }).props
 );
+
+export const CasesMetricsResponseRt = rt.partial(
+  rt.type({
+    mttr: rt.number,
+  }).props
+);

x-pack/plugins/cases/common/constants.ts

@@ -69,6 +69,7 @@ export const CASE_USER_ACTIONS_URL = `${CASE_DETAILS_URL}/user_actions` as const
 export const CASE_ALERTS_URL = `${CASES_URL}/alerts/{alert_id}` as const;
 export const CASE_DETAILS_ALERTS_URL = `${CASE_DETAILS_URL}/alerts` as const;
 
+export const CASE_METRICS_URL = `${CASES_URL}/metrics` as const;
 export const CASE_METRICS_DETAILS_URL = `${CASES_URL}/metrics/{case_id}` as const;
 
 /**

x-pack/plugins/cases/common/ui/types.ts

@@ -13,7 +13,7 @@ import {
   ActionConnector,
   CaseExternalServiceBasic,
   CaseUserActionResponse,
-  CaseMetricsResponse,
+  SingleCaseMetricsResponse,
   CommentResponse,
   CaseResponse,
   CommentResponseAlertsType,
@@ -24,7 +24,7 @@ type DeepRequired<T> = { [K in keyof T]: DeepRequired<T[K]> } & Required<T>;
 
 export interface CasesContextFeatures {
   alerts: { sync?: boolean; enabled?: boolean };
-  metrics: CaseMetricsFeature[];
+  metrics: SingleCaseMetricsFeature[];
 }
 
 export type CasesFeaturesAllRequired = DeepRequired<CasesContextFeatures>;
@@ -97,8 +97,8 @@ export interface AllCases extends CasesStatus {
   total: number;
 }
 
-export type CaseMetrics = CaseMetricsResponse;
-export type CaseMetricsFeature =
+export type SingleCaseMetrics = SingleCaseMetricsResponse;
+export type SingleCaseMetricsFeature =
   | 'alerts.count'
   | 'alerts.users'
   | 'alerts.hosts'

x-pack/plugins/cases/public/components/case_view/metrics/index.test.tsx

@@ -13,16 +13,16 @@ import {
   basicCaseStatusFeatures,
 } from '../../../containers/mock';
 import { CaseViewMetrics } from '.';
-import { CaseMetrics, CaseMetricsFeature } from '../../../../common/ui';
+import { SingleCaseMetrics, SingleCaseMetricsFeature } from '../../../../common/ui';
 import { TestProviders } from '../../../common/mock';
 
 const renderCaseMetrics = ({
   metrics = basicCaseMetrics,
   features = [...basicCaseNumericValueFeatures, ...basicCaseStatusFeatures],
   isLoading = false,
 }: {
-  metrics?: CaseMetrics;
-  features?: CaseMetricsFeature[];
+  metrics?: SingleCaseMetrics;
+  features?: SingleCaseMetricsFeature[];
   isLoading?: boolean;
 } = {}) => {
   return render(
@@ -33,7 +33,7 @@ const renderCaseMetrics = ({
 };
 
 interface FeatureTest {
-  feature: CaseMetricsFeature;
+  feature: SingleCaseMetricsFeature;
   items: Array<{
     title: string;
     value: string | number;

x-pack/plugins/cases/public/components/case_view/metrics/status.tsx

@@ -9,7 +9,7 @@ import React, { useMemo } from 'react';
 import prettyMilliseconds from 'pretty-ms';
 import { EuiFlexGrid, EuiFlexGroup, EuiFlexItem, EuiIconTip, EuiSpacer } from '@elastic/eui';
 import { euiStyled } from '@kbn/kibana-react-plugin/common';
-import { CaseMetrics, CaseMetricsFeature } from '../../../../common/ui';
+import { SingleCaseMetrics, SingleCaseMetricsFeature } from '../../../../common/ui';
 import {
   CASE_CREATED,
   CASE_IN_PROGRESS_DURATION,
@@ -90,10 +90,10 @@ export const CaseStatusMetrics: React.FC<Pick<CaseViewMetricsProps, 'metrics' |
 CaseStatusMetrics.displayName = 'CaseStatusMetrics';
 
 const useGetLifespanMetrics = (
-  metrics: CaseMetrics | null,
-  features: CaseMetricsFeature[]
-): CaseMetrics['lifespan'] | undefined => {
-  return useMemo<CaseMetrics['lifespan']>(() => {
+  metrics: SingleCaseMetrics | null,
+  features: SingleCaseMetricsFeature[]
+): SingleCaseMetrics['lifespan'] | undefined => {
+  return useMemo<SingleCaseMetrics['lifespan']>(() => {
     const lifespan = metrics?.lifespan ?? {
       closeDate: '',
       creationDate: '',

x-pack/plugins/cases/public/components/case_view/metrics/totals.tsx

@@ -8,7 +8,7 @@
 import React, { useMemo } from 'react';
 import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
 import { euiStyled } from '@kbn/kibana-react-plugin/common';
-import { CaseMetrics, CaseMetricsFeature } from '../../../../common/ui';
+import { SingleCaseMetrics, SingleCaseMetricsFeature } from '../../../../common/ui';
 import {
   ASSOCIATED_HOSTS_METRIC,
   ASSOCIATED_USERS_METRIC,
@@ -50,8 +50,8 @@ interface MetricItem {
 type MetricItems = MetricItem[];
 
 const useGetTitleValueMetricItems = (
-  metrics: CaseMetrics | null,
-  features: CaseMetricsFeature[]
+  metrics: SingleCaseMetrics | null,
+  features: SingleCaseMetricsFeature[]
 ): MetricItems => {
   const { alerts, actions, connectors } = metrics ?? {};
   const totalConnectors = connectors?.total ?? 0;
@@ -61,7 +61,7 @@ const useGetTitleValueMetricItems = (
   const totalIsolatedHosts = calculateTotalIsolatedHosts(actions);
 
   const metricItems = useMemo<MetricItems>(() => {
-    const items: Array<[CaseMetricsFeature, Omit<MetricItem, 'id'>]> = [
+    const items: Array<[SingleCaseMetricsFeature, Omit<MetricItem, 'id'>]> = [
       ['alerts.count', { title: TOTAL_ALERTS_METRIC, value: alertsCount }],
       ['alerts.users', { title: ASSOCIATED_USERS_METRIC, value: totalAlertUsers }],
       ['alerts.hosts', { title: ASSOCIATED_HOSTS_METRIC, value: totalAlertHosts }],
@@ -88,7 +88,7 @@ const useGetTitleValueMetricItems = (
   return metricItems;
 };
 
-const calculateTotalIsolatedHosts = (actions: CaseMetrics['actions']) => {
+const calculateTotalIsolatedHosts = (actions: SingleCaseMetrics['actions']) => {
   if (!actions?.isolateHost) {
     return 0;
   }

x-pack/plugins/cases/public/components/case_view/metrics/types.ts

@@ -5,10 +5,10 @@
  * 2.0.
  */
 
-import { CaseMetrics, CaseMetricsFeature } from '../../../../common/ui';
+import { SingleCaseMetrics, SingleCaseMetricsFeature } from '../../../../common/ui';
 
 export interface CaseViewMetricsProps {
-  metrics: CaseMetrics | null;
-  features: CaseMetricsFeature[];
+  metrics: SingleCaseMetrics | null;
+  features: SingleCaseMetricsFeature[];
   isLoading: boolean;
 }

x-pack/plugins/cases/public/components/cases_context/use_cases_features.tsx

@@ -6,13 +6,13 @@
  */
 
 import { useMemo } from 'react';
-import { CaseMetricsFeature } from '../../containers/types';
+import { SingleCaseMetricsFeature } from '../../containers/types';
 import { useCasesContext } from './use_cases_context';
 
 export interface UseCasesFeatures {
   isAlertsEnabled: boolean;
   isSyncAlertsEnabled: boolean;
-  metricsFeatures: CaseMetricsFeature[];
+  metricsFeatures: SingleCaseMetricsFeature[];
 }
 
 export const useCasesFeatures = (): UseCasesFeatures => {

x-pack/plugins/cases/public/containers/__mocks__/api.ts

@@ -36,7 +36,7 @@ import {
   CommentRequest,
   User,
   CaseStatuses,
-  CaseMetricsResponse,
+  SingleCaseMetricsResponse,
 } from '../../../common/api';
 
 export const getCase = async (
@@ -51,10 +51,10 @@ export const resolveCase = async (
   signal: AbortSignal
 ): Promise<ResolvedCase> => Promise.resolve(basicResolvedCase);
 
-export const getCaseMetrics = async (
+export const getSingleCaseMetrics = async (
   caseId: string,
   signal: AbortSignal
-): Promise<CaseMetricsResponse> => Promise.resolve(basicCaseMetrics);
+): Promise<SingleCaseMetricsResponse> => Promise.resolve(basicCaseMetrics);
 
 export const getCasesStatus = async (signal: AbortSignal): Promise<CasesStatus> =>
   Promise.resolve(casesStatus);

x-pack/plugins/cases/public/containers/api.ts

@@ -26,8 +26,8 @@ import {
   getCasePushUrl,
   getCaseUserActionUrl,
   User,
-  CaseMetricsResponse,
   getCaseCommentDeleteUrl,
+  SingleCaseMetricsResponse,
 } from '../../common/api';
 import {
   CASE_REPORTERS_URL,
@@ -45,8 +45,8 @@ import {
   AllCases,
   BulkUpdateStatus,
   Case,
-  CaseMetrics,
-  CaseMetricsFeature,
+  SingleCaseMetrics,
+  SingleCaseMetricsFeature,
   CasesStatus,
   FetchCasesProps,
   SortFieldCase,
@@ -63,7 +63,7 @@ import {
   decodeCasesStatusResponse,
   decodeCaseUserActionsResponse,
   decodeCaseResolveResponse,
-  decodeCaseMetricsResponse,
+  decodeSingleCaseMetricsResponse,
 } from './utils';
 
 export const getCase = async (
@@ -129,20 +129,22 @@ export const getReporters = async (signal: AbortSignal, owner: string[]): Promis
   return response ?? [];
 };
 
-export const getCaseMetrics = async (
+export const getSingleCaseMetrics = async (
   caseId: string,
-  features: CaseMetricsFeature[],
+  features: SingleCaseMetricsFeature[],
   signal: AbortSignal
-): Promise<CaseMetrics> => {
-  const response = await KibanaServices.get().http.fetch<CaseMetricsResponse>(
+): Promise<SingleCaseMetrics> => {
+  const response = await KibanaServices.get().http.fetch<SingleCaseMetricsResponse>(
     getCaseDetailsMetricsUrl(caseId),
     {
       method: 'GET',
       signal,
       query: { features: JSON.stringify(features) },
     }
   );
-  return convertToCamelCase<CaseMetricsResponse, CaseMetrics>(decodeCaseMetricsResponse(response));
+  return convertToCamelCase<SingleCaseMetricsResponse, SingleCaseMetrics>(
+    decodeSingleCaseMetricsResponse(response)
+  );
 };
 
 export const getCaseUserActions = async (

x-pack/plugins/cases/public/containers/mock.ts

@@ -9,8 +9,8 @@ import { ActionLicense, AllCases, Case, CasesStatus, CaseUserActions, Comment }
 
 import type {
   ResolvedCase,
-  CaseMetrics,
-  CaseMetricsFeature,
+  SingleCaseMetrics,
+  SingleCaseMetricsFeature,
   AlertComment,
 } from '../../common/ui/types';
 import {
@@ -189,17 +189,17 @@ export const basicResolvedCase: ResolvedCase = {
   aliasTargetId: `${basicCase.id}_2`,
 };
 
-export const basicCaseNumericValueFeatures: CaseMetricsFeature[] = [
+export const basicCaseNumericValueFeatures: SingleCaseMetricsFeature[] = [
   'alerts.count',
   'alerts.users',
   'alerts.hosts',
   'actions.isolateHost',
   'connectors',
 ];
 
-export const basicCaseStatusFeatures: CaseMetricsFeature[] = ['lifespan'];
+export const basicCaseStatusFeatures: SingleCaseMetricsFeature[] = ['lifespan'];
 
-export const basicCaseMetrics: CaseMetrics = {
+export const basicCaseMetrics: SingleCaseMetrics = {
   alerts: {
     count: 12,
     hosts: {

x-pack/plugins/cases/public/containers/use_get_case_metrics.test.tsx

@@ -6,7 +6,7 @@
  */
 
 import { renderHook, act } from '@testing-library/react-hooks';
-import { CaseMetricsFeature } from '../../common/ui';
+import { SingleCaseMetricsFeature } from '../../common/ui';
 import { useGetCaseMetrics, UseGetCaseMetrics } from './use_get_case_metrics';
 import { basicCase, basicCaseMetrics } from './mock';
 import * as api from './api';
@@ -16,7 +16,7 @@ jest.mock('../common/lib/kibana');
 
 describe('useGetCaseMetrics', () => {
   const abortCtrl = new AbortController();
-  const features: CaseMetricsFeature[] = ['alerts.count'];
+  const features: SingleCaseMetricsFeature[] = ['alerts.count'];
 
   beforeEach(() => {
     jest.clearAllMocks();
@@ -38,8 +38,8 @@ describe('useGetCaseMetrics', () => {
     });
   });
 
-  it('calls getCaseMetrics with correct arguments', async () => {
-    const spyOnGetCaseMetrics = jest.spyOn(api, 'getCaseMetrics');
+  it('calls getSingleCaseMetrics with correct arguments', async () => {
+    const spyOnGetCaseMetrics = jest.spyOn(api, 'getSingleCaseMetrics');
     await act(async () => {
       const { waitForNextUpdate } = renderHook<string, UseGetCaseMetrics>(() =>
         useGetCaseMetrics(basicCase.id, features)
@@ -50,8 +50,8 @@ describe('useGetCaseMetrics', () => {
     });
   });
 
-  it('does not call getCaseMetrics if empty feature parameter passed', async () => {
-    const spyOnGetCaseMetrics = jest.spyOn(api, 'getCaseMetrics');
+  it('does not call getSingleCaseMetrics if empty feature parameter passed', async () => {
+    const spyOnGetCaseMetrics = jest.spyOn(api, 'getSingleCaseMetrics');
     await act(async () => {
       const { waitForNextUpdate } = renderHook<string, UseGetCaseMetrics>(() =>
         useGetCaseMetrics(basicCase.id, [])
@@ -78,7 +78,7 @@ describe('useGetCaseMetrics', () => {
   });
 
   it('refetch case metrics', async () => {
-    const spyOnGetCaseMetrics = jest.spyOn(api, 'getCaseMetrics');
+    const spyOnGetCaseMetrics = jest.spyOn(api, 'getSingleCaseMetrics');
     await act(async () => {
       const { result, waitForNextUpdate } = renderHook<string, UseGetCaseMetrics>(() =>
         useGetCaseMetrics(basicCase.id, features)
@@ -116,8 +116,8 @@ describe('useGetCaseMetrics', () => {
     });
   });
 
-  it('returns an error when getCaseMetrics throws', async () => {
-    const spyOnGetCaseMetrics = jest.spyOn(api, 'getCaseMetrics');
+  it('returns an error when getSingleCaseMetrics throws', async () => {
+    const spyOnGetCaseMetrics = jest.spyOn(api, 'getSingleCaseMetrics');
     spyOnGetCaseMetrics.mockImplementation(() => {
       throw new Error('Something went wrong');
     });