internal: use internal/errors #13829

BridgeAR · 2017-06-20T21:53:18Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Affected core subsystem(s)

internal

BridgeAR · 2017-06-20T21:53:46Z

lib/internal/fs.js

@@ -52,7 +53,7 @@ function stringToFlags(flag) {
    case 'xa+': return O_APPEND | O_CREAT | O_RDWR | O_EXCL;
  }

-  throw new Error('Unknown file open flag: ' + flag);
+  throw new errors.Error('ERR_INVALID_OPT_VALUE', 'flag', flag);


Shouldn't these be TypeErrors?

I agree. X 2

refack · 2017-06-20T21:54:39Z

~~Ref: #13730~~
Oh NM. I thought it was your other idea.

refack

Good, but needs a few tweaks

refack · 2017-06-20T21:58:06Z

test/parallel/test-child-process-constructor.js

@@ -12,7 +12,7 @@ assert.strictEqual(typeof ChildProcess, 'function');
  [undefined, null, 'foo', 0, 1, NaN, true, false].forEach((options) => {
    assert.throws(() => {
      child.spawn(options);
-    }, /^TypeError: "options" must be an object$/);
+    }, common.expectsError({ code: 'ERR_INVALID_ARG_TYPE' }));


{type} should be added.
{message} would be nice.

refack · 2017-06-20T21:59:26Z

lib/internal/util.js

@@ -204,14 +204,16 @@ const kCustomPromisifyArgsSymbol = Symbol('customPromisifyArgs');
 function promisify(orig) {
  if (typeof orig !== 'function') {
    const errors = require('internal/errors');
-    throw new errors.TypeError('ERR_INVALID_ARG_TYPE', 'original', 'function');
+    throw new errors.TypeError('ERR_INVALID_ARG_TYPE', 'orig', 'function');


The other way around (rename the formal parameter) - https://nodejs.org/api/util.html#util_util_promisify_original

refack · 2017-06-20T22:00:22Z

lib/internal/fs.js

@@ -52,7 +53,7 @@ function stringToFlags(flag) {
    case 'xa+': return O_APPEND | O_CREAT | O_RDWR | O_EXCL;
  }

-  throw new Error('Unknown file open flag: ' + flag);
+  throw new errors.Error('ERR_INVALID_OPT_VALUE', 'flag', flag);


I agree. X 2

BridgeAR · 2017-06-21T00:36:39Z

Comments addressed

refack · 2017-06-21T02:40:09Z

Better, but all common.expectsError need {type} (since before the RegEx did assert the Type as part of the message).

BridgeAR · 2017-06-21T12:51:52Z

Addressed and rebased

refack

💯

refack · 2017-06-21T13:13:55Z

Just found #11317.
But IMHO this PR's approach is better

BridgeAR · 2017-06-21T13:26:12Z

@refack I tried to find a duplicate and I didn't find that one... I am fine to remove the overlapping changes here. I guess that would be best?

BridgeAR · 2017-06-21T13:28:50Z

Oh, #11317 was closed when I was looking for it. That's why I couldn't find it 😃

refack · 2017-06-21T13:36:54Z

Oh, #11317 was closed when I was looking for it. That's why I couldn't find it 😃

I don't think flags need a special error code.

refack · 2017-06-21T13:42:05Z

@refack I tried to find a duplicate and I didn't find that one... I am fine to remove the overlapping changes here. I guess that would be best?

Yep.

jasnell · 2017-06-22T03:55:05Z

lib/internal/child_process.js

@@ -273,22 +276,31 @@ ChildProcess.prototype.spawn = function(options) {
    if (options.envPairs === undefined)
      options.envPairs = [];
    else if (!Array.isArray(options.envPairs))
-      throw new TypeError('"envPairs" must be an array');
+      throw new errors.TypeError('ERR_INVALID_ARG_TYPE',
+                                'options.envPairs',


nit: these need to be lined up.

jasnell · 2017-06-22T03:56:03Z

lib/internal/util.js

@@ -201,17 +201,19 @@ function getConstructorOf(obj) {
 const kCustomPromisifiedSymbol = Symbol('util.promisify.custom');
 const kCustomPromisifyArgsSymbol = Symbol('customPromisifyArgs');

-function promisify(orig) {
-  if (typeof orig !== 'function') {
+function promisify(original) {


this change looks entirely unrelated to the internal/errors change... it should likely be in it's own PR

~~I think it is pretty much a leftover of a former change. I'll remove it again~~

I had another look at it and I changed it to original because the error is thrown with original and not orig. I originally changed the error but @refack suggested to change the variable name instead as the documentation also speaks of original.

jasnell · 2017-06-22T03:56:37Z

test/parallel/test-child-process-constructor.js

-    }, re);
+    }, common.expectsError({
+      code: 'ERR_INVALID_ARG_TYPE',
+      type: TypeError


should go ahead and include the message here too

jasnell · 2017-06-22T03:57:51Z

lib/internal/fs.js

@@ -18,7 +19,7 @@ const {

 function assertEncoding(encoding) {
  if (encoding && !Buffer.isEncoding(encoding)) {
-    throw new Error(`Unknown encoding: ${encoding}`);
+    throw new errors.TypeError('ERR_INVALID_OPT_VALUE', 'encoding', encoding);


Having a specific ERR_UNKNOWN_ENCODING error would be better here.

I believe this and the flags assertion are superseded by #11317
(Where I made the opposite argument 😉 #11317 (comment) )

I think I agree that sticking to the generic one makes sense, but open discussion on the merits of a more specific one.

jasnell · 2017-06-22T03:59:02Z

test/parallel/test-fs-open-flags.js

    );
  });

 assert.throws(
  () => stringToFlags({}),
-  /^Error: Unknown file open flag: \[object Object\]$/
+  common.expectsError({ code: 'ERR_INVALID_OPT_VALUE', type: TypeError })


A more specific error here would likely be better.
ERR_FS_UNKNOWN_FILE_OPEN_FLAG or something similar

refack · 2017-07-09T22:34:18Z

@BridgeAR now that the other PRs landed, could you rework & rebase. Probably could use the new expectsError(fn, options) in allot of these places.

Needs rework to use newly landed ERR codes

BridgeAR · 2017-07-11T00:29:27Z

Rebased

refack · 2017-07-11T00:35:43Z

Ping @jasnell @mhdawson

mhdawson

LGTM

refack · 2017-07-11T19:00:22Z

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

BridgeAR · 2017-07-18T17:36:56Z

Rebased. PTAL

refack · 2017-07-19T13:29:55Z

Re: #13937 (comment) @nodejs/ctc

mcollina · 2017-07-19T13:34:27Z

Can you rebase? This is conflicting with master.

In addition refactor common.throws to common.expectsError

BridgeAR · 2017-07-22T21:18:59Z

There is not much left of this after a couple of rebases as there were other PRs that got merged that did the same thing. This is happening very frequently with the internal/errors and I am wondering how it's possible to prevent these duplicates a bit better. I actually stopped opening PRs with ports because of that.

I squashed the commits as they individually did not change a lot anymore.

mcollina

LGTM

refack · 2017-07-22T22:15:46Z

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

In addition refactor common.throws to common.expectsError PR-URL: nodejs#13829 Refs: nodejs#11273 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

refack · 2017-07-22T23:15:44Z

Landed in 095357e

nodejs-github-bot added child_process Issues and PRs related to the child_process subsystem. fs Issues and PRs related to the fs subsystem / file system. util Issues and PRs related to the built-in util module. labels Jun 20, 2017

BridgeAR commented Jun 20, 2017

View reviewed changes

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

refack suggested changes Jun 20, 2017

View reviewed changes

BridgeAR force-pushed the refactor-internal-errors branch from e57cc6e to 904ad1b Compare June 21, 2017 12:51

refack previously approved these changes Jun 21, 2017

View reviewed changes

jasnell mentioned this pull request Jun 21, 2017

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

Closed

80 tasks

jasnell reviewed Jun 22, 2017

View reviewed changes

refack mentioned this pull request Jul 7, 2017

errors, buffer: Migrate buffer errors to use internal/errors #13976

Merged

4 tasks

refack self-assigned this Jul 9, 2017

BridgeAR force-pushed the refactor-internal-errors branch from 904ad1b to 9949174 Compare July 11, 2017 00:25

refack approved these changes Jul 11, 2017

View reviewed changes

mhdawson approved these changes Jul 11, 2017

View reviewed changes

refack mentioned this pull request Jul 15, 2017

meta: semver impact of Error messages #13937

Closed

BridgeAR force-pushed the refactor-internal-errors branch from 9949174 to 16db827 Compare July 18, 2017 17:33

refack added the ctc-review label Jul 19, 2017

internal: use internal/errors

44d655e

In addition refactor common.throws to common.expectsError

BridgeAR force-pushed the refactor-internal-errors branch from 16db827 to 44d655e Compare July 22, 2017 21:18

mcollina approved these changes Jul 22, 2017

View reviewed changes

refack closed this Jul 22, 2017

Trott removed the ctc-review label Jul 24, 2017

jasnell mentioned this pull request Oct 30, 2017

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

Merged

refack removed their assignment Oct 20, 2018

BridgeAR deleted the refactor-internal-errors branch April 1, 2019 23:36

internal: use internal/errors #13829

internal: use internal/errors #13829

Conversation

BridgeAR commented Jun 20, 2017 • edited by refack Loading

Checklist

Affected core subsystem(s)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented Jun 20, 2017 • edited Loading

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

Choose a reason for hiding this comment

BridgeAR commented Jun 21, 2017

refack commented Jun 21, 2017

BridgeAR commented Jun 21, 2017

refack left a comment

Choose a reason for hiding this comment

refack commented Jun 21, 2017

BridgeAR commented Jun 21, 2017

BridgeAR commented Jun 21, 2017

refack commented Jun 21, 2017

refack 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

BridgeAR Jun 23, 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

refack Jun 22, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented Jul 9, 2017

BridgeAR commented Jul 11, 2017

refack commented Jul 11, 2017

mhdawson left a comment

Choose a reason for hiding this comment

refack commented Jul 11, 2017

BridgeAR commented Jul 18, 2017

refack commented Jul 19, 2017

mcollina commented Jul 19, 2017

BridgeAR commented Jul 22, 2017

mcollina left a comment

Choose a reason for hiding this comment

refack commented Jul 22, 2017

refack commented Jul 22, 2017

BridgeAR commented Jun 20, 2017 •

edited by refack

Loading

refack commented Jun 20, 2017 •

edited

Loading

BridgeAR Jun 23, 2017 •

edited

Loading

refack Jun 22, 2017 •

edited

Loading