Refactor (#71)

* use kebab-case

* make imports "less" strange

* fix test, improve style

* fix test

* improve test

* replace benchmark with tinybench

* update tsd

* put types node to  devDependencies

Author: Uzlopak

benchmark/format-date.js

@@ -1,11 +1,14 @@
 'use strict'
 
-const benchmark = require('benchmark')
-const formatDate = require('../lib/formatDate')
+const { Bench } = require('tinybench')
+const formatDate = require('../lib/format-date')
 
 const now = Date.now()
 
-new benchmark.Suite()
-  .add('formatDate', function () { formatDate(now) }, { minSamples: 100 })
-  .on('cycle', function onCycle (event) { console.log(String(event.target)) })
-  .run()
+const benchmark = new Bench()
+
+benchmark.add('formatDate', function () { formatDate(now) })
+
+benchmark.run().then(() => {
+  console.table(benchmark.table())
+})

benchmark/format-message.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const benchmark = require('benchmark')
-const messageFormatFactory = require('../lib/messageFormatFactory')
+const { Bench } = require('tinybench')
+const messageFormatFactory = require('../lib/message-format-factory')
 
 const colors = {
   60: 'red',
@@ -22,7 +22,10 @@ const log = {
   }
 }
 
-new benchmark.Suite()
-  .add('formatMessageColorized', function () { formatMessageColorized(log, 'message') }, { minSamples: 100 })
-  .on('cycle', function onCycle (event) { console.log(String(event.target)) })
-  .run()
+const benchmark = new Bench()
+
+benchmark.add('formatMessageColorized', function () { formatMessageColorized(log, 'message') })
+
+benchmark.run().then(() => {
+  console.table(benchmark.table())
+})

index.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const pretty = require('pino-pretty')
-const messageFormatFactory = require('./lib/messageFormatFactory')
+const { messageFormatFactory } = require('./lib/message-format-factory')
 
 const oneLineLogger = (opts = {}) => {
   const { levels, colors, ...rest } = opts

lib/formatDate.js renamed to lib/format-date.js

@@ -23,3 +23,4 @@ function formatDate (timestamp) {
 }
 
 module.exports = formatDate
+module.exports.formatDate = formatDate

lib/messageFormatFactory.js renamed to lib/message-format-factory.js

@@ -1,5 +1,6 @@
 'use strict'
-const formatDate = require('./formatDate')
+
+const formatDate = require('./format-date')
 const colorizerFactory = require('pino-pretty').colorizerFactory
 
 const messageFormatFactory = (levels, colors, useColors) => {
@@ -46,3 +47,4 @@ const messageFormatFactory = (levels, colors, useColors) => {
 }
 
 module.exports = messageFormatFactory
+module.exports.messageFormatFactory = messageFormatFactory

package.json

@@ -14,14 +14,12 @@
     "pino-pretty": "^13.0.0"
   },
   "devDependencies": {
-    "benchmark": "^2.1.4",
+    "@types/node": "^20.19.19",
     "eslint": "^9.17.0",
     "fastify": "^5.0.0",
     "neostandard": "^0.12.0",
-    "tsd": "^0.32.0"
-  },
-  "resolutions": {
-    "@types/node": "^20.12.7"
+    "tinybench": "^5.0.1",
+    "tsd": "^0.33.0"
   },
   "scripts": {
     "lint": "eslint",

test/fastify.test.js

@@ -1,11 +1,8 @@
 'use strict'
 
-const { serverFactory, TIME, unmockTime, mockTime } = require('./helpers')
+const { before, beforeEach, after, test, describe, afterEach } = require('node:test')
 const pretty = require('pino-pretty')
-const { before, beforeEach, after, test } = require('node:test')
-
-const messages = []
-let server = serverFactory(messages, { colorize: false })
+const { serverFactory, TIME, unmockTime, mockTime } = require('./helpers')
 
 before(() => {
   mockTime()
@@ -15,30 +12,22 @@ after(() => {
   unmockTime()
 })
 
-beforeEach(() => {
-  // empty messages array
-  messages.splice(0, messages.length)
+describe('should log server started messages', () => {
+  let messages
+  let server
 
-  server = serverFactory(messages)
-})
-
-test('should log server started messages', async (t) => {
-  t.beforeEach(async () => {
-    await server.listen({ port: 63995 })
-    t.afterEach(async () => await server.close())
+  beforeEach(async () => {
+    server = serverFactory(messages = [])
+    await server.listen({ host: '127.0.0.1', port: 63995 })
   })
+  afterEach(async () => { await server.close() })
 
-  await t.test('colors supported in TTY', { skip: !pretty.isColorSupported }, (t) => {
-    const messagesExpected = [
-      `${TIME} - \x1B[32minfo\x1B[39m - \x1B[36mServer listening at http://127.0.0.1:63995\x1B[39m\n`,
-      `${TIME} - \x1B[32minfo\x1B[39m - \x1B[36mServer listening at http://[::1]:63995\x1B[39m\n`
-    ]
-
+  test('colors supported in TTY', { skip: !pretty.isColorSupported }, (t) => {
     // sort because the order of the messages is not guaranteed
-    t.assert.deepStrictEqual(messages.sort(), messagesExpected.sort())
+    t.assert.deepStrictEqual(messages[0], `${TIME} - \x1B[32minfo\x1B[39m - \x1B[36mServer listening at http://127.0.0.1:63995\x1B[39m\n`)
   })
 
-  await t.test(
+  test(
     'colors not supported in TTY',
     { skip: pretty.isColorSupported },
     (t) => {
@@ -51,12 +40,16 @@ test('should log server started messages', async (t) => {
       t.assert.deepStrictEqual(messages.sort(), messagesExpected.sort())
     }
   )
-})
+});
+
+['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD'].forEach((method) => {
+  describe(`should log request and response messages for ${method}`, () => {
+    let messages
+    let server
+
+    beforeEach(async () => {
+      server = serverFactory(messages = [])
 
-const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD']
-methods.forEach((method) => {
-  test('should log request and response messages for %p', async (t) => {
-    t.beforeEach(async () => {
       const serverMethod = method === 'HEAD' ? 'GET' : method
       server[serverMethod.toLowerCase()]('/path', (_, req) => {
         req.send()
@@ -68,7 +61,7 @@ methods.forEach((method) => {
       })
     })
 
-    await t.test(
+    test(
       'colors supported in TTY',
       { skip: !pretty.isColorSupported },
       (t) => {
@@ -80,7 +73,7 @@ methods.forEach((method) => {
       }
     )
 
-    await t.test(
+    test(
       'colors not supported in TTY',
       { skip: pretty.isColorSupported },
       (t) => {
@@ -94,9 +87,11 @@ methods.forEach((method) => {
   })
 })
 
-test('should handle user defined log', async (t) => {
-  t.beforeEach(async () => {
-    server = serverFactory(messages, { minimumLevel: 'trace' })
+describe('should handle user defined log', () => {
+  let messages
+  let server
+  beforeEach(async () => {
+    server = serverFactory(messages = [], { minimumLevel: 'trace' })
 
     server.get('/a-path-with-user-defined-log', (res, req) => {
       res.log.fatal('a user defined fatal log')
@@ -112,7 +107,7 @@ test('should handle user defined log', async (t) => {
     await server.inject('/a-path-with-user-defined-log')
   })
 
-  await t.test('colors supported in TTY', { skip: !pretty.isColorSupported }, (t) => {
+  test('colors supported in TTY', { skip: !pretty.isColorSupported }, (t) => {
     const messagesExpected = [
       `${TIME} - \x1B[32minfo\x1B[39m - GET /a-path-with-user-defined-log - \x1B[36mincoming request\x1B[39m\n`,
       `${TIME} - \x1B[41mfatal\x1B[49m - \x1B[36ma user defined fatal log\x1B[39m\n`,
@@ -126,7 +121,7 @@ test('should handle user defined log', async (t) => {
     t.assert.deepStrictEqual(messages, messagesExpected)
   })
 
-  await t.test(
+  test(
     'colors not supported in TTY',
     { skip: pretty.isColorSupported },
     (t) => {

test/formatDate.test.js renamed to test/format-date.test.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const formatDate = require('../lib/formatDate')
 const { test } = require('node:test')
+const { formatDate } = require('../lib/format-date')
 
 const timeFormatRE = /^\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$/
 

test/helpers.js

@@ -3,7 +3,7 @@
 const { Writable } = require('node:stream')
 const fastify = require('fastify')
 const pino = require('pino')
-const target = require('..')
+const { oneLineLogger } = require('..')
 
 const HOUR = 20
 const TIME = `2017-02-14 ${HOUR}:51:48.000+0800`
@@ -16,7 +16,7 @@ const pinoFactory = (opts) => {
 
   return pino(
     { level },
-    target({
+    oneLineLogger({
       ...opts
     })
   )

test/index.test.js

@@ -1,10 +1,9 @@
 'use strict'
 
-const { EPOCH, TIME, MESSAGE_KEY, mockTime, unmockTime } = require('./helpers')
-const target = require('..')
 const { before, after, test } = require('node:test')
 const pretty = require('pino-pretty')
-const { messageFormatFactory } = target
+const { messageFormatFactory, oneLineLogger } = require('..')
+const { EPOCH, TIME, MESSAGE_KEY, mockTime, unmockTime } = require('./helpers')
 
 const messageFormat = messageFormatFactory(
   undefined,
@@ -20,8 +19,8 @@ after(() => {
   unmockTime()
 })
 
-test('able to instantiate target without arguments', () => {
-  target()
+test('able to instantiate oneLineLogger without arguments', () => {
+  oneLineLogger()
 })
 
 test('format log correctly with different logDescriptor', async (t) => {