From 7bb153efe97e91a67a9fe0d2ded240849e7f010f Mon Sep 17 00:00:00 2001
From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Date: Fri, 22 Nov 2024 05:33:32 +1100
Subject: [PATCH] [8.x] [React18] Migrate test suites to account for testing
 library upgrades appex-sharedux (#201153) (#201237)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[React18] Migrate test suites to account for testing library upgrades
appex-sharedux (#201153)](https://github.com/elastic/kibana/pull/201153)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Eyo O.
Eyo","email":"7893459+eokoneyo@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-11-21T16:32:49Z","message":"[React18]
Migrate test suites to account for testing library upgrades
appex-sharedux (#201153)\n\nThis PR migrates test suites that use
`renderHook` from the library\r\n`@testing-library/react-hooks` to adopt
the equivalent and replacement\r\nof `renderHook` from the export that
is now available from\r\n`@testing-library/react`. This work is required
for the planned\r\nmigration to react18.\r\n\r\n## Context\r\n\r\nIn
this PR, usages of `waitForNextUpdate` that previously could
have\r\nbeen destructured from `renderHook` are now been replaced with
`waitFor`\r\nexported from `@testing-library/react`, furthermore
`waitFor`\r\nthat would also have been destructured from the same
renderHook result\r\nis now been replaced with `waitFor` from the export
of\r\n`@testing-library/react`.\r\n\r\n***Why is `waitFor` a sufficient
enough replacement for\r\n`waitForNextUpdate`, and better for testing
values subject to async\r\ncomputations?***\r\n\r\nWaitFor will retry
the provided callback if an error is returned, till\r\nthe configured
timeout elapses. By default the retry interval is `50ms`\r\nwith a
timeout value of `1000ms` that\r\neffectively translates to at least 20
retries for assertions placed\r\nwithin waitFor.
See\r\nhttps://testing-library.com/docs/dom-testing-library/api-async/#waitfor\r\nfor
more information.\r\nThis however means that for person's writing tests,
said person has to\r\nbe explicit about expectations that describe the
internal state of the\r\nhook being tested.\r\nThis implies checking for
instance when a react query hook is being\r\nrendered, there's an
assertion that said hook isn't loading anymore.\r\n\r\nIn this PR you'd
notice that this pattern has been adopted, with most\r\nexisting
assertions following an invocation of `waitForNextUpdate`
being\r\nplaced within a `waitFor`\r\ninvocation. In some cases the
replacement is simply a `waitFor(() => new\r\nPromise((resolve) =>
resolve(null)))` (many thanks to @kapral18, for\r\npoint out exactly why
this works),\r\nwhere this suffices the assertions that follow aren't
placed within a\r\nwaitFor so this PR doesn't get larger than it needs
to be.\r\n\r\nIt's also worth pointing out this PR might also contain
changes to test\r\nand application code to improve said existing
test.\r\n\r\n### What to do next?\r\n1. Review the changes in this
PR.\r\n2. If you think the changes are correct, approve the
PR.\r\n\r\n## Any questions?\r\nIf you have any questions or need help
with this PR, please leave\r\ncomments in this
PR.","sha":"8b1c0f70cbe3d5e18a30523b010170179f8bd4b5","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:SharedUX","backport:prev-minor","React@18"],"title":"[React18]
Migrate test suites to account for testing library upgrades
appex-sharedux","number":201153,"url":"https://github.com/elastic/kibana/pull/201153","mergeCommit":{"message":"[React18]
Migrate test suites to account for testing library upgrades
appex-sharedux (#201153)\n\nThis PR migrates test suites that use
`renderHook` from the library\r\n`@testing-library/react-hooks` to adopt
the equivalent and replacement\r\nof `renderHook` from the export that
is now available from\r\n`@testing-library/react`. This work is required
for the planned\r\nmigration to react18.\r\n\r\n## Context\r\n\r\nIn
this PR, usages of `waitForNextUpdate` that previously could
have\r\nbeen destructured from `renderHook` are now been replaced with
`waitFor`\r\nexported from `@testing-library/react`, furthermore
`waitFor`\r\nthat would also have been destructured from the same
renderHook result\r\nis now been replaced with `waitFor` from the export
of\r\n`@testing-library/react`.\r\n\r\n***Why is `waitFor` a sufficient
enough replacement for\r\n`waitForNextUpdate`, and better for testing
values subject to async\r\ncomputations?***\r\n\r\nWaitFor will retry
the provided callback if an error is returned, till\r\nthe configured
timeout elapses. By default the retry interval is `50ms`\r\nwith a
timeout value of `1000ms` that\r\neffectively translates to at least 20
retries for assertions placed\r\nwithin waitFor.
See\r\nhttps://testing-library.com/docs/dom-testing-library/api-async/#waitfor\r\nfor
more information.\r\nThis however means that for person's writing tests,
said person has to\r\nbe explicit about expectations that describe the
internal state of the\r\nhook being tested.\r\nThis implies checking for
instance when a react query hook is being\r\nrendered, there's an
assertion that said hook isn't loading anymore.\r\n\r\nIn this PR you'd
notice that this pattern has been adopted, with most\r\nexisting
assertions following an invocation of `waitForNextUpdate`
being\r\nplaced within a `waitFor`\r\ninvocation. In some cases the
replacement is simply a `waitFor(() => new\r\nPromise((resolve) =>
resolve(null)))` (many thanks to @kapral18, for\r\npoint out exactly why
this works),\r\nwhere this suffices the assertions that follow aren't
placed within a\r\nwaitFor so this PR doesn't get larger than it needs
to be.\r\n\r\nIt's also worth pointing out this PR might also contain
changes to test\r\nand application code to improve said existing
test.\r\n\r\n### What to do next?\r\n1. Review the changes in this
PR.\r\n2. If you think the changes are correct, approve the
PR.\r\n\r\n## Any questions?\r\nIf you have any questions or need help
with this PR, please leave\r\ncomments in this
PR.","sha":"8b1c0f70cbe3d5e18a30523b010170179f8bd4b5"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/201153","number":201153,"mergeCommit":{"message":"[React18]
Migrate test suites to account for testing library upgrades
appex-sharedux (#201153)\n\nThis PR migrates test suites that use
`renderHook` from the library\r\n`@testing-library/react-hooks` to adopt
the equivalent and replacement\r\nof `renderHook` from the export that
is now available from\r\n`@testing-library/react`. This work is required
for the planned\r\nmigration to react18.\r\n\r\n## Context\r\n\r\nIn
this PR, usages of `waitForNextUpdate` that previously could
have\r\nbeen destructured from `renderHook` are now been replaced with
`waitFor`\r\nexported from `@testing-library/react`, furthermore
`waitFor`\r\nthat would also have been destructured from the same
renderHook result\r\nis now been replaced with `waitFor` from the export
of\r\n`@testing-library/react`.\r\n\r\n***Why is `waitFor` a sufficient
enough replacement for\r\n`waitForNextUpdate`, and better for testing
values subject to async\r\ncomputations?***\r\n\r\nWaitFor will retry
the provided callback if an error is returned, till\r\nthe configured
timeout elapses. By default the retry interval is `50ms`\r\nwith a
timeout value of `1000ms` that\r\neffectively translates to at least 20
retries for assertions placed\r\nwithin waitFor.
See\r\nhttps://testing-library.com/docs/dom-testing-library/api-async/#waitfor\r\nfor
more information.\r\nThis however means that for person's writing tests,
said person has to\r\nbe explicit about expectations that describe the
internal state of the\r\nhook being tested.\r\nThis implies checking for
instance when a react query hook is being\r\nrendered, there's an
assertion that said hook isn't loading anymore.\r\n\r\nIn this PR you'd
notice that this pattern has been adopted, with most\r\nexisting
assertions following an invocation of `waitForNextUpdate`
being\r\nplaced within a `waitFor`\r\ninvocation. In some cases the
replacement is simply a `waitFor(() => new\r\nPromise((resolve) =>
resolve(null)))` (many thanks to @kapral18, for\r\npoint out exactly why
this works),\r\nwhere this suffices the assertions that follow aren't
placed within a\r\nwaitFor so this PR doesn't get larger than it needs
to be.\r\n\r\nIt's also worth pointing out this PR might also contain
changes to test\r\nand application code to improve said existing
test.\r\n\r\n### What to do next?\r\n1. Review the changes in this
PR.\r\n2. If you think the changes are correct, approve the
PR.\r\n\r\n## Any questions?\r\nIf you have any questions or need help
with this PR, please leave\r\ncomments in this
PR.","sha":"8b1c0f70cbe3d5e18a30523b010170179f8bd4b5"}}]}] BACKPORT-->

Co-authored-by: Eyo O. Eyo <7893459+eokoneyo@users.noreply.github.com>
---
 .../modal/tabbed/src/context/index.test.tsx   |  2 +-
 .../src/use_table_persist.test.ts             |  2 +-
 .../content_client_mutation_hooks.test.tsx    | 20 +++++++------------
 .../content_client_query_hooks.test.tsx       | 12 +++++------
 4 files changed, 14 insertions(+), 22 deletions(-)

diff --git a/packages/shared-ux/modal/tabbed/src/context/index.test.tsx b/packages/shared-ux/modal/tabbed/src/context/index.test.tsx
index a25504421b330..8c42dea9080c2 100644
--- a/packages/shared-ux/modal/tabbed/src/context/index.test.tsx
+++ b/packages/shared-ux/modal/tabbed/src/context/index.test.tsx
@@ -8,7 +8,7 @@
  */
 
 import React, { type ComponentProps, type ComponentType } from 'react';
-import { renderHook, act } from '@testing-library/react-hooks';
+import { renderHook, act } from '@testing-library/react';
 import { useModalContext, ModalContextProvider } from '.';
 
 type ModalContextProviderProps = ComponentProps<typeof ModalContextProvider>;
diff --git a/packages/shared-ux/table_persist/src/use_table_persist.test.ts b/packages/shared-ux/table_persist/src/use_table_persist.test.ts
index 51fbd93f7a214..9c88c97b8244a 100644
--- a/packages/shared-ux/table_persist/src/use_table_persist.test.ts
+++ b/packages/shared-ux/table_persist/src/use_table_persist.test.ts
@@ -8,7 +8,7 @@
  */
 
 import { CriteriaWithPagination } from '@elastic/eui';
-import { renderHook, act } from '@testing-library/react-hooks';
+import { renderHook, act } from '@testing-library/react';
 import { useEuiTablePersist } from './use_table_persist';
 import { createStorage } from './storage'; // Mock this if it's external
 
diff --git a/src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx b/src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx
index d2ad215f46e4c..6e77a6c9c47da 100644
--- a/src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx
+++ b/src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx
@@ -8,7 +8,7 @@
  */
 
 import React, { FC, PropsWithChildren } from 'react';
-import { renderHook } from '@testing-library/react-hooks';
+import { renderHook, waitFor } from '@testing-library/react';
 import { ContentClientProvider } from './content_client_context';
 import { ContentClient } from './content_client';
 import { createCrudClientMock } from '../crud_client/crud_client.mock';
@@ -46,12 +46,10 @@ describe('useCreateContentMutation', () => {
     const input: CreateIn = { contentTypeId: 'testType', data: { foo: 'bar' }, version: 2 };
     const output = { test: 'test' };
     crudClient.create.mockResolvedValueOnce(output);
-    const { result, waitFor } = renderHook(() => useCreateContentMutation(), { wrapper: Wrapper });
+    const { result } = renderHook(() => useCreateContentMutation(), { wrapper: Wrapper });
     result.current.mutate(input);
 
-    await waitFor(() => result.current.isSuccess);
-
-    expect(result.current.data).toEqual(output);
+    await waitFor(() => expect(result.current.data).toEqual(output));
   });
 });
 
@@ -66,12 +64,10 @@ describe('useUpdateContentMutation', () => {
     };
     const output = { test: 'test' };
     crudClient.update.mockResolvedValueOnce(output);
-    const { result, waitFor } = renderHook(() => useUpdateContentMutation(), { wrapper: Wrapper });
+    const { result } = renderHook(() => useUpdateContentMutation(), { wrapper: Wrapper });
     result.current.mutate(input);
 
-    await waitFor(() => result.current.isSuccess);
-
-    expect(result.current.data).toEqual(output);
+    await waitFor(() => expect(result.current.data).toEqual(output));
   });
 });
 
@@ -81,11 +77,9 @@ describe('useDeleteContentMutation', () => {
     const input: DeleteIn = { contentTypeId: 'testType', id: 'test', version: 2 };
     const output = { test: 'test' };
     crudClient.delete.mockResolvedValueOnce(output);
-    const { result, waitFor } = renderHook(() => useDeleteContentMutation(), { wrapper: Wrapper });
+    const { result } = renderHook(() => useDeleteContentMutation(), { wrapper: Wrapper });
     result.current.mutate(input);
 
-    await waitFor(() => result.current.isSuccess);
-
-    expect(result.current.data).toEqual(output);
+    await waitFor(() => expect(result.current.data).toEqual(output));
   });
 });
diff --git a/src/plugins/content_management/public/content_client/content_client_query_hooks.test.tsx b/src/plugins/content_management/public/content_client/content_client_query_hooks.test.tsx
index 8cffde7ebd051..266e94641936e 100644
--- a/src/plugins/content_management/public/content_client/content_client_query_hooks.test.tsx
+++ b/src/plugins/content_management/public/content_client/content_client_query_hooks.test.tsx
@@ -8,7 +8,7 @@
  */
 
 import React, { FC, PropsWithChildren } from 'react';
-import { renderHook } from '@testing-library/react-hooks';
+import { renderHook, waitFor } from '@testing-library/react';
 import { ContentClientProvider } from './content_client_context';
 import { ContentClient } from './content_client';
 import { createCrudClientMock } from '../crud_client/crud_client.mock';
@@ -42,9 +42,8 @@ describe('useGetContentQuery', () => {
     const input: GetIn = { id: 'test', contentTypeId: 'testType', version: 2 };
     const output = { test: 'test' };
     crudClient.get.mockResolvedValueOnce(output);
-    const { result, waitFor } = renderHook(() => useGetContentQuery(input), { wrapper: Wrapper });
-    await waitFor(() => result.current.isSuccess);
-    expect(result.current.data).toEqual(output);
+    const { result } = renderHook(() => useGetContentQuery(input), { wrapper: Wrapper });
+    await waitFor(() => expect(result.current.data).toEqual(output));
   });
 });
 
@@ -54,10 +53,9 @@ describe('useSearchContentQuery', () => {
     const input: SearchIn = { contentTypeId: 'testType', query: {}, version: 2 };
     const output = { hits: [{ id: 'test' }] };
     crudClient.search.mockResolvedValueOnce(output);
-    const { result, waitFor } = renderHook(() => useSearchContentQuery(input), {
+    const { result } = renderHook(() => useSearchContentQuery(input), {
       wrapper: Wrapper,
     });
-    await waitFor(() => result.current.isSuccess);
-    expect(result.current.data).toEqual(output);
+    await waitFor(() => expect(result.current.data).toEqual(output));
   });
 });