kayvee 3.17.0 → 4.0.0

package/dist/router/index.js

@@ -0,0 +1,184 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Router = exports.Rule = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const jsonschema_1 = require("jsonschema");
+const js_yaml_1 = require("js-yaml");
+// JSON imports with "with { type: 'json' }" work in both native ESM (Node 24) and
+// TypeScript/ts-node CJS (compiled to require()). This avoids import.meta.url which
+// prevents Node 24 from bypassing ts-node's CJS hook via loadESMFromCJS.
+// @ts-ignore TS1343 - import attributes are supported in TS 5.3+
+const schema_definitions_json_1 = __importDefault(require("./schema_definitions.json"));
+// @ts-ignore TS1343
+const package_json_1 = __importDefault(require("../../package.json"));
+const kvVersion = package_json_1.default.version;
+const teamName = process.env._TEAM_OWNER || "UNSET";
+const reEnvvarTokens = new RegExp("\\$\\{(.+?)\\}", "g");
+const reFieldTokens = new RegExp("%\\{(.+?)\\}", "g");
+// For performance reason this code is intentionally redundant and not-inlined.
+// Removing redundancy and inlining this function somehow makes performance worst.
+function substituteEnvVars(obj, subber) {
+    const rtn = {};
+    const replacer = (s) => s.replace(reEnvvarTokens, (__, p1) => subber(p1) ?? "");
+    for (const key in obj) {
+        const val = obj[key];
+        if (Array.isArray(val)) {
+            const updatedVals = Array(val.length);
+            for (let 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) {
+    const path = key.split(".");
+    let idx = 0;
+    let val = obj;
+    do {
+        val = val[path[idx++]];
+    } while (val && idx < path.length);
+    return val;
+}
+function fieldMatches(obj, field, values) {
+    const val = obj[field] || deepKey(obj, field);
+    if (val == null || val === "") {
+        return false;
+    }
+    if (values[0] === "*") {
+        return true;
+    }
+    for (let i = 0; i < values.length; i++) {
+        if (values[i] === val) {
+            return true;
+        }
+    }
+    return false;
+}
+class Rule {
+    name;
+    matchers;
+    output;
+    constructor(name, matchers, output) {
+        this.name = name;
+        this.matchers = matchers;
+        const envMissing = [];
+        this.output = substituteEnvVars(output, (k) => {
+            const 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((field) => {
+            const 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(msg) {
+        for (const field in this.matchers) {
+            if (!fieldMatches(msg, field, this.matchers[field])) {
+                return false;
+            }
+        }
+        return true;
+    }
+    outputFor(msg) {
+        const rtn = {};
+        const subst = (__, k) => msg[k] || deepKey(msg, k) || "KEY_NOT_FOUND";
+        const replacer = (s) => s.replace(reFieldTokens, subst);
+        for (const key in this.output) {
+            const val = this.output[key];
+            if (Array.isArray(val)) {
+                const updatedVals = Array(val.length);
+                for (let i = 0; i < val.length; i++) {
+                    updatedVals[i] = replacer(val[i]);
+                }
+                rtn[key] = updatedVals;
+            }
+            else {
+                rtn[key] = replacer(val);
+            }
+        }
+        return rtn;
+    }
+}
+exports.Rule = Rule;
+function validateKVConfig(config) {
+    const validator = new jsonschema_1.Validator();
+    const results = validator.validate(config, schema_definitions_json_1.default);
+    return {
+        valid: results.valid,
+        errors: results.errors.map((err) => err.stack ?? ""),
+    };
+}
+function parseConfig(fileString) {
+    let config;
+    try {
+        config = (0, js_yaml_1.load)(fileString);
+    }
+    catch (e) {
+        return { valid: false, rules: [], errors: [e] };
+    }
+    const validateRes = validateKVConfig(config);
+    if (!validateRes.valid) {
+        return Object.assign(validateRes, { rules: [] });
+    }
+    try {
+        const rules = Object.entries(config.routes).map(([name, elem]) => new Rule(name, elem.matchers, elem.output));
+        return { valid: true, rules, errors: [] };
+    }
+    catch (e) {
+        return { valid: false, rules: [], errors: [e] };
+    }
+}
+class Router {
+    rules;
+    constructor(rules) {
+        this.rules = rules || [];
+    }
+    loadConfig(filename) {
+        const data = node_fs_1.default.readFileSync(filename, "utf8");
+        this._loadConfigString(data);
+    }
+    _loadConfigString(configStr) {
+        const parsedRules = parseConfig(configStr);
+        if (!parsedRules.valid) {
+            throw new Error(String(parsedRules.errors));
+        }
+        this.rules = parsedRules.rules;
+    }
+    route(msg) {
+        const outputs = [];
+        for (let i = 0; i < this.rules.length; i++) {
+            const rule = this.rules[i];
+            if (rule.matches(msg)) {
+                outputs.push(rule.outputFor(msg));
+            }
+        }
+        return {
+            team: teamName,
+            kv_version: kvVersion,
+            kv_language: "js",
+            routes: outputs,
+        };
+    }
+}
+exports.Router = Router;

package/package.json

@@ -1,42 +1,82 @@
 {
   "name": "kayvee",
   "description": "Write data to key=val pairs, for human and machine readability",
-  "version": "3.17.0",
-  "main": "index.js",
+  "version": "4.0.0",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import":  "./dist/index.js",
+      "types":   "./dist/index.d.ts"
+    },
+    "./logger": {
+      "require": "./dist/logger/logger.js",
+      "import":  "./dist/logger/logger.js",
+      "types":   "./dist/logger/logger.d.ts"
+    },
+    "./middleware": {
+      "require": "./dist/middleware.js",
+      "import":  "./dist/middleware.js",
+      "types":   "./dist/middleware.d.ts"
+    },
+    "./router": {
+      "require": "./dist/router/index.js",
+      "import":  "./dist/router/index.js",
+      "types":   "./dist/router/index.d.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "logger": ["dist/logger/logger.d.ts"],
+      "middleware": ["dist/middleware.d.ts"],
+      "router": ["dist/router/index.d.ts"]
+    }
+  },
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE"
+  ],
   "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"
+    "js-yaml": "^4.1.0",
+    "jsonschema": "^1.5.0",
+    "morgan": "^1.10.0",
+    "qs": "^6.13.0"
   },
   "devDependencies": {
     "@clever/prettier-config": "1.0.0",
-    "@types/mocha": "^8.0.3",
-    "@types/node": "^12.12.68",
-    "babel-eslint": "^6.0.2",
+    "@types/express": "^4.17.23",
+    "@types/js-yaml": "^4.0.9",
+    "@types/jsonschema": "^1.1.1",
+    "@types/mocha": "^10.0.6",
+    "@types/morgan": "^1.9.10",
+    "@types/node": "^20.11.0",
+    "@types/qs": "^6.9.11",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
     "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"
+    "eslint": "^8.56.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-formatter-summary": "^1.1.0",
+    "express": "^4.18.2",
+    "mocha": "^10.2.0",
+    "prettier": "^3.2.5",
+    "sinon": "^17.0.1",
+    "split": "^1.0.0",
+    "supertest": "^6.3.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.0",
+    "underscore": "^1.8.3"
   },
   "scripts": {
     "test": "make -Br test",
-    "prepublish": "make build"
+    "prepublishOnly": "make build"
   },
   "author": "Clever <tech-notify@clever.com>",
   "license": "BSD-2-Clause",

package/.circleci/config.yml

@@ -1,25 +0,0 @@
-version: 2
-jobs:
-  build:
-    working_directory: ~/Clever/kayvee-js
-    docker:
-    - image: circleci/node:12-stretch
-    environment:
-      CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
-      CIRCLE_TEST_REPORTS: /tmp/circleci-test-results
-    steps:
-    - run:
-        command: cd $HOME && git clone --depth 1 -v https://github.com/Clever/ci-scripts.git && cd ci-scripts && git show --oneline -s
-        name: Clone ci-scripts
-    - checkout
-    - setup_remote_docker
-    - run:
-        command: mkdir -p $CIRCLE_ARTIFACTS $CIRCLE_TEST_REPORTS
-        name: Set up CircleCI artifacts directories
-    - run:
-        command: npm install
-        name: npm install
-    - run: make build
-    - run: npm test
-    - run: make benchmarks
-    - run: if [ "${CIRCLE_BRANCH}" == "master" ]; then $HOME/ci-scripts/circleci/npm-publish $NPM_TOKEN .; fi;

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

package/.nvmrc

@@ -1 +0,0 @@
-12

package/.prettierrc.json

@@ -1 +0,0 @@
-"@clever/prettier-config"

package/Makefile

@@ -1,56 +0,0 @@
-.PHONY: test build format format-all format-check lint
-TESTS=$(shell cd test && ls *.ts | sed s/\.ts$$//)
-TS_FILES := $(shell find . -name "*.ts" -not -path "./node_modules/*")
-FORMATTED_FILES := $(TS_FILES) # Add other file types as you see fit, e.g. JSON files, config files
-MODIFIED_FORMATTED_FILES := $(shell git diff --name-only master $(FORMATTED_FILES))
-
-PRETTIER := ./node_modules/.bin/prettier
-
-build: clean
-	./node_modules/.bin/tsc --outDir build
-	cp ./lib/router/schema_definitions.json ./build/lib/router/
-	cp ./package.json ./build/
-
-test: lint test/tests.json $(TESTS)
-
-$(TESTS):
-	_DEPLOY_ENV=testing _EXECUTION_NAME=abc DEBUG=us:progress NODE_ENV=test \
-	node_modules/mocha/bin/mocha --require ts-node/register --timeout 60000 test/$@.ts
-
-benchmarks: build benchmark-data
-	node benchmarks/routing.js
-
-clean:
-	rm -rf build
-
-clean-data:
-	rm ./benchmarks/data/*.json ./benchmarks/data/*.yml
-
-benchmark-data:
-	@# Only download if the files don't exist
-	@[ -f ./benchmarks/data/corpus-basic.json ] || curl https://raw.githubusercontent.com/Clever/kayvee/master/data/corpus-basic.json > ./benchmarks/data/corpus-basic.json
-	@[ -f ./benchmarks/data/corpus-pathological.json ] || curl https://raw.githubusercontent.com/Clever/kayvee/master/data/corpus-pathological.json > ./benchmarks/data/corpus-pathological.json
-	@[ -f ./benchmarks/data/corpus-realistic.json ] || curl https://raw.githubusercontent.com/Clever/kayvee/master/data/corpus-realistic.json > ./benchmarks/data/corpus-realistic.json
-	@[ -f ./benchmarks/data/kvconfig-basic.yml ] || curl https://raw.githubusercontent.com/Clever/kayvee/master/data/kvconfig-basic.yml > ./benchmarks/data/kvconfig-basic.yml
-	@[ -f ./benchmarks/data/kvconfig-pathological.yml ] || curl https://raw.githubusercontent.com/Clever/kayvee/master/data/kvconfig-pathological.yml > ./benchmarks/data/kvconfig-pathological.yml
-	@[ -f ./benchmarks/data/kvconfig-realistic.yml ] || curl https://raw.githubusercontent.com/Clever/kayvee/master/data/kvconfig-realistic.yml > ./benchmarks/data/kvconfig-realistic.yml
-
-format:
-	@echo "Formatting modified files..."
-	@$(PRETTIER) --write $(MODIFIED_FORMATTED_FILES)
-
-format-all:
-	@echo "Formatting all files..."
-	@$(PRETTIER) --write $(FORMATTED_FILES)
-
-format-check:
-	@echo "Running format check..."
-	@$(PRETTIER) --list-different $(FORMATTED_FILES) || \
-		(echo -e "❌ \033[0;31m Prettier found discrepancies in the above files. Run 'make format' to fix.\033[0m" && false)
-
-lint: format-check
-	./node_modules/.bin/tslint $(TS_FILES)
-	./node_modules/.bin/eslint $(TS_FILES)
-
-test/tests.json:
-	wget https://raw.githubusercontent.com/Clever/kayvee/master/tests.json -O test/tests.json

package/benchmarks/data/.keep

@@ -1 +0,0 @@
-

package/benchmarks/data/corpus-basic.json

@@ -1,22 +0,0 @@
-[
-	{ "title": "time" },
-	{ "title": "person" },
-	{ "title": "year" },
-	{ "title": "way" },
-	{ "title": "day" },
-	{ "title": "thing" },
-	{ "title": "man" },
-	{ "title": "world" },
-	{ "title": "life" },
-	{ "title": "hand" },
-	{ "title": "part" },
-	{ "title": "child" },
-	{ "title": "eye" },
-	{ "title": "woman" },
-	{ "title": "place" },
-	{ "title": "work" },
-	{ "title": "week" },
-	{ "title": "case" },
-	{ "title": "point" },
-	{ "title": "government" }
-]