Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Cases] Including owner when patching a comment Closes #102732 #103020

Merged
merged 3 commits into from
Jun 24, 2021
Merged

[Cases] Including owner when patching a comment Closes #102732 #103020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc7a06a
Including owner when patching a comment
jonathan-buttner Jun 22, 2021
fbc41b2
Fixing tests
jonathan-buttner Jun 23, 2021
3a3459f
Merge branch 'master' of github.com:elastic/kibana into fix-update-co…
jonathan-buttner Jun 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 17 additions & 14 deletions x-pack/plugins/cases/public/containers/api.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,33 +363,36 @@ describe('Case Configuration API', () => {
});

test('check url, method, signal', async () => {
await patchComment(
basicCase.id,
basicCase.comments[0].id,
'updated comment',
basicCase.comments[0].version,
abortCtrl.signal
);
await patchComment({
caseId: basicCase.id,
commentId: basicCase.comments[0].id,
commentUpdate: 'updated comment',
version: basicCase.comments[0].version,
signal: abortCtrl.signal,
owner: SECURITY_SOLUTION_OWNER,
});
expect(fetchMock).toHaveBeenCalledWith(`${CASES_URL}/${basicCase.id}/comments`, {
method: 'PATCH',
body: JSON.stringify({
comment: 'updated comment',
type: CommentType.user,
id: basicCase.comments[0].id,
version: basicCase.comments[0].version,
owner: SECURITY_SOLUTION_OWNER,
}),
signal: abortCtrl.signal,
});
});

test('happy path', async () => {
const resp = await patchComment(
basicCase.id,
basicCase.comments[0].id,
'updated comment',
basicCase.comments[0].version,
abortCtrl.signal
);
const resp = await patchComment({
caseId: basicCase.id,
commentId: basicCase.comments[0].id,
commentUpdate: 'updated comment',
version: basicCase.comments[0].version,
signal: abortCtrl.signal,
owner: SECURITY_SOLUTION_OWNER,
});
expect(resp).toEqual(basicCase);
});
});
Expand Down
26 changes: 18 additions & 8 deletions x-pack/plugins/cases/public/containers/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,21 +283,31 @@ export const postComment = async (
return convertToCamelCase<CaseResponse, Case>(decodeCaseResponse(response));
};

export const patchComment = async (
caseId: string,
commentId: string,
commentUpdate: string,
version: string,
signal: AbortSignal,
subCaseId?: string
): Promise<Case> => {
export const patchComment = async ({
caseId,
commentId,
commentUpdate,
version,
signal,
owner,
subCaseId,
}: {
caseId: string;
commentId: string;
commentUpdate: string;
version: string;
signal: AbortSignal;
owner: string;
subCaseId?: string;
}): Promise<Case> => {
const response = await KibanaServices.get().http.fetch<CaseResponse>(getCaseCommentsUrl(caseId), {
method: 'PATCH',
body: JSON.stringify({
comment: commentUpdate,
type: CommentType.user,
id: commentId,
version,
owner,
}),
...(subCaseId ? { query: { subCaseId } } : {}),
signal,
Expand Down
67 changes: 33 additions & 34 deletions x-pack/plugins/cases/public/containers/use_update_comment.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@
* 2.0.
*/

import React from 'react';
import { renderHook, act } from '@testing-library/react-hooks';
import { useUpdateComment, UseUpdateComment } from './use_update_comment';
import { basicCase, basicCaseCommentPatch, basicSubCaseId } from './mock';
import * as api from './api';
import { TestProviders } from '../common/mock';
import { SECURITY_SOLUTION_OWNER } from '../../common';

jest.mock('./api');
jest.mock('../common/lib/kibana');
Expand All @@ -25,16 +28,20 @@ describe('useUpdateComment', () => {
updateCase,
version: basicCase.comments[0].version,
};

const renderHookUseUpdateComment = () =>
renderHook<string, UseUpdateComment>(() => useUpdateComment(), {
wrapper: ({ children }) => <TestProviders>{children}</TestProviders>,
});

beforeEach(() => {
jest.clearAllMocks();
jest.restoreAllMocks();
});

it('init', async () => {
await act(async () => {
const { result, waitForNextUpdate } = renderHook<string, UseUpdateComment>(() =>
useUpdateComment()
);
const { result, waitForNextUpdate } = renderHookUseUpdateComment();
await waitForNextUpdate();
expect(result.current).toEqual({
isLoadingIds: [],
Expand All @@ -48,51 +55,47 @@ describe('useUpdateComment', () => {
const spyOnPatchComment = jest.spyOn(api, 'patchComment');

await act(async () => {
const { result, waitForNextUpdate } = renderHook<string, UseUpdateComment>(() =>
useUpdateComment()
);
const { result, waitForNextUpdate } = renderHookUseUpdateComment();
await waitForNextUpdate();

result.current.patchComment(sampleUpdate);
await waitForNextUpdate();
expect(spyOnPatchComment).toBeCalledWith(
basicCase.id,
basicCase.comments[0].id,
'updated comment',
basicCase.comments[0].version,
abortCtrl.signal,
undefined
);
expect(spyOnPatchComment).toBeCalledWith({
caseId: basicCase.id,
commentId: basicCase.comments[0].id,
commentUpdate: 'updated comment',
version: basicCase.comments[0].version,
signal: abortCtrl.signal,
owner: SECURITY_SOLUTION_OWNER,
subCaseId: undefined,
});
});
});

it('calls patchComment with correct arguments - sub case', async () => {
const spyOnPatchComment = jest.spyOn(api, 'patchComment');

await act(async () => {
const { result, waitForNextUpdate } = renderHook<string, UseUpdateComment>(() =>
useUpdateComment()
);
const { result, waitForNextUpdate } = renderHookUseUpdateComment();
await waitForNextUpdate();

result.current.patchComment({ ...sampleUpdate, subCaseId: basicSubCaseId });
await waitForNextUpdate();
expect(spyOnPatchComment).toBeCalledWith(
basicCase.id,
basicCase.comments[0].id,
'updated comment',
basicCase.comments[0].version,
abortCtrl.signal,
basicSubCaseId
);
expect(spyOnPatchComment).toBeCalledWith({
caseId: basicCase.id,
commentId: basicCase.comments[0].id,
commentUpdate: 'updated comment',
version: basicCase.comments[0].version,
signal: abortCtrl.signal,
owner: SECURITY_SOLUTION_OWNER,
subCaseId: basicSubCaseId,
});
});
});

it('patch comment', async () => {
await act(async () => {
const { result, waitForNextUpdate } = renderHook<string, UseUpdateComment>(() =>
useUpdateComment()
);
const { result, waitForNextUpdate } = renderHookUseUpdateComment();
await waitForNextUpdate();
result.current.patchComment(sampleUpdate);
await waitForNextUpdate();
Expand All @@ -108,9 +111,7 @@ describe('useUpdateComment', () => {

it('set isLoading to true when posting case', async () => {
await act(async () => {
const { result, waitForNextUpdate } = renderHook<string, UseUpdateComment>(() =>
useUpdateComment()
);
const { result, waitForNextUpdate } = renderHookUseUpdateComment();
await waitForNextUpdate();
result.current.patchComment(sampleUpdate);

Expand All @@ -125,9 +126,7 @@ describe('useUpdateComment', () => {
});

await act(async () => {
const { result, waitForNextUpdate } = renderHook<string, UseUpdateComment>(() =>
useUpdateComment()
);
const { result, waitForNextUpdate } = renderHookUseUpdateComment();
await waitForNextUpdate();
result.current.patchComment(sampleUpdate);

Expand Down
13 changes: 9 additions & 4 deletions x-pack/plugins/cases/public/containers/use_update_comment.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import { useReducer, useCallback, useRef, useEffect } from 'react';
import { useToasts } from '../common/lib/kibana';
import { useOwnerContext } from '../components/owner_context/use_owner_context';
import { patchComment } from './api';
import * as i18n from './translations';
import { Case } from './types';
Expand Down Expand Up @@ -72,6 +73,9 @@ export const useUpdateComment = (): UseUpdateComment => {
const toasts = useToasts();
const isCancelledRef = useRef(false);
const abortCtrlRef = useRef(new AbortController());
// this hook guarantees that there will be at least one value in the owner array, we'll
// just use the first entry just in case there are more than one entry
const owner = useOwnerContext()[0];

const dispatchUpdateComment = useCallback(
async ({
Expand All @@ -89,14 +93,15 @@ export const useUpdateComment = (): UseUpdateComment => {
abortCtrlRef.current = new AbortController();
dispatch({ type: 'FETCH_INIT', payload: commentId });

const response = await patchComment(
const response = await patchComment({
caseId,
commentId,
commentUpdate,
version,
abortCtrlRef.current.signal,
subCaseId
);
signal: abortCtrlRef.current.signal,
subCaseId,
owner,
});

if (!isCancelledRef.current) {
updateCase(response);
Expand Down