@sentry/profiling-node 8.54.0 → 9.0.0-alpha.1

package/lib/esm/index.js

@@ -1,16 +1,8 @@
-import { _nullishCoalesce, _optionalChain, _optionalChainDelete } from '@sentry/core';
-import { logger, GLOBAL_OBJ, parseSemver, forEachEnvelopeItem, createEnvelope, getDebugImagesForResources, uuid4, dsnToString, spanIsSampled, spanToJSON, LRUMap, defineIntegration, consoleSandbox, getRootSpan, getIsolationScope, getCurrentScope, getGlobalScope } from '@sentry/core';
-import { createRequire } from 'node:module';
-import { platform as platform$1, arch as arch$1 } from 'node:os';
-import { dirname, join, resolve } from 'node:path';
-import { versions, env } from 'node:process';
-import { pathToFileURL, fileURLToPath } from 'node:url';
-import { threadId } from 'node:worker_threads';
-import { familySync } from 'detect-libc';
-import { getAbi } from 'node-abi';
+import { CpuProfilerBindings } from '@sentry-internal/node-cpu-profiler';
+import { parseSemver, logger, forEachEnvelopeItem, createEnvelope, getDebugImagesForResources, uuid4, dsnToString, spanIsSampled, spanToJSON, LRUMap, defineIntegration, consoleSandbox, getRootSpan, getIsolationScope, getCurrentScope, getGlobalScope } from '@sentry/core';
 import * as os from 'os';
-import { versions as versions$1, env as env$1 } from 'process';
-import { threadId as threadId$1, isMainThread } from 'worker_threads';
+import { versions, env } from 'process';
+import { threadId, isMainThread } from 'worker_threads';
 
 /**
  * This serves as a build time flag that will be true by default, but false in non-debug builds or if users replace `__SENTRY_DEBUG__` in their generated code.
@@ -19,225 +11,22 @@ import { threadId as threadId$1, isMainThread } from 'worker_threads';
  */
 const DEBUG_BUILD = (typeof __SENTRY_DEBUG__ === 'undefined' || __SENTRY_DEBUG__);
 
-const stdlib = familySync();
-const platform = process.env['BUILD_PLATFORM'] || platform$1();
-const arch = process.env['BUILD_ARCH'] || arch$1();
-const abi = getAbi(versions.node, 'node');
-const identifier = [platform, arch, stdlib, abi].filter(c => c !== undefined && c !== null).join('-');
-
-/**
- *  Imports cpp bindings based on the current platform and architecture.
- */
-// eslint-disable-next-line complexity
-function importCppBindingsModule() {
-  // We need to work around using import.meta.url directly with import.meta.url because jest complains about it.
-  const importMetaUrl =
-    typeof import.meta.url !== 'undefined'
-      ? // This case is always hit when the SDK is built
-        import.meta.url
-      : // This case is hit when the tests are run
-        pathToFileURL(__filename).href;
-
-  const createdRequire = createRequire(importMetaUrl);
-  const esmCompatibleDirname = dirname(fileURLToPath(importMetaUrl));
-
-  // If a binary path is specified, use that.
-  if (env['SENTRY_PROFILER_BINARY_PATH']) {
-    const envPath = env['SENTRY_PROFILER_BINARY_PATH'];
-    return createdRequire(envPath);
-  }
-
-  // If a user specifies a different binary dir, they are in control of the binaries being moved there
-  if (env['SENTRY_PROFILER_BINARY_DIR']) {
-    const binaryPath = join(resolve(env['SENTRY_PROFILER_BINARY_DIR']), `sentry_cpu_profiler-${identifier}`);
-    return createdRequire(`${binaryPath}.node`);
-  }
-
-  // We need the fallthrough so that in the end, we can fallback to the dynamic require.
-  // This is for cases where precompiled binaries were not provided, but may have been compiled from source.
-  if (platform === 'darwin') {
-    if (arch === 'x64') {
-      if (abi === '93') {
-        return createdRequire('../sentry_cpu_profiler-darwin-x64-93.node');
-      }
-      if (abi === '108') {
-        return createdRequire('../sentry_cpu_profiler-darwin-x64-108.node');
-      }
-      if (abi === '115') {
-        return createdRequire('../sentry_cpu_profiler-darwin-x64-115.node');
-      }
-      if (abi === '127') {
-        return createdRequire('../sentry_cpu_profiler-darwin-x64-127.node');
-      }
-    }
-
-    if (arch === 'arm64') {
-      if (abi === '93') {
-        return createdRequire('../sentry_cpu_profiler-darwin-arm64-93.node');
-      }
-      if (abi === '108') {
-        return createdRequire('../sentry_cpu_profiler-darwin-arm64-108.node');
-      }
-      if (abi === '115') {
-        return createdRequire('../sentry_cpu_profiler-darwin-arm64-115.node');
-      }
-      if (abi === '127') {
-        return createdRequire('../sentry_cpu_profiler-darwin-arm64-127.node');
-      }
-    }
-  }
-
-  if (platform === 'win32') {
-    if (arch === 'x64') {
-      if (abi === '93') {
-        return createdRequire('../sentry_cpu_profiler-win32-x64-93.node');
-      }
-      if (abi === '108') {
-        return createdRequire('../sentry_cpu_profiler-win32-x64-108.node');
-      }
-      if (abi === '115') {
-        return createdRequire('../sentry_cpu_profiler-win32-x64-115.node');
-      }
-      if (abi === '127') {
-        return createdRequire('../sentry_cpu_profiler-win32-x64-127.node');
-      }
-    }
-  }
-
-  if (platform === 'linux') {
-    if (arch === 'x64') {
-      if (stdlib === 'musl') {
-        if (abi === '93') {
-          return createdRequire('../sentry_cpu_profiler-linux-x64-musl-93.node');
-        }
-        if (abi === '108') {
-          return createdRequire('../sentry_cpu_profiler-linux-x64-musl-108.node');
-        }
-        if (abi === '115') {
-          return createdRequire('../sentry_cpu_profiler-linux-x64-musl-115.node');
-        }
-        if (abi === '127') {
-          return createdRequire('../sentry_cpu_profiler-linux-x64-musl-127.node');
-        }
-      }
-      if (stdlib === 'glibc') {
-        if (abi === '93') {
-          return createdRequire('../sentry_cpu_profiler-linux-x64-glibc-93.node');
-        }
-        if (abi === '108') {
-          return createdRequire('../sentry_cpu_profiler-linux-x64-glibc-108.node');
-        }
-        if (abi === '115') {
-          return createdRequire('../sentry_cpu_profiler-linux-x64-glibc-115.node');
-        }
-        if (abi === '127') {
-          return createdRequire('../sentry_cpu_profiler-linux-x64-glibc-127.node');
-        }
-      }
-    }
-    if (arch === 'arm64') {
-      if (stdlib === 'musl') {
-        if (abi === '93') {
-          return createdRequire('../sentry_cpu_profiler-linux-arm64-musl-93.node');
-        }
-        if (abi === '108') {
-          return createdRequire('../sentry_cpu_profiler-linux-arm64-musl-108.node');
-        }
-        if (abi === '115') {
-          return createdRequire('../sentry_cpu_profiler-linux-arm64-musl-115.node');
-        }
-        if (abi === '127') {
-          return createdRequire('../sentry_cpu_profiler-linux-arm64-musl-127.node');
-        }
-      }
-
-      if (stdlib === 'glibc') {
-        if (abi === '93') {
-          return createdRequire('../sentry_cpu_profiler-linux-arm64-glibc-93.node');
-        }
-        if (abi === '108') {
-          return createdRequire('../sentry_cpu_profiler-linux-arm64-glibc-108.node');
-        }
-        if (abi === '115') {
-          return createdRequire('../sentry_cpu_profiler-linux-arm64-glibc-115.node');
-        }
-        if (abi === '127') {
-          return createdRequire('../sentry_cpu_profiler-linux-arm64-glibc-127.node');
-        }
-      }
-    }
-  }
-
-  const built_from_source_path = resolve(esmCompatibleDirname, '..', `sentry_cpu_profiler-${identifier}`);
-  return createdRequire(`${built_from_source_path}.node`);
-}
-
-const PrivateCpuProfilerBindings = importCppBindingsModule();
-
-class Bindings  {
-   startProfiling(name) {
-    if (!PrivateCpuProfilerBindings) {
-      DEBUG_BUILD && logger.log('[Profiling] Bindings not loaded, ignoring call to startProfiling.');
-      return;
-    }
-
-    if (typeof PrivateCpuProfilerBindings.startProfiling !== 'function') {
-      DEBUG_BUILD &&
-        logger.log('[Profiling] Native startProfiling function is not available, ignoring call to startProfiling.');
-      return;
-    }
-
-    return PrivateCpuProfilerBindings.startProfiling(name);
-  }
-
-   stopProfiling(
-    name,
-    format,
-  ) {
-    if (!PrivateCpuProfilerBindings) {
-      DEBUG_BUILD &&
-        logger.log('[Profiling] Bindings not loaded or profile was never started, ignoring call to stopProfiling.');
-      return null;
-    }
-
-    if (typeof PrivateCpuProfilerBindings.stopProfiling !== 'function') {
-      DEBUG_BUILD &&
-        logger.log('[Profiling] Native stopProfiling function is not available, ignoring call to stopProfiling.');
-      return null;
-    }
-
-    return PrivateCpuProfilerBindings.stopProfiling(
-      name,
-      format ,
-      threadId,
-      !!GLOBAL_OBJ._sentryDebugIds,
-    );
-  }
-}
-
-const CpuProfilerBindings = new Bindings();
-
 const NODE_VERSION = parseSemver(process.versions.node) ;
 const NODE_MAJOR = NODE_VERSION.major;
 
-function _nullishCoalesce$1(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }function _optionalChain$1(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
 // We require the file because if we import it, it will be included in the bundle.
 // I guess tsc does not check file contents when it's imported.
-const PROFILER_THREAD_ID_STRING = String(threadId$1);
+const PROFILER_THREAD_ID_STRING = String(threadId);
 const PROFILER_THREAD_NAME = isMainThread ? 'main' : 'worker';
 const FORMAT_VERSION = '1';
 const CONTINUOUS_FORMAT_VERSION = '2';
 
-// Os machine was backported to 16.18, but this was not reflected in the types
-// @ts-expect-error ignore missing
-const machine = typeof os.machine === 'function' ? os.machine() : os.arch();
-
 // Machine properties (eval only once)
 const PLATFORM = os.platform();
 const RELEASE = os.release();
 const VERSION = os.version();
 const TYPE = os.type();
-const MODEL = machine;
+const MODEL = os.machine();
 const ARCH = os.arch();
 
 /**
@@ -289,12 +78,12 @@ function createProfilingEvent(client, profile, event) {
   }
 
   return createProfilePayload(client, profile, {
-    release: _nullishCoalesce$1(event.release, () => ( '')),
-    environment: _nullishCoalesce$1(event.environment, () => ( '')),
-    event_id: _nullishCoalesce$1(event.event_id, () => ( '')),
-    transaction: _nullishCoalesce$1(event.transaction, () => ( '')),
+    release: event.release ?? '',
+    environment: event.environment ?? '',
+    event_id: event.event_id ?? '',
+    transaction: event.transaction ?? '',
     start_timestamp: event.start_timestamp ? event.start_timestamp * 1000 : Date.now(),
-    trace_id: _nullishCoalesce$1(_optionalChain$1([event, 'access', _ => _.contexts, 'optionalAccess', _2 => _2['trace'], 'optionalAccess', _3 => _3['trace_id']]), () => ( '')),
+    trace_id: event.contexts?.trace?.trace_id ?? '',
     profile_id: profile.profile_id,
   });
 }
@@ -323,7 +112,7 @@ function createProfilePayload(
   // Log a warning if the profile has an invalid traceId (should be uuidv4).
   // All profiles and transactions are rejected if this is the case and we want to
   // warn users that this is happening if they enable debug flag
-  if (trace_id && trace_id.length !== 32) {
+  if (trace_id?.length !== 32) {
     DEBUG_BUILD && logger.log(`[Profiling] Invalid traceId: ${trace_id} on profiled event`);
   }
 
@@ -339,7 +128,7 @@ function createProfilePayload(
     measurements: cpuProfile.measurements,
     runtime: {
       name: 'node',
-      version: versions$1.node || '',
+      version: versions.node || '',
     },
     os: {
       name: PLATFORM,
@@ -347,7 +136,7 @@ function createProfilePayload(
       build_number: VERSION,
     },
     device: {
-      locale: env$1['LC_ALL'] || env$1['LC_MESSAGES'] || env$1['LANG'] || env$1['LANGUAGE'] || '',
+      locale: env['LC_ALL'] || env['LC_MESSAGES'] || env['LANG'] || env['LANGUAGE'] || '',
       model: MODEL,
       manufacturer: TYPE,
       architecture: ARCH,
@@ -391,7 +180,7 @@ function createProfileChunkPayload(
   // Log a warning if the profile has an invalid traceId (should be uuidv4).
   // All profiles and transactions are rejected if this is the case and we want to
   // warn users that this is happening if they enable debug flag
-  if (trace_id && trace_id.length !== 32) {
+  if (trace_id?.length !== 32) {
     DEBUG_BUILD && logger.log(`[Profiling] Invalid traceId: ${trace_id} on profiled event`);
   }
 
@@ -400,8 +189,8 @@ function createProfileChunkPayload(
   const profile = {
     chunk_id: chunk_id,
     client_sdk: {
-      name: _nullishCoalesce$1(_optionalChain$1([sdk, 'optionalAccess', _4 => _4.name]), () => ( 'sentry.javascript.node')),
-      version: _nullishCoalesce$1(_optionalChain$1([sdk, 'optionalAccess', _5 => _5.version]), () => ( '0.0.0')),
+      name: sdk?.name ?? 'sentry.javascript.node',
+      version: sdk?.version ?? '0.0.0',
     },
     profiler_id: profiler_id,
     platform: 'node',
@@ -433,9 +222,9 @@ function createProfilingChunkEvent(
   }
 
   return createProfileChunkPayload(client, profile, {
-    release: _nullishCoalesce$1(options.release, () => ( '')),
-    environment: _nullishCoalesce$1(options.environment, () => ( '')),
-    trace_id: _nullishCoalesce$1(identifiers.trace_id, () => ( '')),
+    release: options.release ?? '',
+    environment: options.environment ?? '',
+    trace_id: identifiers.trace_id ?? '',
     chunk_id: identifiers.chunk_id,
     profiler_id: identifiers.profiler_id,
     sdk,
@@ -545,18 +334,17 @@ function findProfiledTransactionsFromEnvelope(envelope) {
 
     // First item is the type, so we can skip it, everything else is an event
     for (let j = 1; j < item.length; j++) {
-      const event = item[j];
+      const event = item[j] ;
 
       if (!event) {
         // Shouldn't happen, but lets be safe
         continue;
       }
 
-      // @ts-expect-error profile_id is not part of the metadata type
-      const profile_id = _optionalChain$1([(event.contexts ), 'optionalAccess', _6 => _6['profile'], 'optionalAccess', _7 => _7['profile_id']]);
+      const profile_id = event.contexts?.profile?.profile_id;
 
       if (event && profile_id) {
-        events.push(item[j] );
+        events.push(event);
       }
     }
   });
@@ -607,7 +395,7 @@ function makeProfileChunkEnvelope(
 function applyDebugMetadata(client, resource_paths) {
   const options = client.getOptions();
 
-  if (!options || !options.stackParser) {
+  if (!options?.stackParser) {
     return [];
   }
 
@@ -656,10 +444,6 @@ function maybeProfileSpan(
     profilesSampleRate = profilesSampler({
       name: spanName,
       attributes: data,
-      transactionContext: {
-        name: spanName,
-        parentSampled,
-      },
       parentSampled,
       ...customSamplingContext,
     });
@@ -738,11 +522,14 @@ function stopSpanProfile(span, profile_id) {
   return profile;
 }
 
-var ProfileFormat;(function (ProfileFormat) {
+var ProfileFormat; (function (ProfileFormat) {
   const THREAD = 0; ProfileFormat[ProfileFormat["THREAD"] = THREAD] = "THREAD";
   const CHUNK = 1; ProfileFormat[ProfileFormat["CHUNK"] = CHUNK] = "CHUNK";
 })(ProfileFormat || (ProfileFormat = {}));
 
+/* eslint-disable max-lines */
+
+
 const CHUNK_INTERVAL_MS = 5000;
 const PROFILE_MAP = new LRUMap(50);
 const PROFILE_TIMEOUTS = {};
@@ -775,8 +562,7 @@ function setupAutomatedSpanProfiling(client) {
       const options = client.getOptions();
       // Not intended for external use, hence missing types, but we want to profile a couple of things at Sentry that
       // currently exceed the default timeout set by the SDKs.
-      const maxProfileDurationMs =
-        (options._experiments && options._experiments['maxProfileDurationMs']) || MAX_PROFILE_DURATION_MS;
+      const maxProfileDurationMs = options._experiments?.maxProfileDurationMs || MAX_PROFILE_DURATION_MS;
 
       if (PROFILE_TIMEOUTS[profile_id]) {
         global.clearTimeout(PROFILE_TIMEOUTS[profile_id]);
@@ -834,8 +620,8 @@ function setupAutomatedSpanProfiling(client) {
     const profilesToAddToEnvelope = [];
 
     for (const profiledTransaction of profiledTransactionEvents) {
-      const profileContext = _optionalChain([profiledTransaction, 'access', _ => _.contexts, 'optionalAccess', _2 => _2['profile']]);
-      const profile_id = _optionalChain([profileContext, 'optionalAccess', _3 => _3['profile_id']]);
+      const profileContext = profiledTransaction.contexts?.profile;
+      const profile_id = profileContext?.profile_id;
 
       if (!profile_id) {
         throw new TypeError('[Profiling] cannot find profile for a transaction without a profile context');
@@ -843,7 +629,7 @@ function setupAutomatedSpanProfiling(client) {
 
       // Remove the profile from the transaction context before sending, relay will take care of the rest.
       if (profileContext) {
-         _optionalChainDelete([profiledTransaction, 'access', _4 => _4.contexts, 'optionalAccess', _5 => delete _5['profile']]);
+        delete profiledTransaction.contexts?.profile;
       }
 
       const cpuProfile = takeFromProfileQueue(profile_id);
@@ -861,6 +647,11 @@ function setupAutomatedSpanProfiling(client) {
       client.emit('preprocessEvent', profile, {
         event_id: profiledTransaction.event_id,
       });
+
+      // @ts-expect-error profile does not inherit from Event
+      client.emit('postprocessEvent', profile, {
+        event_id: profiledTransaction.event_id,
+      });
     }
 
     addProfilesToEnvelope(envelope, profilesToAddToEnvelope);
@@ -943,7 +734,7 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
    * Stops profiling of the current chunks and flushes the profile to Sentry
    */
    _chunkStop() {
-    if (_optionalChain([this, 'access', _6 => _6._chunkData, 'optionalAccess', _7 => _7.timer])) {
+    if (this._chunkData?.timer) {
       global.clearTimeout(this._chunkData.timer);
       this._chunkData.timer = undefined;
       DEBUG_BUILD && logger.log(`[Profiling] Stopping profiling chunk: ${this._chunkData.id}`);
@@ -953,9 +744,9 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
         logger.log('[Profiling] Failed to collect profile, sentry client was never attached to the profiler.');
       return;
     }
-    if (!_optionalChain([this, 'access', _8 => _8._chunkData, 'optionalAccess', _9 => _9.id])) {
+    if (!this._chunkData?.id) {
       DEBUG_BUILD &&
-        logger.log(`[Profiling] Failed to collect profile for: ${_optionalChain([this, 'access', _10 => _10._chunkData, 'optionalAccess', _11 => _11.id])}, the chunk_id is missing.`);
+        logger.log(`[Profiling] Failed to collect profile for: ${this._chunkData?.id}, the chunk_id is missing.`);
       return;
     }
 
@@ -979,7 +770,7 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
       this._client,
       this._client.getOptions(),
       profile,
-      _optionalChain([this, 'access', _12 => _12._client, 'access', _13 => _13.getSdkMetadata, 'call', _14 => _14(), 'optionalAccess', _15 => _15.sdk]),
+      this._client.getSdkMetadata()?.sdk,
       {
         chunk_id: this._chunkData.id,
         trace_id: this._chunkData.startTraceID,
@@ -1022,7 +813,7 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
     const metadata = this._client.getSdkMetadata();
     const tunnel = this._client.getOptions().tunnel;
 
-    const envelope = makeProfileChunkEnvelope(chunk, _optionalChain([metadata, 'optionalAccess', _16 => _16.sdk]), tunnel, dsn);
+    const envelope = makeProfileChunkEnvelope(chunk, metadata?.sdk, tunnel, dsn);
     transport.send(envelope).then(null, reason => {
       DEBUG_BUILD && logger.error('Error while sending profile chunk envelope:', reason);
     });
@@ -1103,7 +894,7 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
    * Assigns thread_id and thread name context to a profiled event.
    */
    _assignThreadIdContext(event) {
-    if (!_optionalChain([event, 'optionalAccess', _17 => _17['contexts'], 'optionalAccess', _18 => _18['profile']])) {
+    if (!event?.contexts?.profile) {
       return;
     }
 
@@ -1113,10 +904,10 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
 
     // @ts-expect-error the trace fallback value is wrong, though it should never happen
     // and in case it does, we dont want to override whatever was passed initially.
-    event.contexts['trace'] = {
-      ...(_nullishCoalesce(_optionalChain([event, 'access', _19 => _19.contexts, 'optionalAccess', _20 => _20['trace']]), () => ( {}))),
+    event.contexts.trace = {
+      ...(event.contexts?.trace ?? {}),
       data: {
-        ...(_nullishCoalesce(_optionalChain([event, 'access', _21 => _21.contexts, 'optionalAccess', _22 => _22['trace'], 'optionalAccess', _23 => _23['data']]), () => ( {}))),
+        ...(event.contexts?.trace?.data ?? {}),
         ['thread.id']: PROFILER_THREAD_ID_STRING,
         ['thread.name']: PROFILER_THREAD_NAME,
       },