[Cases] Migrate sub cases routes to a client (#96461)

* Adding sub cases client

* Move sub case routes to case client

* Throw when attempting to access the sub cases client

* Fixing throw and removing user ans soclients

x-pack/plugins/cases/common/api/cases/sub_case.ts

@@ -79,3 +79,4 @@ export type SubCasesResponse = rt.TypeOf<typeof SubCasesResponseRt>;
 export type SubCasesFindResponse = rt.TypeOf<typeof SubCasesFindResponseRt>;
 export type SubCasePatchRequest = rt.TypeOf<typeof SubCasePatchRequestRt>;
 export type SubCasesPatchRequest = rt.TypeOf<typeof SubCasesPatchRequestRt>;
+export type SubCasesFindRequest = rt.TypeOf<typeof SubCasesFindRequestRt>;

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

@@ -4,24 +4,29 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
+import Boom from '@hapi/boom';
 
 import { CasesClientArgs } from './types';
 import { CasesSubClient, createCasesSubClient } from './cases/client';
 import { AttachmentsSubClient, createAttachmentsSubClient } from './attachments/client';
 import { UserActionsSubClient, createUserActionsSubClient } from './user_actions/client';
 import { CasesClientInternal, createCasesClientInternal } from './client_internal';
+import { createSubCasesClient, SubCasesClient } from './sub_cases/client';
+import { ENABLE_CASE_CONNECTOR } from '../../common/constants';
 
 export class CasesClient {
   private readonly _casesClientInternal: CasesClientInternal;
   private readonly _cases: CasesSubClient;
   private readonly _attachments: AttachmentsSubClient;
   private readonly _userActions: UserActionsSubClient;
+  private readonly _subCases: SubCasesClient;
 
   constructor(args: CasesClientArgs) {
     this._casesClientInternal = createCasesClientInternal(args);
     this._cases = createCasesSubClient(args, this, this._casesClientInternal);
     this._attachments = createAttachmentsSubClient(args, this._casesClientInternal);
     this._userActions = createUserActionsSubClient(args);
+    this._subCases = createSubCasesClient(args, this);
   }
 
   public get cases() {
@@ -36,6 +41,13 @@ export class CasesClient {
     return this._userActions;
   }
 
+  public get subCases() {
+    if (!ENABLE_CASE_CONNECTOR) {
+      throw new Error('The case connector feature is disabled');
+    }
+    return this._subCases;
+  }
+
   // TODO: Remove it when all routes will be moved to the cases client.
   public get casesClientInternal() {
     return this._casesClientInternal;

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

@@ -0,0 +1,237 @@
+/*
+ * 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 Boom from '@hapi/boom';
+
+import {
+  caseStatuses,
+  SubCaseResponse,
+  SubCaseResponseRt,
+  SubCasesFindRequest,
+  SubCasesFindResponse,
+  SubCasesFindResponseRt,
+  SubCasesPatchRequest,
+  SubCasesResponse,
+} from '../../../common/api';
+import { CasesClientArgs } from '..';
+import { flattenSubCaseSavedObject, transformSubCases } from '../../routes/api/utils';
+import { countAlertsForID } from '../../common';
+import { createCaseError } from '../../common/error';
+import { CASE_SAVED_OBJECT } from '../../../common/constants';
+import { buildCaseUserActionItem } from '../../services/user_actions/helpers';
+import { constructQueryOptions } from '../../routes/api/cases/helpers';
+import { defaultPage, defaultPerPage } from '../../routes/api';
+import { CasesClient } from '../client';
+import { update } from './update';
+
+interface FindArgs {
+  caseID: string;
+  queryParams: SubCasesFindRequest;
+}
+
+interface GetArgs {
+  includeComments: boolean;
+  id: string;
+}
+
+/**
+ * The API routes for interacting with sub cases.
+ */
+export interface SubCasesClient {
+  delete(ids: string[]): Promise<void>;
+  find(findArgs: FindArgs): Promise<SubCasesFindResponse>;
+  get(getArgs: GetArgs): Promise<SubCaseResponse>;
+  update(subCases: SubCasesPatchRequest): Promise<SubCasesResponse>;
+}
+
+/**
+ * Creates a client for handling the different exposed API routes for interacting with sub cases.
+ */
+export function createSubCasesClient(
+  clientArgs: CasesClientArgs,
+  casesClient: CasesClient
+): SubCasesClient {
+  return Object.freeze({
+    delete: (ids: string[]) => deleteSubCase(ids, clientArgs),
+    find: (findArgs: FindArgs) => find(findArgs, clientArgs),
+    get: (getArgs: GetArgs) => get(getArgs, clientArgs),
+    update: (subCases: SubCasesPatchRequest) => update(subCases, clientArgs, casesClient),
+  });
+}
+
+async function deleteSubCase(ids: string[], clientArgs: CasesClientArgs): Promise<void> {
+  try {
+    const {
+      savedObjectsClient: soClient,
+      user,
+      userActionService,
+      caseService,
+      attachmentService,
+    } = clientArgs;
+
+    const [comments, subCases] = await Promise.all([
+      caseService.getAllSubCaseComments({ soClient, id: ids }),
+      caseService.getSubCases({ soClient, ids }),
+    ]);
+
+    const subCaseErrors = subCases.saved_objects.filter((subCase) => subCase.error !== undefined);
+
+    if (subCaseErrors.length > 0) {
+      throw Boom.notFound(
+        `These sub cases ${subCaseErrors
+          .map((c) => c.id)
+          .join(', ')} do not exist. Please check you have the correct ids.`
+      );
+    }
+
+    const subCaseIDToParentID = subCases.saved_objects.reduce((acc, subCase) => {
+      const parentID = subCase.references.find((ref) => ref.type === CASE_SAVED_OBJECT);
+      acc.set(subCase.id, parentID?.id);
+      return acc;
+    }, new Map<string, string | undefined>());
+
+    await Promise.all(
+      comments.saved_objects.map((comment) =>
+        attachmentService.delete({ soClient, attachmentId: comment.id })
+      )
+    );
+
+    await Promise.all(ids.map((id) => caseService.deleteSubCase(soClient, id)));
+
+    const deleteDate = new Date().toISOString();
+
+    await userActionService.bulkCreate({
+      soClient,
+      actions: ids.map((id) =>
+        buildCaseUserActionItem({
+          action: 'delete',
+          actionAt: deleteDate,
+          actionBy: user,
+          // if for some reason the sub case didn't have a reference to its parent, we'll still log a user action
+          // but we won't have the case ID
+          caseId: subCaseIDToParentID.get(id) ?? '',
+          subCaseId: id,
+          fields: ['sub_case', 'comment', 'status'],
+        })
+      ),
+    });
+  } catch (error) {
+    throw createCaseError({
+      message: `Failed to delete sub cases ids: ${JSON.stringify(ids)}: ${error}`,
+      error,
+      logger: clientArgs.logger,
+    });
+  }
+}
+
+async function find(
+  { caseID, queryParams }: FindArgs,
+  clientArgs: CasesClientArgs
+): Promise<SubCasesFindResponse> {
+  try {
+    const { savedObjectsClient: soClient, caseService } = clientArgs;
+
+    const ids = [caseID];
+    const { subCase: subCaseQueryOptions } = constructQueryOptions({
+      status: queryParams.status,
+      sortByField: queryParams.sortField,
+    });
+
+    const subCases = await caseService.findSubCasesGroupByCase({
+      soClient,
+      ids,
+      options: {
+        sortField: 'created_at',
+        page: defaultPage,
+        perPage: defaultPerPage,
+        ...queryParams,
+        ...subCaseQueryOptions,
+      },
+    });
+
+    const [open, inProgress, closed] = await Promise.all([
+      ...caseStatuses.map((status) => {
+        const { subCase: statusQueryOptions } = constructQueryOptions({
+          status,
+          sortByField: queryParams.sortField,
+        });
+        return caseService.findSubCaseStatusStats({
+          soClient,
+          options: statusQueryOptions ?? {},
+          ids,
+        });
+      }),
+    ]);
+
+    return SubCasesFindResponseRt.encode(
+      transformSubCases({
+        page: subCases.page,
+        perPage: subCases.perPage,
+        total: subCases.total,
+        subCasesMap: subCases.subCasesMap,
+        open,
+        inProgress,
+        closed,
+      })
+    );
+  } catch (error) {
+    throw createCaseError({
+      message: `Failed to find sub cases for case id: ${caseID}: ${error}`,
+      error,
+      logger: clientArgs.logger,
+    });
+  }
+}
+
+async function get(
+  { includeComments, id }: GetArgs,
+  clientArgs: CasesClientArgs
+): Promise<SubCaseResponse> {
+  try {
+    const { savedObjectsClient: soClient, caseService } = clientArgs;
+
+    const subCase = await caseService.getSubCase({
+      soClient,
+      id,
+    });
+
+    if (!includeComments) {
+      return SubCaseResponseRt.encode(
+        flattenSubCaseSavedObject({
+          savedObject: subCase,
+        })
+      );
+    }
+
+    const theComments = await caseService.getAllSubCaseComments({
+      soClient,
+      id,
+      options: {
+        sortField: 'created_at',
+        sortOrder: 'asc',
+      },
+    });
+
+    return SubCaseResponseRt.encode(
+      flattenSubCaseSavedObject({
+        savedObject: subCase,
+        comments: theComments.saved_objects,
+        totalComment: theComments.total,
+        totalAlerts: countAlertsForID({
+          comments: theComments,
+          id,
+        }),
+      })
+    );
+  } catch (error) {
+    throw createCaseError({
+      message: `Failed to get sub case id: ${id}: ${error}`,
+      error,
+      logger: clientArgs.logger,
+    });
+  }
+}