@percy/logger 1.0.0-beta.7 → 1.0.0-beta.73

package/dist/logger.js

@@ -0,0 +1,341 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.PercyLogger = void 0;
+
+var _util = require("./util");
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+const URL_REGEXP = /\bhttps?:\/\/[^\s/$.?#].[^\s]*\b/i;
+const LOG_LEVELS = {
+  debug: 0,
+  info: 1,
+  warn: 2,
+  error: 3
+}; // A PercyLogger instance retains logs in-memory for quick lookups while also writing log
+// messages to stdout and stderr depending on the log level and debug string.
+
+class PercyLogger {
+  // default log level
+  // namespace regular expressions used to determine which debug logs to write
+  // in-memory store for logs and meta info
+  // track deprecations to limit noisy logging
+  // static vars can be overriden for testing
+  // Handles setting env var values and returns a singleton
+  constructor() {
+    _defineProperty(this, "level", 'info');
+
+    _defineProperty(this, "namespaces", {
+      include: [/^.*?$/],
+      exclude: []
+    });
+
+    _defineProperty(this, "messages", new Set());
+
+    _defineProperty(this, "deprecations", new Set());
+
+    let {
+      instance = this
+    } = this.constructor;
+
+    if (process.env.PERCY_DEBUG) {
+      instance.debug(process.env.PERCY_DEBUG);
+    } else if (process.env.PERCY_LOGLEVEL) {
+      instance.loglevel(process.env.PERCY_LOGLEVEL);
+    }
+
+    this.constructor.instance = instance;
+    return instance;
+  } // Change log level at any time or return the current log level
+
+
+  loglevel(level) {
+    if (level) this.level = level;
+    return this.level;
+  } // Change namespaces by generating an array of namespace regular expressions from a
+  // comma separated debug string
+
+
+  debug(namespaces) {
+    if (this.namespaces.string === namespaces) return;
+    this.namespaces.string = namespaces;
+    namespaces = namespaces.split(/[\s,]+/).filter(Boolean);
+    if (!namespaces.length) return this.namespaces;
+    this.loglevel('debug');
+    this.namespaces = namespaces.reduce((namespaces, ns) => {
+      ns = ns.replace(/:?\*/g, m => m[0] === ':' ? ':?.*?' : '.*?');
+
+      if (ns[0] === '-') {
+        namespaces.exclude.push(new RegExp('^' + ns.substr(1) + '$'));
+      } else {
+        namespaces.include.push(new RegExp('^' + ns + '$'));
+      }
+
+      return namespaces;
+    }, {
+      string: namespaces,
+      include: [],
+      exclude: []
+    });
+  } // Creates a new log group and returns level specific functions for logging
+
+
+  group(name) {
+    return Object.keys(LOG_LEVELS).reduce((group, level) => Object.assign(group, {
+      [level]: this.log.bind(this, name, level)
+    }), {
+      deprecated: this.deprecated.bind(this, name),
+      shouldLog: this.shouldLog.bind(this, name),
+      progress: this.progress.bind(this, name),
+      format: this.format.bind(this, name),
+      loglevel: this.loglevel.bind(this),
+      stdout: this.constructor.stdout,
+      stderr: this.constructor.stderr
+    });
+  } // Query for a set of logs by filtering the in-memory store
+
+
+  query(filter) {
+    return Array.from(this.messages).filter(filter);
+  } // Formats messages before they are logged to stdio
+
+
+  format(debug, level, message, elapsed) {
+    let label = 'percy';
+    let suffix = '';
+
+    if (arguments.length === 1) {
+      // format(message)
+      [debug, message] = [null, debug];
+    } else if (arguments.length === 2) {
+      // format(debug, message)
+      [level, message] = [null, level];
+    }
+
+    if (this.level === 'debug') {
+      // include debug info in the label
+      if (debug) label += `:${debug}`; // include elapsed time since last log
+
+      if (elapsed != null) {
+        suffix = ' ' + _util.colors.grey(`(${elapsed}ms)`);
+      }
+    }
+
+    label = _util.colors.magenta(label);
+
+    if (level === 'error') {
+      // red errors
+      message = _util.colors.red(message);
+    } else if (level === 'warn') {
+      // yellow warnings
+      message = _util.colors.yellow(message);
+    } else if (level === 'info' || level === 'debug') {
+      // blue info and debug URLs
+      message = message.replace(URL_REGEXP, _util.colors.blue('$&'));
+    }
+
+    return `[${label}] ${message}${suffix}`;
+  } // Replaces the current line with a log message
+
+
+  progress(debug, message, persist) {
+    if (!this.shouldLog(debug, 'info')) return;
+    let {
+      stdout
+    } = this.constructor;
+
+    if (stdout.isTTY || !this._progress) {
+      message && (message = this.format(debug, message));
+      if (stdout.isTTY) stdout.cursorTo(0);else message && (message = message + '\n');
+      if (message) stdout.write(message);
+      if (stdout.isTTY) stdout.clearLine(1);
+    }
+
+    this._progress = !!message && {
+      message,
+      persist
+    };
+  } // Returns true or false if the level and debug group can write messages to stdio
+
+
+  shouldLog(debug, level) {
+    return LOG_LEVELS[level] != null && LOG_LEVELS[level] >= LOG_LEVELS[this.level] && !this.namespaces.exclude.some(ns => ns.test(debug)) && this.namespaces.include.some(ns => ns.test(debug));
+  } // Ensures that deprecation messages are not logged more than once
+
+
+  deprecated(debug, message, meta) {
+    if (this.deprecations.has(message)) return;
+    this.deprecations.add(message);
+    this.log(debug, 'warn', `Warning: ${message}`, meta);
+  } // Returns true if a socket is present and ready
+
+
+  get isRemote() {
+    var _this$socket;
+
+    return ((_this$socket = this.socket) === null || _this$socket === void 0 ? void 0 : _this$socket.readyState) === 1;
+  } // Generic log method accepts a debug group, log level, log message, and optional meta
+  // information to store with the message and other info
+
+
+  log(debug, level, message, meta = {}) {
+    // message might be an error object
+    let isError = typeof message !== 'string' && (level === 'error' || level === 'debug');
+    let error = isError && message; // if remote, send logs there
+
+    if (this.isRemote) {
+      // serialize error messages
+      message = isError && 'stack' in error ? {
+        message: error.message,
+        stack: error.stack
+      } : message;
+      return this.socket.send(JSON.stringify({
+        log: [debug, level, message, {
+          remote: true,
+          ...meta
+        }]
+      }));
+    } // ensure the message is a string
+
+
+    message = isError && message.stack || message.message || message.toString(); // timestamp each log
+
+    let timestamp = Date.now();
+    let entry = {
+      debug,
+      level,
+      message,
+      meta,
+      timestamp
+    };
+    this.messages.add(entry); // maybe write the message to stdio
+
+    if (this.shouldLog(debug, level)) {
+      let elapsed = timestamp - (this.lastlog || timestamp);
+      if (isError && this.level !== 'debug') message = error.toString();
+      this.write(level, this.format(debug, error ? 'error' : level, message, elapsed));
+      this.lastlog = timestamp;
+    }
+  } // Writes a message to stdio based on the loglevel
+
+
+  write(level, message) {
+    var _this$_progress;
+
+    let {
+      stdout,
+      stderr
+    } = this.constructor;
+    let progress = stdout.isTTY && this._progress;
+
+    if (progress) {
+      stdout.cursorTo(0);
+      stdout.clearLine();
+    }
+
+    (level === 'info' ? stdout : stderr).write(message + '\n');
+    if (!((_this$_progress = this._progress) !== null && _this$_progress !== void 0 && _this$_progress.persist)) delete this._progress;else if (progress) stdout.write(progress.message);
+  } // Opens a socket logging connection
+
+
+  connect(socket) {
+    // send logging environment info
+    let PERCY_DEBUG = process.env.PERCY_DEBUG;
+    let PERCY_LOGLEVEL = process.env.PERCY_LOGLEVEL || this.loglevel();
+    socket.send(JSON.stringify({
+      env: {
+        PERCY_DEBUG,
+        PERCY_LOGLEVEL
+      }
+    })); // attach remote logging handler
+
+    socket.onmessage = ({
+      data
+    }) => {
+      let {
+        log,
+        logAll
+      } = JSON.parse(data);
+      if (logAll) logAll.forEach(e => this.messages.add(e));
+      if (log) this.log(...log);
+    }; // return a cleanup function
+
+
+    return () => {
+      socket.onmessage = null;
+    };
+  } // Connects to a remote logger
+
+
+  async remote(createSocket, timeout = 1000) {
+    if (this.isRemote) return; // if not already connected, wait until the timeout
+
+    let err = await new Promise(resolve => {
+      let done = event => {
+        if (timeoutid == null) return;
+        timeoutid = clearTimeout(timeoutid);
+        if (this.socket) this.socket.onopen = this.socket.onerror = null;
+        resolve((event === null || event === void 0 ? void 0 : event.error) || (event === null || event === void 0 ? void 0 : event.type) === 'error' && 'Error: Socket connection failed');
+      };
+
+      let timeoutid = setTimeout(done, timeout, {
+        error: 'Error: Socket connection timed out'
+      });
+      Promise.resolve().then(async () => {
+        this.socket = await createSocket();
+        if (this.isRemote) return done();
+        this.socket.onopen = this.socket.onerror = done;
+      }).catch(error => done({
+        error
+      }));
+    }); // there was an error connecting, will fallback to normal logging
+
+    if (err) {
+      this.log('logger', 'debug', 'Unable to connect to remote logger');
+      this.log('logger', 'debug', err);
+      return;
+    } // send any messages already logged in this environment
+
+
+    if (this.messages.size) {
+      this.socket.send(JSON.stringify({
+        logAll: Array.from(this.messages).map(entry => ({ ...entry,
+          meta: {
+            remote: true,
+            ...entry.meta
+          }
+        }))
+      }));
+    } // attach an incoming message handler
+
+
+    this.socket.onmessage = ({
+      data
+    }) => {
+      let {
+        env
+      } = JSON.parse(data); // update local environment info
+
+      if (env) Object.assign(process.env, env);
+    }; // return a cleanup function
+
+
+    return () => {
+      this.socket.onmessage = null;
+      this.socket = null;
+    };
+  }
+
+}
+
+exports.PercyLogger = PercyLogger;
+
+_defineProperty(PercyLogger, "stdout", process.stdout);
+
+_defineProperty(PercyLogger, "stderr", process.stderr);
+
+var _default = PercyLogger;
+exports.default = _default;

package/dist/util.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.colors = exports.ANSI_REG = exports.ANSI_COLORS = void 0;
+const {
+  assign,
+  entries
+} = Object; // matches ansi escape sequences
+
+const ANSI_REG = new RegExp('[\\u001B\\u009B][[\\]()#;?]*((?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)' + '|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))', 'g'); // color names by ansi escape code
+
+exports.ANSI_REG = ANSI_REG;
+const ANSI_COLORS = {
+  '91m': 'red',
+  '32m': 'green',
+  '93m': 'yellow',
+  '34m': 'blue',
+  '95m': 'magenta',
+  '90m': 'grey'
+}; // colorize each line of a string using an ansi escape sequence
+
+exports.ANSI_COLORS = ANSI_COLORS;
+const LINE_REG = /^.*$/gm;
+
+function colorize(code, str) {
+  return str.replace(LINE_REG, line => `\u001b[${code}${line}\u001b[39m`);
+} // map ansi colors to bound colorize functions
+
+
+const colors = entries(ANSI_COLORS).reduce((colors, [code, name]) => {
+  return assign(colors, {
+    [name]: colorize.bind(null, code)
+  });
+}, {});
+exports.colors = colors;

package/package.json

@@ -1,25 +1,35 @@
 {
   "name": "@percy/logger",
-  "version": "1.0.0-beta.7",
+  "version": "1.0.0-beta.73",
   "license": "MIT",
-  "main": "index.js",
-  "scripts": {
-    "lint": "eslint --ignore-path ../../.gitignore .",
-    "test": "cross-env NODE_ENV=test mocha",
-    "test:coverage": "nyc yarn test"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/percy/cli",
+    "directory": "packages/logger"
   },
   "publishConfig": {
     "access": "public"
   },
-  "mocha": {
-    "require": "../../scripts/babel-register"
+  "main": "dist/index.js",
+  "browser": "dist/bundle.js",
+  "files": [
+    "dist",
+    "test/helpers.js",
+    "test/client.js"
+  ],
+  "engines": {
+    "node": ">=12"
   },
-  "dependencies": {
-    "colors": "^1.4.0",
-    "winston": "^3.2.1"
+  "scripts": {
+    "build": "node ../../scripts/build",
+    "lint": "eslint --ignore-path ../../.gitignore .",
+    "test": "node ../../scripts/test",
+    "test:coverage": "yarn test --coverage"
   },
-  "devDependencies": {
-    "strip-ansi": "^6.0.0"
+  "rollup": {
+    "output": {
+      "name": "PercyLogger"
+    }
   },
-  "gitHead": "5be796ec8f17958e93ada0b634899b945c9b0d60"
+  "gitHead": "aa8160e02bea3e04ab1d3605762f89fbe79605d4"
 }

package/test/client.js

@@ -0,0 +1,215 @@
+(function() {
+  this.PercyLogger = this.PercyLogger || {};
+  this.PercyLogger.TestHelpers = (function (require$$0, require$$2) {
+  	'use strict';
+
+  	const process = (typeof globalThis !== "undefined" && globalThis.process) || {};
+  	process.env = process.env || {};
+  	process.env.__PERCY_BROWSERIFIED__ = true;
+
+  	globalThis.process = globalThis.process || process;
+
+  	function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+  	var require$$0__default = /*#__PURE__*/_interopDefaultLegacy(require$$0);
+  	var require$$2__default = /*#__PURE__*/_interopDefaultLegacy(require$$2);
+
+  	function getAugmentedNamespace(n) {
+  		if (n.__esModule) return n;
+  		var a = Object.defineProperty({}, '__esModule', {value: true});
+  		Object.keys(n).forEach(function (k) {
+  			var d = Object.getOwnPropertyDescriptor(n, k);
+  			Object.defineProperty(a, k, d.get ? d : {
+  				enumerable: true,
+  				get: function () {
+  					return n[k];
+  				}
+  			});
+  		});
+  		return a;
+  	}
+
+  	const {
+  	  assign,
+  	  entries
+  	} = Object; // matches ansi escape sequences
+
+  	const ANSI_REG$1 = new RegExp('[\\u001B\\u009B][[\\]()#;?]*((?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)' + '|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))', 'g'); // color names by ansi escape code
+
+  	const ANSI_COLORS = {
+  	  '91m': 'red',
+  	  '32m': 'green',
+  	  '93m': 'yellow',
+  	  '34m': 'blue',
+  	  '95m': 'magenta',
+  	  '90m': 'grey'
+  	}; // colorize each line of a string using an ansi escape sequence
+
+  	const LINE_REG = /^.*$/gm;
+
+  	function colorize(code, str) {
+  	  return str.replace(LINE_REG, line => `\u001b[${code}${line}\u001b[39m`);
+  	} // map ansi colors to bound colorize functions
+
+
+  	const colors = entries(ANSI_COLORS).reduce((colors, _ref) => {
+  	  let [code, name] = _ref;
+  	  return assign(colors, {
+  	    [name]: colorize.bind(null, code)
+  	  });
+  	}, {});
+
+  	var util = /*#__PURE__*/Object.freeze({
+  		__proto__: null,
+  		ANSI_REG: ANSI_REG$1,
+  		ANSI_COLORS: ANSI_COLORS,
+  		colors: colors
+  	});
+
+  	var require$$1 = /*@__PURE__*/getAugmentedNamespace(util);
+
+  	const logger = require$$0__default["default"];
+  	const {
+  	  ANSI_REG
+  	} = require$$1;
+  	const {
+  	  Logger
+  	} = logger;
+  	const ELAPSED_REG = /\s\S*?\(\d+ms\)\S*/;
+  	const NEWLINE_REG = /\r\n/g;
+  	const LASTLINE_REG = /\n$/;
+
+  	function sanitizeLog(str) {
+  	  let {
+  	    ansi,
+  	    elapsed
+  	  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  	  // normalize line endings
+  	  str = str.replace(NEWLINE_REG, '\n'); // strip ansi colors
+
+  	  if (!ansi) str = str.replace(ANSI_REG, ''); // strip elapsed time
+
+  	  if (!elapsed) str = str.replace(ELAPSED_REG, ''); // strip trailing line endings
+
+  	  return str.replace(LASTLINE_REG, '');
+  	}
+
+  	function TestIO(data, options) {
+  	  if (!process.env.__PERCY_BROWSERIFIED__) {
+  	    let {
+  	      Writable
+  	    } = require$$2__default["default"];
+  	    return Object.assign(new Writable(), {
+  	      isTTY: options && options.isTTY,
+
+  	      cursorTo() {},
+
+  	      clearLine() {},
+
+  	      _write(chunk, encoding, callback) {
+  	        data.push(sanitizeLog(chunk.toString(), options));
+  	        callback();
+  	      }
+
+  	    });
+  	  }
+  	}
+
+  	function spy(object, method, func) {
+  	  if (object[method].reset) {
+  	    object[method].reset();
+  	    return object[method];
+  	  }
+
+  	  let spy = Object.assign(function spy() {
+  	    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+  	      args[_key] = arguments[_key];
+  	    }
+
+  	    spy.calls.push(args);
+  	    if (func) return func.apply(this, args);
+  	  }, {
+  	    restore: () => object[method] = spy.originalValue,
+  	    reset: () => spy.calls.length = 0,
+  	    originalValue: object[method],
+  	    calls: []
+  	  });
+  	  object[method] = spy;
+  	  return spy;
+  	}
+
+  	const helpers = {
+  	  constructor: Logger,
+  	  loglevel: logger.loglevel,
+  	  stdout: [],
+  	  stderr: [],
+
+  	  get messages() {
+  	    return Logger.instance && Logger.instance.messages;
+  	  },
+
+  	  mock(options) {
+  	    helpers.reset();
+  	    helpers.options = options;
+
+  	    if (!process.env.__PERCY_BROWSERIFIED__) {
+  	      Logger.stdout = TestIO(helpers.stdout, options);
+  	      Logger.stderr = TestIO(helpers.stderr, options);
+  	    } else {
+  	      spy(Logger.prototype, 'write', function (lvl, msg) {
+  	        let stdio = lvl === 'info' ? 'stdout' : 'stderr';
+  	        helpers[stdio].push(sanitizeLog(msg, helpers.options));
+  	        return this.write.originalValue.call(this, lvl, msg);
+  	      });
+  	      spy(console, 'log');
+  	      spy(console, 'warn');
+  	      spy(console, 'error');
+  	    }
+  	  },
+
+  	  reset(soft) {
+  	    if (soft) Logger.instance.loglevel('info');else delete Logger.instance;
+  	    helpers.stdout.length = 0;
+  	    helpers.stderr.length = 0;
+
+  	    if (console.log.reset) {
+  	      console.log.reset();
+  	      console.warn.reset();
+  	      console.error.reset();
+  	    }
+  	  },
+
+  	  dump() {
+  	    if (!helpers.messages || !helpers.messages.size) return;
+  	    if (console.log.and) console.log.and.callThrough();
+
+  	    let write = m => process.env.__PERCY_BROWSERIFIED__ ? console.log(m) : process.stderr.write(`${m}\n`);
+
+  	    let logs = Array.from(helpers.messages);
+  	    logger.loglevel('debug');
+  	    write(logger.format('testing', 'warn', '--- DUMPING LOGS ---'));
+  	    logs.reduce((lastlog, _ref) => {
+  	      let {
+  	        debug,
+  	        level,
+  	        message,
+  	        timestamp
+  	      } = _ref;
+  	      write(logger.format(debug, level, message, timestamp - lastlog));
+  	      return timestamp;
+  	    }, logs[0].timestamp);
+  	  }
+
+  	};
+  	var helpers_1 = helpers;
+
+  	return helpers_1;
+
+  })(PercyLogger, null);
+}).call(window);
+
+if (typeof define === "function" && define.amd) {
+  define([], () => window.PercyLogger.TestHelpers);
+} else if (typeof module === "object" && module.exports) {
+  module.exports = window.PercyLogger.TestHelpers;
+}