[ES|QL] Interactive LOOKUP JOIN indices with editor flyout

.github/CODEOWNERS

@@ -350,6 +350,7 @@ src/platform/packages/private/kbn-handlebars @elastic/kibana-security
 src/platform/packages/private/kbn-hapi-mocks @elastic/kibana-core
 src/platform/packages/private/kbn-health-gateway-server @elastic/kibana-core
 src/platform/packages/private/kbn-import-resolver @elastic/kibana-operations
+src/platform/packages/private/kbn-index-editor @elastic/kibana-esql
 src/platform/packages/private/kbn-item-buffer @elastic/appex-sharedux
 src/platform/packages/private/kbn-jest-serializers @elastic/kibana-operations
 src/platform/packages/private/kbn-journeys @elastic/kibana-operations @elastic/appex-qa
@@ -1351,6 +1352,7 @@ src/platform/plugins/shared/discover/public/context_awareness/profile_providers/
 # ES|QL
 /src/platform/test/api_integration/apis/esql/*.ts @elastic/kibana-esql
 /src/platform/test/functional/services/esql.ts @elastic/kibana-esql
+/src/platform/test/functional/page_objects/index_editor.ts @elastic/kibana-esql
 /src/platform/packages/shared/kbn-monaco/src/languages/esql @elastic/kibana-esql
 x-pack/solutions/observability/plugins/observability/server/lib/esql_extensions @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team
 

package.json

@@ -623,6 +623,7 @@
     "@kbn/iframe-embedded-plugin": "link:x-pack/platform/test/functional_embedded/plugins/iframe_embedded",
     "@kbn/image-embeddable-plugin": "link:src/platform/plugins/private/image_embeddable",
     "@kbn/index-adapter": "link:x-pack/solutions/security/packages/index-adapter",
+    "@kbn/index-editor": "link:src/platform/packages/private/kbn-index-editor",
     "@kbn/index-lifecycle-management-common-shared": "link:x-pack/platform/packages/shared/index-lifecycle-management/index_lifecycle_management_common_shared",
     "@kbn/index-lifecycle-management-plugin": "link:x-pack/platform/plugins/private/index_lifecycle_management",
     "@kbn/index-management-plugin": "link:x-pack/platform/plugins/shared/index_management",

packages/kbn-optimizer/limits.yml

@@ -46,7 +46,7 @@ pageLoadAssetSize:
   embeddableAlertsTable: 6596
   embeddableEnhanced: 10332
   enterpriseSearch: 38494
-  esql: 10370
+  esql: 12323
   esqlDataGrid: 10209
   esUiShared: 100338
   eventAnnotation: 22361

src/platform/packages/private/kbn-esql-editor/src/custom_commands/append_index_to_join_command.test.ts

@@ -0,0 +1,88 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import type { monaco } from '@kbn/monaco';
+import {
+  appendIndexToJoinCommandByName,
+  appendIndexToJoinCommandByPosition,
+} from './append_index_to_join_command';
+
+describe('appendIndexToJoinCommandByName', () => {
+  it('replaces existing index argument', () => {
+    const result = appendIndexToJoinCommandByName(
+      `FROM kibana_sample_data_ecommerce
+  | EVAL customer_id = TO_LONG(customer_id)
+  | LOOKUP JOIN customer_data ON customer_id | LOOKUP JOIN test1123`,
+      'test1123',
+      'new_index'
+    );
+    expect(result).toBe(`FROM kibana_sample_data_ecommerce
+  | EVAL customer_id = TO_LONG(customer_id)
+  | LOOKUP JOIN customer_data ON customer_id
+  | LOOKUP JOIN new_index`);
+  });
+});
+
+describe('appendIndexToJoinCommandByPosition', () => {
+  it('should append an index name to the join command', () => {
+    const result = appendIndexToJoinCommandByPosition(
+      'FROM kibana_sample_data_logs | LOOKUP JOIN  | LIMIT 10',
+      { lineNumber: 1, column: 44 } as monaco.Position,
+      'new_index'
+    );
+    expect(result).toBe(`FROM kibana_sample_data_logs
+  | LOOKUP JOIN new_index
+  | LIMIT 10`);
+  });
+
+  it('should append an index name to the join command in a multi-line query', () => {
+    const result = appendIndexToJoinCommandByPosition(
+      `FROM kibana_sample_data_logs
+  | LOOKUP JOIN\u0020
+  | LIMIT 10`,
+      { lineNumber: 2, column: 17 } as monaco.Position,
+      'new_index'
+    );
+    expect(result).toBe(`FROM kibana_sample_data_logs
+  | LOOKUP JOIN new_index
+  | LIMIT 10`);
+  });
+
+  it('should append an index name to the correct join command', () => {
+    const result = appendIndexToJoinCommandByPosition(
+      'FROM kibana_sample_data_logs | LOOKUP JOIN new_index ON some_field | LOOKUP JOIN  | LIMIT 10',
+      { lineNumber: 1, column: 82 } as monaco.Position,
+      'another_index'
+    );
+    expect(result).toBe(`FROM kibana_sample_data_logs
+  | LOOKUP JOIN new_index ON some_field
+  | LOOKUP JOIN another_index
+  | LIMIT 10`);
+  });
+
+  it('should not append an index name if an index argument with the same name is already present', () => {
+    const result = appendIndexToJoinCommandByPosition(
+      'FROM kibana_sample_data_logs | LOOKUP JOIN new_index | LIMIT 10',
+      { lineNumber: 1, column: 53 } as monaco.Position,
+      'new_index'
+    );
+    expect(result).toBe('FROM kibana_sample_data_logs | LOOKUP JOIN new_index | LIMIT 10');
+  });
+
+  it('should replace the existing index argument', () => {
+    const result = appendIndexToJoinCommandByPosition(
+      'FROM kibana_sample_data_logs | LOOKUP JOIN new_index | LIMIT 10',
+      { lineNumber: 1, column: 53 } as monaco.Position,
+      'new_index_2'
+    );
+    expect(result).toBe(`FROM kibana_sample_data_logs
+  | LOOKUP JOIN new_index_2
+  | LIMIT 10`);
+  });
+});

src/platform/packages/private/kbn-esql-editor/src/custom_commands/append_index_to_join_command.ts

@@ -0,0 +1,156 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import {
+  BasicPrettyPrinter,
+  Parser,
+  isSource,
+  mutate,
+  type ESQLAstItem,
+  type ESQLAstJoinCommand,
+  type ESQLAstQueryExpression,
+  type ESQLSingleAstItem,
+  type ESQLSource,
+} from '@kbn/esql-ast';
+import type { monaco } from '@kbn/monaco';
+
+interface SelectedJoin {
+  joinCmd: ESQLAstJoinCommand;
+  src: ESQLSource | undefined;
+  firstArg: ESQLAstItem;
+}
+
+type JoinCommandSelector = (root: ESQLAstQueryExpression) => SelectedJoin | undefined;
+
+function modifyJoinCommand(
+  root: ESQLAstQueryExpression,
+  selectedJoin: SelectedJoin,
+  createdIndexName: string
+): string {
+  const { joinCmd, src, firstArg } = selectedJoin;
+
+  const newSource: ESQLSource = {
+    type: 'source',
+    sourceType: 'index',
+    incomplete: false,
+    location: src?.location ?? {
+      min: joinCmd.location?.min ?? 0,
+      max: (joinCmd.location?.min ?? 0) + createdIndexName.length,
+    },
+    text: createdIndexName,
+    name: createdIndexName,
+  };
+
+  if (src) {
+    const idx = joinCmd.args.indexOf(firstArg);
+    // remove the original argument (source or AS option) from the JOIN command
+    mutate.generic.commands.args.remove(root, firstArg as unknown as ESQLSingleAstItem);
+    mutate.generic.commands.args.insert(joinCmd, newSource, idx);
+  } else {
+    mutate.generic.commands.args.insert(joinCmd, newSource, 0);
+  }
+
+  return BasicPrettyPrinter.multiline(root);
+}
+
+function getJoinSourceInfo(joinCmd: ESQLAstJoinCommand) {
+  const firstArg = joinCmd.args[0];
+  let src: ESQLSource | undefined;
+  if (isSource(firstArg)) {
+    src = firstArg;
+  } else if (
+    firstArg &&
+    !Array.isArray(firstArg) &&
+    firstArg.type === 'option' &&
+    firstArg.name === 'as'
+  ) {
+    src = firstArg.args[0] as unknown as ESQLSource;
+  }
+  return { src, firstArg };
+}
+
+function byNameSelector(targetName: string): JoinCommandSelector {
+  const trimmedTargetName = targetName.trim();
+  return (root: ESQLAstQueryExpression) => {
+    for (const joinCmd of mutate.commands.join.list(root)) {
+      const { src, firstArg } = getJoinSourceInfo(joinCmd);
+      if (src?.name === trimmedTargetName) {
+        return { joinCmd, src, firstArg };
+      }
+    }
+    return undefined;
+  };
+}
+
+function byPositionSelector(position: monaco.Position, query: string): JoinCommandSelector {
+  const cursorOffset = (() => {
+    const { lineNumber, column } = position;
+    const lines = query.split('\n');
+    let off = 0;
+    for (let i = 0; i < lineNumber - 1; i++) {
+      off += lines[i].length + 1;
+    }
+    return off + column - 1;
+  })();
+
+  return (root: ESQLAstQueryExpression) => {
+    let selectedJoin: SelectedJoin | undefined;
+    let smallestDistance = Number.MAX_SAFE_INTEGER;
+
+    for (const joinCmd of mutate.commands.join.list(root)) {
+      if (joinCmd.location) {
+        const { min, max } = joinCmd.location;
+        let distance = 0;
+        if (cursorOffset < min) distance = min - cursorOffset;
+        else if (cursorOffset > max) distance = cursorOffset - max;
+
+        if (distance < smallestDistance) {
+          smallestDistance = distance;
+          const { src, firstArg } = getJoinSourceInfo(joinCmd);
+          selectedJoin = { joinCmd, src, firstArg };
+        }
+      }
+    }
+    return selectedJoin;
+  };
+}
+
+function appendIndexToJoinCommand(
+  query: string,
+  createdIndexName: string,
+  selector: JoinCommandSelector
+): string {
+  if (!createdIndexName) return query;
+
+  const { root } = Parser.parse(query);
+  const selectedJoin = selector(root);
+
+  if (!selectedJoin) return query;
+
+  if (selectedJoin.src && selectedJoin.src.name === createdIndexName) return query;
+
+  return modifyJoinCommand(root, selectedJoin, createdIndexName);
+}
+
+export function appendIndexToJoinCommandByName(
+  query: string,
+  targetName: string,
+  createdIndexName: string
+): string {
+  if (targetName.trim() === createdIndexName) return query;
+  return appendIndexToJoinCommand(query, createdIndexName, byNameSelector(targetName));
+}
+
+export function appendIndexToJoinCommandByPosition(
+  query: string,
+  position: monaco.Position,
+  createdIndexName: string
+): string {
+  return appendIndexToJoinCommand(query, createdIndexName, byPositionSelector(position, query));
+}

src/platform/packages/private/kbn-esql-editor/src/custom_commands/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export { useLookupIndexCommand, useCanCreateLookupIndex } from './use_lookup_index_editor';