@vtex/api 3.77.3 → 3.77.6

package/CHANGELOG.md

@@ -7,6 +7,24 @@ 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.
+
+## [3.77.4] - 2021-10-22
+
+## [3.77.3] - 2021-10-22
+### Fixed
+- Extract session cookie in a safe manner
+
+## [3.77.2] - 2021-08-26
+### Fixed
+- Extract session cookie in a safe manner
+
 ## [3.77.1] - 2021-02-05
 - Increase HTTP agents connection pools freeSockets and lifetime
 

package/lib/clients/Segment.d.ts

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

package/lib/clients/Segment.js

@@ -1,13 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const cookie_1 = __importDefault(require("cookie"));
 const ramda_1 = require("ramda");
 const constants_1 = require("../constants");
 const HttpClient_1 = require("../HttpClient");
-const SEGMENT_COOKIE = 'vtex_segment';
+const Session_1 = require("./Session");
 const SEGMENT_MAX_AGE_S = 60 * 60; // 60 minutes - segment is actually immutable
 const ALLOWED_QUERY_PREFIXES = ['utm', 'cultureInfo', 'supportedLocales'];
 const filterAndSortQuery = (query) => {
@@ -48,12 +44,10 @@ class Segment extends HttpClient_1.JanusClient {
          */
         this.getSegmentByToken = (token) => this.rawSegment(token).then(ramda_1.prop('data'));
         this.getOrCreateSegment = async (query, token) => {
-            const { data: segmentData, headers: { 'set-cookie': [setCookies], }, } = await this.rawSegment(token, query);
-            const parsedCookie = cookie_1.default.parse(setCookies);
-            const segmentToken = ramda_1.prop(SEGMENT_COOKIE, parsedCookie);
+            const { data: segmentData, headers, } = await this.rawSegment(token, query);
             return {
                 segmentData,
-                segmentToken,
+                segmentToken: Session_1.extractSessionCookie(headers) || token,
             };
         };
         this.rawSegment = (token, query) => {

package/lib/clients/Session.d.ts

@@ -12,3 +12,4 @@ export declare class Session extends JanusClient {
      */
     updateSession: (key: string, value: any, items: string[], token: any) => Promise<void>;
 }
+export declare function extractSessionCookie(headers: Record<string, string>): string | null;

package/lib/clients/Session.js

@@ -61,3 +61,4 @@ function extractSessionCookie(headers) {
     }
     return null;
 }
+exports.extractSessionCookie = extractSessionCookie;

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

package/package.json

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