Merge branch 'fix/tree-shake' into beta

* fix/tree-shake:
  feat: enable tree shaking of Sentry SDK debug code
  chore(lint): enable linting for more files within the repo
  chore(deps): update lock file
  fix(deps): update sentry dependencies to ^7.28.0 (#478)
  docs: minor updates about dependencies and lazy+tracing
  feat: support plugin path for clientConfig and serverConfig (#477)
  feat(tracing): enable Vue Router instrumentation by default (#476)
  Revert "feat(tracing): enable Vue Router instrumentation by default"
  feat(tracing): enable Vue Router instrumentation by default
  chore(lint): tweak eslint ignore directives for generated plugin files
  chore(deps): update devdependency sentry-testkit to v5
  chore(deps): update devdependency @nuxtjs/eslint-config-typescript to v12
  chore(deps): update sentry dependencies to ^7.27.0 (#474)
  feat!: update Sentry SDK from v6 to v7 (#461)
  docs: add information about enriching events (#473)
  fix: gracefully handle Nuxt versions without Runtime Config (#472)

Author: rchl

.eslintignore

@@ -1,5 +1,11 @@
 !.eslintrc.js
 !.release-it.js
+
+# un-ignore @nuxtjs/eslint-config
+!*.d.ts
+!.nuxt/sentry.*.js
+
+dist/
 lib/plugin.*
 lib/templates/*.*
-test/fixture/*/.nuxt
+

.eslintrc.js

@@ -2,7 +2,6 @@ module.exports = {
   extends: [
     '@nuxtjs/eslint-config',
   ],
-  ignorePatterns: ['dist/'],
   rules: {
     'comma-dangle': ['error', 'always-multiline'],
     'import/named': 'off',

.release-it.js

@@ -2,20 +2,20 @@
 module.exports = {
   git: {
     commitMessage: 'chore: release ${version}',
-    tagName: 'v${version}'
+    tagName: 'v${version}',
   },
   npm: {
-    publish: false
+    publish: false,
   },
   github: {
     release: true,
     releaseName: '${version}',
-    releaseNotes: 'echo "${changelog}" | sed 1,2d'
+    releaseNotes: 'echo "${changelog}" | sed 1,2d',
   },
   plugins: {
     '@release-it/conventional-changelog': {
       preset: 'conventionalcommits',
-      infile: 'CHANGELOG.md'
-    }
-  }
+      infile: 'CHANGELOG.md',
+    },
+  },
 }

docs/content/en/guide/migration.md

@@ -0,0 +1,19 @@
+---
+title: Migration guide
+description: Follow this guide to upgrade from one major version to the other.
+position: 10
+category: Guide
+---
+
+Follow this guide to upgrade from one major version to the other.
+
+## Upgrading from v6 to v7
+
+Sentry SDK dependencies updated from v6 to v7. Please read about breaking changes in Sentry SDK's [Upgrading from v6.x to v7.x](https://github.com/getsentry/sentry-javascript/blob/master/MIGRATION.md#upgrading-from-6x-to-7x) document.
+
+Some of the breaking changes listed in that document are automatically handled by the module and don't need any action. Other notable changes that might require action are:
+
+  - When using the `tracing` option, the `@sentry/tracing` dependency needs to be upgraded from v6.x to v7.x.
+  - The `whitelistUrls` and `blacklistUrls` Sentry `config` (or `clientConfig` / `serverConfig`) options have been renamed to `allowUrls` and `denyUrls`.
+  - The `Vue` integration was removed as is now merged into the Sentry Browser SDK. If you have been passing custom `Vue` options through the `clientIntegrations.Vue` object then those can now be merged directly into the `clientConfig` option (without the parent `Vue` key).
+  - The `UserAgent` integration was renamed to `HttpContext`. If you have been passing custom configuration to that integration through `clientIntegrations` option then you should rename the key.

docs/content/en/guide/setup.md

@@ -30,25 +30,30 @@ Add `@nuxtjs/sentry` dependency to your project:
   </code-block>
 </code-group>
 
-Then, add `@nuxtjs/sentry` to the `modules` section of `nuxt.config.js`:
+Then, add `@nuxtjs/sentry` to the `modules` section of `nuxt.config.js` and set your unique `dsn` value:
 
 ```js [nuxt.config.js]
 {
   modules: [
     '@nuxtjs/sentry'
   ],
   sentry: {
-    dsn: '', // Enter your project's DSN here
-    // Additional Module Options go here
-    // https://sentry.nuxtjs.org/sentry/options
+    dsn: '', // Enter your project's DSN.
+    // Additional Module Options.
     config: {
-      // Add native Sentry config here
-      // https://docs.sentry.io/platforms/javascript/guides/vue/configuration/options/
+      // Optional Sentry SDK configuration.
+      // Those options are shared by both the Browser and the Server instances.
+      // Browser-only and Server-only options should go
+      // into `clientConfig` and `serverConfig` objects respectively.
     },
   }
 }
 ```
 
+See [Options](/sentry/options) for a list of available options.
+
+Note that the Sentry SDK dependencies (`@sentry/*`) are not pinned and can be updated independently from the module itself by running `npm upgrade @nuxtjs/sentry` or `yarn update @nuxtjs/sentry`. That means you don't have to wait for a new module release if you want to update to the latest SDK version.
+
 <alert type="info">
 
   For Typescript or type-checked JavaScript projects, you might have to install the `@sentry/tracing` package even when not using the tracing functionality. In that case, the package can be installed as a dev-only dependency.
@@ -68,7 +73,3 @@ In Typescript or type-checked JavaScript projects, add `@nuxtjs/sentry` to the `
   }
 }
 ```
-
-## Configuration
-
-See [Options](/sentry/options) for a list of available options.

docs/content/en/guide/usage.md

@@ -1,30 +1,41 @@
 ---
-title: Usage
-description: 'Usage of Sentry into Nuxt'
+title: Usage / API
+description: 'Usage of Sentry in Nuxt'
 position: 3
 category: Guide
 ---
 
-Enter your DSN in the Nuxt.js config file. Additional config options can be found [here](https://docs.sentry.io/platforms/javascript/guides/vue/configuration/options/).
-
 ### Automatic Capturing
-Once installed, Sentry automatically reports errors, uncaught exceptions, and unhandled rejections. No need for further steps, unless you like to report (certain) exceptions manually (or have deactivated integrations like 'GlobalError'). In this case, find below how to send reports manually. 
+
+Once enabled, Sentry automatically reports errors, uncaught exceptions and unhandled rejections. No need for further steps, unless you like to report (certain) exceptions manually or have deactivated integrations like `GlobalError`. In this case, find out below how to send reports manually.
+
+### Enriching Reported Events
+
+Sentry SDK provides API for enhancing events that are being reported. For example, you can:
+  - set user information like IP address or username using `Sentry.setUser` API
+  - add custom structured data using `Sentry.setContext` API
+  - set custom key/value pairs (tags) that get indexed and can be used for filtering and searching using `Sentry.setTag` API
+  - add file attachments using `scope.addAttachment` API
+  - manually add breadcrumbs using `Sentry.addBreadcrumb` API
+  - and other...
+
+Read more about [Enriching Events](https://docs.sentry.io/platforms/javascript/guides/vue/enriching-events/).
 
 ### Usage in Vue components
 
 In a Vue component, `Sentry` is available as `this.$sentry`, so we can call functions like
 
-``` js
+```js
 this.$sentry.captureException(new Error('example'))
 ```
 
 where `this` is a Vue instance.
 
 ### Usage in `asyncData`
 
-While using Nuxt's `asyncData` method, there's `$sentry` object in the `context`:
+While using Nuxt's `asyncData` method, there's `$sentry` object in the `context` object:
 
-``` js
+```js
 async asyncData ({ params, $sentry }) {
   try {
     let { data } = await axios.get(`https://my-api/posts/${params.id}`)
@@ -37,7 +48,7 @@ async asyncData ({ params, $sentry }) {
 
 ### Usage in server middleware
 
-Sentry instance is accessible through the `process.sentry`.
+Server Sentry instance is accessible through `process.sentry`.
 
 ### Usage in other lifecycle areas
 

docs/content/en/sentry/lazy-loading.md

@@ -5,15 +5,15 @@ position: 6
 category: Sentry
 ---
 
-<alert type="warning">
+Set `lazy: true` in your module options to load Sentry lazily on the client. This will prevent Sentry from being included in your main bundle and should result in a faster initial page load.
 
-  Please be aware that lazy loading could prevent some errors that happen early during app loading from being reported.
+You can also pass a lazy config object in your module options (see [options](/sentry/options#lazy) for more information).
 
-</alert>
+<alert type="info">
 
-Set `lazy: true` in your module options to load Sentry lazily on the client. This will prevent Sentry from being included in your main bundle **but could result in some errors not being reported**.
+  Please be aware that lazy loading could prevent some errors that happen early during app loading from being reported and, if `tracing` is enabled, some performance metrics might not be accurate.
 
-You can also pass a lazy config object in your module options (see [options](/sentry/options#lazy) for more information).
+</alert>
 
 ### Injected properties
 

docs/content/en/sentry/options.md

@@ -12,13 +12,13 @@ Options can be passed using either:
 
 The `config`, `serverConfig` and `clientConfig` options can also be configured using [Runtime Config](/sentry/runtime-config).
 
-Normally, just setting DSN would be enough.
+The `dsn` is the only option that is required to enable Sentry reporting.
 
 ### dsn
 
 - Type: `String`
 - Default: `process.env.SENTRY_DSN || ''`
-- If no `dsn` is provided, Sentry will be initialised, but errors will not be logged. See [#47](https://github.com/nuxt-community/sentry-module/issues/47) for more information about this.
+- If no `dsn` is provided then Sentry will be initialized using mocked instance to prevent the code that references `$sentry` from crashing. No errors will be reported using that mocked instance.
 
 ### lazy
 
@@ -123,6 +123,7 @@ Normally, just setting DSN would be enough.
 - Default: `sentry`
 - Specified object in Nuxt config in `publicRuntimeConfig[runtimeConfigKey]` will override some options at runtime. See documentation at https://nuxtjs.org/docs/2.x/configuration-glossary/configuration-runtime-config/
 - Used to define the environment at runtime for example
+- See also [Runtime Config](/sentry/runtime-config) documentation.
 
 ### disabled
 
@@ -230,21 +231,23 @@ Note that the module sets the following defaults when publishing is enabled:
 - Default:
   ```js
   {
-    Dedupe: {},
     ExtraErrorData: {},
     ReportingObserver: {},
-    RewriteFrames: {}
+    RewriteFrames: {},
   }
   ```
-- Sentry by default also enables these browser integrations: `InboundFilters`, `FunctionToString`, `TryCatch`, `Breadcrumbs`, `GlobalHandlers`, `LinkedErrors`, `UserAgent`. Their options can be overridden by specifying them manually in the object.
-- Here is the full list of client integrations that are supported: `Breadcrumbs`, `CaptureConsole`, `Debug`, `Dedupe`, `ExtraErrorData`, `FunctionToString`, `GlobalHandlers`, `InboundFilters`, `LinkedErrors`, `ReportingObserver`, `RewriteFrames`, `TryCatch`, `UserAgent`, `Vue`.
-- User-provided configuration is merged with the default configuration so to disable integration that is enabled by default, you have to pass `false` as a value. For example to disable `ExtraErrorData` integration (only), set the option to:
+- Sentry by default also enables the following browser integrations: `InboundFilters`, `FunctionToString`, `TryCatch`, `Breadcrumbs`, `GlobalHandlers`, `LinkedErrors`, `Dedupe`, `HttpContext`.
+- The full list of client integrations that are supported: `Breadcrumbs`, `CaptureConsole`, `Debug`, `Dedupe`, `ExtraErrorData`, `FunctionToString`, `GlobalHandlers`, `HttpContext`, `InboundFilters`, `LinkedErrors`, `ReportingObserver`, `RewriteFrames`, `TryCatch`.
+- Integration options can be specified in the object value corresponding to the individual integration key.
+- To disable integration that is enabled by default, pass `false` as a value. For example to disable `ExtraErrorData` integration (only), set the option to:
   ```js
   {
-    ExtraErrorData: false
+    ExtraErrorData: false,
+    ReportingObserver: {},
+    RewriteFrames: {},
   }
   ```
-- See https://docs.sentry.io/platforms/javascript/configuration/integrations/default/ and  https://docs.sentry.io/platforms/javascript/configuration/integrations/plugin/ for more information on the integrations and their configuration
+- See also [Sentry Browser Integrations](https://docs.sentry.io/platforms/javascript/guides/vue/configuration/integrations/) for more information on configuring each integration.
 
 ### serverIntegrations
 
@@ -255,17 +258,20 @@ Note that the module sets the following defaults when publishing is enabled:
     Dedupe: {},
     ExtraErrorData: {},
     RewriteFrames: {},
-    Transaction: {}
   }
   ```
-- Here is the full list of server integrations that are supported: `CaptureConsole`, `Debug`, `Dedupe`, `ExtraErrorData`, `RewriteFrames`, `Modules`, `Transaction`.
-- User-provided configuration is merged with the default configuration so to disable integration that is enabled by default, you have to pass `false` as a value. For example to disable `ExtraErrorData` integration (only), set the option to:
+- Sentry by default also enables the following server integrations: `InboundFilters`, `FunctionToString`, `Console`, `Http`, `OnUncaughtException`, `OnUnhandledRejection`, `ContextLines`, `Context`, `Modules`, `RequestData`, `LinkedErrors`.
+- The full list of server integrations that are supported includes the ones above plus: `CaptureConsole`, `Debug`, `Dedupe`, `ExtraErrorData`, `RewriteFrames`, `Transaction`.
+- Integration options can be specified in the object value corresponding to the individual integration key.
+- To disable integration that is enabled by default, pass `false` as a value. For example to disable `ExtraErrorData` integration (only), set the option to:
   ```js
   {
-    ExtraErrorData: false
+    Dedupe: {},
+    ExtraErrorData: false,
+    RewriteFrames: {},
   }
   ```
-- See https://docs.sentry.io/platforms/node/pluggable-integrations/ for more information on the integrations and their configuration
+- See also [Sentry Server Integrations](https://docs.sentry.io/platforms/node/configuration/integrations/) for more information on configuring each integration.
 
 ### customClientIntegrations
 
@@ -306,21 +312,29 @@ export default function () {
 
 <alert type="info">
 
-  `@sentry/tracing@7` (version 7 and not newer) should be installed manually when using this option.
+  `@sentry/tracing@7` (version 7) should be installed manually when using this option.
 
 </alert>
 
-- Enables the BrowserTracing integration for client performance monitoring
+- Enables Sentry Performance Monitoring on the [server](https://docs.sentry.io/platforms/node/performance/) and [browser](https://docs.sentry.io/platforms/javascript/guides/vue/performance/) side.
 - Takes the following object configuration format (default values shown):
   ```js
   {
     tracesSampleRate: 1.0,
-    trackComponents: true
-    browserTracing: {}
+    browserTracing: {},
+    vueOptions: {
+      trackComponents: true,
+    },
   }
   ```
-- Sentry documentation strongly recommends reducing the `tracesSampleRate` value; it should be between 0.0 and 1.0 (percentage of requests to capture)
-- See available [browserTracing options](https://docs.sentry.io/platforms/javascript/guides/vue/performance/instrumentation/automatic-instrumentation/#configuration-options)
+- On the browser side the `BrowserTracing` integration is enabled by default and adds automatic instrumentation for monitoring the performance of the application. The [Vue Router Integration](https://docs.sentry.io/platforms/javascript/guides/vue/configuration/integrations/vue-router/) is also automatically enabled. See all available [`BrowserTracing` options](https://docs.sentry.io/platforms/javascript/guides/vue/performance/instrumentation/automatic-instrumentation/).
+- On the browser side extra options for [Tracking Vue components](https://docs.sentry.io/platforms/javascript/guides/vue/features/component-tracking/) can be passed through the `vueOptions` object.
+
+<alert type="info">
+
+  The `tracesSampleRate` value can be between 0.0 and 1.0 (percentage of requests to capture) and Sentry documentation strongly recommends reducing the value from the default 1.0.
+
+</alert>
 
 ### config
 
@@ -331,22 +345,49 @@ export default function () {
     environment: this.options.dev ? 'development' : 'production'
   }
   ```
-- Sentry options common to the server and client that are passed to `Sentry.init(options)`. See Sentry documentation at https://docs.sentry.io/platforms/javascript/guides/vue/configuration/options/
-- Note that `config.dsn` is automatically set based on the root `dsn` option
-- The value for `config.release` is automatically inferred from the local repo unless specified manually
-- Do not use `config.integrations`, use clientIntegrations or serverIntegrations
+- Sentry options common to the Server and Browser SDKs that are passed to `Sentry.init()`. See Sentry's documentation for [Basic Browser Options](https://docs.sentry.io/platforms/javascript/guides/vue/configuration/options/) and [Basic Server Options](https://docs.sentry.io/platforms/node/configuration/options/).
+- Note that `config.dsn` is automatically set based on the root `dsn` option.
+- The value for `config.release` is automatically inferred from the local repo unless specified manually.
+- Do not set `config.integrations`, use `clientIntegrations` and `serverIntegrations` options instead.
 
 ### serverConfig
 
 - Type: `Object`
 - Default: `{}`
-- Specified key will override common Sentry options for server sentry plugin
+- Sentry SDK [Basic Server Options](https://docs.sentry.io/platforms/node/configuration/options/).
+- The specified keys will override common options set in the `config` key.
+- The value can be a string in which case it needs to be a file path (can use [webpack aliases](https://nuxtjs.org/docs/2.x/directory-structure/assets#aliases)) pointing to a javascript file whose default export (a function) returns the configuration object. This is necessary in case some of the options rely on imported values or can't be serialized. The function can be `async`. Artificial example that switches out the `transport`:
+  ```js [~/config/sentry-server-config.js]
+  import { makeNodeTransport } from '@sentry/node'
+
+  export default function() {
+    return {
+      transport: makeNodeTransport,
+    }
+  }
+  ```
 
 ### clientConfig
 
-- Type: `Object`
+- Type: `Object` or `String`
 - Default: `{}`
-- Specified keys will override common Sentry options for client sentry plugin
+- Sentry SDK [Basic Browser Options](https://docs.sentry.io/platforms/javascript/guides/vue/configuration/options/).
+- The specified keys will override common options set in the `config` key.
+- The value can be a string in which case it needs to be a file path (can use [webpack aliases](https://nuxtjs.org/docs/2.x/directory-structure/assets#aliases)) pointing to a javascript file whose default export (a function) returns the configuration object. This is necessary in case some of the options rely on imported values or can't be serialized. The function is passed a `Nuxt Context` argument and can be `async`. Example of how to enable [User Feedback](https://docs.sentry.io/platforms/javascript/enriching-events/user-feedback/) dialog:
+  ```js [~/config/sentry-client-config.js]
+  import { showReportDialog } from '@sentry/vue'
+
+  export default function(context) {
+    return {
+      beforeSend (event, hint) {
+        if (event.exception) {
+          showReportDialog({ eventId: event.event_id })
+        }
+        return event
+      },
+    }
+  }
+  ```
 
 ### requestHandlerConfig
 

docs/content/en/sentry/runtime-config.md

@@ -28,3 +28,5 @@ publicRuntimeConfig: {
 ```
 
 You can customize the key that is used to access settings from `publicRuntimeConfig` by setting [`runtimeConfigKey`](/sentry/options#runtimeconfigkey) in the non-runtime options.
+
+This functionality is supported from Nuxt 2.13 and up.

docs/nuxt.config.js

@@ -2,6 +2,6 @@ import theme from '@nuxt/content-theme-docs'
 
 export default theme({
   docs: {
-    primaryColor: '#ae9dff'
-  }
+    primaryColor: '#ae9dff',
+  },
 })