Skip to content

Commit bbf7df7

Browse files
chrisbbreuerchrisbbreuer
committed
feat: add formatters
1 parent 115f2ea commit bbf7df7

File tree

8 files changed

+344
-1
lines changed

8 files changed

+344
-1
lines changed

‎src/formatters/index.ts

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import type { LogFormatter } from './types'
2+
import { JsonFormatter } from './json'
3+
import { TextFormatter } from './text'
4+
5+
export * from './json'
6+
export * from './text'
7+
export * from './types'
8+
9+
export function createFormatter(format: 'json' | 'text' = 'text', options: { colors?: boolean } = {}): LogFormatter {
10+
switch (format) {
11+
case 'json':
12+
return new JsonFormatter()
13+
case 'text':
14+
return new TextFormatter(options.colors)
15+
default:
16+
throw new Error(`Unknown format: ${format}`)
17+
}
18+
}

‎src/formatters/json.ts

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import type { LogEntry } from '../types'
2+
import type { LogFormatter } from './types'
3+
import process from 'node:process'
4+
import { isServerProcess } from '../utils'
5+
6+
export class JsonFormatter implements LogFormatter {
7+
async format(entry: LogEntry): Promise<string> {
8+
const isServer = await isServerProcess()
9+
const metadata = await this.getMetadata(isServer)
10+
11+
return JSON.stringify({
12+
timestamp: entry.timestamp.toISOString(),
13+
level: entry.level,
14+
name: entry.name,
15+
message: entry.message,
16+
metadata,
17+
})
18+
}
19+
20+
private async getMetadata(isServer: boolean) {
21+
if (isServer) {
22+
// Server environment
23+
const { hostname } = await import('node:os')
24+
return {
25+
pid: process.pid,
26+
hostname: hostname(),
27+
environment: process.env.NODE_ENV || 'development',
28+
}
29+
}
30+
31+
// Browser environment
32+
return {
33+
userAgent: navigator.userAgent,
34+
hostname: window.location.hostname || 'browser',
35+
environment: process.env.NODE_ENV || 'development',
36+
}
37+
}
38+
}

‎src/formatters/text.ts

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import type { LogEntry } from '../types'
2+
// src/formatters/text.ts
3+
import type { LogFormatter } from './types'
4+
import * as colors from '../colors'
5+
6+
export class TextFormatter implements LogFormatter {
7+
constructor(private useColors: boolean = true) { }
8+
9+
async format(entry: LogEntry): Promise<string> {
10+
const timestamp = this.formatTimestamp(entry.timestamp)
11+
const level = this.formatLevel(entry.level)
12+
const prefix = this.formatPrefix(entry.name)
13+
const message = this.formatMessage(entry.message)
14+
15+
return `${timestamp} ${prefix} ${level}: ${message}`
16+
}
17+
18+
private formatTimestamp(timestamp: Date): string {
19+
const time = `${timestamp.toLocaleTimeString()}:${timestamp.getMilliseconds()}`
20+
return this.useColors ? colors.gray(time) : time
21+
}
22+
23+
private formatLevel(level: string): string {
24+
if (!this.useColors)
25+
return level.toUpperCase()
26+
27+
switch (level) {
28+
case 'debug': return colors.gray('DEBUG')
29+
case 'info': return colors.blue('INFO')
30+
case 'success': return colors.green('SUCCESS')
31+
case 'warning': return colors.yellow('WARNING')
32+
case 'error': return colors.red('ERROR')
33+
default: return level.toUpperCase()
34+
}
35+
}
36+
37+
private formatPrefix(name: string): string {
38+
const prefix = `[${name}]`
39+
return this.useColors ? colors.blue(prefix) : prefix
40+
}
41+
42+
private formatMessage(message: any): string {
43+
if (typeof message === 'string')
44+
return message
45+
return JSON.stringify(message, null, 2)
46+
}
47+
}

‎src/formatters/types.ts

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import type { LogEntry } from '../types'
2+
3+
export interface LogFormatter {
4+
format: (entry: LogEntry) => string
5+
}

‎src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ function getVariable(variableName: string): string | undefined {
289289
return process.env[variableName]
290290
}
291291

292-
return globalThis[variableName]?.toString()
292+
return (globalThis as any)[variableName]?.toString()
293293
}
294294

295295
function isDefinedAndNotEquals(

‎src/logger.ts

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
import type { LogFormatter } from './formatters'
2+
import type { LogLevel } from './types'
3+
import process from 'node:process'
4+
import { format } from './format'
5+
import { createFormatter } from './formatters'
6+
import { logManager } from './storage/log-manager'
7+
import { isServerProcess } from './utils'
8+
9+
export interface LoggerOptions {
10+
format?: 'json' | 'text'
11+
colors?: boolean
12+
timestamp?: boolean
13+
}
14+
15+
export class Logger {
16+
private formatter: LogFormatter
17+
private isServer: boolean
18+
19+
constructor(
20+
private readonly name: string,
21+
private options: LoggerOptions = {},
22+
) {
23+
this.formatter = createFormatter(
24+
options.format || (process.env.NODE_ENV === 'production' ? 'json' : 'text'),
25+
{ colors: options.colors ?? true },
26+
)
27+
this.isServer = await isServerProcess()
28+
}
29+
30+
public extend(domain: string): Logger {
31+
return new Logger(`${this.name}:${domain}`, this.options)
32+
}
33+
34+
public async debug(message: any, ...args: Array<unknown>): Promise<void> {
35+
await this.log('debug', message, ...args)
36+
}
37+
38+
public info(message: any, ...args: Array<unknown>): () => Promise<void> {
39+
const startTime = performance.now()
40+
void this.log('info', message, ...args)
41+
42+
return async (endMessage?: string, ...endArgs: Array<unknown>) => {
43+
const duration = (performance.now() - startTime).toFixed(2)
44+
if (endMessage) {
45+
await this.log('info', `${endMessage} (${duration}ms)`, ...endArgs)
46+
}
47+
}
48+
}
49+
50+
public async success(message: any, ...args: Array<unknown>): Promise<void> {
51+
await this.log('success', message, ...args)
52+
}
53+
54+
public async warning(message: any, ...args: Array<unknown>): Promise<void> {
55+
await this.log('warning', message, ...args)
56+
}
57+
58+
public async error(message: any, ...args: Array<unknown>): Promise<void> {
59+
await this.log('error', message, ...args)
60+
}
61+
62+
public only(callback: () => void): void {
63+
const isEnabled = process.env.DEBUG === 'true'
64+
|| process.env.DEBUG === '1'
65+
|| process.env.DEBUG === this.name
66+
|| (process.env.DEBUG && this.name.startsWith(process.env.DEBUG))
67+
68+
if (isEnabled) {
69+
callback()
70+
}
71+
}
72+
73+
private async log(level: LogLevel, message: any, ...args: any[]): Promise<void> {
74+
const entry = {
75+
timestamp: new Date(),
76+
level,
77+
name: this.name,
78+
message: this.formatMessage(message, args),
79+
}
80+
81+
// Store the log entry
82+
await logManager.addEntry(entry)
83+
84+
// Format and output the log
85+
const output = await this.formatter.format(entry)
86+
87+
if (this.isServer) {
88+
if (level === 'error' || level === 'warning') {
89+
process.stderr.write(`${output}\n`)
90+
}
91+
else {
92+
process.stdout.write(`${output}\n`)
93+
}
94+
}
95+
else {
96+
// Browser environment
97+
switch (level) {
98+
case 'debug':
99+
// eslint-disable-next-line no-console
100+
console.debug(output)
101+
break
102+
case 'warning':
103+
console.warn(output)
104+
break
105+
case 'error':
106+
console.error(output)
107+
break
108+
default:
109+
// eslint-disable-next-line no-console
110+
console.log(output)
111+
}
112+
}
113+
}
114+
115+
private formatMessage(message: any, args: any[] = []): string {
116+
if (typeof message === 'string' && args.length > 0) {
117+
return format(message, ...args)
118+
}
119+
if (message instanceof Error) {
120+
return message.stack || message.message
121+
}
122+
if (typeof message === 'object') {
123+
return JSON.stringify(message, null, 2)
124+
}
125+
return String(message)
126+
}
127+
}

‎src/utils.ts

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
declare global {
2+
interface Navigator {
3+
product: string
4+
}
5+
}
6+
17
export async function isServerProcess(): Promise<boolean> {
28
if (typeof navigator !== 'undefined' && navigator.product === 'ReactNative') {
39
return true

‎test/server.test.ts

+102
Original file line numberDiff line numberDiff line change
@@ -199,3 +199,105 @@ describe('CLI', () => {
199199
expect(true).toBe(true)
200200
})
201201
})
202+
203+
describe('Formatters', () => {
204+
const sampleEntry = {
205+
timestamp: new Date('2024-02-01T12:34:56.789Z'),
206+
level: 'info',
207+
name: 'test',
208+
message: 'Hello world',
209+
}
210+
211+
describe('TextFormatter', () => {
212+
test('formats log entry with colors', () => {
213+
const formatter = new TextFormatter(true)
214+
const output = formatter.format(sampleEntry)
215+
216+
// The exact string match will depend on the color implementation
217+
expect(output).toContain('Hello world')
218+
expect(output).toContain('[test]')
219+
expect(output).toContain('INFO')
220+
})
221+
222+
test('formats log entry without colors', () => {
223+
const formatter = new TextFormatter(false)
224+
const output = formatter.format(sampleEntry)
225+
226+
expect(output).toBe('12:34:56:789 [test] INFO: Hello world')
227+
})
228+
229+
test('formats object message', () => {
230+
const formatter = new TextFormatter(false)
231+
const entry = {
232+
...sampleEntry,
233+
message: { key: 'value' },
234+
}
235+
const output = formatter.format(entry)
236+
237+
expect(output).toContain('{\n "key": "value"\n}')
238+
})
239+
})
240+
241+
describe('JsonFormatter', () => {
242+
test('formats log entry as JSON', () => {
243+
const formatter = new JsonFormatter()
244+
const output = formatter.format(sampleEntry)
245+
const parsed = JSON.parse(output)
246+
247+
expect(parsed).toEqual({
248+
timestamp: '2024-02-01T12:34:56.789Z',
249+
level: 'info',
250+
name: 'test',
251+
message: 'Hello world',
252+
metadata: expect.any(Object),
253+
})
254+
})
255+
256+
test('includes metadata', () => {
257+
const formatter = new JsonFormatter()
258+
const output = formatter.format(sampleEntry)
259+
const parsed = JSON.parse(output)
260+
261+
expect(parsed.metadata).toHaveProperty('pid')
262+
expect(parsed.metadata).toHaveProperty('hostname')
263+
expect(parsed.metadata).toHaveProperty('environment')
264+
})
265+
266+
test('handles object messages', () => {
267+
const formatter = new JsonFormatter()
268+
const entry = {
269+
...sampleEntry,
270+
message: { key: 'value' },
271+
}
272+
const output = formatter.format(entry)
273+
const parsed = JSON.parse(output)
274+
275+
expect(parsed.message).toEqual({ key: 'value' })
276+
})
277+
})
278+
279+
describe('Format Selection', () => {
280+
test('uses JSON in production', () => {
281+
process.env.NODE_ENV = 'production'
282+
const logger = new Logger('test')
283+
logger.info('test message')
284+
// TODO: verify JSON output
285+
expect(true).toBe(true)
286+
})
287+
288+
test('uses text in development', () => {
289+
process.env.NODE_ENV = 'development'
290+
const logger = new Logger('test')
291+
logger.info('test message')
292+
// TODO: verify text output
293+
expect(true).toBe(true)
294+
})
295+
296+
test('respects format option', () => {
297+
const logger = new Logger('test', { format: 'json' })
298+
logger.info('test message')
299+
// TODO: verify JSON output
300+
expect(true).toBe(true)
301+
})
302+
})
303+
})

0 commit comments

Comments
 (0)