lib: improve the usage of TypeError[INVALID_ARG_TYPE] #16401

starkwang · 2017-10-23T06:31:51Z

The initials of expected in TypeError[ERR_INVALID_ARG_TYPE] are inconsistent.

This PR is to:

Unify the initial usage of TypeError[INVALID_ARG_TYPE]
Add an argument check before construct an error
Revise some inappropriate usage of INVALID_ARG_TYPE

Fixes: #16383

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

apapirovski

Some decisions probably need to be made re: functions and objects. Neither is technically a primitive.

Not sure how I feel about the need for checkExpectedTypeInitial — feels like reviewing PRs and modifying all existing usage would take care of its purpose.

apapirovski · 2017-10-23T15:06:34Z

lib/internal/crypto/random.js

@@ -16,7 +16,7 @@ function assertOffset(offset, length) {
  }

  if (offset > kMaxUint32 || offset < 0) {
-    throw new errors.TypeError('ERR_INVALID_ARG_TYPE', 'offset', 'uint32');
+    throw new errors.TypeError('ERR_INVALID_ARG_TYPE', 'offset', 'Uint32');


Tempted to say that uint32 being lowercase was correct... here and in all other instances that aren't referring to Uint32Array.

starkwang · 2017-10-23T15:55:35Z

Some decisions probably need to be made re: functions and objects. Neither is technically a primitive.

@apapirovski Agreed. But most of the codes using function and object instead of uppercase initial. I'm also confused with the strange convention.

jasnell · 2017-10-23T17:26:13Z

Defensively marking as semver-major... these type of changes should only need to be semver-major while we are still in the process of converting the errors over to the new mechanism.

lpinca · 2017-10-24T09:42:57Z

Not sure how I feel about the need for checkExpectedTypeInitial — feels like reviewing PRs and modifying all existing usage would take care of its purpose.

👍

joyeecheung · 2017-10-27T14:00:28Z

Defensively marking as semver-major... these type of changes should only need to be semver-major while we are still in the process of converting the errors over to the new mechanism.

@jasnell A lot of changes here only affect the error message. If this PR can split those changes touching error codes/adding additional throws out then IMO we could land the message-only changes as semver-patch.

joyeecheung · 2017-10-27T14:02:06Z

Some decisions probably need to be made re: functions and objects. Neither is technically a primitive.

@apapirovski I'd say...let's go with util.isPrimitive.

> util.isPrimitive(() => {})
false
> util.isPrimitive({})
false

apapirovski · 2017-10-27T14:03:46Z

@joyeecheung yeah, I agree — more about whether we capitalize or not. I feel like Function looks a bit weird but it's not a primitive so...

apapirovski · 2017-10-27T14:04:33Z

lib/internal/errors.js

+  'string', 'boolean', 'number', 'object', 'undefined', 'null',
+  'object', 'symbol', 'false', 'falsy', 'function', 'uint32'
+];
+function checkExpectedTypeInitial(expectedType) {


If this remains in some form, it should be made into a lint rule. Otherwise it should IMO be removed.

joyeecheung

Can you split the message-only changes into separate commits? (I guess we need to split the PR as well) That way they don't have to be semver-major.

Personally I prefer not to check the capitalizations of types in runtime, we can probably just make another eslint rule for it.

joyeecheung · 2017-10-27T14:06:23Z

lib/internal/errors.js

+  }
+
+  if (typeof expectedType === 'string') {
+    const lowercase = firstLowerCase(expectedType);


Since primitiveTypes is full of lowercase strings we can just do expectedType.toLowerCase()

joyeecheung · 2017-10-27T14:06:52Z

lib/internal/errors.js

+
+  if (typeof expectedType === 'string') {
+    const lowercase = firstLowerCase(expectedType);
+    if (primitiveTypes.indexOf(lowercase) === -1) {


primitiveTypes.includes(lowercase)?

starkwang · 2017-10-27T15:59:50Z

Can you split the message-only changes into separate commits? (I guess we need to split the PR as well) That way they don't have to be semver-major.

@joyeecheung Sorry I don't understand fully. Do you mean that split every file change (about error message) into separate commits? It will be a lot of commits I guess.

Personally I prefer not to check the capitalizations of types in runtime, we can probably just make another eslint rule for it.

Agreed. I will remove it.

joyeecheung · 2017-10-28T02:39:02Z

@starkwang Sorry for not being clear enough. Some of the changes here do not add additional throw or change the error code (i.e. do not change the first argument like "ERR_*", basically they just change the capitalization, so only the errror messages are changed), those can be split into one commit, and do not have to be sermver-major(that is, can go into 8.x). Those that do change the code or add additional throws can be split into another commit and will have to wait until 9.x

starkwang · 2017-10-28T10:47:07Z

@joyeecheung I've just reduced this PR into message-only changes, which unifies the initials.
I will create another PR to fix the inappropriate error codes (they were in this PR before).

joyeecheung · 2017-10-28T11:54:30Z

LGTM once this changes object -> Object and function -> Function, because we use the capitalized names in the documentation as well, IMO we should be more consistent on this.

Also I think I have incorrectly estimated the timeline in #16401 (comment) , from a quick glance I think none of the errors changed here can be backported in v8.x becuase they have not been migrated there in April anyway. The changes in this PR should be safe to land in v9.x and the other semver-major changes would probably need to wait for v10.x because we are very close to cut v9.x now.

starkwang · 2017-10-28T15:32:12Z

Pushed commit to address comment.

joyeecheung

LGTM with a odd finding. We should probably do an audit on the types passed to ERR_INVALID_ARG_TYPE later...

joyeecheung · 2017-10-28T16:58:00Z

lib/fs.js

@@ -1209,7 +1209,7 @@ function toUnixTimestamp(time) {
  }
  throw new errors.Error('ERR_INVALID_ARG_TYPE',
                         'time',
-                         ['Date', 'time in seconds'],
+                         ['Date', 'Time in seconds'],


Not really need to be fixed in this PR, but this should be ['Date', 'string', 'number']

joyeecheung · 2017-10-28T17:01:02Z

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

tniessen · 2017-10-28T21:33:49Z

Personally, I usually use lowercase for things which typeof returns a correct value for, e.g. number, function and object, but I guess consistency with the documentation makes sense.

starkwang · 2017-11-11T02:03:20Z

@jasnell @joyeecheung @tniessen Is there anyone can review or land this PR?

joyeecheung · 2017-11-11T05:02:50Z

This is a message-only change on the migrated errors now so we don't need TSC approvals...going to land this tomorrow if no one objects. cc @nodejs/collaborators

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

gireeshpunathil · 2017-11-11T05:32:10Z

for me, the types with actual casing that a compiler can successfully parse is one thing, and the types that a consumer can easily relate to is another thing, and it makes sense to abstract the strict syntax in human readable messages. However, consistency draws the bottom line.

mcollina

LGTM

The initials of expected in TypeError[ERR_INVALID_ARG_TYPE] are inconsistent. This change is to unify them. PR-URL: #16401 Fixes: #16383 Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

MylesBorins · 2017-11-17T16:16:31Z

Should this be backported to v6.x-staging or v6.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

As this PR touches more than 50 files it may have been nice to get a backport lined up when this landed

joyeecheung · 2017-11-17T18:13:59Z

@MylesBorins This PR cannot land in v6.x or v8.x because it changes errors that have not been migrated in either branches, see #16401 (comment) . This should be possible to be backported to v9.x though, if it actually needs a backport.

joyeecheung · 2017-11-17T18:15:42Z

@MylesBorins Ah nevermind, I see that it's already released on v9.2.0

Primitives should use lowercase in error message. refs: nodejs#16401

Primitives should use lowercase in error message. Refs: nodejs#16401 PR-URL: nodejs#17568 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>

Primitives should use lowercase in error message. Refs: #16401 PR-URL: #17568 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>

nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Oct 23, 2017

apapirovski reviewed Oct 23, 2017

View reviewed changes

starkwang force-pushed the improve-invalid-arg-type branch from 393b85c to 670dab3 Compare October 23, 2017 16:29

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

apapirovski reviewed Oct 27, 2017

View reviewed changes

joyeecheung reviewed Oct 27, 2017

View reviewed changes

starkwang force-pushed the improve-invalid-arg-type branch from 670dab3 to c74148d Compare October 28, 2017 10:36

joyeecheung removed the semver-major PRs that contain breaking changes and should be released in the next major version. label Oct 28, 2017

starkwang force-pushed the improve-invalid-arg-type branch from c74148d to 75e6dd5 Compare October 28, 2017 15:32

joyeecheung approved these changes Oct 28, 2017

View reviewed changes

starkwang force-pushed the improve-invalid-arg-type branch from 75e6dd5 to 6638db6 Compare November 3, 2017 14:13

joyeecheung self-assigned this Nov 11, 2017

gireeshpunathil approved these changes Nov 11, 2017

View reviewed changes

mcollina approved these changes Nov 11, 2017

View reviewed changes

evanlucas mentioned this pull request Nov 13, 2017

v9.2.0 proposal #16992

Merged

MylesBorins added lts-watch-v6.x labels Nov 17, 2017

joyeecheung added dont-land-on-v6.x and removed lts-watch-v6.x labels Nov 17, 2017

starkwang mentioned this pull request Dec 9, 2017

tools: add lowercase-name-for-primitive eslint rule #17568

Closed

3 tasks

starkwang added a commit to starkwang/node that referenced this pull request Dec 9, 2017

tools: add lowercase-name-for-primitive eslint rule

ea94065

Primitives should use lowercase in error message. refs: nodejs#16401

gibfahn mentioned this pull request Dec 19, 2017

test: refactor concat string to template string #17252

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: improve the usage of TypeError[INVALID_ARG_TYPE] #16401

lib: improve the usage of TypeError[INVALID_ARG_TYPE] #16401

starkwang commented Oct 23, 2017 •

edited

Loading

apapirovski left a comment

apapirovski Oct 23, 2017

starkwang commented Oct 23, 2017

jasnell commented Oct 23, 2017

lpinca commented Oct 24, 2017

joyeecheung commented Oct 27, 2017

joyeecheung commented Oct 27, 2017 •

edited

Loading

apapirovski commented Oct 27, 2017

apapirovski Oct 27, 2017

joyeecheung left a comment

joyeecheung Oct 27, 2017

joyeecheung Oct 27, 2017

starkwang commented Oct 27, 2017

joyeecheung commented Oct 28, 2017

starkwang commented Oct 28, 2017

joyeecheung commented Oct 28, 2017 •

edited

Loading

starkwang commented Oct 28, 2017

joyeecheung left a comment

joyeecheung Oct 28, 2017

joyeecheung commented Oct 28, 2017

tniessen commented Oct 28, 2017

starkwang commented Nov 11, 2017

joyeecheung commented Nov 11, 2017

gireeshpunathil commented Nov 11, 2017

mcollina left a comment

MylesBorins commented Nov 17, 2017

joyeecheung commented Nov 17, 2017

joyeecheung commented Nov 17, 2017

lib: improve the usage of TypeError[INVALID_ARG_TYPE] #16401

lib: improve the usage of TypeError[INVALID_ARG_TYPE] #16401

Conversation

starkwang commented Oct 23, 2017 • edited Loading

Checklist

Affected core subsystem(s)

apapirovski left a comment

Choose a reason for hiding this comment

apapirovski Oct 23, 2017

Choose a reason for hiding this comment

starkwang commented Oct 23, 2017

jasnell commented Oct 23, 2017

lpinca commented Oct 24, 2017

joyeecheung commented Oct 27, 2017

joyeecheung commented Oct 27, 2017 • edited Loading

apapirovski commented Oct 27, 2017

apapirovski Oct 27, 2017

Choose a reason for hiding this comment

joyeecheung left a comment

Choose a reason for hiding this comment

joyeecheung Oct 27, 2017

Choose a reason for hiding this comment

joyeecheung Oct 27, 2017

Choose a reason for hiding this comment

starkwang commented Oct 27, 2017

joyeecheung commented Oct 28, 2017

starkwang commented Oct 28, 2017

joyeecheung commented Oct 28, 2017 • edited Loading

starkwang commented Oct 28, 2017

joyeecheung left a comment

Choose a reason for hiding this comment

joyeecheung Oct 28, 2017

Choose a reason for hiding this comment

joyeecheung commented Oct 28, 2017

tniessen commented Oct 28, 2017

starkwang commented Nov 11, 2017

joyeecheung commented Nov 11, 2017

gireeshpunathil commented Nov 11, 2017

mcollina left a comment

Choose a reason for hiding this comment

MylesBorins commented Nov 17, 2017

joyeecheung commented Nov 17, 2017

joyeecheung commented Nov 17, 2017

starkwang commented Oct 23, 2017 •

edited

Loading

joyeecheung commented Oct 27, 2017 •

edited

Loading

joyeecheung commented Oct 28, 2017 •

edited

Loading