Add UPGRADE.md

Author: spawnia

UPGRADE.md

@@ -0,0 +1,36 @@
+# Upgrade guide
+
+This document provides guidance for upgrading between major versions of `apollo-link-sentry`.
+
+## v2 to v3
+
+### Adapt your configuration
+
+The configuration of `SentryLink` has changed.
+
+```diff
+import { SentryLink } from 'apollo-link-sentry';
+
+new SentryLink({
+- filter: (operation) => ...,
++ shouldHandleOperation: (operation) => ...,
++ uri: 'https://example.com/graphql',
+  setTransaction: true,
+  setFingerprint: true,
+
+- breadcrumb: {
+-   enable: true,
++ attachBreadcrumbs: {
+    includeQuery: false,
+    includeVariables: false,
+-   includeFetchResult: false,
++   includeFetchResult: false,
+    includeError: false,
+    includeCache: false,
+-   includeContext: ['example'],
++   includeContext: ['example'],
++   transform: (breadcrumb, operation) => ...,
+  },
+- beforeBreadcrumb: (breadcrumb) => ...,
+})
+```

src/SentryLink.ts

@@ -57,7 +57,7 @@ export class SentryLink extends ApolloLink {
             // We must have a breadcrumb if attachBreadcrumbs was set
             (breadcrumb as GraphQLBreadcrumb).level = severityForResult(result);
 
-            if (this.options.attachBreadcrumbs.includeResult) {
+            if (this.options.attachBreadcrumbs.includeFetchResult) {
               // We must have a breadcrumb if attachBreadcrumbs was set
               (breadcrumb as GraphQLBreadcrumb).data.fetchResult = result;
             }

src/options.ts

@@ -68,7 +68,7 @@ export type AttachBreadcrumbsOptions = {
    *
    * Be careful not to leak sensitive information or send too much data.
    */
-  includeResult: false | true;
+  includeFetchResult: false | true;
 
   /**
    * Include the response error?
@@ -113,7 +113,7 @@ export const defaultOptions = {
   attachBreadcrumbs: {
     includeQuery: false,
     includeVariables: false,
-    includeResult: false,
+    includeFetchResult: false,
     includeError: false,
     includeCache: false,
     includeContext: false,

tests/apolloSentryLink.test.ts

@@ -59,7 +59,7 @@ describe('SentryLink', () => {
 
   it('should attach a breadcrumb for each apolloOperation', (done) => {
     const includeErrorAndResultOptions: SentryLinkOptions = {
-      attachBreadcrumbs: { includeResult: true, includeError: true },
+      attachBreadcrumbs: { includeFetchResult: true, includeError: true },
     };
 
     const result = { data: { foo: true } };

tests/breadcrumb.test.ts

@@ -32,7 +32,7 @@ describe('makeBreadcrumb', () => {
           includeQuery: false,
           includeVariables: false,
           includeError: false,
-          includeResult: false,
+          includeFetchResult: false,
           includeCache: false,
           includeContext: false,
           transform: undefined,
@@ -84,7 +84,7 @@ describe('makeBreadcrumb', () => {
           includeQuery: true,
           includeVariables: true,
           includeError: true,
-          includeResult: true,
+          includeFetchResult: true,
           includeCache: true,
           includeContext: ['foo.bar'],
           transform: (breadcrumb) => breadcrumb,