在 Jest 的 spyOn 期间出现类型错误：无法设置只有一个 getter 的 #<Object> 的属性 getRequest

IT技术 reactjs unit-testing jestjs spy spyon
2021-05-06 12:21:05

我正在使用 TypeScript 编写 React 应用程序。我使用 Jest 进行单元测试。

我有一个调用 API 的函数：

import { ROUTE_INT_QUESTIONS } from "../../../config/constants/routes";
import { intQuestionSchema } from "../../../config/schemas/intQuestions";
import { getRequest } from "../../utils/serverRequests";

const intQuestionListSchema = [intQuestionSchema];

export const getIntQuestionList = () => getRequest(ROUTE_INT_QUESTIONS, intQuestionListSchema);

该getRequest函数如下所示：

import { Schema } from "normalizr";
import { camelizeAndNormalize } from "../../core";

export const getRequest = (fullUrlRoute: string, schema: Schema) =>
  fetch(fullUrlRoute).then(response =>
    response.json().then(json => {
      if (!response.ok) {
        return Promise.reject(json);
      }
      return Promise.resolve(camelizeAndNormalize(json, schema));
    })
  );

我想像这样使用 Jest 尝试 API 函数：

import fetch from "jest-fetch-mock";
import { ROUTE_INT_QUESTIONS } from "../../../config/constants/routes";
import {
  normalizedIntQuestionListResponse as expected,
  rawIntQuestionListResponse as response
} from "../../../config/fixtures";
import { intQuestionSchema } from "../../../config/schemas/intQuestions";
import * as serverRequests from "./../../utils/serverRequests";
import { getIntQuestionList } from "./intQuestions";

const intQuestionListSchema = [intQuestionSchema];

describe("getIntQuestionList", () => {
  beforeEach(() => {
    fetch.resetMocks();
  });

  it("should get the int question list", () => {
    const getRequestMock = jest.spyOn(serverRequests, "getRequest");
    fetch.mockResponseOnce(JSON.stringify(response));

    expect.assertions(2);
    return getIntQuestionList().then(res => {
      expect(res).toEqual(expected);
      expect(getRequestMock).toHaveBeenCalledWith(ROUTE_INT_QUESTIONS, intQuestionListSchema);
    });
  });
});

问题是该行spyOn抛出以下错误：

  ● getRestaurantList › should get the restaurant list

    TypeError: Cannot set property getRequest of #<Object> which has only a getter

      17 |
      18 |   it("should get the restaurant list", () => {
    > 19 |     const getRequestMock = jest.spyOn(serverRequests, "getRequest");
         |                                 ^
      20 |     fetch.mockResponseOnce(JSON.stringify(response));
      21 |
      22 |     expect.assertions(2);

      at ModuleMockerClass.spyOn (node_modules/jest-mock/build/index.js:706:26)
      at Object.spyOn (src/services/api/IntQuestions/intQuestions.test.ts:19:33)

我用谷歌搜索了这个，只找到了关于热重载的帖子。那么在 Jest 测试期间是什么导致了这种情况呢？我怎样才能通过这个测试？

4个回答

这个很有趣。

问题

Babel生成仅为get重新导出的函数定义的属性。

utils/serverRequests/index.ts从其他module重新导出函数，因此当jest.spyOn用于监视重新导出的函数时会引发错误。

细节

鉴于此代码重新导出所有内容lib：

export * from './lib';

...Babel产生这个：

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _lib = require('./lib');

Object.keys(_lib).forEach(function (key) {
  if (key === "default" || key === "__esModule") return;
  Object.defineProperty(exports, key, {
    enumerable: true,
    get: function get() {
      return _lib[key];
    }
  });
});

请注意，所有属性都仅使用get.

尝试jest.spyOn在这些属性中的任何一个上使用都会产生您看到的错误，因为jest.spyOn尝试用包裹原始函数的间谍替换该属性，但如果该属性仅定义为get.

解决方案

而不是导入../../utils/serverRequests（重新导出getRequest）到测试中，导入module wheregetRequest定义并使用该module创建间谍。

替代解决方案

utils/serverRequests按照@Volodymyr 和@TheF 的建议模拟整个module

正如评论中所建议的，jest 需要在测试对象上设置一个 setter，而 es6 module对象没有。jest.mock()允许您通过在导入后模拟所需的module来解决此问题。

尝试模拟 serverRequests 文件中的导出

import * as serverRequests from './../../utils/serverRequests';
jest.mock('./../../utils/serverRequests', () => ({
    getRequest: jest.fn()
}));

// ...
// ...

it("should get the int question list", () => {
    const getRequestMock = jest.spyOn(serverRequests, "getRequest")
    fetch.mockResponseOnce(JSON.stringify(response));

    expect.assertions(2);
    return getIntQuestionList().then(res => {
        expect(res).toEqual(expected);
          expect(getRequestMock).toHaveBeenCalledWith(ROUTE_INT_QUESTIONS, intQuestionListSchema);
    });
});

这里有一些有用的链接：
https : //jestjs.io/docs/en/es6-class-mocks
https://jestjs.io/docs/en/mock-functions

使用ts-jestas 编译器进行测试，如果您以这种方式模拟module，它将起作用：

import * as serverRequests from "./../../utils/serverRequests";

jest.mock('./../../utils/serverRequests', () => ({
  __esModule: true,
  ...jest.requireActual('./../../utils/serverRequests')
}));

const getRequestMock = jest.spyOn(serverRequests, "getRequest");

开玩笑的官方文档 __esModule

最近我们在我们使用的库中遇到了这样的事情。Babel 只为从库中导出的所有成员提供 getter，所以我们在测试的顶部这样做：

jest.mock('some-library', () => ({
  ...jest.requireActual('some-library')
}));

这解决了这个问题，因为它创建了一个新的、普通的 JS 对象，该对象为库中的每个属性都有一个成员。

其它你可能感兴趣的问题
上一篇什么是SBS塑料 下一篇如何在react中删除 .eslintcache 文件？