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.

Sign up for GitHub

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

[Discover] [Unified Data Table] Disable filtering for multivalue fields in ES|QL mode #35

Merged
merged 1 commit into from
Sep 24, 2024
Merged

[Discover] [Unified Data Table] Disable filtering for multivalue fields in ES|QL mode #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion packages/kbn-unified-data-table/src/components/data_table_columns.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,13 @@ function buildEuiGridColumn({
cellActions = columnCellActions;
} else {
cellActions = dataViewField
? buildCellActions(dataViewField, toastNotifications, valueToStringConverter, onFilter)
? buildCellActions(
dataViewField,
isPlainRecord,
toastNotifications,
valueToStringConverter,
onFilter
)
: [];

if (columnCellActions?.length && cellActionsHandling === 'append') {
Expand Down
83 changes: 59 additions & 24 deletions packages/kbn-unified-data-table/src/components/default_cell_actions.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ describe('Default cell actions ', function () {
it('should not show cell actions for unfilterable fields', async () => {
const cellActions = buildCellActions(
{ name: 'foo', filterable: false } as DataViewField,
false,
servicesMock.toastNotifications,
dataTableContextMock.valueToStringConverter
);
Expand All @@ -61,6 +62,7 @@ describe('Default cell actions ', function () {
it('should show filter actions for filterable fields', async () => {
const cellActions = buildCellActions(
{ name: 'foo', filterable: true } as DataViewField,
false,
servicesMock.toastNotifications,
dataTableContextMock.valueToStringConverter,
jest.fn()
Expand All @@ -71,6 +73,7 @@ describe('Default cell actions ', function () {
it('should show Copy action for _source field', async () => {
const cellActions = buildCellActions(
{ name: '_source', type: '_source', filterable: false } as DataViewField,
false,
servicesMock.toastNotifications,
dataTableContextMock.valueToStringConverter
);
Expand All @@ -87,65 +90,97 @@ describe('Default cell actions ', function () {
const component = mountWithIntl(
<UnifiedDataTableContext.Provider value={dataTableContextMock}>
<FilterInBtn
Component={(props: any) => <EuiButton {...props} />}
rowIndex={1}
colIndex={1}
columnId="extension"
isExpanded={false}
cellActionProps={{
Component: (props: any) => <EuiButton {...props} />,
rowIndex: 1,
colIndex: 1,
columnId: 'extension',
isExpanded: false,
}}
field={{ name: 'extension', filterable: true } as DataViewField}
isPlainRecord={false}
/>
</UnifiedDataTableContext.Provider>
);
const button = findTestSubject(component, 'filterForButton');
await button.simulate('click');
expect(dataTableContextMock.onFilter).toHaveBeenCalledWith({}, 'jpg', '+');
expect(dataTableContextMock.onFilter).toHaveBeenCalledWith(
{ name: 'extension', filterable: true },
'jpg',
'+'
);
});
it('triggers filter function when FilterInBtn is clicked for a non-provided value', async () => {
const component = mountWithIntl(
<UnifiedDataTableContext.Provider value={dataTableContextMock}>
<FilterInBtn
Component={(props: any) => <EuiButton {...props} />}
rowIndex={0}
colIndex={1}
columnId="extension"
isExpanded={false}
cellActionProps={{
Component: (props: any) => <EuiButton {...props} />,
rowIndex: 0,
colIndex: 1,
columnId: 'extension',
isExpanded: false,
}}
field={{ name: 'extension', filterable: true } as DataViewField}
isPlainRecord={false}
/>
</UnifiedDataTableContext.Provider>
);
const button = findTestSubject(component, 'filterForButton');
await button.simulate('click');
expect(dataTableContextMock.onFilter).toHaveBeenCalledWith({}, undefined, '+');
expect(dataTableContextMock.onFilter).toHaveBeenCalledWith(
{ name: 'extension', filterable: true },
undefined,
'+'
);
});
it('triggers filter function when FilterInBtn is clicked for an empty string value', async () => {
const component = mountWithIntl(
<UnifiedDataTableContext.Provider value={dataTableContextMock}>
<FilterInBtn
Component={(props: any) => <EuiButton {...props} />}
rowIndex={4}
colIndex={1}
columnId="message"
isExpanded={false}
cellActionProps={{
Component: (props: any) => <EuiButton {...props} />,
rowIndex: 4,
colIndex: 1,
columnId: 'message',
isExpanded: false,
}}
field={{ name: 'message', filterable: true } as DataViewField}
isPlainRecord={false}
/>
</UnifiedDataTableContext.Provider>
);
const button = findTestSubject(component, 'filterForButton');
await button.simulate('click');
expect(dataTableContextMock.onFilter).toHaveBeenCalledWith({}, '', '+');
expect(dataTableContextMock.onFilter).toHaveBeenCalledWith(
{ name: 'message', filterable: true },
'',
'+'
);
});
it('triggers filter function when FilterOutBtn is clicked', async () => {
const component = mountWithIntl(
<UnifiedDataTableContext.Provider value={dataTableContextMock}>
<FilterOutBtn
Component={(props: any) => <EuiButton {...props} />}
rowIndex={1}
colIndex={1}
columnId="extension"
isExpanded={false}
cellActionProps={{
Component: (props: any) => <EuiButton {...props} />,
rowIndex: 1,
colIndex: 1,
columnId: 'extension',
isExpanded: false,
}}
field={{ name: 'extension', filterable: true } as DataViewField}
isPlainRecord={false}
/>
</UnifiedDataTableContext.Provider>
);
const button = findTestSubject(component, 'filterOutButton');
await button.simulate('click');
expect(dataTableContextMock.onFilter).toHaveBeenCalledWith({}, 'jpg', '-');
expect(dataTableContextMock.onFilter).toHaveBeenCalledWith(
{ name: 'extension', filterable: true },
'jpg',
'-'
);
});
it('triggers clipboard copy when CopyBtn is clicked', async () => {
const component = mountWithIntl(
Expand Down
66 changes: 46 additions & 20 deletions packages/kbn-unified-data-table/src/components/default_cell_actions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,25 @@ function onFilterCell(
}
}

export const FilterInBtn = (
{ Component, rowIndex, columnId }: EuiDataGridColumnCellActionProps,
field: DataViewField
) => {
const esqlMultivalueFilteringDisabled = i18n.translate(
'unifiedDataTable.grid.esqlMultivalueFilteringDisabled',
{
defaultMessage: 'Multivalue filtering is not supported in ES|QL',
}
);

export const FilterInBtn = ({
cellActionProps: { Component, rowIndex, columnId },
field,
isPlainRecord,
}: {
cellActionProps: EuiDataGridColumnCellActionProps;
field: DataViewField;
isPlainRecord: boolean | undefined;
}) => {
const context = useContext(UnifiedDataTableContext);
const filteringDisabled =
isPlainRecord && Array.isArray(context.rows[rowIndex]?.flattened[columnId]);
const buttonTitle = i18n.translate('unifiedDataTable.grid.filterForAria', {
defaultMessage: 'Filter for this {value}',
values: { value: columnId },
Expand All @@ -49,7 +63,8 @@ export const FilterInBtn = (
}}
iconType="plusInCircle"
aria-label={buttonTitle}
title={buttonTitle}
title={filteringDisabled ? esqlMultivalueFilteringDisabled : buttonTitle}
disabled={filteringDisabled}
data-test-subj="filterForButton"
>
{i18n.translate('unifiedDataTable.grid.filterFor', {
Expand All @@ -59,11 +74,18 @@ export const FilterInBtn = (
);
};

export const FilterOutBtn = (
{ Component, rowIndex, columnId }: EuiDataGridColumnCellActionProps,
field: DataViewField
) => {
export const FilterOutBtn = ({
cellActionProps: { Component, rowIndex, columnId },
field,
isPlainRecord,
}: {
cellActionProps: EuiDataGridColumnCellActionProps;
field: DataViewField;
isPlainRecord: boolean | undefined;
}) => {
const context = useContext(UnifiedDataTableContext);
const filteringDisabled =
isPlainRecord && Array.isArray(context.rows[rowIndex]?.flattened[columnId]);
const buttonTitle = i18n.translate('unifiedDataTable.grid.filterOutAria', {
defaultMessage: 'Filter out this {value}',
values: { value: columnId },
Expand All @@ -76,7 +98,8 @@ export const FilterOutBtn = (
}}
iconType="minusInCircle"
aria-label={buttonTitle}
title={buttonTitle}
title={filteringDisabled ? esqlMultivalueFilteringDisabled : buttonTitle}
disabled={filteringDisabled}
data-test-subj="filterOutButton"
>
{i18n.translate('unifiedDataTable.grid.filterOut', {
Expand Down Expand Up @@ -120,23 +143,26 @@ export function buildCopyValueButton(

export function buildCellActions(
field: DataViewField,
isPlainRecord: boolean | undefined,
toastNotifications: ToastsStart,
valueToStringConverter: ValueToStringConverter,
onFilter?: DocViewFilterFn
) {
return [
...(onFilter && field.filterable
? [
({ Component, rowIndex, columnId }: EuiDataGridColumnCellActionProps) =>
FilterInBtn(
{ Component, rowIndex, columnId } as EuiDataGridColumnCellActionProps,
field
),
({ Component, rowIndex, columnId }: EuiDataGridColumnCellActionProps) =>
FilterOutBtn(
{ Component, rowIndex, columnId } as EuiDataGridColumnCellActionProps,
field
),
(cellActionProps: EuiDataGridColumnCellActionProps) =>
FilterInBtn({
cellActionProps,
field,
isPlainRecord,
}),
(cellActionProps: EuiDataGridColumnCellActionProps) =>
FilterOutBtn({
cellActionProps,
field,
isPlainRecord,
}),
]
: []),
({ Component, rowIndex, columnId }: EuiDataGridColumnCellActionProps) =>
Expand Down
Loading