feat(errors): add error.body with original JSON error body (#4421)

.changes/next-release/feature-errors-02c46955.json

@@ -0,0 +1,5 @@
+{
+  "type": "feature",
+  "category": "errors",
+  "description": "add error.body hidden field with original error body for JSON protocols"
+}

.eslintignore

@@ -1,3 +1,4 @@
 dist/*
 test/browser/**/*
 test/configuration.js
+workspace

lib/protocol/json.js

@@ -40,6 +40,7 @@ function extractError(resp) {
   if (httpResponse.body.length > 0) {
     try {
       var e = JSON.parse(httpResponse.body.toString());
+
       var code = e.__type || e.code || e.Code;
       if (code) {
         error.code = code.split('#').pop();
@@ -49,6 +50,24 @@ function extractError(resp) {
       } else {
         error.message = (e.message || e.Message || null);
       }
+
+      // The minimized models do not have error shapes, so
+      // without expanding the model size, it's not possible
+      // to validate the response shape (members) or
+      // check if any are sensitive to logging.
+
+      // Assign the fields as non-enumerable, allowing specific access only.
+      for (var key in e || {}) {
+        if (key === 'code' || key === 'message') {
+          continue;
+        }
+        error['[' + key + ']'] = 'See error.' + key + ' for details.';
+        Object.defineProperty(error, key, {
+          value: e[key],
+          enumerable: false,
+          writable: true
+        });
+      }
     } catch (e) {
       error.statusCode = httpResponse.statusCode;
       error.message = httpResponse.statusMessage;

lib/util.js

@@ -610,7 +610,25 @@ var util = {
     err.name = String(options && options.name || err.name || err.code || 'Error');
     err.time = new Date();
 
-    if (originalError) err.originalError = originalError;
+    if (originalError) {
+      err.originalError = originalError;
+    }
+
+
+    for (var key in options || {}) {
+      if (key[0] === '[' && key[key.length - 1] === ']') {
+        key = key.slice(1, -1);
+        if (key === 'code' || key === 'message') {
+          continue;
+        }
+        err['[' + key + ']'] = 'See error.' + key + ' for details.';
+        Object.defineProperty(err, key, {
+          value: err[key] || (options && options[key]) || (originalError && originalError[key]),
+          enumerable: false,
+          writable: true
+        });
+      }
+    }
 
     return err;
   },