standard-log 6.2.6 → 7.0.0

package/src/memory/MemoryLogReporter.spec.ts

@@ -1,99 +1,103 @@
 import a from 'assertron'
-import { config, createMemoryLogReporter, ProhibitedDuringProduction } from '..'
-import { logLevels } from '../logLevel'
+import { config, createMemoryLogReporter, logLevels, ProhibitedDuringProduction } from '..'
 import { store } from '../store'
 
-beforeEach(() => {
-  store.reset()
-  config({ mode: 'test' })
-})
-test('log entries are saved in the `logs` property', () => {
-  const reporter = createMemoryLogReporter()
-  const entry = { id: 'log', level: 1, args: ['some messages'], timestamp: new Date() }
-  reporter.write(entry)
-  expect(reporter.logs).toEqual([entry])
-})
-
-test('can override id', () => {
-  const reporter = createMemoryLogReporter({ id: 'custom-id-mem' })
-  expect(reporter.id).toBe('custom-id-mem')
-})
-
-test('can filter', () => {
-  const reporter = createMemoryLogReporter({ filter(entry) { return entry.id !== 'secret' } })
-  reporter.write({ id: 'ok', level: 1, args: ['some messages'], timestamp: new Date() })
-  reporter.write({ id: 'secret', level: 1, args: ['some messages'], timestamp: new Date() })
-  expect(reporter.logs.length).toBe(1)
-})
+describe('production checks', () => {
+  beforeEach(() => store.reset())
+  test('set formatter in production mode throws', () => {
+    config({ mode: 'production' })
+    const reporter = createMemoryLogReporter()
 
-test('can change filter', () => {
-  const reporter = createMemoryLogReporter()
-  const filter = reporter.filter
-  reporter.filter = entry => entry.id !== 'secret'
-  expect(reporter.filter).not.toEqual(filter)
-})
+    a.throws(() => { reporter.formatter = e => e }, ProhibitedDuringProduction)
+  })
 
-test('set filter in production mode throws', () => {
-  config({ mode: 'production' })
-  const reporter = createMemoryLogReporter()
-  a.throws(() => { reporter.filter = () => true }, ProhibitedDuringProduction)
+  test('set filter in production mode throws', () => {
+    config({ mode: 'production' })
+    const reporter = createMemoryLogReporter()
+    a.throws(() => { reporter.filter = () => true }, ProhibitedDuringProduction)
+  })
 })
 
-test('formatter can be used to pre-process the log', () => {
-  const reporter = createMemoryLogReporter({
-    formatter: (entry) => ({
-      ...entry,
-      args: entry.args.map(arg => arg === 'secret' ? '<censored>' : arg)
-    })
+describe('unit tests', () => {
+  beforeEach(() => {
+    store.reset()
+    config({ mode: 'test' })
+  })
+  test('log entries are saved in the `logs` property', () => {
+    const reporter = createMemoryLogReporter()
+    const entry = { id: 'log', level: 1, args: ['some messages'], timestamp: new Date() }
+    reporter.write(entry)
+    expect(reporter.logs).toEqual([entry])
   })
 
-  const entry = { id: 'log', level: 1, args: ['a', 'secret', 'b'], timestamp: new Date() }
-  reporter.write(entry)
-
-  expect(reporter.logs[0].args[1]).toBe('<censored>')
-})
+  test('can override id', () => {
+    const reporter = createMemoryLogReporter({ id: 'custom-id-mem' })
+    expect(reporter.id).toBe('custom-id-mem')
+  })
 
-test('can change formatter', () => {
-  const reporter = createMemoryLogReporter()
-  const formatter = reporter.formatter
-  reporter.formatter = e => ({ ...e, args: e.args.reverse() })
-  expect(reporter.formatter).not.toEqual(formatter)
-})
+  test('can filter', () => {
+    const reporter = createMemoryLogReporter({ filter(entry) { return entry.id !== 'secret' } })
+    reporter.write({ id: 'ok', level: 1, args: ['some messages'], timestamp: new Date() })
+    reporter.write({ id: 'secret', level: 1, args: ['some messages'], timestamp: new Date() })
+    expect(reporter.logs.length).toBe(1)
+  })
 
-test('set formatter in production mode throws', () => {
-  config({ mode: 'production' })
-  const reporter = createMemoryLogReporter()
+  test('can change filter', () => {
+    const reporter = createMemoryLogReporter()
+    const filter = reporter.filter
+    reporter.filter = entry => entry.id !== 'secret'
+    expect(reporter.filter).not.toEqual(filter)
+  })
 
-  a.throws(() => { reporter.formatter = e => e }, ProhibitedDuringProduction)
-})
+  test('formatter can be used to pre-process the log', () => {
+    const reporter = createMemoryLogReporter({
+      formatter: (entry) => ({
+        ...entry,
+        args: entry.args.map(arg => arg === 'secret' ? '<censored>' : arg)
+      })
+    })
 
-describe('getLogMessages()', () => {
-  test('empty logs returns empty string', () => {
-    const reporter = createMemoryLogReporter()
+    const entry = { id: 'log', level: 1, args: ['a', 'secret', 'b'], timestamp: new Date() }
+    reporter.write(entry)
 
-    expect(reporter.getLogMessage()).toEqual('')
+    expect(reporter.logs[0].args[1]).toBe('<censored>')
   })
 
-  test('print args', () => {
+  test('can change formatter', () => {
     const reporter = createMemoryLogReporter()
-    const entry = { id: 'log', level: 1, args: ['miku', 'is', 'singing'], timestamp: new Date() }
-    reporter.write(entry)
-    expect(reporter.getLogMessage()).toEqual('miku is singing')
+    const formatter = reporter.formatter
+    reporter.formatter = e => ({ ...e, args: e.args.reverse() })
+    expect(reporter.formatter).not.toEqual(formatter)
   })
 
-  test('print object arg', () => {
-    const reporter = createMemoryLogReporter()
-    const entry = { id: 'log', level: 1, args: [{ 'miku': 'sing' }], timestamp: new Date() }
-    reporter.write(entry)
-    expect(reporter.getLogMessage()).toEqual("{ miku: 'sing' }")
+  describe('getLogMessages()', () => {
+    test('empty logs returns empty string', () => {
+      const reporter = createMemoryLogReporter()
+
+      expect(reporter.getLogMessage()).toEqual('')
+    })
+
+    test('print args', () => {
+      const reporter = createMemoryLogReporter()
+      const entry = { id: 'log', level: 1, args: ['miku', 'is', 'singing'], timestamp: new Date() }
+      reporter.write(entry)
+      expect(reporter.getLogMessage()).toEqual('miku is singing')
+    })
+
+    test('print object arg', () => {
+      const reporter = createMemoryLogReporter()
+      const entry = { id: 'log', level: 1, args: [{ 'miku': 'sing' }], timestamp: new Date() }
+      reporter.write(entry)
+      expect(reporter.getLogMessage()).toEqual("{ miku: 'sing' }")
+    })
   })
-})
 
-describe('getLogMessageWithLevel', () => {
-  test('print with level', () => {
-    const reporter = createMemoryLogReporter()
-    reporter.write({ id: 'log', level: logLevels.info, args: ['msg 1'], timestamp: new Date() })
-    reporter.write({ id: 'log', level: logLevels.warn, args: ['msg 2'], timestamp: new Date() })
-    expect(reporter.getLogMessageWithLevel()).toEqual(`(INFO) msg 1\n(WARN) msg 2`)
+  describe('getLogMessageWithLevel', () => {
+    test('print with level', () => {
+      const reporter = createMemoryLogReporter()
+      reporter.write({ id: 'log', level: logLevels.info, args: ['msg 1'], timestamp: new Date() })
+      reporter.write({ id: 'log', level: logLevels.warn, args: ['msg 2'], timestamp: new Date() })
+      expect(reporter.getLogMessageWithLevel()).toEqual(`(INFO) msg 1\n(WARN) msg 2`)
+    })
   })
 })

package/src/memory/MemoryLogReporter.ts

@@ -24,12 +24,10 @@ function createGetLogMessage() {
   }
 }
 
-function createGetMessageWithLevel() {
-  return function getLogMessage(this: { logs: LogEntry[] }) {
-    return this.logs.map(toInspectLogEntry)
-      .map(log => `${formatLogLevel(log.level)} ${log.args.join(' ')}`)
-      .join('\n')
-  }
+export function toMessageWithLevel(logs: LogEntry[]) {
+  return logs.map(toInspectLogEntry)
+    .map(log => `${formatLogLevel(log.level)} ${log.args.join(' ')}`)
+    .join('\n')
 }
 
 
@@ -59,6 +57,6 @@ export function createMemoryLogReporter(options?: LogReporterOptions<LogEntry>):
       this.logs.push(formatter(entry))
     },
     getLogMessage: createGetLogMessage(),
-    getLogMessageWithLevel: createGetMessageWithLevel()
+    getLogMessageWithLevel() { return toMessageWithLevel(this.logs) }
   }
 }