为什么我不能用 sinon 正确地存根 twilio 库？

Question

在我的代码中，我有：

function handleMessage() {
  const twilio = require('twilio')(process.env.TWILIO_ACCOUNT_SID, process.env.TWILIO_AUTH_TOKEN);
  let recordings = twilio.recordings(foundConference.RecordingSid);
  console.log('recordings', recordings);
  return recordings.remove();
}

在我的存根中，我有：

const sinon = require('sinon');
const twilio = require('twilio')(process.env.TWILIO_ACCOUNT_SID, process.env.TWILIO_AUTH_TOKEN);

exports.twilioRecordings = () => {
  console.log('about to stub', twilio.recordings);
  sinon.stub(twilio, 'recordings').returns('here');
  console.log('finished stub', twilio.recordings);

  return;
};

但是，它实际上并没有创建存根函数。它仍然使用原始recordings功能。我究竟做错了什么？

Answer 1

Twilio npm 包返回一个函数，该函数在每次调用时创建一个新对象，它不是单例。因此，您的存根 twilio 实例仅适用于测试。

此外twilio.recordings（与所有其他属性一样）是通过原型中的 getter 函数定义的，因此它们是只读的：

Object.defineProperty(Twilio.prototype,
  'recordings', {
  get: function() {
    return this.api.account.recordings;
  }
});

因此，存根实际 twilio 实例无效。除非您更改实例的原型，但我认为仅用于单元测试不值得。

我建议您重构代码以将 twilio 初始化放入单独的方法中：

function getTwilio() {
   return require('twilio')(process.env.TWILIO_ACCOUNT_SID, process.env.TWILIO_AUTH_TOKEN);
}

接下来你hangleMessage会看起来像：

function handleMessage() {
  const twilio = this.getTwilio();
  const recordings = twilio.recordings(...);
  ...
}

接下来，在您的测试中，您可以存根getTwilio()返回存根：

const twilioStub = {
    recordings: sinon.stub(),
    remove: sinon.stub()
}
sinon.stub(myAwesomeModule, 'getTwilio').returns(twilioStub);

你也可以考虑使用mock-require包：

const sinon = require('sinon');
const mock = require('mock-require');
mock('twilio', () => ({
  recordings: sinon.stub(),
}));

这是一个关于如何模拟依赖项的问题，可能还有其他有用的库来存根所需的模块。

希望能帮助到你。