test(node): Add NestJS OpenTelemetry Tests (getsentry#10684)

onurtemizkan · web-flow · commit d2fce9bcc914 · 2024-02-20T11:50:48.000-05:00
Part of getsentry#9907
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -899,6 +899,7 @@ jobs:
       - name: Run integration tests
         env:
           NODE_VERSION: ${{ matrix.node }}
+          TS_VERSION: ${{ matrix.typescript }}
         run: |
           cd dev-packages/node-integration-tests
           yarn test
diff --git a/dev-packages/node-integration-tests/package.json b/dev-packages/node-integration-tests/package.json
@@ -28,6 +28,9 @@
   },
   "dependencies": {
     "@hapi/hapi": "^20.3.0",
+    "@nestjs/core": "^10.3.3",
+    "@nestjs/common": "^10.3.3",
+    "@nestjs/platform-express": "^10.3.3",
     "@prisma/client": "3.15.2",
     "@sentry/node": "7.100.0",
     "@sentry/tracing": "7.100.0",
@@ -50,6 +53,8 @@
     "nock": "^13.1.0",
     "pg": "^8.7.3",
     "proxy": "^2.1.1",
+    "reflect-metadata": "0.2.1",
+    "rxjs": "^7.8.1",
     "yargs": "^16.2.0"
   },
   "devDependencies": {
diff --git a/dev-packages/node-integration-tests/suites/tracing-experimental/nestjs/scenario.ts b/dev-packages/node-integration-tests/suites/tracing-experimental/nestjs/scenario.ts
@@ -0,0 +1,53 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+/* eslint-disable @typescript-eslint/explicit-member-accessibility */
+import { loggingTransport, sendPortToRunner } from '@sentry-internal/node-integration-tests';
+import * as Sentry from '@sentry/node-experimental';
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  release: '1.0',
+  tracesSampleRate: 1.0,
+  transport: loggingTransport,
+});
+
+import { Controller, Get, Injectable, Module } from '@nestjs/common';
+import { NestFactory } from '@nestjs/core';
+
+const port = 3450;
+
+// Stop the process from exiting before the transaction is sent
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+setInterval(() => {}, 1000);
+
+@Injectable()
+class AppService {
+  getHello(): string {
+    return 'Hello World!';
+  }
+}
+
+@Controller()
+class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  getHello(): string {
+    return this.appService.getHello();
+  }
+}
+
+@Module({
+  imports: [],
+  controllers: [AppController],
+  providers: [AppService],
+})
+class AppModule {}
+
+async function init(): Promise<void> {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(port);
+  sendPortToRunner(port);
+}
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+init();
diff --git a/dev-packages/node-integration-tests/suites/tracing-experimental/nestjs/test.ts b/dev-packages/node-integration-tests/suites/tracing-experimental/nestjs/test.ts
@@ -0,0 +1,49 @@
+import { conditionalTest } from '../../../utils';
+import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
+
+jest.setTimeout(20000);
+
+const { TS_VERSION } = process.env;
+const isOldTS = TS_VERSION && TS_VERSION.startsWith('3.');
+
+// This is required to run the test with ts-node and decorators
+process.env.TS_NODE_PROJECT = `${__dirname}/tsconfig.json`;
+
+conditionalTest({ min: 16 })('nestjs auto instrumentation', () => {
+  afterAll(async () => {
+    cleanupChildProcesses();
+  });
+
+  const CREATION_TRANSACTION = {
+    transaction: 'Create Nest App',
+  };
+
+  const GET_TRANSACTION = {
+    transaction: 'GET /',
+    spans: expect.arrayContaining([
+      expect.objectContaining({
+        description: 'GET /',
+        data: expect.objectContaining({
+          'nestjs.callback': 'getHello',
+          'nestjs.controller': 'AppController',
+          'nestjs.type': 'request_context',
+          'otel.kind': 'INTERNAL',
+          'sentry.op': 'http',
+        }),
+      }),
+    ]),
+  };
+
+  test('should auto-instrument `nestjs` package', done => {
+    if (isOldTS) {
+      // Skipping test on old TypeScript
+      return done();
+    }
+
+    createRunner(__dirname, 'scenario.ts')
+      .expect({ transaction: CREATION_TRANSACTION })
+      .expect({ transaction: GET_TRANSACTION })
+      .start(done)
+      .makeRequest('get', '/');
+  });
+});
diff --git a/dev-packages/node-integration-tests/suites/tracing-experimental/nestjs/tsconfig.json b/dev-packages/node-integration-tests/suites/tracing-experimental/nestjs/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "include": ["scenario.ts"],
+  "compilerOptions": {
+    "module": "commonjs",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "ES2021",
+  }
+}
diff --git a/yarn.lock b/yarn.lock
