chore(client): remove tracing preview feature usage (#25865)

aqrln · web-flow · commit aa35416c592f · 2024-12-16T19:57:24.000+01:00
Closes: prisma/team-orm#1279
diff --git a/packages/client/src/runtime/core/engines/common/types/QueryEngine.ts b/packages/client/src/runtime/core/engines/common/types/QueryEngine.ts
@@ -48,8 +48,8 @@ export type QueryEngineConfig = {
   datasourceOverrides: Record<string, string>
   env: Record<string, string | undefined>
   logLevel: QueryEngineLogLevel
-  telemetry?: QueryEngineTelemetry
   engineProtocol: EngineProtocol
+  enableTracing: boolean
 }
 
 export type QueryEngineTelemetry = {
diff --git a/packages/client/src/runtime/core/engines/library/LibraryEngine.ts b/packages/client/src/runtime/core/engines/library/LibraryEngine.ts
@@ -2,7 +2,7 @@ import Debug from '@prisma/debug'
 import { ErrorRecord } from '@prisma/driver-adapter-utils'
 import type { BinaryTarget } from '@prisma/get-platform'
 import { assertNodeAPISupported, binaryTargets, getBinaryTargetForCurrentPlatform } from '@prisma/get-platform'
-import { assertAlways, EngineTrace } from '@prisma/internals'
+import { assertAlways, EngineTrace, TracingHelper } from '@prisma/internals'
 import { bold, green, red } from 'kleur/colors'
 
 import { PrismaClientInitializationError } from '../../errors/PrismaClientInitializationError'
@@ -81,6 +81,7 @@ export class LibraryEngine implements Engine<undefined> {
   logLevel: QueryEngineLogLevel
   lastQuery?: string
   loggerRustPanic?: any
+  tracingHelper: TracingHelper
 
   versionInfo?: {
     commit: string
@@ -109,6 +110,7 @@ export class LibraryEngine implements Engine<undefined> {
     this.logLevel = config.logLevel ?? 'error'
     this.logEmitter = config.logEmitter
     this.datamodel = config.inlineSchema
+    this.tracingHelper = config.tracingHelper
 
     if (config.enableDebugLogs) {
       this.logLevel = 'debug'
@@ -147,11 +149,11 @@ export class LibraryEngine implements Engine<undefined> {
       try {
         return await fn(...args, requestId)
       } finally {
-        if (this.config.tracingHelper.isEnabled()) {
+        if (this.tracingHelper.isEnabled()) {
           const traceJson = await this.engine?.trace(requestId)
           if (traceJson) {
             const trace = JSON.parse(traceJson) as EngineTrace
-            this.config.tracingHelper.dispatchEngineSpans(trace.spans)
+            this.tracingHelper.dispatchEngineSpans(trace.spans)
           }
         }
       }
@@ -231,15 +233,15 @@ export class LibraryEngine implements Engine<undefined> {
 
     this.binaryTarget = await this.getCurrentBinaryTarget()
 
-    await this.config.tracingHelper.runInChildSpan('load_engine', () => this.loadEngine())
+    await this.tracingHelper.runInChildSpan('load_engine', () => this.loadEngine())
 
     this.version()
   }
 
   private async getCurrentBinaryTarget() {
     if (TARGET_BUILD_TYPE === 'library') {
       if (this.binaryTarget) return this.binaryTarget
-      const binaryTarget = await this.config.tracingHelper.runInChildSpan('detect_platform', () =>
+      const binaryTarget = await this.tracingHelper.runInChildSpan('detect_platform', () =>
         getBinaryTargetForCurrentPlatform(),
       )
       if (!knownBinaryTargets.includes(binaryTarget)) {
@@ -306,6 +308,7 @@ You may have to run ${green('prisma generate')} for your changes to take effect.
             logLevel: this.logLevel,
             configDir: this.config.cwd,
             engineProtocol: 'json',
+            enableTracing: this.tracingHelper.isEnabled(),
           },
           (log) => {
             weakThis.deref()?.logger(log)
@@ -399,7 +402,7 @@ You may have to run ${green('prisma generate')} for your changes to take effect.
 
       try {
         const headers = {
-          traceparent: this.config.tracingHelper.getTraceParent(),
+          traceparent: this.tracingHelper.getTraceParent(),
         }
 
         await this.engine?.connect(JSON.stringify(headers))
@@ -422,7 +425,7 @@ You may have to run ${green('prisma generate')} for your changes to take effect.
       }
     }
 
-    this.libraryStartingPromise = this.config.tracingHelper.runInChildSpan('connect', startFn)
+    this.libraryStartingPromise = this.tracingHelper.runInChildSpan('connect', startFn)
 
     return this.libraryStartingPromise
   }
@@ -446,7 +449,7 @@ You may have to run ${green('prisma generate')} for your changes to take effect.
       debug('library stopping')
 
       const headers = {
-        traceparent: this.config.tracingHelper.getTraceParent(),
+        traceparent: this.tracingHelper.getTraceParent(),
       }
 
       await this.engine?.disconnect(JSON.stringify(headers))
@@ -457,7 +460,7 @@ You may have to run ${green('prisma generate')} for your changes to take effect.
       debug('library stopped')
     }
 
-    this.libraryStoppingPromise = this.config.tracingHelper.runInChildSpan('disconnect', stopFn)
+    this.libraryStoppingPromise = this.tracingHelper.runInChildSpan('disconnect', stopFn)
 
     return this.libraryStoppingPromise
   }
diff --git a/packages/client/src/runtime/core/engines/library/ReactNativeLibraryLoader.ts b/packages/client/src/runtime/core/engines/library/ReactNativeLibraryLoader.ts
@@ -12,6 +12,7 @@ type PrismaCreateOptions = {
   ignoreEnvVarErrors: boolean
   datasourceOverrides: object | string
   env: object | string
+  enableTracing: boolean
 }
 
 type QueryEngineObject = object
@@ -46,6 +47,7 @@ class ReactNativeQueryEngine implements QueryEngineInstance {
       logLevel: config.logLevel,
       logQueries: config.logQueries ?? false,
       logCallback: logger,
+      enableTracing: config.enableTracing,
     })
   }
 
diff --git a/packages/client/src/runtime/core/tracing/TracingHelper.ts b/packages/client/src/runtime/core/tracing/TracingHelper.ts
@@ -52,11 +52,6 @@ class DynamicTracingHelper implements TracingHelper {
   }
 }
 
-export function getTracingHelper(previewFeatures: string[]): TracingHelper {
-  if (!previewFeatures.includes('tracing')) {
-    // no preview feature - tracing is disabled and can never be enabled
-    return disabledTracingHelper
-  }
-  // preview feature is enabled - tracing is enabled if PRISMA_INSTRUMENTATION global is set
+export function getTracingHelper(): TracingHelper {
   return new DynamicTracingHelper()
 }
diff --git a/packages/client/src/runtime/core/tracing/getTraceParent.test.ts b/packages/client/src/runtime/core/tracing/getTraceParent.test.ts
@@ -1,7 +1,7 @@
 import { getTracingHelper } from './TracingHelper'
 
 it('should return 00 traceparent when tracing is disabled', () => {
-  const helper = getTracingHelper([])
+  const helper = getTracingHelper()
 
   const result = helper.getTraceParent()
 
diff --git a/packages/client/src/runtime/getPrismaClient.ts b/packages/client/src/runtime/getPrismaClient.ts
@@ -358,7 +358,7 @@ export function getPrismaClient(config: GetPrismaClientConfig) {
       this._clientVersion = config.clientVersion ?? clientVersion
       this._activeProvider = config.activeProvider
       this._globalOmit = optionsArg?.omit
-      this._tracingHelper = getTracingHelper(this._previewFeatures)
+      this._tracingHelper = getTracingHelper()
       const envPaths = {
         rootEnvPath:
           config.relativeEnvPaths.rootEnvPath && path.resolve(config.dirname, config.relativeEnvPaths.rootEnvPath),
diff --git a/packages/client/tests/functional/_example/_matrix.ts b/packages/client/tests/functional/_example/_matrix.ts
@@ -36,7 +36,7 @@ export default defineMatrix(() => [
   ],
   [
     {
-      previewFeatures: '"tracing"',
+      previewFeatures: '"relationJoins"',
     },
     {
       previewFeatures: '"referentialIntegrity"',
@@ -52,13 +52,13 @@ export default defineMatrix(() => [
       'provider': 'sqlite',
       'id': 'Int @id @default(autoincrement())',
       'randomString': 'foo',
-      'previewFeatures': '"tracing"',
+      'previewFeatures': '"relationJoins"',
     },
     {
       'provider': 'mongodb',
       'id': 'String @id @default(auto()) @map("_id") @db.ObjectId',
       'randomString': '"book", ',
-      'previewFeatures': '"tracing"',
+      'previewFeatures': '"relationJoins"',
     },
     {
       'provider': 'sqlite',
diff --git a/packages/client/tests/functional/_example/tests.ts b/packages/client/tests/functional/_example/tests.ts
@@ -21,7 +21,7 @@ testMatrix.setupTestSuite(
         provider: Providers.SQLITE
         id: 'Int @id @default(autoincrement())',
         randomString: 'foo',
-        previewFeatures: '"tracing"'
+        previewFeatures: '"relationJoins"'
       }
     */
 
diff --git a/packages/client/tests/functional/tracing-no-sampling/_matrix.ts b/packages/client/tests/functional/tracing-no-sampling/_matrix.ts
@@ -1,14 +1,4 @@
 import { defineMatrix } from '../_utils/defineMatrix'
 import { allProviders } from '../_utils/providers'
 
-export default defineMatrix(() => [
-  allProviders,
-  [
-    {
-      previewFeatures: '"tracing"',
-    },
-    {
-      previewFeatures: '',
-    },
-  ],
-])
+export default defineMatrix(() => [allProviders])
diff --git a/packages/client/tests/functional/tracing/prisma/_schema.ts b/packages/client/tests/functional/tracing/prisma/_schema.ts
@@ -5,7 +5,6 @@ export default testMatrix.setupSchema(({ provider }) => {
   return /* Prisma */ `
     generator client {
       provider = "prisma-client-js"
-      previewFeatures = ["tracing"]
     }
 
     datasource db {
diff --git a/packages/instrumentation/README.md b/packages/instrumentation/README.md
@@ -29,7 +29,6 @@ Don't forget to set `previewFeatures`:
 ```prisma
 generator client {
   provider = "prisma-client-js"
-  previewFeatures = ["tracing"]
 }
 ```
 
diff --git a/sandbox/tracing/prisma/schema.prisma b/sandbox/tracing/prisma/schema.prisma
@@ -1,8 +1,8 @@
 generator client {
-  provider        = "prisma-client-js"
-  output          = "../node_modules/.prisma/client"
-  previewFeatures = ["tracing"]
+  provider = "prisma-client-js"
+  output   = "../node_modules/.prisma/client"
 }
+
 datasource db {
   provider = "sqlite"
   url      = "file:./dev.db"

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,8 @@ export type QueryEngineConfig = {`
`48`	`48`	`datasourceOverrides: Record<string, string>`
`49`	`49`	`env: Record<string, string \| undefined>`
`50`	`50`	`logLevel: QueryEngineLogLevel`
`51`		`- telemetry?: QueryEngineTelemetry`
`52`	`51`	`engineProtocol: EngineProtocol`
	`52`	`+ enableTracing: boolean`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`export type QueryEngineTelemetry = {`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ type PrismaCreateOptions = {`
`12`	`12`	`ignoreEnvVarErrors: boolean`
`13`	`13`	`datasourceOverrides: object \| string`
`14`	`14`	`env: object \| string`
	`15`	`+ enableTracing: boolean`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`type QueryEngineObject = object`
`@@ -46,6 +47,7 @@ class ReactNativeQueryEngine implements QueryEngineInstance {`
`46`	`47`	`logLevel: config.logLevel,`
`47`	`48`	`logQueries: config.logQueries ?? false,`
`48`	`49`	`logCallback: logger,`
	`50`	`+ enableTracing: config.enableTracing,`
`49`	`51`	`})`
`50`	`52`	`}`
`51`	`53`
Original file line number	Diff line number	Diff line change
`@@ -52,11 +52,6 @@ class DynamicTracingHelper implements TracingHelper {`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`
`55`		`-export function getTracingHelper(previewFeatures: string[]): TracingHelper {`
`56`		`- if (!previewFeatures.includes('tracing')) {`
`57`		`- // no preview feature - tracing is disabled and can never be enabled`
`58`		`- return disabledTracingHelper`
`59`		`- }`
`60`		`- // preview feature is enabled - tracing is enabled if PRISMA_INSTRUMENTATION global is set`
	`55`	`+export function getTracingHelper(): TracingHelper {`
`61`	`56`	`return new DynamicTracingHelper()`
`62`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ export default defineMatrix(() => [`
`36`	`36`	`],`
`37`	`37`	`[`
`38`	`38`	`{`
`39`		`- previewFeatures: '"tracing"',`
	`39`	`+ previewFeatures: '"relationJoins"',`
`40`	`40`	`},`
`41`	`41`	`{`
`42`	`42`	`previewFeatures: '"referentialIntegrity"',`
`@@ -52,13 +52,13 @@ export default defineMatrix(() => [`
`52`	`52`	`'provider': 'sqlite',`
`53`	`53`	`'id': 'Int @id @default(autoincrement())',`
`54`	`54`	`'randomString': 'foo',`
`55`		`- 'previewFeatures': '"tracing"',`
	`55`	`+ 'previewFeatures': '"relationJoins"',`
`56`	`56`	`},`
`57`	`57`	`{`
`58`	`58`	`'provider': 'mongodb',`
`59`	`59`	`'id': 'String @id @default(auto()) @map("_id") @db.ObjectId',`
`60`	`60`	`'randomString': '"book", ',`
`61`		`- 'previewFeatures': '"tracing"',`
	`61`	`+ 'previewFeatures': '"relationJoins"',`
`62`	`62`	`},`
`63`	`63`	`{`
`64`	`64`	`'provider': 'sqlite',`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ testMatrix.setupTestSuite(`
`21`	`21`	`provider: Providers.SQLITE`
`22`	`22`	`id: 'Int @id @default(autoincrement())',`
`23`	`23`	`randomString: 'foo',`
`24`		`- previewFeatures: '"tracing"'`
	`24`	`+ previewFeatures: '"relationJoins"'`
`25`	`25`	`}`
`26`	`26`	`*/`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@ export default testMatrix.setupSchema(({ provider }) => {`
`5`	`5`	return /* Prisma */ `
`6`	`6`	`generator client {`
`7`	`7`	`provider = "prisma-client-js"`
`8`		`- previewFeatures = ["tracing"]`
`9`	`8`	`}`
`10`	`9`
`11`	`10`	`datasource db {`