Jest结合vuex-module-decorators为Vue TS组件单测时正确注入Store的方法
Vue组件单元测试中vuex-module-decorators Store注入失败问题
问题背景
- 基于TypeScript开发的Vue组件生产环境全功能运行正常,组件内部引用通过
vuex-module-decorators实现的Vuex Store,搭配自定义全局访问器完成状态调用 - 使用Jest + vue-test-utils编写单元测试时,始终无法正确注入自定义Store
- 测试执行中发现核心异常:组件内引入的
jobsWantedStore为undefined,最终断言EDIT_JOBAction的实际调用次数为0
相关代码实现
被测组件 mycomponent.vue
<template> <v-autocomplete v-model="job :items="jobs" outlined dense @change="editJob" /> </template> <script lang="ts"> import { Component, Vue } from 'vue-property-decorator' import { jobsWantedStore } from '../../utils/store-accessor' @Component export default class SelectJob extends Vue { async editJob() { try { await jobsWantedStore.EDIT_JOB(this.job) } catch (error) { this.error = error } } } </script>
Vuex Store模块实现
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */ import { Module, VuexModule, Action, Mutation, getModule } from 'vuex-module-decorators' import { PrioritisedJob } from '~/models' import JobsWantedService from '~/services/jobs-wanted-service' @Module({ name: 'jobsWanted', stateFactory: true, namespaced: true, }) export default class JobsWanted extends VuexModule { jobsWanted: Array<PrioritisedJob> = [] // Getters public get JobsWanted(): Array<PrioritisedJob> { return this.jobsWanted } // Mutations @Mutation setJobs(jobsWanted: Array<PrioritisedJob>): any { this.jobsWanted = jobsWanted } @Mutation setJob(jobWanted: PrioritisedJob): any { this.jobsWanted = this.jobsWanted.map((job) => { if (jobWanted.id === job.id) { return jobWanted } return { ...job } }) } @Action({ rawError: true }) public async EDIT_JOB(newJob: PrioritisedJob): Promise<any> { try { const job = await JobsWantedService.editJob(newJob) this.setJob(job) } catch (error) { throw error.response } } }
全局Store访问器实现
/* eslint-disable import/no-mutable-exports */ import { Store } from 'vuex' import { getModule } from 'vuex-module-decorators' import jobsWanted from '../store/jobsWanted' let jobsWantedStore: jobsWanted function initialiseStores(store: Store<any>): void { jobsWantedStore = getModule(jobsWanted, store) } export { initialiseStores, jobsWantedStore }
注:该访问器的核心逻辑为,只有主动调用initialiseStores方法传入Vuex实例后,导出的jobsWantedStore变量才会被赋值为绑定后的模块实例,否则初始值为undefined。
现有单元测试 job.spec.js
import { shallowMount, createLocalVue } from '@vue/test-utils' import mycomponent from '@/components/mycomponent.vue' import Vuetify from 'vuetify' import Vuex from 'vuex' const localVue = createLocalVue() const vuetify = new Vuetify() localVue.use(Vuex) describe('SelectJob', () => { let wrapper let store let actions let model beforeEach(() => { actions = { EDIT_JOB: jest.fn(), } store = new Vuex.Store({ modules: { jobsWanted: { namespaced: true, actions, }, }, }) wrapper = shallowMount(SelectJob, { propsData, localVue, vuetify, store, }) }) it('should edit a job', () => { wrapper.vm.editJob() try { expect(actions.EDIT_JOB).toHaveBeenCalled() } catch (e) { expect(e).toMatch('error') } }) })
问题根因
- 自定义Store访问器采用全局单例绑定模式,生产环境下依赖应用启动阶段主动调用
initialiseStores(store)方法,将全局Vuex Store实例与vuex-module-decorators的模块类完成绑定,最终为jobsWantedStore变量赋值可用实例 - 单元测试环境下,应用启动流程不会被自动触发,
initialiseStores方法从未执行,因此jobsWantedStore始终保持初始的undefined状态,组件内部调用该变量的方法时,不会触发测试中mock的Action - 测试时传入mount配置的
store选项,只会将Store挂载到组件实例的$store属性上,不会自动触发Store访问器的全局绑定逻辑
正确实现方案
在测试用例的beforeEach流程中,完成测试用Store实例创建后,显式调用initialiseStores方法传入该实例,完成Decorator模块与测试Store的绑定,即可让组件内引用的jobsWantedStore变量获取到可用实例。
调整后的测试代码示例:
import { shallowMount, createLocalVue } from '@vue/test-utils' import SelectJob from '@/components/mycomponent.vue' import Vuetify from 'vuetify' import Vuex from 'vuex' // 导入Store访问器的初始化方法 import { initialiseStores } from '@/utils/store-accessor' const localVue = createLocalVue() const vuetify = new Vuetify() localVue.use(Vuex) describe('SelectJob', () => { let wrapper let store let actions beforeEach(() => { // 重置所有mock方法状态 jest.clearAllMocks() // 定义mock的Action集合 actions = { EDIT_JOB: jest.fn(), } // 创建测试用Vuex Store实例 store = new Vuex.Store({ modules: { jobsWanted: { namespaced: true, actions, }, }, }) // 关键步骤:主动调用初始化方法,完成Decorator模块与测试Store的绑定 initialiseStores(store) // 挂载被测组件 wrapper = shallowMount(SelectJob, { localVue, vuetify, store, }) }) it('触发editJob方法时应正确调用EDIT_JOB Action', async () => { await wrapper.vm.editJob() expect(actions.EDIT_JOB).toHaveBeenCalled() }) })
注意事项
vuex-module-decorators的getModule方法会缓存已绑定的模块实例,每个测试周期执行前需确保绑定的是当前测试新建的Store实例,避免不同测试用例间的状态污染- 测试流程无需绕过原有生产环境的初始化逻辑,按照生产环境的调用规则显式触发
initialiseStores,即可保持测试与生产环境的逻辑一致性
内容的提问来源于stack exchange,提问作者Elsa Szymczak
相关产品推荐
相关产品推荐

