Simulateurs de temporisation

Les fonctions de temporisation natives (c'est-à-dire setTimeout, setInterval, clearTimeout, clearInterval) sont moins adaptées à un environnement de test car elles dépendent du temps réel pour s'écouler. Jest peut remplacer les temporisateurs par des fonctions qui vous permettent de contrôler le temps qui passe. Great Scott !

timerGame.js

'use strict';

function timerGame(callback) {
  console.log('Prêt .... partez !');
  setTimeout(() => {
    console.log("Le temps est écoulé -- arrêtez !");
    callback && callback();
  }, 1000);
}

module.exports = timerGame;

__tests__/timerGame-test.js

'use strict';

jest.useFakeTimers(); // ou vous pouvez définir "timers": "fake" globalement dans le fichier de configuration
jest.spyOn(global, 'setTimeout');

test(''attend 1 seconde avant de mettre fin au jeu', () => {
  const timerGame = require('../timerGame');
  timerGame();

  expect(setTimeout).toHaveBeenCalledTimes(1);
  expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 1000);
});

Ici, nous activons les faux temporisateurs en appelant jest.useFakeTimers(). Cela permet de remplacer setTimeout et d'autres fonctions de temporisation par des fonctions simulées. Les temporisateurs peuvent être restaurés à leur comportement normal avec jest.useRealTimers().

Bien que vous puissiez appeler jest.useFakeTimers() ou jest.useRealTimers() de n'importe où (niveau supérieur, à l'intérieur d'un bloc it, etc.), il s'agit d'une opération globale et elle affectera les autres tests du même fichier. De plus, vous devez appeler jest.useFakeTimers() pour réinitialiser les compteurs internes avant chaque test. Si vous prévoyez de ne pas utiliser de faux temporisateurs dans tous vos tests, vous devrez faire le nettoyage manuellement, car sinon les faux temporisateurs seront perdus dans les tests :

afterEach(() => {
  jest.useRealTimers();
});

test('faire quelque chose avec de faux temporisateurs', () => {
  jest.useFakeTimers();
  // ...
});

test('faire quelque chose avec des temporisateurs réels', () => {
  // ...
});

Actuellement, deux implémentations des temporisateurs fictifs sont incluses - modern et legacy, où modern est celui par défaut. Consultez la configuration pour savoir comment la configurer.

Exécuter tous les temporisateurs

Un autre test que nous pourrions vouloir écrire pour ce module est celui qui affirme que le callback est appelé après 1 seconde. Pour ce faire, nous allons utiliser les API de contrôle des temporisateurs de Jest pour avancer rapidement dans le temps au beau milieu du test :

jest.useFakeTimers();
test('appelle le callback après 1 seconde', () => {
  const timerGame = require('../timerGame');
  const callback = jest.fn();

  timerGame(callback);

  // À ce point dans le temps, le callback ne devrait pas encore avoir été appelé.
  expect(callback).not.toBeCalled();

  // Avance rapide jusqu'à ce que toutes les temporisateurs aient été exécutés.
  jest.runAllTimers();

  // Maintenant notre callback aurait dû être appelé !
  expect(callback).toBeCalled();
  expect(callback).toHaveBeenCalledTimes(1);
});

Exécuter les temporisateurs en attente

Il existe également des scénarios dans lesquels vous pouvez avoir un temporisateur récursif, c'est-à-dire un temporisateur qui définit un nouveau temporisateur dans son propre callback. Pour cela, exécuter tous les temporisateurs serait une boucle sans fin, lançant l'erreur suivante :

Ran 100000 timers, and there are still more! Assuming we've hit an infinite recursion and bailing out...

Donc quelque chose comme jest.runAllTimers() n'est pas souhaitable. Pour ces cas, vous pouvez utiliser jest.runOnlyPendingTimers() :

infiniteTimerGame.js

'use strict';

function infiniteTimerGame(callback) {
  console.log('Prêt .... partez !');

  setTimeout(() => {
    console.log("Le temps est écoulé ! 10 secondes avant le début de la prochaine partie..." );
    callback && callback();

    // Planifie la prochaine partie dans 10 secondes
    setTimeout(() => {
      infiniteTimerGame(callback);
    }, 10000);
  }, 1000);
}

module.exports = infiniteTimerGame;

__tests__/infiniteTimerGame-test.js

'use strict';

jest.useFakeTimers();
jest.spyOn(global, 'setTimeout');

describe('infiniteTimerGame', () => {
  test('planifie un minuteur de 10 secondes après 1 seconde', () => {
    const infiniteTimerGame = require('../infiniteTimerGame');
    const callback = jest.fn();

    infiniteTimerGame(callback);

    // A ce stade, il devrait y avoir un seul appel à
    // setTimeout pour programmer la fin du jeu dans 1 seconde.
    expect(setTimeout).toHaveBeenCalledTimes(1);
    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 1000);

    // Avance rapide et achèvement des temporisateurs en cours
    // (mais pas les nouveaux temporisateurs créés au cours de ce processus).
    jest.runOnlyPendingTimers();

    // À ce stade, notre minuteur d'une seconde doit avoir déclenché son callback
    expect(callback).toBeCalled();

    // Et il devrait avoir créé un nouveau temporisateur pour commencer le jeu dans
    // 10 secondes
    expect(setTimeout).toHaveBeenCalledTimes(2);
    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 10000);
  });
});

Avancer les temporisateurs par une durée

Une autre possibilité est d'utiliser jest.advanceTimersByTime(msToRun). Lorsque cette API est appelée, tous les temporisateurs sont avancés de msToRun millisecondes. Toutes les « macro-tâches » en attente qui ont été mises en file d'attente via setTimeout() ou setInterval(), et qui devraient être exécutées pendant ce laps de temps, seront exécutées. En plus, si ces macro-tâches planifient de nouvelles macro-tâches qui devraient être exécutées dans le même laps de temps, celles-ci seront exécutées jusqu'à ce qu'il ne reste plus de macro-tâches dans la file d'attente qui doivent être exécutées dans les msToRun millisecondes.

timerGame.js

'use strict';

function timerGame(callback) {
  console.log('Prêt .... partez !');
  setTimeout(() => {
    console.log("Le temps est écoulé -- arrêtez !");
    callback && callback();
  }, 1000);
}

module.exports = timerGame;

__tests__/timerGame-test.js

jest.useFakeTimers();
it('appelle le callback après 1 seconde via advanceTimersByTime', () => {
  const timerGame = require('../timerGame');
  const callback = jest.fn();

  timerGame(callback);

  // À ce stade, le callback ne doit pas encore être appelé
  expect(callback).not.toBeCalled();

  // Avance rapide jusqu'à ce que toutes les temporisateurs aient été exécutés.
  jest.advanceTimersByTime(1000);

  // Maintenant notre callback devrait avoir été appelé !
  expect(callback).toBeCalled();
  expect(callback).toHaveBeenCalledTimes(1);
});

Enfin, il peut parfois être utile dans certains tests de pouvoir effacer tous les temporisateurs en attente. Pour cela, nous avons jest.clearAllTimers().

The code for this example is available at examples/timer.