test: adding mustCall in test-timers-unrefed-in-callback.js #12594

Zahidul-Islam · 2017-04-22T19:31:34Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

Fishrock123

LGTM w/ CI: https://ci.nodejs.org/job/node-test-pull-request/7593/

mscdex · 2017-04-22T19:37:07Z

test/parallel/test-timers-unrefed-in-callback.js

    timer2.unref();
    if (counter2++ === 3)
      server.close();
-  }, 1);
+  }, 4), 1);


I'm not sure this change is correct, especially given the comment block preceding this second test.

I believe it is, but it isn't what are testing so it was left out of the original.

addaleax

LGTM if CI is happy

Trott · 2017-04-23T03:48:42Z

Changes made so running CI again.

CI: https://ci.nodejs.org/job/node-test-pull-request/7606/

Fishrock123

The change is now not ideal. @Zahidul-Islam Please disregard @mscdex's comment and re-add a common.mustCall() to the second timer.

Trott · 2017-04-23T23:17:08Z

@Fishrock123 Doing that will result in a flaky unreliable test. That function can fire 4 times or 5 times, so we cannot use common.mustCall() with it.

Since it was not being checked in the original test, I think @mscdex is right and we should not check it here.

If we want to add a process.on('exit',...) check that it fires at least 4 times, that can be done here or it can be done in a subsequent PR. But we should not use common.mustCall(). (Or we should rewrite common.mustCall to accept an optional range, but that's definitely a separate PR.)

Trott

This LGTM as it currently stands.

Fishrock123 · 2017-04-24T15:40:44Z

Doing that will result in a flaky unreliable test. That function can fire 4 times or 5 times, so we cannot use common.mustCall() with it.

Please do elaborate on why that is? It will definitely fire only one or the other. If the server fully closes this loop, then 4. Otherwise, 5. Is that actually non-deterministic?

Trott · 2017-04-25T03:18:01Z

@Fishrock123 The key is to run it under load. Copy this to test/parallel/test-fishrock123.js:

'use strict';
// Checks that setInterval timers keep running even when they're
// unrefed within their callback.

require('../common');
const assert = require('assert');
const net = require('net');

let counter1 = 0;
let counter2 = 0;

// Test1 checks that clearInterval works as expected for a timer
// unrefed within its callback: it removes the timer and its callback
// is not called anymore. Note that the only reason why this test is
// robust is that:
// 1. the repeated timer it creates has a delay of 1ms
// 2. when this test is completed, another test starts that creates a
//    new repeated timer with the same delay (1ms)
// 3. because of the way timers are implemented in libuv, if two
//    repeated timers A and B are created in that order with the same
//    delay, it is guaranteed that the first occurrence of timer A
//    will fire before the first occurrence of timer B
// 4. as a result, when the timer created by Test2 fired 11 times, if
//    the timer created by Test1 hadn't been removed by clearInterval,
//    it would have fired 11 more times, and the assertion in the
//    process'exit event handler would fail.
function Test1() {
  // server only for maintaining event loop
  const server = net.createServer().listen(0);

  const timer1 = setInterval(() => {
    timer1.unref();
    if (counter1++ === 3) {
      clearInterval(timer1);
      server.close(() => {
        Test2();
      });
    }
  }, 1);
}


// Test2 checks setInterval continues even if it is unrefed within
// timer callback. counter2 continues to be incremented more than 11
// until server close completed.
function Test2() {
  // server only for maintaining event loop
  const server = net.createServer().listen(0);

  const timer2 = setInterval(() => {
    timer2.unref();
    if (counter2++ === 3)
      server.close();
  }, 1);
}

process.on('exit', () => {
  assert.strictEqual(counter1, 4);
  // cause it to fail so that the value of counter2 is displayed by test.py
  assert.fail(`counter2: ${counter2}`);
});

Test1();

The only change is in the exit handler.

If I run the above on my otherwise-idle laptop, it reliably indicates that counter2 has a value of 4. But if I run it under load, I sometimes get 4 and sometimes get 5...

$ tools/test.py --repeat 128 -j 64 test/parallel/test-fishrock123.js 
=== release test-fishrock123 ===                    
Path: parallel/test-fishrock123
assert.js:86
  throw new assert.AssertionError({
  ^
AssertionError: counter2: 5
    at process.on (/Users/trott/io.js/test/parallel/test-fishrock123.js:60:10)
    at emitOne (events.js:120:20)
    at process.emit (events.js:210:7)
Command: out/Release/node /Users/trott/io.js/test/parallel/test-fishrock123.js
=== release test-fishrock123 ===                    
Path: parallel/test-fishrock123
assert.js:86
  throw new assert.AssertionError({
  ^
AssertionError: counter2: 4
    at process.on (/Users/trott/io.js/test/parallel/test-fishrock123.js:60:10)
    at emitOne (events.js:120:20)
    at process.emit (events.js:210:7)
Command: out/Release/node /Users/trott/io.js/test/parallel/test-fishrock123.js
=== release test-fishrock123 ===                    
Path: parallel/test-fishrock123
assert.js:86
  throw new assert.AssertionError({
  ^
AssertionError: counter2: 5
    at process.on (/Users/trott/io.js/test/parallel/test-fishrock123.js:60:10)
    at emitOne (events.js:120:20)
    at process.emit (events.js:210:7)
Command: out/Release/node /Users/trott/io.js/test/parallel/test-fishrock123.js
=== release test-fishrock123 ===                    
Path: parallel/test-fishrock123
assert.js:86
  throw new assert.AssertionError({
  ^
AssertionError: counter2: 4
    at process.on (/Users/trott/io.js/test/parallel/test-fishrock123.js:60:10)
    at emitOne (events.js:120:20)
    at process.emit (events.js:210:7)
Command: out/Release/node /Users/trott/io.js/test/parallel/test-fishrock123.js
=== release test-fishrock123 ===                    
Path: parallel/test-fishrock123
assert.js:86
  throw new assert.AssertionError({
  ^
AssertionError: counter2: 4
    at process.on (/Users/trott/io.js/test/parallel/test-fishrock123.js:60:10)
    at emitOne (events.js:120:20)
    at process.emit (events.js:210:7)
Command: out/Release/node /Users/trott/io.js/test/parallel/test-fishrock123.js
=== release test-fishrock123 ===                    
Path: parallel/test-fishrock123
assert.js:86
  throw new assert.AssertionError({
...

Zahidul-Islam · 2017-04-25T07:21:58Z

@Trott @Fishrock123 @addaleax @jasnell appreciate any suggestion what I should do?

Trott · 2017-04-25T20:59:16Z

@Zahidul-Islam I think it's fine as-is. @Fishrock123?

mscdex · 2017-04-25T21:06:41Z

LGTM

addaleax · 2017-04-29T15:32:29Z

@Fishrock123 ping … if there are no further comments here, I am going to assume you are fine with this change as it is (especially as the diff itself here should not contain anything controversial in my eyes)

Pinged multiple times including a week ago with "if there are no further comments here, I am going to assume you are fine with this", dismissing

PR-URL: nodejs#12594 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Brian White <[email protected]>

Trott · 2017-05-06T23:07:29Z

Landed in 3fd890a.
Thanks for the contribution! 🎉

PR-URL: nodejs#12594 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Brian White <[email protected]>

PR-URL: #12594 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Brian White <[email protected]>

test: adding mustCall in test-timers-unrefed-in-callback.js

12777b0

nodejs-github-bot added the test Issues and PRs related to the tests. label Apr 22, 2017

mscdex added the timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. label Apr 22, 2017

Fishrock123 approved these changes Apr 22, 2017

View reviewed changes

mscdex reviewed Apr 22, 2017

View reviewed changes

addaleax approved these changes Apr 22, 2017

View reviewed changes

test: update test-times-unrefed-in-callback.js

938fb99

Fishrock123 previously requested changes Apr 23, 2017

View reviewed changes

Trott approved these changes Apr 23, 2017

View reviewed changes

jasnell added the code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. label Apr 24, 2017

jasnell approved these changes Apr 24, 2017

View reviewed changes

Trott closed this May 6, 2017

jasnell mentioned this pull request May 11, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

gibfahn added the land-on-v6.x label Jun 20, 2017

MylesBorins mentioned this pull request Jul 18, 2017

v6.11.2 proposal #14356

Merged

snyk-bot mentioned this pull request Mar 18, 2020

[Snyk] Upgrade eslint from 6.3.0 to 6.8.0 O330oei/node#4

Open

snyk-bot mentioned this pull request Apr 1, 2020

[Snyk] Upgrade eslint from 6.3.0 to 6.8.0 O330oei/node#11

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: adding mustCall in test-timers-unrefed-in-callback.js #12594

test: adding mustCall in test-timers-unrefed-in-callback.js #12594

Zahidul-Islam commented Apr 22, 2017

Fishrock123 left a comment

mscdex Apr 22, 2017

Fishrock123 Apr 22, 2017

addaleax left a comment

Trott commented Apr 23, 2017

Fishrock123 left a comment •

edited

Loading

Trott commented Apr 23, 2017 •

edited

Loading

Trott left a comment

Fishrock123 commented Apr 24, 2017

Trott commented Apr 25, 2017

Zahidul-Islam commented Apr 25, 2017

Trott commented Apr 25, 2017

mscdex commented Apr 25, 2017

addaleax commented Apr 29, 2017

Trott commented May 6, 2017

test: adding mustCall in test-timers-unrefed-in-callback.js #12594

test: adding mustCall in test-timers-unrefed-in-callback.js #12594

Conversation

Zahidul-Islam commented Apr 22, 2017

Checklist

Affected core subsystem(s)

Fishrock123 left a comment

Choose a reason for hiding this comment

mscdex Apr 22, 2017

Choose a reason for hiding this comment

Fishrock123 Apr 22, 2017

Choose a reason for hiding this comment

addaleax left a comment

Choose a reason for hiding this comment

Trott commented Apr 23, 2017

Fishrock123 left a comment • edited Loading

Choose a reason for hiding this comment

Trott commented Apr 23, 2017 • edited Loading

Trott left a comment

Choose a reason for hiding this comment

Fishrock123 commented Apr 24, 2017

Trott commented Apr 25, 2017

Zahidul-Islam commented Apr 25, 2017

Trott commented Apr 25, 2017

mscdex commented Apr 25, 2017

addaleax commented Apr 29, 2017

Trott commented May 6, 2017

Fishrock123 left a comment •

edited

Loading

Trott commented Apr 23, 2017 •

edited

Loading