From 69416b318d4432b0b9b5faecf3d288f213140d7f Mon Sep 17 00:00:00 2001
From: Daniel Bevenius <daniel.bevenius@gmail.com>
Date: Wed, 25 Apr 2018 13:58:32 +0200
Subject: [PATCH] tls: specify options.name in validateKeyCert

This commit addresses a TODO added by Ruben Bridgewater in commit
c6b6c92185316e13738e6fa931fdd5303e381e46 ("lib: always show
ERR_INVALID_ARG_TYPE received part") which was to prefix the name of
the invalid argument with 'options.'.

This commit also switches the order of the parameters to validateKeyCert
to be consistent with other validators.
---
 lib/_tls_common.js                              | 17 ++++++++---------
 .../test-https-options-boolean-check.js         |  8 ++++----
 test/parallel/test-tls-options-boolean-check.js |  8 ++++----
 3 files changed, 16 insertions(+), 17 deletions(-)

diff --git a/lib/_tls_common.js b/lib/_tls_common.js
index a9fe0d8f06aa0d..d8f6afed0bd8fb 100644
--- a/lib/_tls_common.js
+++ b/lib/_tls_common.js
@@ -56,11 +56,10 @@ function SecureContext(secureProtocol, secureOptions, context) {
   if (secureOptions) this.context.setOptions(secureOptions);
 }
 
-function validateKeyCert(value, type) {
+function validateKeyCert(name, value) {
   if (typeof value !== 'string' && !isArrayBufferView(value)) {
     throw new ERR_INVALID_ARG_TYPE(
-      // TODO(BridgeAR): Change this to `options.${type}`
-      type,
+      `options.${name}`,
       ['string', 'Buffer', 'TypedArray', 'DataView'],
       value
     );
@@ -100,11 +99,11 @@ exports.createSecureContext = function createSecureContext(options, context) {
     if (Array.isArray(ca)) {
       for (i = 0; i < ca.length; ++i) {
         val = ca[i];
-        validateKeyCert(val, 'ca');
+        validateKeyCert('ca', val);
         c.context.addCACert(val);
       }
     } else {
-      validateKeyCert(ca, 'ca');
+      validateKeyCert('ca', ca);
       c.context.addCACert(ca);
     }
   } else {
@@ -116,11 +115,11 @@ exports.createSecureContext = function createSecureContext(options, context) {
     if (Array.isArray(cert)) {
       for (i = 0; i < cert.length; ++i) {
         val = cert[i];
-        validateKeyCert(val, 'cert');
+        validateKeyCert('cert', val);
         c.context.setCert(val);
       }
     } else {
-      validateKeyCert(cert, 'cert');
+      validateKeyCert('cert', cert);
       c.context.setCert(cert);
     }
   }
@@ -137,11 +136,11 @@ exports.createSecureContext = function createSecureContext(options, context) {
         val = key[i];
         // eslint-disable-next-line eqeqeq
         const pem = (val != undefined && val.pem !== undefined ? val.pem : val);
-        validateKeyCert(pem, 'key');
+        validateKeyCert('key', pem);
         c.context.setKey(pem, val.passphrase || passphrase);
       }
     } else {
-      validateKeyCert(key, 'key');
+      validateKeyCert('key', key);
       c.context.setKey(key, passphrase);
     }
   }
diff --git a/test/parallel/test-https-options-boolean-check.js b/test/parallel/test-https-options-boolean-check.js
index cefa9c1d0a3769..bed5fb03253f7f 100644
--- a/test/parallel/test-https-options-boolean-check.js
+++ b/test/parallel/test-https-options-boolean-check.js
@@ -88,7 +88,7 @@ const caArrDataView = toDataView(caCert);
   }, {
     code: 'ERR_INVALID_ARG_TYPE',
     name: 'TypeError [ERR_INVALID_ARG_TYPE]',
-    message: 'The "key" argument must be one of type string, Buffer, ' +
+    message: 'The "options.key" property must be one of type string, Buffer, ' +
              `TypedArray, or DataView. Received type ${type}`
   });
 });
@@ -113,8 +113,8 @@ const caArrDataView = toDataView(caCert);
   }, {
     code: 'ERR_INVALID_ARG_TYPE',
     name: 'TypeError [ERR_INVALID_ARG_TYPE]',
-    message: 'The "cert" argument must be one of type string, Buffer, ' +
-             `TypedArray, or DataView. Received type ${type}`
+    message: 'The "options.cert" property must be one of type string, Buffer,' +
+             ` TypedArray, or DataView. Received type ${type}`
   });
 });
 
@@ -147,7 +147,7 @@ const caArrDataView = toDataView(caCert);
   }, {
     code: 'ERR_INVALID_ARG_TYPE',
     name: 'TypeError [ERR_INVALID_ARG_TYPE]',
-    message: 'The "ca" argument must be one of type string, Buffer, ' +
+    message: 'The "options.ca" property must be one of type string, Buffer, ' +
              `TypedArray, or DataView. Received type ${type}`
   });
 });
diff --git a/test/parallel/test-tls-options-boolean-check.js b/test/parallel/test-tls-options-boolean-check.js
index de21da63ff4983..242df1140e41c2 100644
--- a/test/parallel/test-tls-options-boolean-check.js
+++ b/test/parallel/test-tls-options-boolean-check.js
@@ -86,7 +86,7 @@ const caArrDataView = toDataView(caCert);
   }, {
     code: 'ERR_INVALID_ARG_TYPE',
     type: TypeError,
-    message: 'The "key" argument must be one of type string, Buffer, ' +
+    message: 'The "options.key" property must be one of type string, Buffer, ' +
              `TypedArray, or DataView. Received type ${type}`
   });
 });
@@ -111,8 +111,8 @@ const caArrDataView = toDataView(caCert);
   }, {
     code: 'ERR_INVALID_ARG_TYPE',
     type: TypeError,
-    message: 'The "cert" argument must be one of type string, Buffer, ' +
-             `TypedArray, or DataView. Received type ${type}`
+    message: 'The "options.cert" property must be one of type string, Buffer,' +
+             ` TypedArray, or DataView. Received type ${type}`
   });
 });
 
@@ -145,7 +145,7 @@ const caArrDataView = toDataView(caCert);
   }, {
     code: 'ERR_INVALID_ARG_TYPE',
     type: TypeError,
-    message: 'The "ca" argument must be one of type string, Buffer, ' +
+    message: 'The "options.ca" property must be one of type string, Buffer, ' +
              `TypedArray, or DataView. Received type ${type}`
   });
 });