[9.0] [ES|QL] Improvements in JOIN autocomplete (#210401) (#210517)

# Backport This will backport the following commits from `main` to `9.0`: - [[ES|QL] Improvements in JOIN autocomplete (#210401)](#210401)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Stratoula Kalafateli <efstratia.kalafateli@elastic.co>
elastic · Feb 11, 2025 · a9ae718 · a9ae718
1 parent 3f49fd9
commit a9ae718
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 5 deletions.
diff --git a/...tform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/complete_items.ts b/...tform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/complete_items.ts
@@ -16,6 +16,13 @@ import { getCommandDefinition } from '../shared/helpers';
 import { getCommandSignature } from '../definitions/helpers';
 import { buildDocumentation } from './documentation_util';
 
+const techPreviewLabel = i18n.translate(
+  'kbn-esql-validation-autocomplete.esql.autocomplete.techPreviewLabel',
+  {
+    defaultMessage: `Technical Preview`,
+  }
+);
+
 export function getAssignmentDefinitionCompletitionItem() {
   const assignFn = builtinFunctions.find(({ name }) => name === '=')!;
   return getOperatorSuggestion(assignFn);
@@ -32,7 +39,6 @@ export const getCommandAutocompleteDefinitions = (
     }
 
     const commandDefinition = getCommandDefinition(command.name);
-    const commandSignature = getCommandSignature(commandDefinition);
     const label = commandDefinition.name.toUpperCase();
     const text = commandDefinition.signature.params.length
       ? `${commandDefinition.name.toUpperCase()} $0`
@@ -45,12 +51,17 @@ export const getCommandAutocompleteDefinitions = (
     ];
 
     for (const type of types) {
+      let detail = type.description || commandDefinition.description;
+      if (commandDefinition.preview) {
+        detail = `[${techPreviewLabel}] ${detail}`;
+      }
+      const commandSignature = getCommandSignature(commandDefinition, type.name);
       const suggestion: SuggestionRawDefinition = {
         label: type.name ? `${type.name.toLocaleUpperCase()} ${label}` : label,
         text: type.name ? `${type.name.toLocaleUpperCase()} ${text}` : text,
         asSnippet: true,
         kind: 'Method',
-        detail: type.description || commandDefinition.description,
+        detail,
         documentation: {
           value: buildDocumentation(commandSignature.declaration, commandSignature.examples),
         },

diff --git a/src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/commands.ts b/src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/commands.ts
@@ -485,6 +485,7 @@ export const commandDefinitions: Array<CommandDefinition<any>> = [
     examples: ['row a=[1,2,3] | mv_expand a'],
     options: [],
     modes: [],
+    preview: true,
     signature: {
       multipleParams: false,
       params: [{ name: 'column', type: 'column', innerTypes: ['any'] }],
@@ -557,19 +558,20 @@ export const commandDefinitions: Array<CommandDefinition<any>> = [
     description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.joinDoc', {
       defaultMessage: 'Join table with another table.',
     }),
+    preview: true,
     examples: [
       '… | LOOKUP JOIN lookup_index ON join_field',
       // TODO: Uncomment when other join types are implemented
       // '… | <LEFT | RIGHT | LOOKUP> JOIN index ON index.field = index2.field',
       // '… | <LEFT | RIGHT | LOOKUP> JOIN index AS alias ON index.field = index2.field',
       // '… | <LEFT | RIGHT | LOOKUP> JOIN index AS alias ON index.field = index2.field, index.field2 = index2.field2',
     ],
-    options: [],
     modes: [],
     signature: {
-      multipleParams: false,
+      multipleParams: true,
       params: [{ name: 'index', type: 'source', wildcards: true }],
     },
+    options: [onOption],
     suggest: suggestForJoin,
   },
 ];
diff --git a/src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/helpers.ts b/src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/helpers.ts
@@ -57,10 +57,14 @@ function handleAdditionalArgs(
 
 export function getCommandSignature(
   { name, signature, options, examples }: CommandDefinition<string>,
+  typeName?: string,
   { withTypes }: { withTypes: boolean } = { withTypes: true }
 ) {
+  const commandName = typeName
+    ? `${typeName.toUpperCase()} ${name.toUpperCase()}`
+    : name.toUpperCase();
   return {
-    declaration: `${name.toUpperCase()} ${printCommandArguments(signature, withTypes)} ${(
+    declaration: `${commandName} ${printCommandArguments(signature, withTypes)} ${(
       options || []
     ).map(
       (option) =>

diff --git a/src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts b/src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts
@@ -194,6 +194,10 @@ export interface CommandBaseDefinition<CommandName extends string> {
 
   alias?: string;
   description: string;
+  /**
+   * Displays a Technical preview label in the autocomplete
+   */
+  preview?: boolean;
   /**
    * Whether to show or hide in autocomplete suggestion list
    */