wrap().invoke().should() ignores timeout options in should assertion

When a function wrapped inside a wrap gets invoked by a invoke, the should seems to ignore the timeout passed along in the wrap object.

Test code:

const slow = () => new Cypress.Promise(resolve => {
  setTimeout(() => resolve('done'), 2000);
});

cy
  .wrap({ slow }, { timeout: 100 })
  .invoke('slow')
  .should('eq', 'done');

This test is a silly example, in reality I’m querying the Mandrill API, which I want to give a very big timeout as Mandrill can take quite a while to show an email, but I do not want to update the defaultCommandTimeout to minutes as other assertions will never take this long.

Additional Info (images, stack traces, etc)

[peterklijn]

@jennifer-shehane is there an update on this issue? It is still present in version 3.1.0.

@mitchkm you can do something like this, it’s horrible but it works:

let defaultTimeout;

before(() => {
  // Store default timeout
  defaultTimeout = Cypress.config('defaultCommandTimeout');
});

beforeEach(() => {
  // Set the timeout to something high
  Cypress.config('defaultCommandTimeout', 5 * 60 * 1000); // 5 minutes
});

it('long test', () => {
  const slow = () => new Cypress.Promise(resolve => {
    setTimeout(() => resolve('done'), 2 * 60 * 1000);
  });
  
  cy
    .wrap({ slow })
    .invoke('slow')
    .should('eq', 'done')
    // Change the timeout back to the default so it doesn't effect other tests.
    .then(() => Cypress.config('defaultCommandTimeout', defaultTimeout));
});

[donleqt]

Here is the solution and example:

/**
 *  helper function that forces cy to wait for a promise
 *
 * @export
 * @param {Promise} promise promise to wait
 * @param {number} [interval=1000] recheck in minlisecons
 * @returns
 */
export function waitPromise(promise, interval = 1000) {
  let isDone = false;

  const runPromise = () => {
    if (isDone) {
      // Wrap and returns the result
      return cy.wrap(promise.catch(error => assert.isNotOk(true, error)));
    }
    return cy.wait(interval).then(() => runPromise());
  };

  // Marks as resolved
  promise.then(() => (isDone = true)).catch(() => (isDone = true));

  return runPromise();
}

And in-use example

it('Restore Password - Should received an email', () => {
  const task = emailHelper.searchLastEmail({
    emailAddress: user.email,
    subject: 'Reset Password',
    timeout: 2 * 60000 // 2 min
  });

  testHelpers.waitPromise(task).then(mail => {
    // Save for later test
    restorePasswordMail = mail;
    return expect(mail).not.to.be.null;
  });
});