tests(e2e): Refactor nestjs e2e applications into multiple smaller test applications (#12948)

Refactor of the existing nestjs test applications. Before we had one
sample application testing everything nest-related. This PR splits them
up into three applications to make it more readable and easier to
understand what is being tested. It also allows for iterating a bit
quicker in local development.

No new functionality was added. Will add more tests in a follow-up.

The three new services are:
- nestjs-basic: Simple nestjs application with no submodules and tests
for basic functionality of the SDK like error monitoring and span
instrumentation.
- nestjs-with-submodules: NestJS application that is bit more complex
including a submodule (and potentially multiple in the future) to have a
more realistic setup for more advanced testing.
- nestjs-distributed-tracing: Includes tests for trace propagation with
multiple services.

Author: nicohrubec

.github/workflows/build.yml

@@ -1037,7 +1037,9 @@ jobs:
             'generic-ts3.8',
             'node-fastify',
             'node-hapi',
-            'nestjs',
+            'nestjs-basic',
+            'nestjs-distributed-tracing',
+            'nestjs-with-submodules',
             'node-exports-test-app',
             'node-koa',
             'node-connect',

dev-packages/e2e-tests/test-applications/nestjs/.gitignore renamed to dev-packages/e2e-tests/test-applications/nestjs-basic/.gitignore

@@ -1,5 +1,5 @@
 {
-  "name": "nestjs",
+  "name": "nestjs-basic",
   "version": "0.0.1",
   "private": true,
   "scripts": {

dev-packages/e2e-tests/test-applications/nestjs/.npmrc renamed to dev-packages/e2e-tests/test-applications/nestjs-basic/.npmrc

@@ -0,0 +1,37 @@
+import { Controller, Get, Param } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get('test-transaction')
+  testTransaction() {
+    return this.appService.testTransaction();
+  }
+
+  @Get('test-exception/:id')
+  async testException(@Param('id') id: string) {
+    return this.appService.testException(id);
+  }
+
+  @Get('test-expected-exception/:id')
+  async testExpectedException(@Param('id') id: string) {
+    return this.appService.testExpectedException(id);
+  }
+
+  @Get('test-span-decorator-async')
+  async testSpanDecoratorAsync() {
+    return { result: await this.appService.testSpanDecoratorAsync() };
+  }
+
+  @Get('test-span-decorator-sync')
+  async testSpanDecoratorSync() {
+    return { result: await this.appService.testSpanDecoratorSync() };
+  }
+
+  @Get('kill-test-cron')
+  async killTestCron() {
+    this.appService.killTestCron();
+  }
+}

dev-packages/e2e-tests/test-applications/nestjs/nest-cli.json renamed to dev-packages/e2e-tests/test-applications/nestjs-basic/nest-cli.json

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ScheduleModule } from '@nestjs/schedule';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+@Module({
+  imports: [ScheduleModule.forRoot()],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}

dev-packages/e2e-tests/test-applications/nestjs/package.json renamed to dev-packages/e2e-tests/test-applications/nestjs-basic/package.json

@@ -3,7 +3,6 @@ import { Cron, SchedulerRegistry } from '@nestjs/schedule';
 import * as Sentry from '@sentry/nestjs';
 import { SentryCron, SentryTraced } from '@sentry/nestjs';
 import type { MonitorConfig } from '@sentry/types';
-import { makeHttpRequest } from './utils';
 
 const monitorConfig: MonitorConfig = {
   schedule: {
@@ -13,53 +12,15 @@ const monitorConfig: MonitorConfig = {
 };
 
 @Injectable()
-export class AppService1 {
+export class AppService {
   constructor(private schedulerRegistry: SchedulerRegistry) {}
 
-  testSuccess() {
-    return { version: 'v1' };
-  }
-
-  testParam(id: string) {
-    return {
-      paramWas: id,
-    };
-  }
-
-  testInboundHeaders(headers: Record<string, string>, id: string) {
-    return {
-      headers,
-      id,
-    };
-  }
-
-  async testOutgoingHttp(id: string) {
-    const data = await makeHttpRequest(`http://localhost:3030/test-inbound-headers/${id}`);
-
-    return data;
-  }
-
-  async testOutgoingFetch(id: string) {
-    const response = await fetch(`http://localhost:3030/test-inbound-headers/${id}`);
-    const data = await response.json();
-
-    return data;
-  }
-
   testTransaction() {
     Sentry.startSpan({ name: 'test-span' }, () => {
       Sentry.startSpan({ name: 'child-span' }, () => {});
     });
   }
 
-  async testError() {
-    const exceptionId = Sentry.captureException(new Error('This is an error'));
-
-    await Sentry.flush(2000);
-
-    return { exceptionId };
-  }
-
   testException(id: string) {
     throw new Error(`This is an exception with id ${id}`);
   }
@@ -68,26 +29,6 @@ export class AppService1 {
     throw new HttpException(`This is an expected exception with id ${id}`, HttpStatus.FORBIDDEN);
   }
 
-  async testOutgoingFetchExternalAllowed() {
-    const fetchResponse = await fetch('http://localhost:3040/external-allowed');
-
-    return fetchResponse.json();
-  }
-
-  async testOutgoingFetchExternalDisallowed() {
-    const fetchResponse = await fetch('http://localhost:3040/external-disallowed');
-
-    return fetchResponse.json();
-  }
-
-  async testOutgoingHttpExternalAllowed() {
-    return makeHttpRequest('http://localhost:3040/external-allowed');
-  }
-
-  async testOutgoingHttpExternalDisallowed() {
-    return makeHttpRequest('http://localhost:3040/external-disallowed');
-  }
-
   @SentryTraced('wait and return a string')
   async wait() {
     await new Promise(resolve => setTimeout(resolve, 500));
@@ -124,20 +65,3 @@ export class AppService1 {
     this.schedulerRegistry.deleteCronJob('test-cron-job');
   }
 }
-
-@Injectable()
-export class AppService2 {
-  externalAllowed(headers: Record<string, string>) {
-    return {
-      headers,
-      route: 'external-allowed',
-    };
-  }
-
-  externalDisallowed(headers: Record<string, string>) {
-    return {
-      headers,
-      route: 'external-disallowed',
-    };
-  }
-}

dev-packages/e2e-tests/test-applications/nestjs/playwright.config.mjs renamed to dev-packages/e2e-tests/test-applications/nestjs-basic/playwright.config.mjs

@@ -0,0 +1,8 @@
+import * as Sentry from '@sentry/nestjs';
+
+Sentry.init({
+  environment: 'qa', // dynamic sampling bias to keep transactions
+  dsn: process.env.E2E_TEST_DSN,
+  tunnel: `http://localhost:3031/`, // proxy server
+  tracesSampleRate: 1,
+});