Another logger in JS. This one offers a console.log-like API and formatting, colored lines and timestamps (or not if desired), all that with 0 dependencies.

Commit c7cf1c83

c7cf1c83426fMerged

Maxence Lecanu <[email protected]> · 4 months ago · 6 files · +4 added · ~2 modified

Description

Merge pull request #57 from LMaxence/refactor/timers-meta-classes

refactor: extract Timer and Meta into isolated classes

Details

Commit
c7cf1c83426f
Parent
81cb2bced387
Merge parent
5c6712a3cd86

lib/hellog.tsmodifiedView file

@@ -1,6 +1,7 @@
11 import { format } from 'node:util';
22 import { serializeError } from './errors.js';
33 import { HellogLevel, HellogLevelOrder } from './levels.js';
4+import { HellogMeta, MetaInput } from './meta.js';
45 import { HellogMessage } from './messages.js';
56 import {
67 HellogColorizeDefaultPlugin,
@@ -9,11 +10,12 @@
910 HellogPrettyDefaultPlugin,
1011 HellogStdoutDefaultPlugin,
1112 } from './plugins.js';
13+import { HellogTimer } from './timer.js';
1214
1315 interface HellogOptions {
1416 level?: HellogLevel;
1517 plugins?: HellogPlugin[];
16- meta?: Record<string, unknown> | (() => Record<string, unknown>);
18+ meta?: MetaInput;
1719 }
1820
1921 /**
@@ -63,7 +65,7 @@
6365 }
6466
6567 readonly options: HellogOptions | undefined;
66- private readonly _timers = new Map<string, bigint>();
68+ private readonly _timers = new HellogTimer();
6769
6870 constructor(options?: HellogOptions) {
6971 this.options = options;
@@ -108,14 +110,11 @@
108110 * reqLog.info('handling request'); // includes requestId in meta
109111 * ```
110112 */
111- child(meta: Record<string, unknown> | (() => Record<string, unknown>)): Hellog {
112- const parentMeta = this.options?.meta;
113+ child(meta: MetaInput): Hellog {
114+ const childMeta = new HellogMeta(this.options?.meta).child(meta);
113115 return new Hellog({
114116 ...this.options,
115- meta: () => ({
116- ...Hellog._resolveMeta(parentMeta),
117- ...Hellog._resolveMeta(meta),
118- }),
117+ meta: () => childMeta.resolve(),
119118 });
120119 }
121120
@@ -124,7 +123,7 @@
124123 * Uses `process.hrtime.bigint()` for sub-millisecond monotonic precision.
125124 */
126125 time(label: string): void {
127- this._timers.set(label, process.hrtime.bigint());
126+ this._timers.start(label);
128127 }
129128
130129 /**
@@ -135,28 +134,15 @@
135134 * @param level - The log level to use (default: DEBUG).
136135 */
137136 timeEnd(label: string, level: HellogLevel = HellogLevel.DEBUG): void {
138- const start = this._timers.get(label);
139- if (start === undefined) return;
140- this._timers.delete(label);
141- const ms = Number(process.hrtime.bigint() - start) / 1_000_000;
142- this._log([`${label}: ${ms.toFixed(3)}ms`], level, { durationMs: ms });
143- }
144-
145- private static _resolveMeta(
146- meta: Record<string, unknown> | (() => Record<string, unknown>) | undefined,
147- ): Record<string, unknown> {
148- if (!meta) return {};
149- if (typeof meta === 'function') return meta();
150- return meta;
137+ const ms = this._timers.end(label);
138+ if (ms === undefined) return;
139+ this._log([HellogTimer.format(label, ms)], level, { durationMs: ms });
151140 }
152141
153142 private _log(data: unknown[], level: HellogLevel, extraMeta?: Record<string, unknown>): void {
154143 if (HellogLevelOrder[level] < HellogLevelOrder[this.maxLevel]) return;
155144
156- const metaObject: Record<string, unknown> = {
157- ...Hellog._resolveMeta(this.options?.meta),
158- ...extraMeta,
159- };
145+ const metaObject = new HellogMeta(this.options?.meta).merge(extraMeta);
160146
161147 const err = data.find((d): d is Error => d instanceof Error);
162148 const serialized = serializeError(err);