errors, process: port internal/process errors to internal/errors #11294

jasnell · 2017-02-10T16:57:04Z

Assign codes to the handful of errors reported by internal/process/*.js
Include documentation for the new error codes
Improve error messages
Improve test coverage for process.nextTick

Semver-major because this updates specific error messages and converts errors over to use the new internal/errors.js mechanism.

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, process

joyeecheung · 2017-02-11T10:48:55Z

doc/api/errors.md

+<a id="ERR_INVALID_ARG_TYPE"></a>
+### ERR_INVALID_ARG_TYPE
+
+The `'ERR_INVALID_ARG_TYPE'` error code is used generically to identify that


(Not sure which PR is the right place to ask, this one seems the oldest so I'll ask here)

Which one does the "type" here cover:

Primitive types (i.e. typeof types, doesn't differentiate Date and RegExp and stuff)

Builtin type tags(i.e. results of Object.prototype.toString.call(), differentiates Date and RegExp)

Class mismatch(i.e. instanceof types, differentiates Date and RegExp)

Also, some PRs use the typeof types as the expected type(e.g. "function"), some uses the class name/type tag(e.g. "Object"), we probably need to be a little bit consistent on this one.

This is not handled very consistently throughout the Node.js source. Sometimes the value itself is passed in, sometimes the typeof is used, etc. The goal here would be to start getting some consistency but it's hard to nail down exactly what that should be.

Got it, so we should focus on migrating the errors to use the new system with a reasonable code right now, and deal with message later, because after the migration it would be easier to change them anyway?

joyeecheung · 2017-02-11T11:09:11Z

lib/internal/errors.js

+      msg += `one of type ${expected.slice(0, len - 1).join(', ')}, or ` +
+             expected[len - 1];
+    } else {
+      msg += `type ${String(expected[0])}`;


String(..) seems unnecessary here?

+1. It's already cast on line 103

jasnell · 2017-02-14T15:48:54Z

@nodejs/ctc ... as a semver major this needs some review and signoff

jasnell · 2017-02-14T15:49:41Z

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

bougarfaoui

@jasnell in the invalidArgType : what if the actual arg is null , the result will be . Received type object

jasnell · 2017-02-14T17:45:42Z

Sigh, good point. I often forget that typeof null === 'object' which is really quite odd.

joyeecheung · 2017-02-14T18:05:14Z

lib/internal/errors.js

+E('ERR_INVALID_CALLBACK', 'callback must be a function');
+E('ERR_STDERR_CLOSE', 'process.stderr cannot be closed');
+E('ERR_STDOUT_CLOSE', 'process.stdout cannot be closed');
+E('ERR_UNK_STDIN_TYPE', 'Unknown stdin file type');


#11298 spells the full UNKNOWN, this should do the same (TBH I can not understand what UNK stands for at first glance...).

jasnell · 2017-02-16T20:24:47Z

@nodejs/ctc ... PTAL... I'd like to get this landed so we can start getting through the others that are starting to stack up

jasnell · 2017-03-06T23:38:00Z

ping @evanlucas, @addaleax, @cjihrig and @mhdawson

evanlucas · 2017-03-27T20:46:23Z

As I mentioned somewhere else (not sure where, there have been a bunch of these pull requests), I'm not thrilled with what the stack trace looks like after this change.

jasnell · 2017-03-27T21:09:07Z

Which part are you unhappy with?

evanlucas · 2017-03-27T21:24:37Z

$ ./node --expose-internals
> new errors.Error('ERR_ASSERTION', 'something')
{ Error[ERR_ASSERTION]: something
    at repl:1:1
    at ContextifyScript.Script.runInThisContext (vm.js:44:33)
    at REPLServer.defaultEval (repl.js:239:29)
    at bound (domain.js:301:14)
    at REPLServer.runBound [as eval] (domain.js:314:12)
    at REPLServer.onLine (repl.js:433:10)
    at emitOne (events.js:120:20)
    at REPLServer.emit (events.js:210:7)
    at REPLServer.Interface._onLine (readline.js:262:10)
    at REPLServer.Interface._line (readline.js:611:8) [Symbol(code)]: 'ERR_ASSERTION' }

I just find it a little harder to read Error[ERR_ASSERTION]: in particular. As opposed to Error:

jasnell · 2017-03-27T21:29:44Z

Do you have an alternative suggestion? Displaying the error code in the output is a significant reason why this allows us to avoid treating changes in the error message as semver-major... That is, it gives the user a stable, non-changing key they can use to search for information on the specific error. Putting the [ERR_ASSERTION] on the other side of the : requires changing the actual error message.

Trott · 2017-03-28T18:48:39Z

As I mentioned somewhere else (not sure where, there have been a bunch of these pull requests), I'm not thrilled with what the stack trace looks like after this change.

I can't find it either, but I chimed in on that too. Error[ERR_ASSERTION] looks like an array value. At an absolute minimum, please put a space in there: Error [ERR_ASSERTION]:

If @evanlucas's output is accurate, the { and } surrounding the output should also be removed. They suggest the contents are an object or JSON.

jasnell · 2017-03-28T19:01:00Z

The { and } is an artifact of util.inspect() rendering, not the internal errors piece.... for instance, do

> var m = new Error("test")
undefined
> m.code = 1
1
> m
{ Error: test
    at repl:1:9
    at ContextifyScript.Script.runInThisContext (vm.js:44:33)
    at REPLServer.defaultEval (repl.js:239:29)
    at bound (domain.js:301:14)
    at REPLServer.runBound [as eval] (domain.js:314:12)
    at REPLServer.onLine (repl.js:433:10)
    at emitOne (events.js:120:20)
    at REPLServer.emit (events.js:210:7)
    at REPLServer.Interface._onLine (readline.js:262:10)
    at REPLServer.Interface._line (readline.js:611:8) code: 1 }

I will open a PR that adds the space before the opening [

gibfahn · 2017-03-28T21:49:11Z

I will open a PR that adds the space before the opening [

PR: #12099

jasnell · 2017-04-05T22:08:01Z

Ping @nodejs/ctc ... I'd like to get this landed. Before the other errors ones get landed.

Trott · 2017-04-05T23:40:51Z

@jasnell This needs at least one more CTC approval before landing. Maybe you can horse-trade with @trevnorris: You review his async-hooks PR that he's not getting enough reviews on and in return he reviews this.

I'm kidding. Or am I?

jasnell · 2017-04-05T23:42:24Z

I'd review the async-hooks had I the time. It's a large pr. I can take a look next week. There are quite a few other prs pending on this one, all semver major, that I would like to get landed

evanlucas · 2017-04-07T13:10:55Z

lib/internal/errors.js

+    var len = expected.length;
+    expected = expected.map((i) => String(i));
+    if (len > 1) {
+      msg += `one of type ${expected.slice(0, len - 1).join(', ')}, or ` +


Maybe break out the expected.slice().join() into a variable? It is getting a little hard to read imo.

evanlucas · 2017-04-07T13:12:28Z

lib/internal/errors.js

+  } else {
+    msg += `of type ${String(expected)}`;
+  }
+  if (arguments.length >= 3) {


With only the first three arguments being used, maybe make this if (arguments.length === 3) {?

Feel free to disregard

jasnell · 2017-04-19T16:44:12Z

@evanlucas ... do you still object to this?

evanlucas · 2017-04-19T16:56:12Z

@jasnell my review was not an objection. I think I'm onboard with this now.

jasnell · 2017-04-19T16:57:36Z

Awesome, ok. Can I ask you to switch the "requested changes" to an approval or LGTM so I can get this landed. As a semver-major I need two CTC signoffs :-)

* Assign codes to the handful of errors reported by internal/process/*.js * Include documentation for the new error codes * Improve error messages * Improve test coverage for process.nextTick Ref: nodejs#11273

jasnell · 2017-04-20T16:14:54Z

Final CI before landing: https://ci.nodejs.org/job/node-test-pull-request/7553/
CIGTM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/720/

jasnell · 2017-04-20T18:32:18Z

CI failures are unrelated. Failures in CITGM are not specific to this PR.

* Assign codes to the handful of errors reported by internal/process/*.js * Include documentation for the new error codes * Improve error messages * Improve test coverage for process.nextTick PR-URL: #11294 Ref: #11273 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>

jasnell · 2017-04-20T18:57:06Z

Landed in e75bc87

jasnell added the semver-major PRs that contain breaking changes and should be released in the next major version. label Feb 10, 2017

nodejs-github-bot added the errors Issues and PRs related to JavaScript errors originated in Node.js core. label Feb 10, 2017

jasnell mentioned this pull request Feb 10, 2017

Tracking Issue: Migrate errors to internal/errors.js #11273

Closed

80 tasks

mscdex added the process Issues and PRs related to the process subsystem. label Feb 10, 2017

joyeecheung reviewed Feb 11, 2017

View reviewed changes

no23reason mentioned this pull request Feb 13, 2017

errors, repl: migrate to use internal/errors.js #11347

Closed

4 tasks

jasnell force-pushed the internal-errors-1 branch from 18670e4 to e24a450 Compare February 14, 2017 15:46

jasnell requested review from evanlucas, addaleax, cjihrig and mhdawson February 14, 2017 15:50

bougarfaoui suggested changes Feb 14, 2017

View reviewed changes

jasnell force-pushed the internal-errors-1 branch from e24a450 to 1727832 Compare February 14, 2017 17:56

joyeecheung reviewed Feb 14, 2017

View reviewed changes

jasnell force-pushed the internal-errors-1 branch 3 times, most recently from 7f1def6 to 86c7993 Compare February 16, 2017 20:24

rauno56 mentioned this pull request Feb 26, 2017

WIP: module,errors: port module to internal/errors #11565

Closed

4 tasks

jasnell force-pushed the internal-errors-1 branch from 86c7993 to 9d3c44f Compare March 6, 2017 23:35

sousandrei mentioned this pull request Mar 8, 2017

dns, net, internal/net: migrate to internals/error #11738

Closed

4 tasks

Trott mentioned this pull request Apr 3, 2017

Node.js Foundation Core Technical Committee (CTC) Meeting 2017-04-05 nodejs/CTC#93

Closed

evanlucas suggested changes Apr 7, 2017

View reviewed changes

Trott mentioned this pull request Apr 9, 2017

Node.js Foundation Core Technical Committee (CTC) Meeting 2017-04-12 nodejs/CTC#98

Closed

refack force-pushed the master branch from 16073c0 to fbe946b Compare April 14, 2017 04:11

Trott mentioned this pull request Apr 17, 2017

Node.js Foundation Core Technical Committee (CTC) Meeting 2017-04-19 nodejs/CTC#105

Closed

evanlucas approved these changes Apr 20, 2017

View reviewed changes

jasnell force-pushed the internal-errors-1 branch from 6ddc9a2 to 626332f Compare April 20, 2017 15:57

errors: port internal/process errors to internal/errors

8dbce73

* Assign codes to the handful of errors reported by internal/process/*.js * Include documentation for the new error codes * Improve error messages * Improve test coverage for process.nextTick Ref: nodejs#11273

jasnell force-pushed the internal-errors-1 branch from 626332f to 8dbce73 Compare April 20, 2017 15:58

jasnell closed this Apr 20, 2017

Trott removed the ctc-review label Apr 24, 2017

jasnell mentioned this pull request May 11, 2017

8.0.0 Release Proposal #12220

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

errors, process: port internal/process errors to internal/errors #11294

errors, process: port internal/process errors to internal/errors #11294

jasnell commented Feb 10, 2017

joyeecheung Feb 11, 2017

joyeecheung Feb 11, 2017

jasnell Feb 14, 2017

joyeecheung Feb 14, 2017

joyeecheung Feb 11, 2017

targos Feb 11, 2017

jasnell commented Feb 14, 2017

jasnell commented Feb 14, 2017

bougarfaoui left a comment

jasnell commented Feb 14, 2017

joyeecheung Feb 14, 2017

jasnell commented Feb 16, 2017

jasnell commented Mar 6, 2017

evanlucas commented Mar 27, 2017

jasnell commented Mar 27, 2017

evanlucas commented Mar 27, 2017

jasnell commented Mar 27, 2017

Trott commented Mar 28, 2017

jasnell commented Mar 28, 2017

gibfahn commented Mar 28, 2017 •

edited

Loading

jasnell commented Apr 5, 2017

Trott commented Apr 5, 2017

jasnell commented Apr 5, 2017

evanlucas Apr 7, 2017

evanlucas Apr 7, 2017

jasnell commented Apr 19, 2017

evanlucas commented Apr 19, 2017

jasnell commented Apr 19, 2017

jasnell commented Apr 20, 2017

jasnell commented Apr 20, 2017

jasnell commented Apr 20, 2017

errors, process: port internal/process errors to internal/errors #11294

errors, process: port internal/process errors to internal/errors #11294

Conversation

jasnell commented Feb 10, 2017

Checklist

Affected core subsystem(s)

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 commented Feb 14, 2017

jasnell commented Feb 14, 2017

bougarfaoui left a comment

Choose a reason for hiding this comment

jasnell commented Feb 14, 2017

Choose a reason for hiding this comment

jasnell commented Feb 16, 2017

jasnell commented Mar 6, 2017

evanlucas commented Mar 27, 2017

jasnell commented Mar 27, 2017

evanlucas commented Mar 27, 2017

jasnell commented Mar 27, 2017

Trott commented Mar 28, 2017

jasnell commented Mar 28, 2017

gibfahn commented Mar 28, 2017 • edited Loading

jasnell commented Apr 5, 2017

Trott commented Apr 5, 2017

jasnell commented Apr 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell commented Apr 19, 2017

evanlucas commented Apr 19, 2017

jasnell commented Apr 19, 2017

jasnell commented Apr 20, 2017

jasnell commented Apr 20, 2017

jasnell commented Apr 20, 2017

gibfahn commented Mar 28, 2017 •

edited

Loading