assert.CallTracker

Node.js で experimental な API として assert.CallTracker がv14 で追加されました。 この機能は呼び出された回数を検証するという機能を持った新しい assert 関数です。

コールバック関数をテストする際に使える便利関数です。機能としては地味ですが、使いこなせると便利なので紹介します。

const assert = require('assert');

const tracker = new assert.CallTracker();

function func() {}

// 一度だけ呼ばれることを期待
const callsfunc = tracker.calls(func, 1);

// ここで呼び出す。
callsfunc();

// tracker.verify を呼ぶことで何度呼ばれたかを検証する。
// これはプログラムが終わるときに1度だけ呼ばれてることを検証する。
process.on('exit', () => {
  tracker.verify();
});

これだけ見ていると何が便利かわからないかも知れませんが、テストを書いた時にコード内の不具合で assert が呼ばれずに終わってしまう状況を防ぐことができます。

const assert = require('assert');
const tracker = new assert.CallTracker();

const http = require('http');

const server = http.createServer();
// 一回だけリクエストが来ることを期待
server.on("request", tracker.calls((req, res) => {
  assert.strictEqual("/", req.url);
  res.end("Hello World!");
}, 1));

server.listen(3000);

process.on("SIGINT", () => {
  // もしも一度もリクエストが来なかったらここで検証失敗が出る
  tracker.verify();
  process.exit();
});