|
| 1 | +import debug, { Debugger } from 'debug'; |
| 2 | + |
| 3 | +enum LogLevel { |
| 4 | + debug = 1, |
| 5 | + info = 2, |
| 6 | + warn = 3, |
| 7 | + error = 4, |
| 8 | + none = 5, |
| 9 | +} |
| 10 | + |
| 11 | +const prefixes = { |
| 12 | + [LogLevel.debug]: 'DEBUG', |
| 13 | + [LogLevel.info]: 'INFO', |
| 14 | + [LogLevel.warn]: 'WARN', |
| 15 | + [LogLevel.error]: 'ERROR', |
| 16 | + [LogLevel.none]: '', |
| 17 | +}; |
| 18 | + |
| 19 | +/** |
| 20 | + * A logger class with support to skip |
| 21 | + */ |
| 22 | +class Logger { |
| 23 | + private _levelToOutput: LogLevel; |
| 24 | + private _logger: Debugger; |
| 25 | + |
| 26 | + constructor(levelToOutput: LogLevel, namespace: string) { |
| 27 | + this._levelToOutput = levelToOutput; |
| 28 | + this._logger = debug(namespace); |
| 29 | + } |
| 30 | + |
| 31 | + /** |
| 32 | + * creates a new Logger instance by inspecting the executing environment |
| 33 | + */ |
| 34 | + static fromEnv(namespace: string): Logger { |
| 35 | + // by default, log everything in development and nothing in production |
| 36 | + let level = process.env.NODE_ENV !== 'production' ? LogLevel.debug : LogLevel.none; |
| 37 | + |
| 38 | + if (localStorage.getItem('debug')) { |
| 39 | + // if a 'debug' key is found in localStorage, use the level in storage or 'debug' by default |
| 40 | + const storageLevel = localStorage.getItem('debug-level') || 'debug'; |
| 41 | + level = LogLevel[storageLevel as keyof typeof LogLevel]; |
| 42 | + } else if (process.env.NODE_ENV !== 'production') { |
| 43 | + // if running in development with no localStorage key |
| 44 | + level = LogLevel.debug; |
| 45 | + // set the keys so they can be easily changed by the dev |
| 46 | + localStorage.setItem('debug', '*'); |
| 47 | + localStorage.setItem('debug-level', 'debug'); |
| 48 | + } |
| 49 | + |
| 50 | + return new Logger(level, namespace); |
| 51 | + } |
| 52 | + |
| 53 | + /** |
| 54 | + * log a debug message |
| 55 | + */ |
| 56 | + debug = (message: string, ...args: any[]) => this._log(LogLevel.debug, message, args); |
| 57 | + |
| 58 | + /** |
| 59 | + * log a info message |
| 60 | + */ |
| 61 | + info = (message: string, ...args: any[]) => this._log(LogLevel.info, message, args); |
| 62 | + |
| 63 | + /** |
| 64 | + * log a warn message |
| 65 | + */ |
| 66 | + warn = (message: string, ...args: any[]) => this._log(LogLevel.warn, message, args); |
| 67 | + |
| 68 | + /** |
| 69 | + * log a error message |
| 70 | + */ |
| 71 | + error = (message: string, ...args: any[]) => this._log(LogLevel.error, message, args); |
| 72 | + |
| 73 | + /** |
| 74 | + * A shared logging function which will only out logs based on the level of this Logger instance |
| 75 | + * @param level the level of the message being logged |
| 76 | + * @param message the message to log |
| 77 | + * @param args optional additional arguments to log |
| 78 | + */ |
| 79 | + private _log(level: LogLevel, message: string, args: any[]) { |
| 80 | + // console.warn('this._levelToOutput', this._levelToOutput); |
| 81 | + // console.warn('level', level); |
| 82 | + // don't log if the level to output is greater than the level of this message |
| 83 | + if (this._levelToOutput > level) return; |
| 84 | + |
| 85 | + const prefix = prefixes[level]; |
| 86 | + this._logger(`[${prefix}] ${message}`, ...args); |
| 87 | + // console.log(`[${prefix}] ${message}`, args); |
| 88 | + } |
| 89 | +} |
| 90 | + |
| 91 | +/** |
| 92 | + * the main logger for the app |
| 93 | + */ |
| 94 | +export const log = Logger.fromEnv('main'); |
| 95 | + |
| 96 | +/** |
| 97 | + * the logger for GRPC requests and responses |
| 98 | + */ |
| 99 | +export const grpcLog = Logger.fromEnv('grpc'); |
| 100 | + |
| 101 | +/** |
| 102 | + * the logger for state updates via mobx actions |
| 103 | + */ |
| 104 | +export const actionLog = Logger.fromEnv('action'); |
0 commit comments