@envelop/sentry 4.0.0-alpha-36a1267.0 → 4.0.0-alpha-5b6bfa8.0

package/README.md

@@ -30,22 +30,24 @@ yarn add @sentry/node @sentry/tracing @envelop/sentry
 ## Usage Example
 
 ```ts
-import { envelop } from '@envelop/core';
-import { useSentry } from '@envelop/sentry';
+import { envelop } from '@envelop/core'
+import { useSentry } from '@envelop/sentry'
+// do this only once in you entry file.
+import '@sentry/tracing'
 
 const getEnveloped = envelop({
   plugins: [
     // ... other plugins ...
     useSentry({
-      includeRawResult: false // set to `true` in order to include the execution result in the metadata collected
+      includeRawResult: false, // set to `true` in order to include the execution result in the metadata collected
       includeResolverArgs: false, // set to `true` in order to include the args passed to resolvers
       includeExecuteVariables: false, // set to `true` in order to include the operation variables values
-      appendTags: (args) => { return { ... }} // if you wish to add custom "tags" to the Sentry transaction created per operation
-      configureScope: (args, scope) => { return { ... }} // if you wish to modify the Sentry scope
-      skip: (executionArgs) => { return { ... }} // if you wish to modify the skip specific operations
-    }),
-  ],
-});
+      appendTags: args => {}, // if you wish to add custom "tags" to the Sentry transaction created per operation
+      configureScope: (args, scope) => {}, // if you wish to modify the Sentry scope
+      skip: executionArgs => {} // if you wish to modify the skip specific operations
+    })
+  ]
+})
 ```
 
 ### Configuration
@@ -59,6 +61,8 @@ const getEnveloped = envelop({
 - `appendTags` - See example above. Allow you to manipulate the tags reports on the Sentry transaction.
 - `configureScope` - See example above. Allow you to manipulate the tags reports on the Sentry transaction.
 - `transactionName` (default: operation name) - Produces a name of Transaction (only when "renameTransaction" or "startTransaction" are enabled) and description of created Span.
+- `traceparentData` (default: `{}`) - Adds tracing data to be sent to Sentry - this includes traceId, parentId and more.
 - `operationName` - Produces a "op" (operation) of created Span.
 - `skip` (default: none) - Produces a "op" (operation) of created Span.
 - `skipError` (default: ignored `EnvelopError`) - Indicates whether or not to skip Sentry exception reporting for a given error. By default, this plugin skips all `EnvelopError` errors and does not report it to Sentry.
+- `eventIdKey` (default: `'sentryEventId'`) - The key in the error's extensions field used to expose the generated Sentry event id. Set to `null` to disable.

package/{index.js → cjs/index.js}

@@ -1,15 +1,14 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const core = require('@envelop/core');
-const Sentry = require('@sentry/node');
-const graphql = require('graphql');
-
-/* eslint-disable @typescript-eslint/no-empty-function */
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSentry = exports.defaultSkipError = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@envelop/core");
+const Sentry = tslib_1.__importStar(require("@sentry/node"));
+const graphql_1 = require("@graphql-tools/graphql");
 function defaultSkipError(error) {
-    return error instanceof core.EnvelopError;
+    return error instanceof core_1.EnvelopError;
 }
+exports.defaultSkipError = defaultSkipError;
 const sentryTracingSymbol = Symbol('sentryTracing');
 const useSentry = (options = {}) => {
     function pick(key, defaultValue) {
@@ -24,6 +23,17 @@ const useSentry = (options = {}) => {
     const renameTransaction = pick('renameTransaction', false);
     const skipOperation = pick('skip', () => false);
     const skipError = pick('skipError', defaultSkipError);
+    function addEventId(err, eventId) {
+        var _a;
+        if (options.eventIdKey === null) {
+            return err;
+        }
+        const eventIdKey = (_a = options.eventIdKey) !== null && _a !== void 0 ? _a : 'sentryEventId';
+        return new graphql_1.GraphQLError(err.message, err.nodes, err.source, err.positions, err.path, undefined, {
+            ...err.extensions,
+            [eventIdKey]: eventId,
+        });
+    }
     const onResolverCalled = trackResolvers
         ? ({ args: resolversArgs, info, context }) => {
             const { rootSpan, opName, operationType } = context[sentryTracingSymbol];
@@ -47,7 +57,10 @@ const useSentry = (options = {}) => {
                         childSpan.setData('result', result);
                     }
                     if (result instanceof Error && !skipError(result)) {
-                        const errorPath = graphql.responsePathAsArray(info.path).join(' > ');
+                        // Map index values in list to $index for better grouping of events.
+                        const errorPath = (0, graphql_1.responsePathAsArray)(info.path)
+                            .map(v => (typeof v === 'number' ? '$index' : v))
+                            .join(' > ');
                         Sentry.captureException(result, {
                             fingerprint: ['graphql', errorPath, opName, operationType],
                         });
@@ -65,17 +78,18 @@ const useSentry = (options = {}) => {
             if (skipOperation(args)) {
                 return;
             }
-            const rootOperation = args.document.definitions.find(o => o.kind === graphql.Kind.OPERATION_DEFINITION);
+            const rootOperation = args.document.definitions.find(o => o.kind === graphql_1.Kind.OPERATION_DEFINITION);
             const operationType = rootOperation.operation;
-            const document = graphql.print(args.document);
+            const document = (0, graphql_1.print)(args.document);
             const opName = args.operationName || ((_a = rootOperation.name) === null || _a === void 0 ? void 0 : _a.value) || 'Anonymous Operation';
             const addedTags = (options.appendTags && options.appendTags(args)) || {};
+            const traceparentData = (options.traceparentData && options.traceparentData(args)) || {};
             const transactionName = options.transactionName ? options.transactionName(args) : opName;
             const op = options.operationName ? options.operationName(args) : 'execute';
             const tags = {
                 operationName: opName,
                 operation: operationType,
-                ...(addedTags || {}),
+                ...addedTags,
             };
             let rootSpan;
             if (startTransaction) {
@@ -83,7 +97,15 @@ const useSentry = (options = {}) => {
                     name: transactionName,
                     op,
                     tags,
+                    ...traceparentData,
                 });
+                if (!rootSpan) {
+                    const error = [
+                        `Could not create the root Sentry transaction for the GraphQL operation "${transactionName}".`,
+                        `It's very likely that this is because you have not included the Sentry tracing SDK in your app's runtime before handling the request.`,
+                    ];
+                    throw new Error(error.join('\n'));
+                }
             }
             else {
                 const scope = Sentry.getCurrentHub().getScope();
@@ -94,6 +116,7 @@ const useSentry = (options = {}) => {
                     tags,
                 });
                 if (!span) {
+                    // eslint-disable-next-line no-console
                     console.warn([
                         `Flag "startTransaction" is enabled but Sentry failed to find a transaction.`,
                         `Try to create a transaction before GraphQL execution phase is started.`,
@@ -118,19 +141,14 @@ const useSentry = (options = {}) => {
                 extendContext({ [sentryTracingSymbol]: sentryContext });
             }
             return {
-                onExecuteDone({ result }) {
-                    if (core.isAsyncIterable(result)) {
-                        rootSpan.finish();
-                        // eslint-disable-next-line no-console
-                        console.warn(`Plugin "sentry" encountered a AsyncIterator which is not supported yet, so tracing data is not available for the operation.`);
-                        return;
-                    }
-                    if (includeRawResult) {
-                        rootSpan.setData('result', result);
-                    }
-                    if (result.errors && result.errors.length > 0) {
-                        for (const err of result.errors) {
+                onExecuteDone(payload) {
+                    const handleResult = ({ result, setResult }) => {
+                        if (includeRawResult) {
+                            rootSpan.setData('result', result);
+                        }
+                        if (result.errors && result.errors.length > 0) {
                             Sentry.withScope(scope => {
+                                var _a;
                                 scope.setTransactionName(opName);
                                 scope.setTag('operation', operationType);
                                 scope.setTag('operationName', opName);
@@ -142,33 +160,44 @@ const useSentry = (options = {}) => {
                                 if (includeExecuteVariables) {
                                     scope.setExtra('variables', args.variableValues);
                                 }
-                                const errorPath = (err.path || []).join(' > ');
-                                if (errorPath) {
-                                    scope.addBreadcrumb({
-                                        category: 'execution-path',
-                                        message: errorPath,
-                                        level: Sentry.Severity.Debug,
-                                    });
-                                }
-                                Sentry.captureException(err, {
-                                    fingerprint: ['graphql', errorPath, opName, operationType],
-                                    contexts: {
-                                        GraphQL: {
-                                            operationName: opName,
-                                            operationType: operationType,
-                                            variables: args.variableValues,
+                                const errors = (_a = result.errors) === null || _a === void 0 ? void 0 : _a.map(err => {
+                                    var _a, _b;
+                                    const errorPath = ((_a = err.path) !== null && _a !== void 0 ? _a : []).join(' > ');
+                                    if (errorPath) {
+                                        scope.addBreadcrumb({
+                                            category: 'execution-path',
+                                            message: errorPath,
+                                            level: 'debug',
+                                        });
+                                    }
+                                    // Map index values in list to $index for better grouping of events.
+                                    const errorPathWithIndex = ((_b = err.path) !== null && _b !== void 0 ? _b : [])
+                                        .map(v => (typeof v === 'number' ? '$index' : v))
+                                        .join(' > ');
+                                    const eventId = Sentry.captureException(err, {
+                                        fingerprint: ['graphql', errorPathWithIndex, opName, operationType],
+                                        contexts: {
+                                            GraphQL: {
+                                                operationName: opName,
+                                                operationType,
+                                                variables: args.variableValues,
+                                            },
                                         },
-                                    },
+                                    });
+                                    return addEventId(err, eventId);
+                                });
+                                setResult({
+                                    ...result,
+                                    errors,
                                 });
                             });
                         }
-                    }
-                    rootSpan.finish();
+                        rootSpan.finish();
+                    };
+                    return (0, core_1.handleStreamOrSingleExecutionResult)(payload, handleResult);
                 },
             };
         },
     };
 };
-
-exports.defaultSkipError = defaultSkipError;
 exports.useSentry = useSentry;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/{index.mjs → esm/index.js}

@@ -1,18 +1,16 @@
-import { EnvelopError, isAsyncIterable } from '@envelop/core';
-import { startTransaction, getCurrentHub, configureScope, withScope, Severity, captureException } from '@sentry/node';
-import { Kind, print, responsePathAsArray } from 'graphql';
-
-/* eslint-disable @typescript-eslint/no-empty-function */
-function defaultSkipError(error) {
+import { EnvelopError, handleStreamOrSingleExecutionResult, } from '@envelop/core';
+import * as Sentry from '@sentry/node';
+import { GraphQLError, Kind, print, responsePathAsArray, } from '@graphql-tools/graphql';
+export function defaultSkipError(error) {
     return error instanceof EnvelopError;
 }
 const sentryTracingSymbol = Symbol('sentryTracing');
-const useSentry = (options = {}) => {
+export const useSentry = (options = {}) => {
     function pick(key, defaultValue) {
         var _a;
         return (_a = options[key]) !== null && _a !== void 0 ? _a : defaultValue;
     }
-    const startTransaction$1 = pick('startTransaction', true);
+    const startTransaction = pick('startTransaction', true);
     const trackResolvers = pick('trackResolvers', true);
     const includeResolverArgs = pick('includeResolverArgs', false);
     const includeRawResult = pick('includeRawResult', false);
@@ -20,6 +18,17 @@ const useSentry = (options = {}) => {
     const renameTransaction = pick('renameTransaction', false);
     const skipOperation = pick('skip', () => false);
     const skipError = pick('skipError', defaultSkipError);
+    function addEventId(err, eventId) {
+        var _a;
+        if (options.eventIdKey === null) {
+            return err;
+        }
+        const eventIdKey = (_a = options.eventIdKey) !== null && _a !== void 0 ? _a : 'sentryEventId';
+        return new GraphQLError(err.message, err.nodes, err.source, err.positions, err.path, undefined, {
+            ...err.extensions,
+            [eventIdKey]: eventId,
+        });
+    }
     const onResolverCalled = trackResolvers
         ? ({ args: resolversArgs, info, context }) => {
             const { rootSpan, opName, operationType } = context[sentryTracingSymbol];
@@ -43,8 +52,11 @@ const useSentry = (options = {}) => {
                         childSpan.setData('result', result);
                     }
                     if (result instanceof Error && !skipError(result)) {
-                        const errorPath = responsePathAsArray(info.path).join(' > ');
-                        captureException(result, {
+                        // Map index values in list to $index for better grouping of events.
+                        const errorPath = responsePathAsArray(info.path)
+                            .map(v => (typeof v === 'number' ? '$index' : v))
+                            .join(' > ');
+                        Sentry.captureException(result, {
                             fingerprint: ['graphql', errorPath, opName, operationType],
                         });
                     }
@@ -66,23 +78,32 @@ const useSentry = (options = {}) => {
             const document = print(args.document);
             const opName = args.operationName || ((_a = rootOperation.name) === null || _a === void 0 ? void 0 : _a.value) || 'Anonymous Operation';
             const addedTags = (options.appendTags && options.appendTags(args)) || {};
+            const traceparentData = (options.traceparentData && options.traceparentData(args)) || {};
             const transactionName = options.transactionName ? options.transactionName(args) : opName;
             const op = options.operationName ? options.operationName(args) : 'execute';
             const tags = {
                 operationName: opName,
                 operation: operationType,
-                ...(addedTags || {}),
+                ...addedTags,
             };
             let rootSpan;
-            if (startTransaction$1) {
-                rootSpan = startTransaction({
+            if (startTransaction) {
+                rootSpan = Sentry.startTransaction({
                     name: transactionName,
                     op,
                     tags,
+                    ...traceparentData,
                 });
+                if (!rootSpan) {
+                    const error = [
+                        `Could not create the root Sentry transaction for the GraphQL operation "${transactionName}".`,
+                        `It's very likely that this is because you have not included the Sentry tracing SDK in your app's runtime before handling the request.`,
+                    ];
+                    throw new Error(error.join('\n'));
+                }
             }
             else {
-                const scope = getCurrentHub().getScope();
+                const scope = Sentry.getCurrentHub().getScope();
                 const parentSpan = scope === null || scope === void 0 ? void 0 : scope.getSpan();
                 const span = parentSpan === null || parentSpan === void 0 ? void 0 : parentSpan.startChild({
                     description: transactionName,
@@ -90,6 +111,7 @@ const useSentry = (options = {}) => {
                     tags,
                 });
                 if (!span) {
+                    // eslint-disable-next-line no-console
                     console.warn([
                         `Flag "startTransaction" is enabled but Sentry failed to find a transaction.`,
                         `Try to create a transaction before GraphQL execution phase is started.`,
@@ -103,7 +125,7 @@ const useSentry = (options = {}) => {
             }
             rootSpan.setData('document', document);
             if (options.configureScope) {
-                configureScope(scope => options.configureScope(args, scope));
+                Sentry.configureScope(scope => options.configureScope(args, scope));
             }
             if (onResolverCalled) {
                 const sentryContext = {
@@ -114,19 +136,14 @@ const useSentry = (options = {}) => {
                 extendContext({ [sentryTracingSymbol]: sentryContext });
             }
             return {
-                onExecuteDone({ result }) {
-                    if (isAsyncIterable(result)) {
-                        rootSpan.finish();
-                        // eslint-disable-next-line no-console
-                        console.warn(`Plugin "sentry" encountered a AsyncIterator which is not supported yet, so tracing data is not available for the operation.`);
-                        return;
-                    }
-                    if (includeRawResult) {
-                        rootSpan.setData('result', result);
-                    }
-                    if (result.errors && result.errors.length > 0) {
-                        for (const err of result.errors) {
-                            withScope(scope => {
+                onExecuteDone(payload) {
+                    const handleResult = ({ result, setResult }) => {
+                        if (includeRawResult) {
+                            rootSpan.setData('result', result);
+                        }
+                        if (result.errors && result.errors.length > 0) {
+                            Sentry.withScope(scope => {
+                                var _a;
                                 scope.setTransactionName(opName);
                                 scope.setTag('operation', operationType);
                                 scope.setTag('operationName', opName);
@@ -138,32 +155,43 @@ const useSentry = (options = {}) => {
                                 if (includeExecuteVariables) {
                                     scope.setExtra('variables', args.variableValues);
                                 }
-                                const errorPath = (err.path || []).join(' > ');
-                                if (errorPath) {
-                                    scope.addBreadcrumb({
-                                        category: 'execution-path',
-                                        message: errorPath,
-                                        level: Severity.Debug,
-                                    });
-                                }
-                                captureException(err, {
-                                    fingerprint: ['graphql', errorPath, opName, operationType],
-                                    contexts: {
-                                        GraphQL: {
-                                            operationName: opName,
-                                            operationType: operationType,
-                                            variables: args.variableValues,
+                                const errors = (_a = result.errors) === null || _a === void 0 ? void 0 : _a.map(err => {
+                                    var _a, _b;
+                                    const errorPath = ((_a = err.path) !== null && _a !== void 0 ? _a : []).join(' > ');
+                                    if (errorPath) {
+                                        scope.addBreadcrumb({
+                                            category: 'execution-path',
+                                            message: errorPath,
+                                            level: 'debug',
+                                        });
+                                    }
+                                    // Map index values in list to $index for better grouping of events.
+                                    const errorPathWithIndex = ((_b = err.path) !== null && _b !== void 0 ? _b : [])
+                                        .map(v => (typeof v === 'number' ? '$index' : v))
+                                        .join(' > ');
+                                    const eventId = Sentry.captureException(err, {
+                                        fingerprint: ['graphql', errorPathWithIndex, opName, operationType],
+                                        contexts: {
+                                            GraphQL: {
+                                                operationName: opName,
+                                                operationType,
+                                                variables: args.variableValues,
+                                            },
                                         },
-                                    },
+                                    });
+                                    return addEventId(err, eventId);
+                                });
+                                setResult({
+                                    ...result,
+                                    errors,
                                 });
                             });
                         }
-                    }
-                    rootSpan.finish();
+                        rootSpan.finish();
+                    };
+                    return handleStreamOrSingleExecutionResult(payload, handleResult);
                 },
             };
         },
     };
 };
-
-export { defaultSkipError, useSentry };

package/package.json

@@ -1,34 +1,56 @@
 {
   "name": "@envelop/sentry",
-  "version": "4.0.0-alpha-36a1267.0",
+  "version": "4.0.0-alpha-5b6bfa8.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.1.0-alpha-36a1267.0",
-    "@sentry/node": "^6",
-    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
+    "@envelop/core": "3.0.0-alpha-5b6bfa8.0",
+    "@sentry/node": "^6 || ^7",
+    "@graphql-tools/graphql": "0.1.0-alpha-33fb2950.0"
   },
+  "dependencies": {},
   "repository": {
     "type": "git",
-    "url": "https://github.com/dotansimha/envelop.git",
+    "url": "https://github.com/n1ru4l/envelop.git",
     "directory": "packages/plugins/sentry"
   },
   "author": "Dotan Simha <dotansimha@gmail.com>",
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
   "typescript": {
-    "definition": "index.d.ts"
+    "definition": "typings/index.d.ts"
   },
+  "type": "module",
   "exports": {
     ".": {
-      "require": "./index.js",
-      "import": "./index.mjs"
+      "require": {
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
     },
     "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
+      "require": {
+        "types": "./typings/*.d.ts",
+        "default": "./cjs/*.js"
+      },
+      "import": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      },
+      "default": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      }
     },
     "./package.json": "./package.json"
   }
-}
+}

package/{index.d.ts → typings/index.d.ts}

@@ -1,6 +1,7 @@
 import { Plugin } from '@envelop/core';
 import * as Sentry from '@sentry/node';
-import { ExecutionArgs } from 'graphql';
+import type { TraceparentData } from '@sentry/types';
+import { ExecutionArgs } from '@graphql-tools/graphql';
 export declare type SentryPluginOptions = {
     /**
      * Starts a new transaction for every GraphQL Operation.
@@ -34,6 +35,11 @@ export declare type SentryPluginOptions = {
      * @default false
      */
     includeExecuteVariables?: boolean;
+    /**
+     * The key of the event id in the error's extension. `null` to disable.
+     * @default sentryEventId
+     */
+    eventIdKey?: string | null;
     /**
      * Adds custom tags to every Transaction.
      */
@@ -48,6 +54,12 @@ export declare type SentryPluginOptions = {
      * @default operation's name or "Anonymous Operation" when missing)
      */
     transactionName?: (args: ExecutionArgs) => string;
+    /**
+     * Produces tracing data for Transaction
+     *
+     * @default is empty
+     */
+    traceparentData?: (args: ExecutionArgs) => TraceparentData | undefined;
     /**
      * Produces a "op" (operation) of created Span.
      *