Cypress中使用导出异步函数报错：Jimp.read不是函数

问题原因 #

Jimp是Node.js专属模块，只能在Node环境运行，而Cypress的自定义命令默认在浏览器上下文执行，直接调用会导致API不兼容，出现Jimp.read is not a function这类错误。

解决步骤 #

1. 在Cypress配置文件中注册Node任务 #

修改cypress.config.js，添加自定义task，将图片处理逻辑放到Node环境执行：

const { defineConfig } = require("cypress");
const Jimp = require("jimp");

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      // 注册处理图片的task
      on('task', {
        async processImage(imgpath, length = 5) {
          const image = await Jimp.read(imgpath);
          // 这里写入你的邮箱提取逻辑
          const result = '提取到的邮箱地址'; // 替换为实际处理结果
          return result;
        }
      });
    },
  },
});

2. 调整自定义命令（commands.js） #

不再直接导入myfunc，改用cy.task调用Node端的处理逻辑，同时修正原代码中result变量作用域错误：

Cypress.Commands.add('login', (username, password, myimage) => {
  cy.visit('/Auth/Login')
  cy.get('input[id=username]').type(username)
  cy.get('input[id=password]').type(password, {sensitive: true})
  
  // 调用Node端的图片处理任务
  cy.task('processImage', myimage)
    .then((result) => {
      cy.log(result);
      cy.get('input[id=email]').type(result);
    })
    .catch((error) => {
      cy.log('Error:', error);
    });

  // 移除此行：result是then回调的局部变量，外部无法访问，会报错
  // cy.get('input[id=email]').type(result)
});

3. （可选）复用myfunc逻辑 #

如果想保留myfunc.js的复用性，可将其导入到配置文件的task中：

// myfunc.js
const Jimp = require("jimp");

module.exports = async function myfunc(imgpath, length = 5) {
  const image = await Jimp.read(imgpath);
  // 图片处理逻辑
  const result = '提取到的邮箱地址';
  return result;
};

然后在cypress.config.js中导入：

const { defineConfig } = require("cypress");
const myfunc = require('./cypress/support/myfunc.js'); // 路径根据实际结构调整

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      on('task', {
        async processImage(imgpath, length = 5) {
          return await myfunc(imgpath, length);
        }
      });
    },
  },
});

关键说明 #

• Cypress的cy.task是唯一能在Node环境执行代码的方式，适合处理文件操作、Node模块调用这类浏览器无法完成的任务。
• 原代码末尾的cy.get('input[id=email]').type(result)会报错，因为result是then回调的局部变量，外部无法访问，必须删除或移到回调内部。

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