如何在自定义函数中正确返回cy.request的响应结果

问题根因 #

返回Undefined的核心原因如下：

• Cypress所有命令都是异步队列执行的，cy.request不会同步返回请求结果，它仅会把请求操作加入Cypress的命令执行队列，原函数执行到cy.request就直接运行结束，没有给外层Add函数返回任何值
• 你编写的return response是在.then()的回调函数内，这个返回值只会被Cypress内部的命令链消费，不会冒泡到外层的Add函数作用域

解决方案 #

方案1：返回Cypress命令链，调用时通过.then()接收结果 #

修改自定义函数，直接返回整个cy.request命令链：

Add(someName) {
  // 新增return把命令链暴露到外层
  return cy.request ({
    method: 'POST',
    url: someURL,
    body: {
      name: someName
    }
  })
}

调用时在返回的命令链后追加.then()即可拿到响应内容：

// 调用示例
Add('测试名称').then((response) => {
  // 此处可正常获取响应的所有字段
  console.log(response.body)
  // 所有依赖该响应结果的操作都需写在该回调内
})

方案2：用别名存储结果（适配跨步骤/跨用例调用场景） #

如果需要在多个位置复用该请求结果，可以通过Cypress别名存储：

Add(someName) {
  return cy.request ({
    method: 'POST',
    url: someURL,
    body: {
      name: someName
    }
  }).as('addRequestResult') // 给响应设置别名
}

后续需要使用时通过cy.get('@别名')获取即可：

Add('测试名称')
// 其他Cypress操作逻辑
cy.get('@addRequestResult').then((response) => {
  console.log(response.body)
})

注意事项 #

• 不要尝试用普通同步变量存储Cypress异步命令的结果，Cypress命令执行和JS主线程运行时序分离，同步赋值的时机永远晚于变量读取的时机
• 所有依赖异步请求结果的操作，必须写在.then()回调内，或通过Cypress别名机制获取

内容的提问来源于stack exchange，提问作者JelleSch