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

[EuiSearchBar] Automatically wrap special characters (that aren't used in EQL syntax) in quotes #6356

Merged
merged 4 commits into from
Nov 16, 2022
Merged
Show file tree
Hide file tree
Changes from 2 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
10 changes: 5 additions & 5 deletions src-docs/src/views/search_bar/search_bar.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ import {
const random = new Random();

const tags = [
{ name: 'marketing', color: 'danger' },
{ name: 'finance', color: 'success' },
{ name: 'eng', color: 'success' },
{ name: 'sales', color: 'warning' },
{ name: 'ga', color: 'success' },
{ name: 'market ing', color: 'danger' },
{ name: 'fi@nance', color: 'success' },
{ name: 'eng!&$#%^', color: 'success' },
{ name: 's*a:les', color: 'warning' },
{ name: 'g\\a/', color: 'success' },
];

const types = ['dashboard', 'visualization', 'watch'];
Expand Down
48 changes: 24 additions & 24 deletions src-docs/src/views/tables/data_store.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,30 @@ import { times } from '../../../../src/services/utils';
const random = new Random();

const createCountries = () => [
{ code: 'NL', name: 'Netherlands', flag: '🇳🇱' },
{ code: 'CZ', name: 'Czech Republic', flag: '🇨🇿' },
{ code: 'ZA', name: 'South Africa', flag: '🇿🇦' },
{ code: 'US', name: 'United States', flag: '🇺🇲' },
{ code: 'AU', name: 'Australia', flag: '🇦🇺' },
{ code: 'IL', name: 'Israel', flag: '🇮🇱' },
{ code: 'NO', name: 'Norway', flag: '🇳🇴' },
{ code: 'IT', name: 'Italy', flag: '🇮🇹' },
{ code: 'CA', name: 'Canada', flag: '🇨🇦' },
{ code: 'CG', name: 'Congo', flag: '🇨🇬' },
{ code: 'CL', name: 'Chile', flag: '🇨🇱' },
{ code: 'FJ', name: 'Fiji', flag: '🇫🇯' },
{ code: 'GB', name: 'United Kingdom', flag: '🇬🇧' },
{ code: 'GR', name: 'Greece', flag: '🇬🇷' },
{ code: 'HT', name: 'Haiti', flag: '🇭🇹' },
{ code: 'LB', name: 'Lebanon', flag: '🇱🇧' },
{ code: 'MM', name: 'Myanmar', flag: '🇲🇲' },
{ code: 'MX', name: 'Mexico', flag: '🇲🇽' },
{ code: 'NG', name: 'Nigeria', flag: '🇳🇬' },
{ code: 'SG', name: 'Singapore', flag: '🇸🇬' },
{ code: 'SO', name: 'Somalia', flag: '🇸🇴' },
{ code: 'TN', name: 'Tunisia', flag: '🇹🇳' },
{ code: 'VE', name: 'Venezuela', flag: '🇻🇪' },
{ code: 'ZM', name: 'Zambia', flag: '🇿🇲' },
{ code: 'NL@', name: 'Netherlands', flag: '🇳🇱' },
{ code: 'CZ@', name: 'Czech Republic', flag: '🇨🇿' },
{ code: 'ZA@', name: 'South Africa', flag: '🇿🇦' },
{ code: 'US@', name: 'United States', flag: '🇺🇲' },
{ code: 'AU@', name: 'Australia', flag: '🇦🇺' },
{ code: 'IL@', name: 'Israel', flag: '🇮🇱' },
{ code: 'NO@', name: 'Norway', flag: '🇳🇴' },
{ code: 'IT@', name: 'Italy', flag: '🇮🇹' },
{ code: 'CA@', name: 'Canada', flag: '🇨🇦' },
{ code: 'CG@', name: 'Congo', flag: '🇨🇬' },
{ code: 'CL@', name: 'Chile', flag: '🇨🇱' },
{ code: 'FJ@', name: 'Fiji', flag: '🇫🇯' },
{ code: 'GB@', name: 'United Kingdom', flag: '🇬🇧' },
{ code: 'GR@', name: 'Greece', flag: '🇬🇷' },
{ code: 'HT@', name: 'Haiti', flag: '🇭🇹' },
{ code: 'LB@', name: 'Lebanon', flag: '🇱🇧' },
{ code: 'MM@', name: 'Myanmar', flag: '🇲🇲' },
{ code: 'MX@', name: 'Mexico', flag: '🇲🇽' },
{ code: 'NG@', name: 'Nigeria', flag: '🇳🇬' },
{ code: 'SG@', name: 'Singapore', flag: '🇸🇬' },
{ code: 'SO@', name: 'Somalia', flag: '🇸🇴' },
{ code: 'TN@', name: 'Tunisia', flag: '🇹🇳' },
{ code: 'VE@', name: 'Venezuela', flag: '🇻🇪' },
{ code: 'ZM@', name: 'Zambia', flag: '🇿🇲' },
];

const firstNames = [
Expand Down
27 changes: 27 additions & 0 deletions src/components/search_bar/query/default_syntax.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,33 @@ describe('defaultSyntax', () => {
expect(printedQuery).toBe(query);
});

describe('phrases with special characters', () => {
const wrappedSpecialChars = "~`!@#$%^&+={}[];',.?".split('');

wrappedSpecialChars.forEach((char) => {
test(`${char} should be wrapped in quotes`, () => {
const query = `user:("foo${char}bar")`;

const ast = defaultSyntax.parse(query);
const printedQuery = defaultSyntax.print(ast);
expect(printedQuery).toBe(query);
});
});

const unwrappedSpecialChars = ['\\"', '(', ')', '_', '-', ':', '*', '\\'];

unwrappedSpecialChars.forEach((char) => {
test(`${char} should not be wrapped in quotes`, () => {
const query = `user:("foo${char}bar")`;
const expected = `user:(foo${char.replaceAll('\\', '')}bar)`;

const ast = defaultSyntax.parse(query);
const printedQuery = defaultSyntax.print(ast);
expect(printedQuery).toBe(expected);
});
});
});

test('single term or expression', () => {
const query = 'f:(foo)';
const ast = defaultSyntax.parse(query);
Expand Down
6 changes: 5 additions & 1 deletion src/components/search_bar/query/default_syntax.ts
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,11 @@ const printValue = (value: Value, options: ParseOptions) => {
return value.toString();
}

if (value.length === 0 || value.match(/\s/) || value.toLowerCase() === 'or') {
if (
value.length === 0 ||
value.match(/[^\w\-_*:()"/\\]/) || // Escape spaces and special characters not used as syntax identifiers
cee-chen marked this conversation as resolved.
Show resolved Hide resolved
value.toLowerCase() === 'or'
) {
return `"${escapePhraseValue(value)}"`;
}

Expand Down