@vtex/api 6.45.4 → 6.45.7

package/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [6.45.7] - 2022-02-23
+
+### Fixed
+
+- Remove sensitive data from logs.
+
+## [6.45.6] - 2021-10-26
+
+### Fixed
+
+- `vtex_segment` cookie extraction
+
+## [6.54.5] - 2021-10-22
+
+### Fixed
+
+- Extract session cookie in a safe manner
+
 ## [6.45.4] - 2021-09-16
 
 ### Removed

package/lib/clients/janus/Segment.d.ts

@@ -30,7 +30,7 @@ export declare class Segment extends JanusClient {
     getSegmentByToken: (token: string | null, tracingConfig?: RequestTracingConfig | undefined) => Promise<SegmentData>;
     getOrCreateSegment: (query?: Record<string, string> | undefined, token?: string | undefined, tracingConfig?: RequestTracingConfig | undefined) => Promise<{
         segmentData: SegmentData;
-        segmentToken: string;
+        segmentToken: string | null;
     }>;
     private rawSegment;
 }

package/lib/clients/janus/Segment.js

@@ -25,7 +25,7 @@ const filterAndSortQuery = (query) => {
 };
 const routes = {
     base: '/api/segments',
-    segments: (token) => token ? `${routes.base}/${token}` : routes.base,
+    segments: (token) => (token ? `${routes.base}/${token}` : routes.base),
 };
 class Segment extends JanusClient_1.JanusClient {
     constructor() {
@@ -43,19 +43,17 @@ class Segment extends JanusClient_1.JanusClient {
          */
         this.getSegmentByToken = (token, tracingConfig) => this.rawSegment(token, undefined, tracingConfig).then(ramda_1.prop('data'));
         this.getOrCreateSegment = async (query, token, tracingConfig) => {
-            const { data: segmentData, headers: { 'set-cookie': [setCookies], }, } = await this.rawSegment(token, query, tracingConfig);
-            const parsedCookie = cookie_1.default.parse(setCookies);
-            const segmentToken = ramda_1.prop(SEGMENT_COOKIE, parsedCookie);
+            const { data: segmentData, headers } = await this.rawSegment(token, query, tracingConfig);
             return {
                 segmentData,
-                segmentToken,
+                segmentToken: extractSegmentCookie(headers),
             };
         };
         this.rawSegment = (token, query, tracingConfig) => {
             const { product, workspace } = this.context;
             const filteredQuery = filterAndSortQuery(query);
             const metric = token ? 'segment-get-token' : 'segment-get-new';
-            return this.http.getRaw(routes.segments(token), ({
+            return this.http.getRaw(routes.segments(token), {
                 forceMaxAge: SEGMENT_MAX_AGE_S,
                 headers: {
                     'Content-Type': 'application/json',
@@ -72,8 +70,19 @@ class Segment extends JanusClient_1.JanusClient {
                     requestSpanNameSuffix: metric,
                     ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
                 },
-            }));
+            });
         };
     }
 }
 exports.Segment = Segment;
+function extractSegmentCookie(headers) {
+    var _a;
+    for (const setCookie of (_a = headers['set-cookie']) !== null && _a !== void 0 ? _a : []) {
+        const parsedCookie = cookie_1.default.parse(setCookie);
+        const segmentCookie = parsedCookie[SEGMENT_COOKIE];
+        if (segmentCookie != null) {
+            return segmentCookie;
+        }
+    }
+    return null;
+}

package/lib/clients/janus/Session.js

@@ -21,7 +21,7 @@ class Session extends JanusClient_1.JanusClient {
             const { data: sessionData, headers } = await this.http.getRaw(routes.base, {
                 headers: {
                     'Content-Type': 'application/json',
-                    'Cookie': `vtex_session=${token};`,
+                    Cookie: `vtex_session=${token};`,
                 },
                 metric,
                 params: {
@@ -46,7 +46,7 @@ class Session extends JanusClient_1.JanusClient {
             const config = {
                 headers: {
                     'Content-Type': 'application/json',
-                    'Cookie': `vtex_session=${token};`,
+                    Cookie: `vtex_session=${token};`,
                 },
                 metric,
                 params: {

package/lib/service/logger/logger.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const constants_1 = require("../../constants");
 const error_1 = require("../../utils/error");
+const log_1 = require("../../utils/log");
 const console_1 = require("./console");
 const linked = !!process.env.VTEX_APP_LINK;
 const app = constants_1.APP.ID;
@@ -22,6 +23,7 @@ class Logger {
         this.log = (message, level) => {
             var _a;
             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/service/worker/runtime/graphql/utils/error.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 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'];
 const QUERY_FIELDS = ['query', 'operationName', 'variables'];
 const trimVariables = (variables) => {
@@ -48,8 +49,8 @@ const formatError = (error, details) => {
             formattedError.extensions.exception = {
                 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),
+                ...ramda_1.omit(log_1.FIRST_LEVEL_SENSITIVE_FIELDS, formattedError.originalError),
+                sensitive: ramda_1.pick(log_1.FIRST_LEVEL_SENSITIVE_FIELDS, formattedError.originalError),
             };
         }
         else {
@@ -59,8 +60,8 @@ const formatError = (error, details) => {
             const extendedException = {
                 message: formattedError.originalError.message,
                 name: formattedError.originalError.name,
-                ...ramda_1.omit(error_1.SENSITIVE_EXCEPTION_FIELDS, mergedException),
-                sensitive: ramda_1.pick(error_1.SENSITIVE_EXCEPTION_FIELDS, mergedException),
+                ...ramda_1.omit(log_1.FIRST_LEVEL_SENSITIVE_FIELDS, mergedException),
+                sensitive: ramda_1.pick(log_1.FIRST_LEVEL_SENSITIVE_FIELDS, mergedException),
             };
             formattedError.extensions.exception = error_1.cleanError(extendedException);
         }

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

@@ -4,6 +4,7 @@ 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 logger_1 = require("../../../../logger");
 const CACHE_CONTROL_HEADER = 'cache-control';
 const META_HEADER = 'x-vtex-meta';
@@ -39,7 +40,7 @@ const logAndRemoveSensitiveData = (ctx, err) => {
     // Use sendLog directly to avoid cleaning error twice.
     ctx.vtex.logger.log(log, level);
     if (!constants_1.LINKED) {
-        error_1.SENSITIVE_EXCEPTION_FIELDS.forEach(field => {
+        log_1.FIRST_LEVEL_SENSITIVE_FIELDS.forEach(field => {
             delete err[field];
         });
     }

package/lib/utils/error.d.ts

@@ -1,5 +1,4 @@
 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,7 +3,6 @@ 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/log.d.ts

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

package/lib/utils/log.js

@@ -0,0 +1,14 @@
+"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']];
+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]];
+        }
+    });
+};

package/package.json

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