|
| 1 | +/** |
| 2 | + * The SDK has 4 log levels and a 5th option for disabling all logging. By |
| 3 | + * default, the log level is set to INFO. |
| 4 | + * |
| 5 | + * The order is a follows: DEBUG < INFO < WARN < ERROR |
| 6 | + * |
| 7 | + * All log types above the current log level will be outputted. |
| 8 | + */ |
| 9 | +export enum LogLevel { |
| 10 | + DEBUG, |
| 11 | + INFO, |
| 12 | + WARN, |
| 13 | + ERROR, |
| 14 | + SILENT |
| 15 | +} |
| 16 | + |
| 17 | +export type LogLevelString = 'debug' | 'info' | 'warn' | 'error' | 'silent'; |
| 18 | + |
| 19 | +const logLevelStringToEnum: { [key in LogLevelString]: LogLevel } = { |
| 20 | + debug: LogLevel.DEBUG, |
| 21 | + info: LogLevel.INFO, |
| 22 | + warn: LogLevel.WARN, |
| 23 | + error: LogLevel.ERROR, |
| 24 | + silent: LogLevel.SILENT |
| 25 | +}; |
| 26 | + |
| 27 | +// HACKY: Use the console method as a string rather than the function itself |
| 28 | +// in order to allow for mocking in tests. |
| 29 | +const logLevelToConsoleFn = { |
| 30 | + [LogLevel.DEBUG]: 'log', |
| 31 | + [LogLevel.INFO]: 'info', |
| 32 | + [LogLevel.WARN]: 'warn', |
| 33 | + [LogLevel.ERROR]: 'error' |
| 34 | +}; |
| 35 | + |
| 36 | +const DEFAULT_LOG_LEVEL = LogLevel.INFO; |
| 37 | + |
| 38 | +/** |
| 39 | + * Configures the verbosity of logging. The default log level is `info`. |
| 40 | + * |
| 41 | + * @param logLevel The verbosity of logging. Can be any of the following values: |
| 42 | + * |
| 43 | + * - `debug`: The most verbose logging level. |
| 44 | + * - `info`: The default logging level. |
| 45 | + * - `warn`: A logging level for non-critical issues. |
| 46 | + * - `error`: A logging level for critical issues. |
| 47 | + * - `silent`: Turn off all logging. |
| 48 | + * |
| 49 | + * @public |
| 50 | + */ |
| 51 | +export function setLogLevel(logLevel: LogLevelString): void { |
| 52 | + loggerClient.logLevel = logLevelStringToEnum[logLevel]; |
| 53 | +} |
| 54 | + |
| 55 | +export function logDebug(message: string, ...args: unknown[]): void { |
| 56 | + loggerClient.debug(message, args); |
| 57 | +} |
| 58 | + |
| 59 | +export function logInfo(message: string, ...args: unknown[]): void { |
| 60 | + loggerClient.info(message, args); |
| 61 | +} |
| 62 | + |
| 63 | +export function logWarn(message: string, ...args: unknown[]): void { |
| 64 | + loggerClient.warn(message, args); |
| 65 | +} |
| 66 | + |
| 67 | +export function logError(message: string, ...args: unknown[]): void { |
| 68 | + loggerClient.error(message, args); |
| 69 | +} |
| 70 | + |
| 71 | +export class Logger { |
| 72 | + /** The log level of the given Logger instance. */ |
| 73 | + private _logLevel = DEFAULT_LOG_LEVEL; |
| 74 | + |
| 75 | + constructor() {} |
| 76 | + |
| 77 | + get logLevel(): LogLevel { |
| 78 | + return this._logLevel; |
| 79 | + } |
| 80 | + |
| 81 | + set logLevel(val: LogLevel) { |
| 82 | + if (!(val in LogLevel)) { |
| 83 | + throw new TypeError(`Invalid value "${val}" assigned to \`logLevel\``); |
| 84 | + } |
| 85 | + this._logLevel = val; |
| 86 | + } |
| 87 | + |
| 88 | + debug(...args: unknown[]): void { |
| 89 | + this._log(LogLevel.DEBUG, ...args); |
| 90 | + } |
| 91 | + |
| 92 | + info(...args: unknown[]): void { |
| 93 | + this._log(LogLevel.INFO, ...args); |
| 94 | + } |
| 95 | + |
| 96 | + warn(...args: unknown[]): void { |
| 97 | + this._log(LogLevel.WARN, ...args); |
| 98 | + } |
| 99 | + |
| 100 | + error(...args: unknown[]): void { |
| 101 | + this._log(LogLevel.ERROR, ...args); |
| 102 | + } |
| 103 | + |
| 104 | + /** |
| 105 | + * Forwards log messages to their corresponding console counterparts if the |
| 106 | + * log level allows it. |
| 107 | + */ |
| 108 | + private _log(logLevel: LogLevel, ...args: unknown[]): void { |
| 109 | + if (logLevel < this._logLevel) { |
| 110 | + return; |
| 111 | + } |
| 112 | + const now = new Date().toISOString(); |
| 113 | + const method = |
| 114 | + logLevelToConsoleFn[logLevel as keyof typeof logLevelToConsoleFn]; |
| 115 | + if (method) { |
| 116 | + console[method as 'log' | 'info' | 'warn' | 'error']( |
| 117 | + `[${now}] Alchemy:`, |
| 118 | + ...args.map(stringify) |
| 119 | + ); |
| 120 | + } else { |
| 121 | + throw new Error( |
| 122 | + `Logger received an invalid logLevel (value: ${logLevel})` |
| 123 | + ); |
| 124 | + } |
| 125 | + } |
| 126 | +} |
| 127 | + |
| 128 | +function stringify(obj: unknown): string | unknown { |
| 129 | + if (typeof obj === 'string') { |
| 130 | + return obj; |
| 131 | + } else { |
| 132 | + try { |
| 133 | + return JSON.stringify(obj); |
| 134 | + } catch (e) { |
| 135 | + // Failed to convert to JSON, log the object directly. |
| 136 | + return obj; |
| 137 | + } |
| 138 | + } |
| 139 | +} |
| 140 | + |
| 141 | +// Instantiate default logger for the SDK. |
| 142 | +const loggerClient: Logger = new Logger(); |
0 commit comments