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

[React18] Migrate test suites to account for testing library upgrades obs-ux-logs-team #201148

Merged
merged 2 commits into from
Nov 25, 2024
Merged

[React18] Migrate test suites to account for testing library upgrades obs-ux-logs-team #201148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14cc5ca
[React18] Migrated test suites to accommodate changes to testing libr…
eokoneyo Nov 21, 2024
3b5abbd
Merge branch 'main' into chore/testing-library-migration-for-obs-ux-l…
elasticmachine Nov 25, 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
2 changes: 1 addition & 1 deletion packages/kbn-react-hooks/src/use_boolean/use_boolean.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/

import { act, cleanup, renderHook } from '@testing-library/react-hooks';
import { renderHook, act, cleanup } from '@testing-library/react';

import { useBoolean } from './use_boolean';

Expand Down
18 changes: 7 additions & 11 deletions x-pack/plugins/fields_metadata/public/hooks/use_fields_metadata/use_fields_metadata.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import { renderHook } from '@testing-library/react-hooks';
import { waitFor, renderHook } from '@testing-library/react';

import { createUseFieldsMetadataHook, UseFieldsMetadataParams } from './use_fields_metadata';
import { FindFieldsMetadataResponsePayload } from '../../../common/latest';
Expand Down Expand Up @@ -46,12 +46,12 @@ describe('useFieldsMetadata', () => {

it('should return the fieldsMetadata value from the API', async () => {
fieldsMetadataClient.find.mockResolvedValue(mockedFieldsMetadataResponse);
const { result, waitForNextUpdate } = renderHook(() => useFieldsMetadata());
const { result } = renderHook(() => useFieldsMetadata());

expect(result.current.loading).toBe(true);
expect(result.current.fieldsMetadata).toEqual(undefined);

await waitForNextUpdate();
await waitFor(() => new Promise((resolve) => resolve(null)));

const { fieldsMetadata, loading, error } = result.current;
expect(fieldsMetadata).toEqual(fields);
Expand All @@ -68,21 +68,17 @@ describe('useFieldsMetadata', () => {
dataset: 'dataset_name',
};

const { waitForNextUpdate } = renderHook(() => useFieldsMetadata(params));
renderHook(() => useFieldsMetadata(params));

await waitForNextUpdate();

expect(fieldsMetadataClient.find).toHaveBeenCalledWith(params);
await waitFor(() => expect(fieldsMetadataClient.find).toHaveBeenCalledWith(params));
});

it('should return an error if the API call fails', async () => {
const error = new Error('Fetch fields metadata Failed');
fieldsMetadataClient.find.mockRejectedValueOnce(error);

const { result, waitForNextUpdate } = renderHook(() => useFieldsMetadata());

await waitForNextUpdate();
const { result } = renderHook(() => useFieldsMetadata());

expect(result.current.error?.message).toMatch(error.message);
await waitFor(() => expect(result.current.error?.message).toMatch(error.message));
});
});
24 changes: 12 additions & 12 deletions ...bservability_solution/logs_shared/public/containers/logs/log_summary/log_summary.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import { renderHook } from '@testing-library/react-hooks';
import { waitFor, renderHook } from '@testing-library/react';
// We are using this inside a `jest.mock` call. Jest requires dynamic dependencies to be prefixed with `mock`
import { coreMock as mockCoreMock } from '@kbn/core/public/mocks';

Expand Down Expand Up @@ -56,14 +56,14 @@ describe('useLogSummary hook', () => {
.mockResolvedValueOnce(firstMockResponse)
.mockResolvedValueOnce(secondMockResponse);

const { result, waitForNextUpdate, rerender } = renderHook(
const { result, rerender } = renderHook(
({ logViewReference }) => useLogSummary(logViewReference, startTimestamp, endTimestamp, null),
{
initialProps: { logViewReference: LOG_VIEW_REFERENCE },
}
);

await waitForNextUpdate();
await waitFor(() => new Promise((resolve) => resolve(null)));

expect(fetchLogSummaryMock).toHaveBeenCalledTimes(1);
expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
Expand All @@ -75,7 +75,7 @@ describe('useLogSummary hook', () => {
expect(result.current.buckets).toEqual(firstMockResponse.data.buckets);

rerender({ logViewReference: CHANGED_LOG_VIEW_REFERENCE });
await waitForNextUpdate();
await waitFor(() => new Promise((resolve) => resolve(null)));

expect(fetchLogSummaryMock).toHaveBeenCalledTimes(2);
expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
Expand All @@ -101,15 +101,15 @@ describe('useLogSummary hook', () => {
.mockResolvedValueOnce(firstMockResponse)
.mockResolvedValueOnce(secondMockResponse);

const { result, waitForNextUpdate, rerender } = renderHook(
const { result, rerender } = renderHook(
({ filterQuery }) =>
useLogSummary(LOG_VIEW_REFERENCE, startTimestamp, endTimestamp, filterQuery),
{
initialProps: { filterQuery: 'INITIAL_FILTER_QUERY' },
}
);

await waitForNextUpdate();
await waitFor(() => new Promise((resolve) => resolve(null)));

expect(fetchLogSummaryMock).toHaveBeenCalledTimes(1);
expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
Expand All @@ -121,7 +121,7 @@ describe('useLogSummary hook', () => {
expect(result.current.buckets).toEqual(firstMockResponse.data.buckets);

rerender({ filterQuery: 'CHANGED_FILTER_QUERY' });
await waitForNextUpdate();
await waitFor(() => new Promise((resolve) => resolve(null)));

expect(fetchLogSummaryMock).toHaveBeenCalledTimes(2);
expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
Expand All @@ -139,15 +139,15 @@ describe('useLogSummary hook', () => {
.mockResolvedValueOnce(createMockResponse([]));

const firstRange = createMockDateRange();
const { waitForNextUpdate, rerender } = renderHook(
const { rerender } = renderHook(
({ startTimestamp, endTimestamp }) =>
useLogSummary(LOG_VIEW_REFERENCE, startTimestamp, endTimestamp, null),
{
initialProps: firstRange,
}
);

await waitForNextUpdate();
await waitFor(() => new Promise((resolve) => resolve(null)));
expect(fetchLogSummaryMock).toHaveBeenCalledTimes(1);
expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
expect.objectContaining({
Expand All @@ -160,7 +160,7 @@ describe('useLogSummary hook', () => {
const secondRange = createMockDateRange('now-20s', 'now');

rerender(secondRange);
await waitForNextUpdate();
await waitFor(() => new Promise((resolve) => resolve(null)));

expect(fetchLogSummaryMock).toHaveBeenCalledTimes(2);
expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
Expand All @@ -176,7 +176,7 @@ describe('useLogSummary hook', () => {
fetchLogSummaryMock.mockResolvedValueOnce(createMockResponse([]));

const firstRange = createMockDateRange();
const { waitForNextUpdate, rerender } = renderHook(
const { rerender } = renderHook(
({ startTimestamp, endTimestamp }) =>
useLogSummary(LOG_VIEW_REFERENCE, startTimestamp, endTimestamp, null),
{
Expand All @@ -188,7 +188,7 @@ describe('useLogSummary hook', () => {

// intentionally don't wait for an update to test the throttling
rerender(secondRange);
await waitForNextUpdate();
await waitFor(() => new Promise((resolve) => resolve(null)));

expect(fetchLogSummaryMock).toHaveBeenCalledTimes(1);
expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
Expand Down
2 changes: 1 addition & 1 deletion ...ervability_solution/logs_shared/public/utils/data_search/use_data_search_request.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import { act, renderHook } from '@testing-library/react-hooks';
import { renderHook, act } from '@testing-library/react';
import React from 'react';
import { firstValueFrom, Observable, of, Subject } from 'rxjs';
import type { ISearchGeneric, IKibanaSearchResponse } from '@kbn/search-types';
Expand Down
2 changes: 1 addition & 1 deletion ...ion/logs_shared/public/utils/data_search/use_latest_partial_data_search_response.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import { act, renderHook } from '@testing-library/react-hooks';
import { renderHook, act } from '@testing-library/react';
import { BehaviorSubject, Observable, of, Subject } from 'rxjs';
import { IKibanaSearchRequest } from '@kbn/search-types';
import { ParsedDataSearchRequestDescriptor, ParsedKibanaSearchResponse } from './types';
Expand Down