[ES|QL] [Discover] Fixes the histogram suggestion

packages/kbn-esql-utils/index.ts

@@ -30,6 +30,7 @@ export {
  retrieveMetadataColumns,
  getQueryColumnsFromESQLQuery,
  isESQLColumnSortable,
+ isESQLColumnGroupable,
  TextBasedLanguages,
 } from './src';
 

packages/kbn-esql-utils/src/index.ts

@@ -31,4 +31,4 @@ export {
  getStartEndParams,
  hasStartEndParams,
 } from './utils/run_query';
-export { isESQLColumnSortable } from './utils/esql_fields_utils';
+export { isESQLColumnSortable, isESQLColumnGroupable } from './utils/esql_fields_utils';

packages/kbn-esql-utils/src/utils/esql_fields_utils.test.ts

@@ -7,7 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 import type { DatatableColumn } from '@kbn/expressions-plugin/common';
-import { isESQLColumnSortable } from './esql_fields_utils';
+import { isESQLColumnSortable, isESQLColumnGroupable } from './esql_fields_utils';
 
 describe('esql fields helpers', () => {
  describe('isESQLColumnSortable', () => {
@@ -63,4 +63,45 @@ describe('esql fields helpers', () => {
  expect(isESQLColumnSortable(keywordField)).toBeTruthy();
  });
  });
+
+ describe('isESQLColumnGroupable', () => {
+ it('returns false for unsupported fields', () => {
+ const unsupportedField = {
+ id: 'unsupported',
+ name: 'unsupported',
+ meta: {
+ type: 'unknown',
+ esType: 'unknown',
+ },
+ isNull: false,
+ } as DatatableColumn;
+ expect(isESQLColumnGroupable(unsupportedField)).toBeFalsy();
+ });
+
+ it('returns false for counter fields', () => {
+ const tsdbField = {
+ id: 'tsbd_counter',
+ name: 'tsbd_counter',
+ meta: {
+ type: 'number',
+ esType: 'counter_long',
+ },
+ isNull: false,
+ } as DatatableColumn;
+ expect(isESQLColumnGroupable(tsdbField)).toBeFalsy();
+ });
+
+ it('returns true for everything else', () => {
+ const keywordField = {
+ id: 'sortable',
+ name: 'sortable',
+ meta: {
+ type: 'string',
+ esType: 'keyword',
+ },
+ isNull: false,
+ } as DatatableColumn;
+ expect(isESQLColumnGroupable(keywordField)).toBeTruthy();
+ });
+ });
 });

packages/kbn-esql-utils/src/utils/esql_fields_utils.ts

@@ -12,6 +12,7 @@ import type { DatatableColumn } from '@kbn/expressions-plugin/common';
 const SPATIAL_FIELDS = ['geo_point', 'geo_shape', 'point', 'shape'];
 const SOURCE_FIELD = '_source';
 const TSDB_COUNTER_FIELDS_PREFIX = 'counter_';
+const UNKNOWN_FIELD = 'unknown';
 
 /**
  * Check if a column is sortable.
@@ -38,3 +39,23 @@ export const isESQLColumnSortable = (column: DatatableColumn): boolean => {
 
  return true;
 };
+
+/**
+ * Check if a column is groupable (| STATS ... BY <column>).
+ *
+ * @param column The DatatableColumn of the field.
+ * @returns True if the column is groupable, false otherwise.
+ */
+
+export const isESQLColumnGroupable = (column: DatatableColumn): boolean => {
+ // we don't allow grouping on the unknown field types
+ if (column.meta?.type === UNKNOWN_FIELD) {
+ return false;
+ }
+ // we don't allow grouping on tsdb counter fields
+ if (column.meta?.esType && column.meta?.esType?.indexOf(TSDB_COUNTER_FIELDS_PREFIX) !== -1) {
+ return false;
+ }
+
+ return true;
+};

src/plugins/unified_histogram/public/chart/breakdown_field_selector.tsx

@@ -11,6 +11,7 @@ import React, { useCallback, useMemo } from 'react';
 import { EuiSelectableOption } from '@elastic/eui';
 import { FieldIcon, getFieldIconProps, comboBoxFieldOptionMatcher } from '@kbn/field-utils';
 import { css } from '@emotion/react';
+import { isESQLColumnGroupable } from '@kbn/esql-utils';
 import { type DataView, DataViewField } from '@kbn/data-views-plugin/common';
 import type { DatatableColumn } from '@kbn/expressions-plugin/common';
 import { convertDatatableColumnToDataViewFieldSpec } from '@kbn/data-view-utils';
@@ -34,10 +35,10 @@ export interface BreakdownFieldSelectorProps {
 const mapToDropdownFields = (dataView: DataView, esqlColumns?: DatatableColumn[]) => {
  if (esqlColumns) {
  return (
+ // filter out unsupported field types and counter time series metrics
  esqlColumns
+ .filter(isESQLColumnGroupable)
  .map((column) => new DataViewField(convertDatatableColumnToDataViewFieldSpec(column)))
- // filter out unsupported field types
- .filter((field) => field.type !== 'unknown')
  );
  }
 

src/plugins/unified_histogram/public/services/lens_vis_service.suggestions.test.ts

@@ -254,6 +254,37 @@ describe('LensVisService suggestions', () => {
  expect(lensVis.visContext?.attributes.state.query).toStrictEqual(histogramQuery);
  });
 
+ test('should return histogramSuggestion even if suggestions returned by the api', async () => {
+ const lensVis = await getLensVisMock({
+ filters: [],
+ query: { esql: 'from the-data-view | limit 100' },
+ dataView: dataViewMock,
+ timeInterval: 'auto',
+ timeRange: {
+ from: '2023-09-03T08:00:00.000Z',
+ to: '2023-09-04T08:56:28.274Z',
+ },
+ breakdownField: undefined,
+ columns: [
+ {
+ id: 'var0',
+ name: 'var0',
+ meta: {
+ type: 'number',
+ },
+ },
+ ],
+ isPlainRecord: true,
+ allSuggestions: allSuggestionsMock,
+ hasHistogramSuggestionForESQL: true,
+ });
+
+ expect(lensVis.currentSuggestionContext?.type).toBe(
+ UnifiedHistogramSuggestionType.histogramForESQL
+ );
+ expect(lensVis.currentSuggestionContext?.suggestion).toBeDefined();
+ });
+
  test('should return histogramSuggestion if no suggestions returned by the api with a geo point breakdown field correctly', async () => {
  const lensVis = await getLensVisMock({
  filters: [],

src/plugins/unified_histogram/public/services/lens_vis_service.ts

@@ -254,6 +254,9 @@ export class LensVisService {
  breakdownField,
  });
  if (histogramSuggestionForESQL) {
+ // In case if histogram suggestion, we want to empty the array and push the new suggestion
+ // to ensure that only the histogram suggestion is available
+ availableSuggestionsWithType.length = 0;
  availableSuggestionsWithType.push({
  suggestion: histogramSuggestionForESQL,
  type: UnifiedHistogramSuggestionType.histogramForESQL,