// Copyright 2017-2022 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 import type { Logger, Logger$Data } from './types'; import { formatDate } from './format/formatDate'; import { isBn } from './is/bn'; import { isBuffer } from './is/buffer'; import { isFunction } from './is/function'; import { isObject } from './is/object'; import { isU8a } from './is/u8a'; import { u8aToHex } from './u8a/toHex'; import { u8aToU8a } from './u8a/toU8a'; import { hasProcess } from './has'; declare const process: { env: Record }; type ConsoleType = 'error' | 'log' | 'warn'; type LogType = ConsoleType | 'debug'; const logTo = { debug: 'log', error: 'error', log: 'log', warn: 'warn' }; function formatOther (value: unknown): unknown { if (value && isObject(value) && value.constructor === Object) { const result: Record = {}; for (const k of Object.keys(value)) { result[k] = loggerFormat(value[k]); } return result; } return value; } export function loggerFormat (value: unknown): unknown { if (Array.isArray(value)) { return value.map(loggerFormat); } else if (isBn(value)) { return value.toString(); } else if (isU8a(value) || isBuffer(value)) { return u8aToHex(u8aToU8a(value)); } return formatOther(value); } function formatWithLength (maxLength: number): (v: unknown) => unknown { return (v: unknown): unknown => { if (maxLength <= 0) { return v; } const r = `${v as string}`; return r.length < maxLength ? v : `${r.substring(0, maxLength)} ...`; }; } function apply (log: LogType, type: string, values: Logger$Data, maxSize = -1): void { if (values.length === 1 && isFunction(values[0])) { const fnResult = values[0]() as unknown; return apply(log, type, Array.isArray(fnResult) ? fnResult : [fnResult], maxSize); } console[logTo[log]]( formatDate(new Date()), type, ...values .map(loggerFormat) .map(formatWithLength(maxSize)) ); } function noop (): void { // noop } function isDebugOn (e: string, type: string): boolean { return !!e && ( e === '*' || type === e || ( e.endsWith('*') && type.startsWith(e.slice(0, -1)) ) ); } function isDebugOff (e: string, type: string): boolean { return !!e && ( e.startsWith('-') && ( type === e.slice(1) || ( e.endsWith('*') && type.startsWith(e.slice(1, -1)) ) ) ); } function getDebugFlag (env: readonly string[], type: string): boolean { let flag = false; for (const e of env) { if (isDebugOn(e, type)) { flag = true; } else if (isDebugOff(e, type)) { flag = false; } } return flag; } function parseEnv (type: string): [boolean, number] { const env = (hasProcess ? process : {}).env || {}; const maxSize = parseInt(env.DEBUG_MAX || '-1', 10); return [ getDebugFlag((env.DEBUG || '').toLowerCase().split(','), type), isNaN(maxSize) ? -1 : maxSize ]; } /** * @name Logger * @summary Creates a consistent log interface for messages * @description * Returns a `Logger` that has `.log`, `.error`, `.warn` and `.debug` (controlled with environment `DEBUG=typeA,typeB`) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console. * @example *
* * ```javascript * import { logger } from '@polkadot/util'; * * const l = logger('test'); * ``` */ export function logger (_type: string): Logger { const type = `${_type.toUpperCase()}:`.padStart(16); const [isDebug, maxSize] = parseEnv(_type.toLowerCase()); return { debug: isDebug ? (...values: Logger$Data) => apply('debug', type, values, maxSize) : noop, error: (...values: Logger$Data) => apply('error', type, values), log: (...values: Logger$Data) => apply('log', type, values), noop, warn: (...values: Logger$Data) => apply('warn', type, values) }; }