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

[8.16] [ML] Transforms: Limit the data grid result window (#196510) #196829

Merged
merged 1 commit into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
14 changes: 8 additions & 6 deletions x-pack/packages/ml/data_grid/hooks/use_data_grid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { ES_CLIENT_TOTAL_HITS_RELATION } from '@kbn/ml-query-utils';
import { INDEX_STATUS } from '../lib/common';
import type { ChartData } from '../lib/field_histograms';
import { ColumnChart } from '../components/column_chart';
import { COLUMN_CHART_DEFAULT_VISIBILITY_ROWS_THRESHOLD, INIT_MAX_COLUMNS } from '../lib/common';
import { MAX_ROW_COUNT, INIT_MAX_COLUMNS } from '../lib/common';
import type {
ChartsVisible,
ColumnId,
Expand Down Expand Up @@ -62,6 +62,11 @@ export const useDataGrid = (

const { rowCount, rowCountRelation } = rowCountInfo;

const setLimitedRowCountInfo = useCallback((info: RowCountInfo) => {
const limitedRowCount = Math.min(info.rowCount, MAX_ROW_COUNT);
setRowCountInfo({ rowCount: limitedRowCount, rowCountRelation: info.rowCountRelation });
}, []);

const toggleChartVisibility = () => {
if (chartsVisible !== undefined) {
setChartsVisible(!chartsVisible);
Expand Down Expand Up @@ -161,10 +166,7 @@ export const useDataGrid = (
// we decide whether to show or hide the charts by default.
useEffect(() => {
if (chartsVisible === undefined && rowCount > 0 && rowCountRelation !== undefined) {
setChartsVisible(
rowCount <= COLUMN_CHART_DEFAULT_VISIBILITY_ROWS_THRESHOLD &&
rowCountRelation !== ES_CLIENT_TOTAL_HITS_RELATION.GTE
);
setChartsVisible(rowCountRelation !== ES_CLIENT_TOTAL_HITS_RELATION.GTE);
}
}, [chartsVisible, rowCount, rowCountRelation]);

Expand All @@ -189,7 +191,7 @@ export const useDataGrid = (
setErrorMessage,
setNoDataMessage,
setPagination,
setRowCountInfo,
setRowCountInfo: setLimitedRowCountInfo,
setSortingColumns,
setStatus,
setTableItems,
Expand Down
4 changes: 2 additions & 2 deletions x-pack/packages/ml/data_grid/lib/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ import type { DataGridItem, IndexPagination, RenderCellValue } from './types';
export const INIT_MAX_COLUMNS = 10;

/**
* The default threshold value for the number of rows at which the column chart visibility is set to true.
* The default maximum row count value, set to 10000 due to ES limitations.
*/
export const COLUMN_CHART_DEFAULT_VISIBILITY_ROWS_THRESHOLD = 10000;
export const MAX_ROW_COUNT = 10000;

/**
* Enum for index status
Expand Down
2 changes: 1 addition & 1 deletion x-pack/packages/ml/data_grid/lib/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ export interface UseDataGridReturnType {
/**
* Setter function for the row count info.
*/
setRowCountInfo: Dispatch<SetStateAction<RowCountInfo>>;
setRowCountInfo: (info: RowCountInfo) => void;
/**
* Setter function for the sorting columns.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ import { useStorage } from '@kbn/ml-local-storage';
import { useUrlState } from '@kbn/ml-url-state';
import { useFieldStatsFlyoutContext } from '@kbn/ml-field-stats-flyout';

import { MAX_ROW_COUNT } from '@kbn/ml-data-grid/lib/common';
import { FormattedMessage } from '@kbn/i18n-react';
import type { PivotAggDict } from '../../../../../../common/types/pivot_aggs';
import type { PivotGroupByDict } from '../../../../../../common/types/pivot_group_by';
import { TRANSFORM_FUNCTION } from '../../../../../../common/constants';
Expand Down Expand Up @@ -288,6 +290,14 @@ export const StepDefineForm: FC<StepDefineFormProps> = React.memo((props) => {
};
});

const rowCountInfoLabel = (
<FormattedMessage
id="xpack.transform.stepDefineForm.rowCountInfoLabel"
defaultMessage="Results are limited to a maximum of {maxRowCount} for preview purposes"
values={{ maxRowCount: MAX_ROW_COUNT }}
/>
);

return (
<div data-test-subj="transformStepDefineForm">
<EuiForm>
Expand Down Expand Up @@ -467,6 +477,11 @@ export const StepDefineForm: FC<StepDefineFormProps> = React.memo((props) => {
label={i18n.translate('xpack.transform.stepDefineForm.dataGridLabel', {
defaultMessage: 'Source documents',
})}
labelAppend={
indexPreviewProps.rowCount === MAX_ROW_COUNT && (
<EuiText size="xs">{rowCountInfoLabel}</EuiText>
)
}
>
<DataGrid {...indexPreviewProps} />
</EuiFormRow>
Expand Down Expand Up @@ -503,6 +518,11 @@ export const StepDefineForm: FC<StepDefineFormProps> = React.memo((props) => {
label={i18n.translate('xpack.transform.stepDefineForm.previewLabel', {
defaultMessage: 'Preview',
})}
labelAppend={
previewProps.rowCount === MAX_ROW_COUNT && (
<EuiText size="xs">{rowCountInfoLabel}</EuiText>
)
}
>
<>
<DataGrid {...previewProps} />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ export default function ({ getService }: FtrProviderContext) {
await transform.wizard.assertAdvancedQueryEditorSwitchCheckState(false);

await transform.testExecution.logTestStep('enables the index preview histogram charts');
await transform.wizard.enableIndexPreviewHistogramCharts(false);
await transform.wizard.enableIndexPreviewHistogramCharts(true);
await transform.testExecution.logTestStep('displays the index preview histogram charts');
await transform.wizard.assertIndexPreviewHistogramCharts(
testData.expected.histogramCharts
Expand Down