@envelop/sentry 5.0.0 → 5.1.0-alpha-20230210074029-bceea042

package/README.md

@@ -1,28 +1,28 @@
 ## `@envelop/sentry`
 
-This plugins collects errors and performance tracing for your execution flow, and reports it to [Sentry](https://sentry.io/).
+This plugin collects errors and performance tracing for your execution flow, and reports it to [Sentry](https://sentry.io).
 
 This is how it looks like in Sentry for error tracking:
 
-![Example](./packages/plugins/sentry/error1.png)
-![Example](./packages/plugins/sentry/error2.png)
+![Example](./error1.png)
+![Example](./error2.png)
 
 > The operation name, document, variables are collected on errors, and the breadcrumbs that led to the error. You can also add any custom values that you need.
 
 And for performance tracking:
 
-![Example](./packages/plugins/sentry/perf1.png)
-![Example](./packages/plugins/sentry/perf2.png)
+![Example](./perf1.png)
+![Example](./perf2.png)
 
 > You can get information about each resolver (including field and type names), it's execution time and arguments. Also, in case of an error, the performance log and info are attached automatically to the reported Sentry error.
 
 ## Getting Started
 
-```
+```sh
 yarn add @sentry/node @sentry/tracing @envelop/sentry
 ```
 
-1. Start by creating an account and a project in https://sentry.io/
+1. Start by creating an account and a project in https://sentry.io
 2. Follow the instructions to setup your Sentry instance in your application.
 3. Setup Sentry global instance configuration.
 4. Setup the Envelop plugin.

package/cjs/index.js

@@ -16,6 +16,7 @@ const useSentry = (options = {}) => {
     const renameTransaction = pick('renameTransaction', false);
     const skipOperation = pick('skip', () => false);
     const skipError = pick('skipError', exports.defaultSkipError);
+    const printedDocumentsCache = new WeakMap();
     const eventIdKey = options.eventIdKey === null ? null : 'sentryEventId';
     function addEventId(err, eventId) {
         if (eventIdKey !== null && eventId !== null) {
@@ -32,7 +33,11 @@ const useSentry = (options = {}) => {
             // @ts-expect-error TODO: not sure how we will make it dev friendly
             o => o.kind === graphql_1.Kind.OPERATION_DEFINITION);
             const operationType = rootOperation.operation;
-            const document = (0, graphql_1.print)(args.document);
+            let document = printedDocumentsCache.get(args.document);
+            if (!document) {
+                document = (0, graphql_1.print)(args.document);
+                printedDocumentsCache.set(args.document, document);
+            }
             const opName = args.operationName || rootOperation.name?.value || 'Anonymous Operation';
             const addedTags = (options.appendTags && options.appendTags(args)) || {};
             const traceparentData = (options.traceparentData && options.traceparentData(args)) || {};
@@ -70,7 +75,7 @@ const useSentry = (options = {}) => {
                 if (!span) {
                     // eslint-disable-next-line no-console
                     console.warn([
-                        `Flag "startTransaction" is enabled but Sentry failed to find a transaction.`,
+                        `Flag "startTransaction" is disabled but Sentry failed to find a transaction.`,
                         `Try to create a transaction before GraphQL execution phase is started.`,
                     ].join('\n'));
                     return {};

package/esm/index.js

@@ -12,6 +12,7 @@ export const useSentry = (options = {}) => {
     const renameTransaction = pick('renameTransaction', false);
     const skipOperation = pick('skip', () => false);
     const skipError = pick('skipError', defaultSkipError);
+    const printedDocumentsCache = new WeakMap();
     const eventIdKey = options.eventIdKey === null ? null : 'sentryEventId';
     function addEventId(err, eventId) {
         if (eventIdKey !== null && eventId !== null) {
@@ -28,7 +29,11 @@ export const useSentry = (options = {}) => {
             // @ts-expect-error TODO: not sure how we will make it dev friendly
             o => o.kind === Kind.OPERATION_DEFINITION);
             const operationType = rootOperation.operation;
-            const document = print(args.document);
+            let document = printedDocumentsCache.get(args.document);
+            if (!document) {
+                document = print(args.document);
+                printedDocumentsCache.set(args.document, document);
+            }
             const opName = args.operationName || rootOperation.name?.value || 'Anonymous Operation';
             const addedTags = (options.appendTags && options.appendTags(args)) || {};
             const traceparentData = (options.traceparentData && options.traceparentData(args)) || {};
@@ -66,7 +71,7 @@ export const useSentry = (options = {}) => {
                 if (!span) {
                     // eslint-disable-next-line no-console
                     console.warn([
-                        `Flag "startTransaction" is enabled but Sentry failed to find a transaction.`,
+                        `Flag "startTransaction" is disabled but Sentry failed to find a transaction.`,
                         `Try to create a transaction before GraphQL execution phase is started.`,
                     ].join('\n'));
                     return {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/sentry",
-  "version": "5.0.0",
+  "version": "5.1.0-alpha-20230210074029-bceea042",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^3.0.4",