lib: migrate errors to internal/errors #17719

styfle · 2017-12-17T19:59:50Z

Refs: #17709

cc @jasnell @joyeecheung

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)

lib, test

joyeecheung

Hi, thank you for opening the pull request, can you add a test for this new error?

joyeecheung · 2017-12-17T20:11:47Z

lib/fs.js

+  if (!(data instanceof Buffer)) {
+    const err = new errors.TypeError('ERR_INVALID_ARG_TYPE',
+                                     'data',
+                                     ['string', 'Buffer'],


The type check only checks if the data is a buffer, can you change this to 'Buffer' instead?

Oops! I was looking at the usage elsewhere in the same file and missed this. Thanks, I fixed it! 👍

styfle · 2017-12-17T22:59:43Z

@joyeecheung I created a test but I have no idea if it's in the correct place.
Also it's failing for some reason. 😨
Please advise, thanks! 😄

starkwang · 2017-12-18T05:17:06Z

lib/fs.js

+  if (!(data instanceof Buffer)) {
+    const err = new errors.TypeError('ERR_INVALID_ARG_TYPE',
+                                     'data',
+                                     ['Buffer'],


Here can be reduced to use a single string 'Buffer', instead of an array ['Buffer'] : )

starkwang · 2017-12-18T05:28:33Z

test/parallel/test-internal-fs-syncwritestream.js

+  }, {
+    code: 'ERR_INVALID_ARG_TYPE',
+    type: TypeError,
+    message: 'The "data" argument must be of type Buffer without null bytes.' +


Umm... If I'm not mistaken, the message here will not match the error it actually throws.
I think it should be 'The "data" argument must be of type Buffer. Received type number'.

Yes, that's probably why the test is failing, you just need to change this to match the actual error message.

Fixed! 🔧

joyeecheung · 2017-12-18T06:25:51Z

test/parallel/test-internal-fs-syncwritestream.js

@@ -41,6 +41,19 @@ const filename = path.join(common.tmpDir, 'sync-write-stream.txt');
  assert.strictEqual(fs.readFileSync(filename).equals(chunk), true);
 }

+// Throws if data is not of type Buffer.
+{
+  const stream = new SyncWriteStream(1);


You can just get the stream using new fs.WriteStream, or fs.createWriteStream, SyncWriteStream is being deprecated. That way this test should be in test-fs-write-stream.js instead.

Thanks! I made the changes.

I debugged the file to see why I was getting the error that the code was expected ERR_INVALID_ARG_TYPE but actual was undefined.

It looks like require(fs) is grabbing my installed 8.x fs and not lib/fs.js. Thoughts on this?

jasnell · 2017-12-18T16:42:02Z

lib/fs.js

@@ -2379,8 +2379,13 @@ WriteStream.prototype.open = function() {


 WriteStream.prototype._write = function(data, encoding, cb) {
-  if (!(data instanceof Buffer))
-    return this.emit('error', new Error('Invalid data'));
+  if (!(data instanceof Buffer)) {


Should likely update this to use Buffer.isType() but let's check with @mcollina first

I would keep this as it is, with instanceof. Buffer.isBuffer is mainly needed outside of core.

mcollina · 2017-12-19T09:19:49Z

lib/fs.js

@@ -2379,8 +2379,13 @@ WriteStream.prototype.open = function() {


 WriteStream.prototype._write = function(data, encoding, cb) {
-  if (!(data instanceof Buffer))
-    return this.emit('error', new Error('Invalid data'));
+  if (!(data instanceof Buffer)) {


I would keep this as it is, with instanceof. Buffer.isBuffer is mainly needed outside of core.

mcollina · 2017-12-19T09:21:03Z

lib/fs.js

+                                     'data',
+                                     'Buffer',
+                                     data);
+    return this.emit('error', err);


while we are at it, I would see if we can convert this to this.detroy(err) instead.

Hi @mcollina, this is my first time looking at the source code for Node so I'm not sure what the implications are of changing that line 🙃

Do you want me to change return this.emit('error', err); to return this.detroy(err);?

How would I ensure that change is working correctly (besides existing unit tests)?

Thanks! 😄

yes.

run our unit tests. You can check if _destroy gets called, but that's a plus.

styfle · 2017-12-19T14:08:01Z

@joyeecheung Can you review again? Thanks!

mcollina · 2017-12-19T14:33:57Z

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

mcollina

LGTM

joyeecheung · 2017-12-19T14:49:26Z

@styfle If you want to run the test with your changes, you can use the node (node.exe on Windows) executable built and linked in the project directory to run the test script. The CI can only be started by a collaborator, whoever runs the CI would usually post the link here.

starkwang · 2017-12-20T01:42:07Z

lib/fs.js

+                                     'data',
+                                     'Buffer',
+                                     data);
+    return this.detroy(err);


detroy -> destroy

@starkwang Oops 😬 That’s embarrassing.
I blame @mcollina because I copied the comment above verbatim 😜

In other news, I realized my MacBook wasn’t actually building because Xcode isn’t installed, but linting seems to work fine. 🤨

Let’s see if this one works 💯

joyeecheung · 2017-12-20T10:21:35Z

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

starkwang · 2017-12-21T02:08:00Z

lib/fs.js

+                                     'data',
+                                     'Buffer',
+                                     data);
+    return this.destroy(err);


The CI seems failed due to this line. It should be:

return this.emit('error', err);

I've tested it on my environment and passed all the test 😉

That’s what it was before but @mcollina said to use destroy instead.
I will change it back.
Thanks for the heads up 😎

@starkwang How does that look?

Refs: nodejs#17709

This should EXTERMINATE the typo

joyeecheung · 2017-12-23T16:07:58Z

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

styfle · 2017-12-23T17:05:24Z

All, thank you for coaching me through this PR!

I hope everyone takes a break from working on node this week to enjoy time with friends and family! 😄 🎄 🎁 ☃️

joyeecheung · 2017-12-23T17:43:51Z

Landed in 8599465, thanks!

Throw ERR_INVALID_ARG_TYPE when validating arguments passed to WriteStream.prototype._write. Refs: #17709 PR-URL: #17719 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

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

joyeecheung requested changes Dec 17, 2017

View reviewed changes

styfle force-pushed the fs-error branch from a01f450 to 3030001 Compare December 17, 2017 21:01

starkwang reviewed Dec 18, 2017

View reviewed changes

joyeecheung reviewed Dec 18, 2017

View reviewed changes

jasnell reviewed Dec 18, 2017

View reviewed changes

mcollina reviewed Dec 19, 2017

View reviewed changes

mcollina added the semver-major PRs that contain breaking changes and should be released in the next major version. label Dec 19, 2017

mcollina approved these changes Dec 19, 2017

View reviewed changes

joyeecheung approved these changes Dec 19, 2017

View reviewed changes

jasnell approved these changes Dec 19, 2017

View reviewed changes

starkwang reviewed Dec 20, 2017

View reviewed changes

joyeecheung mentioned this pull request Dec 20, 2017

Tracking issue: Migrate errors to internal/errors.js #17709

Closed

6 tasks

starkwang reviewed Dec 21, 2017

View reviewed changes

styfle added 9 commits December 21, 2017 12:24

lib: migrate errors to internal/errors

2fb022e

Refs: nodejs#17709

test: add check for stream._write() invalid type

983f368

lib: fix error message

68a73c1

test: fix error message

c28d36c

test: move test from syncwritestream to write-stream

a76b9f1

test: add newline

d01a120

lib: change emit error to destroy

271e9b6

lib: fix typo in “destroy”

b101fca

This should EXTERMINATE the typo

lib: change destroy back to emit error

67848eb

styfle force-pushed the fs-error branch from 8d46a15 to 67848eb Compare December 21, 2017 17:25

joyeecheung added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 23, 2017

joyeecheung approved these changes Dec 23, 2017

View reviewed changes

joyeecheung closed this Dec 23, 2017

joyeecheung removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 23, 2017

styfle deleted the fs-error branch December 23, 2017 19:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: migrate errors to internal/errors #17719

lib: migrate errors to internal/errors #17719

styfle commented Dec 17, 2017 •

edited

Loading

joyeecheung left a comment

joyeecheung Dec 17, 2017

styfle Dec 17, 2017

styfle commented Dec 17, 2017

starkwang Dec 18, 2017

starkwang Dec 18, 2017

joyeecheung Dec 18, 2017

styfle Dec 19, 2017

joyeecheung Dec 18, 2017 •

edited

Loading

styfle Dec 18, 2017

jasnell Dec 18, 2017

mcollina Dec 19, 2017

mcollina Dec 19, 2017

mcollina Dec 19, 2017

styfle Dec 19, 2017

mcollina Dec 19, 2017

styfle commented Dec 19, 2017

mcollina commented Dec 19, 2017

mcollina left a comment

joyeecheung commented Dec 19, 2017 •

edited

Loading

starkwang Dec 20, 2017

styfle Dec 20, 2017 •

edited

Loading

joyeecheung commented Dec 20, 2017

starkwang Dec 21, 2017

styfle Dec 21, 2017

styfle Dec 22, 2017

joyeecheung commented Dec 23, 2017

styfle commented Dec 23, 2017

joyeecheung commented Dec 23, 2017

lib: migrate errors to internal/errors #17719

lib: migrate errors to internal/errors #17719

Conversation

styfle commented Dec 17, 2017 • edited Loading

Checklist

Affected core subsystem(s)

joyeecheung left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

styfle commented Dec 17, 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

joyeecheung Dec 18, 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

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

styfle commented Dec 19, 2017

mcollina commented Dec 19, 2017

mcollina left a comment

Choose a reason for hiding this comment

joyeecheung commented Dec 19, 2017 • edited Loading

Choose a reason for hiding this comment

styfle Dec 20, 2017 • edited Loading

Choose a reason for hiding this comment

joyeecheung commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joyeecheung commented Dec 23, 2017

styfle commented Dec 23, 2017

joyeecheung commented Dec 23, 2017

styfle commented Dec 17, 2017 •

edited

Loading

joyeecheung Dec 18, 2017 •

edited

Loading

joyeecheung commented Dec 19, 2017 •

edited

Loading

styfle Dec 20, 2017 •

edited

Loading