Skip to content

Commit

Permalink
[ML] Add control to show or hide empty fields in dropdown in Transform (
Browse files Browse the repository at this point in the history
#195485)

## Summary
Follow up of #186670. This PR adds
a new control show or hide empty fields in dropdowns in Transform.

#### Transform

Pivot transform creation


https://github.com/user-attachments/assets/35366671-c7a0-4ba1-ae24-ae3d965a2d69

Latest transform creation

<img width="1473" alt="image"
src="https://github.com/user-attachments/assets/db53e7ed-17d5-44d7-93ab-1d0c5ca22f20">





### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <[email protected]>
  • Loading branch information
qn895 and kibanamachine authored Oct 15, 2024
1 parent cb30988 commit d89f32a
Show file tree
Hide file tree
Showing 8 changed files with 119 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,9 @@ export const OptionsListPopover = ({
}: OptionsListPopoverProps) => {
const { populatedFields } = useFieldStatsFlyoutContext();

const [showEmptyFields, setShowEmptyFields] = useState(false);
const [showEmptyFields, setShowEmptyFields] = useState(
populatedFields ? !(populatedFields.size > 0) : true
);
const id = useMemo(() => htmlIdGenerator()(), []);

const filteredOptions = useMemo(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@

import type { FC } from 'react';
import React, { useMemo, useState } from 'react';
import type { EuiComboBoxOptionOption, EuiComboBoxSingleSelectionShape } from '@elastic/eui';
import type {
EuiComboBoxOptionOption,
EuiComboBoxSingleSelectionShape,
EuiFormControlLayoutProps,
} from '@elastic/eui';
import { EuiInputPopover, htmlIdGenerator, EuiFormControlLayout, EuiFieldText } from '@elastic/eui';
import { css } from '@emotion/react';
import { i18n } from '@kbn/i18n';
Expand All @@ -18,8 +22,6 @@ import type { DropDownLabel } from './types';
const MIN_POPOVER_WIDTH = 400;

export const optionCss = css`
display: flex;
align-items: center;
.euiComboBoxOption__enterBadge {
display: none;
}
Expand All @@ -31,7 +33,8 @@ export const optionCss = css`
}
`;

interface OptionListWithFieldStatsProps {
interface OptionListWithFieldStatsProps
extends Pick<EuiFormControlLayoutProps, 'prepend' | 'compressed'> {
options: DropDownLabel[];
placeholder?: string;
'aria-label'?: string;
Expand All @@ -58,6 +61,8 @@ export const OptionListWithFieldStats: FC<OptionListWithFieldStatsProps> = ({
isDisabled,
isLoading,
isClearable = true,
prepend,
compressed,
'aria-label': ariaLabel,
'data-test-subj': dataTestSubj,
}) => {
Expand All @@ -68,13 +73,12 @@ export const OptionListWithFieldStats: FC<OptionListWithFieldStatsProps> = ({
const comboBoxOptions: DropDownLabel[] = useMemo(
() =>
Array.isArray(options)
? options.map(({ isEmpty, hideTrigger: hideInspectButton, ...o }) => ({
? options.map(({ isEmpty, ...o }) => ({
...o,
css: optionCss,
// Change data-is-empty- because EUI is passing all props to dom element
// so isEmpty is invalid, but we need this info to render option correctly
'data-is-empty': isEmpty,
'data-hide-inspect': hideInspectButton,
}))
: [],
[options]
Expand All @@ -89,6 +93,8 @@ export const OptionListWithFieldStats: FC<OptionListWithFieldStatsProps> = ({
id={popoverId}
input={
<EuiFormControlLayout
prepend={prepend}
compressed={compressed}
fullWidth={fullWidth}
// Adding classname to make functional tests similar to EuiComboBox
className={singleSelection ? 'euiComboBox__inputWrap--plainText' : ''}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ import type { EuiComboBoxOptionOption, EuiSelectableOption } from '@elastic/eui'
import type { Aggregation, Field } from '@kbn/ml-anomaly-utils';

interface BaseOption<T> {
key?: string;
label: string | React.ReactNode;
key?: string;
value?: string | number | string[];
isEmpty?: boolean;
hideTrigger?: boolean;
'data-is-empty'?: boolean;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import React from 'react';

import type { EuiComboBoxOptionsListProps, EuiComboBoxOptionOption } from '@elastic/eui';
import { EuiComboBox } from '@elastic/eui';
import { OptionListWithFieldStats } from '@kbn/ml-field-stats-flyout/options_list_with_stats/option_list_with_stats';

interface Props {
options: EuiComboBoxOptionOption[];
Expand All @@ -30,7 +30,7 @@ export const DropDown: React.FC<Props> = ({
isDisabled,
}) => {
return (
<EuiComboBox
<OptionListWithFieldStats
fullWidth
placeholder={placeholder}
singleSelection={{ asPlainText: true }}
Expand All @@ -40,7 +40,6 @@ export const DropDown: React.FC<Props> = ({
isClearable={false}
data-test-subj={testSubj}
isDisabled={isDisabled}
renderOption={renderOption}
/>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ import type { EuiComboBoxOptionOption } from '@elastic/eui';
import { EuiSpacer, EuiToolTip } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { FieldStatsInfoButton, useFieldStatsTrigger } from '@kbn/ml-field-stats-flyout';
import { AggListForm } from './list_form';
import { DropDown } from '../aggregation_dropdown';
import type { PivotAggsConfig } from '../../../../common';
import { PivotConfigurationContext } from '../pivot_configuration/pivot_configuration';
import { MAX_NESTING_SUB_AGGS } from '../../../../common/pivot_aggs';
import type { DropDownOptionWithField } from '../step_define/common/get_pivot_dropdown_options';
import type { DropDownOption } from '../../../../common/dropdown';

/**
* Component for managing sub-aggregation of the provided
Expand Down Expand Up @@ -54,11 +57,47 @@ export const SubAggsSection: FC<{ item: PivotAggsConfig }> = ({ item }) => {
}
return nestingLevel <= MAX_NESTING_SUB_AGGS;
}, [item]);
const { handleFieldStatsButtonClick, populatedFields } = useFieldStatsTrigger();

const options = useMemo(() => {
const opts: EuiComboBoxOptionOption[] = [];
state.aggOptions.forEach(({ label, field, options: aggOptions }: DropDownOptionWithField) => {
const isEmpty = populatedFields && field.id ? !populatedFields.has(field.id) : false;

const aggOption: DropDownOption = {
isGroupLabel: true,
key: field.id,
searchableLabel: label,
// @ts-ignore Purposefully passing label as element instead of string
// for more robust rendering
label: (
<FieldStatsInfoButton
isEmpty={populatedFields && !populatedFields.has(field.id)}
field={field}
label={label}
onButtonClick={handleFieldStatsButtonClick}
/>
),
};

if (aggOptions.length) {
opts.push(aggOption);
opts.push(
...aggOptions.map((o) => ({
...o,
isEmpty,
isGroupLabel: false,
searchableLabel: o.label,
}))
);
}
});
return opts;
}, [handleFieldStatsButtonClick, populatedFields, state.aggOptions]);
const dropdown = (
<DropDown
changeHandler={addSubAggHandler}
options={state.aggOptions}
options={options}
placeholder={i18n.translate('xpack.transform.stepDefineForm.addSubAggregationPlaceholder', {
defaultMessage: 'Add a sub-aggregation ...',
})}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import { EuiFormRow, type EuiComboBoxOptionOption } from '@elastic/eui';

import { i18n } from '@kbn/i18n';
import { useFieldStatsTrigger, FieldStatsInfoButton } from '@kbn/ml-field-stats-flyout';

import { type DropDownOptionWithField } from '../step_define/common/get_pivot_dropdown_options';
import type { DropDownOption } from '../../../../common';
import { AggListForm } from '../aggregation_list';
Expand Down Expand Up @@ -41,28 +40,42 @@ export const PivotConfiguration: FC<StepDefineFormHook['pivotConfig']> = memo(
const { aggList, aggOptions, aggOptionsData, groupByList, groupByOptions, groupByOptionsData } =
state;

const aggOptionsWithFieldStats: EuiComboBoxOptionOption[] = useMemo(
() =>
aggOptions.map(({ label, field, options }: DropDownOptionWithField) => {
const aggOption: DropDownOption = {
isGroupLabelOption: true,
key: field.id,
// @ts-ignore Purposefully passing label as element instead of string
// for more robust rendering
label: (
<FieldStatsInfoButton
isEmpty={populatedFields && !populatedFields.has(field.id)}
field={field}
label={label}
onButtonClick={handleFieldStatsButtonClick}
/>
),
options: options ?? [],
};
return aggOption;
}),
[aggOptions, handleFieldStatsButtonClick, populatedFields]
);
const aggOptionsWithFieldStats: EuiComboBoxOptionOption[] = useMemo(() => {
const opts: EuiComboBoxOptionOption[] = [];
aggOptions.forEach(({ label, field, options }: DropDownOptionWithField) => {
const isEmpty = populatedFields && field.id ? !populatedFields.has(field.id) : false;

const aggOption: DropDownOption = {
isGroupLabel: true,
key: field.id,
searchableLabel: label,
// @ts-ignore Purposefully passing label as element instead of string
// for more robust rendering
label: (
<FieldStatsInfoButton
isEmpty={populatedFields && !populatedFields.has(field.id)}
field={field}
label={label}
onButtonClick={handleFieldStatsButtonClick}
/>
),
};

if (options.length) {
opts.push(aggOption);
opts.push(
...options.map((o) => ({
...o,
isEmpty,
isGroupLabel: false,
searchableLabel: o.label,
}))
);
}
});
return opts;
}, [aggOptions, handleFieldStatsButtonClick, populatedFields]);

return (
<PivotConfigurationContext.Provider value={{ actions, state }}>
<EuiFormRow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ import React, { type FC } from 'react';
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { EuiButtonIcon, EuiCallOut, EuiComboBox, EuiCopy, EuiFormRow } from '@elastic/eui';
import { useFieldStatsTrigger } from '@kbn/ml-field-stats-flyout';
import type { DropDownLabel } from '@kbn/ml-field-stats-flyout';
import { OptionListWithFieldStats, useFieldStatsTrigger } from '@kbn/ml-field-stats-flyout';
import type { LatestFunctionService } from './hooks/use_latest_function_config';

interface LatestFunctionFormProps {
Expand Down Expand Up @@ -73,7 +74,7 @@ export const LatestFunctionForm: FC<LatestFunctionFormProps> = ({
>
<>
{latestFunctionService.sortFieldOptions.length > 0 && (
<EuiComboBox
<OptionListWithFieldStats
fullWidth
placeholder={i18n.translate('xpack.transform.stepDefineForm.sortPlaceholder', {
defaultMessage: 'Add a date field ...',
Expand All @@ -83,15 +84,19 @@ export const LatestFunctionForm: FC<LatestFunctionFormProps> = ({
selectedOptions={
latestFunctionService.config.sort ? [latestFunctionService.config.sort] : []
}
onChange={(selected) => {
latestFunctionService.updateLatestFunctionConfig({
sort: { value: selected[0].value, label: selected[0].label as string },
});
onChange={(selected: DropDownLabel[]) => {
if (typeof selected[0].value === 'string') {
latestFunctionService.updateLatestFunctionConfig({
sort: {
value: selected[0].value,
label: selected[0].label?.toString(),
},
});
}
closeFlyout();
}}
isClearable={false}
data-test-subj="transformWizardSortFieldSelector"
renderOption={renderOption}
/>
)}
{latestFunctionService.sortFieldOptions.length === 0 && (
Expand Down
15 changes: 12 additions & 3 deletions x-pack/test/functional/services/transform/wizard.ts
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,10 @@ export function TransformWizardProvider({ getService, getPageObjects }: FtrProvi
},

async setSortFieldValue(identificator: string, label: string) {
await comboBox.set('transformWizardSortFieldSelector > comboBoxInput', identificator);
await ml.commonUI.setOptionsListWithFieldStatsValue(
'transformWizardSortFieldSelector > comboBoxInput',
identificator
);
await this.assertSortFieldInputValue(identificator);
},

Expand Down Expand Up @@ -507,7 +510,10 @@ export function TransformWizardProvider({ getService, getPageObjects }: FtrProvi
expectedLabel: string,
expectedIntervalLabel?: string
) {
await comboBox.set('transformGroupBySelection > comboBoxInput', identifier);
await ml.commonUI.setOptionsListWithFieldStatsValue(
'transformGroupBySelection > comboBoxInput',
identifier
);
await this.assertGroupByInputValue([]);
await this.assertGroupByEntryExists(index, expectedLabel, expectedIntervalLabel);
},
Expand Down Expand Up @@ -582,7 +588,10 @@ export function TransformWizardProvider({ getService, getPageObjects }: FtrProvi
formData?: Record<string, any>,
parentSelector = ''
) {
await comboBox.set(this.getAggComboBoxInputSelector(parentSelector), identifier);
await ml.commonUI.setOptionsListWithFieldStatsValue(
this.getAggComboBoxInputSelector(parentSelector),
identifier
);
await this.assertAggregationInputValue([], parentSelector);
await this.assertAggregationEntryExists(index, expectedLabel, parentSelector);

Expand Down

0 comments on commit d89f32a

Please sign in to comment.