Skip to content

src: make the output modular #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kevinburkesegment wants to merge 1 commit into
base: master
Choose a base branch
from
Open

src: make the output modular #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/node_modules/
/dist/
package-lock.json
232 changes: 129 additions & 103 deletions __tests__/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { advanceTo } from 'jest-date-mock'
import { Logger, LEVEL } from '../src'
import { Logger, LEVEL, formatLogLine, LogLine } from '../src'

advanceTo('2019-01-01T00:00:00.000Z')

test('can log a message', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()
// Helper to capture log output using the writer option
function createCaptureLogger(options: { level?: LEVEL; devMode?: boolean } = {}) {
const output: string[] = []
const logger = new Logger({
...options,
writer: (s) => output.push(s),
})
return { logger, output }
}

const logger = new Logger()
test('can log a message', () => {
const { logger, output } = createCaptureLogger()
logger.log('info', 'test')

expect(spy).toHaveBeenCalledWith(`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test"}\n`)
expect(output[0]).toBe(`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test"}`)
})

test('allows the log level to be limited', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger({ level: 'error' })
const { logger, output } = createCaptureLogger({ level: 'error' })
logger.log('info', 'test')

expect(spy).not.toHaveBeenCalled()
expect(output).toHaveLength(0)
})

test('validates the level', () => {
Expand All @@ -29,97 +35,80 @@ test('validates the level', () => {
})

test('can log data', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.log('info', 'test', { some: 'data' })

expect(spy).toHaveBeenCalledWith(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"some":"data"}}\n`
)
expect(output[0]).toBe(`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"some":"data"}}`)
})

interface fixture1 {
fixture2?: any;
fixture2?: any
}

test('handles circular references', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()
const { logger, output } = createCaptureLogger()

const fixture1: fixture1 = {}
const fixture2: object = { fixture1 }
fixture1.fixture2 = fixture2

const logger = new Logger()
logger.log('info', 'test', fixture1)

expect(spy).toHaveBeenCalledWith(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"fixture2":{"fixture1":"[Circular]"}}}\n`
expect(output[0]).toBe(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"fixture2":{"fixture1":"[Circular]"}}}`
)
})

test('handles Buffers', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.log('info', 'test', { buffer: Buffer.alloc(2) })

expect(spy).toHaveBeenCalledWith(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"buffer":{"type":"Buffer","data":[0,0]}}}\n`
expect(output[0]).toBe(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"buffer":{"type":"Buffer","data":[0,0]}}}`
)
})

test('handles BigInts', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.log('info', 'test', { bigint: BigInt('999999999999999999999') })

expect(spy).toHaveBeenCalledWith(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"bigint":"999999999999999999999"}}\n`
expect(output[0]).toBe(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"bigint":"999999999999999999999"}}`
)
})

test('handles Maps', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.log('info', 'test', { map: new Map([['test', 'map']]) })

expect(spy).toHaveBeenCalledWith(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"map":[["test","map"]]}}\n`
expect(output[0]).toBe(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"map":[["test","map"]]}}`
)
})

test('handles Sets', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.log('info', 'test', { set: new Set(['test']) })

expect(spy).toHaveBeenCalledWith(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"set":["test"]}}\n`
)
expect(output[0]).toBe(`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"set":["test"]}}`)
})

interface dataError {
data: {
error: {
message: string,
name: string,
stack: string[],
message: string
name: string
stack: string[]
}
}
}

test('handles Errors', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.log('info', 'test', { error: new Error('Request timeout') })

expect(spy).toHaveBeenCalled()
const log: dataError = JSON.parse(spy.mock.calls[0][0] as string) as dataError;
expect(output).toHaveLength(1)
const log: dataError = JSON.parse(output[0]) as dataError
expect(log).toMatchObject({
data: {
error: {
Expand All @@ -135,13 +124,11 @@ test('handles Errors', () => {
})

test('handles Errors at the top level', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.log('info', 'test', new Error('Request timeout'))

expect(spy).toHaveBeenCalled()
const log: dataError = JSON.parse(spy.mock.calls[0][0] as string) as dataError;
expect(output).toHaveLength(1)
const log: dataError = JSON.parse(output[0]) as dataError
expect(log).toMatchObject({
data: {
message: 'Request timeout',
Expand All @@ -154,66 +141,51 @@ test('handles Errors at the top level', () => {
})

class CustomError extends Error {
serviceName?: string;
serviceName?: string
}

test('logs additional properties on Errors', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
const error: CustomError = new Error('Request timeout')
error.serviceName = 'test'
logger.log('info', 'test', { error })

expect(spy).toHaveBeenCalled()
const log: dataError = JSON.parse(spy.mock.calls[0][0] as string) as dataError
expect(output).toHaveLength(1)
const log: dataError = JSON.parse(output[0]) as dataError
expect(log).toHaveProperty('data.error.serviceName')
})

test('devMode: can log a message', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger({ devMode: true })
const { logger, output } = createCaptureLogger({ devMode: true })
logger.log('info', 'test')

expect(spy).toHaveBeenCalled()
expect(spy.mock.calls[0][0]).toMatchInlineSnapshot(`
expect(output).toHaveLength(1)
expect(output[0]).toMatchInlineSnapshot(`
"
INFO: test
"
INFO: test"
`)
})

test('info alias can log data', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.info('test', { some: 'data' })

expect(spy).toHaveBeenCalledWith(
`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"some":"data"}}\n`
)
expect(output[0]).toBe(`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"some":"data"}}`)
})

test('error alias can log data', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
const { logger, output } = createCaptureLogger()
logger.error('test', { some: 'data' })

expect(spy).toHaveBeenCalledWith(
`{"level":"ERROR","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"some":"data"}}\n`
)
expect(output[0]).toBe(`{"level":"ERROR","time":"2019-01-01T00:00:00.000Z","message":"test","data":{"some":"data"}}`)
})

test('devMode: can log data', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger({ devMode: true })
const { logger, output } = createCaptureLogger({ devMode: true })
logger.log('info', 'test', { some: 'data', nested: { buffer: Buffer.alloc(2) } })

expect(spy).toHaveBeenCalled()
expect(spy.mock.calls[0][0]).toMatchInlineSnapshot(`
expect(output).toHaveLength(1)
expect(output[0]).toMatchInlineSnapshot(`
"
INFO: test
some: data
Expand All @@ -222,41 +194,95 @@ test('devMode: can log data', () => {
type: Buffer
data:
- 0
- 0
"
- 0"
`)
})

test('devMode: colors warn level yellow', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger({ devMode: true })
const { logger, output } = createCaptureLogger({ devMode: true })
logger.log('warn', 'test')

expect(spy).toHaveBeenCalled()
expect(spy.mock.calls[0][0]).toMatchInlineSnapshot(`
expect(output).toHaveLength(1)
expect(output[0]).toMatchInlineSnapshot(`
"
WARN: test
"
WARN: test"
`)
})

test('devMode: colors error level red', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger({ devMode: true })
const { logger, output } = createCaptureLogger({ devMode: true })
logger.log('error', 'test1')
logger.log('crit', 'test2')

expect(spy).toBeCalledTimes(2)
expect(spy.mock.calls[0][0]).toMatchInlineSnapshot(`
expect(output).toHaveLength(2)
expect(output[0]).toMatchInlineSnapshot(`
"
ERROR: test1
"
ERROR: test1"
`)
expect(spy.mock.calls[1][0]).toMatchInlineSnapshot(`
expect(output[1]).toMatchInlineSnapshot(`
"
CRIT: test2
"
CRIT: test2"
`)
})

// Tests for the new formatLogLine pure function
describe('formatLogLine', () => {
test('formats a basic log line as JSON', () => {
const logLine: LogLine = {
level: 'INFO',
time: '2019-01-01T00:00:00.000Z',
message: 'test message',
}

const result = formatLogLine(logLine, false)
expect(result).toBe('{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test message"}')
})

test('formats a log line with data as JSON', () => {
const logLine: LogLine = {
level: 'INFO',
time: '2019-01-01T00:00:00.000Z',
message: 'test message',
data: { foo: 'bar' },
}

const result = formatLogLine(logLine, false)
expect(result).toBe(
'{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test message","data":{"foo":"bar"}}'
)
})

test('formats a log line in dev mode', () => {
const logLine: LogLine = {
level: 'INFO',
time: '2019-01-01T00:00:00.000Z',
message: 'test message',
}

const result = formatLogLine(logLine, true)
expect(result).toContain('INFO: test message')
})

test('handles BigInt in data', () => {
const logLine: LogLine = {
level: 'INFO',
time: '2019-01-01T00:00:00.000Z',
message: 'test',
data: { bigint: BigInt('12345678901234567890') },
}

const result = formatLogLine(logLine, false)
expect(result).toContain('"bigint":"12345678901234567890"')
})
})

// Test that default writer still works (backwards compatibility)
test('defaults to stdout when no writer provided', () => {
const spy = jest.spyOn(process.stdout, 'write').mockImplementation()

const logger = new Logger()
logger.log('info', 'test')

expect(spy).toHaveBeenCalledWith(`{"level":"INFO","time":"2019-01-01T00:00:00.000Z","message":"test"}\n`)
spy.mockRestore()
})
Loading