Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ES|QL] Adds the ability to breakdown the histogram in Discover #193820

Merged
merged 20 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@

import { render, act, screen } from '@testing-library/react';
import React from 'react';
import type { DatatableColumn } from '@kbn/expressions-plugin/common';
import { convertDatatableColumnToDataViewFieldSpec } from '@kbn/data-view-utils';
import { DataViewField } from '@kbn/data-views-plugin/common';
import { UnifiedHistogramBreakdownContext } from '../types';
import { dataViewWithTimefieldMock } from '../__mocks__/data_view_with_timefield';
import { BreakdownFieldSelector } from './breakdown_field_selector';

describe('BreakdownFieldSelector', () => {
it('should render correctly', () => {
it('should render correctly for dataview fields', () => {
const onBreakdownFieldChange = jest.fn();
const breakdown: UnifiedHistogramBreakdownContext = {
field: undefined,
Expand Down Expand Up @@ -63,6 +66,67 @@ describe('BreakdownFieldSelector', () => {
`);
});

it('should render correctly for ES|QL columns', () => {
const onBreakdownFieldChange = jest.fn();
const breakdown: UnifiedHistogramBreakdownContext = {
field: undefined,
};

render(
<BreakdownFieldSelector
dataView={dataViewWithTimefieldMock}
breakdown={breakdown}
onBreakdownFieldChange={onBreakdownFieldChange}
esqlColumns={[
{
name: 'bytes',
meta: { type: 'number' },
id: 'bytes',
},
{
name: 'extension',
meta: { type: 'string' },
id: 'extension',
},
]}
/>
);

const button = screen.getByTestId('unifiedHistogramBreakdownSelectorButton');
expect(button.getAttribute('data-selected-value')).toBe(null);

act(() => {
button.click();
});

const options = screen.getAllByRole('option');
expect(
options.map((option) => ({
label: option.getAttribute('title'),
value: option.getAttribute('value'),
checked: option.getAttribute('aria-checked'),
}))
).toMatchInlineSnapshot(`
Array [
Object {
"checked": "true",
"label": "No breakdown",
"value": "__EMPTY_SELECTOR_OPTION__",
},
Object {
"checked": "false",
"label": "bytes",
"value": "bytes",
},
Object {
"checked": "false",
"label": "extension",
"value": "extension",
},
]
`);
});

it('should mark the option as checked if breakdown.field is defined', () => {
const onBreakdownFieldChange = jest.fn();
const field = dataViewWithTimefieldMock.fields.find((f) => f.name === 'extension')!;
Expand Down Expand Up @@ -111,7 +175,7 @@ describe('BreakdownFieldSelector', () => {
`);
});

it('should call onBreakdownFieldChange with the selected field when the user selects a field', () => {
it('should call onBreakdownFieldChange with the selected field when the user selects a dataview field', () => {
const onBreakdownFieldChange = jest.fn();
const selectedField = dataViewWithTimefieldMock.fields.find((f) => f.name === 'bytes')!;
const breakdown: UnifiedHistogramBreakdownContext = {
Expand All @@ -135,4 +199,45 @@ describe('BreakdownFieldSelector', () => {

expect(onBreakdownFieldChange).toHaveBeenCalledWith(selectedField);
});

it('should call onBreakdownFieldChange with the selected field when the user selects an ES|QL field', () => {
const onBreakdownFieldChange = jest.fn();
const esqlColumns = [
{
name: 'bytes',
meta: { type: 'number' },
id: 'bytes',
},
{
name: 'extension',
meta: { type: 'string' },
id: 'extension',
},
] as DatatableColumn[];
const breakdownColumn = esqlColumns.find((c) => c.name === 'bytes')!;
const selectedField = new DataViewField(
convertDatatableColumnToDataViewFieldSpec(breakdownColumn)
);
const breakdown: UnifiedHistogramBreakdownContext = {
field: undefined,
};
render(
<BreakdownFieldSelector
dataView={dataViewWithTimefieldMock}
breakdown={breakdown}
onBreakdownFieldChange={onBreakdownFieldChange}
esqlColumns={esqlColumns}
/>
);

act(() => {
screen.getByTestId('unifiedHistogramBreakdownSelectorButton').click();
});

act(() => {
screen.getByTitle('bytes').click();
});

expect(onBreakdownFieldChange).toHaveBeenCalledWith(selectedField);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ 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 type { DataView, DataViewField } from '@kbn/data-views-plugin/common';
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';
import { i18n } from '@kbn/i18n';
import { UnifiedHistogramBreakdownContext } from '../types';
import { fieldSupportsBreakdown } from '../utils/field_supports_breakdown';
Expand All @@ -25,17 +27,31 @@ import {
export interface BreakdownFieldSelectorProps {
dataView: DataView;
breakdown: UnifiedHistogramBreakdownContext;
esqlColumns?: DatatableColumn[];
onBreakdownFieldChange?: (breakdownField: DataViewField | undefined) => void;
}

const mapToDropdownFields = (dataView: DataView, esqlColumns?: DatatableColumn[]) => {
if (esqlColumns) {
return esqlColumns.map((column) => ({
name: column.name,
displayName: column.name,
type: column.meta?.type,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could use convertDatatableColumnToDataViewFieldSpec here too for consistency in how types are treated and map as new DataViewField(convertDatatableColumnToDataViewFieldSpec(column))

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might also want to filter out unsupported field types with fieldSupportsBreakdown for ES|QL case too.

Copy link
Contributor Author

@stratoula stratoula Oct 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice suggestion, implemented here 9e731df

Note: I don't filter out as we do with the dataview mode as they are not the same operations. Here you can group by with all the filed types. But I added a filter out for unsupported fields as these are not supported by the BY operator e757a54

}));
}

return dataView.fields.filter(fieldSupportsBreakdown);
};

export const BreakdownFieldSelector = ({
dataView,
breakdown,
esqlColumns,
onBreakdownFieldChange,
}: BreakdownFieldSelectorProps) => {
const fields = useMemo(() => mapToDropdownFields(dataView, esqlColumns), [dataView, esqlColumns]);
const fieldOptions: SelectableEntry[] = useMemo(() => {
const options: SelectableEntry[] = dataView.fields
.filter(fieldSupportsBreakdown)
const options: SelectableEntry[] = fields
.map((field) => ({
key: field.name,
name: field.name,
Expand Down Expand Up @@ -69,16 +85,24 @@ export const BreakdownFieldSelector = ({
});

return options;
}, [dataView, breakdown.field]);
}, [fields, breakdown?.field]);

const onChange = useCallback<NonNullable<ToolbarSelectorProps['onChange']>>(
(chosenOption) => {
const field = chosenOption?.value
? dataView.fields.find((currentField) => currentField.name === chosenOption.value)
: undefined;
onBreakdownFieldChange?.(field);
let breakdownField: DataViewField | undefined;
if (esqlColumns) {
const breakdownColumn = esqlColumns?.find((column) => column.name === chosenOption?.value);
breakdownField = breakdownColumn
? new DataViewField(convertDatatableColumnToDataViewFieldSpec(breakdownColumn))
: undefined;
} else {
breakdownField = chosenOption?.value
? dataView.fields.find((currentField) => currentField.name === chosenOption.value)
: undefined;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could simplify this: remove if case and go through fields array instead (considering it consists of data view fields or derived fields with new DataViewField(convertDatatableColumnToDataViewFieldSpec(column)))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! Done here 9e731df

onBreakdownFieldChange?.(breakdownField);
},
[dataView.fields, onBreakdownFieldChange]
[dataView.fields, esqlColumns, onBreakdownFieldChange]
);

return (
Expand Down
4 changes: 4 additions & 0 deletions src/plugins/unified_histogram/public/chart/chart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import type {
LensEmbeddableInput,
LensEmbeddableOutput,
} from '@kbn/lens-plugin/public';
import type { DatatableColumn } from '@kbn/expressions-plugin/common';
import type { DataView, DataViewField } from '@kbn/data-views-plugin/public';
import type { TimeRange } from '@kbn/es-query';
import { Histogram } from './histogram';
Expand Down Expand Up @@ -79,6 +80,7 @@ export interface ChartProps {
onFilter?: LensEmbeddableInput['onFilter'];
onBrushEnd?: LensEmbeddableInput['onBrushEnd'];
withDefaultActions: EmbeddableComponentProps['withDefaultActions'];
columns?: DatatableColumn[];
}

const HistogramMemoized = memo(Histogram);
Expand Down Expand Up @@ -114,6 +116,7 @@ export function Chart({
onBrushEnd,
withDefaultActions,
abortController,
columns,
}: ChartProps) {
const lensVisServiceCurrentSuggestionContext = useObservable(
lensVisService.currentSuggestionContext$
Expand Down Expand Up @@ -312,6 +315,7 @@ export function Chart({
dataView={dataView}
breakdown={breakdown}
onBreakdownFieldChange={onBreakdownFieldChange}
esqlColumns={isPlainRecord ? columns : undefined}
/>
)}
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ export const UnifiedHistogramContainer = forwardRef<
query,
searchSessionId,
requestAdapter,
columns: containerProps.columns,
});

const handleVisContextChange: UnifiedHistogramLayoutProps['onVisContextChanged'] | undefined =
Expand Down
Loading