Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(ember): Set url.template, url.path and url.full on router spans#22095
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.
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
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -5,11 +5,22 @@ import type { | ||
| startBrowserTracingNavigationSpan as startBrowserTracingNavigationSpanType, | ||
| startBrowserTracingPageLoadSpan as startBrowserTracingPageLoadSpanType, | ||
| } from '@sentry/browser'; | ||
| import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, startInactiveSpan } from '@sentry/browser'; | ||
| import { | ||
| getAbsoluteUrl, | ||
| SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, | ||
| SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, | ||
| startInactiveSpan, | ||
| } from '@sentry/browser'; | ||
| import type { Client, Span } from '@sentry/core'; | ||
| import type { EmberRouterMain } from '../types'; | ||
| import { getBackburner } from './performance'; | ||
| const URL_FULL = 'url.full'; | ||
| const URL_PATH = 'url.path'; | ||
| const URL_TEMPLATE = 'url.template'; | ||
| type TransitionWithIntent = Transition & { intent?: { url?: string } }; | ||
| export function instrumentEmberAppInstanceForPerformance( | ||
| client: Client, | ||
| appInstance: ApplicationInstance, | ||
| @@ -22,6 +33,7 @@ export function instrumentEmberAppInstanceForPerformance( | ||
| let routerService = appInstance.lookup('service:router') as RouterService & { | ||
| externalRouter?: RouterService; | ||
| _hasMountedSentryPerformanceRouting?: boolean; | ||
| currentURL?: string; | ||
| }; | ||
| if (routerService.externalRouter) { | ||
| @@ -60,6 +72,52 @@ function getTransitionInformation( | ||
| }; | ||
| } | ||
| function getUrlPathFromEmberLocation(url: string): string { | ||
| if (!url) { | ||
| return '/'; | ||
| } | ||
| const withoutQuery = url.split('?')[0] ?? url; | ||
| if (withoutQuery.includes('#')) { | ||
| const hashPart = withoutQuery.substring(withoutQuery.indexOf('#') + 1); | ||
| return hashPart.startsWith('/') ? hashPart : `/${hashPart}`; | ||
| } | ||
| return withoutQuery.startsWith('/') ? withoutQuery : `/${withoutQuery}`; | ||
| } | ||
| function buildUrlTemplate(path: string, params: Record<string, unknown> = {}): string { | ||
| let template = path; | ||
| const paramEntries = Object.entries(params) | ||
| .filter((entry): entry is [string, string] => typeof entry[1] === 'string' && entry[1].length > 0) | ||
| .sort(([, a], [, b]) => b.length - a.length); | ||
| for (const [key, value] of paramEntries) { | ||
| template = template.replace(`/${value}`, `/:${key}`); | ||
cursor[bot] marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. sentry[bot] marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| } | ||
| return template; | ||
| } | ||
| // Only exported for testing | ||
| export function _getRouteUrlAttributes( | ||
| url: string, | ||
| params: Record<string, unknown> = {}, | ||
| fullUrl: string = url, | ||
| ): Record<string, string> { | ||
| const path = getUrlPathFromEmberLocation(url); | ||
| // `url.full` is derived from the unstripped URL so that hash-location apps keep their `#/...` | ||
| // fragment (e.g. `https://host/#/tracing`), which would otherwise be lost by `getUrlPathFromEmberLocation`. | ||
| return { | ||
| [URL_PATH]: path, | ||
| [URL_FULL]: getAbsoluteUrl(fullUrl), | ||
| [URL_TEMPLATE]: buildUrlTemplate(path, params), | ||
cursor[bot] marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| }; | ||
| } | ||
| // Only exported for testing | ||
| export function _getLocationURL(location: EmberRouterMain['location']): string { | ||
| if (!location?.getURL || !location?.formatURL) { | ||
| @@ -76,7 +134,7 @@ export function _getLocationURL(location: EmberRouterMain['location']): string { | ||
| function _instrumentEmberRouter( | ||
| client: Client, | ||
| routerService: RouterService, | ||
| routerService: RouterService & { currentURL?: string }, | ||
| routerMain: EmberRouterMain, | ||
| config: { disableRunloopPerformance?: boolean; instrumentPageLoad?: boolean; instrumentNavigation?: boolean }, | ||
| startBrowserTracingPageLoadSpan: typeof startBrowserTracingPageLoadSpanType, | ||
| @@ -96,6 +154,7 @@ function _instrumentEmberRouter( | ||
| attributes: { | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route', | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.ember', | ||
| ..._getRouteUrlAttributes(url, routeInfo.params), | ||
sentry[bot] marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| url, | ||
| toRoute: routeInfo.name, | ||
| }, | ||
| @@ -124,11 +183,19 @@ function _instrumentEmberRouter( | ||
| activeRootSpan?.end(); | ||
| // Only `intent.url` reliably reflects the *destination* URL at `routeWillChange` time. The | ||
| // router's location still points at the current (pre-transition) route here, so falling back to | ||
| // it would tag the navigation span with the previous route's `url.*` attributes. When we don't | ||
| // have a trustworthy target URL, we omit them and let `routeDidChange` set them from `currentURL`. | ||
| const targetUrl = (transition as TransitionWithIntent).intent?.url; | ||
| const urlAttributes = targetUrl ? _getRouteUrlAttributes(targetUrl, transition.to?.params) : {}; | ||
| activeRootSpan = startBrowserTracingNavigationSpan(client, { | ||
| name: `route:${toRoute}`, | ||
| attributes: { | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route', | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.ember', | ||
| ...urlAttributes, | ||
cursor[bot] marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| fromRoute, | ||
| toRoute, | ||
| }, | ||
| @@ -150,6 +217,15 @@ function _instrumentEmberRouter( | ||
| } | ||
| transitionSpan.end(); | ||
| const url = routerService.currentURL ?? _getLocationURL(location); | ||
| if (url) { | ||
| const routeInfo = routerService.recognize(url); | ||
| // `currentURL` is the normalized route path and never includes the hash fragment, so we source | ||
| // `url.full` from the location URL (which preserves `#/...` for hash-location apps) when available. | ||
| const fullUrl = _getLocationURL(location) || url; | ||
| activeRootSpan.setAttributes(_getRouteUrlAttributes(url, routeInfo.params ?? transition.to?.params, fullUrl)); | ||
| } | ||
| if (disableRunloopPerformance) { | ||
| activeRootSpan.end(); | ||
| return; | ||
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.