Prisma Integration Incompatible with 5.0.0

[mwillbanks]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Self-hosted/on-premise

Which SDK are you using?

@sentry/serverless

SDK Version

7.58.1

Framework Version

No response

Link to Sentry event

No response

SDK Setup

import * as Sentry from '@sentry/serverless';
import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();
Sentry.AWSLambda.init({
  dsn: process.env.SENTRY_DSN,
  environment: process.env.STAGE,
  tracesSampleRate: 1.0,
  release: process.env.VERSION,
  integrations: [new Sentry.AWSLambda.Integrations.Prisma({ client: prisma })],
});

Steps to Reproduce

1. Use @vendia/serverless-express
2. Use serverless-offline
3. yarn start
4. Navigate to any route

Expected Result

Route would load as previous.

Actual Result

✖ Unhandled exception in handler 'api'.
✖ TypeError: Converting circular structure to JSON
      --> starting at object with constructor 'zr'
      |     property 'client' -> object with constructor 't'
      --- property '_fetcher' closes the circle
      at JSON.stringify (<anonymous>)
      at new Prisma (/Volumes/Projects/xxxxx-api/node_modules/@sentry-internal/tracing/cjs/node/integrations/prisma.js:51:93)
      at init (/Volumes/Projects/xxxxx-api/.build/helper/sentry.js:39:24)
      at configureExpress (/Volumes/Projects/xxxxx-api/.build/helper/sentry.js:51:22)
      at Object.<anonymous> (/Volumes/Projects/xxxxx-api/.build/api/app.js:28:31)
      at Module._compile (node:internal/modules/cjs/loader:1196:14)
      at Object.Module._extensions..js (node:internal/modules/cjs/loader:1250:10)
      at Module.load (node:internal/modules/cjs/loader:1074:32)
      at Function.Module._load (node:internal/modules/cjs/loader:909:12)
      at Module.require (node:internal/modules/cjs/loader:1098:19)
✖ Converting circular structure to JSON
      --> starting at object with constructor 'zr'
      |     property 'client' -> object with constructor 't'
      --- property '_fetcher' closes the circle

[mydea]

Hello,

thank you for writing in!

I think we may fix this in the process of #8534 - we are currently starting to work on revamping the whole underlying performance tracing functionality of the Node SDK, which will allow us to just leverage e.g. https://www.npmjs.com/package/@prisma/instrumentation, which should hopefully also work with v5.

[janpio]

(Prisma here)

Prisma 5.0.0 has not fundamentally changed anything, beyond that we adapted the internal protocol that Prisma Client talks to the internal Query Engine. Before it was GraphQL-like, now it is a custom Json. (This actually existed since Prisma 4.11.0 with the jsonProtocol preview feature, but was made the default with the major release.)

Not sure if this is what causing the problem here though. The error above seems to be from a JSON.stringify which I can only find one in https://github.com/getsentry/sentry-javascript/blob/564af01aeb60706dce0694c662df8a34932c4176/packages/tracing-internal/src/node/integrations/prisma.ts#L86C88-L86C102 - is that the one causing the problem? If so, why doesn't it like the Client any more?

If someone creates a small reproduction example of a working Prisma integration with Prisma 4.16.2, I am happy to take a look at what could be going on when upgrading to Prisma 5.0.0 (or enabling the preview feature with 4.16.2 itself).

[tylerexpa]

I'm also seeing this with Prisma 4.14.1 and @sentry/nextjs 7.59.3

[janpio]

Do you have previewFeatures = ["jsonProtocol"] enabled @tylerexpa or not?

[tylerexpa]

@janpio I have previewFeatures = ["fullTextSearch", "postgresqlExtensions"] set

[janpio]

That would go against my theory above.

Still would appreciate a minimal reproduction of the problem so I can play with it. I know nothing about Sentry, so creating one will not be trivial for me.