github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[React18] Migrate test suites to account for testing library upgrades search-kibana (#201157)

Browse source 
This PR migrates test suites that use `renderHook` from the library
`@testing-library/react-hooks` to adopt the equivalent and replacement
of `renderHook` from the export that is now available from
`@testing-library/react`. This work is required for the planned
migration to react18.

##  Context

In this PR, usages of `waitForNextUpdate` that previously could have
been destructured from `renderHook` are now been replaced with `waitFor`
exported from `@testing-library/react`, furthermore `waitFor`
that would also have been destructured from the same renderHook result
is now been replaced with `waitFor` from the export of
`@testing-library/react`.

***Why is `waitFor` a sufficient enough replacement for
`waitForNextUpdate`, and better for testing values subject to async
computations?***

WaitFor will retry the provided callback if an error is returned, till
the configured timeout elapses. By default the retry interval is `50ms`
with a timeout value of `1000ms` that
effectively translates to at least 20 retries for assertions placed
within waitFor. See
https://testing-library.com/docs/dom-testing-library/api-async/#waitfor
for more information.
This however means that for person's writing tests, said person has to
be explicit about expectations that describe the internal state of the
hook being tested.
This implies checking for instance when a react query hook is being
rendered, there's an assertion that said hook isn't loading anymore.

In this PR you'd notice that this pattern has been adopted, with most
existing assertions following an invocation of `waitForNextUpdate` being
placed within a `waitFor`
invocation. In some cases the replacement is simply a `waitFor(() => new
Promise((resolve) => resolve(null)))` (many thanks to @kapral18, for
point out exactly why this works),
where this suffices the assertions that follow aren't placed within a
waitFor so this PR doesn't get larger than it needs to be.

It's also worth pointing out this PR might also contain changes to test
and application code to improve said existing test.

### What to do next?
1. Review the changes in this PR.
2. If you think the changes are correct, approve the PR.

## Any questions?
If you have any questions or need help with this PR, please leave
comments in this PR.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
This commit is contained in:
Eyo O. Eyo 2024-12-16 10:48:13 +00:00 • committed by GitHub
parent c92899e142
commit 90b77c6ab3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 92 additions and 101 deletions
Download patch file Download diff file Expand all files Collapse all files

91
x-pack/packages/kbn-ai-assistant/src/hooks/use_conversation.test.tsx
View file

@ -5,12 +5,7 @@
* 2.0.
*/
import type { DeeplyMockedKeys } from '@kbn/utility-types-jest';
import {
act,
renderHook,
type RenderHookResult,
type WrapperComponent,
} from '@testing-library/react-hooks';
import { renderHook, act, type RenderHookResult } from '@testing-library/react';
import { merge } from 'lodash';
import React, { PropsWithChildren } from 'react';
import { BehaviorSubject, Observable, of, Subject } from 'rxjs';
@ -33,7 +28,7 @@ import type { NotificationsStart } from '@kbn/core/public';
import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
import { AssistantScope } from '@kbn/ai-assistant-common';
let hookResult: RenderHookResult<UseConversationProps, UseConversationResult>;
let hookResult: RenderHookResult<UseConversationResult, UseConversationProps>;
type MockedService = DeeplyMockedKeys<Omit<AIAssistantAppService, 'conversations'>> & {
conversations: DeeplyMockedKeys<
@ -81,34 +76,32 @@ const useKibanaMockServices = {
};
describe('useConversation', () => {
let wrapper: WrapperComponent<PropsWithChildren<UseConversationProps>>;
const wrapper = ({ children }: PropsWithChildren) => (
<KibanaContextProvider services={useKibanaMockServices}>{children}</KibanaContextProvider>
);
beforeEach(() => {
afterEach(() => {
jest.clearAllMocks();
wrapper = ({ children }: PropsWithChildren<unknown>) => (
<KibanaContextProvider services={useKibanaMockServices}>{children}</KibanaContextProvider>
);
});
describe('with initial messages and a conversation id', () => {
beforeEach(() => {
hookResult = renderHook(useConversation, {
initialProps: {
chatService: mockChatService,
connectorId: 'my-connector',
initialMessages: [
{
'@timestamp': new Date().toISOString(),
message: { content: '', role: MessageRole.User },
},
],
initialConversationId: 'foo',
},
wrapper,
});
});
it('throws an error', () => {
expect(hookResult.result.error).toBeTruthy();
expect(() =>
renderHook(useConversation, {
initialProps: {
chatService: mockChatService,
connectorId: 'my-connector',
initialMessages: [
{
'@timestamp': new Date().toISOString(),
message: { content: '', role: MessageRole.User },
},
],
initialConversationId: 'foo',
},
wrapper,
})
).toThrow(/Cannot set initialMessages if initialConversationId is set/);
});
});
@ -434,25 +427,29 @@ describe('useConversation', () => {
describe('when the title is updated', () => {
describe('without a stored conversation', () => {
beforeEach(() => {
hookResult = renderHook(useConversation, {
initialProps: {
chatService: mockChatService,
connectorId: 'my-connector',
initialMessages: [
{
'@timestamp': new Date().toISOString(),
message: { content: '', role: MessageRole.User },
},
],
initialConversationId: 'foo',
},
wrapper,
});
});
it('throws an error', (done) => {
try {
const { result } = renderHook(useConversation, {
initialProps: {
chatService: mockChatService,
connectorId: 'my-connector',
initialMessages: [
{
'@timestamp': new Date().toISOString(),
message: { content: '', role: MessageRole.User },
},
],
initialConversationId: 'foo',
},
wrapper,
});
it('throws an error', () => {
expect(() => hookResult.result.current.saveTitle('my-new-title')).toThrow();
result.current.saveTitle('my-new-title');
} catch (e) {
expect(e).toBeInstanceOf(Error);
expect(e.message).toBe('Cannot set initialMessages if initialConversationId is set');
done();
}
});
});

2
x-pack/packages/kbn-ai-assistant/src/hooks/use_local_storage.test.ts
View file

@ -5,7 +5,7 @@
* 2.0.
*/
import { renderHook, act } from '@testing-library/react-hooks';
import { renderHook, act } from '@testing-library/react';
import { useLocalStorage } from './use_local_storage';
describe('useLocalStorage', () => {

2
x-pack/plugins/enterprise_search/public/applications/applications/components/search_application/docs_explorer/document_context.test.tsx
View file

@ -7,7 +7,7 @@
import React from 'react';
import { act, renderHook } from '@testing-library/react-hooks';
import { renderHook, act } from '@testing-library/react';
import { DocumentProvider, useSelectedDocument } from './document_context';

2
x-pack/plugins/enterprise_search/public/applications/shared/layout/nav.test.tsx
View file

@ -15,7 +15,7 @@ jest.mock('../../enterprise_search_content/components/search_index/indices/indic
import { setMockValues, mockKibanaValues } from '../../__mocks__/kea_logic';
import { renderHook } from '@testing-library/react-hooks';
import { renderHook } from '@testing-library/react';
import { EuiSideNavItemType } from '@elastic/eui';

6
x-pack/plugins/search_inference_endpoints/public/hooks/use_delete_endpoint.test.tsx
View file

@ -5,7 +5,7 @@
* 2.0.
*/
import { renderHook } from '@testing-library/react-hooks';
import { waitFor, renderHook } from '@testing-library/react';
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { useKibana } from './use_kibana';
import { useDeleteEndpoint } from './use_delete_endpoint';
@ -43,7 +43,7 @@ describe('useDeleteEndpoint', () => {
};
it('should call delete endpoint and show success toast on success', async () => {
const { result, waitFor } = renderHook(() => useDeleteEndpoint(), { wrapper });
const { result } = renderHook(() => useDeleteEndpoint(), { wrapper });
result.current.mutate({ type: 'text_embedding', id: 'in-1' });
@ -60,7 +60,7 @@ describe('useDeleteEndpoint', () => {
it('should show error toast on failure', async () => {
const error = { body: { message: 'error' } };
mockDelete.mockRejectedValue(error);
const { result, waitFor } = renderHook(() => useDeleteEndpoint(), { wrapper });
const { result } = renderHook(() => useDeleteEndpoint(), { wrapper });
result.current.mutate({ type: 'model', id: '123' });

26
x-pack/plugins/search_inference_endpoints/public/hooks/use_scan_usage.test.tsx
View file

@ -7,7 +7,7 @@
import React from 'react';
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { renderHook } from '@testing-library/react-hooks';
import { waitFor, renderHook } from '@testing-library/react';
import { useScanUsage } from './use_scan_usage';
import { useKibana } from './use_kibana';
@ -43,7 +43,7 @@ describe('useScanUsage', () => {
});
test('should call API endpoint with the correct parameters and return response', async () => {
const { result, waitForNextUpdate } = renderHook(
const { result } = renderHook(
() =>
useScanUsage({
type: 'text_embedding',
@ -52,18 +52,18 @@ describe('useScanUsage', () => {
{ wrapper }
);
await waitForNextUpdate();
await waitFor(() => {
expect(mockDelete).toHaveBeenCalledWith(
'/internal/inference_endpoint/endpoints/text_embedding/in-1',
{ query: { scanUsage: true } }
);
expect(mockDelete).toHaveBeenCalledWith(
'/internal/inference_endpoint/endpoints/text_embedding/in-1',
{ query: { scanUsage: true } }
);
expect(result.current.data).toEqual({
acknowledge: true,
error_message: 'inference id is being used',
indexes: ['index1', 'index2'],
pipelines: ['pipeline1', 'pipeline2'],
expect(result.current.data).toEqual({
acknowledge: true,
error_message: 'inference id is being used',
indexes: ['index1', 'index2'],
pipelines: ['pipeline1', 'pipeline2'],
});
});
});
});

2
x-pack/plugins/search_inference_endpoints/public/hooks/use_table_data.test.tsx
View file

@ -6,7 +6,7 @@
*/
import { InferenceAPIConfigResponse } from '@kbn/ml-trained-models-utils';
import { renderHook } from '@testing-library/react-hooks';
import { renderHook } from '@testing-library/react';
import { QueryParams } from '../components/all_inference_endpoints/types';
import { useTableData } from './use_table_data';
import { INFERENCE_ENDPOINTS_TABLE_PER_PAGE_VALUES } from '../components/all_inference_endpoints/types';

2
x-pack/plugins/search_playground/public/hooks/use_llms_models.test.ts
View file

@ -5,7 +5,7 @@
* 2.0.
*/
import { renderHook } from '@testing-library/react-hooks';
import { renderHook } from '@testing-library/react';
import { useLoadConnectors } from './use_load_connectors';
import { useLLMsModels } from './use_llms_models';
import { LLMs } from '../types';

36
x-pack/plugins/search_playground/public/hooks/use_load_connectors.test.ts
View file

@ -8,7 +8,7 @@
import { loadAllActions as loadConnectors } from '@kbn/triggers-actions-ui-plugin/public/common/constants';
import { useLoadConnectors } from './use_load_connectors';
import { useKibana } from './use_kibana';
import { act, renderHook } from '@testing-library/react-hooks';
import { waitFor, renderHook } from '@testing-library/react';
import { OpenAiProviderType } from '@kbn/stack-connectors-plugin/common/openai/constants';
const mockedLoadConnectors = loadConnectors as jest.Mock;
@ -80,11 +80,9 @@ describe('useLoadConnectors', () => {
];
mockedLoadConnectors.mockResolvedValue(connectors);
await act(async () => {
const { result, waitForNextUpdate } = renderHook(() => useLoadConnectors());
await waitForNextUpdate();
await expect(result.current).resolves.toStrictEqual([
const { result } = renderHook(() => useLoadConnectors());
await waitFor(() =>
expect(result.current).resolves.toStrictEqual([
{
actionTypeId: '.gen-ai',
config: {
@ -122,8 +120,8 @@ describe('useLoadConnectors', () => {
title: 'OpenAI Other',
type: 'openai_other',
},
]);
});
])
);
});
it('handles pre-configured connectors', async () => {
@ -149,11 +147,9 @@ describe('useLoadConnectors', () => {
];
mockedLoadConnectors.mockResolvedValue(connectors);
await act(async () => {
const { result, waitForNextUpdate } = renderHook(() => useLoadConnectors());
await waitForNextUpdate();
await expect(result.current).resolves.toStrictEqual([
const { result } = renderHook(() => useLoadConnectors());
await waitFor(() =>
expect(result.current).resolves.toStrictEqual([
{
actionTypeId: '.gen-ai',
id: '1',
@ -171,22 +167,20 @@ describe('useLoadConnectors', () => {
title: 'OpenAI Azure',
type: 'openai_azure',
},
]);
});
])
);
});
it('handles errors correctly', async () => {
const error = new Error('Test Error');
mockedLoadConnectors.mockRejectedValue(error);
await act(async () => {
const { waitForNextUpdate } = renderHook(() => useLoadConnectors());
await waitForNextUpdate();
renderHook(() => useLoadConnectors());
await waitFor(() =>
expect(mockedUseKibana().services.notifications.toasts.addError).toHaveBeenCalledWith(
error,
expect.any(Object)
);
});
)
);
});
});

2
x-pack/plugins/search_playground/public/hooks/use_load_fields_by_indices.test.ts
View file

@ -5,7 +5,7 @@
* 2.0.
*/
import { renderHook } from '@testing-library/react-hooks';
import { renderHook } from '@testing-library/react';
import { useLoadFieldsByIndices } from './use_load_fields_by_indices';
import { useUsageTracker } from './use_usage_tracker';
import { useIndicesFields } from './use_indices_fields';

16
x-pack/plugins/search_playground/public/hooks/use_management_link.test.ts
View file

@ -5,7 +5,7 @@
* 2.0.
*/
import { renderHook } from '@testing-library/react-hooks';
import { waitFor, renderHook } from '@testing-library/react';
import { useManagementLink } from './use_management_link';
import { useKibana } from './use_kibana';
@ -41,13 +41,13 @@ describe('useManagementLink Hook', () => {
'http://localhost:5601/app/management/insightsAndAlerting/triggersActionsConnectors';
mockGetUrl.mockResolvedValue(expectedUrl);
const connectorId = 'test-connector-id';
const { result, waitForNextUpdate } = renderHook(() => useManagementLink(connectorId));
await waitForNextUpdate();
expect(result.current).toBe(expectedUrl);
expect(mockGetUrl).toHaveBeenCalledWith({
sectionId: 'insightsAndAlerting',
appId: 'triggersActionsConnectors/connectors/test-connector-id',
const { result } = renderHook(() => useManagementLink(connectorId));
await waitFor(() => {
expect(result.current).toBe(expectedUrl);
expect(mockGetUrl).toHaveBeenCalledWith({
sectionId: 'insightsAndAlerting',
appId: 'triggersActionsConnectors/connectors/test-connector-id',
});
});
});

2
x-pack/plugins/search_playground/public/hooks/use_query_indices.test.ts
View file

@ -5,7 +5,7 @@
* 2.0.
*/
import { renderHook } from '@testing-library/react-hooks';
import { renderHook } from '@testing-library/react';
import { useQueryIndices } from './use_query_indices';
jest.mock('./use_kibana', () => ({

2
x-pack/plugins/search_playground/public/hooks/use_source_indices_fields.test.tsx
View file

@ -5,7 +5,7 @@
* 2.0.
*/
import { renderHook, act } from '@testing-library/react-hooks';
import { renderHook, act } from '@testing-library/react';
import { useUsageTracker } from './use_usage_tracker';
import { useController } from 'react-hook-form';
import { useIndicesFields } from './use_indices_fields';

2
x-pack/plugins/search_playground/public/hooks/use_usage_tracker.test.ts
View file

@ -5,7 +5,7 @@
* 2.0.
*/
import { renderHook } from '@testing-library/react-hooks';
import { renderHook } from '@testing-library/react';
import { useKibana } from './use_kibana';
import { useUsageTracker } from './use_usage_tracker';