feat: make sentryInstance optional

Author: herkulano

README.md

@@ -29,14 +29,11 @@ const resolvers = {
   }
 }
 
-Sentry.init({
-  dsn: process.env.SENTRY_DSN,
-  environment: process.env.NODE_ENV,
-  release: process.env.npm_package_version
-})
-
 const sentryMiddleware = sentry({
-  sentryInstance: Sentry,
+  config: {
+    dsn: process.env.SENTRY_DSN,
+    environment: process.env.NODE_ENV
+  },
   withScope: (scope, error, context) => {
     scope.setUser({
       id: context.authorization.userId,
@@ -56,11 +53,31 @@ const server = GraphQLServer({
 serve.start(() => `Server running on http://localhost:4000`)
 ```
 
+### Using a Sentry instance
+
+In cases where you want to use your own instance of Sentry to use it in other places in your application you can pass the `sentryInstance`. The `config` property should not be passed as an option.
+
+#### Example usage with a Sentry instance
+
+```ts
+Sentry.init({
+  dsn: process.env.SENTRY_DSN,
+})
+
+const sentryMiddleware = sentry({
+  sentryInstance: Sentry,
+  withScope: (scope, error, context) => {
+    scope.setExtra('origin', context.request.headers.origin)
+  },
+})
+```
+
 ## API & Configuration
 
 ```ts
 export interface Options<Context> {
-  sentryInstance: Sentry
+  sentryInstance?: Sentry
+  config?: Sentry.NodeOptions
   withScope?: ExceptionScope<Context>
   captureReturnedErrors?: boolean
   forwardErrors?: boolean
@@ -88,11 +105,16 @@ type ExceptionScope<Context> = (
 
 | property                | required | description                                                                                                                                                                |
 | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `sentryInstance`        | true     | [Sentry's instance](https://docs.sentry.io/error-reporting/configuration/?platform=node)                                                                                   |
+| `sentryInstance`        | false    | [Sentry's instance](https://docs.sentry.io/error-reporting/configuration/?platform=node)                                                                                   |
+| `config`                | false    | [Sentry's config object](https://docs.sentry.io/error-reporting/configuration/?platform=node)                                                                              |
 | `withScope`             | false    | Function to modify the [Sentry context](https://docs.sentry.io/enriching-error-data/context/?platform=node) to send with the captured error.                               |
 | `captureReturnedErrors` | false    | Capture errors returned from other middlewares, e.g., `graphql-shield` [returns errors](https://github.com/maticzav/graphql-shield#custom-errors) from rules and resolvers |
 | `forwardErrors`         | false    | Should middleware forward errors to the client or block them.                                                                                                              |
 
+#### Note
+
+If `sentryInstance` is not passed then `config.dsn` is required and vice-versa.
+
 ## License
 
 This project is licensed under the [MIT License](LICENSE.md).

src/index.ts

@@ -1,16 +1,17 @@
-import { Scope } from '@sentry/core'
+import * as Sentry from '@sentry/node'
 
 import { IMiddlewareFunction } from 'graphql-middleware/dist/types'
 
 export type ExceptionScope<Context> = (
-  scope: Scope,
+  scope: Sentry.Scope,
   error: Error,
   context: Context,
 ) => void
 
 // Options for graphql-middleware-sentry
 export interface Options<Context> {
-  sentryInstance: any
+  sentryInstance?: any
+  config?: Sentry.NodeOptions
   withScope?: ExceptionScope<Context>
   captureReturnedErrors?: boolean
   forwardErrors?: boolean
@@ -20,13 +21,22 @@ export class SentryError extends Error {}
 
 export const sentry = <Context>({
   sentryInstance = null,
+  config = {},
   withScope,
   captureReturnedErrors = false,
   forwardErrors = false,
 }: Options<Context>): IMiddlewareFunction => {
-  // Check if Sentry DSN is present
-  if (!sentryInstance) {
-    throw new SentryError(`The Sentry instance is missing in the options.`)
+  // Check if either sentryInstance or config.dsn is present
+  if (!sentryInstance && !config.dsn) {
+    throw new SentryError(
+      `Missing the sentryInstance or the dsn parameter in configuration.`,
+    )
+  }
+
+  if (!sentryInstance && config.dsn) {
+    // Init Sentry
+    sentryInstance = Sentry
+    Sentry.init(config)
   }
 
   // Return middleware resolver