/* * Copyright (C) 2018 StApps * This program is free software: you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the Free * Software Foundation, version 3. * * This program is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License along with * this program. If not, see . */ import {stringify} from 'flatted'; import {Transport, TransportWithVerification} from './Transport'; /** * Logger with colors, loglevel and transport * * Log level can be defined by setting the environment variable STAPPS_LOG_LEVEL to a valid log level. Log levels are * set in a binary way. For example STAPPS_LOG_LEVEL=12 does result in logs only for `Logger.warn` and `Logger.error`. * * Log levels in that order are: * ``` * 1 - INFO * 2 - LOG * 4 - WARN * 8 - ERROR * 16 - OK * ``` */ export class Logger { /* * Reset = "\x1b[0m" * Bright = "\x1b[1m" * Dim = "\x1b[2m" * Underscore = "\x1b[4m" * Blink = "\x1b[5m" * Reverse = "\x1b[7m" * Hidden = "\x1b[8m" * * FgBlack = "\x1b[30m" * FgRed = "\x1b[31m" * FgGreen = "\x1b[32m" * FgYellow = "\x1b[33m" * FgBlue = "\x1b[34m" * FgMagenta = "\x1b[35m" * FgCyan = "\x1b[36m" * FgWhite = "\x1b[37m" * * BgBlack = "\x1b[40m" * BgRed = "\x1b[41m" * BgGreen = "\x1b[42m" * BgYellow = "\x1b[43m" * BgBlue = "\x1b[44m" * BgMagenta = "\x1b[45m" * BgCyan = "\x1b[46m" * BgWhite = "\x1b[47m" */ /** * Prefix for cyan color */ private cyan = '\x1b[36m'; /** * Prefix for green color */ private green = '\x1b[32m'; /** * Set to true if this code is executed by Node.js */ private isNode: boolean; /** * Set to true if the environment for a productive environment is given * * In Node.js this means that `NODE_ENV` is set to `production` */ private isProductiveEnvironment: boolean; /** * Log levels */ private logLevels: { [logLevel: string]: 1 | 2 | 4 | 8 | 16 } = { 'INFO': 1, 'LOG': 2, 'WARN': 4, // tslint:disable-next-line:object-literal-sort-keys 'ERROR': 8, 'OK': 16, }; /** * Prefix for red color */ private red = '\x1b[31m'; /** * Suffix to end a color */ private reset = '\x1b[0m'; /** * Transport for errors * * For example `@stapps/smtp-transport` */ private transport?: Transport; /** * Prefix for white color */ private white = '\x1b[37m'; /** * Prefix for yellow color */ private yellow = '\x1b[33m'; /** * Checks if this code is executed in Node.js */ public static isNodeEnvironment(): boolean { // Only Node.js has a process variable that is of [[Class]] process return Object.prototype.toString.call(typeof process !== 'undefined' ? process : 0) === '[object process]'; } /** * Checks if a productive environment is given */ public static isProductiveEnvironment(): boolean { return Logger.isNodeEnvironment && (typeof process.env.NODE_ENV === 'string' && process.env.NODE_ENV === 'production'); } /** * Instatiate an instance of logger * @param transport A transport instance that can be used for error transport */ constructor(transport?: Transport) { // node environment -> maybe we run a service which needs monitoring if (Logger.isNodeEnvironment()) { this.isNode = true; // check if we are in productive environment -> then we need to run a transport if (Logger.isProductiveEnvironment()) { this.isProductiveEnvironment = true; if (typeof transport === 'undefined') { if (process.env.ALLOW_NO_TRANSPORT !== 'true') { throw new Error('Productive environment doesn\'t set an transport agent for error notifications'); } else { this.warn('Productive environment doesn\'t set an transport agent for error notifications'); } } else { this.transport = transport; // we expect an transport for error notifications if (this.isTransportWithVerification(transport) && !transport.isVerified()) { transport.verify().then((success) => { if (typeof success === 'string') { this.ok(success); } else { this.ok('Successfully verified transport for error notification'); } }).catch((err) => { throw err; }); } } } else { this.isProductiveEnvironment = false; } } else { this.isProductiveEnvironment = false; this.isNode = false; } } /** * Check if intended log level is allowed in environment log level * * @param logLevel * @returns {boolean} */ private checkLogLevel(logLevel: 1 | 2 | 4 | 8 | 16) { const requiredLogLevel = this.getLogLevel(); if (requiredLogLevel > 31 || requiredLogLevel < 0) { throw new Error('Log level is out of range.'); } // tslint:disable-next-line:no-bitwise return requiredLogLevel & logLevel; } /** * Return log level from environment * @returns {number} */ private getLogLevel(): number { if (this.isNode && typeof process.env.STAPPS_LOG_LEVEL === 'string') { // Node.js environment exists return parseInt(process.env.STAPPS_LOG_LEVEL, 10); } else if (typeof window !== 'undefined' && typeof (window as any).STAPPS_LOG_LEVEL === 'number') { // browser environment exists return (window as any).STAPPS_LOG_LEVEL; } // Log everything return 31; } private isTransportWithVerification(transport: Transport): transport is TransportWithVerification { return typeof (transport as any).verify === 'function'; } /** * Stringify a list of arguments * * @param args {any[]} Arguments to stringify * @returns {string} Stringified arguments */ private stringifyArguments(..._args: any[]): string { const result: string[] = []; /* tslint:disable:prefer-for-of */ for (let idx = 0; idx < arguments.length; idx++) { /* tslint:enable */ const argument = arguments[idx]; const type = typeof argument; if (['string', 'number'].indexOf(type) !== -1) { result.push(argument); } else if (argument instanceof Error) { result.push(argument.message); if (typeof argument.stack !== 'undefined') { result.push(argument.stack); } } else { result.push(stringify(argument, null, 2)); } } return result.join(', '); } /** * Log with level ERROR * * @param args {any} Arguments to log */ public error(...args: any[]): void { if (this.checkLogLevel(this.logLevels.ERROR)) { if (this.isNode) { /* tslint:disable-next-line:no-console */ console.error(this.red + '[ERROR] ' + this.stringifyArguments(...args) + this.reset); if (this.isProductiveEnvironment) { if (typeof this.transport === 'undefined') { if (process.env.ALLOW_NO_TRANSPORT !== 'true') { throw new Error('Error couldn\'t be tranported. Please set an transport or set ALLOW_NO_TRANSPORT=true'); } } else { this.transport.send('Error', this.stringifyArguments(...args)).catch((err) => { throw err; }); } } } else { /* tslint:disable-next-line:no-console */ console.log('[ERROR] ' + this.stringifyArguments(...args)); } } } /** * Log with level INFO * * @param args {any} Arguments to log */ public info(...args: any[]): void { if (this.checkLogLevel(this.logLevels.INFO)) { if (this.isNode) { /* tslint:disable-next-line:no-console */ console.info(this.cyan + '[INFO] ' + this.stringifyArguments(...args) + this.reset); } else { /* tslint:disable-next-line:no-console */ console.info('[INFO] ' + this.stringifyArguments(...args)); } } } /** * Log with level LOG * * @param args {any} Arguments to log */ public log(...args: any[]): void { if (this.checkLogLevel(this.logLevels.LOG)) { if (this.isNode) { /* tslint:disable-next-line:no-console */ console.log(this.white + '[LOG] ' + this.stringifyArguments(...args) + this.reset); } else { /* tslint:disable-next-line:no-console */ console.log('[LOG] ' + this.stringifyArguments(...args)); } } } /** * Log with level OK * * @param args {any} Arguments to log */ public ok(...args: any[]): void { if (this.checkLogLevel(this.logLevels.OK)) { if (this.isNode) { /* tslint:disable-next-line:no-console */ console.log(this.green + '[OK] ' + this.stringifyArguments(...args) + this.reset); } else { /* tslint:disable-next-line:no-console */ console.log('[OK] ' + this.stringifyArguments(...args)); } } } /** * Log with level WARN * * @param args {any} Arguments to log */ public warn(...args: any[]): void { if (this.checkLogLevel(this.logLevels.WARN)) { if (this.isNode) { /* tslint:disable-next-line:no-console */ console.warn(this.yellow + '[WARN] ' + this.stringifyArguments(...args) + this.reset); } else { /* tslint:disable-next-line:no-console */ console.warn('[WARN] ' + this.stringifyArguments(...args)); } } } }