[Cases] Remove case info from alerts when deleting an alert attachment (

#154024) ## Summary Users can remove alerts from a case by deleting the whole alert attachment. This PR removes the case id from the alerts when deleting an attachment of type alert. It does not remove the case info from all alerts attached to a case when deleting a case. It also fixes a bug where the success toaster will not show when deleting an attachment. Related: #146864, #140800 ## Testing 1. Create a case and attach some alerts to the case. 2. Verify that the alerts table (in security or in o11y) shows the case the alert is attached to. You can enable the cases column by pressing "Fields", searching for "Cases", and then selecting the field. 3. Go to the case and find the alerts' user activity. 4. Press the `...` and press "Remove alerts(s)" 5. Go back to the alert table and verify that the case is not shown in the Cases column for each alert. Please check that when you remove alert(s), attachments (ml, etc), and comments you get a success toaster with the correct text. ### 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)
elastic · Apr 1, 2023 · 3a6f721 · 3a6f721
1 parent 41fb8f3
commit 3a6f721
Show file tree

Hide file tree

Showing 22 changed files with 1,041 additions and 53 deletions.
diff --git a/x-pack/plugins/cases/common/utils/attachments.test.ts b/x-pack/plugins/cases/common/utils/attachments.test.ts
@@ -0,0 +1,59 @@
+/*
+ * 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 { CommentAttributes } from '../api';
+import { CommentType } from '../api';
+import {
+  isCommentRequestTypeExternalReference,
+  isCommentRequestTypePersistableState,
+} from './attachments';
+
+describe('attachments utils', () => {
+  describe('isCommentRequestTypeExternalReference', () => {
+    const externalReferenceAttachment = {
+      type: CommentType.externalReference as const,
+    } as CommentAttributes;
+
+    const commentTypeWithoutAlert = Object.values(CommentType).filter(
+      (type) => type !== CommentType.externalReference
+    );
+
+    it('returns false for type: externalReference', () => {
+      expect(isCommentRequestTypeExternalReference(externalReferenceAttachment)).toBe(true);
+    });
+
+    it.each(commentTypeWithoutAlert)('returns false for type: %s', (type) => {
+      const attachment = {
+        type,
+      } as CommentAttributes;
+
+      expect(isCommentRequestTypeExternalReference(attachment)).toBe(false);
+    });
+  });
+
+  describe('isCommentRequestTypePersistableState', () => {
+    const persistableStateAttachment = {
+      type: CommentType.persistableState as const,
+    } as CommentAttributes;
+
+    const commentTypeWithoutAlert = Object.values(CommentType).filter(
+      (type) => type !== CommentType.persistableState
+    );
+
+    it('returns false for type: persistableState', () => {
+      expect(isCommentRequestTypePersistableState(persistableStateAttachment)).toBe(true);
+    });
+
+    it.each(commentTypeWithoutAlert)('returns false for type: %s', (type) => {
+      const attachment = {
+        type,
+      } as CommentAttributes;
+
+      expect(isCommentRequestTypePersistableState(attachment)).toBe(false);
+    });
+  });
+});
diff --git a/x-pack/plugins/cases/public/components/user_actions/comment/alert.tsx b/x-pack/plugins/cases/public/components/user_actions/comment/alert.tsx
@@ -21,6 +21,7 @@ import { ShowAlertTableLink } from './show_alert_table_link';
 import { HoverableUserWithAvatarResolver } from '../../user_profiles/hoverable_user_with_avatar_resolver';
 import { UserActionContentToolbar } from '../content_toolbar';
 import { AlertPropertyActions } from '../property_actions/alert_property_actions';
+import { DELETE_ALERTS_SUCCESS_TITLE } from './translations';
 
 type BuilderArgs = Pick<
   UserActionBuilderArgs,
@@ -88,7 +89,7 @@ const getSingleAlertUserAction = ({
             />
           </EuiFlexItem>
           <AlertPropertyActions
-            onDelete={() => handleDeleteComment(comment.id)}
+            onDelete={() => handleDeleteComment(comment.id, DELETE_ALERTS_SUCCESS_TITLE(1))}
             isLoading={loadingCommentIds.includes(comment.id)}
             totalAlerts={1}
           />
@@ -142,7 +143,9 @@ const getMultipleAlertsUserAction = ({
             <ShowAlertTableLink />
           </EuiFlexItem>
           <AlertPropertyActions
-            onDelete={() => handleDeleteComment(comment.id)}
+            onDelete={() =>
+              handleDeleteComment(comment.id, DELETE_ALERTS_SUCCESS_TITLE(totalAlerts))
+            }
             isLoading={loadingCommentIds.includes(comment.id)}
             totalAlerts={totalAlerts}
           />

diff --git a/x-pack/plugins/cases/public/components/user_actions/comment/comment.test.tsx b/x-pack/plugins/cases/public/components/user_actions/comment/comment.test.tsx
@@ -201,7 +201,10 @@ describe('createCommentUserActionBuilder', () => {
       await deleteAttachment(result, 'trash', 'Delete');
 
       await waitFor(() => {
-        expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith('basic-comment-id');
+        expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith(
+          'basic-comment-id',
+          'Deleted comment'
+        );
       });
     });
 
@@ -319,7 +322,10 @@ describe('createCommentUserActionBuilder', () => {
       await deleteAttachment(res, 'minusInCircle', 'Remove');
 
       await waitFor(() => {
-        expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith('alert-comment-id');
+        expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith(
+          'alert-comment-id',
+          'Deleted one alert'
+        );
       });
     });
 
@@ -414,7 +420,10 @@ describe('createCommentUserActionBuilder', () => {
       await deleteAttachment(res, 'minusInCircle', 'Remove');
 
       await waitFor(() => {
-        expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith('alert-comment-id');
+        expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith(
+          'alert-comment-id',
+          'Deleted 2 alerts'
+        );
       });
     });
 
@@ -590,7 +599,8 @@ describe('createCommentUserActionBuilder', () => {
 
       await waitFor(() => {
         expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith(
-          'external-reference-comment-id'
+          'external-reference-comment-id',
+          'Deleted attachment'
         );
       });
     });
@@ -761,7 +771,8 @@ describe('createCommentUserActionBuilder', () => {
 
       await waitFor(() => {
         expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith(
-          'persistable-state-comment-id'
+          'persistable-state-comment-id',
+          'Deleted attachment'
         );
       });
     });

diff --git a/x-pack/plugins/cases/public/components/user_actions/comment/registered_attachments.tsx b/x-pack/plugins/cases/public/components/user_actions/comment/registered_attachments.tsx
@@ -21,7 +21,11 @@ import type { CommentResponse } from '../../../../common/api';
 import type { UserActionBuilder, UserActionBuilderArgs } from '../types';
 import { UserActionTimestamp } from '../timestamp';
 import type { SnakeToCamelCase } from '../../../../common/types';
-import { ATTACHMENT_NOT_REGISTERED_ERROR, DEFAULT_EVENT_ATTACHMENT_TITLE } from './translations';
+import {
+  ATTACHMENT_NOT_REGISTERED_ERROR,
+  DEFAULT_EVENT_ATTACHMENT_TITLE,
+  DELETE_REGISTERED_ATTACHMENT,
+} from './translations';
 import { UserActionContentToolbar } from '../content_toolbar';
 import { HoverableUserWithAvatarResolver } from '../../user_profiles/hoverable_user_with_avatar_resolver';
 import { RegisteredAttachmentsPropertyActions } from '../property_actions/registered_attachments_property_actions';
@@ -127,7 +131,7 @@ export const createRegisteredAttachmentUserActionBuilder = <
             {attachmentViewObject.actions}
             <RegisteredAttachmentsPropertyActions
               isLoading={isLoading}
-              onDelete={() => handleDeleteComment(comment.id)}
+              onDelete={() => handleDeleteComment(comment.id, DELETE_REGISTERED_ATTACHMENT)}
             />
           </UserActionContentToolbar>
         ),

diff --git a/x-pack/plugins/cases/public/components/user_actions/comment/translations.tsx b/x-pack/plugins/cases/public/components/user_actions/comment/translations.tsx
@@ -39,3 +39,24 @@ export const UNSAVED_DRAFT_COMMENT = i18n.translate(
     defaultMessage: 'You have unsaved edits for this comment',
   }
 );
+
+export const DELETE_ALERTS_SUCCESS_TITLE = (totalAlerts: number) =>
+  i18n.translate('xpack.cases.userActions.attachments.alerts.successToasterTitle', {
+    defaultMessage:
+      'Deleted {totalAlerts, plural, =1 {one} other {{totalAlerts}}} {totalAlerts, plural, =1 {alert} other {alerts}}',
+    values: { totalAlerts },
+  });
+
+export const DELETE_COMMENT_SUCCESS_TITLE = i18n.translate(
+  'xpack.cases.userActions.attachments.comment.successToasterTitle',
+  {
+    defaultMessage: 'Deleted comment',
+  }
+);
+
+export const DELETE_REGISTERED_ATTACHMENT = i18n.translate(
+  'xpack.cases.userActions.attachments.registeredAttachment.successToasterTitle',
+  {
+    defaultMessage: 'Deleted attachment',
+  }
+);
diff --git a/x-pack/plugins/cases/public/components/user_actions/comment/user.tsx b/x-pack/plugins/cases/public/components/user_actions/comment/user.tsx
@@ -115,7 +115,7 @@ export const createUserAttachmentUserActionBuilder = ({
             isLoading={isLoading}
             commentContent={comment.comment}
             onEdit={() => handleManageMarkdownEditId(comment.id)}
-            onDelete={() => handleDeleteComment(comment.id)}
+            onDelete={() => handleDeleteComment(comment.id, i18n.DELETE_COMMENT_SUCCESS_TITLE)}
             onQuote={() => handleManageQuote(comment.comment)}
           />
         </UserActionContentToolbar>

diff --git a/x-pack/plugins/cases/public/components/user_actions/types.ts b/x-pack/plugins/cases/public/components/user_actions/types.ts
@@ -69,7 +69,7 @@ export interface UserActionBuilderArgs {
   handleOutlineComment: (id: string) => void;
   handleManageMarkdownEditId: (id: string) => void;
   handleSaveComment: ({ id, version }: { id: string; version: string }, content: string) => void;
-  handleDeleteComment: (id: string) => void;
+  handleDeleteComment: (id: string, successToasterTitle: string) => void;
   handleManageQuote: (quote: string) => void;
   onShowAlertDetails: (alertId: string, index: string) => void;
   getRuleDetailsHref?: RuleDetailsNavigation['href'];

diff --git a/x-pack/plugins/cases/public/components/user_actions/use_user_actions_handler.tsx b/x-pack/plugins/cases/public/components/user_actions/use_user_actions_handler.tsx
@@ -76,8 +76,8 @@ export const useUserActionsHandler = (): UseUserActionsHandler => {
   );
 
   const handleDeleteComment = useCallback(
-    (id: string) => {
-      deleteComment({ caseId, commentId: id });
+    (id: string, successToasterTitle: string) => {
+      deleteComment({ caseId, commentId: id, successToasterTitle });
     },
     [caseId, deleteComment]
   );

diff --git a/x-pack/plugins/cases/public/containers/use_delete_comment.test.tsx b/x-pack/plugins/cases/public/containers/use_delete_comment.test.tsx
@@ -5,37 +5,38 @@
  * 2.0.
  */
 
-import React from 'react';
 import { act, renderHook } from '@testing-library/react-hooks';
-import type { UseDeleteComment } from './use_delete_comment';
 import { useDeleteComment } from './use_delete_comment';
 import * as api from './api';
 import { basicCaseId } from './mock';
-import { TestProviders } from '../common/mock';
 import { useRefreshCaseViewPage } from '../components/case_view/use_on_refresh_case_view_page';
 import { useToasts } from '../common/lib/kibana';
+import type { AppMockRenderer } from '../common/mock';
+import { createAppMockRenderer } from '../common/mock';
 
 jest.mock('../common/lib/kibana');
 jest.mock('./api');
 jest.mock('../components/case_view/use_on_refresh_case_view_page');
 
 const commentId = 'ab124';
-
-const wrapper: React.FC<string> = ({ children }) => <TestProviders>{children}</TestProviders>;
+const successToasterTitle = 'Deleted';
 
 describe('useDeleteComment', () => {
   const addSuccess = jest.fn();
   const addError = jest.fn();
 
   (useToasts as jest.Mock).mockReturnValue({ addSuccess, addError });
 
+  let appMockRender: AppMockRenderer;
+
   beforeEach(() => {
+    appMockRender = createAppMockRenderer();
     jest.clearAllMocks();
   });
 
   it('init', async () => {
-    const { result } = renderHook<string, UseDeleteComment>(() => useDeleteComment(), {
-      wrapper,
+    const { result } = renderHook(() => useDeleteComment(), {
+      wrapper: appMockRender.AppWrapper,
     });
 
     expect(result.current).toBeTruthy();
@@ -44,17 +45,15 @@ describe('useDeleteComment', () => {
   it('calls deleteComment with correct arguments - case', async () => {
     const spyOnDeleteComment = jest.spyOn(api, 'deleteComment');
 
-    const { waitForNextUpdate, result } = renderHook<string, UseDeleteComment>(
-      () => useDeleteComment(),
-      {
-        wrapper,
-      }
-    );
+    const { waitForNextUpdate, result } = renderHook(() => useDeleteComment(), {
+      wrapper: appMockRender.AppWrapper,
+    });
 
     act(() => {
       result.current.mutate({
         caseId: basicCaseId,
         commentId,
+        successToasterTitle,
       });
     });
 
@@ -68,37 +67,54 @@ describe('useDeleteComment', () => {
   });
 
   it('refreshes the case page view after delete', async () => {
-    const { waitForNextUpdate, result } = renderHook<string, UseDeleteComment>(
-      () => useDeleteComment(),
-      {
-        wrapper,
-      }
-    );
+    const { waitForNextUpdate, result } = renderHook(() => useDeleteComment(), {
+      wrapper: appMockRender.AppWrapper,
+    });
 
     result.current.mutate({
       caseId: basicCaseId,
       commentId,
+      successToasterTitle,
     });
 
     await waitForNextUpdate();
 
     expect(useRefreshCaseViewPage()).toBeCalled();
   });
 
+  it('shows a success toaster correctly', async () => {
+    const { waitForNextUpdate, result } = renderHook(() => useDeleteComment(), {
+      wrapper: appMockRender.AppWrapper,
+    });
+
+    act(() => {
+      result.current.mutate({
+        caseId: basicCaseId,
+        commentId,
+        successToasterTitle,
+      });
+    });
+
+    await waitForNextUpdate();
+
+    expect(addSuccess).toHaveBeenCalledWith({
+      title: 'Deleted',
+      className: 'eui-textBreakWord',
+    });
+  });
+
   it('sets isError when fails to delete a case', async () => {
     const spyOnDeleteComment = jest.spyOn(api, 'deleteComment');
-    spyOnDeleteComment.mockRejectedValue(new Error('Not possible :O'));
+    spyOnDeleteComment.mockRejectedValue(new Error('Error'));
 
-    const { waitForNextUpdate, result } = renderHook<string, UseDeleteComment>(
-      () => useDeleteComment(),
-      {
-        wrapper,
-      }
-    );
+    const { waitForNextUpdate, result } = renderHook(() => useDeleteComment(), {
+      wrapper: appMockRender.AppWrapper,
+    });
 
     result.current.mutate({
       caseId: basicCaseId,
       commentId,
+      successToasterTitle,
     });
 
     await waitForNextUpdate();

diff --git a/x-pack/plugins/cases/public/containers/use_delete_comment.tsx b/x-pack/plugins/cases/public/containers/use_delete_comment.tsx
@@ -16,10 +16,11 @@ import * as i18n from './translations';
 interface MutationArgs {
   caseId: string;
   commentId: string;
+  successToasterTitle: string;
 }
 
 export const useDeleteComment = () => {
-  const { showErrorToast } = useCasesToast();
+  const { showErrorToast, showSuccessToast } = useCasesToast();
   const refreshCaseViewPage = useRefreshCaseViewPage();
 
   return useMutation(
@@ -29,7 +30,8 @@ export const useDeleteComment = () => {
     },
     {
       mutationKey: casesMutationsKeys.deleteComment,
-      onSuccess: () => {
+      onSuccess: (_, { successToasterTitle }) => {
+        showSuccessToast(successToasterTitle);
         refreshCaseViewPage();
       },
       onError: (error: ServerError) => {

diff --git a/x-pack/plugins/cases/server/client/alerts/types.ts b/x-pack/plugins/cases/server/client/alerts/types.ts
@@ -42,3 +42,8 @@ export interface UpdateAlertCasesRequest {
   alerts: AlertInfo[];
   caseIds: string[];
 }
+
+export interface RemoveAlertsFromCaseRequest {
+  alerts: AlertInfo[];
+  caseId: string;
+}