feat: Next.js SDK + Plugin

README.md

@@ -48,6 +48,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
 - [`@sentry/ember`](https://github.com/getsentry/sentry-javascript/tree/master/packages/ember): browser SDK with Ember integration enabled
 - [`@sentry/vue`](https://github.com/getsentry/sentry-javascript/tree/master/packages/vue): browser SDK with Vue integration enabled
 - [`@sentry/gatsby`](https://github.com/getsentry/sentry-javascript/tree/master/packages/gatsby): SDK for Gatsby
+- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
 - [`@sentry/react-native`](https://github.com/getsentry/sentry-react-native): SDK for React Native with support for native crashes
 - [`@sentry/integrations`](https://github.com/getsentry/sentry-javascript/tree/master/packages/integrations): Pluggable
   integrations that can be used to enhance JS SDKs

package.json

@@ -29,6 +29,8 @@
     "packages/hub",
     "packages/integrations",
     "packages/minimal",
+    "packages/nextjs",
+    "packages/next-plugin-sentry",
     "packages/node",
     "packages/react",
     "packages/serverless",

packages/next-plugin-sentry/LICENSE

@@ -0,0 +1,29 @@
+MIT License
+
+Copyright (c) 2021, Sentry
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

packages/next-plugin-sentry/README.md

@@ -0,0 +1,17 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+# Official Sentry plugin for Next.js
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
+
+## Usage
+
+You don't have to interact with this plugin to use Sentry with your application, see [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs) instead.

packages/next-plugin-sentry/env.js

@@ -0,0 +1,9 @@
+export const getDsn = () =>
+  process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
+
+export const getRelease = () =>
+  process.env.SENTRY_RELEASE ||
+  process.env.NEXT_PUBLIC_SENTRY_RELEASE ||
+  process.env.VERCEL_GITHUB_COMMIT_SHA ||
+  process.env.VERCEL_GITLAB_COMMIT_SHA ||
+  process.env.VERCEL_BITBUCKET_COMMIT_SHA;

packages/next-plugin-sentry/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@sentry/next-plugin-sentry",
+  "version": "6.2.5",
+  "description": "Sentry plugin for Next.js, part of the @sentry/nextjs SDK",
+  "repository": "git://github.com/getsentry/sentry-javascript.git",
+  "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/next-plugin-sentry",
+  "author": "Sentry",
+  "license": "MIT",
+  "engines": {
+    "node": ">=6"
+  },
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@sentry/nextjs": "6.2.5",
+    "@sentry/integrations": "6.2.5"
+  },
+  "devDependencies": {
+    "eslint": "7.20.0",
+    "rimraf": "3.0.2"
+  },
+  "nextjs": {
+    "name": "sentry",
+    "required-env": []
+  },
+  "peerDependencies": {
+    "next": "*"
+  },
+  "scripts": {
+    "link:yarn": "yarn link",
+    "pack": "npm pack"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}

packages/next-plugin-sentry/src/on-error-client.js

@@ -0,0 +1,11 @@
+import { withScope, captureException, captureMessage } from '@sentry/nextjs';
+
+export default async function onErrorClient({ err }) {
+  withScope(scope => {
+    if (err instanceof Error) {
+      captureException(err);
+    } else {
+      captureMessage(err.message);
+    }
+  });
+}

packages/next-plugin-sentry/src/on-error-server.js

@@ -0,0 +1,36 @@
+import { captureException, flush, Handlers, withScope } from '@sentry/nextjs';
+import getConfig from 'next/config';
+
+const { parseRequest } = Handlers;
+
+export default async function onErrorServer(err) {
+  const { serverRuntimeConfig = {}, publicRuntimeConfig = {} } = getConfig() || {};
+  const sentryTimeout = serverRuntimeConfig.sentryTimeout || publicRuntimeConfig.sentryTimeout || 2000;
+
+  withScope(scope => {
+    if (err.req) {
+      scope.addEventProcessor(event => {
+        return parseRequest(event, err.req, {
+          // 'cookies' and 'query_string' use `dynamicRequire` which has a bug in SSR envs right now — Kamil
+          request: ['data', 'headers', 'method', 'url'],
+        });
+      });
+    }
+
+    const toCapture = err instanceof Error ? err : err.err;
+
+    scope.addEventProcessor((event, hint) => {
+      if (hint.originalException === toCapture) {
+        event.exception.values[0].mechanism = {
+          handled: false,
+          type: 'onErrorServer',
+        };
+      }
+      return event;
+    });
+
+    captureException(toCapture);
+  });
+
+  await flush(sentryTimeout);
+}

packages/next-plugin-sentry/src/on-init-client.js

@@ -0,0 +1,6 @@
+import '../../../../sentry.client.config.js';
+
+export default async function initClient() {
+  // There is no initialization code. The goal of this file is the
+  // side-effect of importing the`sentry.client.config.js` file.
+}

packages/next-plugin-sentry/src/on-init-server.js

@@ -0,0 +1,6 @@
+import '../../../../sentry.server.config.js';
+
+export default async function initServer() {
+  // There is no initialization code. The goal of this file is the
+  // side-effect of importing the`sentry.server.config.js` file.
+}

packages/nextjs/.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    browser: true,
+    node: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  extends: ['@sentry-internal/sdk'],
+  ignorePatterns: ['build/**', 'dist/**', 'esm/**', 'examples/**', 'scripts/**'],
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx', '*.d.ts'],
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    {
+      files: ['test/**'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+      },
+    },
+  ],
+  rules: {
+    'max-lines': 'off',
+    '@sentry-internal/sdk/no-async-await': 'off',
+    'jsdoc/require-jsdoc': 0,
+  },
+};

packages/nextjs/LICENSE

@@ -0,0 +1,29 @@
+MIT License
+
+Copyright (c) 2021, Sentry
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

packages/nextjs/README.md

@@ -0,0 +1,76 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+# Official Sentry SDK for Next.js
+
+[![npm version](https://img.shields.io/npm/v/@sentry/nextjs.svg)](https://www.npmjs.com/package/@sentry/nextjs)
+[![npm dm](https://img.shields.io/npm/dm/@sentry/nextjs.svg)](https://www.npmjs.com/package/@sentry/nextjs)
+[![npm dt](https://img.shields.io/npm/dt/@sentry/nextjs.svg)](https://www.npmjs.com/package/@sentry/nextjs)
+[![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/)
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
+
+## General
+
+This package is a wrapper around `@sentry/node` for the server and `@sentry/react` for the client, with added functionality related to Next.js.
+
+To use this SDK, init it in the Sentry config files.
+
+```javascript
+// sentry.client.config.js
+
+import * as Sentry from '@sentry/nextjs';
+
+Sentry.init({
+  dsn: "__DSN__",
+  // ...
+});
+```
+
+```javascript
+// sentry.server.config.js
+
+import * as Sentry from '@sentry/nextjs';
+
+Sentry.init({
+  dsn: "__DSN__",
+  // ...
+});
+```
+
+To set context information or send manual events, use the exported functions of `@sentry/nextjs`.
+
+```javascript
+import * as Sentry from '@sentry/nextjs';
+
+// Set user information, as well as tags and further extras
+Sentry.configureScope(scope => {
+  scope.setExtra('battery', 0.7);
+  scope.setTag('user_mode', 'admin');
+  scope.setUser({ id: '4711' });
+  // scope.clear();
+});
+
+// Add a breadcrumb for future events
+Sentry.addBreadcrumb({
+  message: 'My Breadcrumb',
+  // ...
+});
+
+// Capture exceptions, messages or manual events
+Sentry.captureMessage('Hello, world!');
+Sentry.captureException(new Error('Good bye'));
+Sentry.captureEvent({
+  message: 'Manual',
+  stacktrace: [
+    // ...
+  ],
+});
+```

packages/nextjs/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@sentry/nextjs",
+  "version": "6.2.5",
+  "description": "Official Sentry SDK for Next.js",
+  "repository": "git://github.com/getsentry/sentry-javascript.git",
+  "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs",
+  "author": "Sentry",
+  "license": "MIT",
+  "engines": {
+    "node": ">=6"
+  },
+  "main": "./dist/index.server.js",
+  "module": "./esm/index.server.js",
+  "browser": "./esm/index.client.js",
+  "types": "./esm/index.client.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@sentry/core": "6.2.5",
+    "@sentry/integrations": "6.2.5",
+    "@sentry/next-plugin-sentry": "6.2.5",
+    "@sentry/node": "6.2.5",
+    "@sentry/react": "6.2.5",
+    "@sentry/utils": "6.2.5",
+    "@sentry/webpack-plugin": "1.15.0"
+  },
+  "devDependencies": {
+    "@sentry/types": "6.2.5",
+    "@types/webpack": "^5.28.0",
+    "eslint": "7.20.0",
+    "rimraf": "3.0.2"
+  },
+  "scripts": {
+    "build": "run-p build:esm build:es5",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:es5": "tsc -p tsconfig.build.json",
+    "build:watch": "run-p build:watch:esm build:watch:es5",
+    "build:watch:esm": "tsc -p tsconfig.esm.json -w --preserveWatchOutput",
+    "build:watch:es5": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
+    "clean": "rimraf dist esm coverage *.js *.js.map *.d.ts",
+    "link:yarn": "yarn link",
+    "lint": "run-s lint:prettier lint:eslint",
+    "lint:prettier": "prettier --check \"{src,test}/**/*.ts\"",
+    "lint:eslint": "eslint . --cache --cache-location '../../eslintcache/' --format stylish",
+    "fix": "run-s fix:eslint fix:prettier",
+    "fix:eslint": "eslint . --format stylish --fix",
+    "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "pack": "npm pack"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "jest": {
+    "collectCoverage": true,
+    "transform": {
+      "^.+\\.ts$": "ts-jest"
+    },
+    "moduleFileExtensions": [
+      "js",
+      "ts"
+    ],
+    "testEnvironment": "node",
+    "testMatch": [
+      "**/*.test.ts"
+    ],
+    "globals": {
+      "ts-jest": {
+        "tsConfig": "./tsconfig.json",
+        "diagnostics": false
+      }
+    }
+  }
+}