在 Cypress 测试中等待服务返回非空响应

Question

在我的 Cypress 测试套件中，我有一个命令对电子邮件服务进行 API 调用，查找具有特定主题的电子邮件并返回该电子邮件的内容。

Cypress.Commands.add('getMostRecentEmail', subject => {
  const requestUrl = new URL('api/mails', 'localhost')
  requestUrl.port = '3000'
  requestUrl.searchParams.append('subject', subject)

  // TODO: wait for the following request to return a non-empty response.body

  return cy.request('GET', requestUrl.toString()).then(response => {
    return response.body[0].content[0].value
  })
})

当我在本地运行测试时，效果很好，但是当在 CI 上运行测试时，它第一次失败，但当 Cypress 自动重试测试时成功。据推测，这是因为第一次尝试检索电子邮件时尚未收到电子邮件（电子邮件是在上述代码执行之前立即发送的）。

response.body 是服务返回的匹配电子邮件的数量，第一次发出请求时，这是空的，因此 response.body[0] 是 <代码>未定义。

赛普拉斯将此测试报告为“不稳定”，因为它第一次尝试时没有成功。

为了解决这个问题，我想在检索第一封电子邮件的内容之前等待请求返回非空响应。

Answer 1

请查看 https://slides.com/bahmutov/email-testing 演示文稿。特别是博客文章 https://www.cypress.io/blog/2021/05/24/full-testing-of-html-emails-using-ethereal-accounts/#retry-email-task 讨论如何重试获取电子邮件，因为它只能在某个未知时间后发生。

Answer 2

为您的请求创建一个可以递归调用的函数：

function makeRequestRecursively() {
    cy.request('GET', requestUrl.toString()).then(response => {
        let value = response.body[0].content[0].value;
        if (response.body[0].content[0].value != undefined) {
            return value;
        }
        else {
            // Recursively call the function after 0.5 seconds. You can adjust or remove this.
            setTimeout(function (){
                return makeRequestRecursively();        
            }, 500);
        }
    }
}

替换：

return cy.request('GET', requestUrl.toString()).then(response => {
    return response.body[0].content[0].value
})

为：

return makeRequestRecursively()