kayvee 3.16.0 → 3.18.0

package/lib/logger/logger.ts

@@ -1,23 +1,22 @@
-var _   = require("underscore");
-var kv  = require("../kayvee");
+var _ = require("underscore");
+var kv = require("../kayvee");
 var router = require("../router");
 
-
 var LEVELS = {
-  Trace:    "trace",
-  Debug:    "debug",
-  Info:     "info",
-  Warning:  "warning",
-  Error:    "error",
+  Trace: "trace",
+  Debug: "debug",
+  Info: "info",
+  Warning: "warning",
+  Error: "error",
   Critical: "critical",
 };
 
 var LOG_LEVEL_ENUM = {
-  trace:    0,
-  debug:    1,
-  info:     2,
-  warning:  3,
-  error:    4,
+  trace: 0,
+  debug: 1,
+  info: 2,
+  warning: 3,
+  error: 4,
   critical: 5,
 };
 
@@ -41,13 +40,20 @@ class Logger {
   globals = null;
   logWriter = null;
   logRouter = null;
-
-  constructor(source, logLvl = process.env.KAYVEE_LOG_LEVEL, formatter = kv.format, output = console.error) {
+  asyncLocalStorage = null;
+
+  constructor(
+    source,
+    logLvl = process.env.KAYVEE_LOG_LEVEL,
+    formatter = kv.format,
+    output = console.error,
+  ) {
     this.formatter = formatter;
     this.logLvl = this._validateLogLvl(logLvl);
     this.globals = {};
     this.globals.source = source;
     this.logWriter = output;
+    this.asyncLocalStorage = null;
 
     if (process.env._TEAM_OWNER) {
       this.globals.team = process.env._TEAM_OWNER;
@@ -72,6 +78,10 @@ class Logger {
     }
   }
 
+  setAsyncLocalStorage(asyncLocalStorage) {
+    this.asyncLocalStorage = asyncLocalStorage;
+  }
+
   setRouter(r) {
     this.logRouter = r;
   }
@@ -147,62 +157,104 @@ class Logger {
   }
 
   traceD(title, data) {
-    this._logWithLevel(LEVELS.Trace, {
-      title,
-    }, data);
+    this._logWithLevel(
+      LEVELS.Trace,
+      {
+        title,
+      },
+      data,
+    );
   }
 
   debugD(title, data) {
-    this._logWithLevel(LEVELS.Debug, {
-      title,
-    }, data);
+    this._logWithLevel(
+      LEVELS.Debug,
+      {
+        title,
+      },
+      data,
+    );
   }
 
   infoD(title, data) {
-    this._logWithLevel(LEVELS.Info, {
-      title,
-    }, data);
+    this._logWithLevel(
+      LEVELS.Info,
+      {
+        title,
+      },
+      data,
+    );
   }
 
   warnD(title, data) {
-    this._logWithLevel(LEVELS.Warning, {
-      title,
-    }, data);
+    this._logWithLevel(
+      LEVELS.Warning,
+      {
+        title,
+      },
+      data,
+    );
   }
 
   errorD(title, data) {
-    this._logWithLevel(LEVELS.Error, {
-      title,
-    }, data);
+    this._logWithLevel(
+      LEVELS.Error,
+      {
+        title,
+      },
+      data,
+    );
   }
 
   criticalD(title, data) {
-    this._logWithLevel(LEVELS.Critical, {
-      title,
-    }, data);
+    this._logWithLevel(
+      LEVELS.Critical,
+      {
+        title,
+      },
+      data,
+    );
   }
 
   counterD(title, value, data) {
-    this._logWithLevel(LEVELS.Info, {
-      title,
-      value,
-      type: "counter",
-    }, data);
+    this._logWithLevel(
+      LEVELS.Info,
+      {
+        title,
+        value,
+        type: "counter",
+      },
+      data,
+    );
   }
 
   gaugeD(title, value, data) {
-    this._logWithLevel(LEVELS.Info, {
-      title,
-      value,
-      type:  "gauge",
-    }, data);
+    this._logWithLevel(
+      LEVELS.Info,
+      {
+        title,
+        value,
+        type: "gauge",
+      },
+      data,
+    );
   }
 
   _logWithLevel(logLvl, metadata, userdata) {
     if (LOG_LEVEL_ENUM[logLvl] < LOG_LEVEL_ENUM[this.logLvl]) {
       return;
     }
-    const data = assign({level: logLvl}, this.globals, metadata, userdata);
+    // I'm not clever enough to want to do these in one line without extra vars.
+    // We're on a REALLY old version of TS compiling to ES5. So I don't get a lot of the fancy tools
+    // like ?. and ??.
+    const store = this.asyncLocalStorage && this.asyncLocalStorage.getStore();
+    const storeData = store || { get: () => ({}) };
+    const contextData = storeData.get("context") ? storeData.get("context") : {};
+    const plainContextData =
+      contextData instanceof Map ? Object.fromEntries(contextData) : contextData;
+
+    var data = assign({ level: logLvl }, this.globals, metadata, plainContextData, userdata);
+
     if (this.logRouter) {
       data._kvmeta = this.logRouter.route(data);
     } else if (globalRouter) {
@@ -228,11 +280,13 @@ module.exports.mockRouting = (cb) => {
     const formatter = this.formatter;
     const logWriter = this.logWriter;
 
-    this.formatter = msg => msg;
+    this.formatter = (msg) => msg;
     this.logWriter = (msg) => {
-      if (!msg._kvmeta) { return; }
+      if (!msg._kvmeta) {
+        return;
+      }
 
-      msg._kvmeta.routes.forEach(route => {
+      msg._kvmeta.routes.forEach((route) => {
         ruleMatches[route.rule] = (ruleMatches[route.rule] || []).concat(route);
       });
     };

package/lib/middleware.ts

@@ -38,7 +38,9 @@ function walkDirSync(dir, files = []) {
 function skip_path(dir, base_path = "/") {
   let files = walkDirSync(dir);
   files = files.map((file) => path.join(base_path, file));
-  console.error(`KayveeMiddleware: Skipping successful requests for files in ${dir} at ${base_path}`);
+  console.error(
+    `KayveeMiddleware: Skipping successful requests for files in ${dir} at ${base_path}`,
+  );
   return (req, res) => _(files).contains(req.path) && res.statusCode < 400;
 }
 
@@ -59,7 +61,10 @@ function getBaseUrl(req) {
 function getQueryParams(req) {
   var url = req.originalUrl || req.url;
   var parsed = require("url").parse(url, true);
-  var parsedQueryString = require("qs").parse(parsed.search, {allowPrototypes: false, ignoreQueryPrefix: true});
+  var parsedQueryString = require("qs").parse(parsed.search, {
+    allowPrototypes: false,
+    ignoreQueryPrefix: true,
+  });
   return `?${require("qs").stringify(parsedQueryString)}`;
 }
 
@@ -89,8 +94,7 @@ function getResponseTimeNs(req, res) {
   }
 
   // calculate diff
-  var ns = (res._startAt[0] - req._startAt[0]) * 1e9
-    + (res._startAt[1] - req._startAt[1]);
+  var ns = (res._startAt[0] - req._startAt[0]) * 1e9 + (res._startAt[1] - req._startAt[1]);
   return ns;
 }
 
@@ -118,44 +122,34 @@ function getLogLevel(req, res) {
   return result;
 }
 
-/**
- * Get canary status
- */
-function isCanary() {
-  return (process.env._CANARY === "1") || ("_POD_SHORTNAME" in process.env && process.env._POD_SHORTNAME.includes("-canary"));
-}
-
 /*
  * Default handlers
  */
 var defaultHandlers = [
   // Request method
-  (req) => ({method: req.method}),
+  (req) => ({ method: req.method }),
   // Path (URL without query params)
-  (req) => ({path: getBaseUrl(req)}),
+  (req) => ({ path: getBaseUrl(req) }),
   // Query params
-  (req) => ({params: getQueryParams(req)}),
+  (req) => ({ params: getQueryParams(req) }),
   // Response size
-  (req, res) => ({"response-size": getResponseSize(res)}),
+  (req, res) => ({ "response-size": getResponseSize(res) }),
   // Response time (ns)
-  (req, res) => ({"response-time": getResponseTimeNs(req, res)}),
+  (req, res) => ({ "response-time": getResponseTimeNs(req, res) }),
   // Status code
-  (req, res) => ({"status-code": res.statusCode}),
+  (req, res) => ({ "status-code": res.statusCode }),
   // Ip address
-  (req) => ({ip: getIp(req)}),
+  (req) => ({ ip: getIp(req) }),
   // Via -- what library/code produced this log?
-  () => ({via: "kayvee-middleware"}),
+  () => ({ via: "kayvee-middleware" }),
 
   // Kayvee's reserved fields
   // Log level
-  (req, res) => ({level: getLogLevel(req, res)}),
+  (req, res) => ({ level: getLogLevel(req, res) }),
   // Source -- which app emitted this log?
   // -> Gets passed in among `options` during library initialization
   // Title
-  () => ({title: "request-finished"}),
-  // During the transition to pods, let's keep the canary field accurate
-  // whether it's in the canary pod or a canary container in homepod
-  () => ({canary: isCanary()}),
+  () => ({ title: "request-finished" }),
 ];
 
 const defaultContextHandlers = [];
@@ -167,7 +161,7 @@ function handlerData(handlers, ...args) {
       const handler_data = h(...args);
       _.extend(data, handler_data);
     } catch (e) {
-      // ignore invalid handler
+      // swallow invalid handler
     }
   });
   return data;
@@ -236,14 +230,14 @@ var formatLine = (options_arg) => {
 
   // `source` is the one required field
   if (!options.source) {
-    throw (Error("Missing required config for 'source' in Kayvee middleware 'options'"));
+    throw Error("Missing required config for 'source' in Kayvee middleware 'options'");
   }
 
   const router = KayveeLogger.getGlobalRouter();
 
   return (tokens, req, res) => {
     // Build a dict of data to log
-    var data = {_kvmeta: undefined}; // Adding _kvmeta here to make typescript compile happy
+    var data = { _kvmeta: undefined }; // Adding _kvmeta here to make typescript compile happy
 
     // Add user-configured request headers
     var custom_headers = options.headers || [];
@@ -260,7 +254,7 @@ var formatLine = (options_arg) => {
 
     // Allow user to override `base_handlers`; provide sane default set of handlers
     var base_handlers = options.base_handlers || defaultHandlers;
-    base_handlers = base_handlers.concat([() => ({source: options.source})]);
+    base_handlers = base_handlers.concat([() => ({ source: options.source })]);
 
     // Execute custom-handlers THEN base-handlers
     const all_handlers = custom_handlers.concat(base_handlers);
@@ -285,9 +279,12 @@ const defaultContextLoggerOpts = {
  */
 
 if (process.env.NODE_ENV === "test") {
-  module.exports = (clever_options, morgan_options = {skip: null}) => {
+  module.exports = (clever_options, morgan_options = { skip: null }) => {
     if (clever_options.ignore_dir) {
-      morgan_options.skip = skip_path(clever_options.ignore_dir.directory, clever_options.ignore_dir.path);
+      morgan_options.skip = skip_path(
+        clever_options.ignore_dir.directory,
+        clever_options.ignore_dir.path,
+      );
     }
     return morgan(formatLine(clever_options), morgan_options);
   };
@@ -304,7 +301,10 @@ if (process.env.NODE_ENV === "test") {
       skip: null,
     };
     if (clever_options.ignore_dir) {
-      morgan_options.skip = skip_path(clever_options.ignore_dir.directory, clever_options.ignore_dir.path);
+      morgan_options.skip = skip_path(
+        clever_options.ignore_dir.directory,
+        clever_options.ignore_dir.path,
+      );
     }
     const morgan_logger = morgan(formatLine(clever_options), morgan_options);
     return (req, res, next) => {

package/lib/router/index.ts

@@ -1,8 +1,8 @@
-var fs           = require("fs");
-var jsonschema   = require("jsonschema");
-var schema       = require("./schema_definitions");
-var yaml         = require("js-yaml");
-var _            = require("underscore");
+var fs = require("fs");
+var jsonschema = require("jsonschema");
+var schema = require("./schema_definitions");
+var yaml = require("js-yaml");
+var _ = require("underscore");
 
 var packageJson = require("../../package.json");
 const kvVersion = packageJson.version;
@@ -58,7 +58,9 @@ function fieldMatches(obj, field, values) {
   }
 
   for (let i = 0; i < values.length; i++) {
-    if (values[i] === val) { return true; }
+    if (values[i] === val) {
+      return true;
+    }
   }
 
   return false;
@@ -91,7 +93,7 @@ class Rule {
       if (fieldVals.indexOf("*") !== -1 && fieldVals.length > 1) {
         throw new Error(
           `Invalid matcher values in ${name}.${field}.\n` +
-          "Wildcard matcher can't co-exist with other matchers."
+            "Wildcard matcher can't co-exist with other matchers.",
         );
       }
     });
@@ -106,7 +108,9 @@ class Rule {
   // matches returns true if `msg` matches against this rule
   matches(msg) {
     for (const field in this.matchers) {
-      if (!fieldMatches(msg, field, this.matchers[field])) { return false; }
+      if (!fieldMatches(msg, field, this.matchers[field])) {
+        return false;
+      }
     }
 
     return true;
@@ -161,20 +165,21 @@ function parseConfig(fileString) {
   try {
     config = yaml.safeLoad(fileString);
   } catch (e) {
-    return {valid: false, rules: [], errors: [e]};
+    return { valid: false, rules: [], errors: [e] };
   }
   const validateRes = validateKVConfig(config);
   if (!validateRes.valid) {
-    return _.assign(validateRes, {rules: []});
+    return _.assign(validateRes, { rules: [] });
   }
   try {
     const rulesObj = _.mapObject(
-      config.routes, (elem, name) => new Rule(name, elem.matchers, elem.output)
+      config.routes,
+      (elem, name) => new Rule(name, elem.matchers, elem.output),
     );
     const rules = _.values(rulesObj);
-    return {valid: true, rules, errors: []};
+    return { valid: true, rules, errors: [] };
   } catch (e) {
-    return {valid: false, rules: [], errors: [e]};
+    return { valid: false, rules: [], errors: [e] };
   }
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kayvee",
   "description": "Write data to key=val pairs, for human and machine readability",
-  "version": "3.16.0",
+  "version": "3.18.0",
   "main": "index.js",
   "repository": {
     "type": "git",
@@ -16,19 +16,27 @@
     "underscore": "^1.8.3"
   },
   "devDependencies": {
+    "@clever/prettier-config": "1.0.0",
+    "@types/mocha": "^8.0.3",
+    "@types/node": "^12.12.68",
+    "@typescript-eslint/eslint-plugin": "^5.2.0",
+    "@typescript-eslint/parser": "^5.2.0",
     "babel-eslint": "^6.0.2",
     "benchmark": "^2.1.1",
-    "eslint": "^2.7.0",
+    "eslint": "^7.11.0",
     "eslint-config-airbnb": "^7.0.0",
-    "eslint-plugin-jsx-a11y": "^0.6.2",
-    "eslint-plugin-react": "^4.3.0",
+    "eslint-config-prettier": "^6.12.0",
+    "eslint-formatter-summary": "^1.1.0",
+    "eslint-plugin-jsx-a11y": "^6.3.1",
+    "eslint-plugin-react": "^7.21.5",
+    "eslint-plugin-react-hooks": "^4.1.2",
     "express": "^4.13.4",
-    "mocha": "^2.5.3",
+    "mocha": "^3.5.3",
+    "prettier": "2.1.2",
     "sinon": "^1.17.4",
     "supertest": "^1.2.0",
-    "ts-node": "^0.7.1",
-    "tslint": "^3.7.4",
-    "typescript": "^1.8.9"
+    "ts-node": "^9.0.0",
+    "typescript": "^3.9.10"
   },
   "scripts": {
     "test": "make -Br test",

package/test/context_logger.ts

@@ -5,8 +5,8 @@ var middleware = require("../lib/middleware");
 var KayveeLogger = require("../lib/logger/logger");
 
 describe("ContextLogger", () => {
-  const fake_req = {key1: "val1"};
-  const fake_handler = (req) => ({log_key1: req.key1, key2: "val2"});
+  const fake_req = { key1: "val1" };
+  const fake_handler = (req) => ({ log_key1: req.key1, key2: "val2" });
 
   for (const level of KayveeLogger.LEVELS) {
     it(`correctly adds context to ${level} calls`, () => {
@@ -15,7 +15,7 @@ describe("ContextLogger", () => {
       stub_logger[`${level}D`] = spy;
       const log = new middleware.ContextLogger(stub_logger, [fake_handler], fake_req);
       log[level]("test_title");
-      const expected_context = {log_key1: "val1", key2: "val2"};
+      const expected_context = { log_key1: "val1", key2: "val2" };
       assert(spy.calledWithExactly("test_title", expected_context));
       assert.equal(spy.callCount, 1);
     });
@@ -25,7 +25,7 @@ describe("ContextLogger", () => {
       const stub_logger = {};
       stub_logger[`${level}D`] = spy;
       const log = new middleware.ContextLogger(stub_logger, [fake_handler], fake_req);
-      log[`${level}D`]("test_title", {key2: "new_value", key3: "val3"});
+      log[`${level}D`]("test_title", { key2: "new_value", key3: "val3" });
       const expected_data = {
         log_key1: "val1",
         key2: "new_value",
@@ -43,7 +43,7 @@ describe("ContextLogger", () => {
       stub_logger[`${metric}D`] = spy;
       const log = new middleware.ContextLogger(stub_logger, [fake_handler], fake_req);
       log[metric]("test_title", 3);
-      const expected_context = {log_key1: "val1", key2: "val2"};
+      const expected_context = { log_key1: "val1", key2: "val2" };
       assert(spy.calledWithExactly("test_title", 3, expected_context));
       assert.equal(spy.callCount, 1);
     });
@@ -53,7 +53,7 @@ describe("ContextLogger", () => {
       const stub_logger = {};
       stub_logger[`${metric}D`] = spy;
       const log = new middleware.ContextLogger(stub_logger, [fake_handler], fake_req);
-      log[`${metric}D`]("test_title", 3, {key2: "new_value", key3: "val3"});
+      log[`${metric}D`]("test_title", 3, { key2: "new_value", key3: "val3" });
       const expected_data = {
         log_key1: "val1",
         key2: "new_value",
@@ -66,7 +66,7 @@ describe("ContextLogger", () => {
 
   it("correctly handles being instantiated with empty list of handlers", () => {
     const spy = sinon.spy();
-    const stub_logger = {infoD: spy};
+    const stub_logger = { infoD: spy };
     const log = new middleware.ContextLogger(stub_logger, [], fake_req);
     log.info("test_title");
     const expected_context = {};

package/test/kayvee.ts

@@ -1,4 +1,4 @@
-var kv  = require("../lib/kayvee");
+var kv = require("../lib/kayvee");
 var assert = require("assert");
 var _ = require("underscore");
 var fs = require("fs");
@@ -10,15 +10,17 @@ describe("kayvee", () => {
       it(spec.title, () => {
         const actual = kv.format(spec.input.data);
         const expected = spec.output;
-        assert.deepEqual(JSON.parse(actual), _.extend({deploy_env: "testing", wf_id: "abc"},
-                                                      JSON.parse(expected)));
+        assert.deepEqual(
+          JSON.parse(actual),
+          _.extend({ deploy_env: "testing", wf_id: "abc" }, JSON.parse(expected)),
+        );
       });
     });
   });
 
   describe(".format with Errors", () => {
     it("encodes Error objects", () => {
-      const actual = kv.format({err: Error("An Error Message")});
+      const actual = kv.format({ err: Error("An Error Message") });
       const expected = {
         deploy_env: "testing",
         wf_id: "abc",
@@ -31,10 +33,17 @@ describe("kayvee", () => {
   describe(".formatLog", () => {
     _.each(tests.formatLog, (spec) => {
       it(spec.title, () => {
-        const actual = kv.formatLog(spec.input.source, spec.input.level, spec.input.title, spec.input.data);
+        const actual = kv.formatLog(
+          spec.input.source,
+          spec.input.level,
+          spec.input.title,
+          spec.input.data,
+        );
         const expected = spec.output;
-        assert.deepEqual(JSON.parse(actual), _.extend({deploy_env: "testing", wf_id: "abc"},
-                                                      JSON.parse(expected)));
+        assert.deepEqual(
+          JSON.parse(actual),
+          _.extend({ deploy_env: "testing", wf_id: "abc" }, JSON.parse(expected)),
+        );
       });
     });
   });