kayvee 3.17.0 → 4.0.0

package/build/test/router.js

@@ -1,311 +0,0 @@
-var assert = require("assert");
-var router = require("../lib/router");
-describe("router.Router", function () {
-    describe("constructor", function () {
-        it("parses well formatted configs", function () {
-            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 = [
-                new router.Rule("rule-one", { title: ["authorize-app"] }, {
-                    type: "notifications",
-                    channel: "%{foo.bar}",
-                    icon: ":rocket:",
-                    message: "authorized %{foo.bar} in Hogwarts",
-                    user: "@fishman",
-                }),
-                new router.Rule("rule-two", { "foo.bar": ["multiple", "matches"], baz: ["whatever"] }, {
-                    type: "alerts",
-                    series: "other-series",
-                    dimensions: ["baz"],
-                    stat_type: "gauge",
-                    value_field: "value",
-                }),
-                new router.Rule("rule-three", { "foo.bar": ["multiple", "matches"], baz: ["whatever"] }, {
-                    type: "alerts",
-                    series: "other-series",
-                    dimensions: ["baz"],
-                    stat_type: "gauge",
-                    value_field: "hello",
-                }),
-                new router.Rule("rule-four", { "foo.bar": ["multiple", "matches"], baz: ["whatever"] }, {
-                    type: "alerts",
-                    series: "other-series",
-                    dimensions: [],
-                    stat_type: "gauge",
-                    value_field: "value",
-                }),
-                new router.Rule("rule-five", { "foo.bar": [true], baz: [false] }, {
-                    type: "alerts",
-                    series: "other-series",
-                    dimensions: [],
-                    stat_type: "gauge",
-                    value_field: "value",
-                }),
-            ];
-            var 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"; };
-            // 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);
-            }
-            assert.throws(function () { return 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("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 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("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("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); });
-        });
-    });
-    describe("route", function () {
-        it("matches one or more rule and returns appropriate outputs", function () {
-            var 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 = {
-                title: "hi",
-                foo: "bar",
-            };
-            var expected0 = [
-                {
-                    rule: "rule-one",
-                    channel: "#-bar-",
-                    dimensions: ["-bar-"],
-                },
-            ];
-            var actual0 = r.route(msg0).routes;
-            assert.deepEqual(expected0, actual0);
-            var msg1 = {
-                title: "hi",
-                bing: {
-                    bong: "buzz",
-                },
-            };
-            var expected1 = [
-                {
-                    rule: "rule-two",
-                    series: "x",
-                },
-            ];
-            var actual1 = r.route(msg1).routes;
-            assert.deepEqual(expected1, actual1);
-            var msg2 = {
-                title: "hello",
-                foo: "baz",
-                bing: {
-                    bong: "buzz",
-                },
-            };
-            var expected2 = [
-                {
-                    rule: "rule-one",
-                    channel: "#-baz-",
-                    dimensions: ["-baz-"],
-                },
-                {
-                    rule: "rule-two",
-                    series: "x",
-                },
-            ];
-            var 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"] }, {});
-            assert(r.matches({
-                title: "hello",
-                foo: "bar",
-            }));
-            assert(r.matches({
-                title: "hi",
-                foo: "bar",
-            }));
-            assert(!r.matches({
-                title: "hi",
-                foo: "fighters",
-            }));
-            assert(!r.matches({
-                title: "howdy",
-                foo: "bar",
-            }));
-            assert(!r.matches({
-                "missing-stuff": "indeed",
-            }));
-        });
-        it("works on nested messages", function () {
-            var r = new router.Rule("test-rule", { "foo.bar": ["hello", "hi"] }, {});
-            assert(r.matches({
-                title: "greeting",
-                foo: {
-                    bar: "hello",
-                },
-            }));
-            assert(r.matches({
-                title: "greeting",
-                foo: {
-                    bar: "hi",
-                },
-            }));
-            assert(!r.matches({
-                title: "greeting",
-                foo: {
-                    bar: "howdy",
-                },
-            }));
-            assert(!r.matches({
-                title: "greeting",
-                foo: {
-                    baz: "howdy",
-                },
-            }));
-            assert(!r.matches({
-                title: "greeting",
-                boo: {
-                    bar: "howdy",
-                },
-            }));
-            assert(!r.matches({
-                title: "greeting",
-                foo: "hi",
-            }));
-        });
-        it("wild card matching", function () {
-            var r = new router.Rule("test-rule", { any: ["*"] }, {});
-            assert(r.matches({
-                any: false,
-            }));
-            assert(r.matches({
-                any: 5,
-            }));
-            assert(r.matches({
-                any: "hello",
-            }));
-            assert(r.matches({
-                any: {
-                    bar: "hi",
-                },
-            }));
-            assert(!r.matches({
-                any: "",
-            }));
-            assert(!r.matches({
-                any: null,
-            }));
-            assert(!r.matches({
-                any: undefined,
-            }));
-            assert(!r.matches({
-                title: "greeting",
-                foo: {
-                    bar: "howdy",
-                },
-            }));
-        });
-        it("bool matching", function () {
-            var r = new router.Rule("test-rule", { bull: [true] }, {});
-            assert(r.matches({
-                bull: true,
-            }));
-            assert(r.matches({
-                any: false,
-                bull: true,
-            }));
-            assert(!r.matches({
-                bull: false,
-            }));
-            assert(!r.matches({
-                bull: "false",
-            }));
-            assert(!r.matches({
-                title: "greeting",
-                foo: {
-                    bar: "howdy",
-                },
-            }));
-        });
-    });
-    describe("outputFor", function () {
-        it("substitutes kv entries", function () {
-            var r = new router.Rule("myrule", {}, {
-                channel: "#-%{foo}-",
-                dimensions: ["-%{foo}-", "-%{bar.baz}-"],
-            });
-            var msg = {
-                title: "greeting",
-                foo: "partner",
-                bar: {
-                    baz: "nest egg",
-                },
-            };
-            var expected = {
-                rule: "myrule",
-                channel: "#-partner-",
-                dimensions: ["-partner-", "-nest egg-"],
-            };
-            var actual = r.outputFor(msg);
-            assert.deepEqual(expected, actual);
-        });
-    });
-});

package/index.js

@@ -1,7 +0,0 @@
-module.exports = require("./build/lib/kayvee");
-// export logger capitalized to fix lint errors, lowercased to support legacy usage
-module.exports.logger = module.exports.Logger = require("./build/lib/logger/logger");
-module.exports.router = require("./build/lib/router");
-module.exports.middleware = require("./build/lib/middleware");
-module.exports.setGlobalRouting = module.exports.logger.setGlobalRouting;
-module.exports.mockRouting = module.exports.logger.mockRouting;

package/lib/kayvee.ts

@@ -1,73 +0,0 @@
-var _ = require("underscore");
-
-const deploy_env = process.env._DEPLOY_ENV;
-const workflow_id = process.env._EXECUTION_NAME;
-const pod_id = process.env._POD_ID;
-const pod_shortname = process.env._POD_SHORTNAME;
-const pod_region = process.env._POD_REGION;
-const pod_account = process.env._POD_ACCOUNT;
-
-// Encode errors to strings instead of toJSON()
-function replaceErrors(key, value) {
-  if (value instanceof Error) {
-    return value.toString();
-  }
-
-  return value;
-}
-
-// Converts a map to a string space-delimited key=val pairs
-function format(data) {
-  if (deploy_env || workflow_id || pod_id || pod_shortname || pod_account || pod_region) {
-    const extras: any = {};
-    if (deploy_env) {
-      extras.deploy_env = deploy_env;
-    }
-    if (workflow_id) {
-      extras.wf_id = workflow_id;
-    }
-    if (pod_id) {
-      extras["pod-id"] = pod_id;
-    }
-    if (pod_shortname) {
-      extras["pod-shortname"] = pod_shortname;
-    }
-    if (pod_region) {
-      extras["pod-region"] = pod_region;
-    }
-    if (pod_account) {
-      extras["pod-account"] = pod_account;
-    }
-
-    return JSON.stringify(_.extend(extras, data), replaceErrors);
-  }
-  return JSON.stringify(data, replaceErrors);
-}
-
-// Similar to format, but takes additional reserved params to promote logging best-practices
-function formatLog(source = "", level = "", title = "", data = {}) {
-  let info = data;
-  if (!_.isObject(data)) {
-    info = {};
-  }
-  const reserved = { source, level, title };
-
-  // reserved keys overwrite other keys in data
-  return format(_.extend({}, info, reserved));
-}
-
-module.exports = {
-  format,
-  formatLog,
-};
-
-const LOG_LEVELS = {
-  UNKNOWN: "unknown",
-  CRITICAL: "critical",
-  ERROR: "error",
-  WARNING: "warning",
-  INFO: "info",
-  TRACE: "trace",
-};
-
-_.extend(module.exports, LOG_LEVELS);

package/lib/logger/logger.ts

@@ -1,296 +0,0 @@
-var _ = require("underscore");
-var kv = require("../kayvee");
-var router = require("../router");
-
-var LEVELS = {
-  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,
-  critical: 5,
-};
-
-const assign = Object.assign || _.assign; // Use the faster Object.assign if possible
-
-let globalRouter;
-
-function setGlobalRouting(filename) {
-  globalRouter = new router.Router();
-  globalRouter.loadConfig(filename);
-}
-
-function getGlobalRouter() {
-  return globalRouter;
-}
-
-// This is a port from kayvee-go/logger/logger.go
-class Logger {
-  formatter = null;
-  logLvl = null;
-  globals = null;
-  logWriter = null;
-  logRouter = 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;
-
-    if (process.env._TEAM_OWNER) {
-      this.globals.team = process.env._TEAM_OWNER;
-    }
-    if (process.env._DEPLOY_ENV) {
-      this.globals.deploy_env = process.env._DEPLOY_ENV;
-    }
-    if (process.env._EXECUTION_NAME) {
-      this.globals.wf_id = process.env._EXECUTION_NAME;
-    }
-    if (process.env._POD_ID) {
-      this.globals["pod-id"] = process.env._POD_ID;
-    }
-    if (process.env._POD_SHORTNAME) {
-      this.globals["pod-shortname"] = process.env._POD_SHORTNAME;
-    }
-    if (process.env._POD_REGION) {
-      this.globals["pod-region"] = process.env._POD_REGION;
-    }
-    if (process.env._POD_ACCOUNT) {
-      this.globals["pod-account"] = process.env._POD_ACCOUNT;
-    }
-  }
-
-  setRouter(r) {
-    this.logRouter = r;
-  }
-
-  setConfig(source, logLvl, formatter, output) {
-    this.globals.source = source;
-    this.logLvl = this._validateLogLvl(logLvl);
-    this.formatter = formatter;
-    this.logWriter = output;
-    return this.logWriter;
-  }
-
-  _validateLogLvl(logLvl) {
-    if (logLvl == null) {
-      return LEVELS.Debug;
-    }
-    for (var key in LEVELS) {
-      if (Object.prototype.hasOwnProperty.call(LEVELS, key)) {
-        var value = LEVELS[key];
-        if (logLvl.toLowerCase() === value) {
-          return value;
-        }
-      }
-    }
-    return LEVELS.Debug;
-  }
-
-  setLogLevel(logLvl) {
-    this.logLvl = this._validateLogLvl(logLvl);
-    return this.logLvl;
-  }
-
-  setFormatter(formatter) {
-    this.formatter = formatter;
-    return this.formatter;
-  }
-
-  setOutput(output) {
-    this.logWriter = output;
-    return this.logWriter;
-  }
-
-  trace(title) {
-    this.traceD(title, {});
-  }
-
-  debug(title) {
-    this.debugD(title, {});
-  }
-
-  info(title) {
-    this.infoD(title, {});
-  }
-
-  warn(title) {
-    this.warnD(title, {});
-  }
-
-  error(title) {
-    this.errorD(title, {});
-  }
-
-  critical(title) {
-    this.criticalD(title, {});
-  }
-
-  counter(title) {
-    this.counterD(title, 1, {});
-  }
-
-  gauge(title, value) {
-    this.gaugeD(title, value, {});
-  }
-
-  traceD(title, data) {
-    this._logWithLevel(
-      LEVELS.Trace,
-      {
-        title,
-      },
-      data,
-    );
-  }
-
-  debugD(title, data) {
-    this._logWithLevel(
-      LEVELS.Debug,
-      {
-        title,
-      },
-      data,
-    );
-  }
-
-  infoD(title, data) {
-    this._logWithLevel(
-      LEVELS.Info,
-      {
-        title,
-      },
-      data,
-    );
-  }
-
-  warnD(title, data) {
-    this._logWithLevel(
-      LEVELS.Warning,
-      {
-        title,
-      },
-      data,
-    );
-  }
-
-  errorD(title, data) {
-    this._logWithLevel(
-      LEVELS.Error,
-      {
-        title,
-      },
-      data,
-    );
-  }
-
-  criticalD(title, data) {
-    this._logWithLevel(
-      LEVELS.Critical,
-      {
-        title,
-      },
-      data,
-    );
-  }
-
-  counterD(title, value, data) {
-    this._logWithLevel(
-      LEVELS.Info,
-      {
-        title,
-        value,
-        type: "counter",
-      },
-      data,
-    );
-  }
-
-  gaugeD(title, value, 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);
-    if (this.logRouter) {
-      data._kvmeta = this.logRouter.route(data);
-    } else if (globalRouter) {
-      data._kvmeta = globalRouter.route(data);
-    }
-    this.logWriter(this.formatter(data));
-  }
-}
-
-module.exports = Logger;
-module.exports.setGlobalRouting = setGlobalRouting;
-module.exports.getGlobalRouter = getGlobalRouter;
-module.exports.mockRouting = (cb) => {
-  const _logWithLevel: any = Logger.prototype._logWithLevel;
-
-  if (_logWithLevel.isMocked) {
-    throw Error("Nested kv.mockRouting calls are not supported");
-  }
-
-  const ruleMatches = {};
-
-  Logger.prototype._logWithLevel = function (logLvl, metadata, userdata) {
-    const formatter = this.formatter;
-    const logWriter = this.logWriter;
-
-    this.formatter = (msg) => msg;
-    this.logWriter = (msg) => {
-      if (!msg._kvmeta) {
-        return;
-      }
-
-      msg._kvmeta.routes.forEach((route) => {
-        ruleMatches[route.rule] = (ruleMatches[route.rule] || []).concat(route);
-      });
-    };
-
-    _logWithLevel.call(this, logLvl, metadata, userdata);
-
-    this.formatter = formatter;
-    this.logWriter = logWriter;
-  };
-
-  const stfuTypeScript: any = Logger.prototype._logWithLevel;
-  stfuTypeScript.isMocked = true;
-
-  const done = () => {
-    Logger.prototype._logWithLevel = _logWithLevel;
-    return ruleMatches;
-  };
-
-  cb(done);
-};
-_.extend(module.exports, LEVELS);
-module.exports.LEVELS = ["trace", "debug", "info", "warn", "error", "critical"];
-module.exports.METRICS = ["counter", "gauge"];