kayvee 3.18.0 → 4.0.0

package/{build/lib → dist}/router/index.js

@@ -1,18 +1,28 @@
-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");
-const kvVersion = packageJson.version;
+"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 some how makes performance worst.
+// 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));
+    const replacer = (s) => s.replace(reEnvvarTokens, (__, p1) => subber(p1) ?? "");
     for (const key in obj) {
         const val = obj[key];
         if (Array.isArray(val)) {
@@ -53,10 +63,10 @@ function fieldMatches(obj, field, values) {
     return false;
 }
 class Rule {
+    name;
+    matchers;
+    output;
     constructor(name, matchers, output) {
-        this.name = null;
-        this.matchers = null;
-        this.output = null;
         this.name = name;
         this.matchers = matchers;
         const envMissing = [];
@@ -82,7 +92,6 @@ class Rule {
         }
         this.output.rule = this.name;
     }
-    // matches returns true if `msg` matches against this rule
     matches(msg) {
         for (const field in this.matchers) {
             if (!fieldMatches(msg, field, this.matchers[field])) {
@@ -91,7 +100,6 @@ class Rule {
         }
         return true;
     }
-    // returns the output with kv substitutions performed
     outputFor(msg) {
         const rtn = {};
         const subst = (__, k) => msg[k] || deepKey(msg, k) || "KEY_NOT_FOUND";
@@ -112,39 +120,29 @@ class Rule {
         return rtn;
     }
 }
-// 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).
+exports.Rule = Rule;
 function validateKVConfig(config) {
-    const validator = new jsonschema.Validator();
-    const results = validator.validate(config, schema);
+    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),
+        errors: results.errors.map((err) => 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) {
     let config;
     try {
-        config = yaml.safeLoad(fileString);
+        config = (0, js_yaml_1.load)(fileString);
     }
     catch (e) {
         return { valid: false, rules: [], errors: [e] };
     }
     const validateRes = validateKVConfig(config);
     if (!validateRes.valid) {
-        return _.assign(validateRes, { rules: [] });
+        return Object.assign(validateRes, { rules: [] });
     }
     try {
-        const rulesObj = _.mapObject(config.routes, (elem, name) => new Rule(name, elem.matchers, elem.output));
-        const rules = _.values(rulesObj);
+        const rules = Object.entries(config.routes).map(([name, elem]) => new Rule(name, elem.matchers, elem.output));
         return { valid: true, rules, errors: [] };
     }
     catch (e) {
@@ -152,28 +150,21 @@ function parseConfig(fileString) {
     }
 }
 class Router {
+    rules;
     constructor(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.
     loadConfig(filename) {
-        const data = fs.readFileSync(filename, "utf8");
+        const data = node_fs_1.default.readFileSync(filename, "utf8");
         this._loadConfigString(data);
     }
     _loadConfigString(configStr) {
         const parsedRules = parseConfig(configStr);
         if (!parsedRules.valid) {
-            throw new Error(parsedRules.errors);
+            throw new Error(String(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.
     route(msg) {
         const outputs = [];
         for (let i = 0; i < this.rules.length; i++) {
@@ -190,7 +181,4 @@ class Router {
         };
     }
 }
-module.exports = {
-    Router,
-    Rule,
-};
+exports.Router = Router;

package/package.json

@@ -1,46 +1,82 @@
 {
   "name": "kayvee",
   "description": "Write data to key=val pairs, for human and machine readability",
-  "version": "3.18.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",
-    "@typescript-eslint/eslint-plugin": "^5.2.0",
-    "@typescript-eslint/parser": "^5.2.0",
-    "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": "^7.11.0",
-    "eslint-config-airbnb": "^7.0.0",
-    "eslint-config-prettier": "^6.12.0",
+    "eslint": "^8.56.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^9.1.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"
+    "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.js

@@ -1,124 +0,0 @@
-module.exports = {
-  env: {
-    browser: true,
-    jasmine: true,
-    jest: true,
-    mocha: true,
-    node: true,
-  },
-  extends: [
-    // https://github.com/eslint/eslint
-    "eslint:recommended",
-    // https://github.com/yannickcr/eslint-plugin-react
-    "plugin:react/recommended",
-    // https://github.com/facebook/react/tree/master/packages/eslint-plugin-react-hooks
-    "plugin:react-hooks/recommended",
-    // https: //github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-    // https://github.com/prettier/eslint-config-prettier
-    "prettier",
-    "prettier/@typescript-eslint",
-  ],
-  parser: "@typescript-eslint/parser",
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-    ecmaVersion: 13,
-    sourceType: "module",
-    project: "./tsconfig.json",
-  },
-  plugins: ["react", "react-hooks", "@typescript-eslint"],
-  rules: {
-    camelcase: "off",
-    "comma-dangle": ["error", "always-multiline"],
-    eqeqeq: ["error", "smart"],
-    "global-require": "off",
-    "import/no-unresolved": "off",
-    indent: "off",
-    "key-spacing": ["error", { mode: "minimum" }],
-    "max-len": [
-      "error",
-      {
-        code: 115,
-        ignorePattern: "^import",
-        ignoreRegExpLiterals: true,
-        ignoreStrings: true,
-        ignoreTemplateLiterals: true,
-        ignoreUrls: true,
-      },
-    ],
-    "new-cap": [
-      "error",
-      {
-        capIsNewExceptions: ["immutable.OrderedMap", "OrderedMap"],
-        newIsCapExceptions: ["kayvee.logger"],
-      },
-    ],
-    "newline-per-chained-call": "off",
-    "no-console": "off",
-    "no-multi-spaces": [
-      "error",
-      {
-        exceptions: {
-          ImportDeclaration: true,
-          VariableDeclarator: true,
-        },
-      },
-    ],
-    "no-param-reassign": [
-      "error",
-      {
-        props: false,
-      },
-    ],
-    "no-restricted-syntax": [
-      "error",
-      {
-        message: "Prefer useTypedDispatch to get a typed version of dispatch.",
-        selector: "CallExpression[callee.name='useDispatch']",
-      },
-    ],
-    "no-underscore-dangle": "off",
-    "no-unused-vars": "off",
-    "no-var": "off",
-    quotes: ["error", "double", "avoid-escape"],
-    "react/display-name": "off",
-    "react/jsx-indent": "off",
-    "react/no-did-update-set-state": "off",
-    "react/prop-types": "off",
-    "react/sort-comp": "off",
-    "vars-on-top": "off",
-    "@typescript-eslint/ban-ts-comment": [
-      "error",
-      {
-        "ts-ignore": false,
-      },
-    ],
-    "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/explicit-function-return-type": "off",
-    "@typescript-eslint/no-empty-function": ["error", { allow: ["arrowFunctions"] }],
-    "@typescript-eslint/no-empty-interface": "off",
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-floating-promises": "off",
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/no-unused-vars": ["error", { args: "none" }],
-    "@typescript-eslint/no-use-before-define": "off",
-    "@typescript-eslint/no-var-requires": "off",
-  },
-  overrides: [
-    {
-      files: ["*.ts", "*.tsx"],
-      rules: {
-        "no-undef": "off",
-      },
-    },
-  ],
-  settings: {
-    "import/resolver": "webpack",
-    react: {
-      version: "detect",
-    },
-  },
-};

package/.github/workflows/notify-ci-status.yml

@@ -1,20 +0,0 @@
-name: Notify CI status
-
-on:
-  check_suite:
-    types: [completed]
-  status:
-
-jobs:
-  call-workflow:
-    if: >-
-      (github.event.branches[0].name == github.event.repository.default_branch &&
-        (github.event.state == 'error' || github.event.state == 'failure')) ||
-      (github.event.check_suite.head_branch == github.event.repository.default_branch &&
-        github.event.check_suite.conclusion != 'success')
-    uses: Clever/ci-scripts/.github/workflows/reusable-notify-ci-status.yml@master
-    secrets:
-      CIRCLE_CI_INTEGRATIONS_URL: ${{ secrets.CIRCLE_CI_INTEGRATIONS_URL }}
-      CIRCLE_CI_INTEGRATIONS_USERNAME: ${{ secrets.CIRCLE_CI_INTEGRATIONS_USERNAME }}
-      CIRCLE_CI_INTEGRATIONS_PASSWORD: ${{ secrets.CIRCLE_CI_INTEGRATIONS_PASSWORD }}
-      SLACK_BOT_TOKEN: ${{ secrets.DAPPLE_BOT_TOKEN }}

package/.nvmrc

@@ -1 +0,0 @@
-14

package/.prettierrc.json

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

package/Makefile

@@ -1,55 +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/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" }
-]