kayvee 3.18.0 → 4.0.0

package/build/lib/middleware.js

@@ -1,274 +0,0 @@
-/**
- * Module dependencies.
- * @private
- */
-var fs = require("fs");
-var path = require("path");
-var kayvee = require("../lib/kayvee");
-var KayveeLogger = require("../lib/logger/logger");
-var morgan = require("morgan");
-var _ = require("underscore");
-/**
- * all relative files path in a directory
- */
-function walkDirSync(dir, files = []) {
-    const list = fs.readdirSync(dir);
-    list.forEach((file) => {
-        const f = path.join(dir, file);
-        if (fs.statSync(path.join(dir, file)).isDirectory()) {
-            walkDirSync(f, files);
-        }
-        else {
-            files.push(f);
-        }
-    });
-    return files.map((f) => path.relative(dir, f));
-}
-/**
- * returns a middleware function that checks if path exists in dir.
- *
- * Files in the directory are prefixed by base_path and compared to
- * req.path
- */
-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}`);
-    return (req, res) => _(files).contains(req.path) && res.statusCode < 400;
-}
-/**
- * request path
- */
-function getBaseUrl(req) {
-    var url = req.originalUrl || req.url;
-    var parsed = require("url").parse(url, true);
-    return parsed.pathname;
-}
-/**
- * request query params
- */
-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,
-    });
-    return `?${require("qs").stringify(parsedQueryString)}`;
-}
-/**
- * response size
- */
-function getResponseSize(res) {
-    var result = undefined;
-    var headers = res.headers || res._headers;
-    if (headers && headers["content-length"]) {
-        result = Number(headers["content-length"]);
-    }
-    else if (res.data) {
-        result = res.data.length;
-    }
-    return result;
-}
-/**
- * response time in nanoseconds
- */
-function getResponseTimeNs(req, res) {
-    if (!req._startAt || !res._startAt) {
-        // missing request and/or response start time
-        return undefined;
-    }
-    // calculate diff
-    var ns = (res._startAt[0] - req._startAt[0]) * 1e9 + (res._startAt[1] - req._startAt[1]);
-    return ns;
-}
-/**
- * IP address that sent the request.
- *
- * `req.ip` is defined in Express: http://expressjs.com/en/api.html#req.ip
- */
-function getIp(req) {
-    var remoteAddress = req.connection ? req.connection.remoteAddress : undefined;
-    return req.ip || remoteAddress;
-}
-/**
- * Log level
- */
-function getLogLevel(req, res) {
-    const statusCode = res.statusCode;
-    let result;
-    if (statusCode >= 499) {
-        result = KayveeLogger.Error;
-    }
-    else {
-        result = KayveeLogger.Info;
-    }
-    return result;
-}
-/*
- * Default handlers
- */
-var defaultHandlers = [
-    // Request method
-    (req) => ({ method: req.method }),
-    // Path (URL without query params)
-    (req) => ({ path: getBaseUrl(req) }),
-    // Query params
-    (req) => ({ params: getQueryParams(req) }),
-    // Response size
-    (req, res) => ({ "response-size": getResponseSize(res) }),
-    // Response time (ns)
-    (req, res) => ({ "response-time": getResponseTimeNs(req, res) }),
-    // Status code
-    (req, res) => ({ "status-code": res.statusCode }),
-    // Ip address
-    (req) => ({ ip: getIp(req) }),
-    // Via -- what library/code produced this log?
-    () => ({ via: "kayvee-middleware" }),
-    // Kayvee's reserved fields
-    // Log level
-    (req, res) => ({ level: getLogLevel(req, res) }),
-    // Source -- which app emitted this log?
-    // -> Gets passed in among `options` during library initialization
-    // Title
-    () => ({ title: "request-finished" }),
-];
-const defaultContextHandlers = [];
-function handlerData(handlers, ...args) {
-    const data = {};
-    handlers.forEach((h) => {
-        try {
-            const handler_data = h(...args);
-            _.extend(data, handler_data);
-        }
-        catch (e) {
-            // swallow invalid handler
-        }
-    });
-    return data;
-}
-class ContextLogger {
-    constructor(logger, handlers, ...args) {
-        this.logger = null;
-        this.handlers = [];
-        this.args = [];
-        this.logger = logger;
-        this.handlers = handlers;
-        this.args = args;
-    }
-    _contextualData(data) {
-        return _.extend(handlerData(this.handlers, ...this.args), data);
-    }
-}
-for (const func of KayveeLogger.LEVELS) {
-    ContextLogger.prototype[func] = function (title) {
-        this[`${func}D`](title, {});
-    };
-    ContextLogger.prototype[`${func}D`] = function (title, data) {
-        this.logger[`${func}D`](title, this._contextualData(data));
-    };
-}
-for (const func of KayveeLogger.METRICS) {
-    ContextLogger.prototype[func] = function (title, value) {
-        this[`${func}D`](title, value, {});
-    };
-    ContextLogger.prototype[`${func}D`] = function (title, value, data) {
-        this.logger[`${func}D`](title, value, this._contextualData(data));
-    };
-}
-/*
- * User configuration is passed via an `options` object.
- * Results from configuration are prioritized such that (`base_handlers` > `handlers` > `headers`).
- *
- * // `headers` - logs these request headers, if they exist
- *
- * headers: e.g. ['X-Request-Id', 'Host']
- *
- * // `handlers` - an array of functions of that return dicts to be logged.
- *
- * handlers: e.g. [function(request, response) { return {"key":"val"}]
- *
- * // `base_handlers` - an array of functions of that return dicts to be logged.
- * // Barring exceptional circumstances, `base_handlers` should not be overriden by the user.
- * // `base_handlers` defaults to a core set of handlers to run... see `defaultHandlers`.
- * //
- * // Separating `base_handlers` from `handlers` is done to ensure that reserved keys
- * // don't accidentally get overriden by custom handlers. This can now only happen if
- * // the user explicitly overrides `base_handlers`.
- *
- * base_handlers: e.g. [function(request, response) { return {"key":"val"}]
- *
- */
-var formatLine = (options_arg) => {
-    var options = options_arg || {};
-    // `source` is the one required field
-    if (!options.source) {
-        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
-        // Add user-configured request headers
-        var custom_headers = options.headers || [];
-        var header_data = {};
-        custom_headers.forEach((h) => {
-            // Header field names are case insensitive, so let's be consistent
-            var lc = h.toLowerCase();
-            header_data[lc] = req.headers[lc];
-        });
-        _.extend(data, header_data);
-        // Run user-configured handlers; add custom data
-        var custom_handlers = options.handlers || [];
-        // 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 })]);
-        // Execute custom-handlers THEN base-handlers
-        const all_handlers = custom_handlers.concat(base_handlers);
-        _.extend(data, handlerData(all_handlers, req, res));
-        if (router) {
-            data._kvmeta = router.route(data);
-        }
-        return kayvee.format(data);
-    };
-};
-const defaultContextLoggerOpts = {
-    enabled: true,
-    handlers: defaultContextHandlers,
-};
-/**
- * Module exports.
- * @public
- */
-if (process.env.NODE_ENV === "test") {
-    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);
-        }
-        return morgan(formatLine(clever_options), morgan_options);
-    };
-    module.exports.ContextLogger = ContextLogger;
-}
-else {
-    module.exports = (clever_options, context_logger_options = defaultContextLoggerOpts) => {
-        // `source` is the one required field
-        if (!clever_options.source) {
-            throw new Error("Missing required config for 'source' in Kayvee middleware 'options'");
-        }
-        const logger = new KayveeLogger(clever_options.source);
-        const morgan_options = {
-            stream: process.stderr,
-            skip: null,
-        };
-        if (clever_options.ignore_dir) {
-            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) => {
-            if (context_logger_options.enabled) {
-                req.log = new ContextLogger(logger, context_logger_options.handlers, req);
-            }
-            morgan_logger(req, res, next);
-        };
-    };
-}

package/build/package.json

@@ -1,53 +0,0 @@
-{
-  "name": "kayvee",
-  "description": "Write data to key=val pairs, for human and machine readability",
-  "version": "3.18.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",
-    "@typescript-eslint/eslint-plugin": "^5.2.0",
-    "@typescript-eslint/parser": "^5.2.0",
-    "babel-eslint": "^6.0.2",
-    "benchmark": "^2.1.1",
-    "eslint": "^7.11.0",
-    "eslint-config-airbnb": "^7.0.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",
-    "typescript": "^3.9.10"
-  },
-  "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,69 +0,0 @@
-var assert = require("assert");
-var sinon = require("sinon");
-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" });
-    for (const level of KayveeLogger.LEVELS) {
-        it(`correctly adds context to ${level} calls`, () => {
-            const spy = sinon.spy();
-            const stub_logger = {};
-            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" };
-            assert(spy.calledWithExactly("test_title", expected_context));
-            assert.equal(spy.callCount, 1);
-        });
-        it(`correctly adds context to ${level}D calls`, () => {
-            const spy = sinon.spy();
-            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" });
-            const expected_data = {
-                log_key1: "val1",
-                key2: "new_value",
-                key3: "val3",
-            };
-            assert(spy.calledWithExactly("test_title", expected_data));
-            assert.equal(spy.callCount, 1);
-        });
-    }
-    for (const metric of KayveeLogger.METRICS) {
-        it(`correctly adds context to ${metric} calls`, () => {
-            const spy = sinon.spy();
-            const stub_logger = {};
-            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" };
-            assert(spy.calledWithExactly("test_title", 3, expected_context));
-            assert.equal(spy.callCount, 1);
-        });
-        it(`correctly adds context to ${metric}D calls`, () => {
-            const spy = sinon.spy();
-            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" });
-            const expected_data = {
-                log_key1: "val1",
-                key2: "new_value",
-                key3: "val3",
-            };
-            assert(spy.calledWithExactly("test_title", 3, expected_data));
-            assert.equal(spy.callCount, 1);
-        });
-    }
-    it("correctly handles being instantiated with empty list of handlers", () => {
-        const spy = sinon.spy();
-        const stub_logger = { infoD: spy };
-        const log = new middleware.ContextLogger(stub_logger, [], fake_req);
-        log.info("test_title");
-        const 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", () => {
-    const tests = JSON.parse(fs.readFileSync("test/tests.json"));
-    describe(".format", () => {
-        _.each(tests.format, (spec) => {
-            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)));
-            });
-        });
-    });
-    describe(".format with Errors", () => {
-        it("encodes Error objects", () => {
-            const actual = kv.format({ err: Error("An Error Message") });
-            const expected = {
-                deploy_env: "testing",
-                wf_id: "abc",
-                err: "Error: An Error Message",
-            };
-            assert.deepEqual(JSON.parse(actual), expected);
-        });
-    });
-    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 expected = spec.output;
-                assert.deepEqual(JSON.parse(actual), _.extend({ deploy_env: "testing", wf_id: "abc" }, JSON.parse(expected)));
-            });
-        });
-    });
-});