lucide-node 0.0.1-security → 1.0.0

package/benchmarks/internal/redact.bench.js

@@ -0,0 +1,86 @@
+'use strict'
+
+const bench = require('fastbench')
+const pino = require('../../')
+const fs = require('node:fs')
+const dest = fs.createWriteStream('/dev/null')
+const plog = pino(dest)
+delete require.cache[require.resolve('../../')]
+const plogAsync = require('../../')(pino.destination({ dest: '/dev/null', sync: false }))
+delete require.cache[require.resolve('../../')]
+const plogUnsafe = require('../../')({ safe: false }, dest)
+delete require.cache[require.resolve('../../')]
+const plogUnsafeAsync = require('../../')(
+  { safe: false },
+  pino.destination({ dest: '/dev/null', sync: false })
+)
+const plogRedact = pino({ redact: ['a.b.c'] }, dest)
+delete require.cache[require.resolve('../../')]
+const plogAsyncRedact = require('../../')(
+  { redact: ['a.b.c'] },
+  pino.destination({ dest: '/dev/null', sync: false })
+)
+delete require.cache[require.resolve('../../')]
+const plogUnsafeRedact = require('../../')({ redact: ['a.b.c'], safe: false }, dest)
+delete require.cache[require.resolve('../../')]
+const plogUnsafeAsyncRedact = require('../../')(
+  { redact: ['a.b.c'], safe: false },
+  pino.destination({ dest: '/dev/null', sync: false })
+)
+
+const max = 10
+
+// note that "redact me." is the same amount of bytes as the censor: "[Redacted]"
+
+const run = bench([
+  function benchPinoNoRedact (cb) {
+    for (var i = 0; i < max; i++) {
+      plog.info({ a: { b: { c: 'redact me.', d: 'leave me' } } })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoRedact (cb) {
+    for (var i = 0; i < max; i++) {
+      plogRedact.info({ a: { b: { c: 'redact me.', d: 'leave me' } } })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoUnsafeNoRedact (cb) {
+    for (var i = 0; i < max; i++) {
+      plogUnsafe.info({ a: { b: { c: 'redact me.', d: 'leave me' } } })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoUnsafeRedact (cb) {
+    for (var i = 0; i < max; i++) {
+      plogUnsafeRedact.info({ a: { b: { c: 'redact me.', d: 'leave me' } } })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoAsyncNoRedact (cb) {
+    for (var i = 0; i < max; i++) {
+      plogAsync.info({ a: { b: { c: 'redact me.', d: 'leave me' } } })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoAsyncRedact (cb) {
+    for (var i = 0; i < max; i++) {
+      plogAsyncRedact.info({ a: { b: { c: 'redact me.', d: 'leave me' } } })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoUnsafeAsyncNoRedact (cb) {
+    for (var i = 0; i < max; i++) {
+      plogUnsafeAsync.info({ a: { b: { c: 'redact me.', d: 'leave me' } } })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoUnsafeAsyncRedact (cb) {
+    for (var i = 0; i < max; i++) {
+      plogUnsafeAsyncRedact.info({ a: { b: { c: 'redact me.', d: 'leave me' } } })
+    }
+    setImmediate(cb)
+  }
+], 10000)
+
+run(run)

package/benchmarks/long-string.bench.js

@@ -0,0 +1,81 @@
+'use strict'
+
+const bench = require('fastbench')
+const pino = require('../')
+const bunyan = require('bunyan')
+const bole = require('bole')('bench')
+const winston = require('winston')
+const fs = require('node:fs')
+const dest = fs.createWriteStream('/dev/null')
+const plogNodeStream = pino(dest)
+delete require.cache[require.resolve('../')]
+const plogDest = require('../')(pino.destination('/dev/null'))
+delete require.cache[require.resolve('../')]
+const plogMinLength = require('../')(pino.destination({ dest: '/dev/null', sync: false, minLength: 4096 }))
+
+const crypto = require('crypto')
+
+const longStr = crypto.randomBytes(2000).toString()
+
+const max = 10
+const blog = bunyan.createLogger({
+  name: 'myapp',
+  streams: [{
+    level: 'trace',
+    stream: dest
+  }]
+})
+
+require('bole').output({
+  level: 'info',
+  stream: dest
+}).setFastTime(true)
+
+const chill = winston.createLogger({
+  transports: [
+    new winston.transports.Stream({
+      stream: fs.createWriteStream('/dev/null')
+    })
+  ]
+})
+
+const run = bench([
+  function benchBunyan (cb) {
+    for (var i = 0; i < max; i++) {
+      blog.info(longStr)
+    }
+    setImmediate(cb)
+  },
+  function benchWinston (cb) {
+    for (var i = 0; i < max; i++) {
+      chill.info(longStr)
+    }
+    setImmediate(cb)
+  },
+  function benchBole (cb) {
+    for (var i = 0; i < max; i++) {
+      bole.info(longStr)
+    }
+    setImmediate(cb)
+  },
+  function benchPino (cb) {
+    for (var i = 0; i < max; i++) {
+      plogDest.info(longStr)
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMinLength (cb) {
+    for (var i = 0; i < max; i++) {
+      plogMinLength.info(longStr)
+    }
+    setImmediate(cb)
+  },
+  function benchPinoNodeStream (cb) {
+    for (var i = 0; i < max; i++) {
+      plogNodeStream.info(longStr)
+    }
+    setImmediate(cb)
+  }
+], 1000)
+
+run(run)

package/benchmarks/multi-arg.bench.js

@@ -0,0 +1,193 @@
+'use strict'
+
+const bench = require('fastbench')
+const pino = require('../')
+const bunyan = require('bunyan')
+const bole = require('bole')('bench')
+const winston = require('winston')
+const fs = require('node:fs')
+const dest = fs.createWriteStream('/dev/null')
+const plogNodeStream = pino(dest)
+delete require.cache[require.resolve('../')]
+const plogDest = require('../')(pino.destination('/dev/null'))
+delete require.cache[require.resolve('../')]
+const plogMinLength = require('../')(pino.destination({ dest: '/dev/null', sync: false, minLength: 4096 }))
+delete require.cache[require.resolve('../')]
+
+const deep = require('../package.json')
+deep.deep = Object.assign({}, JSON.parse(JSON.stringify(deep)))
+deep.deep.deep = Object.assign({}, JSON.parse(JSON.stringify(deep)))
+deep.deep.deep.deep = Object.assign({}, JSON.parse(JSON.stringify(deep)))
+
+const blog = bunyan.createLogger({
+  name: 'myapp',
+  streams: [{
+    level: 'trace',
+    stream: dest
+  }]
+})
+
+require('bole').output({
+  level: 'info',
+  stream: dest
+}).setFastTime(true)
+
+const chill = winston.createLogger({
+  transports: [
+    new winston.transports.Stream({
+      stream: fs.createWriteStream('/dev/null')
+    })
+  ]
+})
+
+const max = 10
+
+const run = bench([
+  function benchBunyanInterpolate (cb) {
+    for (var i = 0; i < max; i++) {
+      blog.info('hello %s', 'world')
+    }
+    setImmediate(cb)
+  },
+  function benchWinstonInterpolate (cb) {
+    for (var i = 0; i < max; i++) {
+      chill.log('info', 'hello %s', 'world')
+    }
+    setImmediate(cb)
+  },
+  function benchBoleInterpolate (cb) {
+    for (var i = 0; i < max; i++) {
+      bole.info('hello %s', 'world')
+    }
+    setImmediate(cb)
+  },
+  function benchPinoInterpolate (cb) {
+    for (var i = 0; i < max; i++) {
+      plogDest.info('hello %s', 'world')
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMinLengthInterpolate (cb) {
+    for (var i = 0; i < max; i++) {
+      plogMinLength.info('hello %s', 'world')
+    }
+    setImmediate(cb)
+  },
+  function benchPinoNodeStreamInterpolate (cb) {
+    for (var i = 0; i < max; i++) {
+      plogNodeStream.info('hello %s', 'world')
+    }
+    setImmediate(cb)
+  },
+  function benchBunyanInterpolateAll (cb) {
+    for (var i = 0; i < max; i++) {
+      blog.info('hello %s %j %d', 'world', { obj: true }, 4)
+    }
+    setImmediate(cb)
+  },
+
+  function benchWinstonInterpolateAll (cb) {
+    for (var i = 0; i < max; i++) {
+      chill.log('info', 'hello %s %j %d', 'world', { obj: true }, 4)
+    }
+    setImmediate(cb)
+  },
+  function benchBoleInterpolateAll (cb) {
+    for (var i = 0; i < max; i++) {
+      bole.info('hello %s %j %d', 'world', { obj: true }, 4)
+    }
+    setImmediate(cb)
+  },
+  function benchPinoInterpolateAll (cb) {
+    for (var i = 0; i < max; i++) {
+      plogDest.info('hello %s %j %d', 'world', { obj: true }, 4)
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMinLengthInterpolateAll (cb) {
+    for (var i = 0; i < max; i++) {
+      plogMinLength.info('hello %s %j %d', 'world', { obj: true }, 4)
+    }
+    setImmediate(cb)
+  },
+  function benchPinoNodeStreamInterpolateAll (cb) {
+    for (var i = 0; i < max; i++) {
+      plogNodeStream.info('hello %s %j %d', 'world', { obj: true }, 4)
+    }
+    setImmediate(cb)
+  },
+  function benchBunyanInterpolateExtra (cb) {
+    for (var i = 0; i < max; i++) {
+      blog.info('hello %s %j %d', 'world', { obj: true }, 4, { another: 'obj' })
+    }
+    setImmediate(cb)
+  },
+  function benchWinstonInterpolateExtra (cb) {
+    for (var i = 0; i < max; i++) {
+      chill.log('info', 'hello %s %j %d', 'world', { obj: true }, 4, { another: 'obj' })
+    }
+    setImmediate(cb)
+  },
+  function benchBoleInterpolateExtra (cb) {
+    for (var i = 0; i < max; i++) {
+      bole.info('hello %s %j %d', 'world', { obj: true }, 4, { another: 'obj' })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoInterpolateExtra (cb) {
+    for (var i = 0; i < max; i++) {
+      plogDest.info('hello %s %j %d', 'world', { obj: true }, 4, { another: 'obj' })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMinLengthInterpolateExtra (cb) {
+    for (var i = 0; i < max; i++) {
+      plogMinLength.info('hello %s %j %d', 'world', { obj: true }, 4, { another: 'obj' })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoNodeStreamInterpolateExtra (cb) {
+    for (var i = 0; i < max; i++) {
+      plogNodeStream.info('hello %s %j %d', 'world', { obj: true }, 4, { another: 'obj' })
+    }
+    setImmediate(cb)
+  },
+  function benchBunyanInterpolateDeep (cb) {
+    for (var i = 0; i < max; i++) {
+      blog.info('hello %j', deep)
+    }
+    setImmediate(cb)
+  },
+  function benchWinstonInterpolateDeep (cb) {
+    for (var i = 0; i < max; i++) {
+      chill.log('info', 'hello %j', deep)
+    }
+    setImmediate(cb)
+  },
+  function benchBoleInterpolateDeep (cb) {
+    for (var i = 0; i < max; i++) {
+      bole.info('hello %j', deep)
+    }
+    setImmediate(cb)
+  },
+  function benchPinoInterpolateDeep (cb) {
+    for (var i = 0; i < max; i++) {
+      plogDest.info('hello %j', deep)
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMinLengthInterpolateDeep (cb) {
+    for (var i = 0; i < max; i++) {
+      plogMinLength.info('hello %j', deep)
+    }
+    setImmediate(cb)
+  },
+  function benchPinoNodeStreamInterpolateDeep (cb) {
+    for (var i = 0; i < max; i++) {
+      plogNodeStream.info('hello %j', deep)
+    }
+    setImmediate(cb)
+  }
+], 10000)
+
+run(run)

package/benchmarks/multistream.js

@@ -0,0 +1,98 @@
+'use strict'
+
+const bench = require('fastbench')
+const bunyan = require('bunyan')
+const pino = require('../')
+const fs = require('node:fs')
+const dest = fs.createWriteStream('/dev/null')
+
+const tenStreams = [
+  { stream: dest },
+  { stream: dest },
+  { stream: dest },
+  { stream: dest },
+  { stream: dest },
+  { level: 'debug', stream: dest },
+  { level: 'debug', stream: dest },
+  { level: 'trace', stream: dest },
+  { level: 'warn', stream: dest },
+  { level: 'fatal', stream: dest }
+]
+const pinomsTen = pino({ level: 'debug' }, pino.multistream(tenStreams))
+
+const fourStreams = [
+  { stream: dest },
+  { stream: dest },
+  { level: 'debug', stream: dest },
+  { level: 'trace', stream: dest }
+]
+const pinomsFour = pino({ level: 'debug' }, pino.multistream(fourStreams))
+
+const pinomsOne = pino({ level: 'info' }, pino.multistream(dest))
+const blogOne = bunyan.createLogger({
+  name: 'myapp',
+  streams: [{ stream: dest }]
+})
+
+const blogTen = bunyan.createLogger({
+  name: 'myapp',
+  streams: tenStreams
+})
+const blogFour = bunyan.createLogger({
+  name: 'myapp',
+  streams: fourStreams
+})
+
+const max = 10
+const run = bench([
+  function benchBunyanTen (cb) {
+    for (let i = 0; i < max; i++) {
+      blogTen.info('hello world')
+      blogTen.debug('hello world')
+      blogTen.trace('hello world')
+      blogTen.warn('hello world')
+      blogTen.fatal('hello world')
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMSTen (cb) {
+    for (let i = 0; i < max; i++) {
+      pinomsTen.info('hello world')
+      pinomsTen.debug('hello world')
+      pinomsTen.trace('hello world')
+      pinomsTen.warn('hello world')
+      pinomsTen.fatal('hello world')
+    }
+    setImmediate(cb)
+  },
+  function benchBunyanFour (cb) {
+    for (let i = 0; i < max; i++) {
+      blogFour.info('hello world')
+      blogFour.debug('hello world')
+      blogFour.trace('hello world')
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMSFour (cb) {
+    for (let i = 0; i < max; i++) {
+      pinomsFour.info('hello world')
+      pinomsFour.debug('hello world')
+      pinomsFour.trace('hello world')
+    }
+    setImmediate(cb)
+  },
+  function benchBunyanOne (cb) {
+    for (let i = 0; i < max; i++) {
+      blogOne.info('hello world')
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMSOne (cb) {
+    for (let i = 0; i < max; i++) {
+      pinomsOne.info('hello world')
+    }
+    setImmediate(cb)
+  }
+], 10000)
+
+run()

package/benchmarks/object.bench.js

@@ -0,0 +1,82 @@
+'use strict'
+
+const bench = require('fastbench')
+const pino = require('../')
+const bunyan = require('bunyan')
+const bole = require('bole')('bench')
+const winston = require('winston')
+const fs = require('node:fs')
+const dest = fs.createWriteStream('/dev/null')
+const loglevel = require('./utils/wrap-log-level')(dest)
+const plogNodeStream = pino(dest)
+delete require.cache[require.resolve('../')]
+const plogDest = require('../')(pino.destination('/dev/null'))
+delete require.cache[require.resolve('../')]
+const plogMinLength = require('../')(pino.destination({ dest: '/dev/null', sync: false, minLength: 4096 }))
+const blog = bunyan.createLogger({
+  name: 'myapp',
+  streams: [{
+    level: 'trace',
+    stream: dest
+  }]
+})
+require('bole').output({
+  level: 'info',
+  stream: dest
+}).setFastTime(true)
+const chill = winston.createLogger({
+  transports: [
+    new winston.transports.Stream({
+      stream: fs.createWriteStream('/dev/null')
+    })
+  ]
+})
+
+const max = 10
+
+const run = bench([
+  function benchBunyanObj (cb) {
+    for (var i = 0; i < max; i++) {
+      blog.info({ hello: 'world' })
+    }
+    setImmediate(cb)
+  },
+  function benchWinstonObj (cb) {
+    for (var i = 0; i < max; i++) {
+      chill.info({ hello: 'world' })
+    }
+    setImmediate(cb)
+  },
+  function benchBoleObj (cb) {
+    for (var i = 0; i < max; i++) {
+      bole.info({ hello: 'world' })
+    }
+    setImmediate(cb)
+  },
+  function benchLogLevelObject (cb) {
+    for (var i = 0; i < max; i++) {
+      loglevel.info({ hello: 'world' })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoObj (cb) {
+    for (var i = 0; i < max; i++) {
+      plogDest.info({ hello: 'world' })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoMinLengthObj (cb) {
+    for (var i = 0; i < max; i++) {
+      plogMinLength.info({ hello: 'world' })
+    }
+    setImmediate(cb)
+  },
+  function benchPinoNodeStreamObj (cb) {
+    for (var i = 0; i < max; i++) {
+      plogNodeStream.info({ hello: 'world' })
+    }
+    setImmediate(cb)
+  }
+], 10000)
+
+run(run)

package/benchmarks/utils/generate-benchmark-doc.js

@@ -0,0 +1,36 @@
+'use strict'
+const { join } = require('node:path')
+const { execSync } = require('node:child_process')
+
+const run = (type) => {
+  process.stderr.write(`benchmarking ${type}\n`)
+  return execSync(`node ${join(__dirname, 'runbench')} ${type} -q`)
+}
+
+console.log(`
+# Benchmarks
+
+\`pino.info('hello world')\`:
+
+\`\`\`
+${run('basic')}
+\`\`\`
+
+\`pino.info({'hello': 'world'})\`:
+
+\`\`\`
+${run('object')}
+\`\`\`
+
+\`pino.info(aBigDeeplyNestedObject)\`:
+
+\`\`\`
+${run('deep-object')}
+\`\`\`
+
+\`pino.info('hello %s %j %d', 'world', {obj: true}, 4, {another: 'obj'})\`:
+
+For a fair comparison, [LogLevel](http://npm.im/loglevel) was extended
+to include a timestamp and [bole](http://npm.im/bole) had
+\`fastTime\` mode switched on.
+`)