@depup/sentry__server-utils 10.67.0-depup.0

package/build/esm/graphql/graphql-dc-subscriber.js

@@ -0,0 +1,116 @@
+import { GRAPHQL_DOCUMENT, GRAPHQL_OPERATION_NAME, GRAPHQL_OPERATION_TYPE } from '@sentry/conventions/attributes';
+import { WEB_SERVER_GRAPHQL_SPAN_OP } from '@sentry/conventions/op';
+import { startInactiveSpan, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SPAN_STATUS_ERROR } from '@sentry/core';
+import { bindTracingChannelToSpan } from '../tracing-channel.js';
+import { collectGraphqlDocument, hasResultErrors, getOperationSpanName, renameRootSpanWithOperation } from './utils.js';
+
+const GRAPHQL_DC_CHANNEL_PARSE = "graphql:parse";
+const GRAPHQL_DC_CHANNEL_VALIDATE = "graphql:validate";
+const GRAPHQL_DC_CHANNEL_EXECUTE = "graphql:execute";
+const GRAPHQL_DC_CHANNEL_SUBSCRIBE = "graphql:subscribe";
+const GRAPHQL_DC_CHANNEL_RESOLVE = "graphql:resolve";
+const ORIGIN = "auto.graphql.diagnostic_channel";
+const SPAN_NAME_PARSE = "graphql.parse";
+const SPAN_NAME_VALIDATE = "graphql.validate";
+const SPAN_NAME_EXECUTE = "graphql.execute";
+const SPAN_NAME_SUBSCRIBE = "graphql.subscribe";
+const SPAN_NAME_RESOLVE = "graphql.resolve";
+const GRAPHQL_FIELD_NAME = "graphql.field.name";
+const GRAPHQL_FIELD_PATH = "graphql.field.path";
+const GRAPHQL_FIELD_TYPE = "graphql.field.type";
+const GRAPHQL_PARENT_NAME = "graphql.parent.name";
+function subscribeGraphqlDiagnosticChannels(tracingChannel, options = {}) {
+  const ignoreResolveSpans = options.ignoreResolveSpans !== false;
+  const ignoreTrivialResolveSpans = options.ignoreTrivialResolveSpans !== false;
+  const useOperationNameForRootSpan = options.useOperationNameForRootSpan !== false;
+  setupParseChannel(tracingChannel);
+  setupValidateChannel(tracingChannel);
+  setupOperationChannel(tracingChannel, GRAPHQL_DC_CHANNEL_EXECUTE, SPAN_NAME_EXECUTE, useOperationNameForRootSpan);
+  setupOperationChannel(tracingChannel, GRAPHQL_DC_CHANNEL_SUBSCRIBE, SPAN_NAME_SUBSCRIBE, useOperationNameForRootSpan);
+  if (!ignoreResolveSpans) {
+    setupResolveChannel(tracingChannel, ignoreTrivialResolveSpans);
+  }
+}
+function setupParseChannel(tracingChannel) {
+  bindTracingChannelToSpan(
+    tracingChannel(GRAPHQL_DC_CHANNEL_PARSE),
+    () => startInactiveSpan({
+      name: SPAN_NAME_PARSE,
+      attributes: {
+        [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
+        [SEMANTIC_ATTRIBUTE_SENTRY_OP]: WEB_SERVER_GRAPHQL_SPAN_OP
+      }
+    })
+  );
+}
+function setupValidateChannel(tracingChannel) {
+  bindTracingChannelToSpan(
+    tracingChannel(GRAPHQL_DC_CHANNEL_VALIDATE),
+    (data) => {
+      return startInactiveSpan({
+        name: SPAN_NAME_VALIDATE,
+        attributes: {
+          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
+          [SEMANTIC_ATTRIBUTE_SENTRY_OP]: WEB_SERVER_GRAPHQL_SPAN_OP,
+          [GRAPHQL_DOCUMENT]: collectGraphqlDocument(data.document)
+        }
+      });
+    },
+    {
+      beforeSpanEnd: (span, data) => {
+        if (Array.isArray(data.result) && data.result.length > 0) {
+          span.setStatus({ code: SPAN_STATUS_ERROR, message: "invalid_argument" });
+        }
+      }
+    }
+  );
+}
+function setupOperationChannel(tracingChannel, channelName, fallbackName, useOperationNameForRootSpan) {
+  bindTracingChannelToSpan(
+    tracingChannel(channelName),
+    (data) => {
+      const span = startInactiveSpan({
+        name: getOperationSpanName(data.operationType, data.operationName, fallbackName),
+        attributes: {
+          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
+          [SEMANTIC_ATTRIBUTE_SENTRY_OP]: WEB_SERVER_GRAPHQL_SPAN_OP,
+          [GRAPHQL_OPERATION_TYPE]: data.operationType,
+          [GRAPHQL_OPERATION_NAME]: data.operationName || void 0,
+          [GRAPHQL_DOCUMENT]: collectGraphqlDocument(data.document)
+        }
+      });
+      if (useOperationNameForRootSpan && data.operationType) {
+        renameRootSpanWithOperation(span, data.operationType, data.operationName);
+      }
+      return span;
+    },
+    {
+      beforeSpanEnd: (span, data) => {
+        if (hasResultErrors(data.result)) {
+          span.setStatus({ code: SPAN_STATUS_ERROR, message: "internal_error" });
+        }
+      }
+    }
+  );
+}
+function setupResolveChannel(tracingChannel, ignoreTrivialResolveSpans) {
+  bindTracingChannelToSpan(tracingChannel(GRAPHQL_DC_CHANNEL_RESOLVE), (data) => {
+    if (ignoreTrivialResolveSpans && data.isDefaultResolver) {
+      return void 0;
+    }
+    return startInactiveSpan({
+      name: `${SPAN_NAME_RESOLVE} ${data.fieldPath}`,
+      attributes: {
+        [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
+        [SEMANTIC_ATTRIBUTE_SENTRY_OP]: WEB_SERVER_GRAPHQL_SPAN_OP,
+        [GRAPHQL_FIELD_NAME]: data.fieldName,
+        [GRAPHQL_FIELD_PATH]: data.fieldPath,
+        [GRAPHQL_FIELD_TYPE]: data.fieldType,
+        [GRAPHQL_PARENT_NAME]: data.parentType
+      }
+    });
+  });
+}
+
+export { GRAPHQL_DC_CHANNEL_EXECUTE, GRAPHQL_DC_CHANNEL_PARSE, GRAPHQL_DC_CHANNEL_RESOLVE, GRAPHQL_DC_CHANNEL_SUBSCRIBE, GRAPHQL_DC_CHANNEL_VALIDATE, subscribeGraphqlDiagnosticChannels };
+//# sourceMappingURL=graphql-dc-subscriber.js.map

package/build/esm/graphql/graphql-dc-subscriber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graphql-dc-subscriber.js","sources":["../../../src/graphql/graphql-dc-subscriber.ts"],"sourcesContent":["import type { TracingChannel } from 'node:diagnostics_channel';\nimport { GRAPHQL_DOCUMENT, GRAPHQL_OPERATION_NAME, GRAPHQL_OPERATION_TYPE } from '@sentry/conventions/attributes';\nimport { WEB_SERVER_GRAPHQL_SPAN_OP } from '@sentry/conventions/op';\nimport {\n  SEMANTIC_ATTRIBUTE_SENTRY_OP,\n  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,\n  SPAN_STATUS_ERROR,\n  startInactiveSpan,\n} from '@sentry/core';\nimport { bindTracingChannelToSpan } from '../tracing-channel';\nimport type { GraphqlDocumentNode } from './utils';\nimport { collectGraphqlDocument, getOperationSpanName, hasResultErrors, renameRootSpanWithOperation } from './utils';\n\n// Channel names published by graphql >= 17.0.0 (see graphql-js `src/diagnostics.ts`).\n// Hardcoded so the subscriber does not have to import graphql — the channels just\n// have to be subscribed to before the user's graphql code publishes.\nexport const GRAPHQL_DC_CHANNEL_PARSE = 'graphql:parse';\nexport const GRAPHQL_DC_CHANNEL_VALIDATE = 'graphql:validate';\nexport const GRAPHQL_DC_CHANNEL_EXECUTE = 'graphql:execute';\nexport const GRAPHQL_DC_CHANNEL_SUBSCRIBE = 'graphql:subscribe';\nexport const GRAPHQL_DC_CHANNEL_RESOLVE = 'graphql:resolve';\n\nconst ORIGIN = 'auto.graphql.diagnostic_channel';\n\nconst SPAN_NAME_PARSE = 'graphql.parse';\nconst SPAN_NAME_VALIDATE = 'graphql.validate';\nconst SPAN_NAME_EXECUTE = 'graphql.execute';\nconst SPAN_NAME_SUBSCRIBE = 'graphql.subscribe';\nconst SPAN_NAME_RESOLVE = 'graphql.resolve';\n\n// Field-level attributes for resolver spans. Not in `@sentry/conventions`; these match the keys the\n// vendored OTel instrumentation emits so there is no drift between the two paths.\nconst GRAPHQL_FIELD_NAME = 'graphql.field.name';\nconst GRAPHQL_FIELD_PATH = 'graphql.field.path';\nconst GRAPHQL_FIELD_TYPE = 'graphql.field.type';\nconst GRAPHQL_PARENT_NAME = 'graphql.parent.name';\n\n/** Context published on the sync-only `graphql:parse` channel. */\nexport interface GraphqlParseData {\n  source: string | { body?: string };\n  result?: GraphqlDocumentNode;\n  error?: unknown;\n}\n\n/** Context published on the sync-only `graphql:validate` channel. */\nexport interface GraphqlValidateData {\n  document: GraphqlDocumentNode;\n  /** Validation errors returned by validation; an empty array means the document is valid. */\n  result?: ReadonlyArray<unknown>;\n  error?: unknown;\n}\n\n/**\n * Context published on the `graphql:execute` and `graphql:subscribe` channels.\n *\n * `result` carries an `ExecutionResult` (or, for subscriptions, an async generator); GraphQL errors\n * collected during execution surface on `result.errors` rather than as the channel's `error`\n * lifecycle event, which only fires on an abrupt throw.\n */\nexport interface GraphqlOperationData {\n  document: GraphqlDocumentNode;\n  operationName?: string;\n  operationType?: string;\n  result?: unknown;\n  error?: unknown;\n}\n\n/**\n * Context published on the per-field `graphql:resolve` channel.\n *\n * A resolver throw or rejection publishes the `error` lifecycle event here; the same failure also\n * surfaces in the enclosing execution result.\n */\nexport interface GraphqlResolveData {\n  fieldName: string;\n  parentType: string;\n  fieldType: string;\n  fieldPath: string;\n  /** Whether the field is handled by graphql's default property resolver (vs. a user resolver). */\n  isDefaultResolver: boolean;\n  alias?: string;\n  args?: unknown;\n  result?: unknown;\n  error?: unknown;\n}\n\n/** Options controlling which graphql channels the subscriber emits spans for. */\nexport interface GraphqlDiagnosticChannelsOptions {\n  /**\n   * Do not create spans for resolvers. Resolver spans are per-field and can be very high volume.\n   * Defaults to `true`.\n   */\n  ignoreResolveSpans?: boolean;\n\n  /**\n   * When resolver spans are enabled, do not create them for graphql's default property resolver\n   * (fields without a user-defined resolver), which are rarely interesting. Defaults to `true`.\n   */\n  ignoreTrivialResolveSpans?: boolean;\n\n  /**\n   * Rename the enclosing root span to include the operation name(s), e.g.\n   * `GET /graphql` -> `GET /graphql (query GetUser)`. Defaults to `true`.\n   */\n  useOperationNameForRootSpan?: boolean;\n}\n\n/**\n * Platform-provided factory that creates a native tracing channel for the given name. The\n * subscriber binds the span and its lifecycle onto the channel via `bindTracingChannelToSpan`,\n * which propagates the active span through the runtime's async context.\n *\n * Node passes `node:diagnostics_channel`'s `tracingChannel` directly.\n */\nexport type GraphqlTracingChannelFactory = <T extends object>(name: string) => TracingChannel<T, T>;\n\n/**\n * Subscribe Sentry span handlers to graphql's diagnostics-channel events\n * (`graphql:parse`, `:validate`, `:execute`, `:subscribe`), published by graphql >= 17.0.0.\n *\n * On older graphql versions the channels are never published to, so the subscribers are inert —\n * there is no double-instrumentation against the vendored OTel patcher, which is gated to `< 17`.\n *\n * The per-field `graphql:resolve` channel is only subscribed when `ignoreResolveSpans` is `false`:\n * resolver spans are per-field and can be extremely high-volume, so they are off by default (matching\n * the legacy OTel path). When enabled, `ignoreTrivialResolveSpans` (default `true`) additionally skips\n * graphql's default property resolver.\n */\nexport function subscribeGraphqlDiagnosticChannels(\n  tracingChannel: GraphqlTracingChannelFactory,\n  options: GraphqlDiagnosticChannelsOptions = {},\n): void {\n  const ignoreResolveSpans = options.ignoreResolveSpans !== false;\n  const ignoreTrivialResolveSpans = options.ignoreTrivialResolveSpans !== false;\n  const useOperationNameForRootSpan = options.useOperationNameForRootSpan !== false;\n\n  setupParseChannel(tracingChannel);\n  setupValidateChannel(tracingChannel);\n  setupOperationChannel(tracingChannel, GRAPHQL_DC_CHANNEL_EXECUTE, SPAN_NAME_EXECUTE, useOperationNameForRootSpan);\n  setupOperationChannel(tracingChannel, GRAPHQL_DC_CHANNEL_SUBSCRIBE, SPAN_NAME_SUBSCRIBE, useOperationNameForRootSpan);\n\n  if (!ignoreResolveSpans) {\n    setupResolveChannel(tracingChannel, ignoreTrivialResolveSpans);\n  }\n}\n\nfunction setupParseChannel(tracingChannel: GraphqlTracingChannelFactory): void {\n  bindTracingChannelToSpan(tracingChannel<GraphqlParseData>(GRAPHQL_DC_CHANNEL_PARSE), () =>\n    startInactiveSpan({\n      name: SPAN_NAME_PARSE,\n      attributes: {\n        [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n        [SEMANTIC_ATTRIBUTE_SENTRY_OP]: WEB_SERVER_GRAPHQL_SPAN_OP,\n      },\n    }),\n  );\n}\n\nfunction setupValidateChannel(tracingChannel: GraphqlTracingChannelFactory): void {\n  bindTracingChannelToSpan(\n    tracingChannel<GraphqlValidateData>(GRAPHQL_DC_CHANNEL_VALIDATE),\n    data => {\n      return startInactiveSpan({\n        name: SPAN_NAME_VALIDATE,\n        attributes: {\n          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n          [SEMANTIC_ATTRIBUTE_SENTRY_OP]: WEB_SERVER_GRAPHQL_SPAN_OP,\n          [GRAPHQL_DOCUMENT]: collectGraphqlDocument(data.document),\n        },\n      });\n    },\n    {\n      beforeSpanEnd: (span, data) => {\n        // Validation completes normally even when it returns errors, so flag the span here.\n        if (Array.isArray(data.result) && data.result.length > 0) {\n          span.setStatus({ code: SPAN_STATUS_ERROR, message: 'invalid_argument' });\n        }\n      },\n    },\n  );\n}\n\nfunction setupOperationChannel(\n  tracingChannel: GraphqlTracingChannelFactory,\n  channelName: string,\n  fallbackName: string,\n  useOperationNameForRootSpan: boolean,\n): void {\n  bindTracingChannelToSpan(\n    tracingChannel<GraphqlOperationData>(channelName),\n    data => {\n      const span = startInactiveSpan({\n        name: getOperationSpanName(data.operationType, data.operationName, fallbackName),\n        attributes: {\n          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n          [SEMANTIC_ATTRIBUTE_SENTRY_OP]: WEB_SERVER_GRAPHQL_SPAN_OP,\n          [GRAPHQL_OPERATION_TYPE]: data.operationType,\n          [GRAPHQL_OPERATION_NAME]: data.operationName || undefined,\n          [GRAPHQL_DOCUMENT]: collectGraphqlDocument(data.document),\n        },\n      });\n\n      if (useOperationNameForRootSpan && data.operationType) {\n        renameRootSpanWithOperation(span, data.operationType, data.operationName);\n      }\n\n      return span;\n    },\n    {\n      beforeSpanEnd: (span, data) => {\n        // GraphQL errors are returned on `result.errors`, not as a thrown error, so flag the span here.\n        if (hasResultErrors(data.result)) {\n          span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });\n        }\n      },\n    },\n  );\n}\n\nfunction setupResolveChannel(tracingChannel: GraphqlTracingChannelFactory, ignoreTrivialResolveSpans: boolean): void {\n  bindTracingChannelToSpan(tracingChannel<GraphqlResolveData>(GRAPHQL_DC_CHANNEL_RESOLVE), data => {\n    // Returning `undefined` opts this field out: no span is created and the active context is left\n    // untouched, so the field still resolves under its parent span.\n    if (ignoreTrivialResolveSpans && data.isDefaultResolver) {\n      return undefined;\n    }\n\n    return startInactiveSpan({\n      name: `${SPAN_NAME_RESOLVE} ${data.fieldPath}`,\n      attributes: {\n        [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n        [SEMANTIC_ATTRIBUTE_SENTRY_OP]: WEB_SERVER_GRAPHQL_SPAN_OP,\n        [GRAPHQL_FIELD_NAME]: data.fieldName,\n        [GRAPHQL_FIELD_PATH]: data.fieldPath,\n        [GRAPHQL_FIELD_TYPE]: data.fieldType,\n        [GRAPHQL_PARENT_NAME]: data.parentType,\n      },\n    });\n  });\n}\n"],"names":[],"mappings":";;;;;;AAgBO,MAAM,wBAAA,GAA2B;AACjC,MAAM,2BAAA,GAA8B;AACpC,MAAM,0BAAA,GAA6B;AACnC,MAAM,4BAAA,GAA+B;AACrC,MAAM,0BAAA,GAA6B;AAE1C,MAAM,MAAA,GAAS,iCAAA;AAEf,MAAM,eAAA,GAAkB,eAAA;AACxB,MAAM,kBAAA,GAAqB,kBAAA;AAC3B,MAAM,iBAAA,GAAoB,iBAAA;AAC1B,MAAM,mBAAA,GAAsB,mBAAA;AAC5B,MAAM,iBAAA,GAAoB,iBAAA;AAI1B,MAAM,kBAAA,GAAqB,oBAAA;AAC3B,MAAM,kBAAA,GAAqB,oBAAA;AAC3B,MAAM,kBAAA,GAAqB,oBAAA;AAC3B,MAAM,mBAAA,GAAsB,qBAAA;AA6FrB,SAAS,kCAAA,CACd,cAAA,EACA,OAAA,GAA4C,EAAC,EACvC;AACN,EAAA,MAAM,kBAAA,GAAqB,QAAQ,kBAAA,KAAuB,KAAA;AAC1D,EAAA,MAAM,yBAAA,GAA4B,QAAQ,yBAAA,KAA8B,KAAA;AACxE,EAAA,MAAM,2BAAA,GAA8B,QAAQ,2BAAA,KAAgC,KAAA;AAE5E,EAAA,iBAAA,CAAkB,cAAc,CAAA;AAChC,EAAA,oBAAA,CAAqB,cAAc,CAAA;AACnC,EAAA,qBAAA,CAAsB,cAAA,EAAgB,0BAAA,EAA4B,iBAAA,EAAmB,2BAA2B,CAAA;AAChH,EAAA,qBAAA,CAAsB,cAAA,EAAgB,4BAAA,EAA8B,mBAAA,EAAqB,2BAA2B,CAAA;AAEpH,EAAA,IAAI,CAAC,kBAAA,EAAoB;AACvB,IAAA,mBAAA,CAAoB,gBAAgB,yBAAyB,CAAA;AAAA,EAC/D;AACF;AAEA,SAAS,kBAAkB,cAAA,EAAoD;AAC7E,EAAA,wBAAA;AAAA,IAAyB,eAAiC,wBAAwB,CAAA;AAAA,IAAG,MACnF,iBAAA,CAAkB;AAAA,MAChB,IAAA,EAAM,eAAA;AAAA,MACN,UAAA,EAAY;AAAA,QACV,CAAC,gCAAgC,GAAG,MAAA;AAAA,QACpC,CAAC,4BAA4B,GAAG;AAAA;AAClC,KACD;AAAA,GACH;AACF;AAEA,SAAS,qBAAqB,cAAA,EAAoD;AAChF,EAAA,wBAAA;AAAA,IACE,eAAoC,2BAA2B,CAAA;AAAA,IAC/D,CAAA,IAAA,KAAQ;AACN,MAAA,OAAO,iBAAA,CAAkB;AAAA,QACvB,IAAA,EAAM,kBAAA;AAAA,QACN,UAAA,EAAY;AAAA,UACV,CAAC,gCAAgC,GAAG,MAAA;AAAA,UACpC,CAAC,4BAA4B,GAAG,0BAAA;AAAA,UAChC,CAAC,gBAAgB,GAAG,sBAAA,CAAuB,KAAK,QAAQ;AAAA;AAC1D,OACD,CAAA;AAAA,IACH,CAAA;AAAA,IACA;AAAA,MACE,aAAA,EAAe,CAAC,IAAA,EAAM,IAAA,KAAS;AAE7B,QAAA,IAAI,KAAA,CAAM,QAAQ,IAAA,CAAK,MAAM,KAAK,IAAA,CAAK,MAAA,CAAO,SAAS,CAAA,EAAG;AACxD,UAAA,IAAA,CAAK,UAAU,EAAE,IAAA,EAAM,iBAAA,EAAmB,OAAA,EAAS,oBAAoB,CAAA;AAAA,QACzE;AAAA,MACF;AAAA;AACF,GACF;AACF;AAEA,SAAS,qBAAA,CACP,cAAA,EACA,WAAA,EACA,YAAA,EACA,2BAAA,EACM;AACN,EAAA,wBAAA;AAAA,IACE,eAAqC,WAAW,CAAA;AAAA,IAChD,CAAA,IAAA,KAAQ;AACN,MAAA,MAAM,OAAO,iBAAA,CAAkB;AAAA,QAC7B,MAAM,oBAAA,CAAqB,IAAA,CAAK,aAAA,EAAe,IAAA,CAAK,eAAe,YAAY,CAAA;AAAA,QAC/E,UAAA,EAAY;AAAA,UACV,CAAC,gCAAgC,GAAG,MAAA;AAAA,UACpC,CAAC,4BAA4B,GAAG,0BAAA;AAAA,UAChC,CAAC,sBAAsB,GAAG,IAAA,CAAK,aAAA;AAAA,UAC/B,CAAC,sBAAsB,GAAG,IAAA,CAAK,aAAA,IAAiB,MAAA;AAAA,UAChD,CAAC,gBAAgB,GAAG,sBAAA,CAAuB,KAAK,QAAQ;AAAA;AAC1D,OACD,CAAA;AAED,MAAA,IAAI,2BAAA,IAA+B,KAAK,aAAA,EAAe;AACrD,QAAA,2BAAA,CAA4B,IAAA,EAAM,IAAA,CAAK,aAAA,EAAe,IAAA,CAAK,aAAa,CAAA;AAAA,MAC1E;AAEA,MAAA,OAAO,IAAA;AAAA,IACT,CAAA;AAAA,IACA;AAAA,MACE,aAAA,EAAe,CAAC,IAAA,EAAM,IAAA,KAAS;AAE7B,QAAA,IAAI,eAAA,CAAgB,IAAA,CAAK,MAAM,CAAA,EAAG;AAChC,UAAA,IAAA,CAAK,UAAU,EAAE,IAAA,EAAM,iBAAA,EAAmB,OAAA,EAAS,kBAAkB,CAAA;AAAA,QACvE;AAAA,MACF;AAAA;AACF,GACF;AACF;AAEA,SAAS,mBAAA,CAAoB,gBAA8C,yBAAA,EAA0C;AACnH,EAAA,wBAAA,CAAyB,cAAA,CAAmC,0BAA0B,CAAA,EAAG,CAAA,IAAA,KAAQ;AAG/F,IAAA,IAAI,yBAAA,IAA6B,KAAK,iBAAA,EAAmB;AACvD,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,OAAO,iBAAA,CAAkB;AAAA,MACvB,IAAA,EAAM,CAAA,EAAG,iBAAiB,CAAA,CAAA,EAAI,KAAK,SAAS,CAAA,CAAA;AAAA,MAC5C,UAAA,EAAY;AAAA,QACV,CAAC,gCAAgC,GAAG,MAAA;AAAA,QACpC,CAAC,4BAA4B,GAAG,0BAAA;AAAA,QAChC,CAAC,kBAAkB,GAAG,IAAA,CAAK,SAAA;AAAA,QAC3B,CAAC,kBAAkB,GAAG,IAAA,CAAK,SAAA;AAAA,QAC3B,CAAC,kBAAkB,GAAG,IAAA,CAAK,SAAA;AAAA,QAC3B,CAAC,mBAAmB,GAAG,IAAA,CAAK;AAAA;AAC9B,KACD,CAAA;AAAA,EACH,CAAC,CAAA;AACH;;;;"}

package/build/esm/graphql/index.js

@@ -0,0 +1,21 @@
+import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
+import * as diagnosticsChannel from 'node:diagnostics_channel';
+import { subscribeGraphqlDiagnosticChannels } from './graphql-dc-subscriber.js';
+
+const _graphqlIntegration = ((options = {}) => {
+  return {
+    name: "Graphql",
+    setupOnce() {
+      if (!diagnosticsChannel.tracingChannel) {
+        return;
+      }
+      waitForTracingChannelBinding(() => {
+        subscribeGraphqlDiagnosticChannels(diagnosticsChannel.tracingChannel, options);
+      });
+    }
+  };
+});
+const graphqlIntegration = defineIntegration(_graphqlIntegration);
+
+export { graphqlIntegration };
+//# sourceMappingURL=index.js.map

package/build/esm/graphql/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/graphql/index.ts"],"sourcesContent":["import { defineIntegration, type IntegrationFn, waitForTracingChannelBinding } from '@sentry/core';\nimport * as dc from 'node:diagnostics_channel';\nimport { type GraphqlDiagnosticChannelsOptions, subscribeGraphqlDiagnosticChannels } from './graphql-dc-subscriber';\n\nconst _graphqlIntegration = ((options: GraphqlDiagnosticChannelsOptions = {}) => {\n  return {\n    name: 'Graphql' as const,\n    setupOnce() {\n      // Bail on Node <= 18.18.0, where `tracingChannel` does not exist.\n      if (!dc.tracingChannel) {\n        return;\n      }\n\n      // Subscribe to graphql's native tracing channels (graphql >= 17).\n      // This is a no-op on versions that don't publish to the channels, so it is always safe to call.\n      waitForTracingChannelBinding(() => {\n        subscribeGraphqlDiagnosticChannels(dc.tracingChannel, options);\n      });\n    },\n  };\n}) satisfies IntegrationFn;\n\n/**\n * Auto-instrument the [graphql](https://www.npmjs.com/package/graphql) library via its native\n * `node:diagnostics_channel` tracing channels (graphql >= 17).\n *\n * On older graphql versions the channels are never published to, so this integration is inert and\n * the vendored OTel instrumentation (gated to `< 17`) handles instrumentation instead.\n */\nexport const graphqlIntegration = defineIntegration(_graphqlIntegration);\n"],"names":["dc"],"mappings":";;;;AAIA,MAAM,mBAAA,IAAuB,CAAC,OAAA,GAA4C,EAAC,KAAM;AAC/E,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,SAAA;AAAA,IACN,SAAA,GAAY;AAEV,MAAA,IAAI,CAACA,mBAAG,cAAA,EAAgB;AACtB,QAAA;AAAA,MACF;AAIA,MAAA,4BAAA,CAA6B,MAAM;AACjC,QAAA,kCAAA,CAAmCA,kBAAA,CAAG,gBAAgB,OAAO,CAAA;AAAA,MAC/D,CAAC,CAAA;AAAA,IACH;AAAA,GACF;AACF,CAAA,CAAA;AASO,MAAM,kBAAA,GAAqB,kBAAkB,mBAAmB;;;;"}

package/build/esm/graphql/utils.js

@@ -0,0 +1,87 @@
+import { SENTRY_GRAPHQL_OPERATION } from '@sentry/conventions/attributes';
+import { getClient, isObjectLike, getRootSpan, spanToJSON } from '@sentry/core';
+
+const ORIGINAL_DESCRIPTION_ATTRIBUTE = "original-description";
+const REDACTED_LITERAL_KINDS = /* @__PURE__ */ new Set(["Int", "Float", "String", "BlockString"]);
+function renameRootSpanWithOperation(span, operationType, operationName) {
+  const rootSpan = getRootSpan(span);
+  if (rootSpan === span) {
+    return;
+  }
+  const rootSpanJson = spanToJSON(rootSpan);
+  const newOperation = operationName ? `${operationType} ${operationName}` : operationType;
+  const existingOperations = rootSpanJson.data[SENTRY_GRAPHQL_OPERATION];
+  let operations;
+  if (Array.isArray(existingOperations)) {
+    operations = [...existingOperations, newOperation];
+  } else if (typeof existingOperations === "string") {
+    operations = [existingOperations, newOperation];
+  } else {
+    operations = newOperation;
+  }
+  rootSpan.setAttribute(SENTRY_GRAPHQL_OPERATION, operations);
+  const originalDescription = rootSpanJson.data[ORIGINAL_DESCRIPTION_ATTRIBUTE] ?? rootSpanJson.description;
+  if (!rootSpanJson.data[ORIGINAL_DESCRIPTION_ATTRIBUTE]) {
+    rootSpan.setAttribute(ORIGINAL_DESCRIPTION_ATTRIBUTE, originalDescription);
+  }
+  rootSpan.updateName(`${originalDescription} (${getGraphqlOperationNamesFromAttribute(operations)})`);
+}
+function getGraphqlOperationNamesFromAttribute(attr) {
+  if (Array.isArray(attr)) {
+    const sorted = attr.slice().sort();
+    if (sorted.length <= 5) {
+      return sorted.join(", ");
+    }
+    return `${sorted.slice(0, 5).join(", ")}, +${sorted.length - 5}`;
+  }
+  return attr;
+}
+function getOperationSpanName(operationType, operationName, fallbackName) {
+  if (operationType && operationName) {
+    return `${operationType} ${operationName}`;
+  }
+  if (operationType) {
+    return operationType;
+  }
+  return fallbackName;
+}
+function hasResultErrors(result) {
+  if (isObjectLike(result) && "errors" in result) {
+    const errors = result.errors;
+    return Array.isArray(errors) && errors.length > 0;
+  }
+  return false;
+}
+function redactGraphqlDocument(document) {
+  const loc = document?.loc;
+  const body = loc?.source?.body;
+  if (typeof body !== "string" || !loc?.startToken) {
+    return void 0;
+  }
+  try {
+    const ranges = [];
+    for (let token = loc.startToken; token; token = token.next) {
+      if (REDACTED_LITERAL_KINDS.has(token.kind)) {
+        ranges.push({ start: token.start, end: token.end, kind: token.kind });
+      }
+    }
+    let out = body;
+    for (let i = ranges.length - 1; i >= 0; i--) {
+      const { start, end, kind } = ranges[i];
+      const replacement = kind === "String" || kind === "BlockString" ? '"*"' : "*";
+      out = out.slice(0, start) + replacement + out.slice(end);
+    }
+    return out;
+  } catch {
+    return void 0;
+  }
+}
+function collectGraphqlDocument(document) {
+  if (getClient()?.getDataCollectionOptions().graphQL.document !== true) {
+    return void 0;
+  }
+  return redactGraphqlDocument(document);
+}
+
+export { collectGraphqlDocument, getOperationSpanName, hasResultErrors, renameRootSpanWithOperation };
+//# sourceMappingURL=utils.js.map

package/build/esm/graphql/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../../../src/graphql/utils.ts"],"sourcesContent":["import { SENTRY_GRAPHQL_OPERATION } from '@sentry/conventions/attributes';\nimport type { Span } from '@sentry/core';\nimport { getClient, isObjectLike, getRootSpan, spanToJSON } from '@sentry/core';\n\n// Same key the OTel path uses, so renames stay consistent across both.\nconst ORIGINAL_DESCRIPTION_ATTRIBUTE = 'original-description';\n\n// graphql-js token kinds whose values may carry user data (literal arguments). We\n// replace them in the serialized document so raw inline values can never reach\n// `graphql.document`. Mirrors the legacy OTel instrumentation's redaction set.\nconst REDACTED_LITERAL_KINDS = new Set(['Int', 'Float', 'String', 'BlockString']);\n\n/** Minimal shape of a graphql-js lexer token, enough to locate literal spans for redaction. */\ninterface GraphqlToken {\n  kind: string;\n  start: number;\n  end: number;\n  next?: GraphqlToken | null;\n}\n\n/** Minimal shape of a parsed graphql-js `DocumentNode`, enough to read its source and tokens. */\nexport interface GraphqlDocumentNode {\n  loc?: {\n    startToken?: GraphqlToken;\n    source?: { body?: string };\n  };\n}\n\n/**\n * Rename the enclosing root span to include the operation name(s), e.g. `GET /graphql (query GetUser)`.\n * Mirrors the legacy OTel `useOperationNameForRootSpan` behavior; `parseSpanDescription` reads the same\n * `sentry.graphql.operation` attribute on the OTel export path.\n */\nexport function renameRootSpanWithOperation(span: Span, operationType: string, operationName?: string): void {\n  const rootSpan = getRootSpan(span);\n  // Nothing to rename if the operation span is itself the root (graphql ran outside any span).\n  if (rootSpan === span) {\n    return;\n  }\n\n  const rootSpanJson = spanToJSON(rootSpan);\n\n  const newOperation = operationName ? `${operationType} ${operationName}` : operationType;\n\n  // A single operation is stored as a string, multiple as an array.\n  const existingOperations = rootSpanJson.data[SENTRY_GRAPHQL_OPERATION];\n  let operations: string | string[];\n  if (Array.isArray(existingOperations)) {\n    operations = [...(existingOperations as string[]), newOperation];\n  } else if (typeof existingOperations === 'string') {\n    operations = [existingOperations, newOperation];\n  } else {\n    operations = newOperation;\n  }\n  rootSpan.setAttribute(SENTRY_GRAPHQL_OPERATION, operations);\n\n  // Keep the pre-rename name so repeated renames don't compound.\n  const originalDescription =\n    (rootSpanJson.data[ORIGINAL_DESCRIPTION_ATTRIBUTE] as string | undefined) ?? rootSpanJson.description;\n  if (!rootSpanJson.data[ORIGINAL_DESCRIPTION_ATTRIBUTE]) {\n    rootSpan.setAttribute(ORIGINAL_DESCRIPTION_ATTRIBUTE, originalDescription);\n  }\n\n  rootSpan.updateName(`${originalDescription} (${getGraphqlOperationNamesFromAttribute(operations)})`);\n}\n\n/** Format the accumulated operations for the root span name: up to 5 sorted names, then `+N`. */\nfunction getGraphqlOperationNamesFromAttribute(attr: string | string[]): string {\n  if (Array.isArray(attr)) {\n    // oxlint-disable-next-line typescript/require-array-sort-compare\n    const sorted = attr.slice().sort();\n    if (sorted.length <= 5) {\n      return sorted.join(', ');\n    }\n\n    return `${sorted.slice(0, 5).join(', ')}, +${sorted.length - 5}`;\n  }\n\n  return attr;\n}\n\n/**\n * Span name follows the GraphQL semantic conventions: `<operation.type> <operation.name>` when both\n * are available, `<operation.type>` when only the type is, otherwise a static fallback.\n */\nexport function getOperationSpanName(\n  operationType: string | undefined,\n  operationName: string | undefined,\n  fallbackName: string,\n): string {\n  if (operationType && operationName) {\n    return `${operationType} ${operationName}`;\n  }\n  if (operationType) {\n    return operationType;\n  }\n\n  return fallbackName;\n}\n\n/** Whether a graphql execution result carries GraphQL errors (returned on `result.errors`). */\nexport function hasResultErrors(result: unknown): boolean {\n  if (isObjectLike(result) && 'errors' in result) {\n    const errors = (result as { errors?: unknown }).errors;\n\n    return Array.isArray(errors) && errors.length > 0;\n  }\n\n  return false;\n}\n\n/**\n * Serialize a parsed document into `graphql.document` while redacting every literal argument value:\n * the original source text is preserved verbatim except that string/number literal spans are\n * replaced (`\"foo\"` -> `\"*\"`, `42` -> `*`). graphql does not sanitize its channel payload, so this\n * prevents raw inline values (potential PII) from leaving the process. Variable values are never\n * included. Returns `undefined` (rather than throwing) on anything it cannot serialize.\n */\nfunction redactGraphqlDocument(document: GraphqlDocumentNode | undefined): string | undefined {\n  const loc = document?.loc;\n  const body = loc?.source?.body;\n  if (typeof body !== 'string' || !loc?.startToken) {\n    return undefined;\n  }\n\n  try {\n    // Collect literal token spans, then splice them out back-to-front so earlier offsets stay valid.\n    const ranges: Array<{ start: number; end: number; kind: string }> = [];\n    for (let token: GraphqlToken | null | undefined = loc.startToken; token; token = token.next) {\n      if (REDACTED_LITERAL_KINDS.has(token.kind)) {\n        ranges.push({ start: token.start, end: token.end, kind: token.kind });\n      }\n    }\n\n    let out = body;\n    // Reverse index loop (not `for...of`) so we splice back-to-front; `i` is bounded by the loop, so\n    // `ranges[i]` is always present and the `!` just satisfies `noUncheckedIndexedAccess`.\n    for (let i = ranges.length - 1; i >= 0; i--) {\n      const { start, end, kind } = ranges[i]!;\n      const replacement = kind === 'String' || kind === 'BlockString' ? '\"*\"' : '*';\n      out = out.slice(0, start) + replacement + out.slice(end);\n    }\n\n    return out;\n  } catch {\n    return undefined;\n  }\n}\n\n/**\n * Returns the redacted document if `dataCollection.graphQL.document` is enabled, `undefined` otherwise.\n */\nexport function collectGraphqlDocument(document: GraphqlDocumentNode | undefined): string | undefined {\n  if (getClient()?.getDataCollectionOptions().graphQL.document !== true) {\n    return undefined;\n  }\n  return redactGraphqlDocument(document);\n}\n"],"names":[],"mappings":";;;AAKA,MAAM,8BAAA,GAAiC,sBAAA;AAKvC,MAAM,sBAAA,uBAA6B,GAAA,CAAI,CAAC,OAAO,OAAA,EAAS,QAAA,EAAU,aAAa,CAAC,CAAA;AAuBzE,SAAS,2BAAA,CAA4B,IAAA,EAAY,aAAA,EAAuB,aAAA,EAA8B;AAC3G,EAAA,MAAM,QAAA,GAAW,YAAY,IAAI,CAAA;AAEjC,EAAA,IAAI,aAAa,IAAA,EAAM;AACrB,IAAA;AAAA,EACF;AAEA,EAAA,MAAM,YAAA,GAAe,WAAW,QAAQ,CAAA;AAExC,EAAA,MAAM,eAAe,aAAA,GAAgB,CAAA,EAAG,aAAa,CAAA,CAAA,EAAI,aAAa,CAAA,CAAA,GAAK,aAAA;AAG3E,EAAA,MAAM,kBAAA,GAAqB,YAAA,CAAa,IAAA,CAAK,wBAAwB,CAAA;AACrE,EAAA,IAAI,UAAA;AACJ,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,kBAAkB,CAAA,EAAG;AACrC,IAAA,UAAA,GAAa,CAAC,GAAI,kBAAA,EAAiC,YAAY,CAAA;AAAA,EACjE,CAAA,MAAA,IAAW,OAAO,kBAAA,KAAuB,QAAA,EAAU;AACjD,IAAA,UAAA,GAAa,CAAC,oBAAoB,YAAY,CAAA;AAAA,EAChD,CAAA,MAAO;AACL,IAAA,UAAA,GAAa,YAAA;AAAA,EACf;AACA,EAAA,QAAA,CAAS,YAAA,CAAa,0BAA0B,UAAU,CAAA;AAG1D,EAAA,MAAM,mBAAA,GACH,YAAA,CAAa,IAAA,CAAK,8BAA8B,KAA4B,YAAA,CAAa,WAAA;AAC5F,EAAA,IAAI,CAAC,YAAA,CAAa,IAAA,CAAK,8BAA8B,CAAA,EAAG;AACtD,IAAA,QAAA,CAAS,YAAA,CAAa,gCAAgC,mBAAmB,CAAA;AAAA,EAC3E;AAEA,EAAA,QAAA,CAAS,WAAW,CAAA,EAAG,mBAAmB,KAAK,qCAAA,CAAsC,UAAU,CAAC,CAAA,CAAA,CAAG,CAAA;AACrG;AAGA,SAAS,sCAAsC,IAAA,EAAiC;AAC9E,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,IAAI,CAAA,EAAG;AAEvB,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,KAAA,EAAM,CAAE,IAAA,EAAK;AACjC,IAAA,IAAI,MAAA,CAAO,UAAU,CAAA,EAAG;AACtB,MAAA,OAAO,MAAA,CAAO,KAAK,IAAI,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,CAAA,EAAG,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,CAAC,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA,GAAA,EAAM,MAAA,CAAO,MAAA,GAAS,CAAC,CAAA,CAAA;AAAA,EAChE;AAEA,EAAA,OAAO,IAAA;AACT;AAMO,SAAS,oBAAA,CACd,aAAA,EACA,aAAA,EACA,YAAA,EACQ;AACR,EAAA,IAAI,iBAAiB,aAAA,EAAe;AAClC,IAAA,OAAO,CAAA,EAAG,aAAa,CAAA,CAAA,EAAI,aAAa,CAAA,CAAA;AAAA,EAC1C;AACA,EAAA,IAAI,aAAA,EAAe;AACjB,IAAA,OAAO,aAAA;AAAA,EACT;AAEA,EAAA,OAAO,YAAA;AACT;AAGO,SAAS,gBAAgB,MAAA,EAA0B;AACxD,EAAA,IAAI,YAAA,CAAa,MAAM,CAAA,IAAK,QAAA,IAAY,MAAA,EAAQ;AAC9C,IAAA,MAAM,SAAU,MAAA,CAAgC,MAAA;AAEhD,IAAA,OAAO,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,MAAA,GAAS,CAAA;AAAA,EAClD;AAEA,EAAA,OAAO,KAAA;AACT;AASA,SAAS,sBAAsB,QAAA,EAA+D;AAC5F,EAAA,MAAM,MAAM,QAAA,EAAU,GAAA;AACtB,EAAA,MAAM,IAAA,GAAO,KAAK,MAAA,EAAQ,IAAA;AAC1B,EAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,CAAC,KAAK,UAAA,EAAY;AAChD,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,IAAI;AAEF,IAAA,MAAM,SAA8D,EAAC;AACrE,IAAA,KAAA,IAAS,QAAyC,GAAA,CAAI,UAAA,EAAY,KAAA,EAAO,KAAA,GAAQ,MAAM,IAAA,EAAM;AAC3F,MAAA,IAAI,sBAAA,CAAuB,GAAA,CAAI,KAAA,CAAM,IAAI,CAAA,EAAG;AAC1C,QAAA,MAAA,CAAO,IAAA,CAAK,EAAE,KAAA,EAAO,KAAA,CAAM,KAAA,EAAO,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,IAAA,EAAM,KAAA,CAAM,IAAA,EAAM,CAAA;AAAA,MACtE;AAAA,IACF;AAEA,IAAA,IAAI,GAAA,GAAM,IAAA;AAGV,IAAA,KAAA,IAAS,IAAI,MAAA,CAAO,MAAA,GAAS,CAAA,EAAG,CAAA,IAAK,GAAG,CAAA,EAAA,EAAK;AAC3C,MAAA,MAAM,EAAE,KAAA,EAAO,GAAA,EAAK,IAAA,EAAK,GAAI,OAAO,CAAC,CAAA;AACrC,MAAA,MAAM,WAAA,GAAc,IAAA,KAAS,QAAA,IAAY,IAAA,KAAS,gBAAgB,KAAA,GAAQ,GAAA;AAC1E,MAAA,GAAA,GAAM,GAAA,CAAI,MAAM,CAAA,EAAG,KAAK,IAAI,WAAA,GAAc,GAAA,CAAI,MAAM,GAAG,CAAA;AAAA,IACzD;AAEA,IAAA,OAAO,GAAA;AAAA,EACT,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAKO,SAAS,uBAAuB,QAAA,EAA+D;AACpG,EAAA,IAAI,WAAU,EAAG,wBAAA,EAAyB,CAAE,OAAA,CAAQ,aAAa,IAAA,EAAM;AACrE,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAO,sBAAsB,QAAQ,CAAA;AACvC;;;;"}

package/build/esm/index.js

@@ -0,0 +1,12 @@
+export { graphqlIntegration } from './graphql/index.js';
+export { mongooseIntegration } from './mongoose/index.js';
+export { getV3CommandOperation, getV3SpanAttributes, getV4SpanAttributes, startMongoSpan } from './mongodb/mongodb-span.js';
+export { mysql2Integration } from './mysql2/index.js';
+export { instrumentPrisma, prismaIntegration } from './prisma/index.js';
+export { redisIntegration } from './redis/index.js';
+export { defaultDbStatementSerializer } from './redis/redis-statement-serializer.js';
+export { bindTracingChannelToSpan } from './tracing-channel.js';
+export { vercelAiIntegration } from './vercel-ai/index.js';
+export { fastifyIntegration, handleFastifyError, instrumentFastify } from './integrations/tracing-channel/fastify/index.js';
+export { startMongooseLegacySpan } from './mongoose/mongoose-legacy-span.js';
+//# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}