feat(node): Add Prisma v7 support #18908
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| version: '3.9' | ||
|
|
||
| services: | ||
| db: | ||
| image: postgres:13 | ||
| restart: always | ||
| container_name: integration-tests-prisma-v7 | ||
| ports: | ||
| - '5435:5432' | ||
| environment: | ||
| POSTGRES_USER: prisma | ||
| POSTGRES_PASSWORD: prisma | ||
| POSTGRES_DB: tests |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import * as Sentry from '@sentry/node'; | ||
| import { loggingTransport } from '@sentry-internal/node-integration-tests'; | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| release: '1.0', | ||
| tracesSampleRate: 1.0, | ||
| transport: loggingTransport, | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import { defineConfig } from 'prisma/config'; | ||
|
|
||
| export default defineConfig({ | ||
| earlyAccess: true, | ||
| schema: './prisma/schema.prisma', | ||
| migrate: { | ||
| migrations: './prisma/migrations', | ||
| }, | ||
| datasource: { | ||
| url: 'postgresql://prisma:prisma@localhost:5435/tests', | ||
| }, | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Please do not edit this file manually | ||
| # It should be added in your version-control system (i.e. Git) | ||
| provider = "postgresql" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| -- CreateTable | ||
| CREATE TABLE "User" ( | ||
| "id" SERIAL NOT NULL, | ||
| "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP, | ||
| "email" TEXT NOT NULL, | ||
| "name" TEXT, | ||
|
|
||
| CONSTRAINT "User_pkey" PRIMARY KEY ("id") | ||
| ); | ||
|
|
||
| -- CreateIndex | ||
| CREATE UNIQUE INDEX "User_email_key" ON "User"("email"); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| datasource db { | ||
| provider = "postgresql" | ||
| } | ||
|
|
||
| generator client { | ||
| provider = "prisma-client-js" | ||
| } | ||
|
|
||
| model User { | ||
| id Int @id @default(autoincrement()) | ||
| createdAt DateTime @default(now()) | ||
| email String @unique | ||
| name String? | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| import { PrismaPg } from '@prisma/adapter-pg'; | ||
| import { PrismaClient } from '@prisma/client'; | ||
| import * as Sentry from '@sentry/node'; | ||
| import { randomBytes } from 'crypto'; | ||
|
|
||
| // Stop the process from exiting before the transaction is sent | ||
| setInterval(() => {}, 1000); | ||
|
|
||
| const connectionString = 'postgresql://prisma:prisma@localhost:5435/tests'; | ||
|
|
||
| async function run() { | ||
| await Sentry.startSpan( | ||
| { | ||
| name: 'Test Transaction', | ||
| op: 'transaction', | ||
| }, | ||
| async span => { | ||
| const adapter = new PrismaPg({ connectionString }); | ||
| const client = new PrismaClient({ adapter }); | ||
|
|
||
| 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); | ||
| }, | ||
| ); | ||
|
There was a problem hiding this comment. Wrong API used: span auto-ends before setTimeout firesLow Severity The v7 scenario uses
Member
Author
There was a problem hiding this comment. This is consistent with our v6 tests. |
||
| } | ||
|
|
||
| run(); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| import { afterAll, describe, expect } from 'vitest'; | ||
| import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner'; | ||
|
|
||
| afterAll(() => { | ||
| cleanupChildProcesses(); | ||
| }); | ||
|
|
||
| describe('Prisma ORM v7 Tests', () => { | ||
| createEsmAndCjsTests( | ||
| __dirname, | ||
| 'scenario.mjs', | ||
| 'instrument.mjs', | ||
| (createRunner, test, _mode, cwd) => { | ||
| test('should instrument PostgreSQL queries from Prisma ORM', { timeout: 75_000 }, async () => { | ||
| await createRunner() | ||
| .withDockerCompose({ | ||
| workingDirectory: [cwd], | ||
| readyMatches: ['port 5432'], | ||
| setupCommand: `yarn prisma generate --schema ${cwd}/prisma/schema.prisma && yarn prisma migrate dev -n sentry-test --schema ${cwd}/prisma/schema.prisma`, | ||
| }) | ||
| .expect({ | ||
| transaction: transaction => { | ||
| expect(transaction.transaction).toBe('Test Transaction'); | ||
|
|
||
| const spans = transaction.spans || []; | ||
| expect(spans.length).toBeGreaterThanOrEqual(5); | ||
|
|
||
| // Verify Prisma spans have the correct origin | ||
| const prismaSpans = spans.filter( | ||
| span => span.data && span.data['sentry.origin'] === 'auto.db.otel.prisma', | ||
| ); | ||
| expect(prismaSpans.length).toBeGreaterThanOrEqual(5); | ||
|
|
||
| // Check for key Prisma span descriptions | ||
| const spanDescriptions = prismaSpans.map(span => span.description); | ||
| expect(spanDescriptions).toContain('prisma:client:operation'); | ||
| expect(spanDescriptions).toContain('prisma:client:serialize'); | ||
| expect(spanDescriptions).toContain('prisma:client:connect'); | ||
| expect(spanDescriptions).toContain('prisma:client:db_query'); | ||
|
|
||
| // Verify the create operation has correct metadata | ||
| const createSpan = prismaSpans.find( | ||
| span => | ||
| span.description === 'prisma:client:operation' && | ||
| span.data?.['method'] === 'create' && | ||
| span.data?.['model'] === 'User', | ||
| ); | ||
| expect(createSpan).toBeDefined(); | ||
|
|
||
| // Verify db_query span has system info and correct op (v7 uses db.system.name) | ||
| const dbQuerySpan = prismaSpans.find(span => span.description === 'prisma:client:db_query'); | ||
| expect(dbQuerySpan?.data?.['db.system.name']).toBe('postgresql'); | ||
| expect(dbQuerySpan?.data?.['sentry.op']).toBe('db'); | ||
| expect(dbQuerySpan?.op).toBe('db'); | ||
| }, | ||
| }) | ||
| .start() | ||
| .completed(); | ||
| }); | ||
| }, | ||
| { | ||
| additionalDependencies: { | ||
| '@prisma/adapter-pg': '7.2.0', | ||
| '@prisma/client': '7.2.0', | ||
| pg: '^8.11.0', | ||
| prisma: '7.2.0', | ||
| }, | ||
| copyPaths: ['prisma', 'prisma.config.ts', 'docker-compose.yml'], | ||
| }, | ||
| ); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we maybe use
"prisma-client"here? According to their blog post, this is now possible and rust-free: https://www.prisma.io/blog/announcing-prisma-orm-7-0-0And their migration guide: https://www.prisma.io/docs/orm/more/upgrade-guides/upgrading-versions/upgrading-to-prisma-7#prisma-schema-changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
neat, will update.