fix: remove request auth headers from debug logging (#622)

Co-authored-by: Elise Shanholtz <[email protected]>

Author: JenniferMah

lib/base/RequestClient.js

@@ -91,7 +91,7 @@ RequestClient.prototype.request = function(opts) {
   };
 
   if (opts.logLevel === 'debug') {
-    logRequest(options)
+    this.logRequest(options)
   }
 
   var _this = this;
@@ -102,7 +102,6 @@ RequestClient.prototype.request = function(opts) {
     if (opts.logLevel === 'debug') {
       console.log(`response.statusCode: ${response.status}`)
       console.log(`response.headers: ${JSON.stringify(response.headers)}`)
-      console.log(`response.data: ${JSON.stringify(response.data)}`)
     }
     _this.lastResponse = new Response(response.status, response.data, response.headers);
     deferred.resolve({
@@ -117,23 +116,25 @@ RequestClient.prototype.request = function(opts) {
   return deferred.promise;
 };
 
-function logRequest(options) {
+RequestClient.prototype.filterLoggingHeaders = function (headers){
+  return Object.keys(headers).filter((header) => {
+    return !'authorization'.includes(header.toLowerCase());
+  });
+}
+
+RequestClient.prototype.logRequest = function (options){
   console.log('-- BEGIN Twilio API Request --');
   console.log(`${options.method} ${options.url}`);
 
-  if (options.data) {
-    console.log('Form data:');
-    console.log(options.data);
-  }
-
   if (options.params) {
     console.log('Querystring:');
     console.log(options.params);
   }
 
   if (options.headers) {
     console.log('Headers:');
-    console.log(options.headers)
+    const filteredHeaderKeys = this.filterLoggingHeaders(options.headers);
+    filteredHeaderKeys.forEach((header) => console.log(`${header}: ${options.headers[header]}`));
   }
 
   console.log('-- END Twilio API Request --');

spec/unit/base/RequestClient.spec.js

@@ -46,6 +46,11 @@ describe('lastResponse and lastRequest defined', function() {
     expect(client.lastResponse.body).toEqual('voltron');
   });
 
+  it('should not include request authorization header in filtered headers', function () {
+    const filteredHeaderKeys = client.filterLoggingHeaders(client.lastRequest.headers);
+    expect(filteredHeaderKeys).toEqual(['test-header-key', 'Connection'])
+  });
+
 });
 
 describe('lastRequest defined, lastResponse undefined', function() {