hierarchical-area-logger 0.2.8 → 0.2.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1 -0
- package/dist/index.js +25 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/Logger.ts +10 -1
- package/src/utils.ts +30 -1
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -51,6 +51,27 @@ var createRootLogEntry = ({
|
|
|
51
51
|
}
|
|
52
52
|
return rootLogEntry;
|
|
53
53
|
};
|
|
54
|
+
var removeEmptyAreas = (logData) => {
|
|
55
|
+
const newLogData = {};
|
|
56
|
+
for (const [key, value] of Object.entries(logData)) {
|
|
57
|
+
if (value.length > 0) {
|
|
58
|
+
newLogData[key] = value;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
return newLogData;
|
|
62
|
+
};
|
|
63
|
+
var excludeDebugLogs = (logEntries) => {
|
|
64
|
+
return logEntries.filter((entry) => entry.type !== "debug");
|
|
65
|
+
};
|
|
66
|
+
var processProductionLogData = (logData) => {
|
|
67
|
+
const newLogData = {};
|
|
68
|
+
for (const [key, value] of Object.entries(logData)) {
|
|
69
|
+
if (key !== "root") {
|
|
70
|
+
newLogData[key] = excludeDebugLogs(value);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
return removeEmptyAreas(newLogData);
|
|
74
|
+
};
|
|
54
75
|
|
|
55
76
|
// src/Logger.ts
|
|
56
77
|
var Logger = class {
|
|
@@ -109,6 +130,10 @@ var Logger = class {
|
|
|
109
130
|
this.finalizeRootMessage();
|
|
110
131
|
return this.log;
|
|
111
132
|
}
|
|
133
|
+
dumpProduction() {
|
|
134
|
+
this.finalizeRootMessage();
|
|
135
|
+
return processProductionLogData(this.log);
|
|
136
|
+
}
|
|
112
137
|
appendLogData(logData) {
|
|
113
138
|
delete logData.root;
|
|
114
139
|
this.log = { ...logData, ...this.log };
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/Logger.ts","../src/utils.ts"],"sourcesContent":["import { init } from '@paralleldrive/cuid2';\nimport {
|
|
1
|
+
{"version":3,"sources":["../src/Logger.ts","../src/utils.ts"],"sourcesContent":["import { init } from '@paralleldrive/cuid2';\nimport {\n createRootLogEntry,\n prettyError,\n processProductionLogData,\n} from './utils';\nimport type { LogData, LoggerOptions, LogEntry, LogEntryType } from './types';\n\nexport class Logger {\n public eventId: string;\n private log: LogData;\n public parentEventId?: string;\n private defaultArea: string;\n\n constructor(options: LoggerOptions) {\n this.parentEventId = options.parentEventId;\n this.eventId =\n options.overrideEventId ||\n init({ fingerprint: options.details.service })();\n this.defaultArea = options.defaultArea || 'defaultArea';\n\n this.log = createRootLogEntry({\n path: options.path || '/',\n method: options.method,\n details: options.details,\n eventId: this.eventId,\n parentEventId: options.parentEventId,\n withParentEventId: options.withParentEventId,\n });\n }\n\n private finalizeRootMessage() {\n this.addMessage('root', 'info', 'Request completed', {\n totalDuration: Date.now() - this.log.root[0].timestamp,\n });\n }\n\n private addMessage(\n name: string,\n type: LogEntryType,\n message: string,\n payload?: LogEntry['payload'] | Error\n ) {\n const finalPayload =\n payload instanceof Error ? prettyError(payload) : payload;\n\n this.log[name]!.push({\n type,\n message,\n payload: finalPayload,\n timestamp: Date.now(),\n });\n }\n\n // Area function that returns area-specific logger methods\n public getArea(name = this.defaultArea) {\n if (!this.log[name]) {\n this.log[name] = [];\n }\n\n return {\n info: (message: string, payload?: LogEntry['payload']) => {\n this.addMessage(name, 'info', message, payload);\n },\n warn: (message: string, payload?: LogEntry['payload']) => {\n this.addMessage(name, 'warn', message, payload);\n },\n error: (message: string, payload?: LogEntry['payload'] | Error) => {\n this.addMessage(name, 'error', message, payload);\n },\n log: (message: string, payload?: LogEntry['payload']) => {\n this.addMessage(name, 'log', message, payload);\n },\n debug: (message: string, payload?: LogEntry['payload']) => {\n this.addMessage(name, 'debug', message, payload);\n },\n };\n }\n\n // Public methods on main instance\n public dump(): LogData {\n this.finalizeRootMessage();\n return this.log;\n }\n\n public dumpProduction(): LogData {\n this.finalizeRootMessage();\n return processProductionLogData(this.log);\n }\n\n public appendLogData(logData: LogData): void {\n delete logData.root;\n this.log = { ...logData, ...this.log };\n }\n}\n\n// Factory function for convenience\nexport const createLogger = (options: LoggerOptions): Logger => {\n return new Logger(options);\n};\n","import {\n CreateRootLogEntryOptions,\n LogData,\n LogEntry,\n RootPayload,\n} from './types';\n\nexport const prettyStack = (stack?: string): string[] => {\n if (!stack) return [];\n let toReplace = '';\n\n const regex = /file:\\/\\/\\/(.*)(\\.wrangler|node_modules)\\/.*\\)/gm;\n const m = regex.exec(stack);\n\n if (m && m.length > 1) {\n toReplace = m[1];\n }\n\n return stack\n .split('\\n')\n .map((line) => line.trim())\n .filter((line) => !line.startsWith('Error: '))\n .map((line) => line.replace(toReplace, ''))\n .map((line) => line.replace('file://', ''));\n};\n\nexport const prettyError = (err: Error) => {\n const stack = prettyStack(err.stack);\n const message = err.message;\n return { message, stack };\n};\n\nexport const createRootLogEntry = ({\n path,\n method,\n details,\n eventId,\n parentEventId,\n withParentEventId,\n}: CreateRootLogEntryOptions): LogData => {\n const url = new URL(`http://example.com${path ?? '/'}`);\n\n const rootLogEntry: LogData = {\n root: [\n {\n type: 'info',\n message: 'Request received',\n payload: {\n path: `${url.pathname}${url.search}`,\n method,\n details,\n eventId,\n ...(parentEventId && { parentEventId }),\n } as RootPayload,\n timestamp: Date.now(),\n },\n ],\n };\n\n if (withParentEventId && !parentEventId) {\n rootLogEntry.root.push({\n type: 'error',\n message: 'Parent event ID expected but not found',\n timestamp: Date.now(),\n });\n }\n\n return rootLogEntry;\n};\n\nexport const removeEmptyAreas = (logData: LogData) => {\n const newLogData: LogData = {};\n for (const [key, value] of Object.entries(logData)) {\n if (value.length > 0) {\n newLogData[key] = value;\n }\n }\n return newLogData;\n};\n\nexport const excludeDebugLogs = (logEntries: LogEntry[]) => {\n return logEntries.filter((entry) => entry.type !== 'debug');\n};\n\nexport const processProductionLogData = (logData: LogData) => {\n const newLogData: LogData = {};\n for (const [key, value] of Object.entries(logData)) {\n if (key !== 'root') {\n newLogData[key] = excludeDebugLogs(value);\n }\n }\n return removeEmptyAreas(newLogData);\n};\n"],"mappings":";AAAA,SAAS,YAAY;;;ACOd,IAAM,cAAc,CAAC,UAA6B;AACvD,MAAI,CAAC,MAAO,QAAO,CAAC;AACpB,MAAI,YAAY;AAEhB,QAAM,QAAQ;AACd,QAAM,IAAI,MAAM,KAAK,KAAK;AAE1B,MAAI,KAAK,EAAE,SAAS,GAAG;AACrB,gBAAY,EAAE,CAAC;AAAA,EACjB;AAEA,SAAO,MACJ,MAAM,IAAI,EACV,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,EACzB,OAAO,CAAC,SAAS,CAAC,KAAK,WAAW,SAAS,CAAC,EAC5C,IAAI,CAAC,SAAS,KAAK,QAAQ,WAAW,EAAE,CAAC,EACzC,IAAI,CAAC,SAAS,KAAK,QAAQ,WAAW,EAAE,CAAC;AAC9C;AAEO,IAAM,cAAc,CAAC,QAAe;AACzC,QAAM,QAAQ,YAAY,IAAI,KAAK;AACnC,QAAM,UAAU,IAAI;AACpB,SAAO,EAAE,SAAS,MAAM;AAC1B;AAEO,IAAM,qBAAqB,CAAC;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA0C;AACxC,QAAM,MAAM,IAAI,IAAI,qBAAqB,QAAQ,GAAG,EAAE;AAEtD,QAAM,eAAwB;AAAA,IAC5B,MAAM;AAAA,MACJ;AAAA,QACE,MAAM;AAAA,QACN,SAAS;AAAA,QACT,SAAS;AAAA,UACP,MAAM,GAAG,IAAI,QAAQ,GAAG,IAAI,MAAM;AAAA,UAClC;AAAA,UACA;AAAA,UACA;AAAA,UACA,GAAI,iBAAiB,EAAE,cAAc;AAAA,QACvC;AAAA,QACA,WAAW,KAAK,IAAI;AAAA,MACtB;AAAA,IACF;AAAA,EACF;AAEA,MAAI,qBAAqB,CAAC,eAAe;AACvC,iBAAa,KAAK,KAAK;AAAA,MACrB,MAAM;AAAA,MACN,SAAS;AAAA,MACT,WAAW,KAAK,IAAI;AAAA,IACtB,CAAC;AAAA,EACH;AAEA,SAAO;AACT;AAEO,IAAM,mBAAmB,CAAC,YAAqB;AACpD,QAAM,aAAsB,CAAC;AAC7B,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,OAAO,GAAG;AAClD,QAAI,MAAM,SAAS,GAAG;AACpB,iBAAW,GAAG,IAAI;AAAA,IACpB;AAAA,EACF;AACA,SAAO;AACT;AAEO,IAAM,mBAAmB,CAAC,eAA2B;AAC1D,SAAO,WAAW,OAAO,CAAC,UAAU,MAAM,SAAS,OAAO;AAC5D;AAEO,IAAM,2BAA2B,CAAC,YAAqB;AAC5D,QAAM,aAAsB,CAAC;AAC7B,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,OAAO,GAAG;AAClD,QAAI,QAAQ,QAAQ;AAClB,iBAAW,GAAG,IAAI,iBAAiB,KAAK;AAAA,IAC1C;AAAA,EACF;AACA,SAAO,iBAAiB,UAAU;AACpC;;;ADpFO,IAAM,SAAN,MAAa;AAAA,EAMlB,YAAY,SAAwB;AAClC,SAAK,gBAAgB,QAAQ;AAC7B,SAAK,UACH,QAAQ,mBACR,KAAK,EAAE,aAAa,QAAQ,QAAQ,QAAQ,CAAC,EAAE;AACjD,SAAK,cAAc,QAAQ,eAAe;AAE1C,SAAK,MAAM,mBAAmB;AAAA,MAC5B,MAAM,QAAQ,QAAQ;AAAA,MACtB,QAAQ,QAAQ;AAAA,MAChB,SAAS,QAAQ;AAAA,MACjB,SAAS,KAAK;AAAA,MACd,eAAe,QAAQ;AAAA,MACvB,mBAAmB,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,sBAAsB;AAC5B,SAAK,WAAW,QAAQ,QAAQ,qBAAqB;AAAA,MACnD,eAAe,KAAK,IAAI,IAAI,KAAK,IAAI,KAAK,CAAC,EAAE;AAAA,IAC/C,CAAC;AAAA,EACH;AAAA,EAEQ,WACN,MACA,MACA,SACA,SACA;AACA,UAAM,eACJ,mBAAmB,QAAQ,YAAY,OAAO,IAAI;AAEpD,SAAK,IAAI,IAAI,EAAG,KAAK;AAAA,MACnB;AAAA,MACA;AAAA,MACA,SAAS;AAAA,MACT,WAAW,KAAK,IAAI;AAAA,IACtB,CAAC;AAAA,EACH;AAAA;AAAA,EAGO,QAAQ,OAAO,KAAK,aAAa;AACtC,QAAI,CAAC,KAAK,IAAI,IAAI,GAAG;AACnB,WAAK,IAAI,IAAI,IAAI,CAAC;AAAA,IACpB;AAEA,WAAO;AAAA,MACL,MAAM,CAAC,SAAiB,YAAkC;AACxD,aAAK,WAAW,MAAM,QAAQ,SAAS,OAAO;AAAA,MAChD;AAAA,MACA,MAAM,CAAC,SAAiB,YAAkC;AACxD,aAAK,WAAW,MAAM,QAAQ,SAAS,OAAO;AAAA,MAChD;AAAA,MACA,OAAO,CAAC,SAAiB,YAA0C;AACjE,aAAK,WAAW,MAAM,SAAS,SAAS,OAAO;AAAA,MACjD;AAAA,MACA,KAAK,CAAC,SAAiB,YAAkC;AACvD,aAAK,WAAW,MAAM,OAAO,SAAS,OAAO;AAAA,MAC/C;AAAA,MACA,OAAO,CAAC,SAAiB,YAAkC;AACzD,aAAK,WAAW,MAAM,SAAS,SAAS,OAAO;AAAA,MACjD;AAAA,IACF;AAAA,EACF;AAAA;AAAA,EAGO,OAAgB;AACrB,SAAK,oBAAoB;AACzB,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,iBAA0B;AAC/B,SAAK,oBAAoB;AACzB,WAAO,yBAAyB,KAAK,GAAG;AAAA,EAC1C;AAAA,EAEO,cAAc,SAAwB;AAC3C,WAAO,QAAQ;AACf,SAAK,MAAM,EAAE,GAAG,SAAS,GAAG,KAAK,IAAI;AAAA,EACvC;AACF;AAGO,IAAM,eAAe,CAAC,YAAmC;AAC9D,SAAO,IAAI,OAAO,OAAO;AAC3B;","names":[]}
|
package/package.json
CHANGED
package/src/Logger.ts
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
import { init } from '@paralleldrive/cuid2';
|
|
2
|
-
import {
|
|
2
|
+
import {
|
|
3
|
+
createRootLogEntry,
|
|
4
|
+
prettyError,
|
|
5
|
+
processProductionLogData,
|
|
6
|
+
} from './utils';
|
|
3
7
|
import type { LogData, LoggerOptions, LogEntry, LogEntryType } from './types';
|
|
4
8
|
|
|
5
9
|
export class Logger {
|
|
@@ -79,6 +83,11 @@ export class Logger {
|
|
|
79
83
|
return this.log;
|
|
80
84
|
}
|
|
81
85
|
|
|
86
|
+
public dumpProduction(): LogData {
|
|
87
|
+
this.finalizeRootMessage();
|
|
88
|
+
return processProductionLogData(this.log);
|
|
89
|
+
}
|
|
90
|
+
|
|
82
91
|
public appendLogData(logData: LogData): void {
|
|
83
92
|
delete logData.root;
|
|
84
93
|
this.log = { ...logData, ...this.log };
|
package/src/utils.ts
CHANGED
|
@@ -1,4 +1,9 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import {
|
|
2
|
+
CreateRootLogEntryOptions,
|
|
3
|
+
LogData,
|
|
4
|
+
LogEntry,
|
|
5
|
+
RootPayload,
|
|
6
|
+
} from './types';
|
|
2
7
|
|
|
3
8
|
export const prettyStack = (stack?: string): string[] => {
|
|
4
9
|
if (!stack) return [];
|
|
@@ -62,3 +67,27 @@ export const createRootLogEntry = ({
|
|
|
62
67
|
|
|
63
68
|
return rootLogEntry;
|
|
64
69
|
};
|
|
70
|
+
|
|
71
|
+
export const removeEmptyAreas = (logData: LogData) => {
|
|
72
|
+
const newLogData: LogData = {};
|
|
73
|
+
for (const [key, value] of Object.entries(logData)) {
|
|
74
|
+
if (value.length > 0) {
|
|
75
|
+
newLogData[key] = value;
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
return newLogData;
|
|
79
|
+
};
|
|
80
|
+
|
|
81
|
+
export const excludeDebugLogs = (logEntries: LogEntry[]) => {
|
|
82
|
+
return logEntries.filter((entry) => entry.type !== 'debug');
|
|
83
|
+
};
|
|
84
|
+
|
|
85
|
+
export const processProductionLogData = (logData: LogData) => {
|
|
86
|
+
const newLogData: LogData = {};
|
|
87
|
+
for (const [key, value] of Object.entries(logData)) {
|
|
88
|
+
if (key !== 'root') {
|
|
89
|
+
newLogData[key] = excludeDebugLogs(value);
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
return removeEmptyAreas(newLogData);
|
|
93
|
+
};
|