Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,4 +96,24 @@ export class AppController {
async exampleExceptionLocalFilter() {
throw new ExampleExceptionLocalFilter();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -707,3 +707,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,4 +82,24 @@ export class AppController {
async flush() {
await flush();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -705,3 +705,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
21 changes: 20 additions & 1 deletion packages/node/src/integrations/tracing/nest/helpers.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { CatchTarget, InjectableTarget, Observable, Subscription } from './types';
import type { CatchTarget, InjectableTarget, NextFunction, Observable, Subscription } from './types';

const sentryPatched = 'sentryPatched';

Expand DownExpand Up@@ -53,3 +53,22 @@ export function instrumentObservable(observable: Observable<unknown>, activeSpan
});
}
}

/**
* Proxies the next() call in a nestjs middleware to end the span when it is called.
*/
export function getNextProxy(next: NextFunction, span: Span, prevSpan: undefined | Span): NextFunction {
return new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import {
import { getActiveSpan, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { SDK_VERSION, addNonEnumerableProperty, isThenable } from '@sentry/utils';
import { getMiddlewareSpanOptions, instrumentObservable, isPatched } from './helpers';
import { getMiddlewareSpanOptions, getNextProxy, instrumentObservable, isPatched } from './helpers';
import type { CallHandler, CatchTarget, InjectableTarget, MinimalNestJsExecutionContext, Observable } from './types';

const supportedVersions = ['>=8.0.0 <11'];
Expand DownExpand Up@@ -101,23 +101,19 @@ export class SentryNestInstrumentation extends InstrumentationBase {
target.prototype.use = new Proxy(target.prototype.use, {
apply: (originalUse, thisArgUse, argsUse) => {
const [req, res, next, ...args] = argsUse;
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
const nextProxy = new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();
// Check that we can reasonably assume that the target is a middleware.
// Without these guards, instrumentation will fail if a function named 'use' on a service, which is
// decorated with @Injectable, is called.
if (!req || !res || !next || typeof next !== 'function') {
return originalUse.apply(thisArgUse, argsUse);
}

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
// proxy next to end span on call
const nextProxy = getNextProxy(next, span, prevSpan);
return originalUse.apply(thisArgUse, [req, res, nextProxy, args]);
});
},
Expand All@@ -133,6 +129,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.canActivate = new Proxy(target.prototype.canActivate, {
apply: (originalCanActivate, thisArgCanActivate, argsCanActivate) => {
const context: MinimalNestJsExecutionContext = argsCanActivate[0];

if (!context) {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
});
Expand All@@ -148,6 +150,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.transform = new Proxy(target.prototype.transform, {
apply: (originalTransform, thisArgTransform, argsTransform) => {
const value = argsTransform[0];
const metadata = argsTransform[1];

if (!value || !metadata) {
return originalTransform.apply(thisArgTransform, argsTransform);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalTransform.apply(thisArgTransform, argsTransform);
});
Expand All@@ -169,6 +178,11 @@ export class SentryNestInstrumentation extends InstrumentationBase {
const parentSpan = getActiveSpan();
let afterSpan: Span;

// Check that we can reasonably assume that the target is an interceptor.
if (!context || !next || typeof next.handle !== 'function') {
return originalIntercept.apply(thisArgIntercept, argsIntercept);
}

return startSpanManual(getMiddlewareSpanOptions(target), (beforeSpan: Span) => {
// eslint-disable-next-line @typescript-eslint/unbound-method
next.handle = new Proxy(next.handle, {
Expand DownExpand Up@@ -263,6 +277,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.catch = new Proxy(target.prototype.catch, {
apply: (originalCatch, thisArgCatch, argsCatch) => {
const exception = argsCatch[0];
const host = argsCatch[1];

if (!exception || !host) {
return originalCatch.apply(thisArgCatch, argsCatch);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCatch.apply(thisArgCatch, argsCatch);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,3 +73,8 @@ export interface CatchTarget {
catch?: (...args: any[]) => any;
};
}

/**
* Represents an express NextFunction.
*/
export type NextFunction = (err?: any) => void;
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,4 +96,24 @@ export class AppController {
async exampleExceptionLocalFilter() {
throw new ExampleExceptionLocalFilter();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -707,3 +707,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,4 +82,24 @@ export class AppController {
async flush() {
await flush();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -705,3 +705,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
21 changes: 20 additions & 1 deletion packages/node/src/integrations/tracing/nest/helpers.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { CatchTarget, InjectableTarget, Observable, Subscription } from './types';
import type { CatchTarget, InjectableTarget, NextFunction, Observable, Subscription } from './types';

const sentryPatched = 'sentryPatched';

Expand DownExpand Up@@ -53,3 +53,22 @@ export function instrumentObservable(observable: Observable<unknown>, activeSpan
});
}
}

/**
* Proxies the next() call in a nestjs middleware to end the span when it is called.
*/
export function getNextProxy(next: NextFunction, span: Span, prevSpan: undefined | Span): NextFunction {
return new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import {
import { getActiveSpan, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { SDK_VERSION, addNonEnumerableProperty, isThenable } from '@sentry/utils';
import { getMiddlewareSpanOptions, instrumentObservable, isPatched } from './helpers';
import { getMiddlewareSpanOptions, getNextProxy, instrumentObservable, isPatched } from './helpers';
import type { CallHandler, CatchTarget, InjectableTarget, MinimalNestJsExecutionContext, Observable } from './types';

const supportedVersions = ['>=8.0.0 <11'];
Expand DownExpand Up@@ -101,23 +101,19 @@ export class SentryNestInstrumentation extends InstrumentationBase {
target.prototype.use = new Proxy(target.prototype.use, {
apply: (originalUse, thisArgUse, argsUse) => {
const [req, res, next, ...args] = argsUse;
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
const nextProxy = new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();
// Check that we can reasonably assume that the target is a middleware.
// Without these guards, instrumentation will fail if a function named 'use' on a service, which is
// decorated with @Injectable, is called.
if (!req || !res || !next || typeof next !== 'function') {
return originalUse.apply(thisArgUse, argsUse);
}

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
// proxy next to end span on call
const nextProxy = getNextProxy(next, span, prevSpan);
return originalUse.apply(thisArgUse, [req, res, nextProxy, args]);
});
},
Expand All@@ -133,6 +129,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.canActivate = new Proxy(target.prototype.canActivate, {
apply: (originalCanActivate, thisArgCanActivate, argsCanActivate) => {
const context: MinimalNestJsExecutionContext = argsCanActivate[0];

if (!context) {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
});
Expand All@@ -148,6 +150,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.transform = new Proxy(target.prototype.transform, {
apply: (originalTransform, thisArgTransform, argsTransform) => {
const value = argsTransform[0];
const metadata = argsTransform[1];

if (!value || !metadata) {
return originalTransform.apply(thisArgTransform, argsTransform);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalTransform.apply(thisArgTransform, argsTransform);
});
Expand All@@ -169,6 +178,11 @@ export class SentryNestInstrumentation extends InstrumentationBase {
const parentSpan = getActiveSpan();
let afterSpan: Span;

// Check that we can reasonably assume that the target is an interceptor.
if (!context || !next || typeof next.handle !== 'function') {
return originalIntercept.apply(thisArgIntercept, argsIntercept);
}

return startSpanManual(getMiddlewareSpanOptions(target), (beforeSpan: Span) => {
// eslint-disable-next-line @typescript-eslint/unbound-method
next.handle = new Proxy(next.handle, {
Expand DownExpand Up@@ -263,6 +277,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.catch = new Proxy(target.prototype.catch, {
apply: (originalCatch, thisArgCatch, argsCatch) => {
const exception = argsCatch[0];
const host = argsCatch[1];

if (!exception || !host) {
return originalCatch.apply(thisArgCatch, argsCatch);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCatch.apply(thisArgCatch, argsCatch);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,3 +73,8 @@ export interface CatchTarget {
catch?: (...args: any[]) => any;
};
}

/**
* Represents an express NextFunction.
*/
export type NextFunction = (err?: any) => void;
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,4 +96,24 @@ export class AppController {
async exampleExceptionLocalFilter() {
throw new ExampleExceptionLocalFilter();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -707,3 +707,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,4 +82,24 @@ export class AppController {
async flush() {
await flush();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -705,3 +705,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
21 changes: 20 additions & 1 deletion packages/node/src/integrations/tracing/nest/helpers.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { CatchTarget, InjectableTarget, Observable, Subscription } from './types';
import type { CatchTarget, InjectableTarget, NextFunction, Observable, Subscription } from './types';

const sentryPatched = 'sentryPatched';

Expand DownExpand Up@@ -53,3 +53,22 @@ export function instrumentObservable(observable: Observable<unknown>, activeSpan
});
}
}

/**
* Proxies the next() call in a nestjs middleware to end the span when it is called.
*/
export function getNextProxy(next: NextFunction, span: Span, prevSpan: undefined | Span): NextFunction {
return new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import {
import { getActiveSpan, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { SDK_VERSION, addNonEnumerableProperty, isThenable } from '@sentry/utils';
import { getMiddlewareSpanOptions, instrumentObservable, isPatched } from './helpers';
import { getMiddlewareSpanOptions, getNextProxy, instrumentObservable, isPatched } from './helpers';
import type { CallHandler, CatchTarget, InjectableTarget, MinimalNestJsExecutionContext, Observable } from './types';

const supportedVersions = ['>=8.0.0 <11'];
Expand DownExpand Up@@ -101,23 +101,19 @@ export class SentryNestInstrumentation extends InstrumentationBase {
target.prototype.use = new Proxy(target.prototype.use, {
apply: (originalUse, thisArgUse, argsUse) => {
const [req, res, next, ...args] = argsUse;
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
const nextProxy = new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();
// Check that we can reasonably assume that the target is a middleware.
// Without these guards, instrumentation will fail if a function named 'use' on a service, which is
// decorated with @Injectable, is called.
if (!req || !res || !next || typeof next !== 'function') {
return originalUse.apply(thisArgUse, argsUse);
}

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
// proxy next to end span on call
const nextProxy = getNextProxy(next, span, prevSpan);
return originalUse.apply(thisArgUse, [req, res, nextProxy, args]);
});
},
Expand All@@ -133,6 +129,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.canActivate = new Proxy(target.prototype.canActivate, {
apply: (originalCanActivate, thisArgCanActivate, argsCanActivate) => {
const context: MinimalNestJsExecutionContext = argsCanActivate[0];

if (!context) {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
});
Expand All@@ -148,6 +150,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.transform = new Proxy(target.prototype.transform, {
apply: (originalTransform, thisArgTransform, argsTransform) => {
const value = argsTransform[0];
const metadata = argsTransform[1];

if (!value || !metadata) {
return originalTransform.apply(thisArgTransform, argsTransform);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalTransform.apply(thisArgTransform, argsTransform);
});
Expand All@@ -169,6 +178,11 @@ export class SentryNestInstrumentation extends InstrumentationBase {
const parentSpan = getActiveSpan();
let afterSpan: Span;

// Check that we can reasonably assume that the target is an interceptor.
if (!context || !next || typeof next.handle !== 'function') {
return originalIntercept.apply(thisArgIntercept, argsIntercept);
}

return startSpanManual(getMiddlewareSpanOptions(target), (beforeSpan: Span) => {
// eslint-disable-next-line @typescript-eslint/unbound-method
next.handle = new Proxy(next.handle, {
Expand DownExpand Up@@ -263,6 +277,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.catch = new Proxy(target.prototype.catch, {
apply: (originalCatch, thisArgCatch, argsCatch) => {
const exception = argsCatch[0];
const host = argsCatch[1];

if (!exception || !host) {
return originalCatch.apply(thisArgCatch, argsCatch);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCatch.apply(thisArgCatch, argsCatch);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,3 +73,8 @@ export interface CatchTarget {
catch?: (...args: any[]) => any;
};
}

/**
* Represents an express NextFunction.
*/
export type NextFunction = (err?: any) => void;
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,4 +96,24 @@ export class AppController {
async exampleExceptionLocalFilter() {
throw new ExampleExceptionLocalFilter();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -707,3 +707,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,4 +82,24 @@ export class AppController {
async flush() {
await flush();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -705,3 +705,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
21 changes: 20 additions & 1 deletion packages/node/src/integrations/tracing/nest/helpers.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { CatchTarget, InjectableTarget, Observable, Subscription } from './types';
import type { CatchTarget, InjectableTarget, NextFunction, Observable, Subscription } from './types';

const sentryPatched = 'sentryPatched';

Expand DownExpand Up@@ -53,3 +53,22 @@ export function instrumentObservable(observable: Observable<unknown>, activeSpan
});
}
}

/**
* Proxies the next() call in a nestjs middleware to end the span when it is called.
*/
export function getNextProxy(next: NextFunction, span: Span, prevSpan: undefined | Span): NextFunction {
return new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import {
import { getActiveSpan, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { SDK_VERSION, addNonEnumerableProperty, isThenable } from '@sentry/utils';
import { getMiddlewareSpanOptions, instrumentObservable, isPatched } from './helpers';
import { getMiddlewareSpanOptions, getNextProxy, instrumentObservable, isPatched } from './helpers';
import type { CallHandler, CatchTarget, InjectableTarget, MinimalNestJsExecutionContext, Observable } from './types';

const supportedVersions = ['>=8.0.0 <11'];
Expand DownExpand Up@@ -101,23 +101,19 @@ export class SentryNestInstrumentation extends InstrumentationBase {
target.prototype.use = new Proxy(target.prototype.use, {
apply: (originalUse, thisArgUse, argsUse) => {
const [req, res, next, ...args] = argsUse;
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
const nextProxy = new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();
// Check that we can reasonably assume that the target is a middleware.
// Without these guards, instrumentation will fail if a function named 'use' on a service, which is
// decorated with @Injectable, is called.
if (!req || !res || !next || typeof next !== 'function') {
return originalUse.apply(thisArgUse, argsUse);
}

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
// proxy next to end span on call
const nextProxy = getNextProxy(next, span, prevSpan);
return originalUse.apply(thisArgUse, [req, res, nextProxy, args]);
});
},
Expand All@@ -133,6 +129,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.canActivate = new Proxy(target.prototype.canActivate, {
apply: (originalCanActivate, thisArgCanActivate, argsCanActivate) => {
const context: MinimalNestJsExecutionContext = argsCanActivate[0];

if (!context) {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
});
Expand All@@ -148,6 +150,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.transform = new Proxy(target.prototype.transform, {
apply: (originalTransform, thisArgTransform, argsTransform) => {
const value = argsTransform[0];
const metadata = argsTransform[1];

if (!value || !metadata) {
return originalTransform.apply(thisArgTransform, argsTransform);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalTransform.apply(thisArgTransform, argsTransform);
});
Expand All@@ -169,6 +178,11 @@ export class SentryNestInstrumentation extends InstrumentationBase {
const parentSpan = getActiveSpan();
let afterSpan: Span;

// Check that we can reasonably assume that the target is an interceptor.
if (!context || !next || typeof next.handle !== 'function') {
return originalIntercept.apply(thisArgIntercept, argsIntercept);
}

return startSpanManual(getMiddlewareSpanOptions(target), (beforeSpan: Span) => {
// eslint-disable-next-line @typescript-eslint/unbound-method
next.handle = new Proxy(next.handle, {
Expand DownExpand Up@@ -263,6 +277,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.catch = new Proxy(target.prototype.catch, {
apply: (originalCatch, thisArgCatch, argsCatch) => {
const exception = argsCatch[0];
const host = argsCatch[1];

if (!exception || !host) {
return originalCatch.apply(thisArgCatch, argsCatch);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCatch.apply(thisArgCatch, argsCatch);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,3 +73,8 @@ export interface CatchTarget {
catch?: (...args: any[]) => any;
};
}

/**
* Represents an express NextFunction.
*/
export type NextFunction = (err?: any) => void;
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,4 +96,24 @@ export class AppController {
async exampleExceptionLocalFilter() {
throw new ExampleExceptionLocalFilter();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -707,3 +707,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,4 +82,24 @@ export class AppController {
async flush() {
await flush();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -705,3 +705,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
21 changes: 20 additions & 1 deletion packages/node/src/integrations/tracing/nest/helpers.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { CatchTarget, InjectableTarget, Observable, Subscription } from './types';
import type { CatchTarget, InjectableTarget, NextFunction, Observable, Subscription } from './types';

const sentryPatched = 'sentryPatched';

Expand DownExpand Up@@ -53,3 +53,22 @@ export function instrumentObservable(observable: Observable<unknown>, activeSpan
});
}
}

/**
* Proxies the next() call in a nestjs middleware to end the span when it is called.
*/
export function getNextProxy(next: NextFunction, span: Span, prevSpan: undefined | Span): NextFunction {
return new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import {
import { getActiveSpan, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { SDK_VERSION, addNonEnumerableProperty, isThenable } from '@sentry/utils';
import { getMiddlewareSpanOptions, instrumentObservable, isPatched } from './helpers';
import { getMiddlewareSpanOptions, getNextProxy, instrumentObservable, isPatched } from './helpers';
import type { CallHandler, CatchTarget, InjectableTarget, MinimalNestJsExecutionContext, Observable } from './types';

const supportedVersions = ['>=8.0.0 <11'];
Expand DownExpand Up@@ -101,23 +101,19 @@ export class SentryNestInstrumentation extends InstrumentationBase {
target.prototype.use = new Proxy(target.prototype.use, {
apply: (originalUse, thisArgUse, argsUse) => {
const [req, res, next, ...args] = argsUse;
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
const nextProxy = new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();
// Check that we can reasonably assume that the target is a middleware.
// Without these guards, instrumentation will fail if a function named 'use' on a service, which is
// decorated with @Injectable, is called.
if (!req || !res || !next || typeof next !== 'function') {
return originalUse.apply(thisArgUse, argsUse);
}

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
// proxy next to end span on call
const nextProxy = getNextProxy(next, span, prevSpan);
return originalUse.apply(thisArgUse, [req, res, nextProxy, args]);
});
},
Expand All@@ -133,6 +129,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.canActivate = new Proxy(target.prototype.canActivate, {
apply: (originalCanActivate, thisArgCanActivate, argsCanActivate) => {
const context: MinimalNestJsExecutionContext = argsCanActivate[0];

if (!context) {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
});
Expand All@@ -148,6 +150,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.transform = new Proxy(target.prototype.transform, {
apply: (originalTransform, thisArgTransform, argsTransform) => {
const value = argsTransform[0];
const metadata = argsTransform[1];

if (!value || !metadata) {
return originalTransform.apply(thisArgTransform, argsTransform);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalTransform.apply(thisArgTransform, argsTransform);
});
Expand All@@ -169,6 +178,11 @@ export class SentryNestInstrumentation extends InstrumentationBase {
const parentSpan = getActiveSpan();
let afterSpan: Span;

// Check that we can reasonably assume that the target is an interceptor.
if (!context || !next || typeof next.handle !== 'function') {
return originalIntercept.apply(thisArgIntercept, argsIntercept);
}

return startSpanManual(getMiddlewareSpanOptions(target), (beforeSpan: Span) => {
// eslint-disable-next-line @typescript-eslint/unbound-method
next.handle = new Proxy(next.handle, {
Expand DownExpand Up@@ -263,6 +277,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.catch = new Proxy(target.prototype.catch, {
apply: (originalCatch, thisArgCatch, argsCatch) => {
const exception = argsCatch[0];
const host = argsCatch[1];

if (!exception || !host) {
return originalCatch.apply(thisArgCatch, argsCatch);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCatch.apply(thisArgCatch, argsCatch);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,3 +73,8 @@ export interface CatchTarget {
catch?: (...args: any[]) => any;
};
}

/**
* Represents an express NextFunction.
*/
export type NextFunction = (err?: any) => void;
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,4 +96,24 @@ export class AppController {
async exampleExceptionLocalFilter() {
throw new ExampleExceptionLocalFilter();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -707,3 +707,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,4 +82,24 @@ export class AppController {
async flush() {
await flush();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -705,3 +705,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
21 changes: 20 additions & 1 deletion packages/node/src/integrations/tracing/nest/helpers.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { CatchTarget, InjectableTarget, Observable, Subscription } from './types';
import type { CatchTarget, InjectableTarget, NextFunction, Observable, Subscription } from './types';

const sentryPatched = 'sentryPatched';

Expand DownExpand Up@@ -53,3 +53,22 @@ export function instrumentObservable(observable: Observable<unknown>, activeSpan
});
}
}

/**
* Proxies the next() call in a nestjs middleware to end the span when it is called.
*/
export function getNextProxy(next: NextFunction, span: Span, prevSpan: undefined | Span): NextFunction {
return new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import {
import { getActiveSpan, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { SDK_VERSION, addNonEnumerableProperty, isThenable } from '@sentry/utils';
import { getMiddlewareSpanOptions, instrumentObservable, isPatched } from './helpers';
import { getMiddlewareSpanOptions, getNextProxy, instrumentObservable, isPatched } from './helpers';
import type { CallHandler, CatchTarget, InjectableTarget, MinimalNestJsExecutionContext, Observable } from './types';

const supportedVersions = ['>=8.0.0 <11'];
Expand DownExpand Up@@ -101,23 +101,19 @@ export class SentryNestInstrumentation extends InstrumentationBase {
target.prototype.use = new Proxy(target.prototype.use, {
apply: (originalUse, thisArgUse, argsUse) => {
const [req, res, next, ...args] = argsUse;
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
const nextProxy = new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();
// Check that we can reasonably assume that the target is a middleware.
// Without these guards, instrumentation will fail if a function named 'use' on a service, which is
// decorated with @Injectable, is called.
if (!req || !res || !next || typeof next !== 'function') {
return originalUse.apply(thisArgUse, argsUse);
}

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
// proxy next to end span on call
const nextProxy = getNextProxy(next, span, prevSpan);
return originalUse.apply(thisArgUse, [req, res, nextProxy, args]);
});
},
Expand All@@ -133,6 +129,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.canActivate = new Proxy(target.prototype.canActivate, {
apply: (originalCanActivate, thisArgCanActivate, argsCanActivate) => {
const context: MinimalNestJsExecutionContext = argsCanActivate[0];

if (!context) {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
});
Expand All@@ -148,6 +150,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.transform = new Proxy(target.prototype.transform, {
apply: (originalTransform, thisArgTransform, argsTransform) => {
const value = argsTransform[0];
const metadata = argsTransform[1];

if (!value || !metadata) {
return originalTransform.apply(thisArgTransform, argsTransform);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalTransform.apply(thisArgTransform, argsTransform);
});
Expand All@@ -169,6 +178,11 @@ export class SentryNestInstrumentation extends InstrumentationBase {
const parentSpan = getActiveSpan();
let afterSpan: Span;

// Check that we can reasonably assume that the target is an interceptor.
if (!context || !next || typeof next.handle !== 'function') {
return originalIntercept.apply(thisArgIntercept, argsIntercept);
}

return startSpanManual(getMiddlewareSpanOptions(target), (beforeSpan: Span) => {
// eslint-disable-next-line @typescript-eslint/unbound-method
next.handle = new Proxy(next.handle, {
Expand DownExpand Up@@ -263,6 +277,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.catch = new Proxy(target.prototype.catch, {
apply: (originalCatch, thisArgCatch, argsCatch) => {
const exception = argsCatch[0];
const host = argsCatch[1];

if (!exception || !host) {
return originalCatch.apply(thisArgCatch, argsCatch);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCatch.apply(thisArgCatch, argsCatch);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,3 +73,8 @@ export interface CatchTarget {
catch?: (...args: any[]) => any;
};
}

/**
* Represents an express NextFunction.
*/
export type NextFunction = (err?: any) => void;
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,4 +96,24 @@ export class AppController {
async exampleExceptionLocalFilter() {
throw new ExampleExceptionLocalFilter();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -707,3 +707,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,4 +82,24 @@ export class AppController {
async flush() {
await flush();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -705,3 +705,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
21 changes: 20 additions & 1 deletion packages/node/src/integrations/tracing/nest/helpers.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { CatchTarget, InjectableTarget, Observable, Subscription } from './types';
import type { CatchTarget, InjectableTarget, NextFunction, Observable, Subscription } from './types';

const sentryPatched = 'sentryPatched';

Expand DownExpand Up@@ -53,3 +53,22 @@ export function instrumentObservable(observable: Observable<unknown>, activeSpan
});
}
}

/**
* Proxies the next() call in a nestjs middleware to end the span when it is called.
*/
export function getNextProxy(next: NextFunction, span: Span, prevSpan: undefined | Span): NextFunction {
return new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import {
import { getActiveSpan, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { SDK_VERSION, addNonEnumerableProperty, isThenable } from '@sentry/utils';
import { getMiddlewareSpanOptions, instrumentObservable, isPatched } from './helpers';
import { getMiddlewareSpanOptions, getNextProxy, instrumentObservable, isPatched } from './helpers';
import type { CallHandler, CatchTarget, InjectableTarget, MinimalNestJsExecutionContext, Observable } from './types';

const supportedVersions = ['>=8.0.0 <11'];
Expand DownExpand Up@@ -101,23 +101,19 @@ export class SentryNestInstrumentation extends InstrumentationBase {
target.prototype.use = new Proxy(target.prototype.use, {
apply: (originalUse, thisArgUse, argsUse) => {
const [req, res, next, ...args] = argsUse;
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
const nextProxy = new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();
// Check that we can reasonably assume that the target is a middleware.
// Without these guards, instrumentation will fail if a function named 'use' on a service, which is
// decorated with @Injectable, is called.
if (!req || !res || !next || typeof next !== 'function') {
return originalUse.apply(thisArgUse, argsUse);
}

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
// proxy next to end span on call
const nextProxy = getNextProxy(next, span, prevSpan);
return originalUse.apply(thisArgUse, [req, res, nextProxy, args]);
});
},
Expand All@@ -133,6 +129,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.canActivate = new Proxy(target.prototype.canActivate, {
apply: (originalCanActivate, thisArgCanActivate, argsCanActivate) => {
const context: MinimalNestJsExecutionContext = argsCanActivate[0];

if (!context) {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
});
Expand All@@ -148,6 +150,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.transform = new Proxy(target.prototype.transform, {
apply: (originalTransform, thisArgTransform, argsTransform) => {
const value = argsTransform[0];
const metadata = argsTransform[1];

if (!value || !metadata) {
return originalTransform.apply(thisArgTransform, argsTransform);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalTransform.apply(thisArgTransform, argsTransform);
});
Expand All@@ -169,6 +178,11 @@ export class SentryNestInstrumentation extends InstrumentationBase {
const parentSpan = getActiveSpan();
let afterSpan: Span;

// Check that we can reasonably assume that the target is an interceptor.
if (!context || !next || typeof next.handle !== 'function') {
return originalIntercept.apply(thisArgIntercept, argsIntercept);
}

return startSpanManual(getMiddlewareSpanOptions(target), (beforeSpan: Span) => {
// eslint-disable-next-line @typescript-eslint/unbound-method
next.handle = new Proxy(next.handle, {
Expand DownExpand Up@@ -263,6 +277,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.catch = new Proxy(target.prototype.catch, {
apply: (originalCatch, thisArgCatch, argsCatch) => {
const exception = argsCatch[0];
const host = argsCatch[1];

if (!exception || !host) {
return originalCatch.apply(thisArgCatch, argsCatch);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCatch.apply(thisArgCatch, argsCatch);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,3 +73,8 @@ export interface CatchTarget {
catch?: (...args: any[]) => any;
};
}

/**
* Represents an express NextFunction.
*/
export type NextFunction = (err?: any) => void;
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,4 +96,24 @@ export class AppController {
async exampleExceptionLocalFilter() {
throw new ExampleExceptionLocalFilter();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -707,3 +707,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,4 +82,24 @@ export class AppController {
async flush() {
await flush();
}

@Get('test-service-use')
testServiceWithUseMethod() {
return this.appService.use();
}

@Get('test-service-transform')
testServiceWithTransform() {
return this.appService.transform();
}

@Get('test-service-intercept')
testServiceWithIntercept() {
return this.appService.intercept();
}

@Get('test-service-canActivate')
testServiceWithCanActivate() {
return this.appService.canActivate();
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,4 +78,20 @@ export class AppService {
async killTestCron() {
this.schedulerRegistry.deleteCronJob('test-cron-job');
}

use() {
console.log('Test use!');
}

transform() {
console.log('Test transform!');
}

intercept() {
console.log('Test intercept!');
}

canActivate() {
console.log('Test canActivate!');
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -705,3 +705,23 @@ test('API route transaction includes exactly one nest async interceptor span aft
// 'Interceptor - After Route' is NOT the parent of 'test-controller-span'
expect(testControllerSpan.parent_span_id).not.toBe(exampleInterceptorSpanAfterRouteId);
});

test('Calling use method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-use`);
expect(response.status).toBe(200);
});

test('Calling transform method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-transform`);
expect(response.status).toBe(200);
});

test('Calling intercept method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-intercept`);
expect(response.status).toBe(200);
});

test('Calling canActivate method on service with Injectable decorator returns 200', async ({ baseURL }) => {
const response = await fetch(`${baseURL}/test-service-canActivate`);
expect(response.status).toBe(200);
});
21 changes: 20 additions & 1 deletion packages/node/src/integrations/tracing/nest/helpers.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { CatchTarget, InjectableTarget, Observable, Subscription } from './types';
import type { CatchTarget, InjectableTarget, NextFunction, Observable, Subscription } from './types';

const sentryPatched = 'sentryPatched';

Expand DownExpand Up@@ -53,3 +53,22 @@ export function instrumentObservable(observable: Observable<unknown>, activeSpan
});
}
}

/**
* Proxies the next() call in a nestjs middleware to end the span when it is called.
*/
export function getNextProxy(next: NextFunction, span: Span, prevSpan: undefined | Span): NextFunction {
return new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import {
import { getActiveSpan, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from '@sentry/core';
import type { Span } from '@sentry/types';
import { SDK_VERSION, addNonEnumerableProperty, isThenable } from '@sentry/utils';
import { getMiddlewareSpanOptions, instrumentObservable, isPatched } from './helpers';
import { getMiddlewareSpanOptions, getNextProxy, instrumentObservable, isPatched } from './helpers';
import type { CallHandler, CatchTarget, InjectableTarget, MinimalNestJsExecutionContext, Observable } from './types';

const supportedVersions = ['>=8.0.0 <11'];
Expand DownExpand Up@@ -101,23 +101,19 @@ export class SentryNestInstrumentation extends InstrumentationBase {
target.prototype.use = new Proxy(target.prototype.use, {
apply: (originalUse, thisArgUse, argsUse) => {
const [req, res, next, ...args] = argsUse;
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
const nextProxy = new Proxy(next, {
apply: (originalNext, thisArgNext, argsNext) => {
span.end();
// Check that we can reasonably assume that the target is a middleware.
// Without these guards, instrumentation will fail if a function named 'use' on a service, which is
// decorated with @Injectable, is called.
if (!req || !res || !next || typeof next !== 'function') {
return originalUse.apply(thisArgUse, argsUse);
}

if (prevSpan) {
return withActiveSpan(prevSpan, () => {
return Reflect.apply(originalNext, thisArgNext, argsNext);
});
} else {
return Reflect.apply(originalNext, thisArgNext, argsNext);
}
},
});
const prevSpan = getActiveSpan();

return startSpanManual(getMiddlewareSpanOptions(target), (span: Span) => {
// proxy next to end span on call
const nextProxy = getNextProxy(next, span, prevSpan);
return originalUse.apply(thisArgUse, [req, res, nextProxy, args]);
});
},
Expand All@@ -133,6 +129,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.canActivate = new Proxy(target.prototype.canActivate, {
apply: (originalCanActivate, thisArgCanActivate, argsCanActivate) => {
const context: MinimalNestJsExecutionContext = argsCanActivate[0];

if (!context) {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCanActivate.apply(thisArgCanActivate, argsCanActivate);
});
Expand All@@ -148,6 +150,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.transform = new Proxy(target.prototype.transform, {
apply: (originalTransform, thisArgTransform, argsTransform) => {
const value = argsTransform[0];
const metadata = argsTransform[1];

if (!value || !metadata) {
return originalTransform.apply(thisArgTransform, argsTransform);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalTransform.apply(thisArgTransform, argsTransform);
});
Expand All@@ -169,6 +178,11 @@ export class SentryNestInstrumentation extends InstrumentationBase {
const parentSpan = getActiveSpan();
let afterSpan: Span;

// Check that we can reasonably assume that the target is an interceptor.
if (!context || !next || typeof next.handle !== 'function') {
return originalIntercept.apply(thisArgIntercept, argsIntercept);
}

return startSpanManual(getMiddlewareSpanOptions(target), (beforeSpan: Span) => {
// eslint-disable-next-line @typescript-eslint/unbound-method
next.handle = new Proxy(next.handle, {
Expand DownExpand Up@@ -263,6 +277,13 @@ export class SentryNestInstrumentation extends InstrumentationBase {

target.prototype.catch = new Proxy(target.prototype.catch, {
apply: (originalCatch, thisArgCatch, argsCatch) => {
const exception = argsCatch[0];
const host = argsCatch[1];

if (!exception || !host) {
return originalCatch.apply(thisArgCatch, argsCatch);
}

return startSpan(getMiddlewareSpanOptions(target), () => {
return originalCatch.apply(thisArgCatch, argsCatch);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,3 +73,8 @@ export interface CatchTarget {
catch?: (...args: any[]) => any;
};
}

/**
* Represents an express NextFunction.
*/
export type NextFunction = (err?: any) => void;