fix: 🐛 Allow to turn off logging

NoriSte · Oct 30, 2019 · 238f33b · 238f33b
1 parent 2983652
commit 238f33b
Show file tree

Hide file tree

Showing 6 changed files with 123 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -134,6 +134,7 @@ Pass in an options object to change the default behavior of `cy.waitUntil()`.
 | `interval`    | `200`                | Time to wait between the `checkFunction` invocations.                                                                                                     |
 | `description` | `waitUntil`          | The name logged into the Cypress Test Runner.                                                                                                             |
 | `logger`      | `Cypress.log`        | A custom logger in place of the default [Cypress.log](https://docs.cypress.io/api/cypress-api/cypress-log.html). It's useful just for debugging purposes. |
+| `log`         | `true`               | Enable/disable logging.                                                                                                                                   |
 
 <br />
 <br />

diff --git a/cypress/integration/plugin.spec.js b/cypress/integration/plugin.spec.js
@@ -233,4 +233,17 @@ context("Cypress Wait Until", () => {
       expect(lastCallArgs).deep.include({ name: description });
     });
   });
+
+  it("Should allow to turn off logging", () => {
+    const checkFunction = () => true;
+
+    const logger = {
+      log: (...params) => Cypress.log(...params)
+    };
+    const spy = cy.spy(logger, "log");
+
+    cy.waitUntil(checkFunction, { logger: logger.log, log: false }).then(() => {
+      expect(spy).not.to.have.been.called;
+    });
+  });
 });
diff --git a/cypress/types/plugin.spec.js b/cypress/types/plugin.spec.js
@@ -1,17 +1,97 @@
 /// <reference types="Cypress" />
-cy.waitUntil(function () { return true; });
-cy.waitUntil(function () { return false; });
-cy.waitUntil(function () { return Promise.resolve(true); });
-cy.waitUntil(function () { return Promise.resolve(false); });
-cy.waitUntil(function () { return true; }, {});
-cy.waitUntil(function () { return false; }, {});
-cy.waitUntil(function () { return Promise.resolve(true); }, {});
-cy.waitUntil(function () { return Promise.resolve(false); }, {});
-cy.waitUntil(function () { return true; }, { timeout: 500 });
-cy.waitUntil(function () { return false; }, { timeout: 500 });
-cy.waitUntil(function () { return Promise.resolve(true); }, { timeout: 500 });
-cy.waitUntil(function () { return Promise.resolve(false); }, { timeout: 500 });
-cy.waitUntil(function () { return true; }, { errorMsg: "Custom error message" });
-cy.waitUntil(function () { return false; }, { errorMsg: "Custom error message" });
-cy.waitUntil(function () { return Promise.resolve(true); }, { errorMsg: "Custom error message" });
-cy.waitUntil(function () { return Promise.resolve(false); }, { errorMsg: "Custom error message" });
+cy.waitUntil(function() {
+  return true;
+});
+cy.waitUntil(function() {
+  return false;
+});
+cy.waitUntil(function() {
+  return Promise.resolve(true);
+});
+cy.waitUntil(function() {
+  return Promise.resolve(false);
+});
+cy.waitUntil(function() {
+  return true;
+}, {});
+cy.waitUntil(function() {
+  return false;
+}, {});
+cy.waitUntil(function() {
+  return Promise.resolve(true);
+}, {});
+cy.waitUntil(function() {
+  return Promise.resolve(false);
+}, {});
+cy.waitUntil(
+  function() {
+    return true;
+  },
+  { timeout: 500 }
+);
+cy.waitUntil(
+  function() {
+    return false;
+  },
+  { timeout: 500 }
+);
+cy.waitUntil(
+  function() {
+    return Promise.resolve(true);
+  },
+  { timeout: 500 }
+);
+cy.waitUntil(
+  function() {
+    return Promise.resolve(false);
+  },
+  { timeout: 500 }
+);
+cy.waitUntil(
+  function() {
+    return true;
+  },
+  { errorMsg: "Custom error message" }
+);
+cy.waitUntil(
+  function() {
+    return false;
+  },
+  { errorMsg: "Custom error message" }
+);
+cy.waitUntil(
+  function() {
+    return Promise.resolve(true);
+  },
+  { errorMsg: "Custom error message" }
+);
+cy.waitUntil(
+  function() {
+    return Promise.resolve(false);
+  },
+  { errorMsg: "Custom error message" }
+);
+cy.waitUntil(
+  function() {
+    return true;
+  },
+  { description: "Custom description" }
+);
+cy.waitUntil(
+  function() {
+    return true;
+  },
+  {
+    logger: ({ name, message, consoleProps }) => {
+      console.log({ name, message, consoleProps });
+    }
+  }
+);
+cy.waitUntil(
+  function() {
+    return true;
+  },
+  {
+    log: false
+  }
+);
diff --git a/cypress/types/plugin.spec.ts b/cypress/types/plugin.spec.ts
@@ -27,3 +27,5 @@ cy.waitUntil(() => true, {
     console.log({ name, message, consoleProps });
   }
 });
+
+cy.waitUntil(() => true, { log: false });
diff --git a/index.d.ts b/index.d.ts
@@ -8,6 +8,7 @@ interface WaitUntilOptions {
   errorMsg?: string;
   description?: string;
   logger?: (WaitUntilLog) => any;
+  log?: boolean;
 }
 
 declare namespace Cypress {

diff --git a/src/index.js b/src/index.js
@@ -12,17 +12,20 @@ function waitUntil(subject, checkFunction, options) {
   const TIMEOUT = options.timeout || 5000;
   const ERROR_MSG = options.errorMsg || "Timed out retrying";
   const LOG_DESCRIPTION = options.description || "waitUntil";
+  const LOG = options.log === false ? false : true;
   let retries = Math.floor(TIMEOUT / TIMEOUT_INTERVAL);
 
   const logger = options.logger || Cypress.log;
 
-  logger({
-    name: LOG_DESCRIPTION,
-    message: options,
-    consoleProps: () => ({
-      options
-    })
-  });
+  if (LOG) {
+    logger({
+      name: LOG_DESCRIPTION,
+      message: options,
+      consoleProps: () => ({
+        options
+      })
+    });
+  }
 
   const check = result => {
     if (result) {