feat: upgrade @guidepup/playwright

guidepup · Jan 20, 2024 · 9044840 · 9044840
1 parent fbc30c2
commit 9044840
Show file tree

Hide file tree

Showing 7 changed files with 121 additions and 220 deletions.
diff --git a/package.json b/package.json
@@ -32,16 +32,16 @@
     "test:report": "ts-node src/report.ts"
   },
   "dependencies": {
-    "@guidepup/guidepup": "^0.21.1",
-    "@guidepup/playwright": "^0.12.0",
-    "@playwright/test": "^1.40.1",
+    "@guidepup/guidepup": "^0.22.0",
+    "@guidepup/playwright": "^0.13.1",
+    "@playwright/test": "^1.41.1",
     "csvtojson": "^2.0.10",
     "playwright-merge-html-reports": "^0.2.8"
   },
   "devDependencies": {
-    "@types/node": "^20.10.5",
-    "@typescript-eslint/eslint-plugin": "^6.16.0",
-    "@typescript-eslint/parser": "^6.16.0",
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "ts-node": "^10.9.2",

diff --git a/src/macOsVoiceOver.spec.ts b/src/macOsVoiceOver.spec.ts
@@ -1,8 +1,6 @@
 import { platform, release } from "os";
-import { voTest as test } from "@guidepup/playwright";
-import { VoiceOver } from "@guidepup/guidepup";
-import { KeyCodes } from "@guidepup/guidepup/lib/macOS/KeyCodes";
-import { Modifiers } from "@guidepup/guidepup/lib/macOS/Modifiers";
+import { voiceOverTest as test } from "@guidepup/playwright";
+import { VoiceOver, MacOSKeyCodes, MacOSModifiers } from "@guidepup/guidepup";
 import { record } from "./record";
 import { setup } from "./setup";
 import { readTestSuitesCacheSync, TestSuite } from "./testSuites";
@@ -28,7 +26,7 @@ const mapCommand = (
   | {
       error?: undefined;
       voiceOverCommand: true;
-      mappedCommand: { keyCode: KeyCodes[]; modifiers: Modifiers[] };
+      mappedCommand: { keyCode: MacOSKeyCodes[]; modifiers: MacOSModifiers[] };
     }
   | {
       error?: undefined;
@@ -41,14 +39,14 @@ const mapCommand = (
     keys.includes("Control") && keys.includes("Options");
 
   if (isVoiceOverCommand) {
-    const keyCodes: KeyCodes[] = [];
-    const modifiers: Modifiers[] = [];
+    const keyCodes: MacOSKeyCodes[] = [];
+    const modifiers: MacOSModifiers[] = [];
 
     for (const key of keys) {
-      if (typeof Modifiers[key] !== "undefined") {
-        modifiers.push(Modifiers[key]);
-      } else if (typeof KeyCodes[key] !== "undefined") {
-        keyCodes.push(KeyCodes[key as keyof KeyCodes]);
+      if (typeof MacOSModifiers[key] !== "undefined") {
+        modifiers.push(MacOSModifiers[key]);
+      } else if (typeof MacOSKeyCodes[key] !== "undefined") {
+        keyCodes.push(MacOSKeyCodes[key as keyof MacOSKeyCodes]);
       } else {
         return { error: true };
       }
@@ -67,9 +65,9 @@ const mapCommand = (
   const modifiers: string[] = [];
 
   for (const key of keys) {
-    if (typeof Modifiers[key] !== "undefined") {
+    if (typeof MacOSModifiers[key] !== "undefined") {
       modifiers.push(key);
-    } else if (typeof KeyCodes[key] !== "undefined") {
+    } else if (typeof MacOSKeyCodes[key] !== "undefined") {
       keyCodes.push(key);
     } else {
       return { error: true };
@@ -169,11 +167,13 @@ const generateTestSuite = ({
       test.describe(screenReaderTest.title, () => {
         let stopRecording: () => string;
 
-        test.beforeEach(async ({ page, voiceOver }) => {
+        test.beforeEach(async ({ browser, browserName, page, voiceOver }) => {
           table(screenReaderTest);
 
           try {
             stopRecording = record({
+              browserName,
+              browserVersion: browser.version(),
               test,
               screenReaderName,
             });

diff --git a/src/nvdaTest.ts b/src/nvdaTest.ts
diff --git a/src/record.ts b/src/record.ts
@@ -5,9 +5,13 @@ import { join } from "path";
 import { table } from "./log";
 
 export function record({
+  browserName,
+  browserVersion,
   screenReaderName,
   test,
 }: {
+  browserName: string;
+  browserVersion: string;
   screenReaderName: string;
   test: typeof playwrightTest;
 }): () => string {
@@ -22,7 +26,7 @@ export function record({
 
   switch (platformName) {
     case "darwin": {
-      const recordingFileName = `test_${platformName}_${release()}_${screenReaderName}_${sanitizedTitle}_attempt_${retry}.mov`;
+      const recordingFileName = `test_${platformName}_${release()}_${browserName}_${browserVersion}_${screenReaderName}_${sanitizedTitle}_attempt_${retry}.mov`;
       const recordingFilePath = join("./recordings/", recordingFileName);
 
       table({ recordingFileName });
@@ -36,7 +40,7 @@ export function record({
       };
     }
     case "win32": {
-      const recordingFileName = `test_${platformName}_${release()}_${screenReaderName}_${sanitizedTitle}_attempt_${retry}.mp4`;
+      const recordingFileName = `test_${platformName}_${release()}_${browserName}_${browserVersion}_${screenReaderName}_${sanitizedTitle}_attempt_${retry}.mp4`;
       const recordingFilePath = join("./recordings/", recordingFileName);
 
       table({ recordingFileName });

diff --git a/src/setup.ts b/src/setup.ts
@@ -1,15 +1,14 @@
 import { Page } from "@playwright/test";
 import { delay } from "./delay";
-import { ScreenReader } from "@guidepup/guidepup";
 import { Test } from "./types";
 import { log } from "./log";
+import { VoiceOverPlaywright, NVDAPlaywright } from "@guidepup/playwright";
 
 const PAGE_LOAD_DELAY = 500;
 
 export async function setup({
   hasSetupScript,
   mode,
-  moveToSystemFocusCommand,
   page,
   screenReader,
   setMode,
@@ -19,13 +18,13 @@ export async function setup({
   mode: Test["mode"];
   moveToSystemFocusCommand: unknown;
   page: Page;
-  screenReader: ScreenReader;
+  screenReader: VoiceOverPlaywright | NVDAPlaywright;
   setMode: ({
     mode,
     screenReader,
   }: {
     mode: Test["mode"];
-    screenReader: ScreenReader;
+    screenReader: VoiceOverPlaywright | NVDAPlaywright;
   }) => void | Promise<void>;
   testUrl: string;
 }): Promise<void> {
@@ -34,14 +33,12 @@ export async function setup({
   await page.goto(testUrl, { waitUntil: "load" });
   await delay(PAGE_LOAD_DELAY);
 
-  await screenReader.perform(moveToSystemFocusCommand);
-  await screenReader.perform(moveToSystemFocusCommand);
-  await screenReader.perform(moveToSystemFocusCommand);
-
-  await screenReader.clearSpokenPhraseLog();
-  await screenReader.clearItemTextLog();
+  await screenReader.navigateToWebContent();
 
   if (hasSetupScript) {
+    await page.goto(testUrl, { waitUntil: "load" });
+    await delay(PAGE_LOAD_DELAY);
+
     log("Running test setup.");
 
     await screenReader.act();

diff --git a/src/windowsNvda.spec.ts b/src/windowsNvda.spec.ts
@@ -1,8 +1,6 @@
 import { platform, release } from "os";
-import { nvdaTest as test } from "./nvdaTest";
-import { NVDA } from "@guidepup/guidepup";
-import { KeyCodes } from "@guidepup/guidepup/lib/windows/KeyCodes";
-import { Modifiers } from "@guidepup/guidepup/lib/windows/Modifiers";
+import { NVDAPlaywright, nvdaTest as test } from "@guidepup/playwright";
+import { NVDA, WindowsKeyCodes, WindowsModifiers } from "@guidepup/guidepup";
 import { record } from "./record";
 import { setup } from "./setup";
 import { readTestSuitesCacheSync, TestSuite } from "./testSuites";
@@ -21,15 +19,15 @@ test.describe.configure({ mode: "parallel" });
 
 const screenReaderName = "nvda";
 
-type KeyCodesType = (typeof KeyCodes)[keyof typeof KeyCodes];
-type ModifiersType = (typeof Modifiers)[keyof typeof Modifiers];
+type KeyCodesType = (typeof WindowsKeyCodes)[keyof typeof WindowsKeyCodes];
+type ModifiersType = (typeof WindowsModifiers)[keyof typeof WindowsModifiers];
 
 const setMode = async ({
   mode,
   screenReader,
 }: {
   mode: Test["mode"];
-  screenReader: NVDA;
+  screenReader: NVDAPlaywright;
 }) => {
   if (mode === "interaction") {
     await screenReader.perform(screenReader.keyboardCommands.exitFocusMode);
@@ -55,10 +53,10 @@ const mapCommand = (
   const modifiers: ModifiersType[] = [];
 
   for (const key of keys) {
-    if (typeof Modifiers[key] !== "undefined") {
-      modifiers.push(Modifiers[key]);
-    } else if (typeof KeyCodes[key] !== "undefined") {
-      keyCodes.push(KeyCodes[key]);
+    if (typeof WindowsModifiers[key] !== "undefined") {
+      modifiers.push(WindowsModifiers[key]);
+    } else if (typeof WindowsKeyCodes[key] !== "undefined") {
+      keyCodes.push(WindowsKeyCodes[key]);
     } else {
       return { error: true };
     }
@@ -141,11 +139,13 @@ const generateTestSuite = ({
       test.describe(screenReaderTest.title, () => {
         let stopRecording: () => string;
 
-        test.beforeEach(async ({ page, nvda }) => {
+        test.beforeEach(async ({ browser, browserName, page, nvda }) => {
           table(screenReaderTest);
 
           try {
             stopRecording = record({
+              browserName,
+              browserVersion: browser.version(),
               test,
               screenReaderName,
             });