kayvee 3.17.0 → 3.18.0

package/build/test/router.js

@@ -1,11 +1,59 @@
 var assert = require("assert");
 var router = require("../lib/router");
-describe("router.Router", function () {
-    describe("constructor", function () {
-        it("parses well formatted configs", function () {
+describe("router.Router", () => {
+    describe("constructor", () => {
+        it("parses well formatted configs", () => {
             process.env.SCHOOL = "Hogwarts";
-            var conf = "\nroutes:\n  rule-one:\n    matchers:\n      title: [\"authorize-app\"]\n    output:\n      type: \"notifications\"\n      channel: \"%{foo.bar}\"\n      icon: \":rocket:\"\n      message: \"authorized %{foo.bar} in ${SCHOOL}\"\n      user: \"@fishman\"\n  rule-two:\n    matchers:\n      foo.bar: [\"multiple\", \"matches\"]\n      baz: [\"whatever\"]\n    output:\n      type: \"alerts\"\n      series: \"other-series\"\n      dimensions: [\"baz\"]\n      stat_type: \"gauge\"\n  rule-three:\n    matchers:\n      foo.bar: [\"multiple\", \"matches\"]\n      baz: [\"whatever\"]\n    output:\n      type: \"alerts\"\n      series: \"other-series\"\n      dimensions: [\"baz\"]\n      stat_type: \"gauge\"\n      value_field: \"hello\"\n  rule-four:\n    matchers:\n      foo.bar: [\"multiple\", \"matches\"]\n      baz: [\"whatever\"]\n    output:\n      type: \"alerts\"\n      series: \"other-series\"\n      dimensions: []\n      stat_type: \"gauge\"\n  rule-five:\n    matchers:\n      foo.bar: [true]\n      baz: [false]\n    output:\n      type: \"alerts\"\n      series: \"other-series\"\n      dimensions: []\n      stat_type: \"gauge\"\n";
-            var expected = [
+            const conf = `
+routes:
+  rule-one:
+    matchers:
+      title: ["authorize-app"]
+    output:
+      type: "notifications"
+      channel: "%{foo.bar}"
+      icon: ":rocket:"
+      message: "authorized %{foo.bar} in \${SCHOOL}"
+      user: "@fishman"
+  rule-two:
+    matchers:
+      foo.bar: ["multiple", "matches"]
+      baz: ["whatever"]
+    output:
+      type: "alerts"
+      series: "other-series"
+      dimensions: ["baz"]
+      stat_type: "gauge"
+  rule-three:
+    matchers:
+      foo.bar: ["multiple", "matches"]
+      baz: ["whatever"]
+    output:
+      type: "alerts"
+      series: "other-series"
+      dimensions: ["baz"]
+      stat_type: "gauge"
+      value_field: "hello"
+  rule-four:
+    matchers:
+      foo.bar: ["multiple", "matches"]
+      baz: ["whatever"]
+    output:
+      type: "alerts"
+      series: "other-series"
+      dimensions: []
+      stat_type: "gauge"
+  rule-five:
+    matchers:
+      foo.bar: [true]
+      baz: [false]
+    output:
+      type: "alerts"
+      series: "other-series"
+      dimensions: []
+      stat_type: "gauge"
+`;
+            const expected = [
                 new router.Rule("rule-one", { title: ["authorize-app"] }, {
                     type: "notifications",
                     channel: "%{foo.bar}",
@@ -42,119 +90,211 @@ describe("router.Router", function () {
                     value_field: "value",
                 }),
             ];
-            var actual = new router.Router();
+            const actual = new router.Router();
             actual._loadConfigString(conf);
             assert.deepEqual(actual.rules, expected);
         });
-        it("rejects specials in matchers", function () {
-            var confTmpl = function (v) { return "\nroutes:\n  non-string-values:\n    matchers:\n      no-numbers: [" + v + "]\n    output:\n      type: \"analytics\"\n      series: \"fun\"\n"; };
+        it("rejects specials in matchers", () => {
+            const confTmpl = (v) => `
+routes:
+  non-string-values:
+    matchers:
+      no-numbers: [${v}]
+    output:
+      type: "analytics"
+      series: "fun"
+`;
             // Make sure the template works
-            var conf = confTmpl('"valid"');
-            var actual = new router.Router();
-            assert.doesNotThrow(function () { return actual._loadConfigString(conf); });
-            var _loop_1 = function (invalidVal) {
-                var invalidConf = confTmpl(invalidVal);
-                assert.throws(function () { return actual._loadConfigString(invalidConf); });
-            };
-            for (var _i = 0, _a = ["5", "[]", "{}"]; _i < _a.length; _i++) {
-                var invalidVal = _a[_i];
-                _loop_1(invalidVal);
+            const conf = confTmpl('"valid"');
+            const actual = new router.Router();
+            assert.doesNotThrow(() => actual._loadConfigString(conf));
+            for (const invalidVal of ["5", "[]", "{}"]) {
+                const invalidConf = confTmpl(invalidVal);
+                assert.throws(() => actual._loadConfigString(invalidConf));
             }
-            assert.throws(function () { return actual._loadConfigString(confTmpl('""')); });
+            assert.throws(() => actual._loadConfigString(confTmpl('""')));
             return;
         });
-        it("rejects duplicates in matchers", function () {
-            var confTmpl = function (v) { return "\nroutes:\n  sloppy:\n    matchers:\n      title: [" + v + "]\n    output:\n      type: \"analytics\"\n      series: \"fun\"\n"; };
-            var actual = new router.Router();
-            var validConf = confTmpl('"non-repeated", "name"');
-            assert.doesNotThrow(function () { return actual._loadConfigString(validConf); });
-            var invalidConf = confTmpl('"repeated", "repeated", "name"');
-            assert.throws(function () { return actual._loadConfigString(invalidConf); });
+        it("rejects duplicates in matchers", () => {
+            const confTmpl = (v) => `
+routes:
+  sloppy:
+    matchers:
+      title: [${v}]
+    output:
+      type: "analytics"
+      series: "fun"
+`;
+            const actual = new router.Router();
+            const validConf = confTmpl('"non-repeated", "name"');
+            assert.doesNotThrow(() => actual._loadConfigString(validConf));
+            const invalidConf = confTmpl('"repeated", "repeated", "name"');
+            assert.throws(() => actual._loadConfigString(invalidConf));
         });
-        it("requires correct types in outputs", function () {
-            var confTmpl = function (series, dimensions) { return "\nroutes:\n  wrong:\n    matchers:\n      title: [\"test\"]\n    output:\n      type: \"alerts\"\n      series: " + series + "\n      dimensions: " + dimensions + "\n      value_field: \"hihi\"\n      stat_type: \"gauge\"\n"; };
-            var actual = new router.Router();
-            var validConf = confTmpl('"my-series"', '["dim1", "dim2"]');
-            assert.doesNotThrow(function () { return actual._loadConfigString(validConf); });
-            var invalidConf0 = confTmpl('["my-series"]', '["dim1", "dim2"]');
-            assert.throws(function () { return actual._loadConfigString(invalidConf0); });
-            var invalidConf1 = confTmpl('"my-series"', '"dim1"');
-            assert.throws(function () { return actual._loadConfigString(invalidConf1); });
+        it("requires correct types in outputs", () => {
+            const confTmpl = (series, dimensions) => `
+routes:
+  wrong:
+    matchers:
+      title: ["test"]
+    output:
+      type: "alerts"
+      series: ${series}
+      dimensions: ${dimensions}
+      value_field: "hihi"
+      stat_type: "gauge"
+`;
+            const actual = new router.Router();
+            const validConf = confTmpl('"my-series"', '["dim1", "dim2"]');
+            assert.doesNotThrow(() => actual._loadConfigString(validConf));
+            const invalidConf0 = confTmpl('["my-series"]', '["dim1", "dim2"]');
+            assert.throws(() => actual._loadConfigString(invalidConf0));
+            const invalidConf1 = confTmpl('"my-series"', '"dim1"');
+            assert.throws(() => actual._loadConfigString(invalidConf1));
         });
-        it("requires all keys in outputs", function () {
-            var confTmpl = function (v) { return "\nroutes:\n  wrong:\n    matchers:\n      title: [\"test\"]\n    output:\n      type: \"alerts\"" + v + "\n      dimensions: [\"dim1\", \"dim2\"]\n      stat_type: \"gauge\"\n"; };
-            var actual = new router.Router();
-            var validConf = confTmpl("\n      series: \"whatever\"");
-            assert.doesNotThrow(function () { return actual._loadConfigString(validConf); });
-            var invalidConf = confTmpl("");
-            assert.throws(function () { return actual._loadConfigString(invalidConf); });
+        it("requires all keys in outputs", () => {
+            const confTmpl = (v) => `
+routes:
+  wrong:
+    matchers:
+      title: ["test"]
+    output:
+      type: "alerts"${v}
+      dimensions: ["dim1", "dim2"]
+      stat_type: "gauge"
+`;
+            const actual = new router.Router();
+            const validConf = confTmpl(`
+      series: "whatever"`);
+            assert.doesNotThrow(() => actual._loadConfigString(validConf));
+            const invalidConf = confTmpl("");
+            assert.throws(() => actual._loadConfigString(invalidConf));
         });
-        it("doesn't allow extra keys", function () {
-            var confTmpl = function (v) { return "\nroutes:\n  wrong:\n    matchers:\n      title: [\"test\"]\n    output:\n      type: \"metrics\"" + v + "\n      dimensions: [\"dim1\", \"dim2\"]\n"; };
-            var actual = new router.Router();
-            var validConf = confTmpl("\n      series: \"whatever\"");
-            assert.doesNotThrow(function () { return actual._loadConfigString(validConf); });
-            var invalidConf = confTmpl("\n      series: \"whatever\"\n      something-else: \"hi there\"");
-            assert.throws(function () { return actual._loadConfigString(invalidConf); });
+        it("doesn't allow extra keys", () => {
+            const confTmpl = (v) => `
+routes:
+  wrong:
+    matchers:
+      title: ["test"]
+    output:
+      type: "metrics"${v}
+      dimensions: ["dim1", "dim2"]
+`;
+            const actual = new router.Router();
+            const validConf = confTmpl(`
+      series: "whatever"`);
+            assert.doesNotThrow(() => actual._loadConfigString(validConf));
+            const invalidConf = confTmpl(`
+      series: "whatever"
+      something-else: "hi there"`);
+            assert.throws(() => actual._loadConfigString(invalidConf));
         });
-        it("errors on type-os", function () {
-            var actual = new router.Router();
-            var config;
-            config = "\nroute: # Should be routes (plural)\n  string-values:\n    matchers:\n      errors: [ \"type-o\" ]\n    output:\n      type: \"analytics\"\n      series: \"fun\"\n";
-            assert.throws(function () { return actual._loadConfigString(config); });
-            config = "\nroutes:\n  string-values:\n    matcher: # Should be matchers (plural)\n      errors: [ \"type-o\" ]\n    output:\n      type: \"analytics\"\n      series: \"fun\"\n";
-            assert.throws(function () { return actual._loadConfigString(config); });
-            config = "\nroutes:\n  string-values:\n    matchers:\n      errors: [ \"type-o\" ]\n    outputs: # Should be output (signular)\n      type: \"analytics\"\n      series: \"fun\"\n";
-            assert.throws(function () { return actual._loadConfigString(config); });
-            config = "\nroutes:\n  $invalid-string-values: # Invalid rule name\n    matchers:\n      errors: [ \"type-o\" ]\n    output:\n      type: \"analytics\"\n      series: \"fun\"\n";
-            assert.throws(function () { return actual._loadConfigString(config); });
-            config = "\nroutes:\n  string-values:\n    matchers:\n      errors: [ \"type-o\" ]\n    output:\n      type: \"analytic\" # Should be analytics (plural)p\n      series: \"fun\"\n";
-            assert.throws(function () { return actual._loadConfigString(config); });
-            config = "\nroutes:\n  string-values:\n    matchers:\n      errors: [ \"*\", \"type-o\" ] # A wildcard cannot exist with other matchers\n    output:\n      type: \"analytics\"\n      series: \"fun\"\n";
-            assert.throws(function () { return actual._loadConfigString(config); });
+        it("errors on type-os", () => {
+            const actual = new router.Router();
+            let config;
+            config = `
+route: # Should be routes (plural)
+  string-values:
+    matchers:
+      errors: [ "type-o" ]
+    output:
+      type: "analytics"
+      series: "fun"
+`;
+            assert.throws(() => actual._loadConfigString(config));
+            config = `
+routes:
+  string-values:
+    matcher: # Should be matchers (plural)
+      errors: [ "type-o" ]
+    output:
+      type: "analytics"
+      series: "fun"
+`;
+            assert.throws(() => actual._loadConfigString(config));
+            config = `
+routes:
+  string-values:
+    matchers:
+      errors: [ "type-o" ]
+    outputs: # Should be output (signular)
+      type: "analytics"
+      series: "fun"
+`;
+            assert.throws(() => actual._loadConfigString(config));
+            config = `
+routes:
+  $invalid-string-values: # Invalid rule name
+    matchers:
+      errors: [ "type-o" ]
+    output:
+      type: "analytics"
+      series: "fun"
+`;
+            assert.throws(() => actual._loadConfigString(config));
+            config = `
+routes:
+  string-values:
+    matchers:
+      errors: [ "type-o" ]
+    output:
+      type: "analytic" # Should be analytics (plural)p
+      series: "fun"
+`;
+            assert.throws(() => actual._loadConfigString(config));
+            config = `
+routes:
+  string-values:
+    matchers:
+      errors: [ "*", "type-o" ] # A wildcard cannot exist with other matchers
+    output:
+      type: "analytics"
+      series: "fun"
+`;
+            assert.throws(() => actual._loadConfigString(config));
         });
     });
-    describe("route", function () {
-        it("matches one or more rule and returns appropriate outputs", function () {
-            var r = new router.Router([
+    describe("route", () => {
+        it("matches one or more rule and returns appropriate outputs", () => {
+            const r = new router.Router([
                 new router.Rule("rule-one", { title: ["hello", "hi"], foo: ["bar", "baz"] }, { channel: "#-%{foo}-", dimensions: ["-%{foo}-"] }),
                 new router.Rule("rule-two", { "bing.bong": ["buzz"] }, { series: "x" }),
             ]);
-            var msg0 = {
+            const msg0 = {
                 title: "hi",
                 foo: "bar",
             };
-            var expected0 = [
+            const expected0 = [
                 {
                     rule: "rule-one",
                     channel: "#-bar-",
                     dimensions: ["-bar-"],
                 },
             ];
-            var actual0 = r.route(msg0).routes;
+            const actual0 = r.route(msg0).routes;
             assert.deepEqual(expected0, actual0);
-            var msg1 = {
+            const msg1 = {
                 title: "hi",
                 bing: {
                     bong: "buzz",
                 },
             };
-            var expected1 = [
+            const expected1 = [
                 {
                     rule: "rule-two",
                     series: "x",
                 },
             ];
-            var actual1 = r.route(msg1).routes;
+            const actual1 = r.route(msg1).routes;
             assert.deepEqual(expected1, actual1);
-            var msg2 = {
+            const msg2 = {
                 title: "hello",
                 foo: "baz",
                 bing: {
                     bong: "buzz",
                 },
             };
-            var expected2 = [
+            const expected2 = [
                 {
                     rule: "rule-one",
                     channel: "#-baz-",
@@ -165,15 +305,15 @@ describe("router.Router", function () {
                     series: "x",
                 },
             ];
-            var actual2 = r.route(msg2).routes;
+            const actual2 = r.route(msg2).routes;
             assert.deepEqual(expected2, actual2);
         });
     });
 });
-describe("router.Rule", function () {
-    describe("matches", function () {
-        it("works on simple cases", function () {
-            var r = new router.Rule("test-rule", { title: ["hello", "hi"], foo: ["bar"] }, {});
+describe("router.Rule", () => {
+    describe("matches", () => {
+        it("works on simple cases", () => {
+            const r = new router.Rule("test-rule", { title: ["hello", "hi"], foo: ["bar"] }, {});
             assert(r.matches({
                 title: "hello",
                 foo: "bar",
@@ -194,8 +334,8 @@ describe("router.Rule", function () {
                 "missing-stuff": "indeed",
             }));
         });
-        it("works on nested messages", function () {
-            var r = new router.Rule("test-rule", { "foo.bar": ["hello", "hi"] }, {});
+        it("works on nested messages", () => {
+            const r = new router.Rule("test-rule", { "foo.bar": ["hello", "hi"] }, {});
             assert(r.matches({
                 title: "greeting",
                 foo: {
@@ -231,8 +371,8 @@ describe("router.Rule", function () {
                 foo: "hi",
             }));
         });
-        it("wild card matching", function () {
-            var r = new router.Rule("test-rule", { any: ["*"] }, {});
+        it("wild card matching", () => {
+            const r = new router.Rule("test-rule", { any: ["*"] }, {});
             assert(r.matches({
                 any: false,
             }));
@@ -263,8 +403,8 @@ describe("router.Rule", function () {
                 },
             }));
         });
-        it("bool matching", function () {
-            var r = new router.Rule("test-rule", { bull: [true] }, {});
+        it("bool matching", () => {
+            const r = new router.Rule("test-rule", { bull: [true] }, {});
             assert(r.matches({
                 bull: true,
             }));
@@ -286,25 +426,25 @@ describe("router.Rule", function () {
             }));
         });
     });
-    describe("outputFor", function () {
-        it("substitutes kv entries", function () {
-            var r = new router.Rule("myrule", {}, {
+    describe("outputFor", () => {
+        it("substitutes kv entries", () => {
+            const r = new router.Rule("myrule", {}, {
                 channel: "#-%{foo}-",
                 dimensions: ["-%{foo}-", "-%{bar.baz}-"],
             });
-            var msg = {
+            const msg = {
                 title: "greeting",
                 foo: "partner",
                 bar: {
                     baz: "nest egg",
                 },
             };
-            var expected = {
+            const expected = {
                 rule: "myrule",
                 channel: "#-partner-",
                 dimensions: ["-partner-", "-nest egg-"],
             };
-            var actual = r.outputFor(msg);
+            const actual = r.outputFor(msg);
             assert.deepEqual(expected, actual);
         });
     });

package/lib/logger/logger.ts

@@ -40,6 +40,7 @@ class Logger {
   globals = null;
   logWriter = null;
   logRouter = null;
+  asyncLocalStorage = null;
 
   constructor(
     source,
@@ -52,6 +53,7 @@ class Logger {
     this.globals = {};
     this.globals.source = source;
     this.logWriter = output;
+    this.asyncLocalStorage = null;
 
     if (process.env._TEAM_OWNER) {
       this.globals.team = process.env._TEAM_OWNER;
@@ -76,6 +78,10 @@ class Logger {
     }
   }
 
+  setAsyncLocalStorage(asyncLocalStorage) {
+    this.asyncLocalStorage = asyncLocalStorage;
+  }
+
   setRouter(r) {
     this.logRouter = r;
   }
@@ -238,7 +244,17 @@ class Logger {
     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) {

package/lib/middleware.ts

@@ -161,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;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kayvee",
   "description": "Write data to key=val pairs, for human and machine readability",
-  "version": "3.17.0",
+  "version": "3.18.0",
   "main": "index.js",
   "repository": {
     "type": "git",
@@ -19,20 +19,24 @@
     "@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": "^3.5.3",
     "prettier": "2.1.2",
     "sinon": "^1.17.4",
     "supertest": "^1.2.0",
     "ts-node": "^9.0.0",
-    "tslint": "^3.7.4",
-    "typescript": "^4.0.3"
+    "typescript": "^3.9.10"
   },
   "scripts": {
     "test": "make -Br test",

package/test/middleware.ts

@@ -29,7 +29,7 @@ function afterTest(count, callback) {
     args[2] = args[2] || arg2;
 
     if (count === i) {
-      callback.apply(null, args);
+      callback(...args);
     }
   };
 }

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
     "compilerOptions": {
         "module": "commonjs",
-        "target": "es5",
+        "target": "ES2019",
         "noImplicitAny": false
     },
     "exclude": [

package/.eslintrc.yml

@@ -1,44 +0,0 @@
-extends: "airbnb"
-env:
-  mocha: true
-parser: "babel-eslint"
-parserOptions:
-  ecmaVersion: 6
-rules:
-  # no hard limit on line length
-  max-len: 0
-
-  # we allow use of console...for now
-  no-console: 0
-
-  # we currently use snake case in most places, however, we'd like to switch to camelCase eventually since it's more common in the JS community
-  camelcase: 0
-
-  # vars are necessary for server-side requires right now
-  no-var: 0
-  vars-on-top: 0
-
-  # multi spaces only allowed for aligning variable/import declarations
-  no-multi-spaces:
-    - 2
-    - exceptions:
-        VariableDeclarator: true
-        ImportDeclaration: true
-
-  # we currently use null in many places, so allow == for null checks
-  eqeqeq:
-    - 2
-    - "smart"
-
-  quotes: [2, "double", "avoid-escape"]
-  new-cap:
-    - 2
-    - newIsCapExceptions: ["kayvee.logger"]
-  no-param-reassign:
-    - 2
-    - props: false
-  key-spacing:
-    - 2
-    - mode: "minimum"
-
-  guard-for-in: 0