[8.x] [ES|QL] open suggestions automatically in sources lists and &#x…

…60;ENRICH` (#191312) (#193013) # Backport This will backport the following commits from `main` to `8.x`: - [[ES|QL] open suggestions automatically in sources lists and `ENRICH` (#191312)](#191312)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Drew Tate <[email protected]>
elastic · Sep 16, 2024 · 02f8d09 · 02f8d09
1 parent 612e578
commit 02f8d09
Show file tree

Hide file tree

Showing 10 changed files with 491 additions and 208 deletions.
diff --git a/packages/kbn-esql-ast/src/ast_helpers.ts b/packages/kbn-esql-ast/src/ast_helpers.ts
@@ -405,9 +405,9 @@ export function createSource(
     index,
     name: text,
     sourceType: type,
-    text,
     location: getPosition(ctx.start, ctx.stop),
     incomplete: Boolean(ctx.exception || text === ''),
+    text: ctx?.getText(),
   };
 }
 

diff --git a/packages/kbn-esql-utils/src/utils/query_parsing_helpers.ts b/packages/kbn-esql-utils/src/utils/query_parsing_helpers.ts
@@ -24,7 +24,7 @@ export function getIndexPatternFromESQLQuery(esql?: string) {
   const sourceCommand = ast.find(({ name }) => ['from', 'metrics'].includes(name));
   const args = (sourceCommand?.args ?? []) as ESQLSource[];
   const indices = args.filter((arg) => arg.sourceType === 'index');
-  return indices?.map((index) => index.text).join(',');
+  return indices?.map((index) => index.name).join(',');
 }
 
 // For ES|QL we consider stats and keep transformational command

diff --git a/...esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.from.test.ts b/...esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.from.test.ts
@@ -15,9 +15,6 @@ const visibleIndices = indexes
   .map(({ name, suggestedAs }) => suggestedAs || name)
   .sort();
 
-const addTrailingSpace = (strings: string[], predicate: (s: string) => boolean = (_s) => true) =>
-  strings.map((string) => (predicate(string) ? `${string} ` : string));
-
 const metadataFields = [...METADATA_FIELDS].sort();
 
 describe('autocomplete.suggest', () => {
@@ -37,17 +34,17 @@ describe('autocomplete.suggest', () => {
       test('suggests visible indices on space', async () => {
         const { assertSuggestions } = await setup();
 
-        await assertSuggestions('from /', addTrailingSpace(visibleIndices));
-        await assertSuggestions('FROM /', addTrailingSpace(visibleIndices));
-        await assertSuggestions('from /index', addTrailingSpace(visibleIndices));
+        await assertSuggestions('from /', visibleIndices);
+        await assertSuggestions('FROM /', visibleIndices);
+        await assertSuggestions('from /index', visibleIndices);
       });
 
       test('suggests visible indices on comma', async () => {
         const { assertSuggestions } = await setup();
 
-        await assertSuggestions('FROM a,/', addTrailingSpace(visibleIndices));
-        await assertSuggestions('FROM a, /', addTrailingSpace(visibleIndices));
-        await assertSuggestions('from *,/', addTrailingSpace(visibleIndices));
+        await assertSuggestions('FROM a,/', visibleIndices);
+        await assertSuggestions('FROM a, /', visibleIndices);
+        await assertSuggestions('from *,/', visibleIndices);
       });
 
       test('can suggest integration data sources', async () => {
@@ -56,10 +53,7 @@ describe('autocomplete.suggest', () => {
           .filter(({ hidden }) => !hidden)
           .map(({ name, suggestedAs }) => suggestedAs || name)
           .sort();
-        const expectedSuggestions = addTrailingSpace(
-          visibleDataSources,
-          (s) => !integrations.find(({ name }) => name === s)
-        );
+        const expectedSuggestions = visibleDataSources;
         const { assertSuggestions, callbacks } = await setup();
         const cb = {
           ...callbacks,
@@ -75,7 +69,7 @@ describe('autocomplete.suggest', () => {
     });
 
     describe('... METADATA <fields>', () => {
-      const metadataFieldsSandIndex = metadataFields.filter((field) => field !== '_index');
+      const metadataFieldsAndIndex = metadataFields.filter((field) => field !== '_index');
 
       test('on <kbd>SPACE</kbd> without comma ",", suggests adding metadata', async () => {
         const { assertSuggestions } = await setup();
@@ -103,8 +97,8 @@ describe('autocomplete.suggest', () => {
       test('filters out already used metadata fields', async () => {
         const { assertSuggestions } = await setup();
 
-        await assertSuggestions('from a, b [metadata _index, /]', metadataFieldsSandIndex);
-        await assertSuggestions('from a, b metadata _index, /', metadataFieldsSandIndex);
+        await assertSuggestions('from a, b [metadata _index, /]', metadataFieldsAndIndex);
+        await assertSuggestions('from a, b metadata _index, /', metadataFieldsAndIndex);
       });
     });
   });

diff --git a/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/helpers.ts b/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/helpers.ts
@@ -17,7 +17,7 @@ import { groupingFunctionDefinitions } from '../../definitions/grouping';
 import * as autocomplete from '../autocomplete';
 import type { ESQLCallbacks } from '../../shared/types';
 import type { EditorContext, SuggestionRawDefinition } from '../types';
-import { TIME_SYSTEM_PARAMS } from '../factories';
+import { TIME_SYSTEM_PARAMS, getSafeInsertText } from '../factories';
 import { getFunctionSignatures } from '../../definitions/helpers';
 import { ESQLRealField } from '../../validation/types';
 import {
@@ -280,10 +280,7 @@ export function createCompletionContext(triggerCharacter?: string) {
 export function getPolicyFields(policyName: string) {
   return policies
     .filter(({ name }) => name === policyName)
-    .flatMap(({ enrichFields }) =>
-      // ok, this is a bit of cheating as it's using the same logic as in the helper
-      enrichFields.map((field) => (/[^a-zA-Z\d_\.@]/.test(field) ? `\`${field}\`` : field))
-    );
+    .flatMap(({ enrichFields }) => enrichFields.map((field) => getSafeInsertText(field)));
 }
 
 export interface SuggestOptions {