@envelop/sentry fails subscriptions

[robertherber]

Hi! 👋

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch @envelop/[email protected] for the project I'm working on.

Symbol('sentryTracing') is undefined when using subscriptions with graphql-ws (together with fastify and yoga) and as such causes the subscription call itself to fail. Not sure if the package is meant to be used with subscriptions - but at least it shouldn't crash :)

Here is the diff that solved my problem:

diff --git a/node_modules/@envelop/sentry/cjs/index.js b/node_modules/@envelop/sentry/cjs/index.js
index 1cd1c34..24ffd45 100644
--- a/node_modules/@envelop/sentry/cjs/index.js
+++ b/node_modules/@envelop/sentry/cjs/index.js
@@ -36,6 +36,10 @@ const useSentry = (options = {}) => {
     }
     const onResolverCalled = trackResolvers
         ? ({ args: resolversArgs, info, context }) => {
+            if(!context[sentryTracingSymbol]){
+                console.warn('no sentryTracingSymbol present, skipping tracing')
+                return null
+            }
             const { rootSpan, opName, operationType } = context[sentryTracingSymbol];
             if (rootSpan) {
                 const { fieldName, returnType, parentType } = info;

This issue body was partially generated by patch-package.

[alexanderniebuhr]

We have found the same, but without using subscriptions. We do use GraphQL Yoga.

[robertherber]

We have found the same, but without using subscriptions. We do use GraphQL Yoga.

I'm also using GraphQL Yoga (made that clearer in the original post) although "plugged into" fastify. Are you using vanilla GraphQL Yoga and get the same consistently?

[alexanderniebuhr]

We use vanilla GraphQL Yoga with the envelop plugin registered like so:

async function main() {
	const server = createServer({
		graphiql: process.env.NODE_ENV === 'development',
		endpoint: "/",
		schema,
		context: createContext,
		plugins: [
			useSentry({
				startTransaction: true,
				renameTransaction: false,
				trackResolvers: true,
				includeRawResult: true,
				includeResolverArgs: true,
				includeExecuteVariables: true,
				skip({operationName}) {
					if (operationName == "health") return true
					return false
				},
			})
		]
	})
	await server.start()
}

We need the same patch, even for a very simple query.