fix: improved caller detection (#1267)

* feat: Improve caller detection.

* fix: Use strict mode.

Co-authored-by: Matteo Collina <matteo.collina@gmail.com>

* fix: Removed unused dependency.

* wip: adding integration test

* add tests

* add eval test

Co-authored-by: Shogun <ShogunPanda@users.noreply.github.com>
Co-authored-by: Matteo Collina <matteo.collina@gmail.com>

Author: 3 people

lib/caller.js

@@ -0,0 +1,24 @@
+'use strict'
+
+function noOpPrepareStackTrace (_, stack) {
+  return stack
+}
+
+module.exports = function getCaller () {
+  const originalPrepare = Error.prepareStackTrace
+  Error.prepareStackTrace = noOpPrepareStackTrace
+  const stack = new Error().stack
+  Error.prepareStackTrace = originalPrepare
+
+  if (!Array.isArray(stack)) {
+    return undefined
+  }
+
+  for (const entry of stack.slice(2)) {
+    const file = entry ? entry.getFileName() : undefined
+
+    if (file && file.indexOf('node_modules') === -1) {
+      return file
+    }
+  }
+}

lib/transport.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { createRequire } = require('module')
-const getCaller = require('get-caller-file')
+const getCaller = require('./caller')
 const { join, isAbsolute } = require('path')
 
 let onExit

package.json

@@ -104,7 +104,6 @@
   "dependencies": {
     "fast-redact": "^3.0.0",
     "fastify-warning": "^0.2.0",
-    "get-caller-file": "^2.0.5",
     "on-exit-leak-free": "^0.2.0",
     "pino-abstract-transport": "v0.5.0",
     "pino-std-serializers": "^4.0.0",

pino.js

@@ -2,7 +2,7 @@
 /* eslint no-prototype-builtins: 0 */
 const os = require('os')
 const stdSerializers = require('pino-std-serializers')
-const caller = require('get-caller-file')
+const caller = require('./lib/caller')
 const redaction = require('./lib/redaction')
 const time = require('./lib/time')
 const proto = require('./lib/proto')

test/fixtures/eval.js

@@ -0,0 +1,13 @@
+/* eslint-disable no-eval */
+
+eval(`
+const pino = require('../../')
+
+const logger = pino(
+  pino.transport({
+    target: 'pino-pretty'
+  })
+)
+
+logger.info('done!')
+`)

test/transport/caller.test.js

@@ -0,0 +1,23 @@
+'use strict'
+
+const writer = require('flush-write-stream')
+const { join } = require('path')
+const { test } = require('tap')
+const execa = require('execa')
+
+const { once } = require('../helper')
+
+test('app using a custom transport', async function (t) {
+  const evalApp = join(__dirname, '../', '/fixtures/eval')
+  const child = execa(process.argv[0], [evalApp])
+
+  let actual = ''
+  child.stdout.pipe(writer((s, enc, cb) => {
+    actual += s
+    cb()
+  }))
+
+  await once(child, 'close')
+
+  t.match(actual, /done!/)
+})