Skip to content

perf(angular): do not run change detection when finishing transaction #3622

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
merged 1 commit into from
Jun 4, 2021
Merged

perf(angular): do not run change detection when finishing transaction #3622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 30 additions & 3 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ import { logger, stripUrlQueryAndFragment, timestampWithMs } from '@sentry/utils
import { Observable, Subscription } from 'rxjs';
import { filter, tap } from 'rxjs/operators';

// That's the `global.Zone` exposed when the `zone.js` package is used.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
declare const Zone: any;

// There're 2 types of Angular applications:
// 1) zone-full (by default)
// 2) zone-less
// The developer can avoid importing the `zone.js` package and tells Angular that
// he is responsible for running the change detection by himself. This is done by
// "nooping" the zone through `CompilerOptions` when bootstrapping the root module.
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
const isNgZoneEnabled = typeof Zone !== 'undefined' && !!Zone.current;

let instrumentationInitialized: boolean;
let stashedStartTransaction: (context: TransactionContext) => Transaction | undefined;
let stashedStartTransactionOnLocationChange: boolean;
Expand Down Expand Up @@ -93,13 +106,27 @@ export class TraceService implements OnDestroy {
filter(event => event instanceof NavigationEnd),
tap(() => {
if (this._routingSpan) {
this._routingSpan.finish();
delete this._routingSpan;
if (isNgZoneEnabled) {
// The `Zone.root.run` basically will finish the transaction in the most parent zone.
// The Angular's zone is forked from the `Zone.root`. In this case, `zone.js` won't
// trigger change detection, and `ApplicationRef.tick()` will not be run.
// Caretaker note: we're using `Zone.root` except `NgZone.runOutsideAngular` since this
// will require injecting the `NgZone` facade. That will create a breaking change for
// projects already using the `TraceService`.
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Zone.root.run(() => {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this._routingSpan!.finish();
});
} else {
this._routingSpan.finish();
}
this._routingSpan = null;
}
}),
);

private _routingSpan?: Span;
private _routingSpan: Span | null = null;
private _subscription: Subscription = new Subscription();

public constructor(private readonly _router: Router) {
Expand Down