Enable include/exclude in Terms agg for numeric fields #59425
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,7 +22,10 @@ import { i18n } from '@kbn/i18n'; | |
| import { BucketAggType, IBucketAggConfig } from './bucket_agg_type'; | ||
| import { BUCKET_TYPES } from './bucket_agg_types'; | ||
| import { createFilterTerms } from './create_filter/terms'; | ||
| import { | ||
| isStringOrNumberType, | ||
| migrateIncludeExcludeFormat, | ||
| } from './migrate_include_exclude_format'; | ||
| import { IAggConfigs } from '../agg_configs'; | ||
|
|
||
| import { Adapters } from '../../../../../inspector/public'; | ||
|
|
@@ -266,7 +269,7 @@ export const getTermsBucketAgg = ({ getInternalStartServices }: TermsBucketAggDe | |
| }), | ||
| type: 'string', | ||
| advanced: true, | ||
| shouldShow: isStringOrNumberType, | ||
| ...migrateIncludeExcludeFormat, | ||
| }, | ||
| { | ||
|
|
@@ -276,7 +279,7 @@ export const getTermsBucketAgg = ({ getInternalStartServices }: TermsBucketAggDe | |
| }), | ||
| type: 'string', | ||
| advanced: true, | ||
| shouldShow: isStringOrNumberType, | ||
| ...migrateIncludeExcludeFormat, | ||
| }, | ||
| ], | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,6 +58,8 @@ const buckets = { | |
| size: controls.SizeParamEditor, | ||
| }, | ||
| [BUCKET_TYPES.TERMS]: { | ||
| include: controls.IncludeExcludeParamEditor, | ||
| exclude: controls.IncludeExcludeParamEditor, | ||
| orderBy: controls.OrderByParamEditor, | ||
| orderAgg: controls.OrderAggParamEditor, | ||
| order: wrapWithInlineComp(controls.OrderParamEditor), | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -119,7 +119,7 @@ function getNextModel(list: NumberRowModel[], range: NumberListRange): NumberRow | |
| }; | ||
| } | ||
|
|
||
| function getInitModelList(list: Array<number | undefined | ''>): NumberRowModel[] { | ||
| return list.length | ||
| ? list.map(num => ({ | ||
| value: (num === undefined ? EMPTY_STRING : num) as NumberRowModel['value'], | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import React, { Fragment, useCallback, useEffect, useMemo, useState } from 'react'; | ||
| import { isArray } from 'lodash'; | ||
| import { EuiButtonEmpty, EuiFlexItem, EuiFormRow, EuiSpacer, htmlIdGenerator } from '@elastic/eui'; | ||
| import { FormattedMessage } from '@kbn/i18n/react'; | ||
| import { EMPTY_STRING, getInitModelList, getRange, parse } from './number_list/utils'; | ||
| import { NumberRow, NumberRowModel } from './number_list/number_row'; | ||
| import { AggParamEditorProps } from '../../agg_param_props'; | ||
|
|
||
| const generateId = htmlIdGenerator(); | ||
|
|
||
| function SimpleNumberList({ | ||
|
There was a problem hiding this comment. @maryia-lapata @DianaDerevyankina Could you please explain shortly what's the different between There was a problem hiding this comment. The difference isn't big:
In case we decide to reuse |
||
| agg, | ||
| aggParam, | ||
| value, | ||
| setValue, | ||
| setTouched, | ||
| }: AggParamEditorProps<Array<number | ''>>) { | ||
| const [numbers, setNumbers] = useState( | ||
| getInitModelList(value && isArray(value) ? value : [EMPTY_STRING]) | ||
| ); | ||
| const numberRange = useMemo(() => getRange('[-Infinity,Infinity]'), []); | ||
|
|
||
| // This useEffect is needed to discard changes, it sets numbers a mapped value if they are different | ||
| useEffect(() => { | ||
| if ( | ||
| isArray(value) && | ||
| (value?.length !== numbers.length || | ||
| !value.every((numberValue, index) => numberValue === numbers[index].value)) | ||
| ) { | ||
| setNumbers( | ||
| value.map(numberValue => ({ | ||
| id: generateId(), | ||
| value: numberValue, | ||
| isInvalid: false, | ||
| })) | ||
| ); | ||
| } | ||
| }, [numbers, value]); | ||
|
|
||
| const onUpdate = useCallback( | ||
| (numberList: NumberRowModel[]) => { | ||
| setNumbers(numberList); | ||
| setValue(numberList.map(({ value: numberValue }) => numberValue)); | ||
| }, | ||
| [setValue] | ||
| ); | ||
|
|
||
| const onChangeValue = useCallback( | ||
| (numberField: { id: string; value: string }) => { | ||
| onUpdate( | ||
| numbers.map(number => | ||
| number.id === numberField.id | ||
| ? { | ||
| id: numberField.id, | ||
| value: parse(numberField.value), | ||
DianaDerevyankina marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| isInvalid: false, | ||
| } | ||
| : number | ||
| ) | ||
| ); | ||
| }, | ||
| [numbers, onUpdate] | ||
| ); | ||
|
|
||
| // Add an item to the end of the list | ||
| const onAdd = useCallback(() => { | ||
| const newArray = [ | ||
| ...numbers, | ||
| { | ||
| id: generateId(), | ||
| value: EMPTY_STRING as '', | ||
| isInvalid: false, | ||
| }, | ||
| ]; | ||
| onUpdate(newArray); | ||
| }, [numbers, onUpdate]); | ||
|
|
||
| const onDelete = useCallback( | ||
| (id: string) => onUpdate(numbers.filter(number => number.id !== id)), | ||
| [numbers, onUpdate] | ||
| ); | ||
|
|
||
| return ( | ||
| <EuiFormRow | ||
| id={`${aggParam.name}-${agg.id}}`} | ||
| label={aggParam.displayName || aggParam.name} | ||
| fullWidth={true} | ||
| compressed | ||
| > | ||
| <> | ||
| {numbers.map((number, arrayIndex) => ( | ||
| <Fragment key={number.id}> | ||
| <NumberRow | ||
| isInvalid={number.isInvalid} | ||
| disableDelete={numbers.length === 1} | ||
| model={number} | ||
| labelledbyId={`${aggParam.name}-${agg.id}-legend`} | ||
| range={numberRange} | ||
| onDelete={onDelete} | ||
| onChange={onChangeValue} | ||
| onBlur={setTouched} | ||
| autoFocus={numbers.length !== 1 && arrayIndex === numbers.length - 1} | ||
| /> | ||
| {numbers.length - 1 !== arrayIndex && <EuiSpacer size="s" />} | ||
| </Fragment> | ||
| ))} | ||
| <EuiSpacer size="s" /> | ||
| <EuiFlexItem> | ||
| <EuiButtonEmpty iconType="plusInCircleFilled" onClick={onAdd} size="xs"> | ||
| <FormattedMessage | ||
| id="visDefaultEditor.controls.includeExclude.addUnitButtonLabel" | ||
| defaultMessage="Add value" | ||
| /> | ||
| </EuiButtonEmpty> | ||
| </EuiFlexItem> | ||
| </> | ||
| </EuiFormRow> | ||
| ); | ||
| } | ||
|
|
||
| export { SimpleNumberList }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import React, { useEffect } from 'react'; | ||
| import { isArray } from 'lodash'; | ||
| import { AggParamEditorProps } from '../agg_param_props'; | ||
| import { StringParamEditor } from './string'; | ||
| import { search } from '../../../../data/public'; | ||
| import { SimpleNumberList } from './components/simple_number_list'; | ||
| const { isNumberType } = search.aggs; | ||
|
|
||
| export function IncludeExcludeParamEditor(props: AggParamEditorProps<string | Array<number | ''>>) { | ||
| const { agg, value, setValue } = props; | ||
| const isAggOfNumberType = isNumberType(agg); | ||
|
|
||
| // This useEffect converts value from string type to number and back when the field type is changed | ||
| useEffect(() => { | ||
| if (isAggOfNumberType && !isArray(value) && value !== undefined) { | ||
| const numberArray = value | ||
| .split(',') | ||
|
There was a problem hiding this comment. I think we want to use |
||
| .map(item => parseFloat(item)) | ||
| .filter(number => !isNaN(number)); | ||
|
There was a problem hiding this comment. I would use |
||
| setValue(numberArray.length ? numberArray : ['']); | ||
| } else if (!isAggOfNumberType && isArray(value) && value !== undefined) { | ||
| setValue((value as Array<number | ''>).filter(item => item !== '').toString()); | ||
|
There was a problem hiding this comment. The case should not be needed here, TypeScript should know that There was a problem hiding this comment. Also |
||
| } | ||
| }, [isAggOfNumberType, setValue, value]); | ||
|
|
||
| return isAggOfNumberType ? ( | ||
| <SimpleNumberList {...props} value={value as Array<number | ''>} /> | ||
| ) : ( | ||
| <StringParamEditor {...props} value={value as string} /> | ||
| ); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,7 @@ export { ExtendedBoundsParamEditor } from './extended_bounds'; | |
| export { FieldParamEditor } from './field'; | ||
| export { FiltersParamEditor } from './filters'; | ||
| export { HasExtendedBoundsParamEditor } from './has_extended_bounds'; | ||
| export { IncludeExcludeParamEditor } from './include_exclude'; | ||
| export { IpRangesParamEditor } from './ip_ranges'; | ||
| export { IpRangeTypeParamEditor } from './ip_range_type'; | ||
| export { IsFilteredByCollarParamEditor } from './is_filtered_by_collar'; | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎨 We're trying to not introduce new lodash code if there is an easy vanilla JS equivalent. So I would recommend using
Array.isArrayinstead of using a lodash function.