Skip to content

Commit

Permalink
add some smoother autocompletion
Browse files Browse the repository at this point in the history
  • Loading branch information
@drewdaemon
drewdaemon committed Jul 30, 2024
1 parent 6c581d5 commit 185b81c
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 61 deletions.
111 changes: 58 additions & 53 deletions packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ describe('autocomplete', () => {
describe('show', () => {
testSuggestions('show ', ['INFO']);
for (const fn of ['info']) {
testSuggestions(`show ${fn} `, ['|']);
testSuggestions(`show ${fn} `, ['| ']);
}
});

Expand Down Expand Up @@ -176,7 +176,7 @@ describe('autocomplete', () => {
...getFunctionSignaturesByReturnType('where', 'string', { scalar: true }),
]);
testSuggestions('from a | where stringField >= stringField ', [
'|',
'| ',
...getFunctionSignaturesByReturnType(
'where',
'boolean',
Expand All @@ -187,7 +187,7 @@ describe('autocomplete', () => {
),
]);
testSuggestions.skip('from a | where stringField =~ stringField ', [
'|',
'| ',
...getFunctionSignaturesByReturnType(
'where',
'boolean',
Expand Down Expand Up @@ -304,7 +304,7 @@ describe('autocomplete', () => {
for (const subExpression of subExpressions) {
testSuggestions(`from a | ${subExpression} grok `, getFieldNamesByType('string'));
testSuggestions(`from a | ${subExpression} grok stringField `, [constantPattern], ' ');
testSuggestions(`from a | ${subExpression} grok stringField ${constantPattern} `, ['|']);
testSuggestions(`from a | ${subExpression} grok stringField ${constantPattern} `, ['| ']);
}
});

Expand All @@ -321,7 +321,7 @@ describe('autocomplete', () => {
testSuggestions(`from a | ${subExpression} dissect stringField `, [constantPattern], ' ');
testSuggestions(
`from a | ${subExpression} dissect stringField ${constantPattern} `,
['APPEND_SEPARATOR = $0', '|'],
['APPEND_SEPARATOR = $0', '| '],
' '
);
testSuggestions(
Expand All @@ -330,7 +330,7 @@ describe('autocomplete', () => {
);
testSuggestions(
`from a | ${subExpression} dissect stringField ${constantPattern} append_separator = ":" `,
['|']
['| ']
);
}
});
Expand All @@ -340,20 +340,20 @@ describe('autocomplete', () => {
...getFieldNamesByType('any'),
...getFunctionSignaturesByReturnType('sort', 'any', { scalar: true }),
]);
testSuggestions('from a | sort stringField ', ['ASC', 'DESC', ',', '|']);
testSuggestions('from a | sort stringField desc ', ['NULLS FIRST', 'NULLS LAST', ',', '|']);
testSuggestions('from a | sort stringField ', ['ASC', 'DESC', ',', '| ']);
testSuggestions('from a | sort stringField desc ', ['NULLS FIRST', 'NULLS LAST', ',', '| ']);
// @TODO: improve here
// testSuggestions('from a | sort stringField desc ', ['first', 'last']);
});

describe('limit', () => {
testSuggestions('from a | limit ', ['10', '100', '1000']);
testSuggestions('from a | limit 4 ', ['|']);
testSuggestions('from a | limit 4 ', ['| ']);
});

describe('mv_expand', () => {
testSuggestions('from a | mv_expand ', getFieldNamesByType('any'));
testSuggestions('from a | mv_expand a ', ['|']);
testSuggestions('from a | mv_expand a ', ['| ']);
});

describe('rename', () => {
Expand Down Expand Up @@ -410,7 +410,7 @@ describe('autocomplete', () => {
testSuggestions(`from a ${prevCommand}| enrich _${mode.toUpperCase()}:`, policyNames, ':');
testSuggestions(`from a ${prevCommand}| enrich _${camelCase(mode)}:`, policyNames, ':');
}
testSuggestions(`from a ${prevCommand}| enrich policy `, ['ON $0', 'WITH $0', '|']);
testSuggestions(`from a ${prevCommand}| enrich policy `, ['ON $0', 'WITH $0', '| ']);
testSuggestions(`from a ${prevCommand}| enrich policy on `, [
'stringField',
'numberField',
Expand All @@ -424,45 +424,49 @@ describe('autocomplete', () => {
'`any#Char$Field`',
'kubernetes.something.something',
]);
testSuggestions(`from a ${prevCommand}| enrich policy on b `, ['WITH $0', ',', '|']);
testSuggestions(`from a ${prevCommand}| enrich policy on b `, ['WITH $0', ',', '| ']);
testSuggestions(
`from a ${prevCommand}| enrich policy on b with `,
['var0 =', ...getPolicyFields('policy')],
['var0 = ', ...getPolicyFields('policy')],
' '
);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 `, ['= $0', ',', '|']);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 `, ['= $0', ',', '| ']);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 = `, [
...getPolicyFields('policy'),
]);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 = stringField `, [
',',
'|',
'| ',
]);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 = stringField, `, [
'var1 =',
'var1 = ',
...getPolicyFields('policy'),
]);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 = stringField, var1 `, [
'= $0',
',',
'|',
'| ',
]);
testSuggestions(
`from a ${prevCommand}| enrich policy on b with var0 = stringField, var1 = `,
[...getPolicyFields('policy')]
);
testSuggestions(
`from a ${prevCommand}| enrich policy with `,
['var0 =', ...getPolicyFields('policy')],
['var0 = ', ...getPolicyFields('policy')],
' '
);
testSuggestions(`from a ${prevCommand}| enrich policy with stringField `, ['= $0', ',', '|']);
testSuggestions(`from a ${prevCommand}| enrich policy with stringField `, [
'= $0',
',',
'| ',
]);
}
});

describe('eval', () => {
testSuggestions('from a | eval ', [
'var0 =',
'var0 = ',
...getFieldNamesByType('any'),
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
]);
Expand All @@ -471,7 +475,7 @@ describe('autocomplete', () => {
'number',
]),
',',
'|',
'| ',
]);
testSuggestions('from index | EVAL stringField not ', ['LIKE $0', 'RLIKE $0', 'IN $0']);
testSuggestions('from index | EVAL stringField NOT ', ['LIKE $0', 'RLIKE $0', 'IN $0']);
Expand All @@ -496,7 +500,7 @@ describe('autocomplete', () => {
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
]);
testSuggestions('from a | eval a=numberField, ', [
'var0 =',
'var0 = ',
...getFieldNamesByType('any'),
'a',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
Expand Down Expand Up @@ -541,7 +545,7 @@ describe('autocomplete', () => {
);
testSuggestions('from a | eval a=round(numberField) ', [
',',
'|',
'| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'number',
]),
Expand All @@ -567,7 +571,7 @@ describe('autocomplete', () => {
' '
);
testSuggestions('from a | eval a=round(numberField),', [
'var0 =',
'var0 = ',
...getFieldNamesByType('any'),
'a',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
Expand Down Expand Up @@ -595,7 +599,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | stats avg(numberField) by stringField | eval ',
[
'var0 =',
'var0 = ',
'`avg(numberField)`',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
],
Expand All @@ -607,7 +611,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | eval abs(numberField) + 1 | eval ',
[
'var0 =',
'var0 = ',
...getFieldNamesByType('any'),
'`abs(numberField) + 1`',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
Expand All @@ -617,7 +621,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | stats avg(numberField) by stringField | eval ',
[
'var0 =',
'var0 = ',
'`avg(numberField)`',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
],
Expand All @@ -629,7 +633,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | stats avg(numberField), avg(kubernetes.something.something) by stringField | eval ',
[
'var0 =',
'var0 = ',
'`avg(numberField)`',
'`avg(kubernetes.something.something)`',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
Expand Down Expand Up @@ -723,7 +727,7 @@ describe('autocomplete', () => {
'from a | eval var0 = abs(numberField) | eval abs(var0)',
[
',',
'|',
'| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'number',
]),
Expand Down Expand Up @@ -834,7 +838,7 @@ describe('autocomplete', () => {
[
...dateSuggestions,
',',
'|',
'| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'number',
]),
Expand All @@ -843,7 +847,7 @@ describe('autocomplete', () => {
);
testSuggestions('from a | eval a = 1 year ', [
',',
'|',
'| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'time_interval',
]),
Expand All @@ -853,7 +857,7 @@ describe('autocomplete', () => {
[
...dateSuggestions,
',',
'|',
'| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'number',
]),
Expand Down Expand Up @@ -892,7 +896,7 @@ describe('autocomplete', () => {
});

describe('values suggestions', () => {
testSuggestions('FROM "a"', ['a', 'b'], undefined, 7, [
testSuggestions('FROM "a"', ['a ', 'b '], undefined, 7, [
,
[
{ name: 'a', hidden: false },
Expand Down Expand Up @@ -962,18 +966,16 @@ describe('autocomplete', () => {
}
it('should trigger further suggestions for functions', async () => {
const suggestions = await getSuggestionsFor('from a | eval ');
const [expectedWithTrigger, expectedWithoutTrigger] = partition(
suggestions,
({ kind, label }) => kind === 'Function' || label === 'var0'
);
// test that all functions will retrigger suggestions
expect(
suggestions
.filter(({ kind }) => kind === 'Function')
.every(({ command }) => command === TRIGGER_SUGGESTION_COMMAND)
expectedWithTrigger.every(({ command }) => command === TRIGGER_SUGGESTION_COMMAND)
).toBeTruthy();
// now test that non-function won't retrigger
expect(
suggestions
.filter(({ kind }) => kind !== 'Function')
.every(({ command }) => command == null)
).toBeTruthy();
expect(expectedWithoutTrigger.every(({ command }) => command == null)).toBeTruthy();
});
it('should trigger further suggestions for commands', async () => {
const suggestions = await getSuggestionsFor('from a | ');
Expand Down Expand Up @@ -1035,7 +1037,7 @@ describe('autocomplete', () => {
);

// FROM source
testSuggestions('FROM k', ['index1', 'index2'], undefined, 6, [
testSuggestions('FROM k', ['index1 ', 'index2 '], undefined, 6, [
,
[
{ name: 'index1', hidden: false },
Expand All @@ -1044,7 +1046,7 @@ describe('autocomplete', () => {
]);

// FROM source METADATA
testSuggestions('FROM index1 M', [',', 'METADATA $0', '|'], undefined, 13);
testSuggestions('FROM index1 M', [',', 'METADATA $0', '| '], undefined, 13);

// FROM source METADATA field
testSuggestions('FROM index1 METADATA _', METADATA_FIELDS, undefined, 22);
Expand All @@ -1053,7 +1055,7 @@ describe('autocomplete', () => {
testSuggestions(
'FROM index1 | EVAL b',
[
'var0 =',
'var0 = ',
...getFieldNamesByType('any'),
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
],
Expand Down Expand Up @@ -1086,22 +1088,22 @@ describe('autocomplete', () => {
);

// ENRICH policy ON
testSuggestions('FROM index1 | ENRICH policy O', ['ON $0', 'WITH $0', '|'], undefined, 29);
testSuggestions('FROM index1 | ENRICH policy O', ['ON $0', 'WITH $0', '| '], undefined, 29);

// ENRICH policy ON field
testSuggestions('FROM index1 | ENRICH policy ON f', getFieldNamesByType('any'), undefined, 32);

// ENRICH policy WITH policyfield
testSuggestions(
'FROM index1 | ENRICH policy WITH v',
['var0 =', ...getPolicyFields('policy')],
['var0 = ', ...getPolicyFields('policy')],
undefined,
34
);

testSuggestions(
'FROM index1 | ENRICH policy WITH \tv',
['var0 =', ...getPolicyFields('policy')],
['var0 = ', ...getPolicyFields('policy')],
undefined,
34
);
Expand All @@ -1123,7 +1125,7 @@ describe('autocomplete', () => {
// LIMIT argument
// Here we actually test that the invoke trigger kind does not work
// because it isn't very useful to see literal suggestions when typing a number
testSuggestions('FROM a | LIMIT 1', ['|'], undefined, 16);
testSuggestions('FROM a | LIMIT 1', ['| '], undefined, 16);

// MV_EXPAND field
testSuggestions('FROM index1 | MV_EXPAND f', getFieldNamesByType('any'), undefined, 25);
Expand All @@ -1149,32 +1151,35 @@ describe('autocomplete', () => {
);

// SORT field order
testSuggestions('FROM index1 | SORT stringField a', ['ASC', 'DESC', ',', '|'], undefined, 32);
testSuggestions('FROM index1 | SORT stringField a', ['ASC', 'DESC', ',', '| '], undefined, 32);

// SORT field order nulls
testSuggestions(
'FROM index1 | SORT stringField ASC n',
['NULLS FIRST', 'NULLS LAST', ',', '|'],
['NULLS FIRST', 'NULLS LAST', ',', '| '],
undefined,
36
);

// STATS argument
testSuggestions(
'FROM index1 | STATS f',
['var0 =', ...getFunctionSignaturesByReturnType('stats', 'any', { scalar: true, agg: true })],
[
'var0 = ',
...getFunctionSignaturesByReturnType('stats', 'any', { scalar: true, agg: true }),
],
undefined,
21
);

// STATS argument BY
testSuggestions('FROM index1 | STATS AVG(booleanField) B', ['BY $0', ',', '|'], undefined, 39);
testSuggestions('FROM index1 | STATS AVG(booleanField) B', ['BY $0', ',', '| '], undefined, 39);

// STATS argument BY expression
testSuggestions(
'FROM index1 | STATS field BY f',
[
'var0 =',
'var0 = ',
...getFunctionSignaturesByReturnType('stats', 'any', { grouping: true, scalar: true }),
...getFieldNamesByType('any'),
],
Expand Down
Loading

0 comments on commit 185b81c

Please sign in to comment.