fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

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
Lms24 merged 2 commits into from
Dec 23, 2024
Merged

fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
222c761
fix(angular): Fall back to element `tagName` when name is not provide…
arturovt Dec 23, 2024
2a4f6ce
changelog
Lms24 Dec 23, 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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @arturovt. Thank you for your contribution!

## 8.47.0

- feat(v8/core): Add `updateSpanName` helper function (#14736)
Expand Down
5 changes: 4 additions & 1 deletion .../test-applications/angular-17/src/app/component-tracking/component-tracking.components.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ import { SampleComponent } from '../sample-component/sample-component.components
selector: 'app-cancel',
standalone: true,
imports: [TraceModule, SampleComponent],
template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
template: `
<app-sample-component [trace]="'sample-component'"></app-sample-component>
<app-sample-component trace></app-sample-component>
`,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down
43 changes: 28 additions & 15 deletions dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
const navigationTxnPromise = waitForTransaction('angular-17', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
// immediately navigate to a different route
const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

const traceDirectiveSpan = navigationTxn.spans?.find(
const traceDirectiveSpans = navigationTxn.spans?.filter(
span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
);

expect(traceDirectiveSpan).toBeDefined();
expect(traceDirectiveSpan).toEqual(
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
},
description: '<sample-component>',
op: 'ui.angular.init',
origin: 'auto.ui.angular.trace_directive',
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
}),
expect(traceDirectiveSpans).toHaveLength(2);
expect(traceDirectiveSpans).toEqual(
expect.arrayContaining([
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
},
description: '<sample-component>', // custom component name passed to trace directive
op: 'ui.angular.init',
origin: 'auto.ui.angular.trace_directive',
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
}),
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
},
description: '<app-sample-component>', // fallback selector name
op: 'ui.angular.init',
origin: 'auto.ui.angular.trace_directive',
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
}),
]),
);
});
});
Expand Down
2 changes: 2 additions & 0 deletions dev-packages/e2e-tests/test-applications/angular-19/.npmrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873
7 changes: 5 additions & 2 deletions .../test-applications/angular-19/src/app/component-tracking/component-tracking.components.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,13 @@ import { TraceClass, TraceMethod, TraceModule } from '@sentry/angular';
import { SampleComponent } from '../sample-component/sample-component.components';

@Component({
selector: 'app-cancel',
selector: 'app-component-tracking',
standalone: true,
imports: [TraceModule, SampleComponent],
template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
template: `
<app-sample-component trace="sample-component"></app-sample-component>
<app-sample-component trace></app-sample-component>
`,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down
43 changes: 28 additions & 15 deletions dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
const navigationTxnPromise = waitForTransaction('angular-18', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
// immediately navigate to a different route
const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

const traceDirectiveSpan = navigationTxn.spans?.find(
const traceDirectiveSpans = navigationTxn.spans?.filter(
span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
);

expect(traceDirectiveSpan).toBeDefined();
expect(traceDirectiveSpan).toEqual(
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
},
description: '<sample-component>',
op: 'ui.angular.init',
origin: 'auto.ui.angular.trace_directive',
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
}),
expect(traceDirectiveSpans).toHaveLength(2);
expect(traceDirectiveSpans).toEqual(
expect.arrayContaining([
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
},
description: '<sample-component>', // custom component name passed to trace directive
op: 'ui.angular.init',
origin: 'auto.ui.angular.trace_directive',
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
}),
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
},
description: '<app-sample-component>', // fallback selector name
op: 'ui.angular.init',
origin: 'auto.ui.angular.trace_directive',
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
}),
]),
);
});
});
Expand Down
23 changes: 19 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
import { ElementRef } from '@angular/core';
import type { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
import { Directive, Injectable, Input, NgModule } from '@angular/core';
import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router';
Expand DownExpand Up@@ -235,24 +237,37 @@ export class TraceService implements OnDestroy {
}
}

const UNKNOWN_COMPONENT = 'unknown';

/**
* A directive that can be used to capture initialization lifecycle of the whole component.
* Captures the initialization lifecycle of the component this directive is applied to.
* Specifically, this directive measures the time between `ngOnInit` and `ngAfterViewInit`
* of the component.
*
* Falls back to the component's selector if no name is provided.
*
* @example
* ```html
* <app-my-component trace="myComponent"></app-my-component>
* ```
*/
@Directive({ selector: '[trace]' })
export class TraceDirective implements OnInit, AfterViewInit {
@Input('trace') public componentName?: string;

private _tracingSpan?: Span;

public constructor(private readonly _host: ElementRef<HTMLElement>) {}

/**
* Implementation of OnInit lifecycle method
* @inheritdoc
*/
public ngOnInit(): void {
if (!this.componentName) {
this.componentName = UNKNOWN_COMPONENT;
// Technically, the `trace` binding should always be provided.
// However, if it is incorrectly declared on the element without a
// value (e.g., `<app-component trace />`), we fall back to using `tagName`
// (which is e.g. `APP-COMPONENT`).
this.componentName = this._host.nativeElement.tagName.toLowerCase();
}

if (getActiveSpan()) {
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
fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

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

Lms24
merged 2 commits into

from

Dec 23, 2024
 Merged


fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
222c761

fix(angular): Fall back to element `tagName` when name is not provide…


arturovt Dec 23, 2024
2a4f6ce

changelog


Lms24 Dec 23, 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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @arturovt. Thank you for your contribution!

## 8.47.0

- feat(v8/core): Add `updateSpanName` helper function (#14736)
Expand Down

5 changes: 4 additions & 1 deletion
.../test-applications/angular-17/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ import { SampleComponent } from '../sample-component/sample-component.components
 selector: 'app-cancel',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component [trace]="'sample-component'"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-17', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/angular-19/.npmrc

View file


Open in desktop

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

7 changes: 5 additions & 2 deletions
.../test-applications/angular-19/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,13 @@ import { TraceClass, TraceMethod, TraceModule } from '@sentry/angular';
import { SampleComponent } from '../sample-component/sample-component.components';

@Component({
 selector: 'app-cancel',
 selector: 'app-component-tracking',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component trace="sample-component"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-18', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

23 changes: 19 additions & 4 deletions
packages/angular/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
import { ElementRef } from '@angular/core';
import type { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
import { Directive, Injectable, Input, NgModule } from '@angular/core';
import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router';
Expand DownExpand Up@@ -235,24 +237,37 @@ export class TraceService implements OnDestroy {
 }
}

const UNKNOWN_COMPONENT = 'unknown';

/**
 * A directive that can be used to capture initialization lifecycle of the whole component.
 * Captures the initialization lifecycle of the component this directive is applied to.
 * Specifically, this directive measures the time between `ngOnInit` and `ngAfterViewInit`
 * of the component.
 *
 * Falls back to the component's selector if no name is provided.
 *
 * @example
 * ```html
 * <app-my-component trace="myComponent"></app-my-component>
 * ```
 */
@Directive({ selector: '[trace]' })
export class TraceDirective implements OnInit, AfterViewInit {
 @Input('trace') public componentName?: string;

 private _tracingSpan?: Span;

 public constructor(private readonly _host: ElementRef<HTMLElement>) {}

 /**
 * Implementation of OnInit lifecycle method
 * @inheritdoc
 */
 public ngOnInit(): void {
 if (!this.componentName) {
 this.componentName = UNKNOWN_COMPONENT;
 // Technically, the `trace` binding should always be provided.
 // However, if it is incorrectly declared on the element without a
 // value (e.g., `<app-component trace />`), we fall back to using `tagName`
 // (which is e.g. `APP-COMPONENT`).
 this.componentName = this._host.nativeElement.tagName.toLowerCase();
 }

 if (getActiveSpan()) {
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
fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

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

Lms24
merged 2 commits into

from

Dec 23, 2024
 Merged


fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
222c761

fix(angular): Fall back to element `tagName` when name is not provide…


arturovt Dec 23, 2024
2a4f6ce

changelog


Lms24 Dec 23, 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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @arturovt. Thank you for your contribution!

## 8.47.0

- feat(v8/core): Add `updateSpanName` helper function (#14736)
Expand Down

5 changes: 4 additions & 1 deletion
.../test-applications/angular-17/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ import { SampleComponent } from '../sample-component/sample-component.components
 selector: 'app-cancel',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component [trace]="'sample-component'"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-17', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/angular-19/.npmrc

View file


Open in desktop

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

7 changes: 5 additions & 2 deletions
.../test-applications/angular-19/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,13 @@ import { TraceClass, TraceMethod, TraceModule } from '@sentry/angular';
import { SampleComponent } from '../sample-component/sample-component.components';

@Component({
 selector: 'app-cancel',
 selector: 'app-component-tracking',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component trace="sample-component"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-18', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

23 changes: 19 additions & 4 deletions
packages/angular/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
import { ElementRef } from '@angular/core';
import type { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
import { Directive, Injectable, Input, NgModule } from '@angular/core';
import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router';
Expand DownExpand Up@@ -235,24 +237,37 @@ export class TraceService implements OnDestroy {
 }
}

const UNKNOWN_COMPONENT = 'unknown';

/**
 * A directive that can be used to capture initialization lifecycle of the whole component.
 * Captures the initialization lifecycle of the component this directive is applied to.
 * Specifically, this directive measures the time between `ngOnInit` and `ngAfterViewInit`
 * of the component.
 *
 * Falls back to the component's selector if no name is provided.
 *
 * @example
 * ```html
 * <app-my-component trace="myComponent"></app-my-component>
 * ```
 */
@Directive({ selector: '[trace]' })
export class TraceDirective implements OnInit, AfterViewInit {
 @Input('trace') public componentName?: string;

 private _tracingSpan?: Span;

 public constructor(private readonly _host: ElementRef<HTMLElement>) {}

 /**
 * Implementation of OnInit lifecycle method
 * @inheritdoc
 */
 public ngOnInit(): void {
 if (!this.componentName) {
 this.componentName = UNKNOWN_COMPONENT;
 // Technically, the `trace` binding should always be provided.
 // However, if it is incorrectly declared on the element without a
 // value (e.g., `<app-component trace />`), we fall back to using `tagName`
 // (which is e.g. `APP-COMPONENT`).
 this.componentName = this._host.nativeElement.tagName.toLowerCase();
 }

 if (getActiveSpan()) {
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
fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

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

Lms24
merged 2 commits into

from

Dec 23, 2024
 Merged


fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
222c761

fix(angular): Fall back to element `tagName` when name is not provide…


arturovt Dec 23, 2024
2a4f6ce

changelog


Lms24 Dec 23, 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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @arturovt. Thank you for your contribution!

## 8.47.0

- feat(v8/core): Add `updateSpanName` helper function (#14736)
Expand Down

5 changes: 4 additions & 1 deletion
.../test-applications/angular-17/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ import { SampleComponent } from '../sample-component/sample-component.components
 selector: 'app-cancel',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component [trace]="'sample-component'"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-17', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/angular-19/.npmrc

View file


Open in desktop

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

7 changes: 5 additions & 2 deletions
.../test-applications/angular-19/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,13 @@ import { TraceClass, TraceMethod, TraceModule } from '@sentry/angular';
import { SampleComponent } from '../sample-component/sample-component.components';

@Component({
 selector: 'app-cancel',
 selector: 'app-component-tracking',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component trace="sample-component"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-18', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

23 changes: 19 additions & 4 deletions
packages/angular/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
import { ElementRef } from '@angular/core';
import type { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
import { Directive, Injectable, Input, NgModule } from '@angular/core';
import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router';
Expand DownExpand Up@@ -235,24 +237,37 @@ export class TraceService implements OnDestroy {
 }
}

const UNKNOWN_COMPONENT = 'unknown';

/**
 * A directive that can be used to capture initialization lifecycle of the whole component.
 * Captures the initialization lifecycle of the component this directive is applied to.
 * Specifically, this directive measures the time between `ngOnInit` and `ngAfterViewInit`
 * of the component.
 *
 * Falls back to the component's selector if no name is provided.
 *
 * @example
 * ```html
 * <app-my-component trace="myComponent"></app-my-component>
 * ```
 */
@Directive({ selector: '[trace]' })
export class TraceDirective implements OnInit, AfterViewInit {
 @Input('trace') public componentName?: string;

 private _tracingSpan?: Span;

 public constructor(private readonly _host: ElementRef<HTMLElement>) {}

 /**
 * Implementation of OnInit lifecycle method
 * @inheritdoc
 */
 public ngOnInit(): void {
 if (!this.componentName) {
 this.componentName = UNKNOWN_COMPONENT;
 // Technically, the `trace` binding should always be provided.
 // However, if it is incorrectly declared on the element without a
 // value (e.g., `<app-component trace />`), we fall back to using `tagName`
 // (which is e.g. `APP-COMPONENT`).
 this.componentName = this._host.nativeElement.tagName.toLowerCase();
 }

 if (getActiveSpan()) {
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
fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

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

Lms24
merged 2 commits into

from

Dec 23, 2024
 Merged


fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
222c761

fix(angular): Fall back to element `tagName` when name is not provide…


arturovt Dec 23, 2024
2a4f6ce

changelog


Lms24 Dec 23, 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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @arturovt. Thank you for your contribution!

## 8.47.0

- feat(v8/core): Add `updateSpanName` helper function (#14736)
Expand Down

5 changes: 4 additions & 1 deletion
.../test-applications/angular-17/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ import { SampleComponent } from '../sample-component/sample-component.components
 selector: 'app-cancel',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component [trace]="'sample-component'"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-17', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/angular-19/.npmrc

View file


Open in desktop

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

7 changes: 5 additions & 2 deletions
.../test-applications/angular-19/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,13 @@ import { TraceClass, TraceMethod, TraceModule } from '@sentry/angular';
import { SampleComponent } from '../sample-component/sample-component.components';

@Component({
 selector: 'app-cancel',
 selector: 'app-component-tracking',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component trace="sample-component"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-18', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

23 changes: 19 additions & 4 deletions
packages/angular/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
import { ElementRef } from '@angular/core';
import type { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
import { Directive, Injectable, Input, NgModule } from '@angular/core';
import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router';
Expand DownExpand Up@@ -235,24 +237,37 @@ export class TraceService implements OnDestroy {
 }
}

const UNKNOWN_COMPONENT = 'unknown';

/**
 * A directive that can be used to capture initialization lifecycle of the whole component.
 * Captures the initialization lifecycle of the component this directive is applied to.
 * Specifically, this directive measures the time between `ngOnInit` and `ngAfterViewInit`
 * of the component.
 *
 * Falls back to the component's selector if no name is provided.
 *
 * @example
 * ```html
 * <app-my-component trace="myComponent"></app-my-component>
 * ```
 */
@Directive({ selector: '[trace]' })
export class TraceDirective implements OnInit, AfterViewInit {
 @Input('trace') public componentName?: string;

 private _tracingSpan?: Span;

 public constructor(private readonly _host: ElementRef<HTMLElement>) {}

 /**
 * Implementation of OnInit lifecycle method
 * @inheritdoc
 */
 public ngOnInit(): void {
 if (!this.componentName) {
 this.componentName = UNKNOWN_COMPONENT;
 // Technically, the `trace` binding should always be provided.
 // However, if it is incorrectly declared on the element without a
 // value (e.g., `<app-component trace />`), we fall back to using `tagName`
 // (which is e.g. `APP-COMPONENT`).
 this.componentName = this._host.nativeElement.tagName.toLowerCase();
 }

 if (getActiveSpan()) {
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
fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

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

Lms24
merged 2 commits into

from

Dec 23, 2024
 Merged


fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
222c761

fix(angular): Fall back to element `tagName` when name is not provide…


arturovt Dec 23, 2024
2a4f6ce

changelog


Lms24 Dec 23, 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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @arturovt. Thank you for your contribution!

## 8.47.0

- feat(v8/core): Add `updateSpanName` helper function (#14736)
Expand Down

5 changes: 4 additions & 1 deletion
.../test-applications/angular-17/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ import { SampleComponent } from '../sample-component/sample-component.components
 selector: 'app-cancel',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component [trace]="'sample-component'"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-17', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/angular-19/.npmrc

View file


Open in desktop

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

7 changes: 5 additions & 2 deletions
.../test-applications/angular-19/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,13 @@ import { TraceClass, TraceMethod, TraceModule } from '@sentry/angular';
import { SampleComponent } from '../sample-component/sample-component.components';

@Component({
 selector: 'app-cancel',
 selector: 'app-component-tracking',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component trace="sample-component"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-18', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

23 changes: 19 additions & 4 deletions
packages/angular/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
import { ElementRef } from '@angular/core';
import type { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
import { Directive, Injectable, Input, NgModule } from '@angular/core';
import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router';
Expand DownExpand Up@@ -235,24 +237,37 @@ export class TraceService implements OnDestroy {
 }
}

const UNKNOWN_COMPONENT = 'unknown';

/**
 * A directive that can be used to capture initialization lifecycle of the whole component.
 * Captures the initialization lifecycle of the component this directive is applied to.
 * Specifically, this directive measures the time between `ngOnInit` and `ngAfterViewInit`
 * of the component.
 *
 * Falls back to the component's selector if no name is provided.
 *
 * @example
 * ```html
 * <app-my-component trace="myComponent"></app-my-component>
 * ```
 */
@Directive({ selector: '[trace]' })
export class TraceDirective implements OnInit, AfterViewInit {
 @Input('trace') public componentName?: string;

 private _tracingSpan?: Span;

 public constructor(private readonly _host: ElementRef<HTMLElement>) {}

 /**
 * Implementation of OnInit lifecycle method
 * @inheritdoc
 */
 public ngOnInit(): void {
 if (!this.componentName) {
 this.componentName = UNKNOWN_COMPONENT;
 // Technically, the `trace` binding should always be provided.
 // However, if it is incorrectly declared on the element without a
 // value (e.g., `<app-component trace />`), we fall back to using `tagName`
 // (which is e.g. `APP-COMPONENT`).
 this.componentName = this._host.nativeElement.tagName.toLowerCase();
 }

 if (getActiveSpan()) {
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
fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

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

Lms24
merged 2 commits into

from

Dec 23, 2024
 Merged


fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
222c761

fix(angular): Fall back to element `tagName` when name is not provide…


arturovt Dec 23, 2024
2a4f6ce

changelog


Lms24 Dec 23, 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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @arturovt. Thank you for your contribution!

## 8.47.0

- feat(v8/core): Add `updateSpanName` helper function (#14736)
Expand Down

5 changes: 4 additions & 1 deletion
.../test-applications/angular-17/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ import { SampleComponent } from '../sample-component/sample-component.components
 selector: 'app-cancel',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component [trace]="'sample-component'"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-17', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/angular-19/.npmrc

View file


Open in desktop

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

7 changes: 5 additions & 2 deletions
.../test-applications/angular-19/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,13 @@ import { TraceClass, TraceMethod, TraceModule } from '@sentry/angular';
import { SampleComponent } from '../sample-component/sample-component.components';

@Component({
 selector: 'app-cancel',
 selector: 'app-component-tracking',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component trace="sample-component"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-18', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

23 changes: 19 additions & 4 deletions
packages/angular/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
import { ElementRef } from '@angular/core';
import type { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
import { Directive, Injectable, Input, NgModule } from '@angular/core';
import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router';
Expand DownExpand Up@@ -235,24 +237,37 @@ export class TraceService implements OnDestroy {
 }
}

const UNKNOWN_COMPONENT = 'unknown';

/**
 * A directive that can be used to capture initialization lifecycle of the whole component.
 * Captures the initialization lifecycle of the component this directive is applied to.
 * Specifically, this directive measures the time between `ngOnInit` and `ngAfterViewInit`
 * of the component.
 *
 * Falls back to the component's selector if no name is provided.
 *
 * @example
 * ```html
 * <app-my-component trace="myComponent"></app-my-component>
 * ```
 */
@Directive({ selector: '[trace]' })
export class TraceDirective implements OnInit, AfterViewInit {
 @Input('trace') public componentName?: string;

 private _tracingSpan?: Span;

 public constructor(private readonly _host: ElementRef<HTMLElement>) {}

 /**
 * Implementation of OnInit lifecycle method
 * @inheritdoc
 */
 public ngOnInit(): void {
 if (!this.componentName) {
 this.componentName = UNKNOWN_COMPONENT;
 // Technically, the `trace` binding should always be provided.
 // However, if it is incorrectly declared on the element without a
 // value (e.g., `<app-component trace />`), we fall back to using `tagName`
 // (which is e.g. `APP-COMPONENT`).
 this.componentName = this._host.nativeElement.tagName.toLowerCase();
 }

 if (getActiveSpan()) {
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
fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828

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

Lms24
merged 2 commits into

from

Dec 23, 2024
 Merged


fix(v8/angular): Fall back to element tagName when name is not provided to TraceDirective#14828
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
222c761

fix(angular): Fall back to element `tagName` when name is not provide…


arturovt Dec 23, 2024
2a4f6ce

changelog


Lms24 Dec 23, 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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @arturovt. Thank you for your contribution!

## 8.47.0

- feat(v8/core): Add `updateSpanName` helper function (#14736)
Expand Down

5 changes: 4 additions & 1 deletion
.../test-applications/angular-17/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,10 @@ import { SampleComponent } from '../sample-component/sample-component.components
 selector: 'app-cancel',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component [trace]="'sample-component'"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-17', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/angular-19/.npmrc

View file


Open in desktop

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

7 changes: 5 additions & 2 deletions
.../test-applications/angular-19/src/app/component-tracking/component-tracking.components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,13 @@ import { TraceClass, TraceMethod, TraceModule } from '@sentry/angular';
import { SampleComponent } from '../sample-component/sample-component.components';

@Component({
 selector: 'app-cancel',
 selector: 'app-component-tracking',
 standalone: true,
 imports: [TraceModule, SampleComponent],
 template: `<app-sample-component [trace]="'sample-component'"></app-sample-component>`,
 template: `
 <app-sample-component trace="sample-component"></app-sample-component>
 <app-sample-component trace></app-sample-component>
 `,
})
@TraceClass({ name: 'ComponentTrackingComponent' })
export class ComponentTrackingComponent implements OnInit, AfterViewInit {
Expand Down

43 changes: 28 additions & 15 deletions
dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -191,7 +191,7 @@ test.describe('finish routing span', () => {
});

test.describe('TraceDirective', () => {
 test('creates a child tracingSpan with component name as span name on ngOnInit', async ({ page }) => {
 test('creates a child span with the component name as span name on ngOnInit', async ({ page }) => {
 const navigationTxnPromise = waitForTransaction('angular-18', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });
Expand All@@ -201,23 +201,36 @@ test.describe('TraceDirective', () => {
 // immediately navigate to a different route
 const [_, navigationTxn] = await Promise.all([page.locator('#componentTracking').click(), navigationTxnPromise]);

 const traceDirectiveSpan = navigationTxn.spans?.find(
 const traceDirectiveSpans = navigationTxn.spans?.filter(
 span => span?.data && span?.data[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] === 'auto.ui.angular.trace_directive',
 );

 expect(traceDirectiveSpan).toBeDefined();
 expect(traceDirectiveSpan).toEqual(
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>',
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect(traceDirectiveSpans).toHaveLength(2);
 expect(traceDirectiveSpans).toEqual(
 expect.arrayContaining([
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<sample-component>', // custom component name passed to trace directive
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 expect.objectContaining({
 data: {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.angular.init',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
 },
 description: '<app-sample-component>', // fallback selector name
 op: 'ui.angular.init',
 origin: 'auto.ui.angular.trace_directive',
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 }),
 ]),
 );
 });
});
Expand Down

23 changes: 19 additions & 4 deletions
packages/angular/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
import { ElementRef } from '@angular/core';
import type { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
import { Directive, Injectable, Input, NgModule } from '@angular/core';
import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router';
Expand DownExpand Up@@ -235,24 +237,37 @@ export class TraceService implements OnDestroy {
 }
}

const UNKNOWN_COMPONENT = 'unknown';

/**
 * A directive that can be used to capture initialization lifecycle of the whole component.
 * Captures the initialization lifecycle of the component this directive is applied to.
 * Specifically, this directive measures the time between `ngOnInit` and `ngAfterViewInit`
 * of the component.
 *
 * Falls back to the component's selector if no name is provided.
 *
 * @example
 * ```html
 * <app-my-component trace="myComponent"></app-my-component>
 * ```
 */
@Directive({ selector: '[trace]' })
export class TraceDirective implements OnInit, AfterViewInit {
 @Input('trace') public componentName?: string;

 private _tracingSpan?: Span;

 public constructor(private readonly _host: ElementRef<HTMLElement>) {}

 /**
 * Implementation of OnInit lifecycle method
 * @inheritdoc
 */
 public ngOnInit(): void {
 if (!this.componentName) {
 this.componentName = UNKNOWN_COMPONENT;
 // Technically, the `trace` binding should always be provided.
 // However, if it is incorrectly declared on the element without a
 // value (e.g., `<app-component trace />`), we fall back to using `tagName`
 // (which is e.g. `APP-COMPONENT`).
 this.componentName = this._host.nativeElement.tagName.toLowerCase();
 }

 if (getActiveSpan()) {
Expand Down