fixes

Author: mydea

packages/node/src/integrations/tracing/prisma.ts

@@ -2,7 +2,7 @@ import type { Instrumentation } from '@opentelemetry/instrumentation';
 // When importing CJS modules into an ESM module, we cannot import the named exports directly.
 import * as prismaInstrumentation from '@prisma/instrumentation';
 import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, consoleSandbox, defineIntegration, spanToJSON } from '@sentry/core';
-import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';
+import { generateInstrumentOnce } from '../../otel/instrument';
 import type { PrismaV5TracingHelper } from './prisma/vendor/v5-tracing-helper';
 import type { PrismaV6TracingHelper } from './prisma/vendor/v6-tracing-helper';
 
@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
   return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
 }
 
+function getPrismaTracingHelper(): unknown | undefined {
+  const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
+  const prismaTracingHelper =
+    prismaInstrumentationObject &&
+    typeof prismaInstrumentationObject === 'object' &&
+    'helper' in prismaInstrumentationObject
+      ? prismaInstrumentationObject.helper
+      : undefined;
+
+  return prismaTracingHelper;
+}
+
 class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
   public constructor() {
     super();
@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
     // The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
     // Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
     // We still won't fully emit all the spans, but this could potentially be implemented in the future.
-    const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
-    const prismaTracingHelper =
-      prismaInstrumentationObject &&
-      typeof prismaInstrumentationObject === 'object' &&
-      'helper' in prismaInstrumentationObject
-        ? prismaInstrumentationObject.helper
-        : undefined;
+    const prismaTracingHelper = getPrismaTracingHelper();
 
     let emittedWarning = false;
 
@@ -113,34 +119,35 @@ export const prismaIntegration = defineIntegration(
      */
     prismaInstrumentation?: Instrumentation;
   } = {}) => {
-    let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);
-
     return {
       name: INTEGRATION_NAME,
       setupOnce() {
-        const instrumentation = instrumentPrisma({ prismaInstrumentation });
-        instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
+        instrumentPrisma({ prismaInstrumentation });
       },
       setup(client) {
-        instrumentationWrappedCallback?.(() =>
-          client.on('spanStart', span => {
-            const spanJSON = spanToJSON(span);
-            if (spanJSON.description?.startsWith('prisma:')) {
-              span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.prisma');
-            }
-
-            // Make sure we use the query text as the span name, for ex. SELECT * FROM "User" WHERE "id" = $1
-            if (spanJSON.description === 'prisma:engine:db_query' && spanJSON.data['db.query.text']) {
-              span.updateName(spanJSON.data['db.query.text'] as string);
-            }
-
-            // In Prisma v5.22+, the `db.system` attribute is automatically set
-            // On older versions, this is missing, so we add it here
-            if (spanJSON.description === 'prisma:engine:db_query' && !spanJSON.data['db.system']) {
-              span.setAttribute('db.system', 'prisma');
-            }
-          }),
-        );
+        // If no tracing helper exists, we skip any work here
+        // this means that prisma is not being used
+        if (!getPrismaTracingHelper()) {
+          return;
+        }
+
+        client.on('spanStart', span => {
+          const spanJSON = spanToJSON(span);
+          if (spanJSON.description?.startsWith('prisma:')) {
+            span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.prisma');
+          }
+
+          // Make sure we use the query text as the span name, for ex. SELECT * FROM "User" WHERE "id" = $1
+          if (spanJSON.description === 'prisma:engine:db_query' && spanJSON.data['db.query.text']) {
+            span.updateName(spanJSON.data['db.query.text'] as string);
+          }
+
+          // In Prisma v5.22+, the `db.system` attribute is automatically set
+          // On older versions, this is missing, so we add it here
+          if (spanJSON.description === 'prisma:engine:db_query' && !spanJSON.data['db.system']) {
+            span.setAttribute('db.system', 'prisma');
+          }
+        });
       },
     };
   },

packages/node/test/utils/instrument.test.ts

@@ -65,10 +65,11 @@ describe('instrumentWhenWrapped', () => {
       _wrap: originalWrap,
     } as any;
 
+    const registerCallback = instrumentWhenWrapped(instrumentation);
+
     // Call _wrap first
     instrumentation._wrap();
 
-    const registerCallback = instrumentWhenWrapped(instrumentation);
     registerCallback(callback);
 
     // Callback should be called immediately