fix(node/v8): Add compatibility layer for Prisma v5

Author: Luca Forstner

dev-packages/node-integration-tests/package.json

@@ -16,11 +16,12 @@
     "build:types": "tsc -p tsconfig.types.json",
     "clean": "rimraf -g **/node_modules && run-p clean:script",
     "clean:script": "node scripts/clean.js",
-    "prisma:init": "(cd suites/tracing/prisma-orm && ts-node ./setup.ts)",
+    "prisma-v5:init": "cd suites/tracing/prisma-orm-v5 && ts-node ./setup.ts",
+    "prisma-v6:init": "cd suites/tracing/prisma-orm-v6 && ts-node ./setup.ts",
     "lint": "eslint . --format stylish",
     "fix": "eslint . --format stylish --fix",
     "type-check": "tsc",
-    "pretest": "run-s --silent prisma:init",
+    "pretest": "run-s --silent prisma-v5:init prisma-v6:init",
     "test": "jest --config ./jest.config.js",
     "test:watch": "yarn test --watch"
   },
@@ -30,7 +31,6 @@
     "@nestjs/common": "10.4.6",
     "@nestjs/core": "10.4.6",
     "@nestjs/platform-express": "10.4.6",
-    "@prisma/client": "5.22.0",
     "@sentry/aws-serverless": "8.51.0",
     "@sentry/core": "8.51.0",
     "@sentry/node": "8.51.0",

dev-packages/node-integration-tests/suites/tracing/prisma-orm/docker-compose.yml renamed to dev-packages/node-integration-tests/suites/tracing/prisma-orm-v5/docker-compose.yml

@@ -4,7 +4,7 @@ services:
   db:
     image: postgres:13
     restart: always
-    container_name: integration-tests-prisma
+    container_name: integration-tests-prisma-v5
     ports:
       - '5433:5432'
     environment:

dev-packages/node-integration-tests/suites/tracing/prisma-orm-v5/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "sentry-prisma-test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "db-up": "docker compose up -d",
+    "generate": "prisma generate",
+    "migrate": "prisma migrate dev -n sentry-test",
+    "setup": "run-s --silent db-up generate migrate"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@prisma/client": "5.22.0",
+    "prisma": "5.22.0"
+  }
+}

dev-packages/node-integration-tests/suites/tracing/prisma-orm/prisma/migrations/migration_lock.toml renamed to dev-packages/node-integration-tests/suites/tracing/prisma-orm-v5/prisma/migrations/migration_lock.toml

@@ -0,0 +1,52 @@
+const Sentry = require('@sentry/node');
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  tracesSampleRate: 1.0,
+  transport: loggingTransport,
+  integrations: [Sentry.prismaIntegration()],
+});
+
+const { randomBytes } = require('crypto');
+const { PrismaClient } = require('@prisma/client');
+
+// Stop the process from exiting before the transaction is sent
+setInterval(() => {}, 1000);
+
+async function run() {
+  const client = new PrismaClient();
+
+  await Sentry.startSpanManual(
+    {
+      name: 'Test Transaction',
+      op: 'transaction',
+    },
+    async span => {
+      await client.user.create({
+        data: {
+          name: 'Tilda',
+          email: `tilda_${randomBytes(4).toString('hex')}@sentry.io`,
+        },
+      });
+
+      await client.user.findMany();
+
+      await client.user.deleteMany({
+        where: {
+          email: {
+            contains: 'sentry.io',
+          },
+        },
+      });
+
+      setTimeout(async () => {
+        span.end();
+        await client.$disconnect();
+      }, 500);
+    },
+  );
+}
+
+run();

dev-packages/node-integration-tests/suites/tracing/prisma-orm/prisma/migrations/sentry_test/migration.sql renamed to dev-packages/node-integration-tests/suites/tracing/prisma-orm-v5/prisma/migrations/sentry_test/migration.sql

@@ -0,0 +1,70 @@
+import { conditionalTest } from '../../../utils';
+import { createRunner } from '../../../utils/runner';
+
+conditionalTest({ min: 16 })('Prisma ORM Tests', () => {
+  test('CJS - should instrument PostgreSQL queries from Prisma ORM', done => {
+    createRunner(__dirname, 'scenario.js')
+      .expect({
+        transaction: transaction => {
+          expect(transaction.transaction).toBe('Test Transaction');
+          const spans = transaction.spans || [];
+          expect(spans.length).toBeGreaterThanOrEqual(5);
+
+          expect(spans).toContainEqual(
+            expect.objectContaining({
+              data: {
+                method: 'create',
+                model: 'User',
+                name: 'User.create',
+                'sentry.origin': 'auto.db.otel.prisma',
+              },
+              description: 'prisma:client:operation',
+              status: 'ok',
+            }),
+          );
+
+          expect(spans).toContainEqual(
+            expect.objectContaining({
+              data: {
+                'sentry.origin': 'auto.db.otel.prisma',
+              },
+              description: 'prisma:client:serialize',
+              status: 'ok',
+            }),
+          );
+
+          expect(spans).toContainEqual(
+            expect.objectContaining({
+              data: {
+                'sentry.origin': 'auto.db.otel.prisma',
+              },
+              description: 'prisma:client:connect',
+              status: 'ok',
+            }),
+          );
+          expect(spans).toContainEqual(
+            expect.objectContaining({
+              data: {
+                method: 'findMany',
+                model: 'User',
+                name: 'User.findMany',
+                'sentry.origin': 'auto.db.otel.prisma',
+              },
+              description: 'prisma:client:operation',
+              status: 'ok',
+            }),
+          );
+          expect(spans).toContainEqual(
+            expect.objectContaining({
+              data: {
+                'sentry.origin': 'auto.db.otel.prisma',
+              },
+              description: 'prisma:client:serialize',
+              status: 'ok',
+            }),
+          );
+        },
+      })
+      .start(done);
+  });
+});