feat: Add user's log option to cy.tick (#15586)

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

Author: saturninoabril

cli/types/cypress.d.ts

@@ -1872,7 +1872,7 @@ declare namespace Cypress {
      *  // or use this shortcut
      *  cy.tick(5000).invoke('restore')
      */
-    tick(milliseconds: number): Chainable<Clock>
+    tick(milliseconds: number, options?: Partial<Loggable>): Chainable<Clock>
 
     /**
      * Get the `document.title` property of the page that is currently active.

packages/driver/cypress/integration/commands/clock_spec.js

@@ -461,6 +461,15 @@ describe('src/cy/commands/clock', () => {
           expect(log.get('snapshots')[1].name).to.equal('after')
         })
       })
+
+      it('does not emit when {log: false}', () => {
+        cy
+        .clock()
+        .tick(10, { log: false })
+        .then(function () {
+          expect(this.logs[0]).to.be.undefined
+        })
+      })
     })
   })
 })

packages/driver/src/cy/commands/clock.js

@@ -97,7 +97,7 @@ module.exports = function (Commands, Cypress, cy, state) {
 
       const { tick } = clock
 
-      clock.tick = function (ms) {
+      clock.tick = function (ms, options = {}) {
         if ((ms != null) && !_.isNumber(ms)) {
           $errUtils.throwErrByPath('tick.invalid_argument', { args: { arg: JSON.stringify(ms) } })
         }
@@ -106,10 +106,14 @@ module.exports = function (Commands, Cypress, cy, state) {
           ms = 0
         }
 
-        const theLog = log('tick', `${ms}ms`, false, {
-          'Now': clock.details().now + ms,
-          'Ticked': `${ms} milliseconds`,
-        })
+        let theLog
+
+        if (options.log !== false) {
+          theLog = log('tick', `${ms}ms`, false, {
+            'Now': clock.details().now + ms,
+            'Ticked': `${ms} milliseconds`,
+          })
+        }
 
         if (theLog) {
           theLog.snapshot('before', { next: 'after' })
@@ -151,12 +155,12 @@ module.exports = function (Commands, Cypress, cy, state) {
       return clock
     },
 
-    tick (subject, ms) {
+    tick (subject, ms, options = {}) {
       if (!clock) {
         $errUtils.throwErrByPath('tick.no_clock')
       }
 
-      clock.tick(ms)
+      clock.tick(ms, options)
 
       return clock
     },