Ошибка TypeError во время spyOn Jest: невозможно установить свойство getRequest для # ‹Object›, у которого есть только геттер.

Это было интересно.

Проблема

Babel генерирует свойства, в которых только get определены для реэкспортируемых функций.

utils/serverRequests/index.ts реэкспортирует функции из других модулей, поэтому возникает ошибка, когда jest.spyOn используется для слежения за реэкспортируемыми функциями.

Подробности

Учитывая этот код, реэкспорт всего из lib:

export * from './lib';

..._ 7_ производит это:

'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) в тест, импортируйте модуль, в котором определено getRequest, и используйте этот модуль для создания шпиона.

Альтернативное решение

Смоделируйте весь модуль utils/serverRequests, как это предлагают @Volodymyr и @TheF

Как предлагается в комментариях, для 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

Протестировано с ts-jest в качестве компилятора, оно будет работать, если вы имитируете модуль следующим образом:

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

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

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

Официальный документ для __esModule

Недавно мы обнаружили нечто подобное в библиотеке, которую использовали. Babel предоставлял геттеры только для всех членов, которые были экспортированы из библиотеки, поэтому мы сделали это в начале теста:

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

Это устранило проблему, поскольку он создал новый простой старый объект JS с членом для каждого свойства в библиотеке.

Для всех, у кого есть эта проблема, вы можете настроить babel на использование "свободных" преобразований, которые решили проблему для меня. Просто установите его в своем файле .babelrc так

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

Апгрейды на Jest Unit-Tests терпят неудачу при пересечении:

export * from './serverRequests';

Ссылайтесь на файлы напрямую, чтобы избежать проблем типа "... имеет только геттер"!

Если вы хотите оставить свой импорт без изменений, вы можете решить проблему следующим образом:

import * as lib from './lib'

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

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

Вам нужно будет добавить больше jest.mock строк для любых дополнительных реэкспортируемых функций, за которыми вы хотите следить.