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

Refactoring network TLS to use useSearchStrategy #136187

Merged
merged 3 commits into from
Jul 19, 2022
Merged

Refactoring network TLS to use useSearchStrategy #136187

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
6255b05
Refactoring network TLS to use useSearchStrategy
angorayc Jul 12, 2022
0c7aa95
Merge branch 'main' into useSearchStrategy/tls
kibanamachine Jul 18, 2022
944eeb4
Merge branch 'main' into useSearchStrategy/tls
kibanamachine Jul 18, 2022
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
73 changes: 61 additions & 12 deletions x-pack/plugins/security_solution/public/network/containers/tls/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,77 @@
import { act, renderHook } from '@testing-library/react-hooks';
import { TestProviders } from '../../../common/mock';
import { ID, useNetworkTls } from '.';
import { NetworkType } from '../../store/model';
import { useSearchStrategy } from '../../../common/containers/use_search_strategy';
import { networkModel } from '../../store';
import { FlowTargetSourceDest } from '../../../../common/search_strategy';

jest.mock('../../../common/containers/use_search_strategy', () => ({
useSearchStrategy: jest.fn(),
}));
const mockUseSearchStrategy = useSearchStrategy as jest.Mock;
const mockSearch = jest.fn();

const props = {
endDate: '2020-07-08T08:20:18.966Z',
flowTarget: FlowTargetSourceDest.source,
id: ID,
indexNames: ['auditbeat-*'],
ip: '139.177.197.217',
skip: false,
startDate: '2020-07-07T08:20:18.966Z',
type: networkModel.NetworkType.page,
};

describe('useNetworkTls', () => {
beforeEach(() => {
jest.clearAllMocks();
mockUseSearchStrategy.mockReturnValue({
loading: false,
result: {
edges: [],
totalCount: -1,
pageInfo: {
activePage: 0,
fakeTotalCount: 0,
showMorePagesIndicator: false,
},
},
search: mockSearch,
refetch: jest.fn(),
inspect: {},
});
});

it('runs search', () => {
renderHook(() => useNetworkTls(props), {
wrapper: TestProviders,
});

expect(mockSearch).toHaveBeenCalled();
});

it('does not run search when skip = true', () => {
const localProps = {
...props,
skip: true,
};
renderHook(() => useNetworkTls(localProps), {
wrapper: TestProviders,
});

expect(mockSearch).not.toHaveBeenCalled();
});

it('skip = true will cancel any running request', () => {
const abortSpy = jest.spyOn(AbortController.prototype, 'abort');
const localProps = {
docValueFields: [],
flowTarget: FlowTargetSourceDest.source,
startDate: '2020-07-07T08:20:18.966Z',
endDate: '2020-07-08T08:20:18.966Z',
id: `${ID}-${NetworkType.page}`,
indexNames: ['cool'],
ip: '1.1.1.1',
type: NetworkType.page,
skip: false,
...props,
};
const { rerender } = renderHook(() => useNetworkTls(localProps), {
wrapper: TestProviders,
});
localProps.skip = true;
act(() => rerender());
expect(abortSpy).toHaveBeenCalledTimes(4);
expect(mockUseSearchStrategy).toHaveBeenCalledTimes(3);
expect(mockUseSearchStrategy.mock.calls[2][0].abort).toEqual(true);
});
});
144 changes: 50 additions & 94 deletions x-pack/plugins/security_solution/public/network/containers/tls/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,12 @@
* 2.0.
*/

import { noop } from 'lodash/fp';
import { useState, useEffect, useCallback, useMemo, useRef } from 'react';
import { useState, useEffect, useCallback, useMemo } from 'react';
import deepEqual from 'fast-deep-equal';
import { Subscription } from 'rxjs';

import { isCompleteResponse, isErrorResponse } from '@kbn/data-plugin/common';
import type { ESTermQuery } from '../../../../common/typed_json';
import type { inputsModel } from '../../../common/store';
import { useDeepEqualSelector } from '../../../common/hooks/use_selector';
import { useKibana } from '../../../common/lib/kibana';
import { createFilter } from '../../../common/containers/helpers';
import { generateTablePaginationOptions } from '../../../common/components/paginated_table/helpers';
import type { networkModel } from '../../store';
Expand All @@ -26,9 +22,8 @@ import type {
import { NetworkQueries } from '../../../../common/search_strategy/security_solution/network';

import * as i18n from './translations';
import { getInspectResponse } from '../../../helpers';
import type { FlowTargetSourceDest, PageInfoPaginated } from '../../../../common/search_strategy';
import { useAppToasts } from '../../../common/hooks/use_app_toasts';
import { useSearchStrategy } from '../../../common/containers/use_search_strategy';

export const ID = 'networkTlsQuery';

Expand Down Expand Up @@ -70,17 +65,12 @@ export const useNetworkTls = ({
const { activePage, limit, sort } = useDeepEqualSelector((state) =>
getTlsSelector(state, type, flowTarget)
);
const { data } = useKibana().services;
const refetch = useRef<inputsModel.Refetch>(noop);
const abortCtrl = useRef(new AbortController());
const searchSubscription$ = useRef(new Subscription());
const [loading, setLoading] = useState(false);

const [networkTlsRequest, setHostRequest] = useState<NetworkTlsRequestOptions | null>(null);
const [networkTlsRequest, setNetworkTlsRequest] = useState<NetworkTlsRequestOptions | null>(null);

const wrappedLoadMore = useCallback(
(newActivePage: number) => {
setHostRequest((prevRequest) => {
setNetworkTlsRequest((prevRequest) => {
if (!prevRequest) {
return prevRequest;
}
Expand All @@ -94,79 +84,55 @@ export const useNetworkTls = ({
[limit]
);

const [networkTlsResponse, setNetworkTlsResponse] = useState<NetworkTlsArgs>({
tls: [],
id: ID,
inspect: {
dsl: [],
response: [],
const {
loading,
result: response,
search,
refetch,
inspect,
} = useSearchStrategy<NetworkQueries.tls>({
factoryQueryType: NetworkQueries.tls,
initialResult: {
edges: [],
totalCount: -1,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is what was there before but find it a little odd. It's not related to your PR, but i think we should set this to 0. and change code elsewhere that would be problematic because of that.

In public/common/components/paginated_table/index.tsx we have
const pageCount = Math.ceil(totalCount / limit);
which is why I think we have a -1 as default as otherwise, if it were 0 this calculation would equal Infinity. But we could change the code here to be `totalCount ? totalCount / limit : 1, or some such equivolent.

Maybe there is another reason though

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

++ to the suggestion above. At least we need some explanation in the code why it is -1.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think it's to differentiate the initial value and the fetched value and avoid the calculation error. I'll create an issue to review all the places that have this implementation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#136672

pageInfo: {
activePage: 0,
fakeTotalCount: 0,
showMorePagesIndicator: false,
},
},
isInspected: false,
loadPage: wrappedLoadMore,
pageInfo: {
activePage: 0,
fakeTotalCount: 0,
showMorePagesIndicator: false,
},
refetch: refetch.current,
totalCount: -1,
errorMessage: i18n.FAIL_NETWORK_TLS,
abort: skip,
});
const { addError, addWarning } = useAppToasts();

const networkTlsSearch = useCallback(
(request: NetworkTlsRequestOptions | null) => {
if (request == null || skip) {
return;
}

const asyncSearch = async () => {
abortCtrl.current = new AbortController();
setLoading(true);

searchSubscription$.current = data.search
.search<NetworkTlsRequestOptions, NetworkTlsStrategyResponse>(request, {
strategy: 'securitySolutionSearchStrategy',
abortSignal: abortCtrl.current.signal,
})
.subscribe({
next: (response) => {
if (isCompleteResponse(response)) {
setLoading(false);
setNetworkTlsResponse((prevResponse) => ({
...prevResponse,
tls: response.edges,
inspect: getInspectResponse(response, prevResponse.inspect),
pageInfo: response.pageInfo,
refetch: refetch.current,
totalCount: response.totalCount,
}));

searchSubscription$.current.unsubscribe();
} else if (isErrorResponse(response)) {
setLoading(false);
addWarning(i18n.ERROR_NETWORK_TLS);
searchSubscription$.current.unsubscribe();
}
},
error: (msg) => {
setLoading(false);
addError(msg, {
title: i18n.FAIL_NETWORK_TLS,
});
searchSubscription$.current.unsubscribe();
},
});
};
searchSubscription$.current.unsubscribe();
abortCtrl.current.abort();
asyncSearch();
refetch.current = asyncSearch;
},
[data.search, addError, addWarning, skip]
const networkTlsResponse = useMemo(
() => ({
endDate,
tls: response.edges,
id,
inspect,
isInspected: false,
loadPage: wrappedLoadMore,
pageInfo: response.pageInfo,
refetch,
startDate,
totalCount: response.totalCount,
}),
[
endDate,
id,
inspect,
refetch,
response.edges,
response.pageInfo,
response.totalCount,
startDate,
wrappedLoadMore,
]
);

useEffect(() => {
setHostRequest((prevRequest) => {
setNetworkTlsRequest((prevRequest) => {
const myRequest = {
...(prevRequest ?? {}),
defaultIndex: indexNames,
Expand All @@ -190,20 +156,10 @@ export const useNetworkTls = ({
}, [activePage, indexNames, endDate, filterQuery, limit, startDate, sort, flowTarget, ip, id]);

useEffect(() => {
networkTlsSearch(networkTlsRequest);
return () => {
searchSubscription$.current.unsubscribe();
abortCtrl.current.abort();
};
}, [networkTlsRequest, networkTlsSearch]);

useEffect(() => {
if (skip) {
setLoading(false);
searchSubscription$.current.unsubscribe();
abortCtrl.current.abort();
if (!skip && networkTlsRequest) {
search(networkTlsRequest);
}
}, [skip]);
}, [networkTlsRequest, search, skip]);

return [loading, networkTlsResponse];
};