chore(client): remove engine connect/disconnect span (#14705)

prisma · Aug 8, 2022 · f6d1a65 · f6d1a65
1 parent d978dbf
commit f6d1a65
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 113 deletions.
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -140,7 +140,7 @@
     }
   },
   "dependencies": {
-    "@prisma/engines-version": "4.2.0-31.659227f6781053b4a24d241ede6c3dd2d88d254f"
+    "@prisma/engines-version": "4.2.0-33.2920a97877e12e055c1333079b8d19cee7f33826"
   },
   "sideEffects": false
 }
diff --git a/packages/client/tests/functional/tracing/__snapshots__/tests.ts.snap b/packages/client/tests/functional/tracing/__snapshots__/tests.ts.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`tracing (provider=cockroachdb) Tracing connect should trace the implict $connect call 1`] = `
+exports[`tracing (provider=cockroachdb) tracing connect should trace the implicit $connect call 1`] = `
 Object {
   children: Array [
     Object {
@@ -14,18 +14,7 @@ Object {
       },
     },
     Object {
-      children: Array [
-        Object {
-          children: Array [],
-          span: Object {
-            attributes: Object {},
-            kind: 0,
-            links: Array [],
-            name: prisma:engine:connect,
-            parentSpanId: <parentSpanId>,
-          },
-        },
-      ],
+      children: Array [],
       span: Object {
         attributes: Object {},
         kind: 0,
@@ -1354,7 +1343,7 @@ Object {
 }
 `;
 
-exports[`tracing (provider=mongodb) Tracing connect should trace the implict $connect call 1`] = `
+exports[`tracing (provider=mongodb) tracing connect should trace the implicit $connect call 1`] = `
 Object {
   children: Array [
     Object {
@@ -1368,18 +1357,7 @@ Object {
       },
     },
     Object {
-      children: Array [
-        Object {
-          children: Array [],
-          span: Object {
-            attributes: Object {},
-            kind: 0,
-            links: Array [],
-            name: prisma:engine:connect,
-            parentSpanId: <parentSpanId>,
-          },
-        },
-      ],
+      children: Array [],
       span: Object {
         attributes: Object {},
         kind: 0,
@@ -2398,7 +2376,7 @@ Object {
 }
 `;
 
-exports[`tracing (provider=mysql) Tracing connect should trace the implict $connect call 1`] = `
+exports[`tracing (provider=mysql) tracing connect should trace the implicit $connect call 1`] = `
 Object {
   children: Array [
     Object {
@@ -2412,18 +2390,7 @@ Object {
       },
     },
     Object {
-      children: Array [
-        Object {
-          children: Array [],
-          span: Object {
-            attributes: Object {},
-            kind: 0,
-            links: Array [],
-            name: prisma:engine:connect,
-            parentSpanId: <parentSpanId>,
-          },
-        },
-      ],
+      children: Array [],
       span: Object {
         attributes: Object {},
         kind: 0,
@@ -3752,7 +3719,7 @@ Object {
 }
 `;
 
-exports[`tracing (provider=postgresql) Tracing connect should trace the implict $connect call 1`] = `
+exports[`tracing (provider=postgresql) tracing connect should trace the implicit $connect call 1`] = `
 Object {
   children: Array [
     Object {
@@ -3766,18 +3733,7 @@ Object {
       },
     },
     Object {
-      children: Array [
-        Object {
-          children: Array [],
-          span: Object {
-            attributes: Object {},
-            kind: 0,
-            links: Array [],
-            name: prisma:engine:connect,
-            parentSpanId: <parentSpanId>,
-          },
-        },
-      ],
+      children: Array [],
       span: Object {
         attributes: Object {},
         kind: 0,
@@ -5106,7 +5062,7 @@ Object {
 }
 `;
 
-exports[`tracing (provider=sqlite) Tracing connect should trace the implict $connect call 1`] = `
+exports[`tracing (provider=sqlite) tracing connect should trace the implicit $connect call 1`] = `
 Object {
   children: Array [
     Object {
@@ -5120,18 +5076,7 @@ Object {
       },
     },
     Object {
-      children: Array [
-        Object {
-          children: Array [],
-          span: Object {
-            attributes: Object {},
-            kind: 0,
-            links: Array [],
-            name: prisma:engine:connect,
-            parentSpanId: <parentSpanId>,
-          },
-        },
-      ],
+      children: Array [],
       span: Object {
         attributes: Object {},
         kind: 0,
@@ -6389,7 +6334,7 @@ Object {
 }
 `;
 
-exports[`tracing (provider=sqlserver) Tracing connect should trace the implict $connect call 1`] = `
+exports[`tracing (provider=sqlserver) tracing connect should trace the implicit $connect call 1`] = `
 Object {
   children: Array [
     Object {
@@ -6403,18 +6348,7 @@ Object {
       },
     },
     Object {
-      children: Array [
-        Object {
-          children: Array [],
-          span: Object {
-            attributes: Object {},
-            kind: 0,
-            links: Array [],
-            name: prisma:engine:connect,
-            parentSpanId: <parentSpanId>,
-          },
-        },
-      ],
+      children: Array [],
       span: Object {
         attributes: Object {},
         kind: 0,

diff --git a/packages/client/tests/functional/tracing/tests.ts b/packages/client/tests/functional/tracing/tests.ts
@@ -747,7 +747,7 @@ testMatrix.setupTestSuite(({ provider }) => {
     })
   })
 
-  describe('Tracing connect', () => {
+  describe('tracing connect', () => {
     // @ts-ignore
     let _prisma: PrismaClient
 
@@ -759,7 +759,7 @@ testMatrix.setupTestSuite(({ provider }) => {
       await _prisma.$disconnect()
     })
 
-    test('should trace the implict $connect call', async () => {
+    test('should trace the implicit $connect call', async () => {
       const email = faker.internet.email()
 
       await _prisma.user.findMany({
@@ -784,10 +784,7 @@ testMatrix.setupTestSuite(({ provider }) => {
       const connect = (tree?.children || [])[1] as unknown as Tree
       expect(connect.span.name).toEqual('prisma:client:connect')
 
-      expect(connect.children).toHaveLength(1)
-
-      const engineConnect = (connect?.children || [])[0] as unknown as Tree
-      expect(engineConnect.span.name).toEqual('prisma:engine:connect')
+      expect(connect.children).toHaveLength(0)
 
       const engine = (tree?.children || [])[2] as unknown as Tree
       expect(engine.span.name).toEqual('prisma:engine')
@@ -819,7 +816,7 @@ testMatrix.setupTestSuite(({ provider }) => {
     })
   })
 
-  describe('Tracing disconnect', () => {
+  describe('tracing disconnect', () => {
     // @ts-ignore
     let _prisma: PrismaClient
 
@@ -834,16 +831,6 @@ testMatrix.setupTestSuite(({ provider }) => {
       const tree = await waitForSpanTree()
 
       expect(tree.span.name).toEqual('prisma:client:disconnect')
-
-      // No binary disconnect because we simply kill the process
-      if (getClientEngineType() === ClientEngineType.Binary) {
-        return
-      }
-
-      expect(tree.children).toHaveLength(1)
-
-      const engineDisconnect = (tree.children || [])[0]
-      expect(engineDisconnect.span.name).toEqual('prisma:engine:disconnect')
     })
   })
 })
diff --git a/packages/engine-core/src/binary/BinaryEngine.ts b/packages/engine-core/src/binary/BinaryEngine.ts
@@ -578,7 +578,8 @@ ${chalk.dim("In case we're mistaken, please report this to us 🙏.")}`)
           tracingHeaders.traceparent = getTraceParent()
         }
 
-        flags.push('--tracing-headers', JSON.stringify(tracingHeaders))
+        // TODO: not used yet by the engine
+        // flags.push('--tracing-headers', JSON.stringify(tracingHeaders))
 
         debug({ flags })
 

diff --git a/packages/engine-core/src/library/LibraryEngine.ts b/packages/engine-core/src/library/LibraryEngine.ts
@@ -335,6 +335,7 @@ You may have to run ${chalk.greenBright('prisma generate')} for your changes to
           traceparent: getTraceParent(),
         }
 
+        // TODO: not used yet by the engine
         await this.engine?.connect(JSON.stringify(headers))
 
         this.libraryStarted = true

diff --git a/packages/engine-core/src/tracing/createSpan.ts b/packages/engine-core/src/tracing/createSpan.ts
@@ -1,4 +1,4 @@
-import { ROOT_CONTEXT, SpanContext, SpanKind, trace, TraceFlags } from '@opentelemetry/api'
+import { context, ROOT_CONTEXT, SpanContext, SpanKind, trace, TraceFlags } from '@opentelemetry/api'
 import { Span, Tracer } from '@opentelemetry/sdk-trace-base'
 
 import { EngineSpanEvent } from '../common/types/QueryEngine'
@@ -10,19 +10,22 @@ export async function createSpan(engineSpanEvent: EngineSpanEvent) {
 
   const tracer = trace.getTracer('prisma') as Tracer
 
+  // TODO: workaround for the engines always sending spans even when not traced
+  const traceFlags = trace.getSpan(context.active())?.spanContext().traceFlags
+
   engineSpanEvent.spans.forEach((engineSpan) => {
     const spanContext: SpanContext = {
       traceId: engineSpan.trace_id,
       spanId: engineSpan.span_id,
-      traceFlags: TraceFlags.SAMPLED,
+      traceFlags: traceFlags ?? TraceFlags.SAMPLED,
     }
 
     const links = engineSpan.links?.map((link) => {
       return {
         context: {
           traceId: link.trace_id,
           spanId: link.span_id,
-          traceFlags: TraceFlags.SAMPLED,
+          traceFlags: traceFlags ?? TraceFlags.SAMPLED,
         },
       }
     })

diff --git a/packages/engines/package.json b/packages/engines/package.json
@@ -7,7 +7,7 @@
   "author": "Tim Suchanek <suchanek@prisma.io>",
   "devDependencies": {
     "@prisma/debug": "workspace:*",
-    "@prisma/engines-version": "4.2.0-31.659227f6781053b4a24d241ede6c3dd2d88d254f",
+    "@prisma/engines-version": "4.2.0-33.2920a97877e12e055c1333079b8d19cee7f33826",
     "@prisma/fetch-engine": "workspace:*",
     "@prisma/get-platform": "workspace:*",
     "@swc/core": "1.2.197",

diff --git a/packages/fetch-engine/package.json b/packages/fetch-engine/package.json
@@ -13,7 +13,7 @@
   },
   "bugs": "https://github.com/prisma/prisma/issues",
   "devDependencies": {
-    "@prisma/engines-version": "4.2.0-31.659227f6781053b4a24d241ede6c3dd2d88d254f",
+    "@prisma/engines-version": "4.2.0-33.2920a97877e12e055c1333079b8d19cee7f33826",
     "@swc/core": "1.2.197",
     "@swc/jest": "0.2.22",
     "@types/jest": "28.1.6",

diff --git a/packages/migrate/package.json b/packages/migrate/package.json
@@ -16,7 +16,7 @@
     "version": "latest"
   },
   "devDependencies": {
-    "@prisma/engines-version": "4.2.0-31.659227f6781053b4a24d241ede6c3dd2d88d254f",
+    "@prisma/engines-version": "4.2.0-33.2920a97877e12e055c1333079b8d19cee7f33826",
     "@prisma/generator-helper": "workspace:*",
     "@prisma/internals": "workspace:*",
     "@swc/core": "1.2.204",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml