@middy/input-output-logger 3.0.0-alpha.2 → 3.0.0-alpha.6

package/README.md

@@ -41,10 +41,10 @@ npm install --save @middy/input-output-logger
 
 ## Options
 
-- `logger` function (default `console.log`): logging function that accepts an object
-- `awsContext` boolean (default `false`): Include [AWS Lambda context object](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-context.html) to the logger
-- `omitPaths` string[] (default `[]`): property accepts an array of paths that will be used to remove particular fields import the logged objects. This could serve as a simple way to redact sensitive data from logs (default []).
-
+- `logger` (function) (default `console.log`): logging function that accepts an object
+- `awsContext` (boolean) (default `false`): Include [AWS Lambda context object](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-context.html) to the logger
+- `omitPaths` (string[]) (default `[]`): property accepts an array of paths that will be used to remove particular fields import the logged objects. This could serve as a simple way to redact sensitive data from logs (default []).
+- `replacer` (function) (default undefined): A [replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Parameters) parameter may be passed which will be used `JSON.stringify`ing the request during cloning.
 
 ## Sample usage
 

package/index.js

@@ -1,18 +1,22 @@
+import { jsonSafeParse, jsonSafeStringify } from '@middy/util';
 const defaults = {
-  logger: data => console.log(JSON.stringify(data, null, 2)),
+  logger: console.log,
   awsContext: false,
-  omitPaths: []
+  omitPaths: [],
+  replacer: undefined
 };
 
 const inputOutputLoggerMiddleware = (opts = {}) => {
   let {
     logger,
     awsContext,
-    omitPaths
+    omitPaths,
+    replacer
   } = { ...defaults,
     ...opts
   };
   if (typeof logger !== 'function') logger = null;
+  const omitPathTree = buildPathOmitTree(omitPaths);
 
   const omitAndLog = (param, request) => {
     const message = {
@@ -23,15 +27,22 @@ const inputOutputLoggerMiddleware = (opts = {}) => {
       message.context = pick(request.context, awsContextKeys);
     }
 
-    const redactedMessage = omit(JSON.parse(JSON.stringify(message)), omitPaths);
-    logger(redactedMessage);
+    const cloneMessage = jsonSafeParse(jsonSafeStringify(message, replacer));
+    omit(cloneMessage, {
+      [param]: omitPathTree[param]
+    });
+    logger(cloneMessage);
   };
 
   const inputOutputLoggerMiddlewareBefore = async request => omitAndLog('event', request);
 
   const inputOutputLoggerMiddlewareAfter = async request => omitAndLog('response', request);
 
-  const inputOutputLoggerMiddlewareOnError = inputOutputLoggerMiddlewareAfter;
+  const inputOutputLoggerMiddlewareOnError = async request => {
+    if (request.response === undefined) return;
+    return omitAndLog('response', request);
+  };
+
   return {
     before: logger ? inputOutputLoggerMiddlewareBefore : undefined,
     after: logger ? inputOutputLoggerMiddlewareAfter : undefined,
@@ -53,28 +64,42 @@ const pick = (originalObject = {}, keysToPick = []) => {
   return newObject;
 };
 
-const omit = (originalObject = {}, keysToOmit = []) => {
-  const clonedObject = { ...originalObject
-  };
-
-  for (const path of keysToOmit) {
-    deleteKey(clonedObject, path);
+const buildPathOmitTree = paths => {
+  const tree = {};
+
+  for (let path of paths.sort().reverse()) {
+    if (!Array.isArray(path)) path = path.split('.');
+    if (path.includes('__proto__')) continue;
+    path.slice(0).reduce((a, b, idx) => {
+      if (idx < path.length - 1) {
+        a[b] ?? (a[b] = {});
+        return a[b];
+      }
+
+      a[b] = true;
+      return true;
+    }, tree);
   }
 
-  return clonedObject;
+  return tree;
 };
 
-const deleteKey = (obj, key) => {
-  if (!Array.isArray(key)) key = key.split('.');
-  const rootKey = key.shift();
-
-  if (key.length && obj[rootKey]) {
-    deleteKey(obj[rootKey], key);
-  } else {
-    delete obj[rootKey];
+const omit = (obj, pathTree = {}) => {
+  if (Array.isArray(obj) && pathTree['[]']) {
+    for (const value of obj) {
+      omit(value, pathTree['[]']);
+    }
+  } else if (isObject(obj)) {
+    for (const key in pathTree) {
+      if (pathTree[key] === true) {
+        delete obj[key];
+      } else {
+        omit(obj[key], pathTree[key]);
+      }
+    }
   }
-
-  return obj;
 };
 
+const isObject = value => value && typeof value === 'object' && value.constructor === Object;
+
 export default inputOutputLoggerMiddleware;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/input-output-logger",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.6",
   "description": "Input and output logger middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -18,7 +18,8 @@
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
   },
   "license": "MIT",
   "keywords": [
@@ -46,9 +47,12 @@
     "url": "https://github.com/middyjs/middy/issues"
   },
   "homepage": "https://github.com/middyjs/middy#readme",
+  "dependencies": {
+    "@middy/util": "^3.0.0-alpha.6"
+  },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.2",
+    "@middy/core": "^3.0.0-alpha.6",
     "@types/node": "^17.0.0"
   },
-  "gitHead": "de30419273ecbff08f367f47c7e320ec981cf145"
+  "gitHead": "176660ed3e0716d6bfb635c77251b301e0e24720"
 }