kayvee 3.17.0 → 4.0.0

package/build/lib/router/index.js

@@ -1,198 +0,0 @@
-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");
-var kvVersion = packageJson.version;
-var teamName = process.env._TEAM_OWNER || "UNSET";
-var reEnvvarTokens = new RegExp("\\$\\{(.+?)\\}", "g");
-var reFieldTokens = new RegExp("%\\{(.+?)\\}", "g");
-// For performance reason this code is intentionally redundant and not-inlined.
-// Removing redundancy and inlining this function some how makes performance worst.
-function substituteEnvVars(obj, subber) {
-    var rtn = {};
-    var replacer = function (s) { return s.replace(reEnvvarTokens, function (__, p1) { return subber(p1); }); };
-    for (var key in obj) {
-        var val = obj[key];
-        if (Array.isArray(val)) {
-            var updatedVals = Array(val.length);
-            for (var i = 0; i < val.length; i++) {
-                updatedVals[i] = replacer(val[i]);
-            }
-            rtn[key] = updatedVals;
-        }
-        else {
-            rtn[key] = replacer(val);
-        }
-    }
-    return rtn;
-}
-function deepKey(obj, key) {
-    var path = key.split(".");
-    var idx = 0;
-    var val = obj;
-    do {
-        val = val[path[idx++]];
-    } while (val && idx < path.length);
-    return val;
-}
-function fieldMatches(obj, field, values) {
-    var val = obj[field] || deepKey(obj, field);
-    if (val == null || val === "") {
-        return false;
-    }
-    if (values[0] === "*") {
-        return true;
-    }
-    for (var i = 0; i < values.length; i++) {
-        if (values[i] === val) {
-            return true;
-        }
-    }
-    return false;
-}
-var Rule = /** @class */ (function () {
-    function Rule(name, matchers, output) {
-        this.name = null;
-        this.matchers = null;
-        this.output = null;
-        this.name = name;
-        this.matchers = matchers;
-        var envMissing = [];
-        this.output = substituteEnvVars(output, function (k) {
-            var val = process.env[k];
-            if (val == null) {
-                envMissing.push(k);
-            }
-            return val;
-        });
-        if (envMissing.length > 0) {
-            throw new Error("Missing env var(s): " + envMissing.join(", "));
-        }
-        Object.keys(matchers).forEach(function (field) {
-            var fieldVals = matchers[field];
-            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.");
-            }
-        });
-        if (this.output.type === "alerts" || this.output.type === "metrics") {
-            this.output.value_field = this.output.value_field || "value";
-        }
-        this.output.rule = this.name;
-    }
-    // matches returns true if `msg` matches against this rule
-    Rule.prototype.matches = function (msg) {
-        for (var field in this.matchers) {
-            if (!fieldMatches(msg, field, this.matchers[field])) {
-                return false;
-            }
-        }
-        return true;
-    };
-    // returns the output with kv substitutions performed
-    Rule.prototype.outputFor = function (msg) {
-        var rtn = {};
-        var subst = function (__, k) { return msg[k] || deepKey(msg, k) || "KEY_NOT_FOUND"; };
-        var replacer = function (s) { return s.replace(reFieldTokens, subst); };
-        for (var key in this.output) {
-            var val = this.output[key];
-            if (Array.isArray(val)) {
-                var updatedVals = Array(val.length);
-                for (var i = 0; i < val.length; i++) {
-                    updatedVals[i] = replacer(val[i]);
-                }
-                rtn[key] = updatedVals;
-            }
-            else {
-                rtn[key] = replacer(val);
-            }
-        }
-        return rtn;
-    };
-    return Rule;
-}());
-// validateKVConfig ensures that `routes` matches the config schema. We have this
-// function instead of just doing a plain jsonschema.validate in order to get
-// better error messages for the "output" object (by default jsonschema would
-// just tell you that the output block doesn't match any of the known output
-// formats, but won't tell you what's wrong because it doesn't let you
-// condition on the output.type property).
-function validateKVConfig(config) {
-    var validator = new jsonschema.Validator();
-    var results = validator.validate(config, schema);
-    return {
-        valid: results.valid,
-        errors: results.errors.map(function (err) { return err.stack; }),
-    };
-}
-// parseConfig parses and validates the configuration passed as a string. It
-// returns an object of the form {valid, rules, errors}, where valid is true if
-// it was successfully parsed, rules is an array of rules, and errors is an
-// array of errors.
-function parseConfig(fileString) {
-    var config;
-    try {
-        config = yaml.safeLoad(fileString);
-    }
-    catch (e) {
-        return { valid: false, rules: [], errors: [e] };
-    }
-    var validateRes = validateKVConfig(config);
-    if (!validateRes.valid) {
-        return _.assign(validateRes, { rules: [] });
-    }
-    try {
-        var rulesObj = _.mapObject(config.routes, function (elem, name) { return new Rule(name, elem.matchers, elem.output); });
-        var rules = _.values(rulesObj);
-        return { valid: true, rules: rules, errors: [] };
-    }
-    catch (e) {
-        return { valid: false, rules: [], errors: [e] };
-    }
-}
-var Router = /** @class */ (function () {
-    function Router(rules) {
-        this.rules = null;
-        this.rules = rules || [];
-    }
-    // loadConfig reads in the config located at `filename` and sets the routing
-    // rules to what it finds there. It should be a YAML-formatted file with
-    // routing rules placed under the `routes` key on the root object.
-    Router.prototype.loadConfig = function (filename) {
-        var data = fs.readFileSync(filename, "utf8");
-        this._loadConfigString(data);
-    };
-    Router.prototype._loadConfigString = function (configStr) {
-        var parsedRules = parseConfig(configStr);
-        if (!parsedRules.valid) {
-            throw new Error(parsedRules.errors);
-        }
-        this.rules = parsedRules.rules;
-    };
-    // route matches the log line `msg` against all loaded rules and returns a
-    // metadata object describing the outputs it should be sent to based on that
-    // matching. logger.ts will attach this to log lines under the `_kvmeta`
-    // property.
-    Router.prototype.route = function (msg) {
-        var outputs = [];
-        for (var i = 0; i < this.rules.length; i++) {
-            var rule = this.rules[i];
-            if (rule.matches(msg)) {
-                outputs.push(rule.outputFor(msg));
-            }
-        }
-        return {
-            team: teamName,
-            kv_version: kvVersion,
-            kv_language: "js",
-            routes: outputs,
-        };
-    };
-    return Router;
-}());
-module.exports = {
-    Router: Router,
-    Rule: Rule,
-};

package/build/package.json

@@ -1,49 +0,0 @@
-{
-  "name": "kayvee",
-  "description": "Write data to key=val pairs, for human and machine readability",
-  "version": "3.17.0",
-  "main": "index.js",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/Clever/kayvee-js"
-  },
-  "dependencies": {
-    "js-yaml": "^3.6.1",
-    "jsonschema": "^1.1.0",
-    "morgan": "^1.7.0",
-    "qs": "^6.9.4",
-    "split": "^1.0.0",
-    "underscore": "^1.8.3"
-  },
-  "devDependencies": {
-    "@clever/prettier-config": "1.0.0",
-    "@types/mocha": "^8.0.3",
-    "@types/node": "^12.12.68",
-    "babel-eslint": "^6.0.2",
-    "benchmark": "^2.1.1",
-    "eslint": "^2.7.0",
-    "eslint-config-airbnb": "^7.0.0",
-    "eslint-plugin-jsx-a11y": "^0.6.2",
-    "eslint-plugin-react": "^4.3.0",
-    "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"
-  },
-  "scripts": {
-    "test": "make -Br test",
-    "prepublish": "make build"
-  },
-  "author": "Clever <tech-notify@clever.com>",
-  "license": "BSD-2-Clause",
-  "bugs": {
-    "url": "https://github.com/Clever/kayvee-js/issues"
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  }
-}

package/build/test/context_logger.js

@@ -1,77 +0,0 @@
-var assert = require("assert");
-var sinon = require("sinon");
-var middleware = require("../lib/middleware");
-var KayveeLogger = require("../lib/logger/logger");
-describe("ContextLogger", function () {
-    var fake_req = { key1: "val1" };
-    var fake_handler = function (req) { return ({ log_key1: req.key1, key2: "val2" }); };
-    var _loop_1 = function (level) {
-        it("correctly adds context to " + level + " calls", function () {
-            var spy = sinon.spy();
-            var stub_logger = {};
-            stub_logger[level + "D"] = spy;
-            var log = new middleware.ContextLogger(stub_logger, [fake_handler], fake_req);
-            log[level]("test_title");
-            var expected_context = { log_key1: "val1", key2: "val2" };
-            assert(spy.calledWithExactly("test_title", expected_context));
-            assert.equal(spy.callCount, 1);
-        });
-        it("correctly adds context to " + level + "D calls", function () {
-            var spy = sinon.spy();
-            var stub_logger = {};
-            stub_logger[level + "D"] = spy;
-            var log = new middleware.ContextLogger(stub_logger, [fake_handler], fake_req);
-            log[level + "D"]("test_title", { key2: "new_value", key3: "val3" });
-            var expected_data = {
-                log_key1: "val1",
-                key2: "new_value",
-                key3: "val3",
-            };
-            assert(spy.calledWithExactly("test_title", expected_data));
-            assert.equal(spy.callCount, 1);
-        });
-    };
-    for (var _i = 0, _a = KayveeLogger.LEVELS; _i < _a.length; _i++) {
-        var level = _a[_i];
-        _loop_1(level);
-    }
-    var _loop_2 = function (metric) {
-        it("correctly adds context to " + metric + " calls", function () {
-            var spy = sinon.spy();
-            var stub_logger = {};
-            stub_logger[metric + "D"] = spy;
-            var log = new middleware.ContextLogger(stub_logger, [fake_handler], fake_req);
-            log[metric]("test_title", 3);
-            var expected_context = { log_key1: "val1", key2: "val2" };
-            assert(spy.calledWithExactly("test_title", 3, expected_context));
-            assert.equal(spy.callCount, 1);
-        });
-        it("correctly adds context to " + metric + "D calls", function () {
-            var spy = sinon.spy();
-            var stub_logger = {};
-            stub_logger[metric + "D"] = spy;
-            var log = new middleware.ContextLogger(stub_logger, [fake_handler], fake_req);
-            log[metric + "D"]("test_title", 3, { key2: "new_value", key3: "val3" });
-            var expected_data = {
-                log_key1: "val1",
-                key2: "new_value",
-                key3: "val3",
-            };
-            assert(spy.calledWithExactly("test_title", 3, expected_data));
-            assert.equal(spy.callCount, 1);
-        });
-    };
-    for (var _b = 0, _c = KayveeLogger.METRICS; _b < _c.length; _b++) {
-        var metric = _c[_b];
-        _loop_2(metric);
-    }
-    it("correctly handles being instantiated with empty list of handlers", function () {
-        var spy = sinon.spy();
-        var stub_logger = { infoD: spy };
-        var log = new middleware.ContextLogger(stub_logger, [], fake_req);
-        log.info("test_title");
-        var expected_context = {};
-        assert(spy.calledWithExactly("test_title", expected_context));
-        assert.equal(spy.callCount, 1);
-    });
-});

package/build/test/kayvee.js

@@ -1,36 +0,0 @@
-var kv = require("../lib/kayvee");
-var assert = require("assert");
-var _ = require("underscore");
-var fs = require("fs");
-describe("kayvee", function () {
-    var tests = JSON.parse(fs.readFileSync("test/tests.json"));
-    describe(".format", function () {
-        _.each(tests.format, function (spec) {
-            it(spec.title, function () {
-                var actual = kv.format(spec.input.data);
-                var expected = spec.output;
-                assert.deepEqual(JSON.parse(actual), _.extend({ deploy_env: "testing", wf_id: "abc" }, JSON.parse(expected)));
-            });
-        });
-    });
-    describe(".format with Errors", function () {
-        it("encodes Error objects", function () {
-            var actual = kv.format({ err: Error("An Error Message") });
-            var expected = {
-                deploy_env: "testing",
-                wf_id: "abc",
-                err: "Error: An Error Message",
-            };
-            assert.deepEqual(JSON.parse(actual), expected);
-        });
-    });
-    describe(".formatLog", function () {
-        _.each(tests.formatLog, function (spec) {
-            it(spec.title, function () {
-                var actual = kv.formatLog(spec.input.source, spec.input.level, spec.input.title, spec.input.data);
-                var expected = spec.output;
-                assert.deepEqual(JSON.parse(actual), _.extend({ deploy_env: "testing", wf_id: "abc" }, JSON.parse(expected)));
-            });
-        });
-    });
-});