feat(nestjs): Add function-level span decorator to nestjs - #12721

Merged
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator
Jul 4, 2024
Merged

feat(nestjs): Add function-level span decorator to nestjs#12721
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator

Conversation

@nicohrubec

@nicohrubecnicohrubec commented Jul 2, 2024

Copy link
Copy Markdown
Member

Adds a decorator @SentryTraced() to the nestjs sdk that can be used on functions to wrap them in a span.

Manual test from my sample application see screenshot below.

Screenshot 2024-07-02 at 13 58 51

  • e2e test
  • README update with short example demonstrating how to use this feature

@nicohrubec
nicohrubec marked this pull request as ready for review July 3, 2024 13:55
Comment threadpackages/nestjs/README.md Outdated

## Span Decorator

Use the @GetSentrySpan() decorator to gain additional performance insights for any function within your NestJS application.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Is GetX a pattern that is common for nest? To me it reads a bit weird, something like WrapWithSentrySpan or something along these lines would feel more explanatory to me, but no strong feelings!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SentryTraced

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, GetX is not super common in nest was just an initial idea. I like SentryTraced if everyone is happy with that

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to SentryTraced

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few things that should be adressed but otherwise looks great.

Comment on lines +19 to +23
try {
return await originalMethod.apply(this, args);
} catch (e) {
captureException(e);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We do not want to wrap this with a try-catch-captureException. We only want to capture errors when they bubble up to an unexpected place.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment threadpackages/nestjs/src/index.ts Outdated

export { init } from './sdk';

export * from './span-decorator';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: In the index file, let's be specific about what we export. This is to avoid accidentally widening the API surface.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

const originalMethod = descriptor.value as (...args: any[]) => Promise<any>;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
descriptor.value = async function (...args: any[]) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We should not modify the return value. Currently we are wrapping all non-promise return values in a Promise. To fix this we can just remove all async and await keywords and everything will work perfectly fine.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

expect.objectContaining({
span_id: expect.any(String),
trace_id: expect.any(String),
data: expect.any(Object),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Let's assert on the sentry.origin and sentry.source attibutes in the data object.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly assert the data object now, there is no sentry.source property though

Comment on lines +80 to +83
@SentryTraced('wait function')
async wait() {
return new Promise(resolve => setTimeout(resolve, 500));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: We could add a second method that is not async and assert on it in the test.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a second non-async function and then check whether the transaction includes spans for both?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@nicohrubecnicohrubec mentioned this pull request Jul 4, 2024
@nicohrubecnicohrubec linked an issue Jul 4, 2024 that may be closed by this pull request
@nicohrubec
nicohrubec requested a review from lforstJuly 4, 2024 12:46
@nicohrubec
nicohrubec merged commit 41d946e into developJul 4, 2024
@nicohrubec
nicohrubec deleted the nh/nestjs-span-decorator branch July 4, 2024 13:50
@nicohrubecnicohrubec self-assigned this Jul 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SentryTraced() decorator to get spans for arbitrary functions

3 participants

@nicohrubec@mydea@lforst
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} 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

feat(nestjs): Add function-level span decorator to nestjs - #12721

Merged
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator
Jul 4, 2024
Merged

feat(nestjs): Add function-level span decorator to nestjs#12721
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator

Conversation

@nicohrubec

@nicohrubecnicohrubec commented Jul 2, 2024

Copy link
Copy Markdown
Member

Adds a decorator @SentryTraced() to the nestjs sdk that can be used on functions to wrap them in a span.

Manual test from my sample application see screenshot below.

Screenshot 2024-07-02 at 13 58 51

  • e2e test
  • README update with short example demonstrating how to use this feature

@nicohrubec
nicohrubec marked this pull request as ready for review July 3, 2024 13:55
Comment threadpackages/nestjs/README.md Outdated

## Span Decorator

Use the @GetSentrySpan() decorator to gain additional performance insights for any function within your NestJS application.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Is GetX a pattern that is common for nest? To me it reads a bit weird, something like WrapWithSentrySpan or something along these lines would feel more explanatory to me, but no strong feelings!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SentryTraced

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, GetX is not super common in nest was just an initial idea. I like SentryTraced if everyone is happy with that

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to SentryTraced

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few things that should be adressed but otherwise looks great.

Comment on lines +19 to +23
try {
return await originalMethod.apply(this, args);
} catch (e) {
captureException(e);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We do not want to wrap this with a try-catch-captureException. We only want to capture errors when they bubble up to an unexpected place.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment threadpackages/nestjs/src/index.ts Outdated

export { init } from './sdk';

export * from './span-decorator';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: In the index file, let's be specific about what we export. This is to avoid accidentally widening the API surface.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

const originalMethod = descriptor.value as (...args: any[]) => Promise<any>;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
descriptor.value = async function (...args: any[]) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We should not modify the return value. Currently we are wrapping all non-promise return values in a Promise. To fix this we can just remove all async and await keywords and everything will work perfectly fine.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

expect.objectContaining({
span_id: expect.any(String),
trace_id: expect.any(String),
data: expect.any(Object),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Let's assert on the sentry.origin and sentry.source attibutes in the data object.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly assert the data object now, there is no sentry.source property though

Comment on lines +80 to +83
@SentryTraced('wait function')
async wait() {
return new Promise(resolve => setTimeout(resolve, 500));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: We could add a second method that is not async and assert on it in the test.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a second non-async function and then check whether the transaction includes spans for both?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@nicohrubecnicohrubec mentioned this pull request Jul 4, 2024
@nicohrubecnicohrubec linked an issue Jul 4, 2024 that may be closed by this pull request
@nicohrubec
nicohrubec requested a review from lforstJuly 4, 2024 12:46
@nicohrubec
nicohrubec merged commit 41d946e into developJul 4, 2024
@nicohrubec
nicohrubec deleted the nh/nestjs-span-decorator branch July 4, 2024 13:50
@nicohrubecnicohrubec self-assigned this Jul 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SentryTraced() decorator to get spans for arbitrary functions

3 participants

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

feat(nestjs): Add function-level span decorator to nestjs - #12721

Merged
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator
Jul 4, 2024
Merged

feat(nestjs): Add function-level span decorator to nestjs#12721
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator

Conversation

@nicohrubec

@nicohrubecnicohrubec commented Jul 2, 2024

Copy link
Copy Markdown
Member

Adds a decorator @SentryTraced() to the nestjs sdk that can be used on functions to wrap them in a span.

Manual test from my sample application see screenshot below.

Screenshot 2024-07-02 at 13 58 51

  • e2e test
  • README update with short example demonstrating how to use this feature

@nicohrubec
nicohrubec marked this pull request as ready for review July 3, 2024 13:55
Comment threadpackages/nestjs/README.md Outdated

## Span Decorator

Use the @GetSentrySpan() decorator to gain additional performance insights for any function within your NestJS application.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Is GetX a pattern that is common for nest? To me it reads a bit weird, something like WrapWithSentrySpan or something along these lines would feel more explanatory to me, but no strong feelings!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SentryTraced

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, GetX is not super common in nest was just an initial idea. I like SentryTraced if everyone is happy with that

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to SentryTraced

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few things that should be adressed but otherwise looks great.

Comment on lines +19 to +23
try {
return await originalMethod.apply(this, args);
} catch (e) {
captureException(e);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We do not want to wrap this with a try-catch-captureException. We only want to capture errors when they bubble up to an unexpected place.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment threadpackages/nestjs/src/index.ts Outdated

export { init } from './sdk';

export * from './span-decorator';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: In the index file, let's be specific about what we export. This is to avoid accidentally widening the API surface.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

const originalMethod = descriptor.value as (...args: any[]) => Promise<any>;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
descriptor.value = async function (...args: any[]) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We should not modify the return value. Currently we are wrapping all non-promise return values in a Promise. To fix this we can just remove all async and await keywords and everything will work perfectly fine.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

expect.objectContaining({
span_id: expect.any(String),
trace_id: expect.any(String),
data: expect.any(Object),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Let's assert on the sentry.origin and sentry.source attibutes in the data object.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly assert the data object now, there is no sentry.source property though

Comment on lines +80 to +83
@SentryTraced('wait function')
async wait() {
return new Promise(resolve => setTimeout(resolve, 500));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: We could add a second method that is not async and assert on it in the test.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a second non-async function and then check whether the transaction includes spans for both?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@nicohrubecnicohrubec mentioned this pull request Jul 4, 2024
@nicohrubecnicohrubec linked an issue Jul 4, 2024 that may be closed by this pull request
@nicohrubec
nicohrubec requested a review from lforstJuly 4, 2024 12:46
@nicohrubec
nicohrubec merged commit 41d946e into developJul 4, 2024
@nicohrubec
nicohrubec deleted the nh/nestjs-span-decorator branch July 4, 2024 13:50
@nicohrubecnicohrubec self-assigned this Jul 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SentryTraced() decorator to get spans for arbitrary functions

3 participants

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

feat(nestjs): Add function-level span decorator to nestjs - #12721

Merged
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator
Jul 4, 2024
Merged

feat(nestjs): Add function-level span decorator to nestjs#12721
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator

Conversation

@nicohrubec

@nicohrubecnicohrubec commented Jul 2, 2024

Copy link
Copy Markdown
Member

Adds a decorator @SentryTraced() to the nestjs sdk that can be used on functions to wrap them in a span.

Manual test from my sample application see screenshot below.

Screenshot 2024-07-02 at 13 58 51

  • e2e test
  • README update with short example demonstrating how to use this feature

@nicohrubec
nicohrubec marked this pull request as ready for review July 3, 2024 13:55
Comment threadpackages/nestjs/README.md Outdated

## Span Decorator

Use the @GetSentrySpan() decorator to gain additional performance insights for any function within your NestJS application.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Is GetX a pattern that is common for nest? To me it reads a bit weird, something like WrapWithSentrySpan or something along these lines would feel more explanatory to me, but no strong feelings!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SentryTraced

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, GetX is not super common in nest was just an initial idea. I like SentryTraced if everyone is happy with that

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to SentryTraced

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few things that should be adressed but otherwise looks great.

Comment on lines +19 to +23
try {
return await originalMethod.apply(this, args);
} catch (e) {
captureException(e);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We do not want to wrap this with a try-catch-captureException. We only want to capture errors when they bubble up to an unexpected place.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment threadpackages/nestjs/src/index.ts Outdated

export { init } from './sdk';

export * from './span-decorator';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: In the index file, let's be specific about what we export. This is to avoid accidentally widening the API surface.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

const originalMethod = descriptor.value as (...args: any[]) => Promise<any>;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
descriptor.value = async function (...args: any[]) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We should not modify the return value. Currently we are wrapping all non-promise return values in a Promise. To fix this we can just remove all async and await keywords and everything will work perfectly fine.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

expect.objectContaining({
span_id: expect.any(String),
trace_id: expect.any(String),
data: expect.any(Object),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Let's assert on the sentry.origin and sentry.source attibutes in the data object.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly assert the data object now, there is no sentry.source property though

Comment on lines +80 to +83
@SentryTraced('wait function')
async wait() {
return new Promise(resolve => setTimeout(resolve, 500));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: We could add a second method that is not async and assert on it in the test.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a second non-async function and then check whether the transaction includes spans for both?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@nicohrubecnicohrubec mentioned this pull request Jul 4, 2024
@nicohrubecnicohrubec linked an issue Jul 4, 2024 that may be closed by this pull request
@nicohrubec
nicohrubec requested a review from lforstJuly 4, 2024 12:46
@nicohrubec
nicohrubec merged commit 41d946e into developJul 4, 2024
@nicohrubec
nicohrubec deleted the nh/nestjs-span-decorator branch July 4, 2024 13:50
@nicohrubecnicohrubec self-assigned this Jul 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SentryTraced() decorator to get spans for arbitrary functions

3 participants

@nicohrubec@mydea@lforst
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } 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

feat(nestjs): Add function-level span decorator to nestjs - #12721

Merged
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator
Jul 4, 2024
Merged

feat(nestjs): Add function-level span decorator to nestjs#12721
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator

Conversation

@nicohrubec

@nicohrubecnicohrubec commented Jul 2, 2024

Copy link
Copy Markdown
Member

Adds a decorator @SentryTraced() to the nestjs sdk that can be used on functions to wrap them in a span.

Manual test from my sample application see screenshot below.

Screenshot 2024-07-02 at 13 58 51

  • e2e test
  • README update with short example demonstrating how to use this feature

@nicohrubec
nicohrubec marked this pull request as ready for review July 3, 2024 13:55
Comment threadpackages/nestjs/README.md Outdated

## Span Decorator

Use the @GetSentrySpan() decorator to gain additional performance insights for any function within your NestJS application.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Is GetX a pattern that is common for nest? To me it reads a bit weird, something like WrapWithSentrySpan or something along these lines would feel more explanatory to me, but no strong feelings!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SentryTraced

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, GetX is not super common in nest was just an initial idea. I like SentryTraced if everyone is happy with that

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to SentryTraced

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few things that should be adressed but otherwise looks great.

Comment on lines +19 to +23
try {
return await originalMethod.apply(this, args);
} catch (e) {
captureException(e);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We do not want to wrap this with a try-catch-captureException. We only want to capture errors when they bubble up to an unexpected place.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment threadpackages/nestjs/src/index.ts Outdated

export { init } from './sdk';

export * from './span-decorator';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: In the index file, let's be specific about what we export. This is to avoid accidentally widening the API surface.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

const originalMethod = descriptor.value as (...args: any[]) => Promise<any>;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
descriptor.value = async function (...args: any[]) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We should not modify the return value. Currently we are wrapping all non-promise return values in a Promise. To fix this we can just remove all async and await keywords and everything will work perfectly fine.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

expect.objectContaining({
span_id: expect.any(String),
trace_id: expect.any(String),
data: expect.any(Object),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Let's assert on the sentry.origin and sentry.source attibutes in the data object.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly assert the data object now, there is no sentry.source property though

Comment on lines +80 to +83
@SentryTraced('wait function')
async wait() {
return new Promise(resolve => setTimeout(resolve, 500));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: We could add a second method that is not async and assert on it in the test.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a second non-async function and then check whether the transaction includes spans for both?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@nicohrubecnicohrubec mentioned this pull request Jul 4, 2024
@nicohrubecnicohrubec linked an issue Jul 4, 2024 that may be closed by this pull request
@nicohrubec
nicohrubec requested a review from lforstJuly 4, 2024 12:46
@nicohrubec
nicohrubec merged commit 41d946e into developJul 4, 2024
@nicohrubec
nicohrubec deleted the nh/nestjs-span-decorator branch July 4, 2024 13:50
@nicohrubecnicohrubec self-assigned this Jul 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SentryTraced() decorator to get spans for arbitrary functions

3 participants

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

feat(nestjs): Add function-level span decorator to nestjs - #12721

Merged
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator
Jul 4, 2024
Merged

feat(nestjs): Add function-level span decorator to nestjs#12721
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator

Conversation

@nicohrubec

@nicohrubecnicohrubec commented Jul 2, 2024

Copy link
Copy Markdown
Member

Adds a decorator @SentryTraced() to the nestjs sdk that can be used on functions to wrap them in a span.

Manual test from my sample application see screenshot below.

Screenshot 2024-07-02 at 13 58 51

  • e2e test
  • README update with short example demonstrating how to use this feature

@nicohrubec
nicohrubec marked this pull request as ready for review July 3, 2024 13:55
Comment threadpackages/nestjs/README.md Outdated

## Span Decorator

Use the @GetSentrySpan() decorator to gain additional performance insights for any function within your NestJS application.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Is GetX a pattern that is common for nest? To me it reads a bit weird, something like WrapWithSentrySpan or something along these lines would feel more explanatory to me, but no strong feelings!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SentryTraced

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, GetX is not super common in nest was just an initial idea. I like SentryTraced if everyone is happy with that

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to SentryTraced

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few things that should be adressed but otherwise looks great.

Comment on lines +19 to +23
try {
return await originalMethod.apply(this, args);
} catch (e) {
captureException(e);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We do not want to wrap this with a try-catch-captureException. We only want to capture errors when they bubble up to an unexpected place.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment threadpackages/nestjs/src/index.ts Outdated

export { init } from './sdk';

export * from './span-decorator';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: In the index file, let's be specific about what we export. This is to avoid accidentally widening the API surface.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

const originalMethod = descriptor.value as (...args: any[]) => Promise<any>;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
descriptor.value = async function (...args: any[]) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We should not modify the return value. Currently we are wrapping all non-promise return values in a Promise. To fix this we can just remove all async and await keywords and everything will work perfectly fine.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

expect.objectContaining({
span_id: expect.any(String),
trace_id: expect.any(String),
data: expect.any(Object),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Let's assert on the sentry.origin and sentry.source attibutes in the data object.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly assert the data object now, there is no sentry.source property though

Comment on lines +80 to +83
@SentryTraced('wait function')
async wait() {
return new Promise(resolve => setTimeout(resolve, 500));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: We could add a second method that is not async and assert on it in the test.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a second non-async function and then check whether the transaction includes spans for both?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@nicohrubecnicohrubec mentioned this pull request Jul 4, 2024
@nicohrubecnicohrubec linked an issue Jul 4, 2024 that may be closed by this pull request
@nicohrubec
nicohrubec requested a review from lforstJuly 4, 2024 12:46
@nicohrubec
nicohrubec merged commit 41d946e into developJul 4, 2024
@nicohrubec
nicohrubec deleted the nh/nestjs-span-decorator branch July 4, 2024 13:50
@nicohrubecnicohrubec self-assigned this Jul 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SentryTraced() decorator to get spans for arbitrary functions

3 participants

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

feat(nestjs): Add function-level span decorator to nestjs - #12721

Merged
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator
Jul 4, 2024
Merged

feat(nestjs): Add function-level span decorator to nestjs#12721
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator

Conversation

@nicohrubec

@nicohrubecnicohrubec commented Jul 2, 2024

Copy link
Copy Markdown
Member

Adds a decorator @SentryTraced() to the nestjs sdk that can be used on functions to wrap them in a span.

Manual test from my sample application see screenshot below.

Screenshot 2024-07-02 at 13 58 51

  • e2e test
  • README update with short example demonstrating how to use this feature

@nicohrubec
nicohrubec marked this pull request as ready for review July 3, 2024 13:55
Comment threadpackages/nestjs/README.md Outdated

## Span Decorator

Use the @GetSentrySpan() decorator to gain additional performance insights for any function within your NestJS application.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Is GetX a pattern that is common for nest? To me it reads a bit weird, something like WrapWithSentrySpan or something along these lines would feel more explanatory to me, but no strong feelings!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SentryTraced

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, GetX is not super common in nest was just an initial idea. I like SentryTraced if everyone is happy with that

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to SentryTraced

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few things that should be adressed but otherwise looks great.

Comment on lines +19 to +23
try {
return await originalMethod.apply(this, args);
} catch (e) {
captureException(e);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We do not want to wrap this with a try-catch-captureException. We only want to capture errors when they bubble up to an unexpected place.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment threadpackages/nestjs/src/index.ts Outdated

export { init } from './sdk';

export * from './span-decorator';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: In the index file, let's be specific about what we export. This is to avoid accidentally widening the API surface.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

const originalMethod = descriptor.value as (...args: any[]) => Promise<any>;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
descriptor.value = async function (...args: any[]) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We should not modify the return value. Currently we are wrapping all non-promise return values in a Promise. To fix this we can just remove all async and await keywords and everything will work perfectly fine.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

expect.objectContaining({
span_id: expect.any(String),
trace_id: expect.any(String),
data: expect.any(Object),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Let's assert on the sentry.origin and sentry.source attibutes in the data object.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly assert the data object now, there is no sentry.source property though

Comment on lines +80 to +83
@SentryTraced('wait function')
async wait() {
return new Promise(resolve => setTimeout(resolve, 500));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: We could add a second method that is not async and assert on it in the test.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a second non-async function and then check whether the transaction includes spans for both?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@nicohrubecnicohrubec mentioned this pull request Jul 4, 2024
@nicohrubecnicohrubec linked an issue Jul 4, 2024 that may be closed by this pull request
@nicohrubec
nicohrubec requested a review from lforstJuly 4, 2024 12:46
@nicohrubec
nicohrubec merged commit 41d946e into developJul 4, 2024
@nicohrubec
nicohrubec deleted the nh/nestjs-span-decorator branch July 4, 2024 13:50
@nicohrubecnicohrubec self-assigned this Jul 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SentryTraced() decorator to get spans for arbitrary functions

3 participants

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

feat(nestjs): Add function-level span decorator to nestjs - #12721

Merged
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator
Jul 4, 2024
Merged

feat(nestjs): Add function-level span decorator to nestjs#12721
nicohrubec merged 19 commits into
developfrom
nh/nestjs-span-decorator

Conversation

@nicohrubec

@nicohrubecnicohrubec commented Jul 2, 2024

Copy link
Copy Markdown
Member

Adds a decorator @SentryTraced() to the nestjs sdk that can be used on functions to wrap them in a span.

Manual test from my sample application see screenshot below.

Screenshot 2024-07-02 at 13 58 51

  • e2e test
  • README update with short example demonstrating how to use this feature

@nicohrubec
nicohrubec marked this pull request as ready for review July 3, 2024 13:55
Comment threadpackages/nestjs/README.md Outdated

## Span Decorator

Use the @GetSentrySpan() decorator to gain additional performance insights for any function within your NestJS application.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Is GetX a pattern that is common for nest? To me it reads a bit weird, something like WrapWithSentrySpan or something along these lines would feel more explanatory to me, but no strong feelings!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SentryTraced

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, GetX is not super common in nest was just an initial idea. I like SentryTraced if everyone is happy with that

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to SentryTraced

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few things that should be adressed but otherwise looks great.

Comment on lines +19 to +23
try {
return await originalMethod.apply(this, args);
} catch (e) {
captureException(e);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We do not want to wrap this with a try-catch-captureException. We only want to capture errors when they bubble up to an unexpected place.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment threadpackages/nestjs/src/index.ts Outdated

export { init } from './sdk';

export * from './span-decorator';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: In the index file, let's be specific about what we export. This is to avoid accidentally widening the API surface.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

const originalMethod = descriptor.value as (...args: any[]) => Promise<any>;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
descriptor.value = async function (...args: any[]) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: We should not modify the return value. Currently we are wrapping all non-promise return values in a Promise. To fix this we can just remove all async and await keywords and everything will work perfectly fine.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

expect.objectContaining({
span_id: expect.any(String),
trace_id: expect.any(String),
data: expect.any(Object),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Let's assert on the sentry.origin and sentry.source attibutes in the data object.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly assert the data object now, there is no sentry.source property though

Comment on lines +80 to +83
@SentryTraced('wait function')
async wait() {
return new Promise(resolve => setTimeout(resolve, 500));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: We could add a second method that is not async and assert on it in the test.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a second non-async function and then check whether the transaction includes spans for both?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@nicohrubecnicohrubec mentioned this pull request Jul 4, 2024
@nicohrubecnicohrubec linked an issue Jul 4, 2024 that may be closed by this pull request
@nicohrubec
nicohrubec requested a review from lforstJuly 4, 2024 12:46
@nicohrubec
nicohrubec merged commit 41d946e into developJul 4, 2024
@nicohrubec
nicohrubec deleted the nh/nestjs-span-decorator branch July 4, 2024 13:50
@nicohrubecnicohrubec self-assigned this Jul 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SentryTraced() decorator to get spans for arbitrary functions

3 participants

@nicohrubec@mydea@lforst