typescriptcypresse2ecypress-intercept

Waiting for an intercepted request is not working as expected


I need to check the status of the email verification token changed after verifying the email.

First I create a user, then I get the email verification URL sent to the user and finally access this link.

When accessing the app link, it sends the auth token to the API to mark the email as verified. I need cypress to wait for the API response, so I can continue testing...

it('ensure create a user and verify the email address', () => {
  // Create the user
  cy.request('POST', 'app/sign-up.json', {
    user: {
      userName: 'new_user',
      email: 'm@d.c',
      password: 'password',
      fullName: 'new user full name'
    }
  }).should((response) => {
    expect(response.status).to.eq(201)
    // Check if user has been created in database
    cy.task('prisma:user:findMany', {}).then(async (result: any) => {
      expect(result.length).to.eq(1)
      // Get email verification link
      cy.task<Array<BeeQueue.Job<IEmail>>>('beeQueue:emailService:getJobs', 'waiting')
        .should('exist')
        .should('have.length', 1)
        .then((result) => {
          if (result[0].data.text !== null && result[0].data.text !== undefined) {
            const tokenUrl = result[0].data.text.substring(result[0].data.text.lastIndexOf('http://'))
            // Intercept API request
            cy.intercept('GET', '/app/verify_email.json?*').as('verifyEmail')
            cy.visit(tokenUrl.substring(tokenUrl.indexOf('/app')))
            //
            // Here the logic doesn't work, cypress doesn't wait for the request response
            //
            cy.wait('@verifyEmail').its('response.statusCode').should('equal', 200)
          }
        })
    })
  })
})

In the image, we can see that the request happens after the .wait() In the image we can see that the request happens after the wait()

In next image I used wait before wait for intercepted .wait(2000)

cy.wait(2000)
cy.wait('@verifyEmail').its('response.statusCode').should('equal', 200)

I don't think this way (using a fixed wait) is the smart way to do it. But if there is only this way, then why use the wait with intercept?

In this image I used wait before intercept wait(2000)


Solution

  • (So you're behaving unexpectedly in Cypress)

    Before each test, two tasks were done to clean the redis queue and clean the data from the database. I was passing a callBack to the beforeEach function with the argument done.

    beforeEach((done) => {
       cy.clearDb().then(() => {
         cy.clearEmailQueueJobs()
         done()
       })
    })
    

    At some point one of these tasks was failing and I wasn't catching the error.

    As Fody said Cypress was resetting the runner and returning undefined and now we know why.

    Looking at the image below you can see an error in Cypress.

    Cypress error

    The solution was to pass a callback without the done argument and let Cypress handle task errors

    beforeEach(() => {
      cy.clearDb()
      cy.clearEmailQueueJobs()
    })
    

    Now everything works as expected.

    enter image description here