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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicohrubec merged 8 commits into from
Jul 18, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0abb355
Add separate nest sample application for distributed tracing tests
nicohrubec Jul 17, 2024
19a2af0
Add nestjs-distributed-tracing test application to build script
nicohrubec Jul 17, 2024
c8371aa
Add nest sample application for testing with submodules
nicohrubec Jul 17, 2024
6b9fb34
Update
nicohrubec Jul 17, 2024
cf083a4
Update basic nestjs test application
nicohrubec Jul 17, 2024
a752fa4
Rename test module to example module
nicohrubec Jul 17, 2024
b32759e
Lint
nicohrubec Jul 17, 2024
4165d78
Address PR comments
nicohrubec Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1031,7 +1031,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',
Expand Down
0 ...tests/test-applications/nestjs/.gitignore → ...test-applications/nestjs-basic/.gitignore
View file
Open in desktop
File renamed without changes.
0 ...e2e-tests/test-applications/nestjs/.npmrc → ...sts/test-applications/nestjs-basic/.npmrc
View file
Open in desktop
File renamed without changes.
0 ...ts/test-applications/nestjs/nest-cli.json → ...t-applications/nestjs-basic/nest-cli.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...sts/test-applications/nestjs/package.json → ...st-applications/nestjs-basic/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
"name": "nestjs",
"name": "nestjs-basic",
"version": "0.0.1",
"private": true,
"scripts": {
Expand Down
0 ...applications/nestjs/playwright.config.mjs → ...ations/nestjs-basic/playwright.config.mjs
View file
Open in desktop
File renamed without changes.
37 changes: 37 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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();
}
}
11 changes: 11 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.module.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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 {}
78 changes: 1 addition & 77 deletions ...st-applications/nestjs/src/app.service.ts → ...lications/nestjs-basic/src/app.service.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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: {
Expand All@@ -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}`);
}
Expand All@@ -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));
Expand DownExpand Up@@ -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',
};
}
}
8 changes: 8 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/src/instrument.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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,
});
20 changes: 20 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/src/main.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { AppModule } from './app.module';

const PORT = 3030;

async function bootstrap() {
const app = await NestFactory.create(AppModule);

const { httpAdapter } = app.get(HttpAdapterHost);
Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

await app.listen(PORT);
}

bootstrap();
0 ...applications/nestjs/start-event-proxy.mjs → ...ations/nestjs-basic/start-event-proxy.mjs
View file
Open in desktop
File renamed without changes.
0 ...tions/nestjs/tests/cron-decorator.test.ts → ...nestjs-basic/tests/cron-decorator.test.ts
View file
Open in desktop
File renamed without changes.
29 changes: 0 additions & 29 deletions ...-applications/nestjs/tests/errors.test.ts → ...cations/nestjs-basic/tests/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,32 +53,3 @@ test('Does not send expected exception to Sentry', async ({ baseURL }) => {

expect(errorEventOccurred).toBe(false);
});

test('Does not handle expected exception if exception is thrown in module', async ({ baseURL }) => {
const errorEventPromise = waitForError('nestjs', event => {
return !event.type && event.exception?.values?.[0]?.value === 'Something went wrong in the test module!';
});

const response = await fetch(`${baseURL}/test-module`);
expect(response.status).toBe(500); // should be 400

// should never arrive, but does because the exception is not handled properly
const errorEvent = await errorEventPromise;

expect(errorEvent.exception?.values).toHaveLength(1);
expect(errorEvent.exception?.values?.[0]?.value).toBe('Something went wrong in the test module!');

expect(errorEvent.request).toEqual({
method: 'GET',
cookies: {},
headers: expect.any(Object),
url: 'http://localhost:3030/test-module',
});

expect(errorEvent.transaction).toEqual('GET /test-module');

expect(errorEvent.contexts?.trace).toEqual({
trace_id: expect.any(String),
span_id: expect.any(String),
});
});
0 ...tions/nestjs/tests/span-decorator.test.ts → ...nestjs-basic/tests/span-decorator.test.ts
View file
Open in desktop
File renamed without changes.
0 ...cations/nestjs/tests/transactions.test.ts → ...s/nestjs-basic/tests/transactions.test.ts
View file
Open in desktop
File renamed without changes.
0 ...t-applications/nestjs/tsconfig.build.json → ...ications/nestjs-basic/tsconfig.build.json
View file
Open in desktop
File renamed without changes.
0 ...ts/test-applications/nestjs/tsconfig.json → ...t-applications/nestjs-basic/tsconfig.json
View file
Open in desktop
File renamed without changes.
56 changes: 56 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
2 changes: 2 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.npmrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873
8 changes: 8 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/nest-cli.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
}
}
47 changes: 47 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
{
"name": "nestjs-distributed-tracing",
"version": "0.0.1",
"private": true,
"scripts": {
"build": "nest build",
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
"start": "nest start",
"start:dev": "nest start --watch",
"start:debug": "nest start --debug --watch",
"start:prod": "node dist/main",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test": "playwright test",
"test:build": "pnpm install",
"test:assert": "pnpm test"
},
"dependencies": {
"@nestjs/common": "^10.0.0",
"@nestjs/core": "^10.0.0",
"@nestjs/platform-express": "^10.0.0",
"@sentry/nestjs": "latest || *",
"@sentry/types": "latest || *",
"reflect-metadata": "^0.2.0",
"rxjs": "^7.8.1"
},
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"@nestjs/cli": "^10.0.0",
"@nestjs/schematics": "^10.0.0",
"@nestjs/testing": "^10.0.0",
"@types/express": "^4.17.17",
"@types/node": "18.15.1",
"@types/supertest": "^6.0.0",
"@typescript-eslint/eslint-plugin": "^6.0.0",
"@typescript-eslint/parser": "^6.0.0",
"eslint": "^8.42.0",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-prettier": "^5.0.0",
"prettier": "^3.0.0",
"source-map-support": "^0.5.21",
"supertest": "^6.3.3",
"ts-loader": "^9.4.3",
"tsconfig-paths": "^4.2.0",
"typescript": "^4.9.5"
}
}
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/playwright.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
startCommand: `pnpm start`,
});

export default config;
0 ...est-applications/nestjs/src/instrument.ts → ...tjs-distributed-tracing/src/instrument.ts
View file
Open in desktop
File renamed without changes.
25 changes: 25 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/src/main.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { TraceInitiatorModule } from './trace-initiator.module';
import { TraceReceiverModule } from './trace-receiver.module';

const TRACE_INITIATOR_PORT = 3030;
const TRACE_RECEIVER_PORT = 3040;

async function bootstrap() {
const trace_initiator_app = await NestFactory.create(TraceInitiatorModule);

const { httpAdapter } = trace_initiator_app.get(HttpAdapterHost);
Sentry.setupNestErrorHandler(trace_initiator_app, new BaseExceptionFilter(httpAdapter));

await trace_initiator_app.listen(TRACE_INITIATOR_PORT);

const trace_receiver_app = await NestFactory.create(TraceReceiverModule);
await trace_receiver_app.listen(TRACE_RECEIVER_PORT);
}

bootstrap();
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 8 commits into

from

Jul 18, 2024
 Merged


tests(e2e): Refactor nestjs e2e applications into multiple smaller test applications
#12948
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0abb355

Add separate nest sample application for distributed tracing tests


nicohrubec Jul 17, 2024
19a2af0

Add nestjs-distributed-tracing test application to build script


nicohrubec Jul 17, 2024
c8371aa

Add nest sample application for testing with submodules


nicohrubec Jul 17, 2024
6b9fb34

Update


nicohrubec Jul 17, 2024
cf083a4

Update basic nestjs test application


nicohrubec Jul 17, 2024
a752fa4

Rename test module to example module


nicohrubec Jul 17, 2024
b32759e

Lint


nicohrubec Jul 17, 2024
4165d78

Address PR comments


nicohrubec Jul 18, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 3 additions & 1 deletion
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1031,7 +1031,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',
Expand Down

0
...tests/test-applications/nestjs/.gitignore → ...test-applications/nestjs-basic/.gitignore

View file


Open in desktop


File renamed without changes.


0
...e2e-tests/test-applications/nestjs/.npmrc → ...sts/test-applications/nestjs-basic/.npmrc

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/nest-cli.json → ...t-applications/nestjs-basic/nest-cli.json

View file


Open in desktop


File renamed without changes.


2 changes: 1 addition & 1 deletion
...sts/test-applications/nestjs/package.json → ...st-applications/nestjs-basic/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
 "name": "nestjs",
 "name": "nestjs-basic",
 "version": "0.0.1",
 "private": true,
 "scripts": {
Expand Down

0
...applications/nestjs/playwright.config.mjs → ...ations/nestjs-basic/playwright.config.mjs

View file


Open in desktop


File renamed without changes.


37 changes: 37 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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();
 }
}

11 changes: 11 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 {}

78 changes: 1 addition & 77 deletions
...st-applications/nestjs/src/app.service.ts → ...lications/nestjs-basic/src/app.service.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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: {
Expand All@@ -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}`);
 }
Expand All@@ -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));
Expand DownExpand Up@@ -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',
 };
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { AppModule } from './app.module';

const PORT = 3030;

async function bootstrap() {
 const app = await NestFactory.create(AppModule);

 const { httpAdapter } = app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

 await app.listen(PORT);
}

bootstrap();

0
...applications/nestjs/start-event-proxy.mjs → ...ations/nestjs-basic/start-event-proxy.mjs

View file


Open in desktop


File renamed without changes.


0
...tions/nestjs/tests/cron-decorator.test.ts → ...nestjs-basic/tests/cron-decorator.test.ts

View file


Open in desktop


File renamed without changes.


29 changes: 0 additions & 29 deletions
...-applications/nestjs/tests/errors.test.ts → ...cations/nestjs-basic/tests/errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,32 +53,3 @@ test('Does not send expected exception to Sentry', async ({ baseURL }) => {

 expect(errorEventOccurred).toBe(false);
});

test('Does not handle expected exception if exception is thrown in module', async ({ baseURL }) => {
 const errorEventPromise = waitForError('nestjs', event => {
 return !event.type && event.exception?.values?.[0]?.value === 'Something went wrong in the test module!';
 });

 const response = await fetch(`${baseURL}/test-module`);
 expect(response.status).toBe(500); // should be 400

 // should never arrive, but does because the exception is not handled properly
 const errorEvent = await errorEventPromise;

 expect(errorEvent.exception?.values).toHaveLength(1);
 expect(errorEvent.exception?.values?.[0]?.value).toBe('Something went wrong in the test module!');

 expect(errorEvent.request).toEqual({
 method: 'GET',
 cookies: {},
 headers: expect.any(Object),
 url: 'http://localhost:3030/test-module',
 });

 expect(errorEvent.transaction).toEqual('GET /test-module');

 expect(errorEvent.contexts?.trace).toEqual({
 trace_id: expect.any(String),
 span_id: expect.any(String),
 });
});

0
...tions/nestjs/tests/span-decorator.test.ts → ...nestjs-basic/tests/span-decorator.test.ts

View file


Open in desktop


File renamed without changes.


0
...cations/nestjs/tests/transactions.test.ts → ...s/nestjs-basic/tests/transactions.test.ts

View file


Open in desktop


File renamed without changes.


0
...t-applications/nestjs/tsconfig.build.json → ...ications/nestjs-basic/tsconfig.build.json

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/tsconfig.json → ...t-applications/nestjs-basic/tsconfig.json

View file


Open in desktop


File renamed without changes.


56 changes: 56 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/nest-cli.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
 }
}

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
{
 "name": "nestjs-distributed-tracing",
 "version": "0.0.1",
 "private": true,
 "scripts": {
 "build": "nest build",
 "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
 "start": "nest start",
 "start:dev": "nest start --watch",
 "start:debug": "nest start --debug --watch",
 "start:prod": "node dist/main",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test": "playwright test",
 "test:build": "pnpm install",
 "test:assert": "pnpm test"
 },
 "dependencies": {
 "@nestjs/common": "^10.0.0",
 "@nestjs/core": "^10.0.0",
 "@nestjs/platform-express": "^10.0.0",
 "@sentry/nestjs": "latest || *",
 "@sentry/types": "latest || *",
 "reflect-metadata": "^0.2.0",
 "rxjs": "^7.8.1"
 },
 "devDependencies": {
 "@playwright/test": "^1.44.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@nestjs/cli": "^10.0.0",
 "@nestjs/schematics": "^10.0.0",
 "@nestjs/testing": "^10.0.0",
 "@types/express": "^4.17.17",
 "@types/node": "18.15.1",
 "@types/supertest": "^6.0.0",
 "@typescript-eslint/eslint-plugin": "^6.0.0",
 "@typescript-eslint/parser": "^6.0.0",
 "eslint": "^8.42.0",
 "eslint-config-prettier": "^9.0.0",
 "eslint-plugin-prettier": "^5.0.0",
 "prettier": "^3.0.0",
 "source-map-support": "^0.5.21",
 "supertest": "^6.3.3",
 "ts-loader": "^9.4.3",
 "tsconfig-paths": "^4.2.0",
 "typescript": "^4.9.5"
 }
}

7 changes: 7 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: `pnpm start`,
});

export default config;

0
...est-applications/nestjs/src/instrument.ts → ...tjs-distributed-tracing/src/instrument.ts

View file


Open in desktop


File renamed without changes.


25 changes: 25 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { TraceInitiatorModule } from './trace-initiator.module';
import { TraceReceiverModule } from './trace-receiver.module';

const TRACE_INITIATOR_PORT = 3030;
const TRACE_RECEIVER_PORT = 3040;

async function bootstrap() {
 const trace_initiator_app = await NestFactory.create(TraceInitiatorModule);

 const { httpAdapter } = trace_initiator_app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(trace_initiator_app, new BaseExceptionFilter(httpAdapter));

 await trace_initiator_app.listen(TRACE_INITIATOR_PORT);

 const trace_receiver_app = await NestFactory.create(TraceReceiverModule);
 await trace_receiver_app.listen(TRACE_RECEIVER_PORT);
}

bootstrap();
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 8 commits into

from

Jul 18, 2024
 Merged


tests(e2e): Refactor nestjs e2e applications into multiple smaller test applications
#12948
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0abb355

Add separate nest sample application for distributed tracing tests


nicohrubec Jul 17, 2024
19a2af0

Add nestjs-distributed-tracing test application to build script


nicohrubec Jul 17, 2024
c8371aa

Add nest sample application for testing with submodules


nicohrubec Jul 17, 2024
6b9fb34

Update


nicohrubec Jul 17, 2024
cf083a4

Update basic nestjs test application


nicohrubec Jul 17, 2024
a752fa4

Rename test module to example module


nicohrubec Jul 17, 2024
b32759e

Lint


nicohrubec Jul 17, 2024
4165d78

Address PR comments


nicohrubec Jul 18, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 3 additions & 1 deletion
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1031,7 +1031,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',
Expand Down

0
...tests/test-applications/nestjs/.gitignore → ...test-applications/nestjs-basic/.gitignore

View file


Open in desktop


File renamed without changes.


0
...e2e-tests/test-applications/nestjs/.npmrc → ...sts/test-applications/nestjs-basic/.npmrc

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/nest-cli.json → ...t-applications/nestjs-basic/nest-cli.json

View file


Open in desktop


File renamed without changes.


2 changes: 1 addition & 1 deletion
...sts/test-applications/nestjs/package.json → ...st-applications/nestjs-basic/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
 "name": "nestjs",
 "name": "nestjs-basic",
 "version": "0.0.1",
 "private": true,
 "scripts": {
Expand Down

0
...applications/nestjs/playwright.config.mjs → ...ations/nestjs-basic/playwright.config.mjs

View file


Open in desktop


File renamed without changes.


37 changes: 37 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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();
 }
}

11 changes: 11 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 {}

78 changes: 1 addition & 77 deletions
...st-applications/nestjs/src/app.service.ts → ...lications/nestjs-basic/src/app.service.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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: {
Expand All@@ -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}`);
 }
Expand All@@ -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));
Expand DownExpand Up@@ -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',
 };
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { AppModule } from './app.module';

const PORT = 3030;

async function bootstrap() {
 const app = await NestFactory.create(AppModule);

 const { httpAdapter } = app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

 await app.listen(PORT);
}

bootstrap();

0
...applications/nestjs/start-event-proxy.mjs → ...ations/nestjs-basic/start-event-proxy.mjs

View file


Open in desktop


File renamed without changes.


0
...tions/nestjs/tests/cron-decorator.test.ts → ...nestjs-basic/tests/cron-decorator.test.ts

View file


Open in desktop


File renamed without changes.


29 changes: 0 additions & 29 deletions
...-applications/nestjs/tests/errors.test.ts → ...cations/nestjs-basic/tests/errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,32 +53,3 @@ test('Does not send expected exception to Sentry', async ({ baseURL }) => {

 expect(errorEventOccurred).toBe(false);
});

test('Does not handle expected exception if exception is thrown in module', async ({ baseURL }) => {
 const errorEventPromise = waitForError('nestjs', event => {
 return !event.type && event.exception?.values?.[0]?.value === 'Something went wrong in the test module!';
 });

 const response = await fetch(`${baseURL}/test-module`);
 expect(response.status).toBe(500); // should be 400

 // should never arrive, but does because the exception is not handled properly
 const errorEvent = await errorEventPromise;

 expect(errorEvent.exception?.values).toHaveLength(1);
 expect(errorEvent.exception?.values?.[0]?.value).toBe('Something went wrong in the test module!');

 expect(errorEvent.request).toEqual({
 method: 'GET',
 cookies: {},
 headers: expect.any(Object),
 url: 'http://localhost:3030/test-module',
 });

 expect(errorEvent.transaction).toEqual('GET /test-module');

 expect(errorEvent.contexts?.trace).toEqual({
 trace_id: expect.any(String),
 span_id: expect.any(String),
 });
});

0
...tions/nestjs/tests/span-decorator.test.ts → ...nestjs-basic/tests/span-decorator.test.ts

View file


Open in desktop


File renamed without changes.


0
...cations/nestjs/tests/transactions.test.ts → ...s/nestjs-basic/tests/transactions.test.ts

View file


Open in desktop


File renamed without changes.


0
...t-applications/nestjs/tsconfig.build.json → ...ications/nestjs-basic/tsconfig.build.json

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/tsconfig.json → ...t-applications/nestjs-basic/tsconfig.json

View file


Open in desktop


File renamed without changes.


56 changes: 56 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/nest-cli.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
 }
}

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
{
 "name": "nestjs-distributed-tracing",
 "version": "0.0.1",
 "private": true,
 "scripts": {
 "build": "nest build",
 "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
 "start": "nest start",
 "start:dev": "nest start --watch",
 "start:debug": "nest start --debug --watch",
 "start:prod": "node dist/main",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test": "playwright test",
 "test:build": "pnpm install",
 "test:assert": "pnpm test"
 },
 "dependencies": {
 "@nestjs/common": "^10.0.0",
 "@nestjs/core": "^10.0.0",
 "@nestjs/platform-express": "^10.0.0",
 "@sentry/nestjs": "latest || *",
 "@sentry/types": "latest || *",
 "reflect-metadata": "^0.2.0",
 "rxjs": "^7.8.1"
 },
 "devDependencies": {
 "@playwright/test": "^1.44.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@nestjs/cli": "^10.0.0",
 "@nestjs/schematics": "^10.0.0",
 "@nestjs/testing": "^10.0.0",
 "@types/express": "^4.17.17",
 "@types/node": "18.15.1",
 "@types/supertest": "^6.0.0",
 "@typescript-eslint/eslint-plugin": "^6.0.0",
 "@typescript-eslint/parser": "^6.0.0",
 "eslint": "^8.42.0",
 "eslint-config-prettier": "^9.0.0",
 "eslint-plugin-prettier": "^5.0.0",
 "prettier": "^3.0.0",
 "source-map-support": "^0.5.21",
 "supertest": "^6.3.3",
 "ts-loader": "^9.4.3",
 "tsconfig-paths": "^4.2.0",
 "typescript": "^4.9.5"
 }
}

7 changes: 7 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: `pnpm start`,
});

export default config;

0
...est-applications/nestjs/src/instrument.ts → ...tjs-distributed-tracing/src/instrument.ts

View file


Open in desktop


File renamed without changes.


25 changes: 25 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { TraceInitiatorModule } from './trace-initiator.module';
import { TraceReceiverModule } from './trace-receiver.module';

const TRACE_INITIATOR_PORT = 3030;
const TRACE_RECEIVER_PORT = 3040;

async function bootstrap() {
 const trace_initiator_app = await NestFactory.create(TraceInitiatorModule);

 const { httpAdapter } = trace_initiator_app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(trace_initiator_app, new BaseExceptionFilter(httpAdapter));

 await trace_initiator_app.listen(TRACE_INITIATOR_PORT);

 const trace_receiver_app = await NestFactory.create(TraceReceiverModule);
 await trace_receiver_app.listen(TRACE_RECEIVER_PORT);
}

bootstrap();
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 8 commits into

from

Jul 18, 2024
 Merged


tests(e2e): Refactor nestjs e2e applications into multiple smaller test applications
#12948
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0abb355

Add separate nest sample application for distributed tracing tests


nicohrubec Jul 17, 2024
19a2af0

Add nestjs-distributed-tracing test application to build script


nicohrubec Jul 17, 2024
c8371aa

Add nest sample application for testing with submodules


nicohrubec Jul 17, 2024
6b9fb34

Update


nicohrubec Jul 17, 2024
cf083a4

Update basic nestjs test application


nicohrubec Jul 17, 2024
a752fa4

Rename test module to example module


nicohrubec Jul 17, 2024
b32759e

Lint


nicohrubec Jul 17, 2024
4165d78

Address PR comments


nicohrubec Jul 18, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 3 additions & 1 deletion
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1031,7 +1031,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',
Expand Down

0
...tests/test-applications/nestjs/.gitignore → ...test-applications/nestjs-basic/.gitignore

View file


Open in desktop


File renamed without changes.


0
...e2e-tests/test-applications/nestjs/.npmrc → ...sts/test-applications/nestjs-basic/.npmrc

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/nest-cli.json → ...t-applications/nestjs-basic/nest-cli.json

View file


Open in desktop


File renamed without changes.


2 changes: 1 addition & 1 deletion
...sts/test-applications/nestjs/package.json → ...st-applications/nestjs-basic/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
 "name": "nestjs",
 "name": "nestjs-basic",
 "version": "0.0.1",
 "private": true,
 "scripts": {
Expand Down

0
...applications/nestjs/playwright.config.mjs → ...ations/nestjs-basic/playwright.config.mjs

View file


Open in desktop


File renamed without changes.


37 changes: 37 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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();
 }
}

11 changes: 11 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 {}

78 changes: 1 addition & 77 deletions
...st-applications/nestjs/src/app.service.ts → ...lications/nestjs-basic/src/app.service.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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: {
Expand All@@ -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}`);
 }
Expand All@@ -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));
Expand DownExpand Up@@ -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',
 };
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { AppModule } from './app.module';

const PORT = 3030;

async function bootstrap() {
 const app = await NestFactory.create(AppModule);

 const { httpAdapter } = app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

 await app.listen(PORT);
}

bootstrap();

0
...applications/nestjs/start-event-proxy.mjs → ...ations/nestjs-basic/start-event-proxy.mjs

View file


Open in desktop


File renamed without changes.


0
...tions/nestjs/tests/cron-decorator.test.ts → ...nestjs-basic/tests/cron-decorator.test.ts

View file


Open in desktop


File renamed without changes.


29 changes: 0 additions & 29 deletions
...-applications/nestjs/tests/errors.test.ts → ...cations/nestjs-basic/tests/errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,32 +53,3 @@ test('Does not send expected exception to Sentry', async ({ baseURL }) => {

 expect(errorEventOccurred).toBe(false);
});

test('Does not handle expected exception if exception is thrown in module', async ({ baseURL }) => {
 const errorEventPromise = waitForError('nestjs', event => {
 return !event.type && event.exception?.values?.[0]?.value === 'Something went wrong in the test module!';
 });

 const response = await fetch(`${baseURL}/test-module`);
 expect(response.status).toBe(500); // should be 400

 // should never arrive, but does because the exception is not handled properly
 const errorEvent = await errorEventPromise;

 expect(errorEvent.exception?.values).toHaveLength(1);
 expect(errorEvent.exception?.values?.[0]?.value).toBe('Something went wrong in the test module!');

 expect(errorEvent.request).toEqual({
 method: 'GET',
 cookies: {},
 headers: expect.any(Object),
 url: 'http://localhost:3030/test-module',
 });

 expect(errorEvent.transaction).toEqual('GET /test-module');

 expect(errorEvent.contexts?.trace).toEqual({
 trace_id: expect.any(String),
 span_id: expect.any(String),
 });
});

0
...tions/nestjs/tests/span-decorator.test.ts → ...nestjs-basic/tests/span-decorator.test.ts

View file


Open in desktop


File renamed without changes.


0
...cations/nestjs/tests/transactions.test.ts → ...s/nestjs-basic/tests/transactions.test.ts

View file


Open in desktop


File renamed without changes.


0
...t-applications/nestjs/tsconfig.build.json → ...ications/nestjs-basic/tsconfig.build.json

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/tsconfig.json → ...t-applications/nestjs-basic/tsconfig.json

View file


Open in desktop


File renamed without changes.


56 changes: 56 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/nest-cli.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
 }
}

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
{
 "name": "nestjs-distributed-tracing",
 "version": "0.0.1",
 "private": true,
 "scripts": {
 "build": "nest build",
 "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
 "start": "nest start",
 "start:dev": "nest start --watch",
 "start:debug": "nest start --debug --watch",
 "start:prod": "node dist/main",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test": "playwright test",
 "test:build": "pnpm install",
 "test:assert": "pnpm test"
 },
 "dependencies": {
 "@nestjs/common": "^10.0.0",
 "@nestjs/core": "^10.0.0",
 "@nestjs/platform-express": "^10.0.0",
 "@sentry/nestjs": "latest || *",
 "@sentry/types": "latest || *",
 "reflect-metadata": "^0.2.0",
 "rxjs": "^7.8.1"
 },
 "devDependencies": {
 "@playwright/test": "^1.44.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@nestjs/cli": "^10.0.0",
 "@nestjs/schematics": "^10.0.0",
 "@nestjs/testing": "^10.0.0",
 "@types/express": "^4.17.17",
 "@types/node": "18.15.1",
 "@types/supertest": "^6.0.0",
 "@typescript-eslint/eslint-plugin": "^6.0.0",
 "@typescript-eslint/parser": "^6.0.0",
 "eslint": "^8.42.0",
 "eslint-config-prettier": "^9.0.0",
 "eslint-plugin-prettier": "^5.0.0",
 "prettier": "^3.0.0",
 "source-map-support": "^0.5.21",
 "supertest": "^6.3.3",
 "ts-loader": "^9.4.3",
 "tsconfig-paths": "^4.2.0",
 "typescript": "^4.9.5"
 }
}

7 changes: 7 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: `pnpm start`,
});

export default config;

0
...est-applications/nestjs/src/instrument.ts → ...tjs-distributed-tracing/src/instrument.ts

View file


Open in desktop


File renamed without changes.


25 changes: 25 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { TraceInitiatorModule } from './trace-initiator.module';
import { TraceReceiverModule } from './trace-receiver.module';

const TRACE_INITIATOR_PORT = 3030;
const TRACE_RECEIVER_PORT = 3040;

async function bootstrap() {
 const trace_initiator_app = await NestFactory.create(TraceInitiatorModule);

 const { httpAdapter } = trace_initiator_app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(trace_initiator_app, new BaseExceptionFilter(httpAdapter));

 await trace_initiator_app.listen(TRACE_INITIATOR_PORT);

 const trace_receiver_app = await NestFactory.create(TraceReceiverModule);
 await trace_receiver_app.listen(TRACE_RECEIVER_PORT);
}

bootstrap();
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 8 commits into

from

Jul 18, 2024
 Merged


tests(e2e): Refactor nestjs e2e applications into multiple smaller test applications
#12948
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0abb355

Add separate nest sample application for distributed tracing tests


nicohrubec Jul 17, 2024
19a2af0

Add nestjs-distributed-tracing test application to build script


nicohrubec Jul 17, 2024
c8371aa

Add nest sample application for testing with submodules


nicohrubec Jul 17, 2024
6b9fb34

Update


nicohrubec Jul 17, 2024
cf083a4

Update basic nestjs test application


nicohrubec Jul 17, 2024
a752fa4

Rename test module to example module


nicohrubec Jul 17, 2024
b32759e

Lint


nicohrubec Jul 17, 2024
4165d78

Address PR comments


nicohrubec Jul 18, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 3 additions & 1 deletion
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1031,7 +1031,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',
Expand Down

0
...tests/test-applications/nestjs/.gitignore → ...test-applications/nestjs-basic/.gitignore

View file


Open in desktop


File renamed without changes.


0
...e2e-tests/test-applications/nestjs/.npmrc → ...sts/test-applications/nestjs-basic/.npmrc

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/nest-cli.json → ...t-applications/nestjs-basic/nest-cli.json

View file


Open in desktop


File renamed without changes.


2 changes: 1 addition & 1 deletion
...sts/test-applications/nestjs/package.json → ...st-applications/nestjs-basic/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
 "name": "nestjs",
 "name": "nestjs-basic",
 "version": "0.0.1",
 "private": true,
 "scripts": {
Expand Down

0
...applications/nestjs/playwright.config.mjs → ...ations/nestjs-basic/playwright.config.mjs

View file


Open in desktop


File renamed without changes.


37 changes: 37 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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();
 }
}

11 changes: 11 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 {}

78 changes: 1 addition & 77 deletions
...st-applications/nestjs/src/app.service.ts → ...lications/nestjs-basic/src/app.service.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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: {
Expand All@@ -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}`);
 }
Expand All@@ -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));
Expand DownExpand Up@@ -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',
 };
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { AppModule } from './app.module';

const PORT = 3030;

async function bootstrap() {
 const app = await NestFactory.create(AppModule);

 const { httpAdapter } = app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

 await app.listen(PORT);
}

bootstrap();

0
...applications/nestjs/start-event-proxy.mjs → ...ations/nestjs-basic/start-event-proxy.mjs

View file


Open in desktop


File renamed without changes.


0
...tions/nestjs/tests/cron-decorator.test.ts → ...nestjs-basic/tests/cron-decorator.test.ts

View file


Open in desktop


File renamed without changes.


29 changes: 0 additions & 29 deletions
...-applications/nestjs/tests/errors.test.ts → ...cations/nestjs-basic/tests/errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,32 +53,3 @@ test('Does not send expected exception to Sentry', async ({ baseURL }) => {

 expect(errorEventOccurred).toBe(false);
});

test('Does not handle expected exception if exception is thrown in module', async ({ baseURL }) => {
 const errorEventPromise = waitForError('nestjs', event => {
 return !event.type && event.exception?.values?.[0]?.value === 'Something went wrong in the test module!';
 });

 const response = await fetch(`${baseURL}/test-module`);
 expect(response.status).toBe(500); // should be 400

 // should never arrive, but does because the exception is not handled properly
 const errorEvent = await errorEventPromise;

 expect(errorEvent.exception?.values).toHaveLength(1);
 expect(errorEvent.exception?.values?.[0]?.value).toBe('Something went wrong in the test module!');

 expect(errorEvent.request).toEqual({
 method: 'GET',
 cookies: {},
 headers: expect.any(Object),
 url: 'http://localhost:3030/test-module',
 });

 expect(errorEvent.transaction).toEqual('GET /test-module');

 expect(errorEvent.contexts?.trace).toEqual({
 trace_id: expect.any(String),
 span_id: expect.any(String),
 });
});

0
...tions/nestjs/tests/span-decorator.test.ts → ...nestjs-basic/tests/span-decorator.test.ts

View file


Open in desktop


File renamed without changes.


0
...cations/nestjs/tests/transactions.test.ts → ...s/nestjs-basic/tests/transactions.test.ts

View file


Open in desktop


File renamed without changes.


0
...t-applications/nestjs/tsconfig.build.json → ...ications/nestjs-basic/tsconfig.build.json

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/tsconfig.json → ...t-applications/nestjs-basic/tsconfig.json

View file


Open in desktop


File renamed without changes.


56 changes: 56 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/nest-cli.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
 }
}

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
{
 "name": "nestjs-distributed-tracing",
 "version": "0.0.1",
 "private": true,
 "scripts": {
 "build": "nest build",
 "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
 "start": "nest start",
 "start:dev": "nest start --watch",
 "start:debug": "nest start --debug --watch",
 "start:prod": "node dist/main",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test": "playwright test",
 "test:build": "pnpm install",
 "test:assert": "pnpm test"
 },
 "dependencies": {
 "@nestjs/common": "^10.0.0",
 "@nestjs/core": "^10.0.0",
 "@nestjs/platform-express": "^10.0.0",
 "@sentry/nestjs": "latest || *",
 "@sentry/types": "latest || *",
 "reflect-metadata": "^0.2.0",
 "rxjs": "^7.8.1"
 },
 "devDependencies": {
 "@playwright/test": "^1.44.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@nestjs/cli": "^10.0.0",
 "@nestjs/schematics": "^10.0.0",
 "@nestjs/testing": "^10.0.0",
 "@types/express": "^4.17.17",
 "@types/node": "18.15.1",
 "@types/supertest": "^6.0.0",
 "@typescript-eslint/eslint-plugin": "^6.0.0",
 "@typescript-eslint/parser": "^6.0.0",
 "eslint": "^8.42.0",
 "eslint-config-prettier": "^9.0.0",
 "eslint-plugin-prettier": "^5.0.0",
 "prettier": "^3.0.0",
 "source-map-support": "^0.5.21",
 "supertest": "^6.3.3",
 "ts-loader": "^9.4.3",
 "tsconfig-paths": "^4.2.0",
 "typescript": "^4.9.5"
 }
}

7 changes: 7 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: `pnpm start`,
});

export default config;

0
...est-applications/nestjs/src/instrument.ts → ...tjs-distributed-tracing/src/instrument.ts

View file


Open in desktop


File renamed without changes.


25 changes: 25 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { TraceInitiatorModule } from './trace-initiator.module';
import { TraceReceiverModule } from './trace-receiver.module';

const TRACE_INITIATOR_PORT = 3030;
const TRACE_RECEIVER_PORT = 3040;

async function bootstrap() {
 const trace_initiator_app = await NestFactory.create(TraceInitiatorModule);

 const { httpAdapter } = trace_initiator_app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(trace_initiator_app, new BaseExceptionFilter(httpAdapter));

 await trace_initiator_app.listen(TRACE_INITIATOR_PORT);

 const trace_receiver_app = await NestFactory.create(TraceReceiverModule);
 await trace_receiver_app.listen(TRACE_RECEIVER_PORT);
}

bootstrap();
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 8 commits into

from

Jul 18, 2024
 Merged


tests(e2e): Refactor nestjs e2e applications into multiple smaller test applications
#12948
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0abb355

Add separate nest sample application for distributed tracing tests


nicohrubec Jul 17, 2024
19a2af0

Add nestjs-distributed-tracing test application to build script


nicohrubec Jul 17, 2024
c8371aa

Add nest sample application for testing with submodules


nicohrubec Jul 17, 2024
6b9fb34

Update


nicohrubec Jul 17, 2024
cf083a4

Update basic nestjs test application


nicohrubec Jul 17, 2024
a752fa4

Rename test module to example module


nicohrubec Jul 17, 2024
b32759e

Lint


nicohrubec Jul 17, 2024
4165d78

Address PR comments


nicohrubec Jul 18, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 3 additions & 1 deletion
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1031,7 +1031,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',
Expand Down

0
...tests/test-applications/nestjs/.gitignore → ...test-applications/nestjs-basic/.gitignore

View file


Open in desktop


File renamed without changes.


0
...e2e-tests/test-applications/nestjs/.npmrc → ...sts/test-applications/nestjs-basic/.npmrc

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/nest-cli.json → ...t-applications/nestjs-basic/nest-cli.json

View file


Open in desktop


File renamed without changes.


2 changes: 1 addition & 1 deletion
...sts/test-applications/nestjs/package.json → ...st-applications/nestjs-basic/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
 "name": "nestjs",
 "name": "nestjs-basic",
 "version": "0.0.1",
 "private": true,
 "scripts": {
Expand Down

0
...applications/nestjs/playwright.config.mjs → ...ations/nestjs-basic/playwright.config.mjs

View file


Open in desktop


File renamed without changes.


37 changes: 37 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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();
 }
}

11 changes: 11 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 {}

78 changes: 1 addition & 77 deletions
...st-applications/nestjs/src/app.service.ts → ...lications/nestjs-basic/src/app.service.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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: {
Expand All@@ -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}`);
 }
Expand All@@ -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));
Expand DownExpand Up@@ -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',
 };
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { AppModule } from './app.module';

const PORT = 3030;

async function bootstrap() {
 const app = await NestFactory.create(AppModule);

 const { httpAdapter } = app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

 await app.listen(PORT);
}

bootstrap();

0
...applications/nestjs/start-event-proxy.mjs → ...ations/nestjs-basic/start-event-proxy.mjs

View file


Open in desktop


File renamed without changes.


0
...tions/nestjs/tests/cron-decorator.test.ts → ...nestjs-basic/tests/cron-decorator.test.ts

View file


Open in desktop


File renamed without changes.


29 changes: 0 additions & 29 deletions
...-applications/nestjs/tests/errors.test.ts → ...cations/nestjs-basic/tests/errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,32 +53,3 @@ test('Does not send expected exception to Sentry', async ({ baseURL }) => {

 expect(errorEventOccurred).toBe(false);
});

test('Does not handle expected exception if exception is thrown in module', async ({ baseURL }) => {
 const errorEventPromise = waitForError('nestjs', event => {
 return !event.type && event.exception?.values?.[0]?.value === 'Something went wrong in the test module!';
 });

 const response = await fetch(`${baseURL}/test-module`);
 expect(response.status).toBe(500); // should be 400

 // should never arrive, but does because the exception is not handled properly
 const errorEvent = await errorEventPromise;

 expect(errorEvent.exception?.values).toHaveLength(1);
 expect(errorEvent.exception?.values?.[0]?.value).toBe('Something went wrong in the test module!');

 expect(errorEvent.request).toEqual({
 method: 'GET',
 cookies: {},
 headers: expect.any(Object),
 url: 'http://localhost:3030/test-module',
 });

 expect(errorEvent.transaction).toEqual('GET /test-module');

 expect(errorEvent.contexts?.trace).toEqual({
 trace_id: expect.any(String),
 span_id: expect.any(String),
 });
});

0
...tions/nestjs/tests/span-decorator.test.ts → ...nestjs-basic/tests/span-decorator.test.ts

View file


Open in desktop


File renamed without changes.


0
...cations/nestjs/tests/transactions.test.ts → ...s/nestjs-basic/tests/transactions.test.ts

View file


Open in desktop


File renamed without changes.


0
...t-applications/nestjs/tsconfig.build.json → ...ications/nestjs-basic/tsconfig.build.json

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/tsconfig.json → ...t-applications/nestjs-basic/tsconfig.json

View file


Open in desktop


File renamed without changes.


56 changes: 56 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/nest-cli.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
 }
}

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
{
 "name": "nestjs-distributed-tracing",
 "version": "0.0.1",
 "private": true,
 "scripts": {
 "build": "nest build",
 "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
 "start": "nest start",
 "start:dev": "nest start --watch",
 "start:debug": "nest start --debug --watch",
 "start:prod": "node dist/main",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test": "playwright test",
 "test:build": "pnpm install",
 "test:assert": "pnpm test"
 },
 "dependencies": {
 "@nestjs/common": "^10.0.0",
 "@nestjs/core": "^10.0.0",
 "@nestjs/platform-express": "^10.0.0",
 "@sentry/nestjs": "latest || *",
 "@sentry/types": "latest || *",
 "reflect-metadata": "^0.2.0",
 "rxjs": "^7.8.1"
 },
 "devDependencies": {
 "@playwright/test": "^1.44.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@nestjs/cli": "^10.0.0",
 "@nestjs/schematics": "^10.0.0",
 "@nestjs/testing": "^10.0.0",
 "@types/express": "^4.17.17",
 "@types/node": "18.15.1",
 "@types/supertest": "^6.0.0",
 "@typescript-eslint/eslint-plugin": "^6.0.0",
 "@typescript-eslint/parser": "^6.0.0",
 "eslint": "^8.42.0",
 "eslint-config-prettier": "^9.0.0",
 "eslint-plugin-prettier": "^5.0.0",
 "prettier": "^3.0.0",
 "source-map-support": "^0.5.21",
 "supertest": "^6.3.3",
 "ts-loader": "^9.4.3",
 "tsconfig-paths": "^4.2.0",
 "typescript": "^4.9.5"
 }
}

7 changes: 7 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: `pnpm start`,
});

export default config;

0
...est-applications/nestjs/src/instrument.ts → ...tjs-distributed-tracing/src/instrument.ts

View file


Open in desktop


File renamed without changes.


25 changes: 25 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { TraceInitiatorModule } from './trace-initiator.module';
import { TraceReceiverModule } from './trace-receiver.module';

const TRACE_INITIATOR_PORT = 3030;
const TRACE_RECEIVER_PORT = 3040;

async function bootstrap() {
 const trace_initiator_app = await NestFactory.create(TraceInitiatorModule);

 const { httpAdapter } = trace_initiator_app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(trace_initiator_app, new BaseExceptionFilter(httpAdapter));

 await trace_initiator_app.listen(TRACE_INITIATOR_PORT);

 const trace_receiver_app = await NestFactory.create(TraceReceiverModule);
 await trace_receiver_app.listen(TRACE_RECEIVER_PORT);
}

bootstrap();
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 8 commits into

from

Jul 18, 2024
 Merged


tests(e2e): Refactor nestjs e2e applications into multiple smaller test applications
#12948
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0abb355

Add separate nest sample application for distributed tracing tests


nicohrubec Jul 17, 2024
19a2af0

Add nestjs-distributed-tracing test application to build script


nicohrubec Jul 17, 2024
c8371aa

Add nest sample application for testing with submodules


nicohrubec Jul 17, 2024
6b9fb34

Update


nicohrubec Jul 17, 2024
cf083a4

Update basic nestjs test application


nicohrubec Jul 17, 2024
a752fa4

Rename test module to example module


nicohrubec Jul 17, 2024
b32759e

Lint


nicohrubec Jul 17, 2024
4165d78

Address PR comments


nicohrubec Jul 18, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 3 additions & 1 deletion
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1031,7 +1031,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',
Expand Down

0
...tests/test-applications/nestjs/.gitignore → ...test-applications/nestjs-basic/.gitignore

View file


Open in desktop


File renamed without changes.


0
...e2e-tests/test-applications/nestjs/.npmrc → ...sts/test-applications/nestjs-basic/.npmrc

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/nest-cli.json → ...t-applications/nestjs-basic/nest-cli.json

View file


Open in desktop


File renamed without changes.


2 changes: 1 addition & 1 deletion
...sts/test-applications/nestjs/package.json → ...st-applications/nestjs-basic/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
 "name": "nestjs",
 "name": "nestjs-basic",
 "version": "0.0.1",
 "private": true,
 "scripts": {
Expand Down

0
...applications/nestjs/playwright.config.mjs → ...ations/nestjs-basic/playwright.config.mjs

View file


Open in desktop


File renamed without changes.


37 changes: 37 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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();
 }
}

11 changes: 11 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 {}

78 changes: 1 addition & 77 deletions
...st-applications/nestjs/src/app.service.ts → ...lications/nestjs-basic/src/app.service.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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: {
Expand All@@ -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}`);
 }
Expand All@@ -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));
Expand DownExpand Up@@ -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',
 };
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { AppModule } from './app.module';

const PORT = 3030;

async function bootstrap() {
 const app = await NestFactory.create(AppModule);

 const { httpAdapter } = app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

 await app.listen(PORT);
}

bootstrap();

0
...applications/nestjs/start-event-proxy.mjs → ...ations/nestjs-basic/start-event-proxy.mjs

View file


Open in desktop


File renamed without changes.


0
...tions/nestjs/tests/cron-decorator.test.ts → ...nestjs-basic/tests/cron-decorator.test.ts

View file


Open in desktop


File renamed without changes.


29 changes: 0 additions & 29 deletions
...-applications/nestjs/tests/errors.test.ts → ...cations/nestjs-basic/tests/errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,32 +53,3 @@ test('Does not send expected exception to Sentry', async ({ baseURL }) => {

 expect(errorEventOccurred).toBe(false);
});

test('Does not handle expected exception if exception is thrown in module', async ({ baseURL }) => {
 const errorEventPromise = waitForError('nestjs', event => {
 return !event.type && event.exception?.values?.[0]?.value === 'Something went wrong in the test module!';
 });

 const response = await fetch(`${baseURL}/test-module`);
 expect(response.status).toBe(500); // should be 400

 // should never arrive, but does because the exception is not handled properly
 const errorEvent = await errorEventPromise;

 expect(errorEvent.exception?.values).toHaveLength(1);
 expect(errorEvent.exception?.values?.[0]?.value).toBe('Something went wrong in the test module!');

 expect(errorEvent.request).toEqual({
 method: 'GET',
 cookies: {},
 headers: expect.any(Object),
 url: 'http://localhost:3030/test-module',
 });

 expect(errorEvent.transaction).toEqual('GET /test-module');

 expect(errorEvent.contexts?.trace).toEqual({
 trace_id: expect.any(String),
 span_id: expect.any(String),
 });
});

0
...tions/nestjs/tests/span-decorator.test.ts → ...nestjs-basic/tests/span-decorator.test.ts

View file


Open in desktop


File renamed without changes.


0
...cations/nestjs/tests/transactions.test.ts → ...s/nestjs-basic/tests/transactions.test.ts

View file


Open in desktop


File renamed without changes.


0
...t-applications/nestjs/tsconfig.build.json → ...ications/nestjs-basic/tsconfig.build.json

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/tsconfig.json → ...t-applications/nestjs-basic/tsconfig.json

View file


Open in desktop


File renamed without changes.


56 changes: 56 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/nest-cli.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
 }
}

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
{
 "name": "nestjs-distributed-tracing",
 "version": "0.0.1",
 "private": true,
 "scripts": {
 "build": "nest build",
 "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
 "start": "nest start",
 "start:dev": "nest start --watch",
 "start:debug": "nest start --debug --watch",
 "start:prod": "node dist/main",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test": "playwright test",
 "test:build": "pnpm install",
 "test:assert": "pnpm test"
 },
 "dependencies": {
 "@nestjs/common": "^10.0.0",
 "@nestjs/core": "^10.0.0",
 "@nestjs/platform-express": "^10.0.0",
 "@sentry/nestjs": "latest || *",
 "@sentry/types": "latest || *",
 "reflect-metadata": "^0.2.0",
 "rxjs": "^7.8.1"
 },
 "devDependencies": {
 "@playwright/test": "^1.44.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@nestjs/cli": "^10.0.0",
 "@nestjs/schematics": "^10.0.0",
 "@nestjs/testing": "^10.0.0",
 "@types/express": "^4.17.17",
 "@types/node": "18.15.1",
 "@types/supertest": "^6.0.0",
 "@typescript-eslint/eslint-plugin": "^6.0.0",
 "@typescript-eslint/parser": "^6.0.0",
 "eslint": "^8.42.0",
 "eslint-config-prettier": "^9.0.0",
 "eslint-plugin-prettier": "^5.0.0",
 "prettier": "^3.0.0",
 "source-map-support": "^0.5.21",
 "supertest": "^6.3.3",
 "ts-loader": "^9.4.3",
 "tsconfig-paths": "^4.2.0",
 "typescript": "^4.9.5"
 }
}

7 changes: 7 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: `pnpm start`,
});

export default config;

0
...est-applications/nestjs/src/instrument.ts → ...tjs-distributed-tracing/src/instrument.ts

View file


Open in desktop


File renamed without changes.


25 changes: 25 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { TraceInitiatorModule } from './trace-initiator.module';
import { TraceReceiverModule } from './trace-receiver.module';

const TRACE_INITIATOR_PORT = 3030;
const TRACE_RECEIVER_PORT = 3040;

async function bootstrap() {
 const trace_initiator_app = await NestFactory.create(TraceInitiatorModule);

 const { httpAdapter } = trace_initiator_app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(trace_initiator_app, new BaseExceptionFilter(httpAdapter));

 await trace_initiator_app.listen(TRACE_INITIATOR_PORT);

 const trace_receiver_app = await NestFactory.create(TraceReceiverModule);
 await trace_receiver_app.listen(TRACE_RECEIVER_PORT);
}

bootstrap();
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 8 commits into

from

Jul 18, 2024
 Merged


tests(e2e): Refactor nestjs e2e applications into multiple smaller test applications
#12948
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0abb355

Add separate nest sample application for distributed tracing tests


nicohrubec Jul 17, 2024
19a2af0

Add nestjs-distributed-tracing test application to build script


nicohrubec Jul 17, 2024
c8371aa

Add nest sample application for testing with submodules


nicohrubec Jul 17, 2024
6b9fb34

Update


nicohrubec Jul 17, 2024
cf083a4

Update basic nestjs test application


nicohrubec Jul 17, 2024
a752fa4

Rename test module to example module


nicohrubec Jul 17, 2024
b32759e

Lint


nicohrubec Jul 17, 2024
4165d78

Address PR comments


nicohrubec Jul 18, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 3 additions & 1 deletion
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1031,7 +1031,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',
Expand Down

0
...tests/test-applications/nestjs/.gitignore → ...test-applications/nestjs-basic/.gitignore

View file


Open in desktop


File renamed without changes.


0
...e2e-tests/test-applications/nestjs/.npmrc → ...sts/test-applications/nestjs-basic/.npmrc

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/nest-cli.json → ...t-applications/nestjs-basic/nest-cli.json

View file


Open in desktop


File renamed without changes.


2 changes: 1 addition & 1 deletion
...sts/test-applications/nestjs/package.json → ...st-applications/nestjs-basic/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
 "name": "nestjs",
 "name": "nestjs-basic",
 "version": "0.0.1",
 "private": true,
 "scripts": {
Expand Down

0
...applications/nestjs/playwright.config.mjs → ...ations/nestjs-basic/playwright.config.mjs

View file


Open in desktop


File renamed without changes.


37 changes: 37 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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();
 }
}

11 changes: 11 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 {}

78 changes: 1 addition & 77 deletions
...st-applications/nestjs/src/app.service.ts → ...lications/nestjs-basic/src/app.service.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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: {
Expand All@@ -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}`);
 }
Expand All@@ -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));
Expand DownExpand Up@@ -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',
 };
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-basic/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { AppModule } from './app.module';

const PORT = 3030;

async function bootstrap() {
 const app = await NestFactory.create(AppModule);

 const { httpAdapter } = app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

 await app.listen(PORT);
}

bootstrap();

0
...applications/nestjs/start-event-proxy.mjs → ...ations/nestjs-basic/start-event-proxy.mjs

View file


Open in desktop


File renamed without changes.


0
...tions/nestjs/tests/cron-decorator.test.ts → ...nestjs-basic/tests/cron-decorator.test.ts

View file


Open in desktop


File renamed without changes.


29 changes: 0 additions & 29 deletions
...-applications/nestjs/tests/errors.test.ts → ...cations/nestjs-basic/tests/errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,32 +53,3 @@ test('Does not send expected exception to Sentry', async ({ baseURL }) => {

 expect(errorEventOccurred).toBe(false);
});

test('Does not handle expected exception if exception is thrown in module', async ({ baseURL }) => {
 const errorEventPromise = waitForError('nestjs', event => {
 return !event.type && event.exception?.values?.[0]?.value === 'Something went wrong in the test module!';
 });

 const response = await fetch(`${baseURL}/test-module`);
 expect(response.status).toBe(500); // should be 400

 // should never arrive, but does because the exception is not handled properly
 const errorEvent = await errorEventPromise;

 expect(errorEvent.exception?.values).toHaveLength(1);
 expect(errorEvent.exception?.values?.[0]?.value).toBe('Something went wrong in the test module!');

 expect(errorEvent.request).toEqual({
 method: 'GET',
 cookies: {},
 headers: expect.any(Object),
 url: 'http://localhost:3030/test-module',
 });

 expect(errorEvent.transaction).toEqual('GET /test-module');

 expect(errorEvent.contexts?.trace).toEqual({
 trace_id: expect.any(String),
 span_id: expect.any(String),
 });
});

0
...tions/nestjs/tests/span-decorator.test.ts → ...nestjs-basic/tests/span-decorator.test.ts

View file


Open in desktop


File renamed without changes.


0
...cations/nestjs/tests/transactions.test.ts → ...s/nestjs-basic/tests/transactions.test.ts

View file


Open in desktop


File renamed without changes.


0
...t-applications/nestjs/tsconfig.build.json → ...ications/nestjs-basic/tsconfig.build.json

View file


Open in desktop


File renamed without changes.


0
...ts/test-applications/nestjs/tsconfig.json → ...t-applications/nestjs-basic/tsconfig.json

View file


Open in desktop


File renamed without changes.


56 changes: 56 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/nest-cli.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
 }
}

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
{
 "name": "nestjs-distributed-tracing",
 "version": "0.0.1",
 "private": true,
 "scripts": {
 "build": "nest build",
 "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
 "start": "nest start",
 "start:dev": "nest start --watch",
 "start:debug": "nest start --debug --watch",
 "start:prod": "node dist/main",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test": "playwright test",
 "test:build": "pnpm install",
 "test:assert": "pnpm test"
 },
 "dependencies": {
 "@nestjs/common": "^10.0.0",
 "@nestjs/core": "^10.0.0",
 "@nestjs/platform-express": "^10.0.0",
 "@sentry/nestjs": "latest || *",
 "@sentry/types": "latest || *",
 "reflect-metadata": "^0.2.0",
 "rxjs": "^7.8.1"
 },
 "devDependencies": {
 "@playwright/test": "^1.44.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@nestjs/cli": "^10.0.0",
 "@nestjs/schematics": "^10.0.0",
 "@nestjs/testing": "^10.0.0",
 "@types/express": "^4.17.17",
 "@types/node": "18.15.1",
 "@types/supertest": "^6.0.0",
 "@typescript-eslint/eslint-plugin": "^6.0.0",
 "@typescript-eslint/parser": "^6.0.0",
 "eslint": "^8.42.0",
 "eslint-config-prettier": "^9.0.0",
 "eslint-plugin-prettier": "^5.0.0",
 "prettier": "^3.0.0",
 "source-map-support": "^0.5.21",
 "supertest": "^6.3.3",
 "ts-loader": "^9.4.3",
 "tsconfig-paths": "^4.2.0",
 "typescript": "^4.9.5"
 }
}

7 changes: 7 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: `pnpm start`,
});

export default config;

0
...est-applications/nestjs/src/instrument.ts → ...tjs-distributed-tracing/src/instrument.ts

View file


Open in desktop


File renamed without changes.


25 changes: 25 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
// Import this first
import './instrument';

// Import other modules
import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/nestjs';
import { TraceInitiatorModule } from './trace-initiator.module';
import { TraceReceiverModule } from './trace-receiver.module';

const TRACE_INITIATOR_PORT = 3030;
const TRACE_RECEIVER_PORT = 3040;

async function bootstrap() {
 const trace_initiator_app = await NestFactory.create(TraceInitiatorModule);

 const { httpAdapter } = trace_initiator_app.get(HttpAdapterHost);
 Sentry.setupNestErrorHandler(trace_initiator_app, new BaseExceptionFilter(httpAdapter));

 await trace_initiator_app.listen(TRACE_INITIATOR_PORT);

 const trace_receiver_app = await NestFactory.create(TraceReceiverModule);
 await trace_receiver_app.listen(TRACE_RECEIVER_PORT);
}

bootstrap();
Loading