Apollo performance tracing not working with nestjs graphql

[kaufmo]

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 package are you using?

@sentry/node

SDK Version

7.13.0

Framework Version

@nestjs/graphql: ^10.0.0
@nestjs/apollo: ^10.0.0
apollo-server-core": ^3.3.0
apollo-server-express: ^3.3.0

Link to Sentry event

No response

Steps to Reproduce

Im running a nestjs graphql api which uses apollo-server behind. I want to integrate the Apollo tracing: https://docs.sentry.io/platforms/node/performance/database/opt-in/#apollo-server-integration but I'm always getting an error.

It looks like the problem is that the integration cannot find the resolvers in constructSchema? See here my resolvers are empty https://github.com/getsentry/sentry-javascript/blob/master/packages/tracing/src/integrations/node/apollo.ts#L49

Can somebody help me how can i fix that?

Expected Result

Expected result would be getting tracing into my sentry instance 😅

Actual Result

Error on API startup

This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at /dist/sentry.ts:58:28
    at Array.map (<anonymous>)
    at ApolloServer.<anonymous> (/dist/sentry.ts:56:51)
    at new ApolloServerBase (xxx/node_modules/apollo-server-core/src/ApolloServer.ts:330:18)
    at new ApolloServer (xxx/node_modules/apollo-server-express/src/ApolloServer.ts:55:1)
    at ApolloDriver.registerExpress (xxx/node_modules/@nestjs/apollo/dist/drivers/apollo-base.driver.js:77:30)
    at ApolloDriver.registerServer (xxx/node_modules/@nestjs/apollo/dist/drivers/apollo.driver.js:38:24)
    at ApolloDriver.start (xxx/node_modules/@nestjs/apollo/dist/drivers/apollo.driver.js:23:20)
    at GraphQLModule.onModuleInit (xxx/node_modules/@nestjs/graphql/dist/graphql.module.js:105:9)

[AbhiPrasad]

Hey, thanks for writing in! This is super strange - @nestjs/apollo should be using apollo-server-core under the hood. Could you try upgrading your apollo-server-core? Perhaps that will help.

[kaufmo]

Hi @AbhiPrasad, I've upgrade both to the newest version but that didn't helped. Do you have another idea?

"apollo-server-core": "^3.10.2",
"apollo-server-express": "^3.10.2",

[onurtemizkan]

@kaufmo, could you create a reproduction for us to debug this further?

[kaufmo]

@onurtemizkan yes for sure i can create a simple repo for that, but we are using a selfhosted sentry instance which i cannot use here. Is it ok when you have to set dsn manually?

[onurtemizkan]

Is it ok when you have to set dsn manually?

That's totally fine @kaufmo, thanks.

[kaufmo]

@onurtemizkan I've created the repo: https://github.com/kaufmo/nestjs-sentry-apollo-example. When you start the api with yarn start:dev you will see the error. When you comment out the apollo integration then everything works fine.
Is that ok for you to debug?

This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at /xxx/dev/nestjs-sentry-apollo-example/node_modules/@sentry/tracing/cjs/integrations/node/apollo.js:42:18
    at Array.map (<anonymous>)
    at ApolloServer.<anonymous> (/xxx/dev/nestjs-sentry-apollo-example/node_modules/@sentry/tracing/cjs/integrations/node/apollo.js:41:43)
    at new ApolloServerBase (/xxx/dev/nestjs-sentry-apollo-example/node_modules/apollo-server-core/src/ApolloServer.ts:330:18)
    at new ApolloServer (/xxx/dev/nestjs-sentry-apollo-example/node_modules/apollo-server-express/src/ApolloServer.ts:55:1)
    at ApolloDriver.registerExpress (/xxx/dev/nestjs-sentry-apollo-example/node_modules/@nestjs/apollo/dist/drivers/apollo-base.driver.js:77:30)
    at ApolloDriver.registerServer (/xxx/dev/nestjs-sentry-apollo-example/node_modules/@nestjs/apollo/dist/drivers/apollo.driver.js:38:24)
    at ApolloDriver.start (/xxx/dev/nestjs-sentry-apollo-example/node_modules/@nestjs/apollo/dist/drivers/apollo.driver.js:23:20)
    at GraphQLModule.onModuleInit (/xxx/dev/nestjs-sentry-apollo-example/node_modules/@nestjs/graphql/dist/graphql.module.js:105:9)

[onurtemizkan]

Thanks for the reproduction @kaufmo! I was able to reproduce and debug the issue.

Apollo integration only supports ApolloServer instances constructed with a resolvers array provided.

It seems there are two other ways to create an ApolloServer instance:

• Providing a pre-constructed schema (apparently, Nestjs is doing this)
• Providing a modules object

So, resolvers array we iterate on is in fact optional, and we should fix this, logging a warning message if resolvers is not available. I'll open a PR to fix it.

I'm also opening another issue about adding support for schema and module.