errors: improve error types #13857

BridgeAR · 2017-06-21T19:08:06Z

While working on the internal errors a bit more I realized that there are multiple error types not yet documented and some have minor shortcomings. Here I mainly just document the missing ones. All changes are summarized in the commit messages.

I feel the change to always rely on util.format for the arguments passed to error types might actually be the wrong way and instead we should always use a function. The latter would likely be a tad faster and we could also validate the args in that case. Relying on util.format is nicer to read though and shorter.

Besides that I want to kick of a short discussion about the error types in general. I know I'm late to the party but maybe my two cents are still worth the effort:
For me the error codes are most useful when a bit more abstract and if they cover a range of more specific errors and are not bound to exactly one error (with exceptions) (i.e. a single bound error type with a optional lower and upper bound instead of a individual bounds error each time).
That way the user can handle some generic ones in his code if wanted and necessary. I think handling lots of very specific ones is often not doable or as useful.
So if there's still a possibility to do this, I would say let's try to always find more generic approaches and go so far to consolidate a few already existing error codes. As some were not yet documented, it's easier with them but all others would have to be changed as semver major and I'm not sure if it's worth the effort in that case.
Here's my view on what could still be improved:

ERR_INVALID_FD not yet documented and this could easily be a more generic one
ERR_INVALID_CALLBACK could be replaced with ERR_INVALID_ARG_TYPE. That essentially does the same, just not as specific to callbacks. If you want to outline the callbacks, it should stay as it is.
ERR_INVALID_REPL_EVAL_CONFIG could be generic with something similar to: "Receive two types that may not be set at the same time."
ERR_STDERR_CLOSE and ERR_STDOUT_CLOSE could be consolidated to ERR_STD_CLOSE
ERR_UNKNOWN_STREAM_TYPE and ERR_STDIN_STREAM_TYPE could be consolidated to ERR_UNKNOWN_UV_TYPE
ERR_SOCKET_BAD_PORT I think it would be better to use a generic range / bound error instead
ERR_SOCKET_BAD_TYPE could be converted to a more generic approach with predefined allowed entries.

Besides that it would recommend to try to limit adding new error codes to the bare minimum.

Summoning @jasnell

If all or some of my suggestions find acclaim, I'd open another PR to address these points.

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)

errors,dgram,process,util,v8,http

mscdex · 2017-06-21T19:13:31Z

Marking as semver-major due to error message change(s).

mscdex · 2017-06-21T19:17:13Z

lib/internal/errors.js

 E('ERR_TRANSFORM_WITH_LENGTH_0',
  'Calling transform done when ws.length != 0');
 E('ERR_HTTP_TRAILER_INVALID',
  'Trailers are invalid with this transfer encoding');
-E('ERR_UNKNOWN_BUILTIN_MODULE', (id) => `No such built-in module: ${id}`);


Instead of removing this, perhaps it should instead be used to replace the manual/old Error creation in lib/internal/bootstrap_node.js ?

I didn't do that because of the comment right above that error:

// Model the error off the internal/errors.js model, but // do not use that module given that it could actually be // the one causing the error if there's a bug in Node.js

jasnell · 2017-06-21T21:53:31Z

doc/api/errors.md

+Used when a callback is called more than once.
+
+<a id="ERR_ASSERTION"></a>
+### ERR_ASSERTION


These should be in alphabetical order.

jasnell · 2017-06-21T21:53:53Z

doc/api/errors.md

+<a id="ERR_CPU_USAGE"></a>
+### ERR_CPU_USAGE
+
+Used when the native call from process.cpuUsage can't be processed properly.


nit: please avoid the use of contractions... s/can't/cannot

nit: process.cpuUsage is code and should probably be process.cpuUsage

jasnell · 2017-06-21T21:54:19Z

doc/api/errors.md

+### ERR_HTTP_HEADERS_SENT
+
+Used in case the headers were already sent and another attempt is made to add
+more headers.


Used when headers have already been sent and another ...

jasnell · 2017-06-21T21:54:47Z

doc/api/errors.md

+<a id="ERR_INVALID_CHAR"></a>
+### ERR_INVALID_CHAR
+
+Used in e.g. http if invalid characters are detected in headers.


Used when invalid characters are detected in headers.

jasnell · 2017-06-21T21:55:59Z

doc/api/errors.md

+<a id="ERR_HTTP_INVALID_STATUS_CODE"></a>
+### ERR_HTTP_INVALID_STATUS_CODE
+
+Used for nonexisting status codes.


Not quite. non-existing would be non-registered. The code actually allows using valid but not-registered status codes (e.g. I could send 999). The error is thrown when the status code is < 100 or > 999

I am aware that the validation is less strict but personally I would keep the description like that as it feels more intuitive to me. With the range I would wonder why that range was chosen. As far as I know the current bounds were chosen to be "somewhat" near the regular status codes.

I do see your point about non-existing as well though.

jasnell · 2017-06-21T21:56:17Z

doc/api/errors.md

+<a id="ERR_INVALID_ARRAY_LENGTH"></a>
+### ERR_INVALID_ARRAY_LENGTH
+
+Used in case a array is not of the expected length or in a valid range.


Used when an Array is not ...

jasnell · 2017-06-21T21:56:38Z

doc/api/errors.md

+<a id="ERR_INVALID_FD"></a>
+### ERR_INVALID_FD
+
+Used in case a FD entry is not valid (i.e. negative).


Used when a file descriptor ('fd') is not valid.

jasnell · 2017-06-21T21:57:02Z

doc/api/errors.md

+<a id="ERR_PARSE_HISTORY_DATA"></a>
+### ERR_PARSE_HISTORY_DATA
+
+Used in the `repl` if you use the old history file and an error occurred while


Please avoid the use of informal personal pronouns like you in the docs

if the old history file is used

jasnell · 2017-06-21T21:58:11Z

doc/api/errors.md

+### ERR_HTTP_TRAILER_INVALID
+
+Used when the `Trailer` header is set even though the encoding does not support
+that.


this is misleading. It's not the encoding that matters, it is the transfer encoding ...

jasnell · 2017-06-21T21:58:50Z

doc/api/errors.md

+<a id="ERR_V8BREAKITERATOR"></a>
+### ERR_V8BREAKITERATOR
+
+Used if the full ICU data is not installed.


Used when the V8 BreakIterator API is used but the full ICU data set is not installed.

jasnell

Thank you for working on this. Left some comments.

benjamingr · 2017-06-21T23:04:39Z

doc/api/errors.md

+<a id="ERR_MULTIPLE_CALLBACK"></a>
+### ERR_MULTIPLE_CALLBACK
+
+Used when a callback is called more than once.


nit: I'm not sure this is indicative enough for people new to node.

benjamingr · 2017-06-21T23:06:41Z

doc/api/errors.md

+<a id="ERR_TRANSFORM_ALREADY_TRANSFORMING"></a>
+### ERR_TRANSFORM_ALREADY_TRANSFORMING
+
+Used when stream transform done is called even though it is still in process.


I'm not sure this is indicative enough.

benjamingr · 2017-06-21T23:09:37Z

Nice work, I think some examples for the errors would be really nice but I'm fine with landing it (after the requested fixes) without them and iterating.

BridgeAR · 2017-06-21T23:39:57Z

Note: I explicitly do not document ERR_INVALID_REPL_HISTORY as it is not yet exposed to the users and I have another PR open that will fix that. I also did not document ERR_TRANSFORM_WITH_LENGTH_0 and ERR_TRANSFORM_ALREADY_TRANSFORMING. There is no test for these at the moment and I think it would be better to document them in another PR / investigate what to do with those.

BridgeAR · 2017-06-22T00:15:25Z

Comments addressed. @jasnell would you be so kind and just drop a comment about my suggestions in the PR description? I could open a separate issue for these if preferred.

BridgeAR · 2017-06-22T00:16:35Z

test/parallel/test-child-process-fork-regr-gh-2847.js

-            throw err;
-          }
+        if (err && err.message !== 'Channel closed') {
+          throw err;


Note: the thrown error should never have that error code ECONNREFUSED as far as I can see.

#8950
I'll run a stress test

jasnell

Generally LGTM with one nit

mhdawson

LGTM. Thanks for all the hard work to refine/improve the errors.

1) Add missing lazy assert call 2) Remove obsolete error type 3) Name undocumented error type more appropriate 4) Consolidate error type style (rely on util.format instead of using a function) 5) Uppercase the first letter from error messages 6) Improve some internal error parameters

BridgeAR · 2017-06-26T21:03:38Z

Nit addressed and rebased

refack

Need to test
test/parallel/test-child-process-fork-regr-gh-2847.js

refack · 2017-06-26T23:07:35Z

test/parallel/test-child-process-fork-regr-gh-2847.js

-            throw err;
-          }
+        if (err && err.message !== 'Channel closed') {
+          throw err;


#8950
I'll run a stress test

refack · 2017-06-26T23:14:12Z

Stress AIX: https://ci.nodejs.org/job/node-stress-single-test/1307/nodes=aix61-ppc64/
Stress freeBSD: https://ci.nodejs.org/job/node-stress-single-test/1308/nodes=freebsd10-64/

refack

Stress passed

refack · 2017-06-27T01:46:01Z

Pre land CI: https://ci.nodejs.org/job/node-test-commit/10778/

Trott · 2017-06-27T05:56:08Z

After 4 hours of stalled build on the Raspberry Pi devices, I canceled the CI run on that platform. The devices need attention, I'm afraid. This will either have to land without a CI run on the Raspberry Pi's (which I think is probably OK) or else wait for the CI builds to start working again (shouldn't be too long before that happens, Rod mentioned in IRC he was looking at it).

tniessen · 2017-06-28T13:14:01Z

CI on arm: https://ci.nodejs.org/job/node-test-commit-arm-fanned/9641/

Other failures appear to be unrelated / flaky tests.

mhdawson · 2017-06-28T16:56:28Z

Given this: nodejs/build#774 (comment) I think its probably ok to land without arm results.

PR-URL: #13857 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

1) Add missing lazy assert call 2) Remove obsolete error type 3) Name undocumented error type more appropriate 4) Consolidate error type style (rely on util.format instead of using a function) 5) Uppercase the first letter from error messages 6) Improve some internal error parameters PR-URL: #13857 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

PR-URL: #13857 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

tniessen · 2017-06-28T18:05:02Z

Landed in 8ca9338 ... 2fa2a60, thank you! 🎉 Post-merge (partial) CI: https://ci.nodejs.org/job/node-test-commit-linuxone/6913/

PR-URL: nodejs#13857 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Backport-PR-URL: #22380 PR-URL: #13857 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

nodejs-github-bot added dont-land-on-v4.x errors Issues and PRs related to JavaScript errors originated in Node.js core. lib / src Issues and PRs related to general changes in the lib or src directory. whatwg-url Issues and PRs related to the WHATWG URL implementation. labels Jun 21, 2017

mscdex added the semver-major PRs that contain breaking changes and should be released in the next major version. label Jun 21, 2017

mscdex reviewed Jun 21, 2017

View reviewed changes

jasnell reviewed Jun 21, 2017

View reviewed changes

jasnell requested changes Jun 21, 2017

View reviewed changes

benjamingr reviewed Jun 21, 2017

View reviewed changes

BridgeAR force-pushed the improve-error-types branch from 7726155 to f0a6b15 Compare June 21, 2017 23:15

BridgeAR force-pushed the improve-error-types branch 2 times, most recently from 85920fb to 885a725 Compare June 21, 2017 23:58

BridgeAR changed the title ~~errors: improve error types WIP~~ errors: improve error types Jun 22, 2017

BridgeAR force-pushed the improve-error-types branch from 885a725 to 33e1f36 Compare June 22, 2017 00:14

BridgeAR commented Jun 22, 2017

View reviewed changes

jasnell approved these changes Jun 26, 2017

View reviewed changes

mhdawson approved these changes Jun 26, 2017

View reviewed changes

BridgeAR added 5 commits June 26, 2017 23:02

doc: document missing error types

6dc6d1a

dgram,process,util: refactor Error to TypeError

13a1f13

v8: add new to the throw statement

3e619ee

http: simplify if statement

eff06a3

BridgeAR force-pushed the improve-error-types branch from d7a25e3 to eff06a3 Compare June 26, 2017 21:03

refack suggested changes Jun 26, 2017

View reviewed changes

refack approved these changes Jun 27, 2017

View reviewed changes

refack mentioned this pull request Jun 27, 2017

now: node-test-binary-arm doesn't finish nodejs/build#774

Closed

cjihrig approved these changes Jun 27, 2017

View reviewed changes

tniessen closed this Jun 28, 2017

jasnell mentioned this pull request Oct 30, 2017

Proposal: 2017-10-31, Version 9.0.0 (Current) #15135

Merged

MylesBorins mentioned this pull request Sep 6, 2018

v8.12.0 proposal #21593

Merged

BridgeAR deleted the improve-error-types branch April 1, 2019 23:36

errors: improve error types #13857

errors: improve error types #13857

Conversation

BridgeAR commented Jun 21, 2017 • edited Loading

Checklist

Affected core subsystem(s)

mscdex commented Jun 21, 2017

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

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

jasnell Jun 21, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benjamingr commented Jun 21, 2017

BridgeAR commented Jun 21, 2017 • edited Loading

BridgeAR commented Jun 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell left a comment

Choose a reason for hiding this comment

mhdawson left a comment

Choose a reason for hiding this comment

BridgeAR commented Jun 26, 2017

refack left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented Jun 26, 2017

refack left a comment

Choose a reason for hiding this comment

refack commented Jun 27, 2017

Trott commented Jun 27, 2017

tniessen commented Jun 28, 2017 • edited Loading

mhdawson commented Jun 28, 2017

tniessen commented Jun 28, 2017

BridgeAR commented Jun 21, 2017 •

edited

Loading

jasnell Jun 21, 2017 •

edited

Loading

BridgeAR commented Jun 21, 2017 •

edited

Loading

tniessen commented Jun 28, 2017 •

edited

Loading