Cypress.on('fail')钩子内cy命令在beforeEach开头出错时不执行问题咨询

我在Cypress 14.1.0的support文件中实现了如下fail钩子：

Cypress.on('fail', (err) => {
    cy.task('sendStat', {host: '0.0.0.0', metric: 'my_metric_failures'});
    throw new Error("UI failure (fail hook)");
})

遇到的问题是：

• 当beforeEach函数开头出现错误时，钩子会被触发（能看到抛出的错误信息），但cy.task完全不执行，其他cy.*命令（如cy.wait）也同样被忽略。
• 若错误来自beforeEach内部稍晚位置或it块内，cy.task能正常执行。

核心原因：测试上下文与命令队列的初始化时机 #

Cypress的cy.*命令依赖活跃的测试命令队列和完整的测试上下文：

1. 当beforeEach开头出现同步错误（比如直接throw new Error、未定义变量报错等）时，测试流程会被立即中断，此时Cypress还未初始化测试命令队列，fail钩子中调用的cy.*命令无法被加入队列执行，因此被忽略。
2. 当错误来自beforeEach后续的Cypress命令（如cy.visit失败）或it块内时，测试命令队列已经启动，测试上下文也已完全初始化，cy.*命令能正常被加入队列并执行。

解决方案 #

方案1：绕过Cypress命令队列，直接执行Node.js逻辑

cy.task本质是在Node.js环境执行代码，因此可以将任务逻辑抽离为独立函数，在fail钩子中直接调用，无需通过cy.task：

1. 在cypress.config.js中抽离任务逻辑：

const sendStat = (options) => {
  // 原cy.task('sendStat')的业务逻辑，比如发送统计请求
  console.log('上报失败统计:', options);
  // 可直接使用Node.js API，如axios、fs等
};

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      on('task', {
        sendStat: sendStat // 保留原task，供其他场景使用
      });
    },
  },
});

2. 在support文件的fail钩子中直接调用该函数：

const { sendStat } = require('../cypress.config'); // 根据实际路径调整

Cypress.on('fail', (err) => {
    sendStat({host: '0.0.0.0', metric: 'my_metric_failures'});
    throw new Error("UI failure (fail hook)");
});

方案2：使用异步API直接执行（无需Cypress命令）

如果sendStat是异步操作（比如HTTP请求），可直接使用Node.js的异步库（如axios）在fail钩子中执行：

const axios = require('axios');

Cypress.on('fail', async (err) => {
    await axios.post('你的统计接口地址', {host: '0.0.0.0', metric: 'my_metric_failures'});
    throw new Error("UI failure (fail hook)");
});

方案3：确保beforeEach开头的错误触发Cypress命令队列

如果beforeEach开头的错误是业务逻辑的同步判断，可将其包装为Cypress命令，确保队列初始化：

beforeEach(() => {
  // 原同步错误逻辑改为cy.wrap触发
  cy.wrap(null).then(() => {
    if (someCondition) {
      throw new Error('业务判断失败');
    }
  });
  // 后续命令
});

这种方式会启动Cypress命令队列，即使判断失败触发fail钩子，cy.task也能正常执行。

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