You need to enable JavaScript to run this app. Jest单元测试引入JSON配置后出现无法读取api1属性的报错求助
优惠活动
大模型
产品
解决方案
定价
更多

Jest单元测试引入JSON配置后出现无法读取api1属性的报错求助

Jest 单元测试引入本地JSON配置报错排查指南

问题复现场景

  • 项目基础技术栈为React + Jest + Enzyme,新增src/config/config.json配置文件前,所有单元测试均可正常执行通过
  • 新增的配置文件内容存在JSON语法格式问题:
// src/config/config.json
{
    "appName": "Mystery",
    "clients": {
       "api1": "http://localhost:8082",
       "api2": "http://localhost:8083",
       "api3": "http://localhost:8084"
    }, // 此处存在多余的尾随逗号,属于JSON语法错误
}
  • 业务侧在网络请求封装模块中按相对路径导入JSON配置,读取clients.api1初始化请求客户端实例:
// 网络请求模块示例代码
import CONFIG from '../../config/config.json';
const api = new Client(CONFIG.clients.api1);
  • 执行npm test后的统一报错:所有依赖该请求封装模块的测试用例,抛出TypeError: Cannot read property 'api1' of undefined

问题根因

  • Jest默认未开启JSON文件解析能力:日常开发用的Webpack、Vite等构建工具内置了JSON文件加载器,可以直接处理项目内的JSON导入逻辑,但Jest默认的模块解析规则,仅允许解析js/jsx后缀的代码文件,遇到.json后缀的导入时,会将导入值解析为空对象。此时CONFIG实际为{},读取CONFIG.clients得到的结果为undefined,进一步读取undefined上的api1属性就会触发报错
  • 配置文件本身存在语法错误:原config.json中clients对象闭合后多余的尾随逗号,属于标准JSON语法不支持的格式,即使开启了JSON解析能力,带语法错误的文件也无法被正确读取

分步解决操作

  • 第一步:先修正config.json的语法错误,删除多余的尾随逗号,保证文件为合法标准JSON格式
  • 第二步:修改Jest配置,将.json加入支持解析的文件后缀列表。可在项目根目录的jest.config.js、jest.config.ts文件,或package.json内的jest配置块中,补充moduleFileExtensions配置:
// jest.config.js 配置示例
module.exports = {
  // 保留原有业务配置...
  moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx', 'json']
}
  • 第三步:如果配置后仍存在相对路径识别失败的问题,可补充moduleDirectories配置,让Jest能正确识别src目录下的相对路径引用:
// 补充路径解析配置
moduleDirectories: ['node_modules', 'src']
  • 第四步:针对不需要读取真实配置内容的测试场景,可以直接通过jest.mock模拟对应配置模块,隔离测试对真实配置的依赖:
// 测试文件开头添加mock逻辑
jest.mock('../../config/config.json', () => ({
  clients: {
    api1: 'http://mock-test-api.com'
  }
}), { virtual: true })

内容的提问来源于stack exchange,提问作者N8BIZ

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.10 06:06:04