logger.js 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. const fs = require("fs");
  4. const path = require("path");
  5. // Will use chalk if chalk is available to add color to console logging
  6. let chalk;
  7. let printRed;
  8. let printYellow;
  9. let printGray;
  10. try {
  11. chalk = require('chalk');
  12. printRed = chalk.red;
  13. printYellow = chalk.yellow;
  14. printGray = chalk.gray;
  15. }
  16. catch (e) {
  17. printRed = printYellow = printGray = (msg) => {
  18. return msg;
  19. };
  20. }
  21. var LogLevel;
  22. (function (LogLevel) {
  23. LogLevel[LogLevel["ERROR"] = 0] = "ERROR";
  24. LogLevel[LogLevel["WARN"] = 1] = "WARN";
  25. LogLevel[LogLevel["INFO"] = 2] = "INFO";
  26. LogLevel[LogLevel["DEBUG"] = 3] = "DEBUG";
  27. })(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
  28. var WriteTo;
  29. (function (WriteTo) {
  30. WriteTo[WriteTo["CONSOLE"] = 0] = "CONSOLE";
  31. WriteTo[WriteTo["FILE"] = 1] = "FILE";
  32. WriteTo[WriteTo["BOTH"] = 2] = "BOTH";
  33. WriteTo[WriteTo["NONE"] = 3] = "NONE";
  34. })(WriteTo = exports.WriteTo || (exports.WriteTo = {}));
  35. let logFile = 'webdriver.log'; // the default log file name
  36. /**
  37. * Logger class adds timestamp output, log levels, and identifiers to help
  38. * when debugging. Also could write to console, file, both, or none.
  39. */
  40. class Logger {
  41. /**
  42. * Creates a logger instance with an ID for the logger.
  43. * @constructor
  44. */
  45. constructor(id) {
  46. this.id = id;
  47. }
  48. /**
  49. * Set up the write location. If writing to a file, get the file descriptor.
  50. * @param writeTo The enum for where to write the logs.
  51. * @param opt_logFile An optional parameter to override the log file location.
  52. */
  53. static setWrite(writeTo, opt_logFile) {
  54. if (opt_logFile) {
  55. logFile = opt_logFile;
  56. }
  57. Logger.writeTo = writeTo;
  58. if (Logger.writeTo == WriteTo.FILE || Logger.writeTo == WriteTo.BOTH) {
  59. Logger.fd = fs.openSync(path.resolve(logFile), 'a');
  60. Logger.firstWrite = false;
  61. }
  62. }
  63. /**
  64. * Log INFO
  65. * @param ...msgs multiple arguments to be logged.
  66. */
  67. info(...msgs) {
  68. this.log_(LogLevel.INFO, msgs);
  69. }
  70. /**
  71. * Log DEBUG
  72. * @param ...msgs multiple arguments to be logged.
  73. */
  74. debug(...msgs) {
  75. this.log_(LogLevel.DEBUG, msgs);
  76. }
  77. /**
  78. * Log WARN
  79. * @param ...msgs multiple arguments to be logged.
  80. */
  81. warn(...msgs) {
  82. this.log_(LogLevel.WARN, msgs);
  83. }
  84. /**
  85. * Log ERROR
  86. * @param ...msgs multiple arguments to be logged.
  87. */
  88. error(...msgs) {
  89. this.log_(LogLevel.ERROR, msgs);
  90. }
  91. /**
  92. * For the log level set, check to see if the messages should be logged.
  93. * @param logLevel The log level of the message.
  94. * @param msgs The messages to be logged
  95. */
  96. log_(logLevel, msgs) {
  97. switch (Logger.logLevel) {
  98. case LogLevel.ERROR:
  99. if (logLevel <= LogLevel.ERROR) {
  100. this.print_(logLevel, msgs);
  101. }
  102. break;
  103. case LogLevel.WARN:
  104. if (logLevel <= LogLevel.WARN) {
  105. this.print_(logLevel, msgs);
  106. }
  107. break;
  108. case LogLevel.INFO:
  109. if (logLevel <= LogLevel.INFO) {
  110. this.print_(logLevel, msgs);
  111. }
  112. break;
  113. case LogLevel.DEBUG:
  114. if (logLevel <= LogLevel.DEBUG) {
  115. this.print_(logLevel, msgs);
  116. }
  117. break;
  118. default:
  119. throw new Error('Log level undefined');
  120. }
  121. }
  122. /**
  123. * Format with timestamp, log level, identifier, and message and log to
  124. * specified medium (console, file, both, none).
  125. * @param logLevel The log level of the message.
  126. * @param msgs The messages to be logged.
  127. */
  128. print_(logLevel, msgs) {
  129. let consoleLog = '';
  130. let fileLog = '';
  131. if (Logger.showTimestamp) {
  132. consoleLog += Logger.timestamp_(WriteTo.CONSOLE);
  133. fileLog += Logger.timestamp_(WriteTo.FILE);
  134. }
  135. consoleLog += Logger.level_(logLevel, this.id, WriteTo.CONSOLE);
  136. fileLog += Logger.level_(logLevel, this.id, WriteTo.FILE);
  137. if (Logger.showId) {
  138. consoleLog += Logger.id_(logLevel, this.id, WriteTo.CONSOLE);
  139. fileLog += Logger.id_(logLevel, this.id, WriteTo.FILE);
  140. }
  141. consoleLog += ' -';
  142. fileLog += ' - ';
  143. switch (Logger.writeTo) {
  144. case WriteTo.CONSOLE:
  145. msgs.unshift(consoleLog);
  146. console.log.apply(console, msgs);
  147. break;
  148. case WriteTo.FILE:
  149. // for the first line written to the file, add a space
  150. if (!Logger.firstWrite) {
  151. fs.writeSync(Logger.fd, '\n');
  152. Logger.firstWrite = true;
  153. }
  154. fileLog += ' ' + Logger.msgToFile_(msgs);
  155. fs.writeSync(Logger.fd, fileLog + '\n');
  156. break;
  157. case WriteTo.BOTH:
  158. // for the first line written to the file, add a space
  159. if (!Logger.firstWrite) {
  160. fs.writeSync(Logger.fd, '\n');
  161. Logger.firstWrite = true;
  162. }
  163. fileLog += ' ' + Logger.msgToFile_(msgs);
  164. fs.writeSync(Logger.fd, fileLog + '\n');
  165. msgs.unshift(consoleLog);
  166. console.log.apply(console, msgs);
  167. break;
  168. case WriteTo.NONE:
  169. break;
  170. }
  171. }
  172. /**
  173. * Get a timestamp formatted with [hh:mm:ss]
  174. * @param writeTo The enum for where to write the logs.
  175. * @return The string of the formatted timestamp
  176. */
  177. static timestamp_(writeTo) {
  178. let d = new Date();
  179. let ts = '[';
  180. let hours = d.getHours() < 10 ? '0' + d.getHours() : d.getHours();
  181. let minutes = d.getMinutes() < 10 ? '0' + d.getMinutes() : d.getMinutes();
  182. let seconds = d.getSeconds() < 10 ? '0' + d.getSeconds() : d.getSeconds();
  183. if (writeTo == WriteTo.CONSOLE) {
  184. ts += printGray(hours + ':' + minutes + ':' + seconds) + ']';
  185. }
  186. else {
  187. ts += hours + ':' + minutes + ':' + seconds + ']';
  188. }
  189. ts += ' ';
  190. return ts;
  191. }
  192. /**
  193. * Get the identifier of the logger as '/<id>'
  194. * @param logLevel The log level of the message.
  195. * @param writeTo The enum for where to write the logs.
  196. * @return The string of the formatted id
  197. */
  198. static id_(logLevel, id, writeTo) {
  199. let level = LogLevel[logLevel].toString();
  200. if (writeTo === WriteTo.FILE) {
  201. return '/' + id;
  202. }
  203. else if (logLevel === LogLevel.ERROR) {
  204. return printRed('/' + id);
  205. }
  206. else if (logLevel === LogLevel.WARN) {
  207. return printYellow('/' + id);
  208. }
  209. else {
  210. return '/' + id;
  211. }
  212. }
  213. /**
  214. * Get the log level formatted with the first letter. For info, it is I.
  215. * @param logLevel The log level of the message.
  216. * @param writeTo The enum for where to write the logs.
  217. * @return The string of the formatted log level
  218. */
  219. static level_(logLevel, id, writeTo) {
  220. let level = LogLevel[logLevel].toString();
  221. if (writeTo === WriteTo.FILE) {
  222. return level[0];
  223. }
  224. else if (logLevel === LogLevel.ERROR) {
  225. return printRed(level[0]);
  226. }
  227. else if (logLevel === LogLevel.WARN) {
  228. return printYellow(level[0]);
  229. }
  230. else {
  231. return level[0];
  232. }
  233. }
  234. /**
  235. * Convert the list of messages to a single string message.
  236. * @param msgs The list of messages.
  237. * @return The string of the formatted messages
  238. */
  239. static msgToFile_(msgs) {
  240. let log = '';
  241. for (let pos = 0; pos < msgs.length; pos++) {
  242. let msg = msgs[pos];
  243. let ret;
  244. if (typeof msg === 'object') {
  245. ret = JSON.stringify(msg);
  246. }
  247. else {
  248. ret = msg;
  249. }
  250. if (pos !== msgs.length - 1) {
  251. ret += ' ';
  252. }
  253. log += ret;
  254. }
  255. return log;
  256. }
  257. }
  258. Logger.logLevel = LogLevel.INFO;
  259. Logger.showTimestamp = true;
  260. Logger.showId = true;
  261. Logger.writeTo = WriteTo.CONSOLE;
  262. Logger.firstWrite = false;
  263. exports.Logger = Logger;
  264. //# sourceMappingURL=logger.js.map