feat: updating exported methods to be async

Updating many things to be async after userEvent 14 announced all its exported methods would be marked async BREAKING CHANGE: All exported methods now return Promises
Grunet · Jan 27, 2022 · 3bc117c · 3bc117c
1 parent e7d6b3a
commit 3bc117c
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 70 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -57,8 +57,8 @@
   },
   "homepage": "https://github.com/Grunet/keyboard-testing-library#readme",
   "peerDependencies": {
-    "@testing-library/dom": "7.x",
-    "@testing-library/user-event": "13.x"
+    "@testing-library/dom": "^7.x",
+    "@testing-library/user-event": "^14.x"
   },
   "peerDependenciesMeta": {
     "@testing-library/dom": {
@@ -70,7 +70,7 @@
   },
   "devDependencies": {
     "@testing-library/dom": "^7.30.3",
-    "@testing-library/user-event": "^13.1.1",
+    "@testing-library/user-event": "14.0.0-beta.8",
     "@typescript-eslint/eslint-plugin": "^4.15.0",
     "@typescript-eslint/parser": "^4.15.0",
     "commitizen": "^4.2.3",
@@ -90,7 +90,7 @@
     "semantic-release": "^17.3.9",
     "ts-jest": "^26.5.1",
     "ts-node": "^9.1.1",
-    "typescript": "^4.1.5"
+    "typescript": "^4.5.5"
   },
   "config": {
     "commitizen": {

diff --git a/src/index.ts b/src/index.ts
@@ -51,28 +51,28 @@ function __createKeyboardOnlyUserEvent() {
         }
       }
     },
-    navigateTo(element: Element) {
-      __navigateToAndThrowIfNotFound(element, navigationActions, logger);
+    async navigateTo(element: Element) {
+      await __navigateToAndThrowIfNotFound(element, navigationActions, logger);
     },
-    navigateToAndPressEnter(element: Element) {
-      __navigateToAndThrowIfNotFound(element, navigationActions, logger);
+    async navigateToAndPressEnter(element: Element) {
+      await __navigateToAndThrowIfNotFound(element, navigationActions, logger);
 
-      activationActions.enter(element);
+      await activationActions.enter(element);
     },
-    navigateToAndPressSpacebar(element: Element) {
-      __navigateToAndThrowIfNotFound(element, navigationActions, logger);
+    async navigateToAndPressSpacebar(element: Element) {
+      await __navigateToAndThrowIfNotFound(element, navigationActions, logger);
 
-      activationActions.spacebar(element);
+      await activationActions.spacebar(element);
     },
   };
 }
 
-function __navigateToAndThrowIfNotFound(
+async function __navigateToAndThrowIfNotFound(
   element: Element,
   navigationActions: INavigationActions,
   logger: ILogger
 ) {
-  const foundElement = navigateTo(element, navigationActions, logger);
+  const foundElement = await navigateTo(element, navigationActions, logger);
 
   if (!foundElement) {
     throw new Error(
@@ -130,17 +130,17 @@ const testingLibShims: IKeyboardActions = {
   navigation: {
     tab:
       userEvent &&
-      (() => {
-        userEvent.tab();
+      (async () => {
+        await userEvent.tab();
       }),
     shiftTab:
       userEvent &&
-      (() => {
-        userEvent.tab({ shift: true });
+      (async () => {
+        await userEvent.tab({ shift: true });
       }),
     arrowUp:
       fireEvent &&
-      ((element) => {
+      (async (element) => {
         fireEvent.keyDown(element, {
           key: "ArrowUp",
           code: "ArrowUp",
@@ -149,7 +149,7 @@ const testingLibShims: IKeyboardActions = {
       }),
     arrowRight:
       fireEvent &&
-      ((element) => {
+      (async (element) => {
         fireEvent.keyDown(element, {
           key: "ArrowRight",
           code: "ArrowRight",
@@ -158,7 +158,7 @@ const testingLibShims: IKeyboardActions = {
       }),
     arrowDown:
       fireEvent &&
-      ((element) => {
+      (async (element) => {
         fireEvent.keyDown(element, {
           key: "ArrowDown",
           code: "ArrowDown",
@@ -167,7 +167,7 @@ const testingLibShims: IKeyboardActions = {
       }),
     arrowLeft:
       fireEvent &&
-      ((element) => {
+      (async (element) => {
         fireEvent.keyDown(element, {
           key: "ArrowLeft",
           code: "ArrowLeft",
@@ -178,7 +178,7 @@ const testingLibShims: IKeyboardActions = {
   activation: {
     enter:
       fireEvent &&
-      ((element) => {
+      (async (element) => {
         fireEvent.keyDown(element, {
           key: "Enter",
           code: "Enter",
@@ -187,7 +187,7 @@ const testingLibShims: IKeyboardActions = {
       }),
     spacebar:
       fireEvent &&
-      ((element) => {
+      (async (element) => {
         fireEvent.keyDown(element, {
           key: " ",
           code: "Space",

diff --git a/src/navigateTo.ts b/src/navigateTo.ts
@@ -4,12 +4,12 @@ import {
   ILogger,
 } from "./shared/interfaces";
 
-function navigateTo(
+async function navigateTo(
   element: Element,
   navigationActions: INavigationActions,
   logger: ILogger
-): boolean {
-  const foundElement = findTarget(
+): Promise<boolean> {
+  const foundElement = await findTarget(
     element,
     new KeyboardNavigationGraphAdapter(),
     navigationActions,
@@ -19,12 +19,12 @@ function navigateTo(
   return foundElement;
 }
 
-function findTarget(
+async function findTarget(
   targetEl: Element,
   kngService: KeyboardNavigationGraphAdapter,
   navigationActions: INavigationActions,
   logger: ILogger
-): boolean {
+): Promise<boolean> {
   let curEl = getCurrentlyFocusedEl();
   /*eslint no-constant-condition: ["error", { "checkLoops": false }] -- to allow for the infinite while loop */
   while (true) {
@@ -39,7 +39,7 @@ function findTarget(
     }
     logger?.capturePath(unexploredPath);
 
-    const newCurEl = followPath(
+    const newCurEl = await followPath(
       curEl,
       unexploredPath,
       kngService,
@@ -51,12 +51,12 @@ function findTarget(
   }
 }
 
-function followPath(
+async function followPath(
   startEl: Element,
   pathOfActions: Array<keyof INavigationActions>,
   kngService: KeyboardNavigationGraphAdapter,
   navigationActions: INavigationActions
-): Element {
+): Promise<Element> {
   const elsOnPath: Array<Element> = [startEl];
   const remainingPath = [...pathOfActions];
 
@@ -65,7 +65,7 @@ function followPath(
 
     const navActionToPerform = navigationActions[nextAction];
 
-    navActionToPerform(elsOnPath[0]);
+    await navActionToPerform(elsOnPath[0]);
     const nextEl = getCurrentlyFocusedEl();
 
     elsOnPath.unshift(nextEl);

diff --git a/src/shared/interfaces.ts b/src/shared/interfaces.ts
@@ -4,12 +4,12 @@ interface IKeyboardActions {
 }
 
 interface INavigationActions {
-  tab: () => void;
-  shiftTab: () => void;
-  arrowUp: (element: Element) => void;
-  arrowRight: (element: Element) => void;
-  arrowDown: (element: Element) => void;
-  arrowLeft: (element: Element) => void;
+  tab: () => Promise<void>;
+  shiftTab: () => Promise<void>;
+  arrowUp: (element: Element) => Promise<void>;
+  arrowRight: (element: Element) => Promise<void>;
+  arrowDown: (element: Element) => Promise<void>;
+  arrowLeft: (element: Element) => Promise<void>;
 }
 
 /* Hack to export an iterable list of the interface's property names */
@@ -39,8 +39,8 @@ const unused1: areDuplicateNavigationActionNamesTheSame = true; //Should cause a
 /* End hack */
 
 interface IActivationActions {
-  enter: (element: Element) => void;
-  spacebar: (element: Element) => void;
+  enter: (element: Element) => Promise<void>;
+  spacebar: (element: Element) => Promise<void>;
 }
 
 /* Hack to export an iterable list of the interface's property names */