fix(caller): use calling file name for libraries calling Pino (#1276)

* fix(caller): use calling file name for libraries calling Pino

* fix(caller): handle case where stacktrace contains node:internal entries

* fix: add node_modules in fixtures to gitignore

* refactor(caller): merge two functions

Author: FredericEspiau

.gitignore

@@ -55,3 +55,5 @@ profile-*
 # lock files
 yarn.lock
 package-lock.json
+
+!test/fixtures/eval/node_modules

lib/caller.js

@@ -1,9 +1,15 @@
 'use strict'
 
+const fs = require('fs')
+
 function noOpPrepareStackTrace (_, stack) {
   return stack
 }
 
+function isOutsideNodeModules (input) {
+  return typeof input === 'string' && fs.existsSync(input) && input.indexOf('node_modules') === -1
+}
+
 module.exports = function getCaller () {
   const originalPrepare = Error.prepareStackTrace
   Error.prepareStackTrace = noOpPrepareStackTrace
@@ -14,11 +20,15 @@ module.exports = function getCaller () {
     return undefined
   }
 
-  for (const entry of stack.slice(2)) {
+  const entries = stack.slice(2)
+
+  for (const entry of entries) {
     const file = entry ? entry.getFileName() : undefined
 
-    if (file && file.indexOf('node_modules') === -1) {
+    if (isOutsideNodeModules(file)) {
       return file
     }
   }
+
+  return entries[0] ? entries[0].getFileName() : undefined
 }

test/fixtures/eval.js test/fixtures/eval/index.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-eval */
 
 eval(`
-const pino = require('../../')
+const pino = require('../../../')
 
 const logger = pino(
   pino.transport({

test/fixtures/eval/node_modules/14-files.js

@@ -7,8 +7,38 @@ const execa = require('execa')
 
 const { once } = require('../helper')
 
-test('app using a custom transport', async function (t) {
-  const evalApp = join(__dirname, '../', '/fixtures/eval')
+test('when using a custom transport outside node_modules, the first file outside node_modules should be used', async function (t) {
+  const evalApp = join(__dirname, '../', '/fixtures/eval/index.js')
+  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!/)
+})
+
+test('when using a custom transport where some files in stacktrace are in the node_modules, the first file outside node_modules should be used', async function (t) {
+  const evalApp = join(__dirname, '../', '/fixtures/eval/node_modules/2-files.js')
+  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!/)
+})
+
+test('when using a custom transport where all files in stacktrace are in the node_modules, the first file inside node_modules should be used', async function (t) {
+  const evalApp = join(__dirname, '../', '/fixtures/eval/node_modules/14-files.js')
   const child = execa(process.argv[0], [evalApp])
 
   let actual = ''