feat(nestjs): Add @sentry/nestjs (#12613)

Implements basic nest js package as wrapper on top of node sdk --------- Co-authored-by: Luca Forstner <luca.forstner@sentry.io>
getsentry · Jun 26, 2024 · 8c94548 · 8c94548
1 parent 98fda49
commit 8c94548
Show file tree

Hide file tree

Showing 34 changed files with 267 additions and 18 deletions.
diff --git a/.craft.yml b/.craft.yml
@@ -97,6 +97,9 @@ targets:
  - name: npm
  id: '@sentry/bun'
  includeNames: /^sentry-bun-\d.*\.tgz$/
+ - name: npm
+ id: '@sentry/nestjs'
+ includeNames: /^sentry-nestjs-\d.*\.tgz$/
 
  ## 6. Fullstack/Meta Frameworks (depending on Node and Browser or Framework SDKs)
  - name: npm

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1067,7 +1067,7 @@ jobs:
  'generic-ts3.8',
  'node-fastify',
  'node-hapi',
- 'node-nestjs',
+ 'nestjs',
  'node-exports-test-app',
  'node-koa',
  'node-connect',

diff --git a/.../test-applications/node-nestjs/.gitignore → ...tests/test-applications/nestjs/.gitignore b/.../test-applications/node-nestjs/.gitignore → ...tests/test-applications/nestjs/.gitignore
diff --git a/...ests/test-applications/node-nestjs/.npmrc → ...e2e-tests/test-applications/nestjs/.npmrc b/...ests/test-applications/node-nestjs/.npmrc → ...e2e-tests/test-applications/nestjs/.npmrc
diff --git a/...st-applications/node-nestjs/nest-cli.json → ...ts/test-applications/nestjs/nest-cli.json b/...st-applications/node-nestjs/nest-cli.json → ...ts/test-applications/nestjs/nest-cli.json
diff --git a/...est-applications/node-nestjs/package.json → ...sts/test-applications/nestjs/package.json b/...est-applications/node-nestjs/package.json → ...sts/test-applications/nestjs/package.json
@@ -1,5 +1,5 @@
 {
- "name": "node-nestjs",
+ "name": "nestjs",
  "version": "0.0.1",
  "private": true,
  "scripts": {
@@ -18,7 +18,7 @@
  "@nestjs/common": "^10.0.0",
  "@nestjs/core": "^10.0.0",
  "@nestjs/platform-express": "^10.0.0",
- "@sentry/node": "latest || *",
+ "@sentry/nestjs": "latest || *",
  "@sentry/types": "latest || *",
  "reflect-metadata": "^0.2.0",
  "rxjs": "^7.8.1"

diff --git a/...cations/node-nestjs/playwright.config.mjs → ...applications/nestjs/playwright.config.mjs b/...cations/node-nestjs/playwright.config.mjs → ...applications/nestjs/playwright.config.mjs
diff --git a/...cations/node-nestjs/src/app.controller.ts → ...applications/nestjs/src/app.controller.ts b/...cations/node-nestjs/src/app.controller.ts → ...applications/nestjs/src/app.controller.ts
diff --git a/...pplications/node-nestjs/src/app.module.ts → ...est-applications/nestjs/src/app.module.ts b/...pplications/node-nestjs/src/app.module.ts → ...est-applications/nestjs/src/app.module.ts
diff --git a/...plications/node-nestjs/src/app.service.ts → ...st-applications/nestjs/src/app.service.ts b/...plications/node-nestjs/src/app.service.ts → ...st-applications/nestjs/src/app.service.ts
@@ -1,5 +1,5 @@
 import { Injectable } from '@nestjs/common';
-import * as Sentry from '@sentry/node';
+import * as Sentry from '@sentry/nestjs';
 import { makeHttpRequest } from './utils';
 
 @Injectable()

diff --git a/...pplications/node-nestjs/src/instrument.ts → ...est-applications/nestjs/src/instrument.ts b/...pplications/node-nestjs/src/instrument.ts → ...est-applications/nestjs/src/instrument.ts
@@ -1,4 +1,4 @@
-import * as Sentry from '@sentry/node';
+import * as Sentry from '@sentry/nestjs';
 
 Sentry.init({
  environment: 'qa', // dynamic sampling bias to keep transactions

diff --git a/...test-applications/node-nestjs/src/main.ts → ...ests/test-applications/nestjs/src/main.ts b/...test-applications/node-nestjs/src/main.ts → ...ests/test-applications/nestjs/src/main.ts
@@ -3,7 +3,7 @@ import './instrument';
 
 // Import other modules
 import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
-import * as Sentry from '@sentry/node';
+import * as Sentry from '@sentry/nestjs';
 import { AppModule1, AppModule2 } from './app.module';
 
 const app1Port = 3030;

diff --git a/...est-applications/node-nestjs/src/utils.ts → ...sts/test-applications/nestjs/src/utils.ts b/...est-applications/node-nestjs/src/utils.ts → ...sts/test-applications/nestjs/src/utils.ts
diff --git a/...cations/node-nestjs/start-event-proxy.mjs → ...applications/nestjs/start-event-proxy.mjs b/...cations/node-nestjs/start-event-proxy.mjs → ...applications/nestjs/start-event-proxy.mjs
@@ -2,5 +2,5 @@ import { startEventProxyServer } from '@sentry-internal/test-utils';
 
 startEventProxyServer({
  port: 3031,
- proxyServerName: 'node-nestjs',
+ proxyServerName: 'nestjs',
 });
diff --git a/...ications/node-nestjs/tests/errors.test.ts → ...-applications/nestjs/tests/errors.test.ts b/...ications/node-nestjs/tests/errors.test.ts → ...-applications/nestjs/tests/errors.test.ts
@@ -2,7 +2,7 @@ import { expect, test } from '@playwright/test';
 import { waitForError } from '@sentry-internal/test-utils';
 
 test('Sends exception to Sentry', async ({ baseURL }) => {
- const errorEventPromise = waitForError('node-nestjs', event => {
+ const errorEventPromise = waitForError('nestjs', event => {
  return !event.type && event.exception?.values?.[0]?.value === 'This is an exception with id 123';
  });
 

diff --git a/...ons/node-nestjs/tests/propagation.test.ts → ...ications/nestjs/tests/propagation.test.ts b/...ons/node-nestjs/tests/propagation.test.ts → ...ications/nestjs/tests/propagation.test.ts
@@ -6,14 +6,14 @@ import { SpanJSON } from '@sentry/types';
 test('Propagates trace for outgoing http requests', async ({ baseURL }) => {
  const id = crypto.randomUUID();
 
- const inboundTransactionPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const inboundTransactionPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent.contexts?.trace?.op === 'http.server' &&
  transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-inbound-headers/${id}`
  );
  });
 
- const outboundTransactionPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const outboundTransactionPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent.contexts?.trace?.op === 'http.server' &&
  transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-http/${id}`
@@ -121,14 +121,14 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => {
 test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => {
  const id = crypto.randomUUID();
 
- const inboundTransactionPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const inboundTransactionPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent?.contexts?.trace?.op === 'http.server' &&
  transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-inbound-headers/${id}`
  );
  });
 
- const outboundTransactionPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const outboundTransactionPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent?.contexts?.trace?.op === 'http.server' &&
  transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-fetch/${id}`
@@ -234,7 +234,7 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => {
 });
 
 test('Propagates trace for outgoing external http requests', async ({ baseURL }) => {
- const inboundTransactionPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const inboundTransactionPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent?.contexts?.trace?.op === 'http.server' &&
  transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-http-external-allowed`
@@ -271,7 +271,7 @@ test('Propagates trace for outgoing external http requests', async ({ baseURL })
 });
 
 test('Does not propagate outgoing http requests not covered by tracePropagationTargets', async ({ baseURL }) => {
- const inboundTransactionPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const inboundTransactionPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent?.contexts?.trace?.op === 'http.server' &&
  transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-http-external-disallowed`
@@ -295,7 +295,7 @@ test('Does not propagate outgoing http requests not covered by tracePropagationT
 });
 
 test('Propagates trace for outgoing external fetch requests', async ({ baseURL }) => {
- const inboundTransactionPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const inboundTransactionPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent?.contexts?.trace?.op === 'http.server' &&
  transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-fetch-external-allowed`
@@ -332,7 +332,7 @@ test('Propagates trace for outgoing external fetch requests', async ({ baseURL }
 });
 
 test('Does not propagate outgoing fetch requests not covered by tracePropagationTargets', async ({ baseURL }) => {
- const inboundTransactionPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const inboundTransactionPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent?.contexts?.trace?.op === 'http.server' &&
  transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-fetch-external-disallowed`

diff --git a/...ns/node-nestjs/tests/transactions.test.ts → ...cations/nestjs/tests/transactions.test.ts b/...ns/node-nestjs/tests/transactions.test.ts → ...cations/nestjs/tests/transactions.test.ts
@@ -2,7 +2,7 @@ import { expect, test } from '@playwright/test';
 import { waitForTransaction } from '@sentry-internal/test-utils';
 
 test('Sends an API route transaction', async ({ baseURL }) => {
- const pageloadTransactionEventPromise = waitForTransaction('node-nestjs', transactionEvent => {
+ const pageloadTransactionEventPromise = waitForTransaction('nestjs', transactionEvent => {
  return (
  transactionEvent?.contexts?.trace?.op === 'http.server' &&
  transactionEvent?.transaction === 'GET /test-transaction'

diff --git a/...lications/node-nestjs/tsconfig.build.json → ...t-applications/nestjs/tsconfig.build.json b/...lications/node-nestjs/tsconfig.build.json → ...t-applications/nestjs/tsconfig.build.json
diff --git a/...st-applications/node-nestjs/tsconfig.json → ...ts/test-applications/nestjs/tsconfig.json b/...st-applications/node-nestjs/tsconfig.json → ...ts/test-applications/nestjs/tsconfig.json
diff --git a/dev-packages/e2e-tests/verdaccio-config/config.yaml b/dev-packages/e2e-tests/verdaccio-config/config.yaml
@@ -80,6 +80,12 @@ packages:
  unpublish: $all
  # proxy: npmjs # Don't proxy for E2E tests!
 
+ '@sentry/nestjs':
+ access: $all
+ publish: $all
+ unpublish: $all
+ # proxy: npmjs # Don't proxy for E2E tests!
+
  '@sentry/nextjs':
  access: $all
  publish: $all

diff --git a/package.json b/package.json
@@ -60,6 +60,7 @@
  "packages/gatsby",
  "packages/google-cloud-serverless",
  "packages/integration-shims",
+ "packages/nestjs",
  "packages/nextjs",
  "packages/node",
  "packages/nuxt",

diff --git a/packages/nestjs/.eslintrc.js b/packages/nestjs/.eslintrc.js
@@ -0,0 +1,6 @@
+module.exports = {
+ env: {
+ node: true,
+ },
+ extends: ['../../.eslintrc.js'],
+};
diff --git a/packages/nestjs/LICENSE b/packages/nestjs/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Functional Software, Inc. dba Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/nestjs/README.md b/packages/nestjs/README.md
@@ -0,0 +1,43 @@
+<p align="center">
+ <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+ <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
+ </a>
+</p>
+
+# Official Sentry SDK for NestJS (EXPERIMENTAL)
+
+[![npm version](https://img.shields.io/npm/v/@sentry/nestjs.svg)](https://www.npmjs.com/package/@sentry/nestjs)
+[![npm dm](https://img.shields.io/npm/dm/@sentry/nestjs.svg)](https://www.npmjs.com/package/@sentry/nestjs)
+[![npm dt](https://img.shields.io/npm/dt/@sentry/nestjs.svg)](https://www.npmjs.com/package/@sentry/nestjs)
+
+This SDK is considered **experimental and in an alpha state**. It may experience breaking changes. Please reach out on
+[GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns.
+
+## Installation
+
+```bash
+npm install @sentry/nestjs
+
+# Or yarn
+yarn add @sentry/nestjs
+```
+
+## Usage
+
+```js
+// CJS Syntax
+const Sentry = require('@sentry/nestjs');
+// ESM Syntax
+import * as Sentry from '@sentry/nestjs';
+
+Sentry.init({
+ dsn: '__DSN__',
+ // ...
+});
+```
+
+Note that it is necessary to initialize Sentry **before you import any package that may be instrumented by us**.
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nestjs/)
diff --git a/packages/nestjs/package.json b/packages/nestjs/package.json
@@ -0,0 +1,71 @@
+{
+ "name": "@sentry/nestjs",
+ "version": "8.12.0",
+ "description": "Official Sentry SDK for NestJS",
+ "repository": "git://github.com/getsentry/sentry-javascript.git",
+ "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs",
+ "author": "Sentry",
+ "license": "MIT",
+ "engines": {
+ "node": ">=16"
+ },
+ "files": [
+ "/build",
+ "LICENSE",
+ "README.md"
+ ],
+ "main": "build/cjs/nestjs/index.js",
+ "module": "build/esm/nestjs/index.js",
+ "types": "build/types/index.d.ts",
+ "exports": {
+ "./package.json": "./package.json",
+ ".": {
+ "import": {
+ "types": "./build/types/index.d.ts",
+ "default": "./build/esm/index.js"
+ },
+ "require": {
+ "types": "./build/types/index.d.ts",
+ "default": "./build/cjs/index.js"
+ }
+ }
+ },
+ "typesVersions": {
+ "<4.9": {
+ "build/types/index.d.ts": [
+ "build/types-ts3.8/index.d.ts"
+ ]
+ }
+ },
+ "publishConfig": {
+ "access": "public"
+ },
+ "dependencies": {
+ "@sentry/core": "8.12.0",
+ "@sentry/node": "8.12.0"
+ },
+ "scripts": {
+ "build": "run-p build:transpile build:types",
+ "build:dev": "yarn build",
+ "build:transpile": "rollup -c rollup.npm.config.mjs",
+ "build:types": "run-s build:types:core build:types:downlevel",
+ "build:types:core": "tsc -p tsconfig.types.json",
+ "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
+ "build:watch": "run-p build:transpile:watch build:types:watch",
+ "build:dev:watch": "yarn build:watch",
+ "build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
+ "build:types:watch": "tsc -p tsconfig.types.json --watch",
+ "build:tarball": "npm pack",
+ "circularDepCheck": "madge --circular src/index.ts",
+ "clean": "rimraf build coverage sentry-node-*.tgz",
+ "fix": "eslint . --format stylish --fix",
+ "lint": "eslint . --format stylish",
+ "test": "vitest run",
+ "test:watch": "vitest --watch",
+ "yalc:publish": "yalc publish --push --sig"
+ },
+ "volta": {
+ "extends": "../../package.json"
+ },
+ "sideEffects": false
+}
diff --git a/packages/nestjs/rollup.npm.config.mjs b/packages/nestjs/rollup.npm.config.mjs
@@ -0,0 +1,3 @@
+import { makeBaseNPMConfig, makeNPMConfigVariants } from '@sentry-internal/rollup-utils';
+
+export default makeNPMConfigVariants(makeBaseNPMConfig());
diff --git a/packages/nestjs/src/index.ts b/packages/nestjs/src/index.ts
@@ -0,0 +1,3 @@
+export * from '@sentry/node';
+
+export { init } from './sdk';
diff --git a/packages/nestjs/src/sdk.ts b/packages/nestjs/src/sdk.ts
@@ -0,0 +1,16 @@
+import { applySdkMetadata } from '@sentry/core';
+import type { NodeClient, NodeOptions } from '@sentry/node';
+import { init as nodeInit } from '@sentry/node';
+
+/**
+ * Initializes the NestJS SDK
+ */
+export function init(options: NodeOptions | undefined = {}): NodeClient | undefined {
+ const opts: NodeOptions = {
+ ...options,
+ };
+
+ applySdkMetadata(opts, 'nestjs');
+
+ return nodeInit(opts);
+}
diff --git a/packages/nestjs/test/sdk.test.ts b/packages/nestjs/test/sdk.test.ts
@@ -0,0 +1,34 @@
+import * as SentryNode from '@sentry/node';
+import { SDK_VERSION } from '@sentry/utils';
+
+import { vi } from 'vitest';
+import { init as nestInit } from '../src/sdk';
+
+const nodeInit = vi.spyOn(SentryNode, 'init');
+const PUBLIC_DSN = 'https://username@domain/123';
+
+describe('Initialize Nest SDK', () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ });
+
+ it('has the correct metadata', () => {
+ const client = nestInit({
+ dsn: PUBLIC_DSN,
+ });
+
+ const expectedMetadata = {
+ _metadata: {
+ sdk: {
+ name: 'sentry.javascript.nestjs',
+ packages: [{ name: 'npm:@sentry/nestjs', version: SDK_VERSION }],
+ version: SDK_VERSION,
+ },
+ },
+ };
+
+ expect(client).not.toBeUndefined();
+ expect(nodeInit).toHaveBeenCalledTimes(1);
+ expect(nodeInit).toHaveBeenLastCalledWith(expect.objectContaining(expectedMetadata));
+ });
+});
diff --git a/packages/nestjs/tsconfig.json b/packages/nestjs/tsconfig.json
@@ -0,0 +1,7 @@
+{
+ "extends": "../../tsconfig.json",
+
+ "include": ["src/**/*"],
+
+ "compilerOptions": {}
+}
diff --git a/packages/nestjs/tsconfig.test.json b/packages/nestjs/tsconfig.test.json
@@ -0,0 +1,12 @@
+{
+ "extends": "./tsconfig.json",
+
+ "include": ["test/**/*", "vite.config.ts"],
+
+ "compilerOptions": {
+ // should include all types from `./tsconfig.json` plus types for all test frameworks used
+ "types": ["vitest/globals"]
+
+ // other package-specific, test-specific options
+ }
+}