@vtex/api 1.9.0 → 1.9.2

package/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.9.2] - 2022-03-08
+### Fixed
+- Only remove sensitive fields from logs.
+
+## [1.9.1] - 2022-02-24
+### Fixed
+- Remove sensitive data from logs.
+
 ## [1.9.0] - 2019-02-25
 ### Added
 - Functions that call new Apps API for dependency resolution.

package/lib/Logger.js

@@ -14,6 +14,7 @@ const PQueue = require("p-queue");
 const ramda_1 = require("ramda");
 const HttpClient_1 = require("./HttpClient");
 const IODataSource_1 = require("./IODataSource");
+const log_1 = require("./utils/log");
 const DEFAULT_SUBJECT = '-';
 const PICKED_AXIOS_PROPS = ['baseURL', 'cacheable', 'data', 'finished', 'headers', 'method', 'timeout', 'status', 'path', 'url'];
 const queue = new PQueue({ concurrency: 1 });
@@ -46,11 +47,12 @@ class Logger extends IODataSource_1.IODataSource {
                 error.code = 'ERR_NIL_ERR';
                 console.error(error);
             }
-            const { code: errorCode, message, stack, config, request, response } = error, rest = __rest(error, ["code", "message", "stack", "config", "request", "response"]);
+            const { code: errorCode, message, response } = error, rest = __rest(error, ["code", "message", "response"]);
+            log_1.removeSensitiveData(rest);
             const code = errorCode || response && `http-${response.status}`;
-            const pickedDetails = Object.assign({}, config ? { config: ramda_1.pick(PICKED_AXIOS_PROPS, config) } : undefined, request ? { request: ramda_1.pick(PICKED_AXIOS_PROPS, request) } : undefined, response ? { response: ramda_1.pick(PICKED_AXIOS_PROPS, response) } : undefined, JSON.parse(stringify(rest, errorReplacer)), details);
+            const pickedDetails = Object.assign({}, response ? { response: ramda_1.pick(PICKED_AXIOS_PROPS, response) } : undefined, JSON.parse(stringify(rest, errorReplacer)), details);
             const hasDetails = Object.keys(pickedDetails).length > 0;
-            return this.sendLog(subject, { code, message, stack, details: hasDetails ? pickedDetails : undefined }, 'error');
+            return this.sendLog(subject, { code, message, details: hasDetails ? pickedDetails : undefined }, 'error');
         };
         this.sendLog = (subject, message, level) => {
             return queue.add(() => this.http.put(routes.Log(level), message, { params: { subject } }));

package/lib/utils/json.d.ts

@@ -0,0 +1,5 @@
+export declare function cleanJson(json: {
+    [k: string]: any;
+}, targetFields: string[]): {
+    [k: string]: any;
+};

package/lib/utils/json.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function cleanJson(json, targetFields) {
+    for (const key of Object.keys(json)) {
+        let deleted = false;
+        for (const field of targetFields) {
+            if (key === field) {
+                delete json[key];
+                deleted = true;
+            }
+        }
+        if (!deleted && json[key] && typeof json[key] === 'object') {
+            json[key] = cleanJson(json[key], targetFields);
+        }
+    }
+    return json;
+}
+exports.cleanJson = cleanJson;

package/lib/utils/log.d.ts

@@ -0,0 +1,3 @@
+export declare const removeSensitiveData: (log: any) => {
+    [k: string]: any;
+};

package/lib/utils/log.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const json_1 = require("./json");
+const SENSITIVE_FIELDS = ['cookie', 'Cookie', 'vtexIdclientautcookie', 'error'];
+exports.removeSensitiveData = (log) => {
+    return json_1.cleanJson(log, SENSITIVE_FIELDS);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "1.9.0",
+  "version": "1.9.2",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",