axe 7.0.1 → 8.1.1

package/lib/index.js

@@ -4,11 +4,11 @@ function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableTo
 
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 
-function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
 
 function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
 
-function _createForOfIteratorHelper(o, allowArrayLike) { var it; if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 
@@ -18,9 +18,9 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 // eslint-disable-next-line import/no-unassigned-import
 require('console-polyfill');
@@ -55,7 +55,6 @@ var aliases = {
   err: 'error'
 };
 var endpoint = 'https://api.cabinjs.com';
-var env = process.env.NODE_ENV || 'development';
 var levelError = "`level` invalid, must be: ".concat(levels.join(', ')); // <https://stackoverflow.com/a/43233163>
 
 function isEmpty(value) {
@@ -101,18 +100,31 @@ var Axe = /*#__PURE__*/function () {
       timeout: 5000,
       retry: 3,
       showStack: process.env.SHOW_STACK ? boolean(process.env.SHOW_STACK) : true,
-      showMeta: process.env.SHOW_META ? boolean(process.env.SHOW_META) : true,
+      meta: {
+        show: process.env.SHOW_META ? boolean(process.env.SHOW_META) : true,
+        showApp: process.env.SHOW_META_APP ? boolean(process.env.SHOW_META_APP) : true,
+        omittedFields: process.env.OMIT_META_FIELDS ? process.env.OMIT_META_FIELDS.split(',').map(function (s) {
+          return s.trim();
+        }) : []
+      },
       silent: false,
       logger: console,
       name: false,
       level: 'info',
       levels: ['info', 'warn', 'error', 'fatal'],
-      capture: process.browser ? false : env === 'production',
+      // TODO: if user specifies `key` and it is `process.platform === 'browser' || process.browser || env === 'production'` then set `capture` to `true`
+      capture: false,
       callback: false,
       appInfo: process.env.APP_INFO ? boolean(process.env.APP_INFO) : true
-    }, config);
+    }, config); // For backwards compatability
+
+    if (this.config.showMeta) {
+      this.config.meta.show = this.config.showMeta;
+      delete this.config.showMeta;
+    }
+
     this.appInfo = this.config.appInfo ? isFunction(parseAppInfo) ? parseAppInfo() : false : false;
-    this.log = this.log.bind(this); // inherit methods from parent logger
+    this.log = this.log.bind(this); // Inherit methods from parent logger
 
     var methods = Object.keys(this.config.logger).filter(function (key) {
       return !omittedLoggerKeys.has(key);
@@ -125,7 +137,7 @@ var Axe = /*#__PURE__*/function () {
       for (_iterator.s(); !(_step = _iterator.n()).done;) {
         var element = _step.value;
         this[element] = this.config.logger[element];
-      } // bind helper functions for each log level
+      } // Bind helper functions for each log level
 
     } catch (err) {
       _iterator.e(err);
@@ -145,13 +157,13 @@ var Axe = /*#__PURE__*/function () {
             args[_key] = arguments[_key];
           }
 
-          return _this.log.apply(_this, _toConsumableArray([element].concat([].slice.call(args))));
+          return _this.log.apply(_this, _toConsumableArray([element].concat(Array.prototype.slice.call(args))));
         };
       };
 
       for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
         _loop();
-      } // we could have used `auto-bind` but it's not compiled for browser
+      } // We could have used `auto-bind` but it's not compiled for browser
 
     } catch (err) {
       _iterator2.e(err);
@@ -162,11 +174,11 @@ var Axe = /*#__PURE__*/function () {
     this.setLevel = this.setLevel.bind(this);
     this.getNormalizedLevel = this.getNormalizedLevel.bind(this);
     this.setName = this.setName.bind(this);
-    this.setCallback = this.setCallback.bind(this); // set the logger name
+    this.setCallback = this.setCallback.bind(this); // Set the logger name
 
-    if (this.config.name) this.setName(this.config.name); // set the logger level
+    if (this.config.name) this.setName(this.config.name); // Set the logger level
 
-    this.setLevel(this.config.level); // aliases
+    this.setLevel(this.config.level); // Aliases
 
     this.err = this.error;
     this.warning = this.warn;
@@ -180,9 +192,9 @@ var Axe = /*#__PURE__*/function () {
   }, {
     key: "setLevel",
     value: function setLevel(level) {
-      if (!isString(level) || !levels.includes(level)) throw new Error(levelError); // support signale logger and other loggers that use `logLevel`
+      if (!isString(level) || !levels.includes(level)) throw new Error(levelError); // Support signale logger and other loggers that use `logLevel`
 
-      if (isString(this.config.logger.logLevel)) this.config.logger.logLevel = level;else this.config.logger.level = level; // adjusts `this.config.levels` array
+      if (isString(this.config.logger.logLevel)) this.config.logger.logLevel = level;else this.config.logger.level = level; // Adjusts `this.config.levels` array
       // so that it has all proceeding (inclusive)
 
       this.config.levels = levels.slice(levels.indexOf(level));
@@ -198,7 +210,7 @@ var Axe = /*#__PURE__*/function () {
   }, {
     key: "setName",
     value: function setName(name) {
-      if (!isString(name)) throw new Error('`name` must be a String'); // support signale logger and other loggers that use `scope`
+      if (!isString(name)) throw new Error('`name` must be a String'); // Support signale logger and other loggers that use `scope`
 
       if (isString(this.config.logger.scope)) this.config.logger.scope = name;else this.config.logger.name = name;
     } // eslint-disable-next-line complexity
@@ -217,7 +229,7 @@ var Axe = /*#__PURE__*/function () {
         args[_key2 - 3] = arguments[_key2];
       }
 
-      originalArgs = originalArgs.concat([].slice.call(args));
+      originalArgs = originalArgs.concat(Array.prototype.slice.call(args));
       var config = this.config;
       var modifier = 0;
 
@@ -232,7 +244,7 @@ var Axe = /*#__PURE__*/function () {
         message = level;
         level = this.getNormalizedLevel(level);
         modifier = -1;
-      } // bunyan support (meta, message, ...args)
+      } // Bunyan support (meta, message, ...args)
 
 
       var isBunyan = false;
@@ -242,10 +254,10 @@ var Axe = /*#__PURE__*/function () {
         var _meta = meta;
         meta = message;
         message = isString(_meta) && originalArgs.length >= 3 + modifier ? format.apply(void 0, _toConsumableArray(originalArgs.slice(2 + modifier))) : _meta;
-      } // if message was undefined then set it to level
+      } // If message was undefined then set it to level
 
 
-      if (isUndefined(message)) message = level; // if only `message` was passed then if it was an Object
+      if (isUndefined(message)) message = level; // If only `message` was passed then if it was an Object
       // preserve it as an Object by setting it as meta
 
       if (originalArgs.slice(1 + modifier).length === 1 && !isString(message) && !isError(message)) {
@@ -254,14 +266,14 @@ var Axe = /*#__PURE__*/function () {
         };
         message = level;
       } else if (!isBunyan && originalArgs.length >= 4 + modifier) {
-        // if there are four or more args
+        // If there are four or more args
         // then infer to use util.format on everything
         message = format.apply(void 0, _toConsumableArray(originalArgs.slice(1 + modifier)));
         meta = {};
-      } else if (!isBunyan && originalArgs.length === 3 + modifier && isString(message) && formatSpecifiers.filter(function (t) {
+      } else if (!isBunyan && originalArgs.length === 3 + modifier && isString(message) && formatSpecifiers.some(function (t) {
         return message.includes(t);
-      }).length > 0) {
-        // otherwise if there are three args and if the `message` contains
+      })) {
+        // Otherwise if there are three args and if the `message` contains
         // a placeholder token (e.g. '%s' or '%d' - see above `formatSpecifiers` variable)
         // then we can infer that the `meta` arg passed is used for formatting
         message = format(message, meta);
@@ -272,71 +284,71 @@ var Axe = /*#__PURE__*/function () {
             err: parseErr(meta)
           }; // } else if (!isPlainObject(meta) && !isUndefined(meta) && !isNull(meta)) {
         } else if (!isObject(meta) && !isUndefined(meta) && !isNull(meta)) {
-          // if the `meta` variable passed was not an Object then convert it
+          // If the `meta` variable passed was not an Object then convert it
           message = format(message, meta);
           meta = {};
         } else if (!isString(message)) {
-          // if the message is not a string then we should run `util.format` on it
+          // If the message is not a string then we should run `util.format` on it
           // assuming we're formatting it like it was another argument
           // (as opposed to using something like fast-json-stringify)
           message = format(message);
         }
-      } // if (!isPlainObject(meta)) meta = {};
+      } // If (!isPlainObject(meta)) meta = {};
 
 
       if (!isUndefined(meta) && !isObject(meta)) meta = {
         meta: meta
       };else if (!isObject(meta)) meta = {};
-      var err;
+      var error;
 
       if (isError(message)) {
-        err = message;
-        if (!isObject(meta.err)) meta.err = parseErr(err);
+        error = message;
+        if (!isObject(meta.err)) meta.err = parseErr(error);
         var _message = message;
         message = _message.message;
       } else if (isError(meta.err)) {
-        err = meta.err;
-      } // omit `callback` from `meta` if it was passed
+        error = meta.err;
+      } // Omit `callback` from `meta` if it was passed
 
 
       var callback = isFunction(config.callback) && (!isBoolean(meta.callback) || meta.callback);
-      meta = omit(meta, ['callback']); // set default level on meta
+      meta = omit(meta, ['callback']); // Set default level on meta
 
-      meta.level = level; // add `app` object to metadata
+      meta.level = level; // Add `app` object to metadata
 
-      if (this.appInfo) meta.app = this.appInfo; // set the body used for returning with and sending logs
+      if (this.appInfo) meta.app = this.appInfo; // Set the body used for returning with and sending logs
       // (and also remove circular references)
 
       var body = safeStringify({
         message: message,
         meta: meta
-      }); // send to Cabin or other logging service here the `message` and `meta`
+      }); // Send to Cabin or other logging service here the `message` and `meta`
 
-      if (config.capture && config.levels.includes(level) && (!isError(err) || !err._captureFailed)) {
-        // if the user didn't specify a key
+      if (config.capture && config.levels.includes(level) && (!isError(error) || !error._captureFailed)) {
+        // If the user didn't specify a key
         // and they are using the default endpoint
         // then we should throw an error to them
-        if (config.endpoint === endpoint && !config.key) throw new Error("Cabin API key required (e.g. `{ key: 'YOUR-CABIN-API-KEY' })`)\n<https://cabinjs.com>"); // capture the log over HTTP
+        if (config.endpoint === endpoint && !config.key) throw new Error("Cabin API key required (e.g. `{ key: 'YOUR-CABIN-API-KEY' })`)\n<https://cabinjs.com>"); // Capture the log over HTTP
 
         var request = superagent.post(config.endpoint).set('X-Request-Id', cuid()).timeout(config.timeout);
-        if (!process.browser) request.set('User-Agent', "axe/".concat(pkg.version)); // basic auth (e.g. Cabin API key)
+        if (!process.browser) request.set('User-Agent', "axe/".concat(pkg.version)); // Basic auth (e.g. Cabin API key)
 
-        if (config.key) request.auth(config.key); // set headers if any
+        if (config.key) request.auth(config.key); // Set headers if any
 
         if (!isEmpty(config.headers)) request.set(config.headers);
-        request.type('application/json').send(body).retry(config.retry).end(function (err) {
-          if (err) {
-            err._captureFailed = true;
+        request.type('application/json').send(body).retry(config.retry).end(function (error_) {
+          if (error_) {
+            error_._captureFailed = true;
 
-            _this2.config.logger.error(err);
+            _this2.config.logger.error(error_);
           }
         });
-      } // custom callback function (e.g. Slack message)
+      } // Custom callback function (e.g. Slack message)
 
 
-      if (callback) config.callback(level, message, meta); // suppress logs if it was silent
+      if (callback) config.callback(level, message, meta); // Suppress logs if it was silent
 
-      if (config.silent) return body; // return early if it is not a valid logging level
+      if (config.silent) return body; // Return early if it is not a valid logging level
 
       if (!config.levels.includes(level)) return body; //
       // determine log method to use
@@ -349,17 +361,21 @@ var Axe = /*#__PURE__*/function () {
       //
 
       var method = level;
-      if (modifier === -1) method = 'log';else if (level === 'fatal') method = 'error'; // if there was meta information then output it
+      if (modifier === -1) method = 'log';else if (level === 'fatal') method = 'error'; // If there was meta information then output it
+      // setup ommitted fields
+
+      var omittedFields = ['level', 'err'].concat(this.config.meta.omittedFields); // Omit app is configured
 
-      var omitted = omit(meta, ['level', 'err']); // show stack trace if necessary (along with any metadata)
+      if (!this.config.meta.showApp) omittedFields.push('app');
+      var omitted = omit(meta, omittedFields); // Show stack trace if necessary (along with any metadata)
 
-      if (method === 'error' && isError(err) && config.showStack) {
-        if (!config.showMeta || isEmpty(omitted)) this.config.logger.error(err);else this.config.logger.error(err, omitted);
-      } else if (!config.showMeta || isEmpty(omitted)) {
+      if (method === 'error' && isError(error) && config.showStack) {
+        if (!config.meta.show || isEmpty(omitted)) this.config.logger.error(error);else this.config.logger.error(error, omitted);
+      } else if (!config.meta.show || isEmpty(omitted)) {
         this.config.logger[method](message);
       } else {
         this.config.logger[method](message, omitted);
-      } // return the parsed body in case we need it
+      } // Return the parsed body in case we need it
 
 
       return body;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "axe",
   "description": "Logging add-on to send logs over HTTP to your server in Node and Browser environments. Works with any logger! Chop up your logs consistently! Made for Cabin and Lad.",
-  "version": "7.0.1",
+  "version": "8.1.1",
   "author": "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com)",
   "ava": {
     "serial": true,
@@ -31,49 +31,49 @@
   ],
   "dependencies": {
     "@ladjs/format-util": "^1.0.4",
-    "boolean": "^3.0.2",
+    "boolean": "^3.1.4",
     "console-polyfill": "^0.3.0",
     "cuid": "^2.1.8",
-    "fast-safe-stringify": "^2.0.7",
+    "fast-safe-stringify": "^2.1.1",
     "format-specifiers": "^1.0.0",
     "iserror": "^0.0.2",
     "lodash.omit": "^4.5.0",
-    "parse-app-info": "^4.0.1",
+    "parse-app-info": "^4.0.2",
     "parse-err": "^0.0.12",
-    "superagent": "^6.1.0"
+    "superagent": "^7.0.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.12.7",
-    "@babel/core": "^7.12.7",
-    "@babel/preset-env": "^7.12.7",
-    "@commitlint/cli": "^11.0.0",
-    "@commitlint/config-conventional": "^11.0.0",
-    "ava": "^3.13.0",
+    "@babel/cli": "^7.16.8",
+    "@babel/core": "^7.16.7",
+    "@babel/preset-env": "^7.16.8",
+    "@commitlint/cli": "^16.0.2",
+    "@commitlint/config-conventional": "^16.0.0",
+    "ava": "^4.0.1",
     "babelify": "^10.0.0",
     "browserify": "^17.0.0",
-    "codecov": "^3.8.1",
-    "consola": "^2.15.0",
-    "cross-env": "^7.0.2",
-    "eslint": "^7.14.0",
-    "eslint-config-xo-lass": "^1.0.4",
-    "eslint-plugin-compat": "^3.8.0",
+    "codecov": "^3.8.2",
+    "consola": "^2.15.3",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.6.0",
+    "eslint-config-xo-lass": "^1.0.6",
+    "eslint-plugin-compat": "^4.0.1",
     "eslint-plugin-node": "^11.1.0",
-    "express": "^4.17.1",
-    "fixpack": "^3.0.6",
-    "husky": "^4.3.0",
+    "express": "^4.17.2",
+    "fixpack": "^4.0.0",
+    "husky": "^7.0.4",
     "jsdom": "15.x",
-    "koa": "^2.13.0",
-    "lint-staged": "^10.5.1",
-    "lodash": "^4.17.20",
+    "koa": "^2.13.4",
+    "lint-staged": "^12.1.7",
+    "lodash": "^4.17.21",
     "nyc": "^15.1.0",
-    "pino": "^6.7.0",
-    "remark-cli": "^9.0.0",
-    "remark-preset-github": "^3.0.4",
+    "pino": "^7.6.3",
+    "remark-cli": "^10.0.1",
+    "remark-preset-github": "^4.0.1",
     "rimraf": "^3.0.2",
     "signale": "^1.4.0",
-    "sinon": "^9.2.1",
+    "sinon": "^12.0.1",
     "tinyify": "https://github.com/niftylettuce/tinyify",
-    "xo": "^0.35.0"
+    "xo": "^0.47.0"
   },
   "engines": {
     "node": ">=7.0.0"
@@ -169,6 +169,10 @@
     ],
     "ignore": [
       "config.js"
-    ]
+    ],
+    "rules": {
+      "node/prefer-global/process": "off",
+      "unicorn/prefer-spread": "off"
+    }
   }
 }