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

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2024 Functional Software, Inc. dba Sentry
+Copyright (c) 2022 Functional Software, Inc. dba Sentry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/lib/cjs/index.js

@@ -1,19 +1,11 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
+const nodeCpuProfiler = require('@sentry-internal/node-cpu-profiler');
 const core = require('@sentry/core');
-const node_module = require('node:module');
-const node_os = require('node:os');
-const node_path = require('node:path');
-const node_process = require('node:process');
-const node_url = require('node:url');
-const node_worker_threads = require('node:worker_threads');
-const detectLibc = require('detect-libc');
-const nodeAbi = require('node-abi');
 const os = require('os');
 const process$1 = require('process');
 const worker_threads = require('worker_threads');
 
-var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 /**
  * 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.
  *
@@ -21,204 +13,6 @@ var _documentCurrentScript = typeof document !== 'undefined' ? document.currentS
  */
 const DEBUG_BUILD = (typeof __SENTRY_DEBUG__ === 'undefined' || __SENTRY_DEBUG__);
 
-const stdlib = detectLibc.familySync();
-const platform = process.env['BUILD_PLATFORM'] || node_os.platform();
-const arch = process.env['BUILD_ARCH'] || node_os.arch();
-const abi = nodeAbi.getAbi(node_process.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 (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.js', document.baseURI).href)) !== 'undefined'
-      ? // This case is always hit when the SDK is built
-        (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.js', document.baseURI).href))
-      : // This case is hit when the tests are run
-        node_url.pathToFileURL(__filename).href;
-
-  const createdRequire = node_module.createRequire(importMetaUrl);
-  const esmCompatibleDirname = node_path.dirname(node_url.fileURLToPath(importMetaUrl));
-
-  // If a binary path is specified, use that.
-  if (node_process.env['SENTRY_PROFILER_BINARY_PATH']) {
-    const envPath = node_process.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 (node_process.env['SENTRY_PROFILER_BINARY_DIR']) {
-    const binaryPath = node_path.join(node_path.resolve(node_process.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 = node_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 && core.logger.log('[Profiling] Bindings not loaded, ignoring call to startProfiling.');
-      return;
-    }
-
-    if (typeof PrivateCpuProfilerBindings.startProfiling !== 'function') {
-      DEBUG_BUILD &&
-        core.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 &&
-        core.logger.log('[Profiling] Bindings not loaded or profile was never started, ignoring call to stopProfiling.');
-      return null;
-    }
-
-    if (typeof PrivateCpuProfilerBindings.stopProfiling !== 'function') {
-      DEBUG_BUILD &&
-        core.logger.log('[Profiling] Native stopProfiling function is not available, ignoring call to stopProfiling.');
-      return null;
-    }
-
-    return PrivateCpuProfilerBindings.stopProfiling(
-      name,
-      format ,
-      node_worker_threads.threadId,
-      !!core.GLOBAL_OBJ._sentryDebugIds,
-    );
-  }
-}
-
-const CpuProfilerBindings = new Bindings();
-
 const NODE_VERSION = core.parseSemver(process.versions.node) ;
 const NODE_MAJOR = NODE_VERSION.major;
 
@@ -291,7 +85,7 @@ function createProfilingEvent(client, profile, event) {
     event_id: event.event_id ?? '',
     transaction: event.transaction ?? '',
     start_timestamp: event.start_timestamp ? event.start_timestamp * 1000 : Date.now(),
-    trace_id: event.contexts?.['trace']?.['trace_id'] ?? '',
+    trace_id: event.contexts?.trace?.trace_id ?? '',
     profile_id: profile.profile_id,
   });
 }
@@ -542,18 +336,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 = (event.contexts )?.['profile']?.['profile_id'];
+      const profile_id = event.contexts?.profile?.profile_id;
 
       if (event && profile_id) {
-        events.push(item[j] );
+        events.push(event);
       }
     }
   });
@@ -693,7 +486,7 @@ function maybeProfileSpan(
   }
 
   const profile_id = core.uuid4();
-  CpuProfilerBindings.startProfiling(profile_id);
+  nodeCpuProfiler.CpuProfilerBindings.startProfiling(profile_id);
   DEBUG_BUILD && core.logger.log(`[Profiling] started profiling transaction: ${core.spanToJSON(span).description}`);
 
   // set transaction context - do this regardless if profiling fails down the line
@@ -713,7 +506,7 @@ function stopSpanProfile(span, profile_id) {
     return null;
   }
 
-  const profile = CpuProfilerBindings.stopProfiling(profile_id, 0);
+  const profile = nodeCpuProfiler.CpuProfilerBindings.stopProfiling(profile_id, 0);
   DEBUG_BUILD && core.logger.log(`[Profiling] stopped profiling of transaction: ${core.spanToJSON(span).description}`);
 
   // In case of an overlapping span, stopProfiling may return null and silently ignore the overlapping profile.
@@ -736,6 +529,9 @@ var ProfileFormat; (function (ProfileFormat) {
   const CHUNK = 1; ProfileFormat[ProfileFormat["CHUNK"] = CHUNK] = "CHUNK";
 })(ProfileFormat || (ProfileFormat = {}));
 
+/* eslint-disable max-lines */
+
+
 const CHUNK_INTERVAL_MS = 5000;
 const PROFILE_MAP = new core.LRUMap(50);
 const PROFILE_TIMEOUTS = {};
@@ -826,8 +622,8 @@ function setupAutomatedSpanProfiling(client) {
     const profilesToAddToEnvelope = [];
 
     for (const profiledTransaction of profiledTransactionEvents) {
-      const profileContext = profiledTransaction.contexts?.['profile'];
-      const profile_id = profileContext?.['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');
@@ -835,7 +631,7 @@ function setupAutomatedSpanProfiling(client) {
 
       // Remove the profile from the transaction context before sending, relay will take care of the rest.
       if (profileContext) {
-        delete profiledTransaction.contexts?.['profile'];
+        delete profiledTransaction.contexts?.profile;
       }
 
       const cpuProfile = takeFromProfileQueue(profile_id);
@@ -956,7 +752,7 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
       return;
     }
 
-    const profile = CpuProfilerBindings.stopProfiling(this._chunkData.id, ProfileFormat.CHUNK);
+    const profile = nodeCpuProfiler.CpuProfilerBindings.stopProfiling(this._chunkData.id, ProfileFormat.CHUNK);
 
     if (!profile) {
       DEBUG_BUILD && core.logger.log(`[Profiling] _chunkiledStartTraceID to collect profile for: ${this._chunkData.id}`);
@@ -1034,7 +830,7 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
       core.getCurrentScope().getPropagationContext().traceId || core.getIsolationScope().getPropagationContext().traceId;
     const chunk = this._initializeChunk(traceId);
 
-    CpuProfilerBindings.startProfiling(chunk.id);
+    nodeCpuProfiler.CpuProfilerBindings.startProfiling(chunk.id);
     DEBUG_BUILD && core.logger.log(`[Profiling] starting profiling chunk: ${chunk.id}`);
 
     chunk.timer = global.setTimeout(() => {
@@ -1100,7 +896,7 @@ class ContinuousProfiler {constructor() { ContinuousProfiler.prototype.__init.ca
    * Assigns thread_id and thread name context to a profiled event.
    */
    _assignThreadIdContext(event) {
-    if (!event?.['contexts']?.['profile']) {
+    if (!event?.contexts?.profile) {
       return;
     }
 
@@ -1110,10 +906,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'] = {
-      ...(event.contexts?.['trace'] ?? {}),
+    event.contexts.trace = {
+      ...(event.contexts?.trace ?? {}),
       data: {
-        ...(event.contexts?.['trace']?.['data'] ?? {}),
+        ...(event.contexts?.trace?.data ?? {}),
         ['thread.id']: PROFILER_THREAD_ID_STRING,
         ['thread.name']: PROFILER_THREAD_NAME,
       },