Skip to content

[ResponseOps][Alerts] Don't show empty state in grouping component while first loading #195777

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

Merged
umbopepato merged 3 commits into from
Oct 14, 2024
Merged

[ResponseOps][Alerts] Don't show empty state in grouping component while first loading #195777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0621b00
Don't show empty state in grouping component while first loading
umbopepato Oct 10, 2024
ab4a612
Merge branch 'main' of github.com:elastic/kibana into 190954-grouping…
umbopepato Oct 14, 2024
4c5d95b
Update grouping test
umbopepato Oct 14, 2024
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
73 changes: 42 additions & 31 deletions packages/kbn-grouping/src/components/grouping.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,41 +7,52 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/

import { fireEvent, render, within } from '@testing-library/react';
import { fireEvent, render, within, screen } from '@testing-library/react';
import React from 'react';
import { I18nProvider } from '@kbn/i18n-react';
import { Grouping } from './grouping';
import { Grouping, GroupingProps } from './grouping';
import { createGroupFilter, getNullGroupFilter } from '../containers/query/helpers';
import { METRIC_TYPE } from '@kbn/analytics';
import { getTelemetryEvent } from '../telemetry/const';

import { mockGroupingProps, host1Name, host2Name } from './grouping.mock';
import { SetRequired } from 'type-fest';

const renderChildComponent = jest.fn();
const takeActionItems = jest.fn();
const mockTracker = jest.fn();

const testProps = {
const testProps: SetRequired<GroupingProps<{}>, 'data'> = {
...mockGroupingProps,
renderChildComponent,
takeActionItems,
tracker: mockTracker,
};

describe('grouping container', () => {
describe('Grouping', () => {
beforeEach(() => {
jest.clearAllMocks();
});

it('Renders groups count when groupsCount > 0', () => {
const { getByTestId, getAllByTestId, queryByTestId } = render(
render(
<I18nProvider>
<Grouping {...testProps} />
</I18nProvider>
);
expect(getByTestId('unit-count').textContent).toBe('14 events');
expect(getByTestId('group-count').textContent).toBe('3 groups');
expect(getAllByTestId('grouping-accordion').length).toBe(3);
expect(queryByTestId('empty-results-panel')).not.toBeInTheDocument();
expect(screen.getByTestId('unit-count').textContent).toBe('14 events');
expect(screen.getByTestId('group-count').textContent).toBe('3 groups');
expect(screen.getAllByTestId('grouping-accordion').length).toBe(3);
expect(screen.queryByTestId('empty-results-panel')).not.toBeInTheDocument();
});

it('Does not render empty state while loading', () => {
render(
<I18nProvider>
<Grouping {...testProps} isLoading />
</I18nProvider>
);
expect(screen.queryByTestId('empty-results-panel')).not.toBeInTheDocument();
});

it('Does not render group counts when groupsCount = 0', () => {
Expand All @@ -58,25 +69,25 @@ describe('grouping container', () => {
value: 0,
},
};
const { getByTestId, queryByTestId } = render(
render(
<I18nProvider>
<Grouping {...testProps} data={data} />
</I18nProvider>
);
expect(queryByTestId('unit-count')).not.toBeInTheDocument();
expect(queryByTestId('group-count')).not.toBeInTheDocument();
expect(queryByTestId('grouping-accordion')).not.toBeInTheDocument();
expect(getByTestId('empty-results-panel')).toBeInTheDocument();
expect(screen.queryByTestId('unit-count')).not.toBeInTheDocument();
expect(screen.queryByTestId('group-count')).not.toBeInTheDocument();
expect(screen.queryByTestId('grouping-accordion')).not.toBeInTheDocument();
expect(screen.getByTestId('empty-results-panel')).toBeInTheDocument();
});

it('Opens one group at a time when each group is clicked', () => {
const { getAllByTestId } = render(
render(
<I18nProvider>
<Grouping {...testProps} />
</I18nProvider>
);
const group1 = within(getAllByTestId('grouping-accordion')[0]).getAllByRole('button')[0];
const group2 = within(getAllByTestId('grouping-accordion')[1]).getAllByRole('button')[0];
const group1 = within(screen.getAllByTestId('grouping-accordion')[0]).getAllByRole('button')[0];
const group2 = within(screen.getAllByTestId('grouping-accordion')[1]).getAllByRole('button')[0];
fireEvent.click(group1);
expect(renderChildComponent).toHaveBeenNthCalledWith(
1,
Expand All @@ -90,12 +101,12 @@ describe('grouping container', () => {
});

it('Send Telemetry when each group is clicked', () => {
const { getAllByTestId } = render(
render(
<I18nProvider>
<Grouping {...testProps} />
</I18nProvider>
);
const group1 = within(getAllByTestId('grouping-accordion')[0]).getAllByRole('button')[0];
const group1 = within(screen.getAllByTestId('grouping-accordion')[0]).getAllByRole('button')[0];
fireEvent.click(group1);
expect(mockTracker).toHaveBeenNthCalledWith(
1,
Expand All @@ -120,19 +131,19 @@ describe('grouping container', () => {

it('Renders a null group and passes the correct filter to take actions and child component', () => {
takeActionItems.mockReturnValue([<span />]);
const { getAllByTestId, getByTestId } = render(
render(
<I18nProvider>
<Grouping {...testProps} />
</I18nProvider>
);
expect(getByTestId('null-group-icon')).toBeInTheDocument();
expect(screen.getByTestId('null-group-icon')).toBeInTheDocument();

let lastGroup = getAllByTestId('grouping-accordion').at(-1);
let lastGroup = screen.getAllByTestId('grouping-accordion').at(-1);
fireEvent.click(within(lastGroup!).getByTestId('take-action-button'));

expect(takeActionItems).toHaveBeenCalledWith(getNullGroupFilter('host.name'), 2);

lastGroup = getAllByTestId('grouping-accordion').at(-1);
lastGroup = screen.getAllByTestId('grouping-accordion').at(-1);
fireEvent.click(within(lastGroup!).getByTestId('group-panel-toggle'));

expect(renderChildComponent).toHaveBeenCalledWith(getNullGroupFilter('host.name'));
Expand All @@ -149,23 +160,23 @@ describe('grouping container', () => {
expect(groupPanelRenderer).toHaveBeenNthCalledWith(
1,
'host.name',
testProps.data.groupByFields.buckets[0],
testProps.data.groupByFields!.buckets![0],
undefined,
false
);

expect(groupPanelRenderer).toHaveBeenNthCalledWith(
2,
'host.name',
testProps.data.groupByFields.buckets[1],
testProps.data.groupByFields!.buckets![1],
undefined,
false
);

expect(groupPanelRenderer).toHaveBeenNthCalledWith(
3,
'host.name',
testProps.data.groupByFields.buckets[2],
testProps.data.groupByFields!.buckets![2],
'The selected group by field, host.name, is missing a value for this group of events.',
false
);
Expand All @@ -181,20 +192,20 @@ describe('grouping container', () => {
expect(groupPanelRenderer).toHaveBeenNthCalledWith(
1,
'host.name',
testProps.data.groupByFields.buckets[0],
testProps.data.groupByFields!.buckets![0],
undefined,
true
);
});

describe('groupsUnit', () => {
it('renders default groupsUnit text correctly', () => {
const { getByTestId } = render(
render(
<I18nProvider>
<Grouping {...testProps} />
</I18nProvider>
);
expect(getByTestId('group-count').textContent).toBe('3 groups');
expect(screen.getByTestId('group-count').textContent).toBe('3 groups');
});
it('calls custom groupsUnit callback correctly', () => {
// Provide a custom groupsUnit function in testProps
Expand All @@ -203,14 +214,14 @@ describe('grouping container', () => {
);
const customProps = { ...testProps, groupsUnit: customGroupsUnit };

const { getByTestId } = render(
render(
<I18nProvider>
<Grouping {...customProps} />
</I18nProvider>
);

expect(customGroupsUnit).toHaveBeenCalledWith(3, testProps.selectedGroup, true);
expect(getByTestId('group-count').textContent).toBe('3 custom units');
expect(screen.getByTestId('group-count').textContent).toBe('3 custom units');
});
});
});
5 changes: 2 additions & 3 deletions packages/kbn-grouping/src/components/grouping.tsx
View file
Open in desktop
Copy link
Copy Markdown
Member

@cnasikas cnasikas Oct 11, 2024

Choose a reason for hiding this comment

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

Could you please add a unit test for the new behavior?

Copy link
Copy Markdown
Member Author

@umbopepato umbopepato Oct 14, 2024

Choose a reason for hiding this comment

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

I took the occasion and also updated the whole test file to screen._ queries 🙂

Original file line number Diff line number Diff line change
Expand Up @@ -222,10 +222,9 @@ const GroupingComponent = <T,>({
css={groupingLevel > 0 ? groupingContainerCssLevel : groupingContainerCss}
className="eui-xScroll"
>
{isLoading && (
{isLoading ? (
<EuiProgress data-test-subj="is-loading-grouping-table" size="xs" color="accent" />
)}
{groupCount > 0 ? (
) : groupCount > 0 ? (
<span data-test-subj={`grouping-level-${groupingLevel}`}>
{groupPanels}
{groupCount > 0 && (
Expand Down