test: fix flaky test-net-write-after-close #14361

Trott · 2017-07-19T06:03:22Z

Replace 250ms timer with event-based logic to make test robust.

Fixes: #13597

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
commit message follows commit guidelines

Affected core subsystem(s)

test net

Trott · 2017-07-19T06:13:23Z

CI: https://ci.nodejs.org/job/node-test-commit/11248/

santigimeno · 2017-07-19T07:15:26Z

test/parallel/test-net-write-after-close.js

 }));

 server.listen(0, function() {
  const client = net.connect(this.address().port, function() {
+    client.on('end', () => {
+      serverSocket.write('test', common.mustCall());
+    });


Maybe wrapping this with common.mustCall()?

Sure, done.

mcollina · 2017-07-19T08:46:41Z

test/parallel/test-net-write-after-close.js

 }));

 server.listen(0, function() {
  const client = net.connect(this.address().port, function() {
+    client.on('end', () => {


'end' signals the end of the readable side of the stream, I think it should be 'finish' (see https://nodejs.org/api/stream.html#stream_events_finish_and_end).

Should documentation for the finish event be added to net.Socket documentation the way end is? Or would that just be more confusing than helpful?

Test fails if I replace end with finish because serverSocket is undefined...

/Users/trott/io.js/test/parallel/test-net-write-after-close.js:43 serverSocket.write('test', common.mustCall()); ^ TypeError: Cannot read property 'write' of undefined at Socket.client.on (/Users/trott/io.js/test/parallel/test-net-write-after-close.js:43:19) at emitNone (events.js:110:20) at Socket.emit (events.js:207:7) at finishMaybe (_stream_writable.js:587:14) at endWritable (_stream_writable.js:595:3) at Socket.Writable.end (_stream_writable.js:546:5) at Socket.end (net.js:491:31) at Socket.<anonymous> (/Users/trott/io.js/test/parallel/test-net-write-after-close.js:45:12) at Object.onceWrapper (events.js:314:30) at emitNone (events.js:105:13)

Actually now that I read this better, 'end' is correct.

'finish' is part of the streams API, but it will signal when the current side is closed. 'end' will be emitted when the other side as stopped sending, so when we call serverSocker.write() that will lead to an error.

mcollina · 2017-07-19T08:48:06Z

test/parallel/test-net-write-after-close.js

 const server = net.createServer(common.mustCall(function(socket) {
+  serverSocket = socket;
+
  socket.resume();

  socket.on('error', common.mustCall(function(error) {
    console.error('got error, closing server', error);
    server.close();


it seems this is the expected behavior. Can we change the text or place a comment so it's clear to the reader?

got error -> received error as expected

Also: I'd be OK with removing the console.error() entirely too. Either way.

refack

% comments

mcollina · 2017-07-19T13:44:29Z

test/parallel/test-net-write-after-close.js

 }));

 server.listen(0, function() {
  const client = net.connect(this.address().port, function() {
+    client.on('end', () => {
+      serverSocket.write('test', common.mustCall());
+    });
    client.end();


can you add a comment on top of this? Something like:

// cliend.end() will close both the readable and writable side // of the duplex, because allowHalfOpen is defaulted to false. // Then 'end' will be emitted when it receives a FIN packet from // the other side.

Replace 250ms timer with event-based logic to make test robust. Fixes: nodejs#13597

Trott · 2017-07-19T13:58:15Z

Stress tests:

master (should show failures): https://ci.nodejs.org/job/node-stress-single-test/1325/
this PR (should be green, or at least show fewer failures...): https://ci.nodejs.org/job/node-stress-single-test/1327/

Trott · 2017-07-19T13:59:53Z

Re-running CI with changes:

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

Trott · 2017-07-19T15:53:37Z

Stress tests results are as expected. 🎉

Trott · 2017-07-21T17:35:19Z

Landed in 43bd47c

Replace 250ms timer with event-based logic to make test robust. PR-URL: nodejs#14361 Fixes: nodejs#13597 Reviewed-By: Santiago Gimeno <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>

Replace 250ms timer with event-based logic to make test robust. PR-URL: #14361 Fixes: #13597 Reviewed-By: Santiago Gimeno <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>

MylesBorins · 2017-08-16T07:48:08Z

This does not land cleanly in LTS. Please feel free to manually backport by following the guide. Please also feel free to replace do-not-land if it is being backported

Trott added flaky-test Issues and PRs related to the tests with unstable failures on the CI. net Issues and PRs related to the net subsystem. test Issues and PRs related to the tests. labels Jul 19, 2017

Trott mentioned this pull request Jul 19, 2017

test: investigate flakiness of test-net-write-after-close #13597

Closed

santigimeno approved these changes Jul 19, 2017

View reviewed changes

mcollina reviewed Jul 19, 2017

View reviewed changes

refack approved these changes Jul 19, 2017

View reviewed changes

mcollina reviewed Jul 19, 2017

View reviewed changes

Trott force-pushed the fix-13597 branch 2 times, most recently from 5696f73 to e1a978a Compare July 19, 2017 13:47

test: fix flaky test-net-write-after-close

64794dd

Replace 250ms timer with event-based logic to make test robust. Fixes: nodejs#13597

Trott force-pushed the fix-13597 branch from e1a978a to 64794dd Compare July 19, 2017 13:50

cjihrig approved these changes Jul 19, 2017

View reviewed changes

lpinca approved these changes Jul 19, 2017

View reviewed changes

jasnell approved these changes Jul 19, 2017

View reviewed changes

Trott closed this Jul 21, 2017

addaleax mentioned this pull request Jul 24, 2017

v8.3.0 proposal #14452

Closed

addaleax mentioned this pull request Aug 2, 2017

v8.3.0 proposal #14594

Merged

MylesBorins added the dont-land-on-v6.x label Aug 16, 2017

Trott deleted the fix-13597 branch January 13, 2022 22:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: fix flaky test-net-write-after-close #14361

test: fix flaky test-net-write-after-close #14361

Trott commented Jul 19, 2017

Trott commented Jul 19, 2017

santigimeno Jul 19, 2017

Trott Jul 19, 2017

mcollina Jul 19, 2017

Trott Jul 19, 2017 •

edited

Loading

Trott Jul 19, 2017

mcollina Jul 19, 2017

mcollina Jul 19, 2017

Trott Jul 19, 2017

Trott Jul 19, 2017

refack left a comment

mcollina Jul 19, 2017

Trott Jul 19, 2017

Trott commented Jul 19, 2017

Trott commented Jul 19, 2017

Trott commented Jul 19, 2017

Trott commented Jul 21, 2017

MylesBorins commented Aug 16, 2017

test: fix flaky test-net-write-after-close #14361

test: fix flaky test-net-write-after-close #14361

Conversation

Trott commented Jul 19, 2017

Checklist

Affected core subsystem(s)

Trott commented Jul 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trott Jul 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trott commented Jul 19, 2017

Trott commented Jul 19, 2017

Trott commented Jul 19, 2017

Trott commented Jul 21, 2017

MylesBorins commented Aug 16, 2017

Trott Jul 19, 2017 •

edited

Loading