cypress-voice-plugin 1.0.0 → 1.0.1

package/index.js

@@ -15,7 +15,14 @@ if (
     addStyles();
   });
 
-  Cypress.on("test:after:run", (config, test) => {
+  // Used when user navigates away from current spec within the test runner
+  // Stops the voice from continuing
+  Cypress.on("window:unload", () => {
+    const voice = window.speechSynthesis;
+    voice.cancel();
+  });
+
+  Cypress.on("test:after:run", (_, test) => {
     // Additional context of test index
     // To account for loops where there is one test per describe and suite names may stay
     // And to account for both specs with multiple suites or only one suite
@@ -26,16 +33,6 @@ if (
 
     // Checking the current test index is either equal to the last index of the suite or the test context
     const currentTestIsLast = lastTestIndex === testNumber;
-
-    // Checks within the document for a failure state
-    const failed = window.top?.document.querySelector(".runnable-failed");
-    // Checks within the document for a retried state to determine if retry occurred
-    const retried = window.top?.document.querySelector(".runnable-retried");
-    // Checks within the document for a passed state
-    const passed = window.top?.document.querySelector(".runnable-passed");
-    // Checks within the document for a skipped state
-    const skipped = window.top?.document.querySelector(".runnable-pending");
-
     // Rate toggle for speed of spoken text
     const rate = window.top?.document.querySelector("#rate");
 
@@ -45,18 +42,26 @@ if (
     // Volume toggle for volume of spoken text
     const volume = window.top?.document.querySelector("#volume");
 
-    const failedTests = window.top?.document.querySelectorAll(
-      ".test.runnable-failed"
-    ).length;
-    const retriedTests = window.top?.document.querySelectorAll(
-      ".test.runnable-passed.runnable-retried"
-    ).length;
-    const passedTests = window.top?.document.querySelectorAll(
-      ".test.runnable-passed"
-    ).length;
-    const skippedTests = window.top?.document.querySelectorAll(
-      ".test.runnable-pending"
-    ).length;
+    // Logic involved with waiting for the restart button to appear
+    // This signals the Cypress Test Runner has completed it's current run
+    function waitForElement(selector, callback) {
+      const observer = new MutationObserver((mutations, observer) => {
+        const element = window.top?.document.querySelector(selector);
+        if (element) {
+          observer.disconnect();
+          callback(element);
+        }
+      });
+
+      observer.observe(window.top?.document.body, {
+        childList: true,
+        subtree: true,
+      });
+    }
+    // Checks within the document for a failure state
+    const failed = window.top?.document.querySelector(".runnable-failed");
+    // Checks within the document for a retried state to determine if retry occurred
+    const retried = window.top?.document.querySelector(".runnable-retried");
 
     // Check test result count for passed, failed, skipped, retried
     // If count is 1, use singular
@@ -69,7 +74,7 @@ if (
     // Only return seconds if minutes are less than or equal to 0
     function specTime() {
       const specTime = window.top?.document.querySelector(
-        '[data-cy="spec-duration"]'
+        '[data-cy="spec-duration"]',
       )?.textContent;
       const specSec = specTime?.slice(-2);
       const specMin = specTime?.slice(0, 2);
@@ -137,33 +142,42 @@ if (
       }
     }
 
-    // Checking if retries are set in config
-    // If so, check the config object for the current retry number, the configured number of retries, and if current test failed
-    // If return true, do not allow the voice to activate
-    function checkRetry() {
-      if (
-        config.retries > 0 &&
-        config.retries !== config.currentRetry &&
-        config.state === "failed"
-      ) {
-        return true;
+    // Retrieve count of passed, failed, retried, and skipped tests
+    function retrieveTestStats() {
+      let failedTests = window.top?.document
+        .querySelector(".failed")
+        .innerText.replace("Failed:\n", "");
+
+      const retriedTests = window.top?.document.querySelectorAll(
+        ".test.runnable-passed.runnable-retried",
+      ).length;
+
+      let passedTests = window.top?.document
+        .querySelector(".passed")
+        .innerText.replace("Passed:\n", "");
+
+      let skippedTests = window.top?.document
+        .querySelector(".pending")
+        .innerText.replace("Pending:\n", "");
+
+      if (passedTests === "--") {
+        passedTests = 0;
       } else {
-        return false;
+        passedTests = parseInt(passedTests);
       }
-    }
 
-    // Checking if all tests are skipped in spec file
-    // If so, announce that all spec tests are skipped
-    function checkSkipped() {
-      if (skipped && !failed && !passed) {
-        return true;
+      if (failedTests === "--") {
+        failedTests = 0;
       } else {
-        return false;
+        failedTests = parseInt(failedTests);
+      }
+
+      if (skippedTests === "--") {
+        skippedTests = 0;
+      } else {
+        skippedTests = parseInt(skippedTests);
       }
-    }
 
-    // Retrieve count of passed, failed, retried, and skipped tests
-    function retrieveTestStats() {
       const stats = [
         `${passedTests - retriedTests}` +
           pluralizeWord(" test", " tests", `${passedTests - retriedTests}`) +
@@ -183,102 +197,96 @@ if (
       return `${filteredStats.toString()}`;
     }
 
-    // Checking if the index of current test matches the total length of tests in the spec
-    // Checking if we are awaiting retries on final spec
-    if (currentTestIsLast && checkSkipped() === true) {
-      const message = new SpeechSynthesisUtterance(
-        "All Spec tests are skipped."
-      );
-      message.rate = rate.value;
-      message.pitch = pitch.value;
-      message.volume = volume.value;
-      speechSynthesis.speak(message);
-    }
-
-    // Before executing speechSynthesis, ensure we don't have any remaining tests to run
-    // Determine which environment variables were set and speak appropriate message
-    if (checkRetry() === false && checkSkipped() === false) {
-      // Announce spec run result and/or total time based on provided environment variable(s)
-      if (
-        Cypress.env("voiceResultType") === "simple" &&
-        !Cypress.env("voiceTime")
-      ) {
-        const message = new SpeechSynthesisUtterance(
-          `Spec ${
-            failed ? "failed." : retried ? "passed with retries." : "passed."
-          }`
-        );
-        message.rate = rate.value;
-        message.pitch = pitch.value;
-        message.volume = volume.value;
-        speechSynthesis.speak(message);
-      } else if (
-        Cypress.env("voiceTime") &&
-        !(Cypress.env("voiceResultType") === "simple") &&
-        !(Cypress.env("voiceResultType") === "detailed")
-      ) {
-        const message = new SpeechSynthesisUtterance(
-          "Total time: " + specTime()
-        );
-        message.rate = rate.value;
-        message.pitch = pitch.value;
-        message.volume = volume.value;
-        speechSynthesis.speak(message);
-      } else if (
-        Cypress.env("voiceResultType") === "detailed" &&
-        !Cypress.env("voiceTime")
-      ) {
-        const message = new SpeechSynthesisUtterance(
-          `Spec ${
-            failed
-              ? "failed: " + retrieveTestStats()
-              : retried
-              ? "passed with retries: " + retrieveTestStats()
-              : "passed: " + retrieveTestStats()
-          }`
-        );
-        message.rate = rate.value;
-        message.pitch = pitch.value;
-        message.volume = volume.value;
-        speechSynthesis.speak(message);
-      } else if (
-        Cypress.env("voiceResultType") === "simple" &&
-        Cypress.env("voiceTime")
-      ) {
-        const message = new SpeechSynthesisUtterance(
-          `Spec ${
-            failed
-              ? "failed. Total time: " + specTime()
-              : retried
-              ? "passed with retries. Total time: " + specTime()
-              : "passed. Total time: " + specTime()
-          }`
-        );
-        message.rate = rate.value;
-        message.pitch = pitch.value;
-        message.volume = volume.value;
-        speechSynthesis.speak(message);
-      } else if (
-        Cypress.env("voiceResultType") === "detailed" &&
-        Cypress.env("voiceTime")
-      ) {
-        const message = new SpeechSynthesisUtterance(
-          `Spec ${
-            failed
-              ? "failed: " + retrieveTestStats() + " Total time: " + specTime()
-              : retried
-              ? "passed with retries: " +
-                retrieveTestStats() +
-                ". Total time: " +
-                specTime()
-              : "passed: " + retrieveTestStats() + " Total time: " + specTime()
-          }`
-        );
-        message.rate = rate.value;
-        message.pitch = pitch.value;
-        message.volume = volume.value;
-        speechSynthesis.speak(message);
-      }
+    if (currentTestIsLast) {
+      waitForElement(".restart", () => {
+        // Announce spec run result and/or total time based on provided environment variable(s)
+        if (
+          Cypress.env("voiceResultType") === "simple" &&
+          !Cypress.env("voiceTime")
+        ) {
+          const message = new SpeechSynthesisUtterance(
+            `Spec ${
+              failed ? "failed." : retried ? "passed with retries." : "passed."
+            }`,
+          );
+          message.rate = rate.value;
+          message.pitch = pitch.value;
+          message.volume = volume.value;
+          speechSynthesis.speak(message);
+        } else if (
+          Cypress.env("voiceTime") &&
+          !(Cypress.env("voiceResultType") === "simple") &&
+          !(Cypress.env("voiceResultType") === "detailed")
+        ) {
+          const message = new SpeechSynthesisUtterance(
+            "Total time: " + specTime(),
+          );
+          message.rate = rate.value;
+          message.pitch = pitch.value;
+          message.volume = volume.value;
+          speechSynthesis.speak(message);
+        } else if (
+          Cypress.env("voiceResultType") === "detailed" &&
+          !Cypress.env("voiceTime")
+        ) {
+          const message = new SpeechSynthesisUtterance(
+            `Spec ${
+              failed
+                ? "failed: " + retrieveTestStats()
+                : retried
+                  ? "passed with retries: " + retrieveTestStats()
+                  : "passed: " + retrieveTestStats()
+            }`,
+          );
+          message.rate = rate.value;
+          message.pitch = pitch.value;
+          message.volume = volume.value;
+          speechSynthesis.speak(message);
+        } else if (
+          Cypress.env("voiceResultType") === "simple" &&
+          Cypress.env("voiceTime")
+        ) {
+          const message = new SpeechSynthesisUtterance(
+            `Spec ${
+              failed
+                ? "failed. Total time: " + specTime()
+                : retried
+                  ? "passed with retries. Total time: " + specTime()
+                  : "passed. Total time: " + specTime()
+            }`,
+          );
+          message.rate = rate.value;
+          message.pitch = pitch.value;
+          message.volume = volume.value;
+          speechSynthesis.speak(message);
+        } else if (
+          Cypress.env("voiceResultType") === "detailed" &&
+          Cypress.env("voiceTime")
+        ) {
+          const message = new SpeechSynthesisUtterance(
+            `Spec ${
+              failed
+                ? "failed: " +
+                  retrieveTestStats() +
+                  " Total time: " +
+                  specTime()
+                : retried
+                  ? "passed with retries: " +
+                    retrieveTestStats() +
+                    ". Total time: " +
+                    specTime()
+                  : "passed: " +
+                    retrieveTestStats() +
+                    " Total time: " +
+                    specTime()
+            }`,
+          );
+          message.rate = rate.value;
+          message.pitch = pitch.value;
+          message.volume = volume.value;
+          speechSynthesis.speak(message);
+        }
+      });
     }
   });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-voice-plugin",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Voice plugin for the Cypress Test Runner",
   "main": "./index.js",
   "scripts": {