Jest spyOn 期间的 TypeError：无法设置只有一个 getter 的 #<Object> 的属性 getRequest

Question

我正在用 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 测试期间可能导致这种情况的原因是什么？我怎样才能让这个测试通过？

Answer 1

如果您希望不修改导入，可以通过以下方式解决问题：

import * as lib from './lib'

jest.mock('./lib/subModule')

it('can be mocked', () => {
  jest.spyOn(lib, 'subModuleFunction')
})

您需要添加更多 jest.mock 行以用于您希望监视的任何其他重新导出的函数。

Answer 2

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

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

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

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

Jest oficial doc for __esModule

Answer 3

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

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

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

Answer 4

Jest 单元测试的升级失败，交叉时：

export * from './serverRequests';

直接引用文件以避免“...只有一个吸气剂”问题！

Answer 5

对于遇到此问题的其他人，您可以将 babel 设置为使用“松散”转换，这为我解决了问题。只需将其设置在您的 .babelrc 文件中即可

{
  "presets": [
    ["@babel/preset-env", {
      "loose": true
    }]
  ]
}

Answer 6

这个很有趣。

问题

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

utils/serverRequests/index.ts 从其他模块重新导出函数，因此当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 尝试用包含原始函数的间谍替换该属性，但如果该属性仅使用@987654332 定义则不能@。

---

解决方案

不要将../../utils/serverRequests（重新导出getRequest）导入到测试中，而是导入定义getRequest的模块并使用该模块来创建间谍。

替代解决方案

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

Answer 7

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

尝试从您的 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