ref(server-utils): Streamline graphql integration

Author: mydea

packages/deno/src/index.ts

@@ -126,7 +126,7 @@ export {
   firebaseIntegration,
   genericPoolIntegration,
   googleGenAIIntegration,
-  graphqlDiagnosticsIntegration,
+  graphqlIntegration,
   hapiIntegration,
   kafkajsIntegration,
   knexIntegration,

packages/deno/src/sdk.ts

@@ -19,7 +19,7 @@ import {
   firebaseIntegration,
   genericPoolIntegration,
   googleGenAIIntegration,
-  graphqlDiagnosticsIntegration,
+  graphqlIntegration,
   hapiIntegration,
   kafkajsIntegration,
   koaIntegration,
@@ -65,7 +65,7 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
     denoServeIntegration(),
     denoHttpIntegration(),
     denoRedisIntegration(),
-    graphqlDiagnosticsIntegration(),
+    graphqlIntegration(),
     vercelAiIntegration(),
     // orchestrion-based instrumentations. We add a deliberate list here rather
     // than every channel integration: each one needs a Deno test proving it

packages/node/src/index.ts

@@ -11,7 +11,7 @@ export {
   firebaseIntegration,
   genericPoolIntegration,
   googleGenAIIntegration,
-  graphqlDiagnosticsIntegration as graphqlIntegration,
+  graphqlIntegration,
   hapiIntegration,
   kafkajsIntegration as kafkaIntegration,
   knexIntegration,

packages/node/src/integrations/tracing/index.ts

@@ -7,7 +7,7 @@ import {
   firebaseIntegration,
   genericPoolIntegration,
   googleGenAIIntegration,
-  graphqlDiagnosticsIntegration,
+  graphqlIntegration,
   hapiIntegration,
   kafkajsIntegration,
   koaIntegration,
@@ -31,7 +31,7 @@ export function getAutoPerformanceIntegrations(): Integration[] {
   return [
     expressIntegration(),
     fastifyIntegration(),
-    graphqlDiagnosticsIntegration(),
+    graphqlIntegration(),
     mongodbIntegration(),
     mongooseIntegration(),
     mysqlIntegration(),

packages/server-utils/src/graphql/index.ts

@@ -1,7 +1,6 @@
 export * from './exports';
 
 // Exports using diagnostics channels
-export { graphqlIntegration } from './graphql';
 export { mongooseIntegration } from './mongoose';
 export { mysql2Integration } from './mysql2';
 export { instrumentPrisma, prismaIntegration } from './prisma';

packages/server-utils/src/index.ts

@@ -7,8 +7,8 @@ import {
   SPAN_STATUS_ERROR,
   startInactiveSpan,
 } from '@sentry/core';
-import { bindTracingChannelToSpan } from '../tracing-channel';
-import type { GraphqlDocumentNode } from './utils';
+import { bindTracingChannelToSpan } from '../../tracing-channel';
+import type { GraphqlDocumentNode } from './types';
 import { collectGraphqlDocument, getOperationSpanName, hasResultErrors, renameRootSpanWithOperation } from './utils';
 
 // Channel names published by graphql >= 17.0.0 (see graphql-js `src/diagnostics.ts`).
@@ -85,7 +85,7 @@ export interface GraphqlResolveData {
 }
 
 /** Options controlling which graphql channels the subscriber emits spans for. */
-export interface GraphqlDiagnosticChannelsOptions {
+export interface GraphQLOptions {
   /**
    * Do not create spans for resolvers. Resolver spans are per-field and can be very high volume.
    * Defaults to `true`.
@@ -128,7 +128,7 @@ export type GraphqlTracingChannelFactory = <T extends object>(name: string) => T
  */
 export function subscribeGraphqlDiagnosticChannels(
   tracingChannel: GraphqlTracingChannelFactory,
-  options: GraphqlDiagnosticChannelsOptions = {},
+  options: GraphQLOptions = {},
 ): void {
   const ignoreResolveSpans = options.ignoreResolveSpans !== false;
   const ignoreTrivialResolveSpans = options.ignoreTrivialResolveSpans !== false;

…ils/src/graphql/graphql-dc-subscriber.ts …rations/graphql/graphql-dc-subscriber.tspackages/server-utils/src/graphql/graphql-dc-subscriber.ts renamed to packages/server-utils/src/integrations/graphql/graphql-dc-subscriber.ts packages/server-utils/src/graphql/graphql-dc-subscriber.ts renamed to packages/server-utils/src/integrations/graphql/graphql-dc-subscriber.ts

@@ -1,8 +1,7 @@
 import * as diagnosticsChannel from 'node:diagnostics_channel';
-import type { Client, IntegrationFn } from '@sentry/core';
-import { defineIntegration, extendIntegration } from '@sentry/core';
-import { graphqlIntegration as graphqlNativeIntegration } from '../../graphql';
-import type { GraphqlDiagnosticChannelsOptions } from '../../graphql/graphql-dc-subscriber';
+import type { IntegrationFn } from '@sentry/core';
+import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
+import { subscribeGraphqlDiagnosticChannels, type GraphQLOptions } from './graphql-dc-subscriber';
 import { CHANNELS } from '../../orchestrion/channels';
 import { graphqlModuleNames } from '../../orchestrion/config/graphql';
 import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
@@ -28,15 +27,15 @@ interface GraphqlChannelContext {
   error?: unknown;
 }
 
-function getOptionsWithDefaults(options: GraphqlDiagnosticChannelsOptions): GraphqlResolvedConfig {
+function getOptionsWithDefaults(options: GraphQLOptions): GraphqlResolvedConfig {
   return {
     ignoreResolveSpans: options.ignoreResolveSpans !== false,
     ignoreTrivialResolveSpans: options.ignoreTrivialResolveSpans !== false,
     useOperationNameForRootSpan: options.useOperationNameForRootSpan !== false,
   };
 }
 
-const _graphqlIntegration = ((options: GraphqlDiagnosticChannelsOptions = {}) => {
+const _graphqlIntegration = ((options: GraphQLOptions = {}) => {
   const config = getOptionsWithDefaults(options);
   const getConfig = (): GraphqlResolvedConfig => config;
 
@@ -45,6 +44,9 @@ const _graphqlIntegration = ((options: GraphqlDiagnosticChannelsOptions = {}) =>
     setup(client) {
       invokeOrchestrionInstrumentation(client, graphqlModuleNames, instrumentGraphql, [config, getConfig]);
     },
+    setupOnce() {
+      setupNativeGraphQLInstrumentation(options);
+    },
   };
 }) satisfies IntegrationFn;
 
@@ -66,30 +68,20 @@ function instrumentGraphql(config: GraphqlResolvedConfig, getConfig: () => Graph
   );
 }
 
-/**
- * Orchestrion-driven graphql integration for graphql v14–16 (v17 publishes native
- * `diagnostics_channel` events handled by `@sentry/server-utils`'s graphql integration instead).
- *
- * Subscribes to the `orchestrion:graphql:{parse,validate,execute}` channels the orchestrion code
- * transform injects into `graphql`'s `language/parser.js`, `validation/validate.js` and
- * `execution/execute.js`, emitting spans identical to the native path. Requires the orchestrion
- * runtime hook or bundler plugin.
- */
-export const graphqlIntegration = defineIntegration(_graphqlIntegration);
+function setupNativeGraphQLInstrumentation(options: GraphQLOptions) {
+  if (!diagnosticsChannel.tracingChannel) {
+    return;
+  }
+
+  // Subscribe to graphql's native tracing channels (graphql >= 17).
+  // This is a no-op on versions that don't publish to the channels, so it is always safe to call.
+  waitForTracingChannelBinding(() => {
+    subscribeGraphqlDiagnosticChannels(diagnosticsChannel.tracingChannel, options);
+  });
+}
 
 /**
- * The complete graphql diagnostics-channel integration: the native subscriber (graphql v17) composed
- * with the orchestrion subscriber (v14–16), so opting into injection instruments every supported
- * version via diagnostics channels without the OTel patcher. Reuses the OTel `Graphql` name so
- * enabling injection swaps this in for it.
+ * Instrument the graphql library.
+ * This works for graphql v14-v17.
  */
-export const graphqlDiagnosticsIntegration = (options?: GraphqlDiagnosticChannelsOptions) => {
-  const orchestrion = graphqlIntegration(options);
-  // The native half is the base integration's own `setupOnce`; the orchestrion half
-  // registers lazily via `setup` (only once `graphql` is injected), so it isn't
-  // merged onto the base `setupOnce` — both run.
-  return extendIntegration(graphqlNativeIntegration(options), {
-    name: INTEGRATION_NAME,
-    setup: (client: Client) => orchestrion.setup?.(client),
-  });
-};
+export const graphqlIntegration = defineIntegration(_graphqlIntegration);

packages/server-utils/src/integrations/graphql/index.ts

@@ -14,13 +14,8 @@ import {
   SPAN_STATUS_ERROR,
   startInactiveSpan,
 } from '@sentry/core';
-import type { GraphqlDocumentNode } from '../../graphql/utils';
-import {
-  collectGraphqlDocument,
-  getOperationSpanName,
-  hasResultErrors,
-  renameRootSpanWithOperation,
-} from '../../graphql/utils';
+import type { GraphqlDocumentNode } from './types';
+import { collectGraphqlDocument, getOperationSpanName, hasResultErrors, renameRootSpanWithOperation } from './utils';
 import { GRAPHQL_DATA_SYMBOL, ORIGIN, SPAN_NAME_EXECUTE, SPAN_NAME_PARSE, SPAN_NAME_VALIDATE } from './constants';
 import { getOperation, wrapFields, wrapFieldResolver } from './resolvers';
 import type {

packages/server-utils/src/integrations/graphql/spans.ts

@@ -31,3 +31,19 @@ export interface GraphqlResolvedConfig {
   ignoreTrivialResolveSpans: boolean;
   useOperationNameForRootSpan: boolean;
 }
+
+/** Minimal shape of a graphql-js lexer token, enough to locate literal spans for redaction. */
+export interface GraphqlToken {
+  kind: string;
+  start: number;
+  end: number;
+  next?: GraphqlToken | null;
+}
+
+/** Minimal shape of a parsed graphql-js `DocumentNode`, enough to read its source and tokens. */
+export interface GraphqlDocumentNode {
+  loc?: {
+    startToken?: GraphqlToken;
+    source?: { body?: string };
+  };
+}