fix(core): getCallerInfo() for nodejs v20/23

Author: waitingsong

packages/core/src/lib/callstack/util.ts

@@ -34,6 +34,8 @@ const initInfo: CallerInfo = {
 
 const nodeVersion = semver.coerce(process.version)
 const isNodeGteV20 = nodeVersion ? semver.gte(nodeVersion, '20.0.0') : false
+const isNodeGteV22 = nodeVersion ? semver.gte(nodeVersion, '22.9.0') : false
+const isNodeGteV23 = nodeVersion ? semver.gte(nodeVersion, '23.3.0') : false
 
 /**
  * Nodejs execution options
@@ -123,41 +125,31 @@ interface CallerInfoOrigin {
  */
 export function getCallerInfo(callerDistance = 0): CallerInfo {
   const depth = callerDistance + 1
-  let ret: CallerInfo = {
+  let info22: CallerInfo = {
     ...initInfo,
   }
-
   // @link https://github.com/nodejs/node/releases/tag/v22.9.0
   // @ts-ignore since node v22.9
   if (typeof util.getCallSite === 'function') {
-    // @ts-ignore
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
-    const callSites: CallerInfoOrigin[] = util.getCallSite(depth + 1)
-    const site = callSites[depth]
-    assert(site, 'stack empty')
-    ret = {
-      ...ret,
-      path: site.scriptName,
-      fileName: site.scriptName,
-      className: '',
-      funcName: site.functionName,
-      methodName: '',
-      lineNumber: site.lineNumber,
-      columnNumber: site.column,
-      enclosingLineNumber: -1,
-      enclosingColNumber: -1,
-    }
+    info22 = getCallSiteNative(depth, true)
   }
 
   const stacks = getStackCallerSites(depth + 5)
-  const site = pickSite(stacks.slice(depth - 1), ret)
+  let site = stacks[depth]
   assert(site, 'stack empty')
+  const fileName = site.getFileName() ?? ''
+  let funcName = site.getFunctionName() ?? ''
 
-  const funcName = site.getFunctionName() ?? ''
+  if (isNodeGteV22 && (fileName !== info22.path || funcName !== info22.funcName)) {
+    const infoWoSourceMap = isNodeGteV23 ? getCallSiteNative(depth, false) : info22
+    site = pickSite(stacks.slice(depth - 1), infoWoSourceMap)
+    assert(site, 'stack empty after pickSite')
+  }
+
+  funcName = site.getFunctionName() ?? ''
   const methodName = site.getMethodName() ?? ''
   const typeName = site.getTypeName() ?? ''
   const line = site.toString()
-
   let className = typeName
   if (! className) {
     className = methodName
@@ -169,11 +161,68 @@ export function getCallerInfo(callerDistance = 0): CallerInfo {
         : ''
     }
   }
-  ret.className = className
-  ret.methodName = methodName
+  if (info22.path) {
+    info22.className = className
+    info22.methodName = methodName
+    if (! info22.methodName) {
+      info22.methodName = info22.funcName
+    }
+    return info22
+  }
+
+  const fileLine = site.getFileName()
+  const info: CallerInfo = {
+    ...initInfo,
+    path: fileLine ?? '',
+    fileName: site.getFileName() ?? '',
+    className,
+    funcName,
+    methodName,
+    lineNumber: site.getLineNumber() ?? 0,
+    columnNumber: site.getColumnNumber() ?? 0,
+  }
+  const ret = {
+    ...info22,
+    ...info,
+  }
   if (! ret.methodName) {
     ret.methodName = ret.funcName
   }
+  return ret
+}
+
+/**
+ *
+ * @param sourceMap since node v23.3
+ * @returns
+ */
+function getCallSiteNative(distance: number, sourceMap: boolean): CallerInfo {
+  const depth = distance + 1
+  const ret: CallerInfo = {
+    ...initInfo,
+  }
+  const depth2 = isNodeGteV23 ? depth + 2 : depth + 1
+  const depth3 = isNodeGteV23 ? depth + 1 : depth
+
+  // @ts-ignore
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
+  const callSites: CallerInfoOrigin[] = util.getCallSite(depth2, { sourceMap })
+  const site = callSites[depth3]
+  assert(site, 'stack empty')
+  ret.path = site.scriptName
+  ret.fileName = site.scriptName
+  ret.funcName = site.functionName
+  ret.lineNumber = site.lineNumber
+  ret.columnNumber = site.column
+
+  if (sourceMap && ! ret.funcName) {
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
+    const callSites2: CallerInfoOrigin[] = util.getCallSite(depth2, { sourceMap: false })
+    const site2 = callSites2[depth3]
+    assert(site2, 'stack2 empty')
+    ret.funcName = site2.functionName
+  }
 
   return ret
 }

packages/core/test/callstack/33.caller-stack.test.ts

@@ -4,6 +4,7 @@ import { pathToFileURL } from 'node:url'
 
 import { fileShortPath, genCurrentDirname, genCurrentFilename, getCallerStack } from '@waiting/shared-core'
 
+import { isNodeGteV23 } from '#@/root.config.js'
 
 import { fake1, fake2, test1, test2, test3, test4, test5 } from './call-config.js'
 
@@ -17,16 +18,13 @@ const pathUrl = pathToFileURL(tmpFile)
 const path1 = pathUrl.href
 
 describe(fileShortPath(import.meta.url), () => {
-
   describe('Should demo1 work', () => {
     it('test1()', () => {
       const info = test1()
       console.log({ info })
       assert(info.path === path1, `expect path: "${path1}", but got: "${info.path}"`)
       assert(info.line === 6, `expect line: "6", but got: "${info.line}"`)
       assert(info.column === 22, `expect column: "22", but got: "${info.column}"`)
-      assert(info.columnNumber === 24, `expect columnNumber: "24", but got: "${info.columnNumber}"`)
-      // assert(info.enclosingColNumber === 8, `expect enclosingColNumber: "8", but got: "${info.enclosingColNumber}"`)
     })
     it('test2()', () => {
       const info = test2()

packages/core/test/callstack/34.util.getCallerInfo.test.ts

@@ -2,6 +2,7 @@ import assert from 'node:assert'
 
 import { getCallerInfo } from '##/index.js'
 import { fileShortPath } from '##/lib/helper.js'
+import { isNodeGteV23 } from '#@/root.config.js'
 
 import { demo } from './34.demo1.js'
 import { demo2 } from './34.demo2.js'
@@ -10,6 +11,7 @@ import { _demo, validateInfo } from './34a.config.js'
 
 describe(fileShortPath(import.meta.url), () => {
 
+
   describe('getCallerInfo() ', () => {
     it('distance: 0', () => {
       const info = getCallerInfo(0)
@@ -18,15 +20,21 @@ describe(fileShortPath(import.meta.url), () => {
     })
 
     it('distance: 1', () => {
-      const info = _demo()
+      const info = _demo() // line23
       validateInfo(info, import.meta.url)
       assert(info.line === -1, JSON.stringify(info, null, 2))
       assert(info.column === -1, JSON.stringify(info, null, 2))
       assert(info.funcName === '', JSON.stringify(info, null, 2))
       assert(info.methodName === '', JSON.stringify(info, null, 2))
       assert(info.className === 'Context', JSON.stringify(info, null, 2))
-      assert(info.lineNumber === 15, JSON.stringify(info, null, 2))
-      assert(info.columnNumber === 26, JSON.stringify(info, null, 2))
+      if (isNodeGteV23) {
+        assert(info.lineNumber === 23, JSON.stringify(info, null, 2))
+        assert(info.columnNumber === 20, JSON.stringify(info, null, 2))
+      }
+      else {
+        assert(info.lineNumber === 16, JSON.stringify(info, null, 2))
+        assert(info.columnNumber === 26, JSON.stringify(info, null, 2))
+      }
     })
 
     it('demo', () => {
@@ -37,24 +45,37 @@ describe(fileShortPath(import.meta.url), () => {
       assert(info.funcName === '', JSON.stringify(info, null, 2))
       assert(info.methodName === '', JSON.stringify(info, null, 2))
       assert(info.className === 'Context', JSON.stringify(info, null, 2))
-      assert(info.lineNumber === 26, JSON.stringify(info, null, 2))
-      assert(info.columnNumber === 26, JSON.stringify(info, null, 2))
+      if (isNodeGteV23) {
+        assert(info.lineNumber === 41, JSON.stringify(info, null, 2))
+        assert(info.columnNumber === 20, JSON.stringify(info, null, 2))
+      }
+      else {
+        assert(info.lineNumber === 33, JSON.stringify(info, null, 2))
+        assert(info.columnNumber === 26, JSON.stringify(info, null, 2))
+
+      }
     })
 
-    it('demo2', case22) // line44
+    it('demo2', case22)
 
   })
 })
 
 function case22(): void {
-  const info = demo2()
+  const info = demo2() // line65
   validateInfo(info, 'test/callstack/34.util.getCallerInfo.test.ts')
   assert(info.line === -1, JSON.stringify(info, null, 2))
   assert(info.column === -1, JSON.stringify(info, null, 2))
   assert(info.funcName === 'case22', JSON.stringify(info, null, 2))
   assert(info.methodName === 'case22', JSON.stringify(info, null, 2))
   assert(info.className === 'Context', JSON.stringify(info, null, 2))
-  assert(info.lineNumber === 40, JSON.stringify(info, null, 2))
-  assert(info.columnNumber === 18, JSON.stringify(info, null, 2))
+  if (isNodeGteV23) {
+    assert(info.lineNumber === 65, JSON.stringify(info, null, 2))
+    assert(info.columnNumber === 16, JSON.stringify(info, null, 2))
+  }
+  else {
+    assert(info.lineNumber === 53, JSON.stringify(info, null, 2))
+    assert(info.columnNumber === 18, JSON.stringify(info, null, 2))
+  }
 }
 

packages/core/test/callstack/35.util.getCallerInfo.class.test.ts

@@ -2,6 +2,7 @@ import assert from 'node:assert'
 
 import { getCallerInfo } from '##/index.js'
 import { fileShortPath } from '##/lib/helper.js'
+import { isNodeGteV23 } from '#@/root.config.js'
 
 import { Foo, _demo, validateInfo } from './34a.config.js'
 
@@ -16,8 +17,14 @@ describe(fileShortPath(import.meta.url), () => {
       assert(info.className === 'Foo', `expect Foo, but got ${info.className}`)
       assert(info.funcName === 'foo', `expect foo, but got ${info.funcName}`)
       assert(info.srcPath === '', `expect blank, but got ${info.srcPath}`)
-      assert(info.columnNumber === 16, `expect 16, but got ${info.columnNumber}`)
-      assert(info.lineNumber === 10, `expect 10, but got ${info.lineNumber}`)
+      if (isNodeGteV23) {
+        assert(info.columnNumber === 12, `expect 12, but got ${info.columnNumber}`)
+        assert(info.lineNumber === 16, `expect 16, but got ${info.lineNumber}`)
+      }
+      else {
+        assert(info.columnNumber === 16, `expect 16, but got ${info.columnNumber}`)
+        assert(info.lineNumber === 10, `expect 10, but got ${info.lineNumber}`)
+      }
     })
 
     it('distance: 1', () => {
@@ -27,8 +34,14 @@ describe(fileShortPath(import.meta.url), () => {
       assert(info.className === 'Foo', `expect Foo, but got ${info.className}`)
       assert(info.funcName === 'barz', `expect foo, but got ${info.funcName}`)
       assert(info.srcPath === '', `expect blank, but got ${info.srcPath}`)
-      assert(info.columnNumber === 21, `expect 21, but got ${info.columnNumber}`)
-      assert(info.lineNumber === 16, `expect 16, but got ${info.lineNumber}`)
+      if (isNodeGteV23) {
+        assert(info.columnNumber === 17, `expect 17, but got ${info.columnNumber}`)
+        assert(info.lineNumber === 24, `expect 24, but got ${info.lineNumber}`)
+      }
+      else {
+        assert(info.columnNumber === 21, `expect 21, but got ${info.columnNumber}`)
+        assert(info.lineNumber === 16, `expect 16, but got ${info.lineNumber}`)
+      }
     })
   })
 })

packages/core/test/root.config.ts

@@ -1,6 +1,7 @@
 import { join } from 'node:path'
 
 import { genCurrentDirname } from '@waiting/shared-core'
+import semver from 'semver'
 
 
 export const testDir = genCurrentDirname(import.meta.url)
@@ -31,3 +32,9 @@ export const testConfig = {
   TEST,
 } as TestConfig
 
+
+const nodeVersion = semver.coerce(process.version)
+export const isNodeGteV20 = nodeVersion ? semver.gte(nodeVersion, '20.0.0') : false
+export const isNodeGteV22 = nodeVersion ? semver.gte(nodeVersion, '22.9.0') : false
+export const isNodeGteV23 = nodeVersion ? semver.gte(nodeVersion, '23.3.0') : false
+