test-timers-same-timeout-wrong-list-deleted.js

'use strict';

/*
 * This is a regression test for https://github.com/nodejs/node/issues/7722.
 *
 * When nested timers have the same timeout, calling clearTimeout on the
 * older timer after it has fired causes the list the newer timer is in
 * to be deleted. Since the newer timer was not cleared, it still blocks
 * the event loop completing for the duration of its timeout, however, since
 * no reference exists to it in its list, it cannot be canceled and its
 * callback is not called when the timeout elapses.
 */

const common = require('../common');
const assert = require('assert');
const Timer = process.binding('timer_wrap').Timer;

const TIMEOUT = common.platformTimeout(100);

const handle1 = setTimeout(common.mustCall(function() {
  // Cause the old TIMEOUT list to be deleted
  clearTimeout(handle1);

  // Cause a new list with the same key (TIMEOUT) to be created for this timer
  const handle2 = setTimeout(common.mustNotCall(), TIMEOUT);

  setTimeout(common.mustCall(function() {
    // Attempt to cancel the second timer. Fix for this bug will keep the
    // newer timer from being dereferenced by keeping its list from being
    // erroneously deleted. If we are able to cancel the timer successfully,
    // the bug is fixed.
    clearTimeout(handle2);

    setImmediate(common.mustCall(function() {
      setImmediate(common.mustCall(function() {
        const activeTimers = getActiveTimers();

        // Make sure our clearTimeout succeeded. One timer finished and
        // the other was canceled, so none should be active.
        assert.strictEqual(activeTimers.length, 0);
      }));
    }));
  }), 1);

  // Make sure our timers got added to the list.
  const activeTimers = getActiveTimers();
  const shortTimer = activeTimers.find(function(handle) {
    return handle._list.msecs === 1;
  });
  const longTimers = activeTimers.filter(function(handle) {
    return handle._list.msecs === TIMEOUT;
  });

  // Make sure our clearTimeout succeeded. One timer finished and
  // the other was canceled, so none should be active.
  assert.strictEqual(activeTimers.length, 3);
  assert(shortTimer instanceof Timer, 'The shorter timer is not in the list.');
  assert.strictEqual(longTimers.length, 2);

  // When this callback completes, `listOnTimeout` should now look at the
  // correct list and refrain from removing the new TIMEOUT list which
  // contains the reference to the newer timer.
}), TIMEOUT);

function getActiveTimers() {
  const activeHandles = process._getActiveHandles();
  return activeHandles.filter((handle) => handle instanceof Timer);
}