url: port WHATWG URL API to internal/errors #12574

TimothyGu · 2017-04-21T21:38:59Z

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)

url, errors

joyeecheung · 2017-04-24T05:40:27Z

doc/api/errors.md

@@ -561,6 +561,13 @@ found [here][online].
 <a id="nodejs-error-codes"></a>
 ## Node.js Error Codes

+<a id="ERR_ARG_NOT_ITERABLE"></a>


This can also be just ERR_INVALID_ARG_TYPE with Iterable as the expected type..no strong feelings about it though.

For this I think the more specific error is warranted.

joyeecheung · 2017-04-24T05:45:29Z

lib/internal/url.js

@@ -840,15 +841,17 @@ class URLSearchParams {
        for (const pair of init) {
          if (typeof pair !== 'object' ||
              typeof pair[Symbol.iterator] !== 'function') {
-            throw new TypeError('Each query pair must be iterable');
+            throw new errors.TypeError('ERR_INVALID_TUPLE', 'Each query pair',


I know the name/value thing is already in error messages...but since we are changing error messages anyway, I think [name, value] would be easier to understand at the first glance.

joyeecheung · 2017-04-24T05:49:05Z

doc/api/errors.md

+### ERR_INVALID_THIS
+
+The `'ERR_INVALID_THIS'` error code is used generically to identify that a
+Node.js API function is called with an incompatible `this` value. Its use is


The "limited to WHATWG URL" part can be left out IMO, the source of errors would be visible in the stack trace anyway... This way people don't need to change this section when they add this type of error to other APIs

joyeecheung · 2017-04-24T05:54:31Z

doc/api/errors.md

+
+An error with code `'ERR_INVALID_TUPLE'` is thrown when an element in the
+`iterable` provided to the [WHATWG][WHATWG URL API] [`URLSearchParams`
+constructor][`new URLSearchParams(iterable)`] does not represent a name/value


[name, value] tuple would be easier to grasp..

"name/value tuple" is the WHATWG nomenclature, but I'm perfectly fine with "[name, value] tuple".

joyeecheung · 2017-04-24T05:58:09Z

doc/api/errors.md

+An error using the `'ERR_INVALID_URL'` code is thrown when an invalid URL is
+passed to the [WHATWG][WHATWG URL API] [`URL` constructor][`new URL(input)`] to
+be parsed. The thrown error object typically has an additional property
+`'input'` that contains the URL that failed to parse.


Note that at the moment input might not be exactly the same as the original input since it needs to go through trimming and String::NO_NULL_TERMINATION | String::REPLACE_INVALID_UTF8 first...we could've stored the original input, but that's for another PR to consider

Right, the REPLACE_INVALID_UTF8 is pretty edge-case, but trimming can indeed be something the user does not expect. Agreed on addressing this in a separate PR though.

joyeecheung · 2017-04-24T06:27:46Z

doc/api/errors.md

+in the [WHATWG URL API][] for strict compliance with the specification (which
+in some cases may accept `func(undefined)` but not `func()`). In most native
+Node.js APIs, `func(undefined)` and `func()` are treated identically, and the
+[`ERR_INVALID_ARG_TYPE`][] error code may be used instead.


In that case, why not just use 'ERR_INVALID_ARG_TYPE'?

'ERR_INVALID_ARG_TYPE' has the following templated message:

The "FOO" argument must be of type BAR.

In this case, it is not the question of what type the argument is, but whether it is defined at all.

joyeecheung · 2017-04-24T06:30:20Z

lib/internal/errors.js

 E('ERR_ASSERTION', (msg) => msg);
 E('ERR_INVALID_ARG_TYPE', invalidArgType);
 E('ERR_INVALID_CALLBACK', 'callback must be a function');
+E('ERR_INVALID_FILE_URL_HOST', 'File URL host must %s');
+E('ERR_INVALID_FILE_URL_PATH', 'File URL path must %s');
+E('ERR_INVALID_THIS', 'Value of this must be of type %s');


Maybe surround this with quotes or backticks? The original error message uses backticks.

It's quite rare to have an error message with backticks in it (most error messages use double quotes). Here are a few alternatives:

Value of "this" must be of type %s

Method called on incompatible receiver of type %s (V8-inspired)

Method called on incompatible %s (SpiderMonkey-inspired)

Choice 1 SGTM.

joyeecheung · 2017-04-24T06:34:30Z

lib/internal/errors.js

+E('ERR_INVALID_THIS', 'Value of this must be of type %s');
+E('ERR_INVALID_TUPLE', '%s must be an iterable %s tuple');
+E('ERR_INVALID_URL',
+  (input) => `Invalid URL${input !== undefined ? `: ${input}` : ''}`);


I think undefined should be in the message here..otherwise if the user makes a mistake and passes an undefined, there is no way to know if it is an undefined or just an empty string.

joyeecheung · 2017-04-24T06:41:51Z

lib/internal/url.js

-        return new TypeError(
-          'Path must not include encoded \\ or / characters');
+        return new errors.TypeError('ERR_INVALID_FILE_URL_PATH',
+                                    'not include encoded \\ or / characters');


It's a bit weird to put the verbs in separate places...maybe the must part can be left out in the error message format and written here?

joyeecheung · 2017-04-24T06:49:56Z

test/common.js

-      return typeof err === 'object' && 'name' in err && err.name === code.name;
+      return typeof err === 'object' &&
+             'name' in err &&
+             err.name.startsWith(code.name);


Or maybe err instanceof code.constructor ?

I don't know about this one, I'm generally not a huge fan of instanceof checks due to unreliability across different V8 contexts, and it is quite possible that WPT's testharness.js uses the error name string check instead of instanceof.

jasnell

I'd like to see @joyeecheung's comments addressed.

Also slightly revise the grammar of two-expected value scenario.

TimothyGu · 2017-04-25T00:28:23Z

Addressed most of @joyeecheung's comments, except those that are still visible above.

joyeecheung · 2017-04-25T01:53:20Z

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

TimothyGu · 2017-04-25T23:34:11Z

Landed in d457a98.

Also slightly revises grammar. PR-URL: #12574 Refs: #11273 Refs: #11299 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]>

TimothyGu requested review from jasnell and joyeecheung April 21, 2017 21:38

nodejs-github-bot added dont-land-on-v4.x errors Issues and PRs related to JavaScript errors originated in Node.js core. whatwg-url Issues and PRs related to the WHATWG URL implementation. labels Apr 21, 2017

jasnell mentioned this pull request Apr 21, 2017

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

Closed

80 tasks

TimothyGu added the dont-land-on-v7.x label Apr 21, 2017

joyeecheung reviewed Apr 24, 2017

View reviewed changes

jasnell requested changes Apr 24, 2017

View reviewed changes

TimothyGu added 3 commits April 24, 2017 17:21

errors: factor out "of type" text generation

c02820a

Also slightly revise the grammar of two-expected value scenario.

url: port WHATWG URL API to internal/errors

71a31ff

Address comments

b43cdee

TimothyGu force-pushed the url-errors branch from 04a25a2 to b43cdee Compare April 25, 2017 00:27

joyeecheung approved these changes Apr 25, 2017

View reviewed changes

jasnell approved these changes Apr 25, 2017

View reviewed changes

watilde approved these changes Apr 25, 2017

View reviewed changes

TimothyGu closed this Apr 25, 2017

TimothyGu deleted the url-errors branch April 25, 2017 23:34

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

url: port WHATWG URL API to internal/errors #12574

url: port WHATWG URL API to internal/errors #12574

TimothyGu commented Apr 21, 2017

joyeecheung Apr 24, 2017

jasnell Apr 24, 2017

joyeecheung Apr 24, 2017

joyeecheung Apr 24, 2017

joyeecheung Apr 24, 2017

TimothyGu Apr 24, 2017 •

edited

Loading

joyeecheung Apr 24, 2017

TimothyGu Apr 24, 2017

joyeecheung Apr 24, 2017

TimothyGu Apr 24, 2017

joyeecheung Apr 24, 2017

TimothyGu Apr 25, 2017 •

edited

Loading

joyeecheung Apr 24, 2017

joyeecheung Apr 24, 2017

joyeecheung Apr 24, 2017

TimothyGu Apr 25, 2017

jasnell left a comment

TimothyGu commented Apr 25, 2017

joyeecheung commented Apr 25, 2017

TimothyGu commented Apr 25, 2017

url: port WHATWG URL API to internal/errors #12574

url: port WHATWG URL API to internal/errors #12574

Conversation

TimothyGu commented Apr 21, 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

TimothyGu Apr 24, 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

TimothyGu Apr 25, 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

jasnell left a comment

Choose a reason for hiding this comment

TimothyGu commented Apr 25, 2017

joyeecheung commented Apr 25, 2017

TimothyGu commented Apr 25, 2017

TimothyGu Apr 24, 2017 •

edited

Loading

TimothyGu Apr 25, 2017 •

edited

Loading