tls: migrate tls.js to use internal/errors.js #13994

mhdawson · 2017-06-29T23:25:16Z

Migrate tls.js to use internal/errors.js as per
#11273

The internal code used to set the 'code' as the client.authorizationError, or if no code existed the 'message' as the client.authorizationError. Since with the new approach there is always a 'code' we end up setting the less descriptive code. I guess that is consistent though with what was being done for existing errors with a code anyway.

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)

tls

jasnell · 2017-06-30T15:38:26Z

lib/internal/errors.js

@@ -111,6 +111,8 @@ module.exports = exports = {
 // Note: Please try to keep these in alphabetical order
 E('ERR_ARG_NOT_ITERABLE', '%s must be iterable');
 E('ERR_ASSERTION', '%s');
+E('ERR_CERT_ALTNAME_INVALID',


ERR_TLS_CERT_ALTNAME_INVALID?

jasnell · 2017-06-30T15:38:44Z

lib/internal/errors.js

@@ -111,6 +111,8 @@ module.exports = exports = {
 // Note: Please try to keep these in alphabetical order
 E('ERR_ARG_NOT_ITERABLE', '%s must be iterable');
 E('ERR_ASSERTION', '%s');
+E('ERR_CERT_ALTNAME_INVALID',
+  'Hostname/IP does not match certificate\'s altnames: %s');


Perhaps use a template string form to avoid having to escape?

mhdawson · 2017-06-30T19:51:32Z

Pushed commit to address comments.

BridgeAR · 2017-07-05T19:26:53Z

lib/internal/errors.js

+E('ERR_TLS_CERT_ALTNAME_INVALID',
+  (reason) => {
+    return `Hostname/IP does not match certificate's altnames: ${reason}`;
+  });


You do not have to use a function here. Instead we can rely on util.format by replacing the function with:
'Hostname/IP does not match certificate's altnames: %s'.

This is done in all other places and it would be nice to keep it consistent.

Thanks for the suggestion, updating now

actually that is what I had originally. The suggestion to use a function was from James to avoid having to escape the '. Having said that I think I prefer avoiding the function for consistency so I'll change back.

mhdawson · 2017-07-05T19:43:01Z

@BridgeAR pushed commit to change back to address your comment.

mhdawson · 2017-07-05T22:43:57Z

@fhinkel any chance you can review this PR ?

jasnell · 2017-07-10T16:13:12Z

Needs a rebase...

refack

Could you add an assertion of the structure of the Error object to parallel/test-tls-friendly-error-message.js?

Migrate tls.js to use internal/errors.js as per nodejs#11273

mhdawson · 2017-07-11T21:28:26Z

@refack I'm not following, I looked at the test and I don't see the relation to this PR. I see it already validates the following:

assert.strictEqual(err.code, 'UNABLE_TO_VERIFY_LEAF_SIGNATURE');
assert.strictEqual(err.message, 'unable to verify the first certificate');

mhdawson · 2017-07-11T21:29:26Z

Rebased and squashed.

mhdawson · 2017-07-11T21:30:40Z

@fhinkel just need one more CTC reviewer on this one.

refack · 2017-07-11T23:51:19Z

@refack I'm not following, I looked at the test and I don't see the relation to this PR. I see it already validates the following:

I meant you did not add an assertion of the generated error message for the new error code you introduced ERR_TLS_CERT_ALTNAME_INVALID.
Looking at parallel/test-tls-friendly-error-message.js it seems like a good place for that (but any other place is as just as good).
IMHO we should assert the generated message somewhere.

mhdawson · 2017-07-12T15:44:23Z

@refack I don't think we have been requiring validating the message. I had mentioned it as a discussion point when reviewing other PRs. I do agree validation at least once makes sense, but was not sure if we should require that in every test for the code.

I'd suggest this as our approach going forward

If the error message is simply a string that will be output as is, we should be able to trust that the errors mechanism will do the right thing. No validation of message output needed in this case.
If the error message does have parameters, then there should be validation of the string generation in test/parallel/test-internal-errors.js
Other tests using the new error should not check the string and only use the code. This means that if we change the string only the test in 2) needs to be updated.

I've gone ahead and pushed a commit to do that for this PR.

If we agree on the above we should put that guidance into the issue tracking and our internal docs. Once we have agreement I'll do that. The alternative to 3) is that we also require that the message be validated every time the code is used. This would be most thorough.

refack · 2017-07-12T18:20:35Z

@mhdawson Agreed, I made the same argument almost verbatim in some other thread!

refack · 2017-07-12T18:24:21Z

The only caveat with (3) is if the code explicitly modifies the message after Error construction. We should mention that as a no-no in reviewing guidelines.

mhdawson · 2017-07-12T21:48:37Z

@refack PR to add guidance to documentation #14207

mhdawson · 2017-07-13T16:48:20Z

@nodejs/ctc need one more reviewer as its SemVer major.

joyeecheung

Changes LGTM but I can't seem to find the documentation for the old behavior?

mcollina

LGTM

mhdawson · 2017-07-18T00:21:27Z

@joyeecheung not sure what you mean by "can't seem to find the documentation for the old behavior" ?

mhdawson · 2017-07-18T00:23:40Z

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

mhdawson · 2017-07-18T13:33:01Z

One more time for CI run as last one seems not to exist: https://ci.nodejs.org/job/node-test-pull-request/9218/

mhdawson · 2017-07-18T17:59:56Z

CI run good landing.

mhdawson · 2017-07-18T18:05:10Z

Landed as 3ccfeb4

Migrate tls.js to use internal/errors.js as per #11273 PR-URL: #13994 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

nodejs-github-bot added errors Issues and PRs related to JavaScript errors originated in Node.js core. tls Issues and PRs related to the tls subsystem. labels Jun 29, 2017

jasnell mentioned this pull request Jun 29, 2017

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

Closed

80 tasks

jasnell reviewed Jun 30, 2017

View reviewed changes

BridgeAR reviewed Jul 5, 2017

View reviewed changes

mhdawson added the semver-major PRs that contain breaking changes and should be released in the next major version. label Jul 5, 2017

jasnell approved these changes Jul 10, 2017

View reviewed changes

refack suggested changes Jul 10, 2017

View reviewed changes

tls: migrate tls.js to use internal/errors.js

b90e451

Migrate tls.js to use internal/errors.js as per nodejs#11273

mhdawson force-pushed the napi-errors-10 branch from 43dc625 to b90e451 Compare July 11, 2017 21:29

squash: address comments

d9392ff

refack approved these changes Jul 12, 2017

View reviewed changes

joyeecheung approved these changes Jul 15, 2017

View reviewed changes

refack mentioned this pull request Jul 15, 2017

meta: semver impact of Error messages #13937

Closed

mcollina approved these changes Jul 17, 2017

View reviewed changes

mhdawson closed this Jul 18, 2017

jasnell mentioned this pull request Oct 30, 2017

Proposal: 2017-10-31, Version 9.0.0 (Current) #15135

Merged

mhdawson deleted the napi-errors-10 branch September 30, 2019 13:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tls: migrate tls.js to use internal/errors.js #13994

tls: migrate tls.js to use internal/errors.js #13994

mhdawson commented Jun 29, 2017

jasnell Jun 30, 2017

jasnell Jun 30, 2017

mhdawson commented Jun 30, 2017

BridgeAR Jul 5, 2017

mhdawson Jul 5, 2017

mhdawson Jul 5, 2017

mhdawson commented Jul 5, 2017 •

edited

Loading

mhdawson commented Jul 5, 2017

jasnell commented Jul 10, 2017

refack left a comment

mhdawson commented Jul 11, 2017

mhdawson commented Jul 11, 2017

mhdawson commented Jul 11, 2017

refack commented Jul 11, 2017

mhdawson commented Jul 12, 2017 •

edited

Loading

refack commented Jul 12, 2017

refack commented Jul 12, 2017

mhdawson commented Jul 12, 2017

mhdawson commented Jul 13, 2017

joyeecheung left a comment

mcollina left a comment

mhdawson commented Jul 18, 2017

mhdawson commented Jul 18, 2017

mhdawson commented Jul 18, 2017

mhdawson commented Jul 18, 2017

mhdawson commented Jul 18, 2017

tls: migrate tls.js to use internal/errors.js #13994

tls: migrate tls.js to use internal/errors.js #13994

Conversation

mhdawson commented Jun 29, 2017

Checklist

Affected core subsystem(s)

jasnell Jun 30, 2017

Choose a reason for hiding this comment

jasnell Jun 30, 2017

Choose a reason for hiding this comment

mhdawson commented Jun 30, 2017

BridgeAR Jul 5, 2017

Choose a reason for hiding this comment

mhdawson Jul 5, 2017

Choose a reason for hiding this comment

mhdawson Jul 5, 2017

Choose a reason for hiding this comment

mhdawson commented Jul 5, 2017 • edited Loading

mhdawson commented Jul 5, 2017

jasnell commented Jul 10, 2017

refack left a comment

Choose a reason for hiding this comment

mhdawson commented Jul 11, 2017

mhdawson commented Jul 11, 2017

mhdawson commented Jul 11, 2017

refack commented Jul 11, 2017

mhdawson commented Jul 12, 2017 • edited Loading

refack commented Jul 12, 2017

refack commented Jul 12, 2017

mhdawson commented Jul 12, 2017

mhdawson commented Jul 13, 2017

joyeecheung left a comment

Choose a reason for hiding this comment

mcollina left a comment

Choose a reason for hiding this comment

mhdawson commented Jul 18, 2017

mhdawson commented Jul 18, 2017

mhdawson commented Jul 18, 2017

mhdawson commented Jul 18, 2017

mhdawson commented Jul 18, 2017

mhdawson commented Jul 5, 2017 •

edited

Loading

mhdawson commented Jul 12, 2017 •

edited

Loading