Skip to content

[7.x] Avoid mutating KQL query when validating it (#97081) #97411

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

Merged
pgayvallet merged 1 commit into from
Apr 18, 2021
Merged

[7.x] Avoid mutating KQL query when validating it (#97081) #97411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions src/core/server/saved_objects/service/lib/filter_utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* Side Public License, v 1.
*/

import { cloneDeep } from 'lodash';
// @ts-expect-error no ts
import { esKuery } from '../../es_query';

Expand Down Expand Up @@ -105,6 +106,22 @@ describe('Filter Utils', () => {
)
).toEqual(esKuery.fromKueryExpression('foo.title: "best"'));
});

test('does not mutate the input KueryNode', () => {
const input = esKuery.nodeTypes.function.buildNode(
'is',
`foo.attributes.title`,
'best',
true
);

const inputCopy = cloneDeep(input);

validateConvertFilterToKueryNode(['foo'], input, mockMappings);

expect(input).toEqual(inputCopy);
});

test('Validate a simple KQL expression filter', () => {
expect(
validateConvertFilterToKueryNode(['foo'], 'foo.attributes.title: "best"', mockMappings)
Expand Down
5 changes: 3 additions & 2 deletions src/core/server/saved_objects/service/lib/filter_utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@
*/

import { set } from '@elastic/safer-lodash-set';
import { get } from 'lodash';
import { get, cloneDeep } from 'lodash';
import { SavedObjectsErrorHelpers } from './errors';
import { IndexMapping } from '../../mappings';
// @ts-expect-error no ts
import { esKuery } from '../../es_query';

type KueryNode = any;

const astFunctionType = ['is', 'range', 'nested'];
Expand All @@ -23,7 +24,7 @@ export const validateConvertFilterToKueryNode = (
): KueryNode | undefined => {
if (filter && indexMapping) {
const filterKueryNode =
typeof filter === 'string' ? esKuery.fromKueryExpression(filter) : filter;
typeof filter === 'string' ? esKuery.fromKueryExpression(filter) : cloneDeep(filter);

const validationFilterKuery = validateFilterKueryNode({
astFilter: filterKueryNode,
Expand Down