feat(nuxt): Always add tracing meta tags#13273

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
s1gr1d merged 4 commits into from
Aug 12, 2024
Merged

feat(nuxt): Always add tracing meta tags #13273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f05848c
feat(nuxt): Always add tracing meta tags
s1gr1d Aug 8, 2024
20db23c
Merge branch 'develop' into sig/nuxt-meta-tags
s1gr1d Aug 9, 2024
f096088
Merge branch 'develop' into sig/nuxt-meta-tags
s1gr1d Aug 12, 2024
346a3ad
fix test
s1gr1d Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 4 additions & 13 deletions packages/nuxt/src/runtime/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { getActiveSpan, getRootSpan, spanToTraceHeader } from '@sentry/core';
import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
import { getTraceMetaTags } from '@sentry/core';
import type { Context } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';
import { dynamicSamplingContextToSentryBaggageHeader } from '@sentry/utils';
import type { CapturedErrorContext } from 'nitropack';
import type { NuxtRenderHTMLContext } from 'nuxt/app';

Expand DownExpand Up@@ -37,16 +35,9 @@ export function extractErrorContext(errorContext: CapturedErrorContext): Context
* Exported only for testing
*/
export function addSentryTracingMetaTags(head: NuxtRenderHTMLContext['head']): void {
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
const metaTags = getTraceMetaTags();

if (rootSpan) {
const traceParentData = spanToTraceHeader(rootSpan);
const dynamicSamplingContext = dynamicSamplingContextToSentryBaggageHeader(
getDynamicSamplingContextFromSpan(rootSpan),
);

head.push(`<meta name="sentry-trace" content="${traceParentData}"/>`);
head.push(`<meta name="baggage" content="${dynamicSamplingContext}"/>`);
if (metaTags) {
head.push(metaTags);
}
}
65 changes: 17 additions & 48 deletions packages/nuxt/test/runtime/plugins/server.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,33 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { getTraceMetaTags } from '@sentry/core';
import { type Mock, afterEach, describe, expect, it, vi } from 'vitest';
import { addSentryTracingMetaTags } from '../../../src/runtime/utils';

const mockReturns = vi.hoisted(() => {
return {
traceHeader: 'trace-header',
baggageHeader: 'baggage-header',
};
});

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');

return {
...actual,
getActiveSpan: vi.fn().mockReturnValue({ spanId: '123' }),
getRootSpan: vi.fn().mockReturnValue({ spanId: 'root123' }),
spanToTraceHeader: vi.fn(() => mockReturns.traceHeader),
};
});

vi.mock('@sentry/opentelemetry', async () => {
const actual = await vi.importActual('@sentry/opentelemetry');

return {
...actual,
getDynamicSamplingContextFromSpan: vi.fn().mockReturnValue('contextValue'),
};
});

vi.mock('@sentry/utils', async () => {
const actual = await vi.importActual('@sentry/utils');

return {
...actual,
dynamicSamplingContextToSentryBaggageHeader: vi.fn().mockReturnValue(mockReturns.baggageHeader),
};
});
vi.mock('@sentry/core', () => ({
getTraceMetaTags: vi.fn(),
}));

describe('addSentryTracingMetaTags', () => {
afterEach(() => {
vi.resetAllMocks();
});

it('should add meta tags when there is an active root span', () => {
it('should add meta tags to the head array', () => {
const mockMetaTags = [
'<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
'<meta name="baggage" content="sentry-environment=production"/>',
].join('\n');

// return value is mocked here as return values of `getTraceMetaTags` are tested separately (in @sentry/core)
(getTraceMetaTags as Mock).mockReturnValue(mockMetaTags);

@Lms24Lms24Aug 12, 2024

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.

I think that's fine, given the unit under test here is the Nuxt-specific addSentryTracingMetaTags function.

What we should do in the near future is to make sure our e2e tests cover distributed tracing behaviour. For example, we should check that

  • the sever-side request transaction and the client-side pageload transaction is connected by the same trace. This will validate that the trace meta tag injection generally works.
  • potential requests made on the client side to the server (thinking of API endpoint or data loading calls, whatever nuxt offers) are connected to the server side. This is probably easiest testable when making these calls during or directly after a navigation so that we can make sure a client-side root span exists.

I'm also working on a SvelteKit e2e test app that's specifically configured for tracing without performance. We could think about doing something similar for Nuxt but I wouldn't require it for the moment.


const head: string[] = [];
addSentryTracingMetaTags(head);

expect(head).toContain(`<meta name="sentry-trace" content="${mockReturns.traceHeader}"/>`);
expect(head).toContain(`<meta name="baggage" content="${mockReturns.baggageHeader}"/>`);
expect(head).toContain(mockMetaTags);
});

it('should not add meta tags when there is no active root span', () => {
vi.doMock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');

return {
...actual,
getActiveSpan: vi.fn().mockReturnValue(undefined),
};
});
it('should handle empty meta tags', () => {
(getTraceMetaTags as Mock).mockReturnValue('');

const head: string[] = [];
addSentryTracingMetaTags(head);
Expand Down
, '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
feat(nuxt): Always add tracing meta tags#13273

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 4 commits into

from

Aug 12, 2024
 Merged


feat(nuxt): Always add tracing meta tags
#13273
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f05848c

feat(nuxt): Always add tracing meta tags


s1gr1d Aug 8, 2024
20db23c

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 9, 2024
f096088

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 12, 2024
346a3ad

fix test


s1gr1d Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 4 additions & 13 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { getActiveSpan, getRootSpan, spanToTraceHeader } from '@sentry/core';
import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
import { getTraceMetaTags } from '@sentry/core';
import type { Context } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';
import { dynamicSamplingContextToSentryBaggageHeader } from '@sentry/utils';
import type { CapturedErrorContext } from 'nitropack';
import type { NuxtRenderHTMLContext } from 'nuxt/app';

Expand DownExpand Up@@ -37,16 +35,9 @@ export function extractErrorContext(errorContext: CapturedErrorContext): Context
 * Exported only for testing
 */
export function addSentryTracingMetaTags(head: NuxtRenderHTMLContext['head']): void {
 const activeSpan = getActiveSpan();
 const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
 const metaTags = getTraceMetaTags();

 if (rootSpan) {
 const traceParentData = spanToTraceHeader(rootSpan);
 const dynamicSamplingContext = dynamicSamplingContextToSentryBaggageHeader(
 getDynamicSamplingContextFromSpan(rootSpan),
 );

 head.push(`<meta name="sentry-trace" content="${traceParentData}"/>`);
 head.push(`<meta name="baggage" content="${dynamicSamplingContext}"/>`);
 if (metaTags) {
 head.push(metaTags);
 }
}

65 changes: 17 additions & 48 deletions
packages/nuxt/test/runtime/plugins/server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,64 +1,33 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { getTraceMetaTags } from '@sentry/core';
import { type Mock, afterEach, describe, expect, it, vi } from 'vitest';
import { addSentryTracingMetaTags } from '../../../src/runtime/utils';

const mockReturns = vi.hoisted(() => {
 return {
 traceHeader: 'trace-header',
 baggageHeader: 'baggage-header',
 };
});

vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({ spanId: '123' }),
 getRootSpan: vi.fn().mockReturnValue({ spanId: 'root123' }),
 spanToTraceHeader: vi.fn(() => mockReturns.traceHeader),
 };
});

vi.mock('@sentry/opentelemetry', async () => {
 const actual = await vi.importActual('@sentry/opentelemetry');

 return {
 ...actual,
 getDynamicSamplingContextFromSpan: vi.fn().mockReturnValue('contextValue'),
 };
});

vi.mock('@sentry/utils', async () => {
 const actual = await vi.importActual('@sentry/utils');

 return {
 ...actual,
 dynamicSamplingContextToSentryBaggageHeader: vi.fn().mockReturnValue(mockReturns.baggageHeader),
 };
});
vi.mock('@sentry/core', () => ({
 getTraceMetaTags: vi.fn(),
}));

describe('addSentryTracingMetaTags', () => {
 afterEach(() => {
 vi.resetAllMocks();
 });

 it('should add meta tags when there is an active root span', () => {
 it('should add meta tags to the head array', () => {
 const mockMetaTags = [
 '<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
 '<meta name="baggage" content="sentry-environment=production"/>',
 ].join('\n');

 // return value is mocked here as return values of `getTraceMetaTags` are tested separately (in @sentry/core)
 (getTraceMetaTags as Mock).mockReturnValue(mockMetaTags);
@Lms24Lms24Aug 12, 2024

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.

I think that's fine, given the unit under test here is the Nuxt-specific addSentryTracingMetaTags function.
What we should do in the near future is to make sure our e2e tests cover distributed tracing behaviour. For example, we should check that
  • the sever-side request transaction and the client-side pageload transaction is connected by the same trace. This will validate that the trace meta tag injection generally works.
  • potential requests made on the client side to the server (thinking of API endpoint or data loading calls, whatever nuxt offers) are connected to the server side. This is probably easiest testable when making these calls during or directly after a navigation so that we can make sure a client-side root span exists.
I'm also working on a SvelteKit e2e test app that's specifically configured for tracing without performance. We could think about doing something similar for Nuxt but I wouldn't require it for the moment.

 const head: string[] = [];
 addSentryTracingMetaTags(head);

 expect(head).toContain(`<meta name="sentry-trace" content="${mockReturns.traceHeader}"/>`);
 expect(head).toContain(`<meta name="baggage" content="${mockReturns.baggageHeader}"/>`);
 expect(head).toContain(mockMetaTags);
 });

 it('should not add meta tags when there is no active root span', () => {
 vi.doMock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue(undefined),
 };
 });
 it('should handle empty meta tags', () => {
 (getTraceMetaTags as Mock).mockReturnValue('');

 const head: string[] = [];
 addSentryTracingMetaTags(head);
Expand Down

, '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
feat(nuxt): Always add tracing meta tags#13273

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 4 commits into

from

Aug 12, 2024
 Merged


feat(nuxt): Always add tracing meta tags
#13273
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f05848c

feat(nuxt): Always add tracing meta tags


s1gr1d Aug 8, 2024
20db23c

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 9, 2024
f096088

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 12, 2024
346a3ad

fix test


s1gr1d Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 4 additions & 13 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { getActiveSpan, getRootSpan, spanToTraceHeader } from '@sentry/core';
import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
import { getTraceMetaTags } from '@sentry/core';
import type { Context } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';
import { dynamicSamplingContextToSentryBaggageHeader } from '@sentry/utils';
import type { CapturedErrorContext } from 'nitropack';
import type { NuxtRenderHTMLContext } from 'nuxt/app';

Expand DownExpand Up@@ -37,16 +35,9 @@ export function extractErrorContext(errorContext: CapturedErrorContext): Context
 * Exported only for testing
 */
export function addSentryTracingMetaTags(head: NuxtRenderHTMLContext['head']): void {
 const activeSpan = getActiveSpan();
 const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
 const metaTags = getTraceMetaTags();

 if (rootSpan) {
 const traceParentData = spanToTraceHeader(rootSpan);
 const dynamicSamplingContext = dynamicSamplingContextToSentryBaggageHeader(
 getDynamicSamplingContextFromSpan(rootSpan),
 );

 head.push(`<meta name="sentry-trace" content="${traceParentData}"/>`);
 head.push(`<meta name="baggage" content="${dynamicSamplingContext}"/>`);
 if (metaTags) {
 head.push(metaTags);
 }
}

65 changes: 17 additions & 48 deletions
packages/nuxt/test/runtime/plugins/server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,64 +1,33 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { getTraceMetaTags } from '@sentry/core';
import { type Mock, afterEach, describe, expect, it, vi } from 'vitest';
import { addSentryTracingMetaTags } from '../../../src/runtime/utils';

const mockReturns = vi.hoisted(() => {
 return {
 traceHeader: 'trace-header',
 baggageHeader: 'baggage-header',
 };
});

vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({ spanId: '123' }),
 getRootSpan: vi.fn().mockReturnValue({ spanId: 'root123' }),
 spanToTraceHeader: vi.fn(() => mockReturns.traceHeader),
 };
});

vi.mock('@sentry/opentelemetry', async () => {
 const actual = await vi.importActual('@sentry/opentelemetry');

 return {
 ...actual,
 getDynamicSamplingContextFromSpan: vi.fn().mockReturnValue('contextValue'),
 };
});

vi.mock('@sentry/utils', async () => {
 const actual = await vi.importActual('@sentry/utils');

 return {
 ...actual,
 dynamicSamplingContextToSentryBaggageHeader: vi.fn().mockReturnValue(mockReturns.baggageHeader),
 };
});
vi.mock('@sentry/core', () => ({
 getTraceMetaTags: vi.fn(),
}));

describe('addSentryTracingMetaTags', () => {
 afterEach(() => {
 vi.resetAllMocks();
 });

 it('should add meta tags when there is an active root span', () => {
 it('should add meta tags to the head array', () => {
 const mockMetaTags = [
 '<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
 '<meta name="baggage" content="sentry-environment=production"/>',
 ].join('\n');

 // return value is mocked here as return values of `getTraceMetaTags` are tested separately (in @sentry/core)
 (getTraceMetaTags as Mock).mockReturnValue(mockMetaTags);
@Lms24Lms24Aug 12, 2024

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.

I think that's fine, given the unit under test here is the Nuxt-specific addSentryTracingMetaTags function.
What we should do in the near future is to make sure our e2e tests cover distributed tracing behaviour. For example, we should check that
  • the sever-side request transaction and the client-side pageload transaction is connected by the same trace. This will validate that the trace meta tag injection generally works.
  • potential requests made on the client side to the server (thinking of API endpoint or data loading calls, whatever nuxt offers) are connected to the server side. This is probably easiest testable when making these calls during or directly after a navigation so that we can make sure a client-side root span exists.
I'm also working on a SvelteKit e2e test app that's specifically configured for tracing without performance. We could think about doing something similar for Nuxt but I wouldn't require it for the moment.

 const head: string[] = [];
 addSentryTracingMetaTags(head);

 expect(head).toContain(`<meta name="sentry-trace" content="${mockReturns.traceHeader}"/>`);
 expect(head).toContain(`<meta name="baggage" content="${mockReturns.baggageHeader}"/>`);
 expect(head).toContain(mockMetaTags);
 });

 it('should not add meta tags when there is no active root span', () => {
 vi.doMock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue(undefined),
 };
 });
 it('should handle empty meta tags', () => {
 (getTraceMetaTags as Mock).mockReturnValue('');

 const head: string[] = [];
 addSentryTracingMetaTags(head);
Expand Down

, '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
feat(nuxt): Always add tracing meta tags#13273

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 4 commits into

from

Aug 12, 2024
 Merged


feat(nuxt): Always add tracing meta tags
#13273
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f05848c

feat(nuxt): Always add tracing meta tags


s1gr1d Aug 8, 2024
20db23c

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 9, 2024
f096088

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 12, 2024
346a3ad

fix test


s1gr1d Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 4 additions & 13 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { getActiveSpan, getRootSpan, spanToTraceHeader } from '@sentry/core';
import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
import { getTraceMetaTags } from '@sentry/core';
import type { Context } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';
import { dynamicSamplingContextToSentryBaggageHeader } from '@sentry/utils';
import type { CapturedErrorContext } from 'nitropack';
import type { NuxtRenderHTMLContext } from 'nuxt/app';

Expand DownExpand Up@@ -37,16 +35,9 @@ export function extractErrorContext(errorContext: CapturedErrorContext): Context
 * Exported only for testing
 */
export function addSentryTracingMetaTags(head: NuxtRenderHTMLContext['head']): void {
 const activeSpan = getActiveSpan();
 const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
 const metaTags = getTraceMetaTags();

 if (rootSpan) {
 const traceParentData = spanToTraceHeader(rootSpan);
 const dynamicSamplingContext = dynamicSamplingContextToSentryBaggageHeader(
 getDynamicSamplingContextFromSpan(rootSpan),
 );

 head.push(`<meta name="sentry-trace" content="${traceParentData}"/>`);
 head.push(`<meta name="baggage" content="${dynamicSamplingContext}"/>`);
 if (metaTags) {
 head.push(metaTags);
 }
}

65 changes: 17 additions & 48 deletions
packages/nuxt/test/runtime/plugins/server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,64 +1,33 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { getTraceMetaTags } from '@sentry/core';
import { type Mock, afterEach, describe, expect, it, vi } from 'vitest';
import { addSentryTracingMetaTags } from '../../../src/runtime/utils';

const mockReturns = vi.hoisted(() => {
 return {
 traceHeader: 'trace-header',
 baggageHeader: 'baggage-header',
 };
});

vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({ spanId: '123' }),
 getRootSpan: vi.fn().mockReturnValue({ spanId: 'root123' }),
 spanToTraceHeader: vi.fn(() => mockReturns.traceHeader),
 };
});

vi.mock('@sentry/opentelemetry', async () => {
 const actual = await vi.importActual('@sentry/opentelemetry');

 return {
 ...actual,
 getDynamicSamplingContextFromSpan: vi.fn().mockReturnValue('contextValue'),
 };
});

vi.mock('@sentry/utils', async () => {
 const actual = await vi.importActual('@sentry/utils');

 return {
 ...actual,
 dynamicSamplingContextToSentryBaggageHeader: vi.fn().mockReturnValue(mockReturns.baggageHeader),
 };
});
vi.mock('@sentry/core', () => ({
 getTraceMetaTags: vi.fn(),
}));

describe('addSentryTracingMetaTags', () => {
 afterEach(() => {
 vi.resetAllMocks();
 });

 it('should add meta tags when there is an active root span', () => {
 it('should add meta tags to the head array', () => {
 const mockMetaTags = [
 '<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
 '<meta name="baggage" content="sentry-environment=production"/>',
 ].join('\n');

 // return value is mocked here as return values of `getTraceMetaTags` are tested separately (in @sentry/core)
 (getTraceMetaTags as Mock).mockReturnValue(mockMetaTags);
@Lms24Lms24Aug 12, 2024

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.

I think that's fine, given the unit under test here is the Nuxt-specific addSentryTracingMetaTags function.
What we should do in the near future is to make sure our e2e tests cover distributed tracing behaviour. For example, we should check that
  • the sever-side request transaction and the client-side pageload transaction is connected by the same trace. This will validate that the trace meta tag injection generally works.
  • potential requests made on the client side to the server (thinking of API endpoint or data loading calls, whatever nuxt offers) are connected to the server side. This is probably easiest testable when making these calls during or directly after a navigation so that we can make sure a client-side root span exists.
I'm also working on a SvelteKit e2e test app that's specifically configured for tracing without performance. We could think about doing something similar for Nuxt but I wouldn't require it for the moment.

 const head: string[] = [];
 addSentryTracingMetaTags(head);

 expect(head).toContain(`<meta name="sentry-trace" content="${mockReturns.traceHeader}"/>`);
 expect(head).toContain(`<meta name="baggage" content="${mockReturns.baggageHeader}"/>`);
 expect(head).toContain(mockMetaTags);
 });

 it('should not add meta tags when there is no active root span', () => {
 vi.doMock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue(undefined),
 };
 });
 it('should handle empty meta tags', () => {
 (getTraceMetaTags as Mock).mockReturnValue('');

 const head: string[] = [];
 addSentryTracingMetaTags(head);
Expand Down

, '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
feat(nuxt): Always add tracing meta tags#13273

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 4 commits into

from

Aug 12, 2024
 Merged


feat(nuxt): Always add tracing meta tags
#13273
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f05848c

feat(nuxt): Always add tracing meta tags


s1gr1d Aug 8, 2024
20db23c

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 9, 2024
f096088

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 12, 2024
346a3ad

fix test


s1gr1d Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 4 additions & 13 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { getActiveSpan, getRootSpan, spanToTraceHeader } from '@sentry/core';
import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
import { getTraceMetaTags } from '@sentry/core';
import type { Context } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';
import { dynamicSamplingContextToSentryBaggageHeader } from '@sentry/utils';
import type { CapturedErrorContext } from 'nitropack';
import type { NuxtRenderHTMLContext } from 'nuxt/app';

Expand DownExpand Up@@ -37,16 +35,9 @@ export function extractErrorContext(errorContext: CapturedErrorContext): Context
 * Exported only for testing
 */
export function addSentryTracingMetaTags(head: NuxtRenderHTMLContext['head']): void {
 const activeSpan = getActiveSpan();
 const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
 const metaTags = getTraceMetaTags();

 if (rootSpan) {
 const traceParentData = spanToTraceHeader(rootSpan);
 const dynamicSamplingContext = dynamicSamplingContextToSentryBaggageHeader(
 getDynamicSamplingContextFromSpan(rootSpan),
 );

 head.push(`<meta name="sentry-trace" content="${traceParentData}"/>`);
 head.push(`<meta name="baggage" content="${dynamicSamplingContext}"/>`);
 if (metaTags) {
 head.push(metaTags);
 }
}

65 changes: 17 additions & 48 deletions
packages/nuxt/test/runtime/plugins/server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,64 +1,33 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { getTraceMetaTags } from '@sentry/core';
import { type Mock, afterEach, describe, expect, it, vi } from 'vitest';
import { addSentryTracingMetaTags } from '../../../src/runtime/utils';

const mockReturns = vi.hoisted(() => {
 return {
 traceHeader: 'trace-header',
 baggageHeader: 'baggage-header',
 };
});

vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({ spanId: '123' }),
 getRootSpan: vi.fn().mockReturnValue({ spanId: 'root123' }),
 spanToTraceHeader: vi.fn(() => mockReturns.traceHeader),
 };
});

vi.mock('@sentry/opentelemetry', async () => {
 const actual = await vi.importActual('@sentry/opentelemetry');

 return {
 ...actual,
 getDynamicSamplingContextFromSpan: vi.fn().mockReturnValue('contextValue'),
 };
});

vi.mock('@sentry/utils', async () => {
 const actual = await vi.importActual('@sentry/utils');

 return {
 ...actual,
 dynamicSamplingContextToSentryBaggageHeader: vi.fn().mockReturnValue(mockReturns.baggageHeader),
 };
});
vi.mock('@sentry/core', () => ({
 getTraceMetaTags: vi.fn(),
}));

describe('addSentryTracingMetaTags', () => {
 afterEach(() => {
 vi.resetAllMocks();
 });

 it('should add meta tags when there is an active root span', () => {
 it('should add meta tags to the head array', () => {
 const mockMetaTags = [
 '<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
 '<meta name="baggage" content="sentry-environment=production"/>',
 ].join('\n');

 // return value is mocked here as return values of `getTraceMetaTags` are tested separately (in @sentry/core)
 (getTraceMetaTags as Mock).mockReturnValue(mockMetaTags);
@Lms24Lms24Aug 12, 2024

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.

I think that's fine, given the unit under test here is the Nuxt-specific addSentryTracingMetaTags function.
What we should do in the near future is to make sure our e2e tests cover distributed tracing behaviour. For example, we should check that
  • the sever-side request transaction and the client-side pageload transaction is connected by the same trace. This will validate that the trace meta tag injection generally works.
  • potential requests made on the client side to the server (thinking of API endpoint or data loading calls, whatever nuxt offers) are connected to the server side. This is probably easiest testable when making these calls during or directly after a navigation so that we can make sure a client-side root span exists.
I'm also working on a SvelteKit e2e test app that's specifically configured for tracing without performance. We could think about doing something similar for Nuxt but I wouldn't require it for the moment.

 const head: string[] = [];
 addSentryTracingMetaTags(head);

 expect(head).toContain(`<meta name="sentry-trace" content="${mockReturns.traceHeader}"/>`);
 expect(head).toContain(`<meta name="baggage" content="${mockReturns.baggageHeader}"/>`);
 expect(head).toContain(mockMetaTags);
 });

 it('should not add meta tags when there is no active root span', () => {
 vi.doMock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue(undefined),
 };
 });
 it('should handle empty meta tags', () => {
 (getTraceMetaTags as Mock).mockReturnValue('');

 const head: string[] = [];
 addSentryTracingMetaTags(head);
Expand Down

, '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
feat(nuxt): Always add tracing meta tags#13273

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 4 commits into

from

Aug 12, 2024
 Merged


feat(nuxt): Always add tracing meta tags
#13273
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f05848c

feat(nuxt): Always add tracing meta tags


s1gr1d Aug 8, 2024
20db23c

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 9, 2024
f096088

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 12, 2024
346a3ad

fix test


s1gr1d Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 4 additions & 13 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { getActiveSpan, getRootSpan, spanToTraceHeader } from '@sentry/core';
import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
import { getTraceMetaTags } from '@sentry/core';
import type { Context } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';
import { dynamicSamplingContextToSentryBaggageHeader } from '@sentry/utils';
import type { CapturedErrorContext } from 'nitropack';
import type { NuxtRenderHTMLContext } from 'nuxt/app';

Expand DownExpand Up@@ -37,16 +35,9 @@ export function extractErrorContext(errorContext: CapturedErrorContext): Context
 * Exported only for testing
 */
export function addSentryTracingMetaTags(head: NuxtRenderHTMLContext['head']): void {
 const activeSpan = getActiveSpan();
 const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
 const metaTags = getTraceMetaTags();

 if (rootSpan) {
 const traceParentData = spanToTraceHeader(rootSpan);
 const dynamicSamplingContext = dynamicSamplingContextToSentryBaggageHeader(
 getDynamicSamplingContextFromSpan(rootSpan),
 );

 head.push(`<meta name="sentry-trace" content="${traceParentData}"/>`);
 head.push(`<meta name="baggage" content="${dynamicSamplingContext}"/>`);
 if (metaTags) {
 head.push(metaTags);
 }
}

65 changes: 17 additions & 48 deletions
packages/nuxt/test/runtime/plugins/server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,64 +1,33 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { getTraceMetaTags } from '@sentry/core';
import { type Mock, afterEach, describe, expect, it, vi } from 'vitest';
import { addSentryTracingMetaTags } from '../../../src/runtime/utils';

const mockReturns = vi.hoisted(() => {
 return {
 traceHeader: 'trace-header',
 baggageHeader: 'baggage-header',
 };
});

vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({ spanId: '123' }),
 getRootSpan: vi.fn().mockReturnValue({ spanId: 'root123' }),
 spanToTraceHeader: vi.fn(() => mockReturns.traceHeader),
 };
});

vi.mock('@sentry/opentelemetry', async () => {
 const actual = await vi.importActual('@sentry/opentelemetry');

 return {
 ...actual,
 getDynamicSamplingContextFromSpan: vi.fn().mockReturnValue('contextValue'),
 };
});

vi.mock('@sentry/utils', async () => {
 const actual = await vi.importActual('@sentry/utils');

 return {
 ...actual,
 dynamicSamplingContextToSentryBaggageHeader: vi.fn().mockReturnValue(mockReturns.baggageHeader),
 };
});
vi.mock('@sentry/core', () => ({
 getTraceMetaTags: vi.fn(),
}));

describe('addSentryTracingMetaTags', () => {
 afterEach(() => {
 vi.resetAllMocks();
 });

 it('should add meta tags when there is an active root span', () => {
 it('should add meta tags to the head array', () => {
 const mockMetaTags = [
 '<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
 '<meta name="baggage" content="sentry-environment=production"/>',
 ].join('\n');

 // return value is mocked here as return values of `getTraceMetaTags` are tested separately (in @sentry/core)
 (getTraceMetaTags as Mock).mockReturnValue(mockMetaTags);
@Lms24Lms24Aug 12, 2024

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.

I think that's fine, given the unit under test here is the Nuxt-specific addSentryTracingMetaTags function.
What we should do in the near future is to make sure our e2e tests cover distributed tracing behaviour. For example, we should check that
  • the sever-side request transaction and the client-side pageload transaction is connected by the same trace. This will validate that the trace meta tag injection generally works.
  • potential requests made on the client side to the server (thinking of API endpoint or data loading calls, whatever nuxt offers) are connected to the server side. This is probably easiest testable when making these calls during or directly after a navigation so that we can make sure a client-side root span exists.
I'm also working on a SvelteKit e2e test app that's specifically configured for tracing without performance. We could think about doing something similar for Nuxt but I wouldn't require it for the moment.

 const head: string[] = [];
 addSentryTracingMetaTags(head);

 expect(head).toContain(`<meta name="sentry-trace" content="${mockReturns.traceHeader}"/>`);
 expect(head).toContain(`<meta name="baggage" content="${mockReturns.baggageHeader}"/>`);
 expect(head).toContain(mockMetaTags);
 });

 it('should not add meta tags when there is no active root span', () => {
 vi.doMock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue(undefined),
 };
 });
 it('should handle empty meta tags', () => {
 (getTraceMetaTags as Mock).mockReturnValue('');

 const head: string[] = [];
 addSentryTracingMetaTags(head);
Expand Down

, '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
feat(nuxt): Always add tracing meta tags#13273

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 4 commits into

from

Aug 12, 2024
 Merged


feat(nuxt): Always add tracing meta tags
#13273
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f05848c

feat(nuxt): Always add tracing meta tags


s1gr1d Aug 8, 2024
20db23c

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 9, 2024
f096088

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 12, 2024
346a3ad

fix test


s1gr1d Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 4 additions & 13 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { getActiveSpan, getRootSpan, spanToTraceHeader } from '@sentry/core';
import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
import { getTraceMetaTags } from '@sentry/core';
import type { Context } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';
import { dynamicSamplingContextToSentryBaggageHeader } from '@sentry/utils';
import type { CapturedErrorContext } from 'nitropack';
import type { NuxtRenderHTMLContext } from 'nuxt/app';

Expand DownExpand Up@@ -37,16 +35,9 @@ export function extractErrorContext(errorContext: CapturedErrorContext): Context
 * Exported only for testing
 */
export function addSentryTracingMetaTags(head: NuxtRenderHTMLContext['head']): void {
 const activeSpan = getActiveSpan();
 const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
 const metaTags = getTraceMetaTags();

 if (rootSpan) {
 const traceParentData = spanToTraceHeader(rootSpan);
 const dynamicSamplingContext = dynamicSamplingContextToSentryBaggageHeader(
 getDynamicSamplingContextFromSpan(rootSpan),
 );

 head.push(`<meta name="sentry-trace" content="${traceParentData}"/>`);
 head.push(`<meta name="baggage" content="${dynamicSamplingContext}"/>`);
 if (metaTags) {
 head.push(metaTags);
 }
}

65 changes: 17 additions & 48 deletions
packages/nuxt/test/runtime/plugins/server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,64 +1,33 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { getTraceMetaTags } from '@sentry/core';
import { type Mock, afterEach, describe, expect, it, vi } from 'vitest';
import { addSentryTracingMetaTags } from '../../../src/runtime/utils';

const mockReturns = vi.hoisted(() => {
 return {
 traceHeader: 'trace-header',
 baggageHeader: 'baggage-header',
 };
});

vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({ spanId: '123' }),
 getRootSpan: vi.fn().mockReturnValue({ spanId: 'root123' }),
 spanToTraceHeader: vi.fn(() => mockReturns.traceHeader),
 };
});

vi.mock('@sentry/opentelemetry', async () => {
 const actual = await vi.importActual('@sentry/opentelemetry');

 return {
 ...actual,
 getDynamicSamplingContextFromSpan: vi.fn().mockReturnValue('contextValue'),
 };
});

vi.mock('@sentry/utils', async () => {
 const actual = await vi.importActual('@sentry/utils');

 return {
 ...actual,
 dynamicSamplingContextToSentryBaggageHeader: vi.fn().mockReturnValue(mockReturns.baggageHeader),
 };
});
vi.mock('@sentry/core', () => ({
 getTraceMetaTags: vi.fn(),
}));

describe('addSentryTracingMetaTags', () => {
 afterEach(() => {
 vi.resetAllMocks();
 });

 it('should add meta tags when there is an active root span', () => {
 it('should add meta tags to the head array', () => {
 const mockMetaTags = [
 '<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
 '<meta name="baggage" content="sentry-environment=production"/>',
 ].join('\n');

 // return value is mocked here as return values of `getTraceMetaTags` are tested separately (in @sentry/core)
 (getTraceMetaTags as Mock).mockReturnValue(mockMetaTags);
@Lms24Lms24Aug 12, 2024

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.

I think that's fine, given the unit under test here is the Nuxt-specific addSentryTracingMetaTags function.
What we should do in the near future is to make sure our e2e tests cover distributed tracing behaviour. For example, we should check that
  • the sever-side request transaction and the client-side pageload transaction is connected by the same trace. This will validate that the trace meta tag injection generally works.
  • potential requests made on the client side to the server (thinking of API endpoint or data loading calls, whatever nuxt offers) are connected to the server side. This is probably easiest testable when making these calls during or directly after a navigation so that we can make sure a client-side root span exists.
I'm also working on a SvelteKit e2e test app that's specifically configured for tracing without performance. We could think about doing something similar for Nuxt but I wouldn't require it for the moment.

 const head: string[] = [];
 addSentryTracingMetaTags(head);

 expect(head).toContain(`<meta name="sentry-trace" content="${mockReturns.traceHeader}"/>`);
 expect(head).toContain(`<meta name="baggage" content="${mockReturns.baggageHeader}"/>`);
 expect(head).toContain(mockMetaTags);
 });

 it('should not add meta tags when there is no active root span', () => {
 vi.doMock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue(undefined),
 };
 });
 it('should handle empty meta tags', () => {
 (getTraceMetaTags as Mock).mockReturnValue('');

 const head: string[] = [];
 addSentryTracingMetaTags(head);
Expand Down

, '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
feat(nuxt): Always add tracing meta tags#13273

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 4 commits into

from

Aug 12, 2024
 Merged


feat(nuxt): Always add tracing meta tags
#13273
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f05848c

feat(nuxt): Always add tracing meta tags


s1gr1d Aug 8, 2024
20db23c

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 9, 2024
f096088

Merge branch 'develop' into sig/nuxt-meta-tags


s1gr1d Aug 12, 2024
346a3ad

fix test


s1gr1d Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 4 additions & 13 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { getActiveSpan, getRootSpan, spanToTraceHeader } from '@sentry/core';
import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
import { getTraceMetaTags } from '@sentry/core';
import type { Context } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';
import { dynamicSamplingContextToSentryBaggageHeader } from '@sentry/utils';
import type { CapturedErrorContext } from 'nitropack';
import type { NuxtRenderHTMLContext } from 'nuxt/app';

Expand DownExpand Up@@ -37,16 +35,9 @@ export function extractErrorContext(errorContext: CapturedErrorContext): Context
 * Exported only for testing
 */
export function addSentryTracingMetaTags(head: NuxtRenderHTMLContext['head']): void {
 const activeSpan = getActiveSpan();
 const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
 const metaTags = getTraceMetaTags();

 if (rootSpan) {
 const traceParentData = spanToTraceHeader(rootSpan);
 const dynamicSamplingContext = dynamicSamplingContextToSentryBaggageHeader(
 getDynamicSamplingContextFromSpan(rootSpan),
 );

 head.push(`<meta name="sentry-trace" content="${traceParentData}"/>`);
 head.push(`<meta name="baggage" content="${dynamicSamplingContext}"/>`);
 if (metaTags) {
 head.push(metaTags);
 }
}

65 changes: 17 additions & 48 deletions
packages/nuxt/test/runtime/plugins/server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,64 +1,33 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { getTraceMetaTags } from '@sentry/core';
import { type Mock, afterEach, describe, expect, it, vi } from 'vitest';
import { addSentryTracingMetaTags } from '../../../src/runtime/utils';

const mockReturns = vi.hoisted(() => {
 return {
 traceHeader: 'trace-header',
 baggageHeader: 'baggage-header',
 };
});

vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({ spanId: '123' }),
 getRootSpan: vi.fn().mockReturnValue({ spanId: 'root123' }),
 spanToTraceHeader: vi.fn(() => mockReturns.traceHeader),
 };
});

vi.mock('@sentry/opentelemetry', async () => {
 const actual = await vi.importActual('@sentry/opentelemetry');

 return {
 ...actual,
 getDynamicSamplingContextFromSpan: vi.fn().mockReturnValue('contextValue'),
 };
});

vi.mock('@sentry/utils', async () => {
 const actual = await vi.importActual('@sentry/utils');

 return {
 ...actual,
 dynamicSamplingContextToSentryBaggageHeader: vi.fn().mockReturnValue(mockReturns.baggageHeader),
 };
});
vi.mock('@sentry/core', () => ({
 getTraceMetaTags: vi.fn(),
}));

describe('addSentryTracingMetaTags', () => {
 afterEach(() => {
 vi.resetAllMocks();
 });

 it('should add meta tags when there is an active root span', () => {
 it('should add meta tags to the head array', () => {
 const mockMetaTags = [
 '<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
 '<meta name="baggage" content="sentry-environment=production"/>',
 ].join('\n');

 // return value is mocked here as return values of `getTraceMetaTags` are tested separately (in @sentry/core)
 (getTraceMetaTags as Mock).mockReturnValue(mockMetaTags);
@Lms24Lms24Aug 12, 2024

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.

I think that's fine, given the unit under test here is the Nuxt-specific addSentryTracingMetaTags function.
What we should do in the near future is to make sure our e2e tests cover distributed tracing behaviour. For example, we should check that
  • the sever-side request transaction and the client-side pageload transaction is connected by the same trace. This will validate that the trace meta tag injection generally works.
  • potential requests made on the client side to the server (thinking of API endpoint or data loading calls, whatever nuxt offers) are connected to the server side. This is probably easiest testable when making these calls during or directly after a navigation so that we can make sure a client-side root span exists.
I'm also working on a SvelteKit e2e test app that's specifically configured for tracing without performance. We could think about doing something similar for Nuxt but I wouldn't require it for the moment.

 const head: string[] = [];
 addSentryTracingMetaTags(head);

 expect(head).toContain(`<meta name="sentry-trace" content="${mockReturns.traceHeader}"/>`);
 expect(head).toContain(`<meta name="baggage" content="${mockReturns.baggageHeader}"/>`);
 expect(head).toContain(mockMetaTags);
 });

 it('should not add meta tags when there is no active root span', () => {
 vi.doMock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');

 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue(undefined),
 };
 });
 it('should handle empty meta tags', () => {
 (getTraceMetaTags as Mock).mockReturnValue('');

 const head: string[] = [];
 addSentryTracingMetaTags(head);
Expand Down