lib/fs: convert to using internal/errors #15043

pmatzavin · 2017-08-26T12:11:24Z

covert lib/fs.js over to using lib/internal/errors.js

ref: #11273

i have not addressed the cases that use errnoException(),
for reasons described in GH-12926

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]
(https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#commit-message-guidelines)

Affected core subsystem(s)

lib/fs

kunalspathak · 2017-08-28T21:40:19Z

lib/fs.js

-                        typeof options + ' instead.');
+    throw new errors.TypeError('ERR_INVALID_ARG_TYPE',
+                               'options',
+                               ['object', 'string'],


'object', 'string' [](start = 32, length = 18)

can you have it ['string', 'object'] just to match the earlier error message?

jasnell · 2017-08-29T05:03:12Z

lib/fs.js

@@ -128,7 +131,10 @@ function makeCallback(cb) {
  }

  if (typeof cb !== 'function') {
-    throw new TypeError('"callback" argument must be a function');
+    throw new errors.TypeError('ERR_INVALID_ARG_TYPE',


Please use ERR_INVALID_CALLBACK here :-)

And every where that the callback error is emitted :-)

jasnell · 2017-08-29T05:05:40Z

looks good in general with a few edits necessary!

refack

Suggested some improvments

refack · 2017-08-29T13:39:27Z

lib/fs.js

@@ -156,8 +165,11 @@ function makeStatsCallback(cb) {

 function nullCheck(path, callback) {
  if (('' + path).indexOf('\u0000') !== -1) {
-    var er = new Error('Path must be a string without null bytes');
-    er.code = 'ENOENT';
+    const er = new errors.Error('ERR_INVALID_ARG_TYPE',


IMHO this could be changed to TypeError.
Feedback anyone?

That's really difficult to say. The coercion to a string means that any value can be used, it's not really a TypeError. The real check here is the null-character bit, which doesn't feel like a TypeError to me. I could live with it tho.

refack · 2017-08-29T13:46:09Z

lib/fs.js

@@ -1193,7 +1208,10 @@ function toUnixTimestamp(time) {
    // convert to 123.456 UNIX timestamp
    return time.getTime() / 1000;
  }
-  throw new Error('Cannot parse time: ' + time);
+  throw new errors.Error('ERR_INVALID_ARG_TYPE',


These a disparity with the docs (but out of scope for this PR)

AFAICT date string will not parse

tl;dr 3rd arg should be ['Date', 'time in seconds']

2.You are right I will go with ['Date', 'time in seconds']
The date string was (inaccurate) for a string timestamp arg like '1504020561954'

I updated it to ['Date', 'time in seconds'] (commit: 2f0738a)

refack · 2017-08-29T13:46:34Z

lib/fs.js

@@ -1495,7 +1513,10 @@ fs.watchFile = function(filename, options, listener) {
  }

  if (typeof listener !== 'function') {
-    throw new Error('"watchFile()" requires a listener function');
+    throw new errors.Error('ERR_INVALID_ARG_TYPE',


As above, maybe TypeError

I updated it to TypeError (commit: 2f0738a)

refack · 2017-08-29T13:48:12Z

lib/fs.js

@@ -1903,16 +1932,16 @@ function ReadStream(path, options) {

  if (this.start !== undefined) {
    if (typeof this.start !== 'number') {
-      throw new TypeError('"start" option must be a Number');
+      throw new errors.TypeError('ERR_INVALID_OPT_VALUE', 'start', this.start);


IMHO ERR_INVALID_ARG_TYPE might be better.

I updated it to ERR_INVALID_ARG_TYPE (commit: 2f0738a)

refack · 2017-08-29T13:48:27Z

lib/fs.js

    }
    if (this.end === undefined) {
      this.end = Infinity;
    } else if (typeof this.end !== 'number') {
-      throw new TypeError('"end" option must be a Number');
+      throw new errors.TypeError('ERR_INVALID_OPT_VALUE', 'end', this.end);


Same as L1935

I updated it to ERR_INVALID_ARG_TYPE (commit: 2f0738a)

refack · 2017-08-29T13:53:05Z

lib/fs.js

    }

    if (this.start > this.end) {
-      throw new Error('"start" option must be <= "end" option');
+      throw new errors.Error('ERR_INVALID_OPT_VALUE', 'end', this.end);


IMHO ERR_VALUE_OUT_OF_RANGE might be better:

throw new errors.RangeError('ERR_VALUE_OUT_OF_RANGE', 'start', '<= "end"', `{start: ${this.start}, end: ${this.end}}`);

to produce:
The value of "start" must be <= "end". Received "{start: 5, end: 4}"

I updated it to ERR_VALUE_OUT_OF_RANGE and I added the new error ERR_VALUE_OUT_OF_RANGE in errors.js (commit: 2f0738a)

refack · 2017-08-29T13:53:25Z

lib/fs.js

@@ -2069,10 +2098,10 @@ function WriteStream(path, options) {

  if (this.start !== undefined) {
    if (typeof this.start !== 'number') {
-      throw new TypeError('"start" option must be a Number');
+      throw new errors.TypeError('ERR_INVALID_OPT_VALUE', 'start', this.start);


Same as L1935

I updated it to ERR_INVALID_ARG_TYPE (commit: 2f0738a)

refack · 2017-08-29T13:53:39Z

lib/fs.js

    }
    if (this.start < 0) {
-      throw new Error('"start" must be >= zero');
+      throw new errors.Error('ERR_INVALID_OPT_VALUE', 'start', this.start);


Similar to L1944

I updated it to ERR_VALUE_OUT_OF_RANGE (commit: 2f0738a)

refack · 2017-08-29T13:57:00Z

test/parallel/test-fs-read-stream.js

-}, /"start" option must be <= "end" option/);
+common.expectsError(
+  () => {
+    fs.createReadStream(rangeFile, { start: 10, end: 2 });


Just for this case I suggest validating the output message as well

I added the message assertion (commit: 2f0738a)

refack · 2017-08-29T14:02:38Z

Hello @pmatzavin and welcome (or is it welcome back?). Thank you for tackling this one, it's a non trivial change 🥇
If you haven't already, it's recommended you take a look at CONTRIBUTING.md guide (especially the part about "discuss and update"). Customarily PRs are kept open for at least 48 hours so that anyone interested gets a chance to comment or review. Also internal/error migrations are "semver-major" so they require 2 approvals from CTC members, so it might take longer (hopefully not).

P.S. If you have any question you can also feel free to contact me directly.

I hadn't meant to hit approve yet!

refack

💯

refack · 2017-08-30T12:31:59Z

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

mhdawson

LGTM thanks for helping with the error conversion.

jasnell

LGTM with green CI

covert lib/fs.js over to using lib/internal/errors.js i have not addressed the cases that use errnoException(), for reasons described in nodejsGH-12926 - throw the ERR_INVALID_CALLBACK error when the the callback is invalid - replace the ['object', 'string'] with ['string', 'object'] in the error constructor call, to better match the previous err msg in the getOptions() function - add error ERR_VALUE_OUT_OF_RANGE in lib/internal/errors.js, this error is thrown when a numeric value is out of range - document the ERR_VALUE_OUT_OF_RANGE err in errors.md - correct the expected args, in the error thrown in the function fs._toUnixTimestamp() to ['Date', 'time in seconds'] (lib/fs.js) - update the listener error type in the fs.watchFile() function, from Error to TypeError (lib/fs.js) - update errors from ERR_INVALID_OPT_VALUE to ERR_INVALID_ARG_TYPE in the functions fs.ReadStream() and fs.WriteStream(), for the cases of range errors use the new error: ERR_VALUE_OUT_OF_RANGE (lib/fs.js) PR-URL: nodejs#15043 Refs: nodejs#11273 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

refack · 2017-08-31T23:20:24Z

Pre-land sanity: https://ci.nodejs.org/job/node-test-commit-linuxone/8335/

covert lib/fs.js over to using lib/internal/errors.js i have not addressed the cases that use errnoException(), for reasons described in nodejsGH-12926 - throw the ERR_INVALID_CALLBACK error when the the callback is invalid - replace the ['object', 'string'] with ['string', 'object'] in the error constructor call, to better match the previous err msg in the getOptions() function - add error ERR_VALUE_OUT_OF_RANGE in lib/internal/errors.js, this error is thrown when a numeric value is out of range - document the ERR_VALUE_OUT_OF_RANGE err in errors.md - correct the expected args, in the error thrown in the function fs._toUnixTimestamp() to ['Date', 'time in seconds'] (lib/fs.js) - update the listener error type in the fs.watchFile() function, from Error to TypeError (lib/fs.js) - update errors from ERR_INVALID_OPT_VALUE to ERR_INVALID_ARG_TYPE in the functions fs.ReadStream() and fs.WriteStream(), for the cases of range errors use the new error: ERR_VALUE_OUT_OF_RANGE (lib/fs.js) PR-URL: nodejs#15043 Refs: nodejs#11273 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

refack · 2017-08-31T23:40:18Z

Landed in 219932a
(force pushed)

covert lib/fs.js over to using lib/internal/errors.js i have not addressed the cases that use errnoException(), for reasons described in GH-12926 - throw the ERR_INVALID_CALLBACK error when the the callback is invalid - replace the ['object', 'string'] with ['string', 'object'] in the error constructor call, to better match the previous err msg in the getOptions() function - add error ERR_VALUE_OUT_OF_RANGE in lib/internal/errors.js, this error is thrown when a numeric value is out of range - document the ERR_VALUE_OUT_OF_RANGE err in errors.md - correct the expected args, in the error thrown in the function fs._toUnixTimestamp() to ['Date', 'time in seconds'] (lib/fs.js) - update the listener error type in the fs.watchFile() function, from Error to TypeError (lib/fs.js) - update errors from ERR_INVALID_OPT_VALUE to ERR_INVALID_ARG_TYPE in the functions fs.ReadStream() and fs.WriteStream(), for the cases of range errors use the new error: ERR_VALUE_OUT_OF_RANGE (lib/fs.js) PR-URL: nodejs/node#15043 Refs: nodejs/node#11273 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

nodejs-github-bot added the fs Issues and PRs related to the fs subsystem / file system. label Aug 26, 2017

pmatzavin mentioned this pull request Aug 26, 2017

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

Closed

80 tasks

hiroppy added errors Issues and PRs related to JavaScript errors originated in Node.js core. semver-major PRs that contain breaking changes and should be released in the next major version. labels Aug 26, 2017

kunalspathak reviewed Aug 28, 2017

View reviewed changes

jasnell reviewed Aug 29, 2017

View reviewed changes

jasnell previously approved these changes Aug 29, 2017

View reviewed changes

refack reviewed Aug 29, 2017

View reviewed changes

refack self-assigned this Aug 29, 2017

refack approved these changes Aug 30, 2017

View reviewed changes

mhdawson reviewed Aug 30, 2017

View reviewed changes

jasnell approved these changes Aug 30, 2017

View reviewed changes

refack force-pushed the lib_fs_convert_err branch from 2f0738a to 0b1285c Compare August 31, 2017 23:19

refack merged commit 0b1285c into nodejs:master Aug 31, 2017

pmatzavin deleted the lib_fs_convert_err branch September 2, 2017 12:38

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib/fs: convert to using internal/errors #15043

lib/fs: convert to using internal/errors #15043

pmatzavin commented Aug 26, 2017 •

edited

Loading

kunalspathak Aug 28, 2017 •

edited

Loading

jasnell Aug 29, 2017

jasnell Aug 29, 2017

jasnell commented Aug 29, 2017

refack left a comment

refack Aug 29, 2017

jasnell Aug 29, 2017

refack Aug 29, 2017

pmatzavin Aug 29, 2017

pmatzavin Aug 30, 2017 •

edited

Loading

refack Aug 29, 2017

pmatzavin Aug 30, 2017 •

edited

Loading

refack Aug 29, 2017

pmatzavin Aug 30, 2017 •

edited

Loading

refack Aug 29, 2017

pmatzavin Aug 30, 2017 •

edited

Loading

refack Aug 29, 2017

pmatzavin Aug 30, 2017 •

edited

Loading

refack Aug 29, 2017

pmatzavin Aug 30, 2017 •

edited

Loading

refack Aug 29, 2017

pmatzavin Aug 30, 2017 •

edited

Loading

refack Aug 29, 2017

pmatzavin Aug 30, 2017 •

edited

Loading

refack commented Aug 29, 2017

refack left a comment

refack commented Aug 30, 2017

mhdawson left a comment

jasnell left a comment

refack commented Aug 31, 2017

refack commented Aug 31, 2017

lib/fs: convert to using internal/errors #15043

lib/fs: convert to using internal/errors #15043

Conversation

pmatzavin commented Aug 26, 2017 • edited Loading

Checklist

Affected core subsystem(s)

kunalspathak Aug 28, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell commented Aug 29, 2017

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

Choose a reason for hiding this comment

pmatzavin Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmatzavin Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmatzavin Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmatzavin Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmatzavin Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmatzavin Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmatzavin Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmatzavin Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

refack commented Aug 29, 2017

refack left a comment

Choose a reason for hiding this comment

refack commented Aug 30, 2017

mhdawson left a comment

Choose a reason for hiding this comment

jasnell left a comment

Choose a reason for hiding this comment

refack commented Aug 31, 2017

refack commented Aug 31, 2017

pmatzavin commented Aug 26, 2017 •

edited

Loading

kunalspathak Aug 28, 2017 •

edited

Loading

pmatzavin Aug 30, 2017 •

edited

Loading

pmatzavin Aug 30, 2017 •

edited

Loading

pmatzavin Aug 30, 2017 •

edited

Loading

pmatzavin Aug 30, 2017 •

edited

Loading

pmatzavin Aug 30, 2017 •

edited

Loading

pmatzavin Aug 30, 2017 •

edited

Loading

pmatzavin Aug 30, 2017 •

edited

Loading

pmatzavin Aug 30, 2017 •

edited

Loading