feat: mask the payload with sensitive info in console logs

docs/helpers/REST.md

@@ -101,6 +101,9 @@ Sends PATCH request to API.
 
 ```js
 I.sendPatchRequest('/api/users.json', { "email": "user@user.com" });
+
+// To mask the payload in logs
+I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" }));
 ```
 
 #### Parameters
@@ -115,6 +118,9 @@ Sends POST request to API.
 
 ```js
 I.sendPostRequest('/api/users.json', { "email": "user@user.com" });
+
+// To mask the payload in logs
+I.sendPostRequest('/api/users.json', secret({ "email": "user@user.com" }));
 ```
 
 #### Parameters
@@ -129,6 +135,9 @@ Sends PUT request to API.
 
 ```js
 I.sendPutRequest('/api/users.json', { "email": "user@user.com" });
+
+// To mask the payload in logs
+I.sendPutRequest('/api/users.json', secret({ "email": "user@user.com" }));
 ```
 
 #### Parameters

lib/helper/REST.js

@@ -1,4 +1,5 @@
 const axios = require('axios').default;
+const Secret = require('../secret');
 
 const Helper = require('../helper');
 
@@ -75,12 +76,18 @@ class REST extends Helper {
    * @param {*} request
    */
   async _executeRequest(request) {
+    const _debugRequest = { ...request };
     axios.defaults.timeout = request.timeout || this.options.timeout;
 
     if (this.headers && this.headers.auth) {
       request.auth = this.headers.auth;
     }
 
+    if (request.data instanceof Secret) {
+      _debugRequest.data = '*****';
+      request.data = typeof request.data === 'object' ? { ...request.data.toString() } : request.data.toString();
+    }
+
     if ((typeof request.data) === 'string') {
       if (!request.headers || !request.headers['Content-Type']) {
         request.headers = { ...request.headers, ...{ 'Content-Type': 'application/x-www-form-urlencoded' } };
@@ -91,7 +98,7 @@ class REST extends Helper {
       await this.config.onRequest(request);
     }
 
-    this.debugSection('Request', JSON.stringify(request));
+    this.debugSection('Request', JSON.stringify(_debugRequest));
 
     let response;
     try {
@@ -149,6 +156,10 @@ class REST extends Helper {
    *
    * ```js
    * I.sendPostRequest('/api/users.json', { "email": "user@user.com" });
+   *
+   * // To mask the payload in logs
+   * I.sendPostRequest('/api/users.json', secret({ "email": "user@user.com" }));
+   *
    * ```
    *
    * @param {*} url
@@ -176,6 +187,10 @@ class REST extends Helper {
    *
    * ```js
    * I.sendPatchRequest('/api/users.json', { "email": "user@user.com" });
+   *
+   * // To mask the payload in logs
+   * I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" }));
+   *
    * ```
    *
    * @param {string} url
@@ -203,6 +218,10 @@ class REST extends Helper {
    *
    * ```js
    * I.sendPutRequest('/api/users.json', { "email": "user@user.com" });
+   *
+   * // To mask the payload in logs
+   * I.sendPutRequest('/api/users.json', secret({ "email": "user@user.com" }));
+   *
    * ```
    *
    * @param {string} url