kayvee 3.16.0 → 3.18.0

package/.eslintrc.js

@@ -0,0 +1,124 @@
+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

@@ -0,0 +1,20 @@
+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 +1 @@
-12
+14

package/.prettierrc.json

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

package/Makefile

@@ -1,6 +1,10 @@
-.PHONY: test build
+.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/*" -not -path "./typings/*")
+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
@@ -31,8 +35,20 @@ benchmark-data:
 	@[ -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
 
-lint:
-	./node_modules/.bin/tslint $(TS_FILES)
+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:

package/build/lib/kayvee.js

@@ -1,10 +1,10 @@
 var _ = require("underscore");
-var deploy_env = process.env._DEPLOY_ENV;
-var workflow_id = process.env._EXECUTION_NAME;
-var pod_id = process.env._POD_ID;
-var pod_shortname = process.env._POD_SHORTNAME;
-var pod_region = process.env._POD_REGION;
-var pod_account = process.env._POD_ACCOUNT;
+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) {
@@ -15,7 +15,7 @@ function replaceErrors(key, 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) {
-        var extras = {};
+        const extras = {};
         if (deploy_env) {
             extras.deploy_env = deploy_env;
         }
@@ -39,24 +39,20 @@ function format(data) {
     return JSON.stringify(data, replaceErrors);
 }
 // Similar to format, but takes additional reserved params to promote logging best-practices
-function formatLog(source, level, title, data) {
-    if (source === void 0) { source = ""; }
-    if (level === void 0) { level = ""; }
-    if (title === void 0) { title = ""; }
-    if (data === void 0) { data = {}; }
-    var info = data;
+function formatLog(source = "", level = "", title = "", data = {}) {
+    let info = data;
     if (!_.isObject(data)) {
         info = {};
     }
-    var reserved = { source: source, level: level, title: title };
+    const reserved = { source, level, title };
     // reserved keys overwrite other keys in data
     return format(_.extend({}, info, reserved));
 }
 module.exports = {
-    format: format,
-    formatLog: formatLog,
+    format,
+    formatLog,
 };
-var LOG_LEVELS = {
+const LOG_LEVELS = {
     UNKNOWN: "unknown",
     CRITICAL: "critical",
     ERROR: "error",

package/build/lib/logger/logger.js

@@ -17,8 +17,8 @@ var LOG_LEVEL_ENUM = {
     error: 4,
     critical: 5,
 };
-var assign = Object.assign || _.assign; // Use the faster Object.assign if possible
-var globalRouter;
+const assign = Object.assign || _.assign; // Use the faster Object.assign if possible
+let globalRouter;
 function setGlobalRouting(filename) {
     globalRouter = new router.Router();
     globalRouter.loadConfig(filename);
@@ -27,21 +27,20 @@ function getGlobalRouter() {
     return globalRouter;
 }
 // This is a port from kayvee-go/logger/logger.go
-var Logger = (function () {
-    function Logger(source, logLvl, formatter, output) {
-        if (logLvl === void 0) { logLvl = process.env.KAYVEE_LOG_LEVEL; }
-        if (formatter === void 0) { formatter = kv.format; }
-        if (output === void 0) { output = console.error; }
+class Logger {
+    constructor(source, logLvl = process.env.KAYVEE_LOG_LEVEL, formatter = kv.format, output = console.error) {
         this.formatter = null;
         this.logLvl = null;
         this.globals = null;
         this.logWriter = null;
         this.logRouter = null;
+        this.asyncLocalStorage = null;
         this.formatter = formatter;
         this.logLvl = this._validateLogLvl(logLvl);
         this.globals = {};
         this.globals.source = source;
         this.logWriter = output;
+        this.asyncLocalStorage = null;
         if (process.env._TEAM_OWNER) {
             this.globals.team = process.env._TEAM_OWNER;
         }
@@ -64,17 +63,20 @@ var Logger = (function () {
             this.globals["pod-account"] = process.env._POD_ACCOUNT;
         }
     }
-    Logger.prototype.setRouter = function (r) {
+    setAsyncLocalStorage(asyncLocalStorage) {
+        this.asyncLocalStorage = asyncLocalStorage;
+    }
+    setRouter(r) {
         this.logRouter = r;
-    };
-    Logger.prototype.setConfig = function (source, logLvl, formatter, output) {
+    }
+    setConfig(source, logLvl, formatter, output) {
         this.globals.source = source;
         this.logLvl = this._validateLogLvl(logLvl);
         this.formatter = formatter;
         this.logWriter = output;
         return this.logWriter;
-    };
-    Logger.prototype._validateLogLvl = function (logLvl) {
+    }
+    _validateLogLvl(logLvl) {
         if (logLvl == null) {
             return LEVELS.Debug;
         }
@@ -87,92 +89,99 @@ var Logger = (function () {
             }
         }
         return LEVELS.Debug;
-    };
-    Logger.prototype.setLogLevel = function (logLvl) {
+    }
+    setLogLevel(logLvl) {
         this.logLvl = this._validateLogLvl(logLvl);
         return this.logLvl;
-    };
-    Logger.prototype.setFormatter = function (formatter) {
+    }
+    setFormatter(formatter) {
         this.formatter = formatter;
         return this.formatter;
-    };
-    Logger.prototype.setOutput = function (output) {
+    }
+    setOutput(output) {
         this.logWriter = output;
         return this.logWriter;
-    };
-    Logger.prototype.trace = function (title) {
+    }
+    trace(title) {
         this.traceD(title, {});
-    };
-    Logger.prototype.debug = function (title) {
+    }
+    debug(title) {
         this.debugD(title, {});
-    };
-    Logger.prototype.info = function (title) {
+    }
+    info(title) {
         this.infoD(title, {});
-    };
-    Logger.prototype.warn = function (title) {
+    }
+    warn(title) {
         this.warnD(title, {});
-    };
-    Logger.prototype.error = function (title) {
+    }
+    error(title) {
         this.errorD(title, {});
-    };
-    Logger.prototype.critical = function (title) {
+    }
+    critical(title) {
         this.criticalD(title, {});
-    };
-    Logger.prototype.counter = function (title) {
+    }
+    counter(title) {
         this.counterD(title, 1, {});
-    };
-    Logger.prototype.gauge = function (title, value) {
+    }
+    gauge(title, value) {
         this.gaugeD(title, value, {});
-    };
-    Logger.prototype.traceD = function (title, data) {
+    }
+    traceD(title, data) {
         this._logWithLevel(LEVELS.Trace, {
-            title: title,
+            title,
         }, data);
-    };
-    Logger.prototype.debugD = function (title, data) {
+    }
+    debugD(title, data) {
         this._logWithLevel(LEVELS.Debug, {
-            title: title,
+            title,
         }, data);
-    };
-    Logger.prototype.infoD = function (title, data) {
+    }
+    infoD(title, data) {
         this._logWithLevel(LEVELS.Info, {
-            title: title,
+            title,
         }, data);
-    };
-    Logger.prototype.warnD = function (title, data) {
+    }
+    warnD(title, data) {
         this._logWithLevel(LEVELS.Warning, {
-            title: title,
+            title,
         }, data);
-    };
-    Logger.prototype.errorD = function (title, data) {
+    }
+    errorD(title, data) {
         this._logWithLevel(LEVELS.Error, {
-            title: title,
+            title,
         }, data);
-    };
-    Logger.prototype.criticalD = function (title, data) {
+    }
+    criticalD(title, data) {
         this._logWithLevel(LEVELS.Critical, {
-            title: title,
+            title,
         }, data);
-    };
-    Logger.prototype.counterD = function (title, value, data) {
+    }
+    counterD(title, value, data) {
         this._logWithLevel(LEVELS.Info, {
-            title: title,
-            value: value,
+            title,
+            value,
             type: "counter",
         }, data);
-    };
-    Logger.prototype.gaugeD = function (title, value, data) {
+    }
+    gaugeD(title, value, data) {
         this._logWithLevel(LEVELS.Info, {
-            title: title,
-            value: value,
+            title,
+            value,
             type: "gauge",
         }, data);
-    };
-    Logger.prototype._logWithLevel = function (logLvl, metadata, userdata) {
+    }
+    _logWithLevel(logLvl, metadata, userdata) {
         if (LOG_LEVEL_ENUM[logLvl] < LOG_LEVEL_ENUM[this.logLvl]) {
             return;
         }
-        var data = assign({ level: logLvl }, this.globals, metadata, userdata);
+        // I'm not clever enough to want to do these in one line without extra vars.
+        // We're on a REALLY old version of TS compiling to ES5. So I don't get a lot of the fancy tools
+        // like ?. and ??.
+        const store = this.asyncLocalStorage && this.asyncLocalStorage.getStore();
+        const storeData = store || { get: () => ({}) };
+        const contextData = storeData.get("context") ? storeData.get("context") : {};
+        const plainContextData = contextData instanceof Map ? Object.fromEntries(contextData) : contextData;
+        var data = assign({ level: logLvl }, this.globals, metadata, plainContextData, userdata);
         if (this.logRouter) {
             data._kvmeta = this.logRouter.route(data);
         }
@@ -180,27 +189,26 @@ var Logger = (function () {
             data._kvmeta = globalRouter.route(data);
         }
         this.logWriter(this.formatter(data));
-    };
-    return Logger;
-}());
+    }
+}
 module.exports = Logger;
 module.exports.setGlobalRouting = setGlobalRouting;
 module.exports.getGlobalRouter = getGlobalRouter;
-module.exports.mockRouting = function (cb) {
-    var _logWithLevel = Logger.prototype._logWithLevel;
+module.exports.mockRouting = (cb) => {
+    const _logWithLevel = Logger.prototype._logWithLevel;
     if (_logWithLevel.isMocked) {
         throw Error("Nested kv.mockRouting calls are not supported");
     }
-    var ruleMatches = {};
+    const ruleMatches = {};
     Logger.prototype._logWithLevel = function (logLvl, metadata, userdata) {
-        var formatter = this.formatter;
-        var logWriter = this.logWriter;
-        this.formatter = function (msg) { return msg; };
-        this.logWriter = function (msg) {
+        const formatter = this.formatter;
+        const logWriter = this.logWriter;
+        this.formatter = (msg) => msg;
+        this.logWriter = (msg) => {
             if (!msg._kvmeta) {
                 return;
             }
-            msg._kvmeta.routes.forEach(function (route) {
+            msg._kvmeta.routes.forEach((route) => {
                 ruleMatches[route.rule] = (ruleMatches[route.rule] || []).concat(route);
             });
         };
@@ -208,9 +216,9 @@ module.exports.mockRouting = function (cb) {
         this.formatter = formatter;
         this.logWriter = logWriter;
     };
-    var stfuTypeScript = Logger.prototype._logWithLevel;
+    const stfuTypeScript = Logger.prototype._logWithLevel;
     stfuTypeScript.isMocked = true;
-    var done = function () {
+    const done = () => {
         Logger.prototype._logWithLevel = _logWithLevel;
         return ruleMatches;
     };