@vtex/api 3.77.4 → 3.77.7

package/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.77.7] - 2022-04-14
+
+### Fixed
+- Update sensitive fields.
+  - Remove "error".
+  - Add missing fields.
+- Fix cleanJson.
+  - Lowercase keys before comparison.
+
+## [3.77.6] - 2022-03-08
+### Fixed
+- Only remove cookie fields when removing sensitive data from logs.
+
+## [3.77.5] - 2022-02-24
+### Fixed
+- Remove sensitive data from logs.
+
 ## [3.77.4] - 2021-10-22
 
 ## [3.77.3] - 2021-10-22

package/lib/service/logger/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const error_1 = require("../../utils/error");
+const log_1 = require("../../utils/log");
 const linked = !!process.env.VTEX_APP_LINK;
 const app = process.env.VTEX_APP_ID;
 const EMPTY_MESSAGE = 'Logger.log was called with null or undefined message';
@@ -22,6 +23,7 @@ class Logger {
         this.error = (error) => this.log(error, LogLevel.Error);
         this.log = (message, level) => {
             const data = message ? error_1.cleanError(message) : EMPTY_MESSAGE;
+            log_1.cleanLog(data);
             /* tslint:disable:object-literal-sort-keys */
             const inflatedLog = {
                 __VTEX_IO_LOG: true,

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.toLowerCase() === 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,5 @@
+export declare const cleanLog: (log: {
+    [k: string]: any;
+}) => {
+    [k: string]: any;
+};

package/lib/utils/log.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const json_1 = require("./json");
+const SENSITIVE_FIELDS = [
+    'auth',
+    'authorization',
+    'authtoken',
+    'cookie',
+    'proxy-athorization',
+    'rawheaders',
+    'token',
+    'vtexIdclientautcookie',
+    'x-vtex-api-appkey',
+    'x-vtex-api-apptoken',
+    'x-vtex-credential',
+    'x-vtex-session',
+];
+exports.cleanLog = (log) => {
+    return json_1.cleanJson(log, SENSITIVE_FIELDS);
+};

package/package.json

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