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.

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

[Security Solution] [Fix] Alert Page Controls do not recover from invalid query. #156542

Merged
merged 3 commits into from
May 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,19 @@ const getStoreWithCustomState = (newState: typeof state = state) => {
return createStore(newState, SUB_PLUGINS_REDUCER, kibanaObservable, storage);
};

const TestComponent: FC<ComponentProps<typeof TestProviders>> = (props) => (
const TestComponent: FC<
ComponentProps<typeof TestProviders> & {
filterGroupProps?: Partial<ComponentProps<typeof FilterGroup>>;
}
> = (props) => (
<TestProviders store={getStoreWithCustomState()} {...props}>
<FilterGroup
initialControls={DEFAULT_DETECTION_PAGE_FILTERS}
dataViewId="security-solution-default"
chainingSystem="HIERARCHICAL"
onFilterChange={onFilterChangeMock}
onInit={onInitMock}
{...props.filterGroupProps}
/>
</TestProviders>
);
Expand Down Expand Up @@ -525,6 +530,36 @@ describe(' Filter Group Component ', () => {
expect(screen.queryByTestId(TEST_IDS.SAVE_CHANGE_POPOVER)).toBeVisible();
});
});
it('should update controlGroup with new filters and queries when valid query is supplied', async () => {
const validQuery = { query: { language: 'kuery', query: '' } };
// pass an invalid query
render(<TestComponent filterGroupProps={validQuery} />);

await waitFor(() => {
expect(controlGroupMock.updateInput).toHaveBeenNthCalledWith(
1,
expect.objectContaining({
filters: undefined,
query: validQuery.query,
})
);
});
});

it('should not update controlGroup with new filters and queries when invalid query is supplied', async () => {
const invalidQuery = { query: { language: 'kuery', query: '\\' } };
// pass an invalid query
render(<TestComponent filterGroupProps={invalidQuery} />);

await waitFor(() => {
expect(controlGroupMock.updateInput).toHaveBeenCalledWith(
expect.objectContaining({
filters: [],
query: undefined,
})
);
});
});
});

describe('Filter Changed Banner', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ import { FilterGroupContext } from './filter_group_context';
import { NUM_OF_CONTROLS } from './config';
import { TEST_IDS } from './constants';
import { URL_PARAM_ARRAY_EXCEPTION_MSG } from './translations';
import { convertToBuildEsQuery } from '../../lib/kuery';

const FilterWrapper = styled.div.attrs((props) => ({
className: props.className,
Expand Down Expand Up @@ -149,14 +150,41 @@ const FilterGroupComponent = (props: PropsWithChildren<FilterGroupProps>) => {
return cleanup;
}, []);

const { filters: validatedFilters, query: validatedQuery } = useMemo(() => {
const [_, kqlError] = convertToBuildEsQuery({
config: {},
queries: query ? [query] : [],
filters: filters ?? [],
indexPattern: { fields: [], title: '' },
});

// we only need to handle kqlError because control group can handle Lucene error
if (kqlError) {
/*
* Based on the behaviour from other components,
* ignore all filters and queries if there is some error
* in the input filters and queries
*
* */
return {
filters: [],
query: undefined,
};
}
return {
filters,
query,
};
}, [filters, query]);

useEffect(() => {
controlGroup?.updateInput({
filters: validatedFilters,
query: validatedQuery,
timeRange,
filters,
query,
chainingSystem,
});
}, [timeRange, filters, query, chainingSystem, controlGroup]);
}, [timeRange, chainingSystem, controlGroup, validatedQuery, validatedFilters]);

const handleInputUpdates = useCallback(
(newInput: ControlGroupInput) => {
Expand All @@ -171,7 +199,7 @@ const FilterGroupComponent = (props: PropsWithChildren<FilterGroupProps>) => {
[setControlGroupInputUpdates, getStoredControlInput, isViewMode, setHasPendingChanges]
);

const handleFilterUpdates = useCallback(
const handleOutputFilterUpdates = useCallback(
({ filters: newFilters }: ControlGroupOutput) => {
if (isEqual(currentFiltersRef.current, newFilters)) return;
if (onFilterChange) onFilterChange(newFilters ?? []);
Expand All @@ -181,8 +209,8 @@ const FilterGroupComponent = (props: PropsWithChildren<FilterGroupProps>) => {
);

const debouncedFilterUpdates = useMemo(
() => debounce(handleFilterUpdates, 500),
[handleFilterUpdates]
() => debounce(handleOutputFilterUpdates, 500),
[handleOutputFilterUpdates]
);

useEffect(() => {
Expand Down