lib/querystring: convert to using internal/errors #15565

ramimoshe · 2017-09-23T05:42:26Z

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

BridgeAR

This needs a test and the error type should not change.

BridgeAR · 2017-09-23T13:27:25Z

lib/querystring.js

@@ -178,7 +179,7 @@ function qsEscape(str) {
    if (i < str.length)
      c2 = str.charCodeAt(i) & 0x3FF;
    else
-      throw new URIError('URI malformed');
+      throw new errors.TypeError('ERR_QUERYSTRING_URI_INVALID', 'URI malformed');


The error type URIError should stay as it is. If that type does not yet exist in the internal/errors it has to be created.
Out of my perspective a better name for the internal type would also be ERR_INVALID_URI (I am still thinking about if it would be a good idea to combine this with the existing ERR_INVALID_URL type or not) and the error message itself should be moved in the internal errors as static value.

As a temporary workaround this could be done with:

else { const e = new URIError('URI malformed'); e.code = 'ERR_INVALID_URI'; throw e; }

Since this is the only place in /lib/ where URIError is used, I'm not sure it should not be changed...
/cc @jasnell

This recommendation is bad out of my perspective. It is not similar to the internal/errors by just adding the error code. It is neither a NodeError, nor would it receive any further changes in case something changes in the internal/errors.
I would also like to keep the error type as URIError even if it is the only occurrence in lib. It is a single line that has to be added to the internal/errors to add that type and use it from then on.

Thank for your comments
but I am not fully understand you
@BridgeAR @refack do you mean to add "URIError" to module.exports in internal/errors?
e.g:

module.exports = exports = { message, URIError, ....

or using the exported Error with URIError
e.g:

throw new errors.Error(URIError)

BridgeAR · 2017-09-23T13:38:22Z

@ramimoshe Thanks a lot for your PR! This goes in the right direction and just needs a bit more work 😃

ramimoshe · 2017-09-23T19:21:45Z

thanks,
I changed the error to be ERR_INVALID_URL, and I did a small refactor

refack · 2017-09-23T19:26:09Z

lib/internal/errors.js

@@ -261,7 +261,7 @@ E('ERR_NO_LONGER_SUPPORTED', '%s is no longer supported');
 E('ERR_OUT_OF_RANGE', 'The "%s" argument is out of range');
 E('ERR_OUTOFMEMORY', 'Out of memory');
 E('ERR_PARSE_HISTORY_DATA', 'Could not parse history data in %s');
-E('ERR_QUERYSTRING_URI_INVALID', '%s');
+E('ERR_INVALID_URL', 'URI malformed');


So we have a new lint rule that makes sure the error code are sorted in ASCIIbetical order.
It would have made you notice https://github.com/nodejs/node/blob/4518d94e6104323b06781ba608e59208d35a6129/lib/internal/errors.js#L243
So IMHO make this ERR_INVALID_URI (so that we can keep the message text the same), and move it to L243 above the previous ERR_INVALID_URL

refack · 2017-09-23T20:02:28Z

Thanks for following up.
Now all that's left is to fix the tests:
https://github.com/nodejs/node/blob/4518d94e6104323b06781ba608e59208d35a6129/test/parallel/test-querystring-escape.js#L16
https://github.com/nodejs/node/blob/4518d94e6104323b06781ba608e59208d35a6129/test/parallel/test-url-parse-invalid-input.js#L28
https://github.com/nodejs/node/blob/4518d94e6104323b06781ba608e59208d35a6129/test/parallel/test-querystring.js#L273-L276
with something like:

common.expectsError(
  () => qs.stringify({ foo: '\udc00' }),
  {
    code: 'ERR_INVALID_URI',
    type: TypeError,
    message: 'URI malformed'
  }
);

or just as the validator for assert.throws

common.expectsError({
  code: 'ERR_INVALID_URI',
  type: TypeError,
  message: 'URI malformed'
});

I did a small refactor

👍

lpinca · 2017-09-24T06:50:49Z

lib/querystring.js

-    if (i < str.length)
-      c2 = str.charCodeAt(i) & 0x3FF;
-    else
-      throw new URIError('URI malformed');


I'm not sure if this should to be changed to use internal/errors. URIError seems fine to me.

I would definitely recommend to change this to use internal/errors but it should be kept as URIError as I mentioned above (#15565 (comment)).

ramimoshe · 2017-09-24T10:02:26Z

@refack
I am not sure how to update 'decodeURIComponent' function
so "node/test/parallel/test-querystring.js Lines 273 to 276 " test is still checking URIError

 // invalid surrogate pair throws URIError 
 assert.throws(function() { 
   qs.stringify({ foo: '\udc00' }); 
 }, /^URIError: URI malformed$/);

StackTrace from the test (after changing):

URIError: URI malformed
    at decodeURIComponent (<anonymous>)
    at Url.parse (url.js:292:19)
    at Object.urlParse [as parse] (url.js:98:5)
    at Object.<anonymous> (/Users/rami.moshe/Projects/forks/node/test/parallel/test-url-parse-invalid-input.js:27:5)
    at Module._compile (module.js:600:30)
    at Object.Module._extensions..js (module.js:611:10)
    at Module.load (module.js:521:32)
    at tryModuleLoad (module.js:484:12)
    at Function.Module._load (module.js:476:3)
    at Function.Module.runMain (module.js:641:10)

BridgeAR · 2017-09-25T20:30:39Z

@ramimoshe you can not update the decodeURIComponent function and you should not even try. It is a native function.

The error type should definitely not be changed because it would be inconsistent in that case what error we might return. Please switch back to the URIError and just add that type to the internal/errors as I pointed out.

BridgeAR · 2017-09-30T15:20:06Z

Ping @ramimoshe

ramimoshe · 2017-09-30T19:44:17Z

Thank for your comments
but I am not fully understand you
@BridgeAR @refack do you mean to add "URIError" to module.exports in internal/errors?
e.g:

module.exports = exports = {
  message,
  URIError, 
  ....

or using the exported Error with URIError
e.g:

throw new errors.Error(URIError)

BridgeAR · 2017-09-30T22:32:35Z

This is how you can add the URIError to the internal/errors.

module.exports = exports = {
  message,
  Error: makeNodeError(Error),
  TypeError: makeNodeError(TypeError),
  RangeError: makeNodeError(RangeError),
  URIError: makeNodeError(URIError), // <---- 
  AssertionError,
  E // This is exported only to facilitate testing.
};

And this is how you would use it in a different file.

const errors = require('internal/errors');
// ...
throw new errors.URIError('ERR_INVALID_URI');

joyeecheung · 2017-10-08T18:16:20Z

I think I have brought this up in a URL PR before but couldn't find the link. The ECMAScript spec says URIError should only be raised by built-in functions, i.e. functions like decodeURIComponent() that are implemented as part of the language, we should not raise that in our codebase anyway.

(Going to board so no time to dig the link to spec)

refack · 2017-10-08T20:07:35Z

I couldn't find a reference in the ECMAScript spec (image because the spec takes a while to load)

The Web IDL spec only excludes SyntaxError - https://heycam.github.io/webidl/#idl-exceptions

refack · 2017-10-08T20:13:56Z

@ramimoshe, sorry for the delay.

so "node/test/parallel/test-querystring.js Lines 273 to 276 " test is still checking URIError

Use common.expectsError, specifying the type and code. Example

node/test/parallel/test-zlib-not-string-or-buffer.js

Lines 10 to 18 in b050c14

    
           common.expectsError( 
        
             () => zlib.deflateSync(i), 
        
             { 
        
               code: 'ERR_INVALID_ARG_TYPE', 
        
               type: TypeError, 
        
               message: 'The "buffer" argument must be one of type string, Buffer, ' + 
        
                        'TypedArray, or DataView' 
        
             } 
        
           );

joyeecheung · 2017-10-14T15:15:15Z

@refack IMO

Indicates that one of the global URI handling functions was used in a way that is incompatible with its definition.

means it excludes user land methods from throwing a URIError, because those are not "global URI handling functions". Also the WHATWG URL doesn't throw URIError either, it throws TypeError in similar situations.

Anyway, I am still fine with throwing URIError in this PR because that's what we do at the moment.

joyeecheung

This would need to update test/parallel/test-querystring.js tests in order to pass the tests...

joyeecheung · 2017-10-14T15:48:33Z

Also, test/parallel/test-querystring-escape.js needs to be updated as well.

joyeecheung · 2017-10-18T16:06:43Z

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

ramimoshe · 2017-10-19T10:11:23Z

@joyeecheung do you know the issue with ubuntu1404-64 build?
e.g: https://ci.nodejs.org/job/node-test-commit-linux/13309/nodes=ubuntu1404-64/console

joyeecheung · 2017-10-19T17:17:58Z

@ramimoshe Nope, looks like a flake because the failing test should not go through the query string module.

ramimoshe · 2017-10-25T10:44:12Z

@joyeecheung do i have to do something or just wait to approving?

Fixed

joyeecheung · 2017-10-25T15:43:05Z

@ramimoshe This is semver-major so needs at least 2 TSC approvals... @nodejs/tsc

joyeecheung · 2017-10-28T08:24:24Z

CI before landing: https://ci.nodejs.org/job/node-test-pull-request/11040/

joyeecheung · 2017-10-28T11:28:38Z

https://ci.nodejs.org/job/node-test-linter/13033/console

not ok 11 - /usr/home/iojs/build/workspace/node-test-linter/lib/internal/errors.js
  ---
  message: '"ERR_INVALID_URI" is not documented in doc/api/errors.md'
  severity: error
  data:
    line: 291
    column: 1
    ruleId: documented-errors
  messages:
    - message: doc/api/errors.md does not have an anchor for "ERR_INVALID_URI"
      severity: error
      data:
        line: 291
        column: 1
        ruleId: documented-errors
  ...

@ramimoshe Do you have time to document this error code? If not I can do that, just don't want to delay this PR for too long.

ramimoshe · 2017-10-28T14:53:26Z

@joyeecheung - yes, i will fix it

joyeecheung

LGTM if CI is green: https://ci.nodejs.org/job/node-test-pull-request/11053/

PR-URL: nodejs#15565 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>

refack · 2017-10-28T18:08:47Z

@ramimoshe Thanks!

PR-URL: nodejs/node#15565 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>

nodejs-github-bot added errors Issues and PRs related to JavaScript errors originated in Node.js core. querystring Issues and PRs related to the built-in querystring module. labels Sep 23, 2017

ramimoshe mentioned this pull request Sep 23, 2017

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

Closed

80 tasks

BridgeAR previously requested changes Sep 23, 2017

View reviewed changes

refack self-assigned this Sep 23, 2017

refack reviewed Sep 23, 2017

View reviewed changes

lpinca reviewed Sep 24, 2017

View reviewed changes

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

refack approved these changes Oct 8, 2017

View reviewed changes

joyeecheung previously requested changes Oct 14, 2017

View reviewed changes

jasnell approved these changes Oct 25, 2017

View reviewed changes

joyeecheung approved these changes Oct 28, 2017

View reviewed changes

gireeshpunathil approved these changes Oct 28, 2017

View reviewed changes

joyeecheung approved these changes Oct 28, 2017

View reviewed changes

joyeecheung mentioned this pull request Oct 28, 2017

detect CI links in reviews nodejs/node-core-utils#15

Merged

querystring: convert to using internal/errors

9788e96

PR-URL: nodejs#15565 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>

refack force-pushed the master branch from 7f4b786 to 9788e96 Compare October 28, 2017 18:05

refack merged commit 9788e96 into nodejs:master Oct 28, 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 12, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib/querystring: convert to using internal/errors #15565

lib/querystring: convert to using internal/errors #15565

ramimoshe commented Sep 23, 2017

BridgeAR left a comment

BridgeAR Sep 23, 2017

refack Sep 23, 2017 •

edited

Loading

refack Sep 23, 2017

BridgeAR Sep 25, 2017

ramimoshe Sep 26, 2017 •

edited

Loading

BridgeAR commented Sep 23, 2017

ramimoshe commented Sep 23, 2017

refack Sep 23, 2017

refack commented Sep 23, 2017

lpinca Sep 24, 2017

BridgeAR Sep 25, 2017

ramimoshe commented Sep 24, 2017 •

edited

Loading

BridgeAR commented Sep 25, 2017

BridgeAR commented Sep 30, 2017

ramimoshe commented Sep 30, 2017

BridgeAR commented Sep 30, 2017

joyeecheung commented Oct 8, 2017

refack commented Oct 8, 2017

refack commented Oct 8, 2017

joyeecheung commented Oct 14, 2017

joyeecheung left a comment

joyeecheung commented Oct 14, 2017

joyeecheung commented Oct 18, 2017

ramimoshe commented Oct 19, 2017

joyeecheung commented Oct 19, 2017

ramimoshe commented Oct 25, 2017

joyeecheung commented Oct 25, 2017

joyeecheung commented Oct 28, 2017

joyeecheung commented Oct 28, 2017

ramimoshe commented Oct 28, 2017

joyeecheung left a comment

refack commented Oct 28, 2017

lib/querystring: convert to using internal/errors #15565

lib/querystring: convert to using internal/errors #15565

Conversation

ramimoshe commented Sep 23, 2017

BridgeAR left a comment

Choose a reason for hiding this comment

BridgeAR Sep 23, 2017

Choose a reason for hiding this comment

refack Sep 23, 2017 • edited Loading

Choose a reason for hiding this comment

refack Sep 23, 2017

Choose a reason for hiding this comment

BridgeAR Sep 25, 2017

Choose a reason for hiding this comment

ramimoshe Sep 26, 2017 • edited Loading

Choose a reason for hiding this comment

BridgeAR commented Sep 23, 2017

ramimoshe commented Sep 23, 2017

refack Sep 23, 2017

Choose a reason for hiding this comment

refack commented Sep 23, 2017

lpinca Sep 24, 2017

Choose a reason for hiding this comment

BridgeAR Sep 25, 2017

Choose a reason for hiding this comment

ramimoshe commented Sep 24, 2017 • edited Loading

BridgeAR commented Sep 25, 2017

BridgeAR commented Sep 30, 2017

ramimoshe commented Sep 30, 2017

BridgeAR commented Sep 30, 2017

joyeecheung commented Oct 8, 2017

refack commented Oct 8, 2017

refack commented Oct 8, 2017

joyeecheung commented Oct 14, 2017

joyeecheung left a comment

Choose a reason for hiding this comment

joyeecheung commented Oct 14, 2017

joyeecheung commented Oct 18, 2017

ramimoshe commented Oct 19, 2017

joyeecheung commented Oct 19, 2017

ramimoshe commented Oct 25, 2017

joyeecheung commented Oct 25, 2017

joyeecheung commented Oct 28, 2017

joyeecheung commented Oct 28, 2017

ramimoshe commented Oct 28, 2017

joyeecheung left a comment

Choose a reason for hiding this comment

refack commented Oct 28, 2017

refack Sep 23, 2017 •

edited

Loading

ramimoshe Sep 26, 2017 •

edited

Loading

ramimoshe commented Sep 24, 2017 •

edited

Loading