JestのFake Timers

https://github.com/sinonjs/fake-timers
@sinonjs/fake-timersに依存しているはず

jest.useFakeTimersを使うと、↓は偽のタイマーから値を返す実装に置き換わる

• Date
• performance.now()
• queueMicrotask()
• setImmediate()
• clearImmediate()
• setInterval()
• clearInterval()
• setTimeout()
• clearTimeout()

環境によって以下も同様に置き換わる。

• Node
  • process.hrtime
  • process.nextTick()
• JSDOM
  • requestAnimationFrame()
  • cancelAnimationFrame()
  • requestIdleCallback()
  • cancelIdleCallback()

useFakeTimersのオプション

type FakeTimersConfig = {
  advanceTimers?: boolean | number;
  doNotFake?: Array<FakeableAPI>;
  legacyFakeTimers?: boolean;
  now?: number | Date;
  timerLimit?: number;
};

jest.useRealTimers()を呼ばない限り同じテストファイル内ではjest.useFakeTimers()の偽のタイマーが生き続ける。
同じファイル内のどこで呼ぶこともできるけど、それがファイル内のテスト全体に影響する。

jest.useRealTimers()を呼べばオリジナルの実装に戻る。

LegacyFakeTimersとModernFakeTimersがある

export {default as LegacyFakeTimers} from './legacyFakeTimers';
export {default as ModernFakeTimers} from './modernFakeTimers';

LegacyFakeTimersは@sinonjs/fake-timersに依存していないタイマー実装。

https://github.com/facebook/jest/blob/39f3beda6b396665bebffab94e8d7c45be30454c/packages/jest-fake-timers/src/modernFakeTimers.ts

useFakeTimersを呼ぶと、this._fakeTimers.install()が実行される

    this._clock = this._fakeTimers.install(
      this._toSinonFakeTimersConfig(fakeTimersConfig),
    );

this._fakeTimersは@sinonjs/fake-timersのwithGlobalをコンストラクタ関数で呼んだ結果を参照している。

this._fakeTimers = withGlobal(global);

@sinonjs/fake-timersのwithGlobal を見に行くと、大きい関数がある

https://github.com/sinonjs/fake-timers/blob/8179e1a81e4be8d24485f17d3c3e58ab11d8f1ba/src/fake-timers-src.js#L135