Skip to content

[9.3] [Lens] Fix KQL character escaping when query is generated from Top values column (breakdown). (#250925) #252264

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
awahab07 merged 1 commit into from
Feb 11, 2026
Merged

[9.3] [Lens] Fix KQL character escaping when query is generated from Top values column (breakdown). (#250925) #252264

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
53 changes: 53 additions & 0 deletions x-pack/platform/plugins/shared/lens/public/datasources/form_based/form_based.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2481,6 +2481,59 @@ describe('IndexPattern Data Source', () => {
disabled: { kuery: [], lucene: [] },
});
});
it('should escape special characters in term values for valid KQL syntax', () => {
publicAPI = FormBasedDatasource.getPublicAPI({
state: {
...baseState,
layers: {
first: {
indexPatternId: '1',
columnOrder: ['col1'],
columns: {
col1: {
label: 'Terms',
dataType: 'string',
isBucketed: true,
operationType: 'terms',
sourceField: 'path.keyword',
params: {
orderBy: { type: 'alphabetical' },
orderDirection: 'asc',
size: 10,
},
} as TermsIndexPatternColumn,
},
},
},
},
layerId: 'first',
indexPatterns,
});
const data = {
first: {
type: 'datatable' as const,
columns: [{ id: 'col1', name: 'path.keyword', meta: { type: 'string' as const } }],
rows: [
{ col1: 'C:\\' },
{ col1: 'path with "quotes"' },
{ col1: 'backslash\\and"quote' },
],
},
};
expect(publicAPI.getFilters(data)).toEqual({
enabled: {
kuery: [
[
{ language: 'kuery', query: 'path.keyword: "C:\\\\"' },
{ language: 'kuery', query: 'path.keyword: "path with \\"quotes\\""' },
{ language: 'kuery', query: 'path.keyword: "backslash\\\\and\\"quote"' },
],
],
lucene: [],
},
disabled: { kuery: [], lucene: [] },
});
});
it('should ignore top values fields if other/missing option is enabled', () => {
publicAPI = FormBasedDatasource.getPublicAPI({
state: {
Expand Down
11 changes: 4 additions & 7 deletions x-pack/platform/plugins/shared/lens/public/datasources/form_based/utils.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ import { FormattedMessage } from '@kbn/i18n-react';
import type { DocLinksStart, ThemeServiceStart } from '@kbn/core/public';
import { hasUnsupportedDownsampledAggregationFailure } from '@kbn/search-response-warnings';
import type { DatatableUtilitiesService } from '@kbn/data-plugin/common';
import type { TimeRange } from '@kbn/es-query';
import { escapeQuotes, type TimeRange } from '@kbn/es-query';
import { EuiLink, EuiSpacer } from '@elastic/eui';

import type { DatatableColumn } from '@kbn/expressions-plugin/common';
import { groupBy, escape, uniq, uniqBy } from 'lodash';
import { groupBy, uniq, uniqBy } from 'lodash';
import type { Query } from '@kbn/data-plugin/common';

import {
Expand Down Expand Up @@ -747,13 +747,10 @@ function extractQueriesFromTerms(
}
if (typeof value !== 'string' && Array.isArray(value.keys)) {
return value.keys
.map(
(term: string, index: number) =>
`${fields[index]}: ${`"${term === '' ? escape(term) : term}"`}`
)
.map((term: string, index: number) => `${fields[index]}: "${escapeQuotes(term)}"`)
.join(' AND ');
}
return `${column.sourceField}: ${`"${value === '' ? escape(value) : value}"`}`;
return `${column.sourceField}: "${escapeQuotes(String(value))}"`;
})
.filter(Boolean) as string[];

Expand Down