Add masking on HTTP request/response logging

zeplin · Jan 15, 2020 · f0aec66 · f0aec66
1 parent 0770692
commit f0aec66
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -65,6 +65,7 @@
     "http-status-codes": "^1.4.0",
     "inquirer": "^7.0.0",
     "jsonwebtoken": "^8.5.1",
+    "mask-json": "^1.0.3",
     "strip-ansi": "^6.0.0",
     "ts-dedent": "^1.1.0",
     "url-join": "^4.0.1",

diff --git a/src/api/interceptors.ts b/src/api/interceptors.ts
@@ -1,15 +1,20 @@
 import { AxiosRequestConfig, AxiosResponse } from "axios";
+import maskJson from "mask-json";
 import logger from "../util/logger";
 
+const blacklist = ["password", "Zeplin-Access-Token", "Zeplin-Token"];
+
+const mask = maskJson(blacklist);
+
 const requestLogger = (request: AxiosRequestConfig): AxiosRequestConfig => {
     const { url, method, data, headers } = request;
     let httpLog = `HTTP Request: ${method} ${url}`;
 
     if (headers) {
-        httpLog = httpLog.concat(`, Headers: ${JSON.stringify(headers)}`);
+        httpLog = httpLog.concat(`, Headers: ${JSON.stringify(mask(headers))}`);
     }
     if (data) {
-        httpLog = httpLog.concat(`, Body: ${JSON.stringify(data)}`);
+        httpLog = httpLog.concat(`, Body: ${JSON.stringify(mask(data))}`);
     }
 
     logger.http(httpLog);
@@ -30,11 +35,10 @@ const responseLogger = (response: AxiosResponse): AxiosResponse => {
         .concat(`, Status: ${status}-${statusText}`);
 
     if (headers) {
-        httpLog = httpLog.concat(`, Headers: ${JSON.stringify(headers)}`);
+        httpLog = httpLog.concat(`, Headers: ${JSON.stringify(mask(headers))}`);
     }
-
     if (data) {
-        httpLog = httpLog.concat(`, Body: ${JSON.stringify(data)}`);
+        httpLog = httpLog.concat(`, Body: ${JSON.stringify(mask(data))}`);
     }
 
     logger.http(httpLog);

diff --git a/src/errors/APIError.ts b/src/errors/APIError.ts
@@ -14,7 +14,7 @@ export class APIError extends CLIError {
                     message = "Looks like your session has expired, please login again.";
                     break;
                 case BAD_REQUEST:
-                    message = "There is a problem with the request payload.";
+                    message = "There is a problem with the API request.";
                     break;
                 default:
                     message = `${response.data.title} - ${response.data.message}`;

diff --git a/src/types/mask-json.d.ts b/src/types/mask-json.d.ts
@@ -0,0 +1,10 @@
+type FunctionReturnsSameType = <T>(object: T) => T;
+
+declare module "mask-json" {
+    function maskJson(
+        collection: Array<string>,
+        opts?: { ignoreCase: boolean; replacement: string }
+    ): FunctionReturnsSameType;
+
+    export = maskJson;
+}