net: migrate errors to internal/errors #17766

kysnm · 2017-12-19T23:11:21Z

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)

doc, errors, net

Trott

Hi @kysnm! Thanks for the pull request! I have no comments on the code changes and will leave that to others, but I have two small nit-pick comments on the docs.

Trott · 2017-12-19T23:53:55Z

doc/api/errors.md

+### ERR_SERVER_NOT_RUNNING
+
+The [`server.close()`][] method was called when a `net.Server` was not running. This applies to all instances of `net.Server`, including HTTP, HTTPS,
+and HTTP/2 Server instances.


Nit: "Server" should probably be either in backticks or else lowercase. (Either it is referring to a server generically, in which case lowercase, or it is referring to the Server object, in which case backticks.)

Trott · 2017-12-19T23:54:04Z

doc/api/errors.md

+<a id="ERR_SERVER_NOT_RUNNING"></a>
+### ERR_SERVER_NOT_RUNNING
+
+The [`server.close()`][] method was called when a `net.Server` was not running. This applies to all instances of `net.Server`, including HTTP, HTTPS,


Wrap at 80 chars?

kysnm · 2017-12-20T02:25:30Z

@Trott
Thank you for review. I have fixed it.

joyeecheung · 2017-12-20T10:14:54Z

test/parallel/test-http-unix-socket.js

@@ -59,7 +59,7 @@ server.listen(common.PIPE, common.mustCall(function() {
      server.close(common.mustCall(function(error) {
        assert.strictEqual(error, undefined);
        server.close(common.mustCall(function(error) {
-          assert.strictEqual(error && error.message, 'Not running');
+          assert.strictEqual(error && error.code, 'ERR_SERVER_NOT_RUNNING');


Can you use common.expectsError() to test this? This should be something like

common.expectsError({ code: 'ERR_SERVER_NOT_RUNNING', message: 'Server is not running.', type: Error })(error);

joyeecheung · 2017-12-20T10:15:20Z

test/parallel/test-net-socket-destroy-send.js

@@ -13,10 +13,10 @@ server.listen(0, common.mustCall(function() {
    // Test destroy returns this, even on multiple calls when it short-circuits.
    assert.strictEqual(conn, conn.destroy().destroy());
    conn.on('error', common.mustCall(function(err) {
-      assert.strictEqual(err.message, 'This socket is closed');
+      assert.strictEqual(err.code, 'ERR_SOCKET_CLOSED');


Same as above, please use common.expectsError

joyeecheung · 2017-12-20T10:15:32Z

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

@@ -28,8 +28,7 @@ const net = require('net');
    const client = net.connect({ port }, common.mustCall(() => {
      client.on('error', common.mustCall((err) => {
        server.close();
-        assert.strictEqual(err.constructor, Error);
-        assert.strictEqual(err.message, 'This socket is closed');
+        assert.strictEqual(err.code, 'ERR_SOCKET_CLOSED');


kysnm · 2017-12-20T14:00:06Z

@joyeecheung
Thanks for your review. I have fixed it.

apapirovski · 2017-12-20T14:02:44Z

test/parallel/test-net-socket-destroy-send.js

@@ -13,10 +13,18 @@ server.listen(0, common.mustCall(function() {
    // Test destroy returns this, even on multiple calls when it short-circuits.
    assert.strictEqual(conn, conn.destroy().destroy());
    conn.on('error', common.mustCall(function(err) {


The common.mustCall is not necessary here. common.expectsError creates a function that can receive an error and also makes sure that it actually ran.

apapirovski · 2017-12-20T14:03:25Z

test/parallel/test-net-socket-destroy-send.js

    }));
    conn.write(Buffer.from('kaboom'), common.mustCall(function(err) {
-      assert.strictEqual(err.message, 'This socket is closed');
+      common.expectsError({


kysnm · 2017-12-20T15:16:47Z

@apapirovski
Thanks for your review. I have fixed it.

jasnell · 2017-12-20T22:25:12Z

test/parallel/test-http-unix-socket.js

+            code: 'ERR_SERVER_NOT_RUNNING',
+            message: 'Server is not running.',
+            type: Error
+          })(error);


This can be simplified to...

server.close(common.expectsError({ code: 'ERR_SERVER_NOT_RUNNING', message: 'Server is not running.', type: Error }));

kysnm · 2017-12-21T07:46:06Z

@jasnell
Sorry for bothering you…

jasnell · 2017-12-22T17:49:40Z

@kysnm .. there's no bother at all :-) thank you for doing this!

maclover7 · 2017-12-23T00:43:16Z

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

joyeecheung · 2017-12-23T16:12:03Z

There were some seemingly unrelated errors in the last CI. New CI: https://ci.nodejs.org/job/node-test-pull-request/12281/

joyeecheung · 2017-12-23T18:19:22Z

Landed in b98aaa3, thanks!

Throw ERR_SOCKET_CLOSED and ERR_SERVER_NOT_RUNNING instead of the old-style errors in net.js. PR-URL: #17766 Refs: #17709 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

net: migrate errors to internal/errors

0419699

nodejs-github-bot added errors Issues and PRs related to JavaScript errors originated in Node.js core. net Issues and PRs related to the net subsystem. labels Dec 19, 2017

Trott reviewed Dec 19, 2017

View reviewed changes

kysnm added 3 commits December 20, 2017 11:24

Wrap at 80 chars

614792b

Server should be enclosed to backticks

9f60c2c

Just an adjustment

4f79622

kysnm force-pushed the net-migrate-to-internal-errors branch from 086f5f9 to 4f79622 Compare December 20, 2017 02:24

targos approved these changes Dec 20, 2017

View reviewed changes

joyeecheung reviewed Dec 20, 2017

View reviewed changes

joyeecheung mentioned this pull request Dec 20, 2017

Tracking issue: Migrate errors to internal/errors.js #17709

Closed

6 tasks

Use common.expectsError instead of assert.strictEqual

37711dd

apapirovski reviewed Dec 20, 2017

View reviewed changes

Remove useless common.mustCall

7832c2f

jasnell reviewed Dec 20, 2017

View reviewed changes

Remove useless common.mustCall again

3cf5f8f

lpinca approved these changes Dec 21, 2017

View reviewed changes

joyeecheung approved these changes Dec 22, 2017

View reviewed changes

jasnell approved these changes Dec 22, 2017

View reviewed changes

maclover7 added the semver-major PRs that contain breaking changes and should be released in the next major version. label Dec 22, 2017

joyeecheung added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 23, 2017

joyeecheung closed this Dec 23, 2017

joyeecheung removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 23, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

net: migrate errors to internal/errors #17766

net: migrate errors to internal/errors #17766

kysnm commented Dec 19, 2017 •

edited

Loading

Trott left a comment

Trott Dec 19, 2017

Trott Dec 19, 2017

kysnm commented Dec 20, 2017

joyeecheung Dec 20, 2017

joyeecheung Dec 20, 2017

joyeecheung Dec 20, 2017

kysnm commented Dec 20, 2017

apapirovski Dec 20, 2017

apapirovski Dec 20, 2017

kysnm commented Dec 20, 2017

jasnell Dec 20, 2017

kysnm commented Dec 21, 2017

jasnell commented Dec 22, 2017

maclover7 commented Dec 23, 2017

joyeecheung commented Dec 23, 2017

joyeecheung commented Dec 23, 2017

net: migrate errors to internal/errors #17766

net: migrate errors to internal/errors #17766

Conversation

kysnm commented Dec 19, 2017 • edited Loading

Checklist

Affected core subsystem(s)

Trott left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kysnm commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kysnm commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kysnm commented Dec 20, 2017

Choose a reason for hiding this comment

kysnm commented Dec 21, 2017

jasnell commented Dec 22, 2017

maclover7 commented Dec 23, 2017

joyeecheung commented Dec 23, 2017

joyeecheung commented Dec 23, 2017

kysnm commented Dec 19, 2017 •

edited

Loading