@vtex/api 3.77.5 → 3.77.6

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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.

package/lib/service/graphql/middlewares/formatters.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const apollo_server_errors_1 = require("apollo-server-errors");
 const ramda_1 = require("ramda");
 const error_1 = require("../../../utils/error");
-const log_1 = require("../../../utils/log");
 const ERROR_FIELD_WHITELIST = ['message', 'path', 'stack', 'extensions', 'statusCode', 'name', 'headers', 'originalError', 'code'];
 // formatError overrides the default option in runHttpQuery, which
 // does not keep track of the error stack. All non-enumerable
@@ -22,11 +21,11 @@ const createFormatError = (details) => (error) => {
             delete formattedError.originalError.stack;
         }
         if (!formattedError.extensions.exception) {
-            formattedError.extensions.exception = Object.assign({ message: formattedError.originalError.message, name: formattedError.originalError.name }, ramda_1.omit(log_1.FIRST_LEVEL_SENSITIVE_FIELDS, formattedError.originalError), { sensitive: ramda_1.pick(log_1.FIRST_LEVEL_SENSITIVE_FIELDS, formattedError.originalError) });
+            formattedError.extensions.exception = Object.assign({ message: formattedError.originalError.message, name: formattedError.originalError.name }, ramda_1.omit(error_1.SENSITIVE_EXCEPTION_FIELDS, formattedError.originalError), { sensitive: ramda_1.pick(error_1.SENSITIVE_EXCEPTION_FIELDS, formattedError.originalError) });
         }
         else {
             const mergedExceptions = Object.assign({}, formattedError.originalError, formattedError.extensions.exception);
-            const extendedException = Object.assign({ message: formattedError.originalError.message, name: formattedError.originalError.name }, ramda_1.omit(log_1.FIRST_LEVEL_SENSITIVE_FIELDS, mergedExceptions), { sensitive: ramda_1.pick(log_1.FIRST_LEVEL_SENSITIVE_FIELDS, mergedExceptions) });
+            const extendedException = Object.assign({ message: formattedError.originalError.message, name: formattedError.originalError.name }, ramda_1.omit(error_1.SENSITIVE_EXCEPTION_FIELDS, mergedExceptions), { sensitive: ramda_1.pick(error_1.SENSITIVE_EXCEPTION_FIELDS, mergedExceptions) });
             formattedError.extensions.exception = error_1.cleanError(extendedException);
         }
         // Make originalError not enumerable to prevent duplicated log and response information

package/lib/service/http/middlewares/error.js

@@ -5,7 +5,6 @@ const constants_1 = require("../../../constants");
 const RequestCancelledError_1 = require("../../../errors/RequestCancelledError");
 const TooManyRequestsError_1 = require("../../../errors/TooManyRequestsError");
 const error_1 = require("../../../utils/error");
-const log_1 = require("../../../utils/log");
 const CACHE_CONTROL_HEADER = 'cache-control';
 const META_HEADER = 'x-vtex-meta';
 const ETAG_HEADER = 'etag';
@@ -33,7 +32,7 @@ const logAndRemoveSensitiveData = (ctx, err) => {
     // Use sendLog directly to avoid cleaning error twice.
     ctx.vtex.logger.log(log, level);
     if (!constants_1.LINKED) {
-        log_1.FIRST_LEVEL_SENSITIVE_FIELDS.forEach(field => {
+        error_1.SENSITIVE_EXCEPTION_FIELDS.forEach(field => {
             delete err[field];
         });
     }

package/lib/utils/error.d.ts

@@ -1,4 +1,5 @@
 export declare const PICKED_AXIOS_PROPS: string[];
+export declare const SENSITIVE_EXCEPTION_FIELDS: string[];
 /**
  * Cleans errors by removing circular properties, truncating large strings and picking axios properties
  *

package/lib/utils/error.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // Inspired by https://github.com/sindresorhus/serialize-error
 const ramda_1 = require("ramda");
 exports.PICKED_AXIOS_PROPS = ['baseURL', 'cacheable', 'data', 'finished', 'headers', 'method', 'timeout', 'status', 'path', 'url', 'metric', 'inflightKey', 'forceMaxAge', 'params', 'responseType'];
+exports.SENSITIVE_EXCEPTION_FIELDS = ['config', 'request', 'stack'];
 const MAX_ERROR_STRING_LENGTH = process.env.MAX_ERROR_STRING_LENGTH ? parseInt(process.env.MAX_ERROR_STRING_LENGTH, 10) : 8 * 1024;
 const findCaseInsensitive = (target, set) => ramda_1.find(t => t.toLocaleLowerCase() === target, set);
 const destroyCircular = (from, seen) => {

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

@@ -1,3 +1,5 @@
-export declare const FIRST_LEVEL_SENSITIVE_FIELDS: string[];
-export declare const SECOND_LEVEL_SENSITIVE_FIELDS: string[][];
-export declare const cleanLog: (log: any) => void;
+export declare const cleanLog: (log: {
+    [k: string]: any;
+}) => {
+    [k: string]: any;
+};

package/lib/utils/log.js

@@ -1,14 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FIRST_LEVEL_SENSITIVE_FIELDS = ['config', 'request', 'stack', 'error'];
-exports.SECOND_LEVEL_SENSITIVE_FIELDS = [['parsedInfo', 'requestConfig'], ['headers', 'cookie']];
+const json_1 = require("./json");
+const SENSITIVE_FIELDS = ['cookie', 'Cookie', 'vtexIdclientautcookie', 'error'];
 exports.cleanLog = (log) => {
-    exports.FIRST_LEVEL_SENSITIVE_FIELDS.forEach(field => {
-        delete log[field];
-    });
-    exports.SECOND_LEVEL_SENSITIVE_FIELDS.forEach(field => {
-        if (field[0] in log) {
-            delete log[field[0]][field[1]];
-        }
-    });
+    return json_1.cleanJson(log, SENSITIVE_FIELDS);
 };

package/package.json

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