@platformatic/wattpm-pprof-capture 3.54.0 → 3.56.0

package/index.js

@@ -1,10 +1,24 @@
-import { time, heap, SourceMapper } from '@datadog/pprof'
+import { heap, SourceMapper, time } from '@datadog/pprof'
+import { getITC, getLogger } from '@platformatic/globals'
 import { performance } from 'node:perf_hooks'
 import { workerData } from 'node:worker_threads'
 import { NoProfileAvailableError, NotEnoughELUError, ProfilingAlreadyStartedError, ProfilingNotStartedError } from './lib/errors.js'
 import { SourceMapperWrapper } from './lib/source-mapper-wrapper.js'
 
-const kITC = Symbol.for('plt.runtime.itc')
+// @datadog/pprof >= 5.14.2 introduced a regression in the legacy time profiler
+// `stop()`: it now clears the internal source mapper (via handleStopNoRestart)
+// *before* serializing the profile, so transpiled frames (e.g. TypeScript) are
+// no longer mapped back to their original `.ts` sources. The `stopV2()` entry
+// point serializes the profile while the source mapper is still set — the
+// behaviour `stop()` had in earlier versions. It is not re-exported on the
+// public `time` facade, so resolve it from the internal module when available
+// and fall back to the public `stop()` otherwise (e.g. older versions).
+let stopTimeProfilerV2 = null
+try {
+  ;({ stopV2: stopTimeProfilerV2 } = await import('@datadog/pprof/out/src/time-profiler.js'))
+} catch {
+  // Internal module path not available; fall back to the public stop().
+}
 
 // SourceMapper for resolving transpiled code locations back to original source
 let sourceMapper = null
@@ -55,14 +69,15 @@ const profilingState = {
 }
 
 // Keep trying until ITC is available. This is needed because preloads run
-// before the app thread initialization, so globalThis.platformatic.messaging
-// and ITC don't exist yet.
+// before the app thread initialization, so messaging and ITC don't exist yet.
 const registerInterval = setInterval(() => {
-  if (globalThis[kITC]) {
-    globalThis[kITC].handle('getLastProfile', getLastProfile)
-    globalThis[kITC].handle('startProfiling', startProfiling)
-    globalThis[kITC].handle('stopProfiling', stopProfiling)
-    globalThis[kITC].handle('getProfilingState', getProfilingState)
+  const itc = getITC({ throwOnMissing: false })
+
+  if (itc) {
+    itc.handle('getLastProfile', getLastProfile)
+    itc.handle('startProfiling', startProfiling)
+    itc.handle('stopProfiling', stopProfiling)
+    itc.handle('getProfilingState', getProfilingState)
     clearInterval(registerInterval)
   }
 }, 10)
@@ -159,9 +174,11 @@ function stopProfiler (type, state) {
     state.latestProfile = (state.sourceMapsEnabled && sourceMapper) ? profiler.profile(undefined, sourceMapper) : profiler.profile()
     profiler.stop()
   } else {
-    // CPU time profiler returns the profile when stopping
-    // sourceMapper was already passed to start(), so it's applied automatically
-    state.latestProfile = profiler.stop()
+    // CPU time profiler returns the profile when stopping.
+    // sourceMapper was already passed to start(), so it's applied automatically.
+    // Use stopV2() when available so the source mapper is honoured during
+    // serialization (see the note next to stopTimeProfilerV2 above).
+    state.latestProfile = stopTimeProfilerV2 ? stopTimeProfilerV2() : profiler.stop()
   }
 }
 
@@ -211,18 +228,19 @@ function startIfOverThreshold (type, state, wasRunning = state.profilerStarted)
     // Was not running: only start if ELU rises above start threshold
     : isAboveThreshold(state)
 
+  const logger = getLogger({ throwOnMissing: false })
   if (shouldRun) {
     // ELU is high enough, start/restart profiling
-    if (!wasRunning && !state.profilerStarted && globalThis.platformatic?.logger) {
-      globalThis.platformatic.logger.debug(
+    if (!wasRunning && !state.profilerStarted && logger) {
+      logger.debug(
         { type, eluThreshold: state.eluThreshold, currentELU },
         'Starting profiler due to ELU threshold exceeded'
       )
     }
     startProfiler(type, state, state.options)
-  } else if (!shouldRun && wasRunning && globalThis.platformatic?.logger && state.eluThreshold != null) {
+  } else if (!shouldRun && wasRunning && state.eluThreshold != null && logger) {
     // Log when deciding not to restart after stopping (only in rotation context)
-    globalThis.platformatic.logger.debug(
+    logger.debug(
       { type, eluThreshold: state.eluThreshold, currentELU },
       'Pausing profiler due to ELU below threshold'
     )
@@ -240,8 +258,9 @@ async function initializeSourceMapper (options = {}) {
     // Get the application directory from workerData
     const appPath = workerData?.applicationConfig?.path
     if (!appPath) {
-      if (globalThis.platformatic?.logger) {
-        globalThis.platformatic.logger.debug('No application path available for sourcemap resolution')
+      const logger = getLogger({ throwOnMissing: false })
+      if (logger) {
+        logger.debug('No application path available for sourcemap resolution')
       }
       return
     }
@@ -267,16 +286,18 @@ async function initializeSourceMapper (options = {}) {
     // Wrap the SourceMapper to fix Windows path normalization
     sourceMapper = new SourceMapperWrapper(innerMapper)
 
-    if (globalThis.platformatic?.logger) {
+    const logger = getLogger({ throwOnMissing: false })
+    if (logger) {
       const hasMappings = sourceMapper && typeof sourceMapper.hasMappingInfo === 'function'
-      globalThis.platformatic.logger.info(
+      logger.info(
         { appPath, hasSourceMapper: !!sourceMapper, hasMappingInfo: hasMappings },
         'SourceMapper initialized for profiling'
       )
     }
   } catch (err) {
-    if (globalThis.platformatic?.logger) {
-      globalThis.platformatic.logger.warn(
+    const logger = getLogger({ throwOnMissing: false })
+    if (logger) {
+      logger.warn(
         { err: err.message, stack: err.stack },
         'Failed to initialize SourceMapper'
       )

package/lib/node-modules-sourcemaps.js

@@ -1,3 +1,4 @@
+import { getLogger } from '@platformatic/globals'
 import { promises as fs } from 'node:fs'
 import path from 'node:path'
 import { createRequire } from 'node:module'
@@ -184,7 +185,7 @@ function resolveModulePath (appPath, moduleName) {
  */
 export async function loadNodeModulesSourceMaps (appPath, moduleNames, debug = false) {
   const entries = new Map()
-  const logger = globalThis.platformatic?.logger
+  const logger = getLogger({ throwOnMissing: false })
 
   if (debug && logger) {
     logger.debug({ appPath, moduleNames }, 'Loading source maps from node_modules')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/wattpm-pprof-capture",
-  "version": "3.54.0",
+  "version": "3.56.0",
   "description": "pprof profiling capture for wattpm",
   "main": "index.js",
   "type": "module",
@@ -17,7 +17,8 @@
   "dependencies": {
     "@datadog/pprof": "^5.3.0",
     "@fastify/error": "^4.0.0",
-    "undici": "^7.0.0"
+    "undici": "^7.27.2",
+    "@platformatic/globals": "3.56.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",
@@ -26,8 +27,8 @@
     "neostandard": "^0.12.0",
     "pprof-format": "^2.1.0",
     "typescript": "^5.0.0",
-    "@platformatic/service": "3.54.0",
-    "@platformatic/foundation": "3.54.0"
+    "@platformatic/service": "3.56.0",
+    "@platformatic/foundation": "3.56.0"
   },
   "engines": {
     "node": ">=22.19.0"