Cypress无头模式下await无法解析Promise问题求助

问题现象 #

使用Cypress结合cy.request开发API测试，为了避免.then链式调用，封装了返回原生JavaScript Promise的makeRequest函数。该代码在Cypress UI模式（Chrome浏览器）下运行正常，但执行无头模式命令npx cypress run --headless --spec 'pathtofile'时，第二个API请求失败，报错：Cypress test was stopped while running this command。

问题原因 #

Cypress拥有独立的异步命令队列系统，所有Cypress命令（包括cy.request）都属于Cypress.Chainable类型，并非原生Promise。手动封装原生Promise会脱离Cypress的命令队列管控，UI模式下Chrome的事件循环机制可能偶然兼容这种写法，但无头模式默认使用Electron浏览器，其事件循环处理逻辑与Chrome存在差异，导致原生Promise和Cypress命令队列的异步行为冲突，最终触发测试终止。

解决方案 #

直接基于Cypress.Chainable封装请求函数，无需手动创建原生Promise。Cypress支持通过async/await语法扁平化链式调用，完全可以满足避免.then嵌套的需求。

修改后的代码示例 #

const newPet = {
  "name": "jkysssssss",
  "data": {
    "year": 2017,
    "price": 4589,
    "CPU model": "Intel eeeeeee",
    "Hard disk size": "1 TB"
  }
}

export function makeRequest(requestOptions: any) {
  // 直接返回Cypress.Chainable，无需原生Promise封装
  return cy.request(requestOptions).then((res) => {
    if (!res || !res.body) {
      throw new Error('No response body returned from request.');
    }
    
    // 确保响应体是对象格式
    if (typeof res.body !== 'object' || res.body === null) {
      res.body = { data: res.body };
    }

    // 为响应体添加状态码字段
    res.body.status = res.status;

    // 打印响应日志
    cy.log(JSON.stringify(res.body));

    return res;
  });
}

describe('API Tests', () => {
  it('should make a POST request and handle the response', async () => {
    const requestOptions = {
      method: 'POST',
      url: 'https://api.restful-api.dev/objects',
      headers: {
        'Content-Type': 'application/json',
      },
      body: newPet,
    };

    // 使用await扁平化调用，无需嵌套.then
    const res1 = await makeRequest(requestOptions);
    expect(res1.body.status).to.eq(200);

    const res2 = await makeRequest(requestOptions);
    expect(res2.body.status).to.eq(200);
  });
});

关键说明 #

• 移除原生Promise封装后，makeRequest返回的是Cypress原生的Chainable对象，完全受Cypress命令队列管控，在UI和无头模式下行为一致。
• 使用async/await语法可以彻底避免.then链式嵌套，同时保证Cypress命令的执行顺序。
• 如果需要抛出错误，直接使用throw即可，Cypress会自动捕获并标记测试失败，无需手动调用reject。

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