lib: finish assigning codes to errors thrown from JS #19373

targos · 2018-03-15T15:21:05Z

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

targos · 2018-03-15T15:28:42Z

lib/net.js

@@ -934,6 +935,7 @@ function internalConnect(
      localAddress = localAddress || '::';
      err = self._handle.bind6(localAddress, localPort);
    } else {
+      // eslint-disable-next-line no-restricted-syntax
      self.destroy(new TypeError('Invalid addressType: ' + addressType));


This error doesn't have a code but I don't know what to do with it: Assign a code? Which one? How can we reach this error?

I think you can provide a custom lookup function to net.connect that calls the callback with an invalid addressType to trigger this. Something like

net.connect({ host: 'foo.bar' port: 80, lookup: (host, dnsopts, cb) => cb(null, '127.0.0.1', 100) // 100 is not a valid addressType })

Also we probably need to invent a error code for this?

Thanks. I guess there is something broken to fix first, because this is what I get with your example:

$ node test/parallel/test-net-connect-options-invalid-address-type.js node[15295]: ../src/tcp_wrap.cc:282:static void node::TCPWrap::Connect(const v8::FunctionCallbackInfo<v8::Value>&): Assertion `args[2]->IsUint32()' failed. 1: node::Abort() [node] 2: 0x8cebdb [node] 3: node::TCPWrap::Connect(v8::FunctionCallbackInfo<v8::Value> const&) [node] 4: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&)) [node] 5: 0xb1444c [node] 6: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*) [node] 7: 0x1f18982042fd [1] 15295 abort (core dumped) node test/parallel/test-net-connect-options-invalid-address-type.js

This happens because localAddress and localPort are undefined so we end up in another path:
https://github.com/targos/node/blob/244cdb1e033706756c0296d344cca5702dea261b/lib/net.js#L965-L971

targos · 2018-03-15T16:51:43Z

I added a code for the net.connect error.

targos · 2018-03-17T10:43:51Z

/cc @jasnell @BridgeAR

BridgeAR

LGTM

BridgeAR · 2018-03-17T10:58:56Z

lib/.eslintrc.yaml

+  no-restricted-syntax:
+    - error
+    - selector: "NewExpression[callee.name=/Error$/]:not([callee.name=/^(AssertionError|NghttpError)$/])"
+      message: "Use an error exported by the internal/errors module"


I have a doubt now: does this override the no-restricted-syntax rule from our main config? If so, can we merge them somehow?

Oh, yes, it will. When looking at this I did not see that it was only for ./lib. Activating it for the hole code base is probably not the best idea though. We could of course copy the rules that are currently in the main file but that is also not ideal...

Is there any possibility to combine this rule? That would be really great.

@not-an-aardvark Do you have a suggestion? We would like to add a new restricted syntax to lib while not overriding the other ones configured in the main config

Unfortunately, there's not a good way to do that at the moment. As a workaround, you could copy-paste the configuration from the parent directory, add the new entry, and put the resulting config in lib/.eslintrc.yaml. This would have the desired effect, but it could cause the two configs to get out of sync if someone updates .eslintrc.yaml later on and forgets to update the copied version in lib/.eslintrc.yaml.

There is some discussion on improving this in eslint/eslint#9192.

Thank you. I copied the config and put a comment explaining that it should be kept in sync.

BridgeAR · 2018-03-17T11:00:52Z

lib/fs.js

@@ -423,6 +423,9 @@ function tryCreateBuffer(size, fd, isUserFd) {
  var threw = true;
  var buffer;
  try {
+    if (size > kMaxLength) {
+      throw new ERR_FS_FILE_TOO_LARGE(size);
+    }
    buffer = Buffer.allocUnsafe(size);


Since we now check for kMaxLength: is it still possible for the alloc to throw an error? If not, then the try / catch should be obsolete.

I think it can still throw if there is not enough memory available to construct the buffer?

Ah, yes, I thought it might crash in that case but it will actually throw Array buffer allocation failed.

targos · 2018-03-17T19:29:11Z

blocking until #19415 lands because I think it will affect the 3rd commit

BridgeAR · 2018-03-20T12:39:48Z

#19415 landed, so I removed the blocked label.

joyeecheung · 2018-03-20T14:10:19Z

doc/api/errors.md

@@ -1301,6 +1307,11 @@ multiple of the element size.
 While calling `napi_create_typedarray()`, `(length * size_of_element) +
 byte_offset` was larger than the length of given `buffer`.

+<a id="ERR_NET_INVALID_ADDRESS_TYPE"></a>
+### ERR_NET_INVALID_ADDRESS_TYPE


There is an existing ERR_INVALID_ADDRESS_FAMILY that should serve the same purpose, if we want to create an error specific to the DNS lookup function, can we use another name specific to that to avoid confusion? For example, ERR_NET_INVALID_LOOKUP?

Yes, thanks. I meant to change this after #19415.

After this commit, all errors thrown from JS code in lib have an error code.

This adds a rule that forbids the use of native Error constructors in the `lib` directory. This is to encourage use of the `internal/errors` mechanism. The rule is disabled for errors that are not created with the `internal/errors` module but are still assigned an error code.

targos · 2018-03-21T06:54:58Z

lib/net.js

@@ -935,7 +936,7 @@ function internalConnect(
      localAddress = localAddress || '::';
      err = self._handle.bind6(localAddress, localPort);
    } else {
-      self.destroy(new TypeError('Invalid addressType: ' + addressType));
+      self.destroy(new ERR_INVALID_ADDRESS_FAMILY(addressType));


I think this is unreachable now, so I removed the test. I'm going to replace it by a CHECK when #19503 is fixed.

targos · 2018-03-21T06:55:47Z

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

targos · 2018-03-21T10:18:05Z

CI is green. @BridgeAR @jasnell PTAL. The changes are a bit different now.

BridgeAR

LGTM

BridgeAR · 2018-03-21T11:06:45Z

test/sequential/test-inspector-port-cluster.js

@@ -287,9 +288,9 @@ function masterProcessMain() {

        cluster.setupMaster(clusterSettings);

-        assert.throws(() => {
+        common.expectsError(() => {


As a recommendation for the future: assert.throws is actually becoming more and more powerful and using it is probably better than using common.expectsError (even though that is still useful as a callback function).

What should I do to make it work with assert.throws?

This is what I get:

AssertionError [ERR_ASSERTION]: type: expected [Function: RangeError], not undefined at masterProcessMain (/home/mzasso/git/nodejs/node/test/sequential/test-inspector-port-cluster.js:238:16) at Object.<anonymous> (/home/mzasso/git/nodejs/node/test/sequential/test-inspector-port-cluster.js:347:3)

Right now there are some special handled properties in common.expectsError that do not exist in assert.throws. One is the message property: it is either a strict equal comparison or you can use a regular expression. Using regular expressions is not (yet) possible (I am still considering adding options to accept those as well) with assert.throws.
The other difference is the type property: it will actually check for the specific error type. That is not possible at all with assert.throws and instead you can check for the name property.

After this commit, all errors thrown from JS code in lib have an error code. PR-URL: #19373 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

This adds a rule that forbids the use of native Error constructors in the `lib` directory. This is to encourage use of the `internal/errors` mechanism. The rule is disabled for errors that are not created with the `internal/errors` module but are still assigned an error code. PR-URL: #19373 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

targos · 2018-03-21T19:20:11Z

Landed in fddcd62...6a9f049

targos requested a review from joyeecheung March 15, 2018 15:21

nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Mar 15, 2018

targos commented Mar 15, 2018

View reviewed changes

targos added semver-major PRs that contain breaking changes and should be released in the next major version. errors Issues and PRs related to JavaScript errors originated in Node.js core. labels Mar 15, 2018

BridgeAR approved these changes Mar 17, 2018

View reviewed changes

jasnell approved these changes Mar 17, 2018

View reviewed changes

targos added the blocked PRs that are blocked by other issues or PRs. label Mar 17, 2018

BridgeAR removed the blocked PRs that are blocked by other issues or PRs. label Mar 20, 2018

targos force-pushed the finish-lib-error-codes branch from 615de82 to 4c9274d Compare March 20, 2018 13:14

joyeecheung reviewed Mar 20, 2018

View reviewed changes

targos added 2 commits March 21, 2018 07:44

fs,cluster,net: assign error codes to remaining errors

6337ec4

After this commit, all errors thrown from JS code in lib have an error code.

targos force-pushed the finish-lib-error-codes branch from 4c9274d to 957c493 Compare March 21, 2018 06:52

targos commented Mar 21, 2018

View reviewed changes

BridgeAR approved these changes Mar 21, 2018

View reviewed changes

targos closed this Mar 21, 2018

targos deleted the finish-lib-error-codes branch March 21, 2018 19:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: finish assigning codes to errors thrown from JS #19373

lib: finish assigning codes to errors thrown from JS #19373

targos commented Mar 15, 2018

targos Mar 15, 2018

joyeecheung Mar 15, 2018

joyeecheung Mar 15, 2018

targos Mar 15, 2018

targos Mar 15, 2018

targos commented Mar 15, 2018

targos commented Mar 17, 2018

BridgeAR left a comment

BridgeAR Mar 17, 2018

targos Mar 17, 2018

BridgeAR Mar 17, 2018

targos Mar 20, 2018

not-an-aardvark Mar 20, 2018

targos Mar 21, 2018

BridgeAR Mar 17, 2018

targos Mar 17, 2018

BridgeAR Mar 17, 2018

targos commented Mar 17, 2018

BridgeAR commented Mar 20, 2018

joyeecheung Mar 20, 2018 •

edited

Loading

targos Mar 21, 2018

targos Mar 21, 2018

targos commented Mar 21, 2018

targos commented Mar 21, 2018

BridgeAR left a comment

BridgeAR Mar 21, 2018

targos Mar 21, 2018

BridgeAR Mar 21, 2018

targos commented Mar 21, 2018

lib: finish assigning codes to errors thrown from JS #19373

lib: finish assigning codes to errors thrown from JS #19373

Conversation

targos commented Mar 15, 2018

Checklist

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

targos commented Mar 15, 2018

targos commented Mar 17, 2018

BridgeAR left a 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

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

targos commented Mar 17, 2018

BridgeAR commented Mar 20, 2018

joyeecheung Mar 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

targos commented Mar 21, 2018

targos commented Mar 21, 2018

BridgeAR left a 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

targos commented Mar 21, 2018

joyeecheung Mar 20, 2018 •

edited

Loading