@vtex/api 1.9.1-beta.0 → 1.9.2

package/CHANGELOG.md

@@ -7,9 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [1.9.1-beta.0] - 2019-03-08
+## [1.9.2] - 2022-03-08
+### Fixed
+- Only remove sensitive fields from logs.
 
-## [1.9.1-beta] - 2019-03-08
+## [1.9.1] - 2022-02-24
+### Fixed
+- Remove sensitive data from logs.
 
 ## [1.9.0] - 2019-02-25
 ### Added

package/lib/HttpClient/index.js

@@ -73,7 +73,6 @@ class HttpClient {
         this.request = (config) => __awaiter(this, void 0, void 0, function* () {
             const context = { config };
             yield this.runMiddlewares(context);
-            console.error('finished middlewares, returning response =', context.response);
             return context.response;
         });
         const { baseURL, authToken, authType, cacheStorage, metrics, recorder, userAgent, timeout = DEFAULT_TIMEOUT_MS, segmentToken } = opts;

package/lib/HttpClient/middlewares/cache.js

@@ -38,7 +38,6 @@ function isCacheable(arg) {
 const addNotModified = (validateStatus) => (status) => validateStatus(status) || status === 304;
 exports.cacheMiddleware = ({ cacheStorage, segmentToken }) => {
     return (ctx, next) => __awaiter(this, void 0, void 0, function* () {
-        console.error('cacheMiddleware');
         if (!isCacheable(ctx.config)) {
             return yield next();
         }

package/lib/HttpClient/middlewares/metrics.js

@@ -11,7 +11,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const statusLabel = (status) => `${Math.floor(status / 100)}xx`;
 exports.metricsMiddleware = (metrics) => {
     return (ctx, next) => __awaiter(this, void 0, void 0, function* () {
-        console.error('metricsMiddleware');
         const start = ctx.config.metric && process.hrtime();
         const production = ctx.config.production || false;
         let status;

package/lib/HttpClient/middlewares/notFound.js

@@ -13,7 +13,6 @@ function nullIfNotFound(config) {
     return config && config.nullIfNotFound;
 }
 exports.acceptNotFoundMiddleware = (ctx, next) => __awaiter(this, void 0, void 0, function* () {
-    console.error('acceptNotFoundMiddleware');
     const { config } = ctx;
     if (nullIfNotFound(config)) {
         ctx.config.validateStatus = addNotFound(config.validateStatus);
@@ -21,7 +20,6 @@ exports.acceptNotFoundMiddleware = (ctx, next) => __awaiter(this, void 0, void 0
     yield next();
 });
 exports.notFoundFallbackMiddleware = (ctx, next) => __awaiter(this, void 0, void 0, function* () {
-    console.error('notFoundFallbackMiddleware');
     yield next();
     const { config } = ctx;
     if (nullIfNotFound(config) && ctx.response && ctx.response.status === 404) {

package/lib/HttpClient/middlewares/recorder.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.recorderMiddleware = (recorder) => {
     return (ctx, next) => __awaiter(this, void 0, void 0, function* () {
-        console.error('recorderMiddleware');
         try {
             yield next();
             if (ctx.response) {

package/lib/HttpClient/middlewares/request.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = require("axios");
-// import * as retry from 'axios-retry'
+const retry = require("axios-retry");
 const http_1 = require("http");
 const http = axios_1.default.create({
     httpAgent: new http_1.Agent({
@@ -17,7 +17,7 @@ const http = axios_1.default.create({
         maxFreeSockets: 50,
     }),
 });
-// retry(http)
+retry(http);
 http.interceptors.response.use(response => response, (err) => {
     try {
         delete err.response.request;
@@ -30,12 +30,10 @@ http.interceptors.response.use(response => response, (err) => {
 });
 exports.defaultsMiddleware = (baseURL, headers, timeout) => {
     return (ctx, next) => __awaiter(this, void 0, void 0, function* () {
-        console.error('defaultsMiddleware');
         ctx.config = Object.assign({ baseURL, maxRedirects: 0, timeout, validateStatus: status => (status >= 200 && status < 300) }, ctx.config, { headers: Object.assign({}, headers, ctx.config.headers) });
         yield next();
     });
 };
 exports.requestMiddleware = (ctx, next) => __awaiter(this, void 0, void 0, function* () {
-    console.error('requestMiddleware');
     ctx.response = yield http.request(ctx.config);
 });

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.1-beta.0",
+  "version": "1.9.2",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

package/#package.json#

@@ -1,53 +0,0 @@
-{
-  "name": "@vtex/api",
-  "version": "0.48.1-beta.6",
-  "description": "VTEX I/O API client",
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
-  "scripts": {
-    "clean": "rimraf lib/",
-    "watch": "tsc --watch",
-    "build": "tsc",
-    "lint": "tsc --noEmit && tslint src/*.ts",
-    "prepublish": "run-s clean build"
-  },
-  "engines": {
-    "node": ">=6"
-  },
-  "keywords": [
-    "vtex"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:vtex/node-vtex-api.git"
-  },
-  "license": "MIT",
-  "dependencies": {
-    "@types/lru-cache": "^4.1.1",
-    "archiver": "^2.1.0",
-    "axios": "^0.16.0",
-    "axios-retry": "^1.2.0",
-    "koa-compose": "^4.1.0",
-    "lru-cache": "^4.1.3",
-    "mime-types": "^2.1.12",
-    "multipart-stream": "^2.0.1",
-    "qs": "^6.5.1",
-    "semver": "^5.5.1",
-    "tar-fs": "^1.15.3"
-  },
-  "devDependencies": {
-    "@types/archiver": "^2.0.1",
-    "@types/koa-compose": "^3.2.2",
-    "@types/lru-cache": "^4.1.1",
-    "@types/mime-types": "^2.1.0",
-    "@types/node": "^8.0.14",
-    "@types/qs": "^6.5.1",
-    "@types/semver": "^5.5.0",
-    "npm-run-all": "^2.3.0",
-    "rimraf": "^2.5.2",
-    "tslint": "^4.0.0",
-    "tslint-config-vtex": "^1.3.1",
-    "tslint-eslint-rules": "^4.1.1",
-    "typescript": "^2.7.1"
-  }
-}