embarklabs
/
embark
mirror of https://github.com/embarklabs/embark.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

refactor(@embark/core): refactor logger to use modern JS APIs 

This also removes `parseLogFile()` as it's not used anywhere inside Embark.
This commit is contained in:
Pascal Precht 2020-01-15 14:40:34 +01:00 committed by Michael Bradley
parent 6b4052ee7b
commit 8c9e6b11c8
3 changed files with 91 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/core/logger/package.json
View File

@ -36,7 +36,7 @@
"ci": "npm run qa", "ci": "npm run qa",
"clean": "npm run reset", "clean": "npm run reset",
"lint": "eslint src/", "lint": "eslint src/",
"qa": "npm-run-all lint _typecheck _build", "qa": "npm-run-all lint _typecheck _build test",
"reset": "npx rimraf dist embark-*.tgz package", "reset": "npx rimraf dist embark-*.tgz package",
"solo": "embark-solo", "solo": "embark-solo",
"test": "jest" "test": "jest"

218
packages/core/logger/src/index.js
View File

@ -5,7 +5,6 @@ const { escapeHtml } = require('./utils');
const util = require('util'); const util = require('util');
const DATE_FORMAT = 'YYYY-MM-DD HH:mm:ss:SSS'; const DATE_FORMAT = 'YYYY-MM-DD HH:mm:ss:SSS';
const LOG_REGEX = new RegExp(/\[(\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d:\d\d\d)\] (?:\[(\w*)\]:?)?\s?\s?(.*)/gmi);
export const LogLevels = { export const LogLevels = {
error: 'error', error: 'error',
@ -18,11 +17,9 @@ export const LogLevels = {
export class Logger { export class Logger {
constructor(options) { constructor(options) {
this.events = options.events || {emit: function(){}}; this.events = options.events || {emit: function(){}};
this.logLevels = Object.keys(LogLevels);
this.logLevel = options.logLevel || 'info'; this.logLevel = options.logLevel || 'info';
this._logFunction = options.logFunction || console.log; this._logFunction = options.logFunction || console.log;
this.logFunction = function() { this.logFunction = function(...args) {
const args = Array.from(arguments);
const color = args[args.length - 1]; const color = args[args.length - 1];
args.splice(args.length - 1, 1); args.splice(args.length - 1, 1);
this._logFunction(...args.filter(arg => arg !== undefined && arg !== null).map(arg => { this._logFunction(...args.filter(arg => arg !== undefined && arg !== null).map(arg => {
@ -35,134 +32,97 @@ export class Logger {
this.logFile = options.logFile; this.logFile = options.logFile;
} }
/**
* Parses the logFile, returning an array of JSON objects containing the
* log messages.
* @param {Number} limit specifies how many log messages to return from the
* end of the log file
* @returns {Array} array containing
* - msg: the log message
* - logLevel: log level (ie 'info', 'debug')
* - name: process name (always "embark")
* - timestamp: timestamp of log message (milliseconds since 1/1/1970)
*/
parseLogFile(limit) {
let matches;
let logs = [];
const logFile = fs.readFileSync(this.logFile, 'utf8');
while ((matches = LOG_REGEX.exec(logFile)) !== null) {
// This is necessary to avoid infinite loops with zero-width matches
if (matches.index === LOG_REGEX.lastIndex) {
LOG_REGEX.lastIndex++;
}
if (matches && matches.length) { registerAPICall(plugins) {
logs.push({ let plugin = plugins.createPlugin('dashboard', {});
msg: [matches[3]], plugin.registerAPICall(
logLevel: matches[2], 'ws',
name: 'embark', '/embark-api/logs',
timestamp: date.parse(matches[1], DATE_FORMAT).getTime() (ws, _req) => {
}); this.events.on("log", (logLevel, logMsg) => {
} logMsg = escapeHtml(logMsg);
ws.send(JSON.stringify({msg: logMsg, msg_clear: logMsg.stripColors, logLevel: logLevel}), () => {});
});
}
);
}
writeToFile(...args) {
if (!this.logFile) {
return;
} }
// if 'limit' is specified, get log lines from the end of the log file let origin = "[" + ((new Error().stack).split("at ")[3]).trim() + "]";
if(limit && limit > 0 && logs.length > limit){
logs.slice(limit * -1); const formattedDate = [`[${date.format(new Date(), DATE_FORMAT)}]`]; // adds a timestamp to the logs in the logFile
fs.appendFileSync(this.logFile, "\n" + formattedDate.concat(origin, args).join(' '));
}
error(...args) {
if (!args.length || !(this.shouldLog('error'))) {
return;
} }
return logs; this.events.emit("log", "error", args);
this.logFunction(...Array.from(args), 'red');
this.writeToFile("[error]: ", args);
}
warn(...args) {
if (!args.length || !(this.shouldLog('warn'))) {
return;
}
this.events.emit("log", "warn", args);
this.logFunction(...Array.from(args), 'yellow');
this.writeToFile("[warning]: ", args);
}
info(...args) {
if (!args.length || !(this.shouldLog('info'))) {
return;
}
this.events.emit("log", "info", args);
this.logFunction(...Array.from(args), 'green');
this.writeToFile("[info]: ", args);
}
consoleOnly(...args) {
if (!args.length || !(this.shouldLog('info'))) {
return;
}
this.logFunction(...Array.from(args), 'green');
this.writeToFile("[consoleOnly]: ", args);
}
debug(...args) {
if (!args.length || !(this.shouldLog('debug'))) {
return;
}
this.events.emit("log", "debug", args);
this.logFunction(args, null);
this.writeToFile("[debug]: ", args);
}
trace(...args) {
if (!args.length || !(this.shouldLog('trace'))) {
return;
}
this.events.emit("log", "trace", args);
this.logFunction(args, null);
this.writeToFile("[trace]: ", args);
}
dir(...args) {
const txt = args[0];
if (!txt || !(this.shouldLog('info'))) {
return;
}
this.events.emit("log", "dir", txt);
this.logFunction(txt, null);
this.writeToFile("[dir]: ", args);
}
shouldLog(level) {
const logLevels = Object.keys(LogLevels);
return (logLevels.indexOf(level) <= logLevels.indexOf(this.logLevel));
} }
} }
Logger.prototype.registerAPICall = function (plugins) {
const self = this;
let plugin = plugins.createPlugin('dashboard', {});
plugin.registerAPICall(
'ws',
'/embark-api/logs',
(ws, _req) => {
self.events.on("log", function (logLevel, logMsg) {
logMsg = escapeHtml(logMsg);
ws.send(JSON.stringify({msg: logMsg, msg_clear: logMsg.stripColors, logLevel: logLevel}), () => {});
});
}
);
};
Logger.prototype.writeToFile = function (_txt) {
if (!this.logFile) {
return;
}
let origin = "[" + ((new Error().stack).split("at ")[3]).trim() + "]";
const formattedDate = [`[${date.format(new Date(), DATE_FORMAT)}]`]; // adds a timestamp to the logs in the logFile
fs.appendFileSync(this.logFile, "\n" + formattedDate.concat(origin, Array.from(arguments)).join(' '));
};
Logger.prototype.error = function () {
if (!arguments.length || !(this.shouldLog('error'))) {
return;
}
this.events.emit("log", "error", ...arguments);
this.logFunction(...Array.from(arguments), 'red');
this.writeToFile("[error]: ", ...arguments);
};
Logger.prototype.warn = function () {
if (!arguments.length || !(this.shouldLog('warn'))) {
return;
}
this.events.emit("log", "warn", ...arguments);
this.logFunction(...Array.from(arguments), 'yellow');
this.writeToFile("[warning]: ", ...arguments);
};
Logger.prototype.info = function () {
if (!arguments.length || !(this.shouldLog('info'))) {
return;
}
this.events.emit("log", "info", ...arguments);
this.logFunction(...Array.from(arguments), 'green');
this.writeToFile("[info]: ", ...arguments);
};
Logger.prototype.consoleOnly = function () {
if (!arguments.length || !(this.shouldLog('info'))) {
return;
}
this.logFunction(...Array.from(arguments), 'green');
this.writeToFile("[consoleOnly]: ", ...arguments);
};
Logger.prototype.debug = function () {
if (!arguments.length || !(this.shouldLog('debug'))) {
return;
}
this.events.emit("log", "debug", ...arguments);
this.logFunction(...arguments, null);
this.writeToFile("[debug]: ", ...arguments);
};
Logger.prototype.trace = function () {
if (!arguments.length || !(this.shouldLog('trace'))) {
return;
}
this.events.emit("log", "trace", ...arguments);
this.logFunction(...arguments, null);
this.writeToFile("[trace]: ", ...arguments);
};
Logger.prototype.dir = function (txt) {
if (!txt || !(this.shouldLog('info'))) {
return;
}
this.events.emit("log", "dir", txt);
this.logFunction(txt, null);
this.writeToFile("[dir]: ", ...arguments);
};
Logger.prototype.shouldLog = function (level) {
return (this.logLevels.indexOf(level) <= this.logLevels.indexOf(this.logLevel));
};

2
packages/core/logger/test/logger.spec.js
View File

@ -27,7 +27,7 @@ describe('core/logger', () => {
sinon.restore(); sinon.restore();
}); });
test('it should should use custom log function for logging', () => { test('it should use custom log function for logging', () => {
logger.info('Hello world'); logger.info('Hello world');
assert(testLogFn.calledOnce); assert(testLogFn.calledOnce);
}); });