From 419054c97a98bcb93097c8c5585d483f69e7542e Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 28 Oct 2021 10:50:35 +0200 Subject: [PATCH 1/3] Remove usage of deprecated Keyboard class Signed-off-by: Johan Haals --- .../HeaderActionMenu/HeaderActionMenu.test.tsx | 18 ++++++------------ packages/test-utils/src/testUtils/Keyboard.js | 2 +- 2 files changed, 7 insertions(+), 13 deletions(-) diff --git a/packages/core-components/src/layout/HeaderActionMenu/HeaderActionMenu.test.tsx b/packages/core-components/src/layout/HeaderActionMenu/HeaderActionMenu.test.tsx index b1bd398d15..58785c5c90 100644 --- a/packages/core-components/src/layout/HeaderActionMenu/HeaderActionMenu.test.tsx +++ b/packages/core-components/src/layout/HeaderActionMenu/HeaderActionMenu.test.tsx @@ -15,13 +15,10 @@ */ import React from 'react'; -import { render, fireEvent } from '@testing-library/react'; -import { - wrapInTestApp, - Keyboard, - renderInTestApp, -} from '@backstage/test-utils'; +import { fireEvent } from '@testing-library/react'; +import { renderInTestApp } from '@backstage/test-utils'; import { HeaderActionMenu } from './HeaderActionMenu'; +import userEvent from '@testing-library/user-event'; describe('', () => { it('renders without any items and without exploding', async () => { @@ -89,16 +86,13 @@ describe('', () => { }); it('should close when hitting escape', async () => { - const rendered = render( - wrapInTestApp( - , - ), + const rendered = await renderInTestApp( + , ); - expect(rendered.container.getAttribute('aria-hidden')).toBeNull(); fireEvent.click(rendered.getByTestId('header-action-menu')); expect(rendered.container.getAttribute('aria-hidden')).toBe('true'); - await Keyboard.type(rendered, ''); + userEvent.type(rendered.getByTestId('header-action-menu'), '{esc}'); expect(rendered.container.getAttribute('aria-hidden')).toBeNull(); }); }); diff --git a/packages/test-utils/src/testUtils/Keyboard.js b/packages/test-utils/src/testUtils/Keyboard.js index 3f4724d562..0d46d26363 100644 --- a/packages/test-utils/src/testUtils/Keyboard.js +++ b/packages/test-utils/src/testUtils/Keyboard.js @@ -25,7 +25,7 @@ const codes = { /** * @public - * @deprecated because it has no usages. Perhaps resurfaced in the future when need be. + * @deprecated superseded by @testing-library/user-event */ export class Keyboard { static async type(target, input) { From f808392183bbe32adf2c61fa4dba8ba85c4e8f8a Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 28 Oct 2021 13:38:41 +0200 Subject: [PATCH 2/3] reference library function Signed-off-by: Johan Haals --- packages/test-utils/src/testUtils/Keyboard.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/test-utils/src/testUtils/Keyboard.js b/packages/test-utils/src/testUtils/Keyboard.js index 0d46d26363..2a7928f8cd 100644 --- a/packages/test-utils/src/testUtils/Keyboard.js +++ b/packages/test-utils/src/testUtils/Keyboard.js @@ -25,7 +25,7 @@ const codes = { /** * @public - * @deprecated superseded by @testing-library/user-event + * @deprecated superseded by {@link @testing-library/user-event#userEvent} */ export class Keyboard { static async type(target, input) { From 71fd5cd735fe79a3182ae9de4a8b6f2f33918804 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 28 Oct 2021 14:58:08 +0200 Subject: [PATCH 3/3] add changeset Signed-off-by: Johan Haals --- .changeset/loud-bats-flow.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/loud-bats-flow.md diff --git a/.changeset/loud-bats-flow.md b/.changeset/loud-bats-flow.md new file mode 100644 index 0000000000..af4837dbbe --- /dev/null +++ b/.changeset/loud-bats-flow.md @@ -0,0 +1,5 @@ +--- +'@backstage/test-utils': patch +--- + +Update Keyboard deprecation with a link to the recommended successor