|
| 1 | +import { |
| 2 | + browserTracingIntegration, |
| 3 | + getActiveSpan, |
| 4 | + getRootSpan, |
| 5 | + spanToJSON, |
| 6 | + startBrowserTracingNavigationSpan, |
| 7 | +} from '@sentry/browser'; |
| 8 | +import { |
| 9 | + SEMANTIC_ATTRIBUTE_SENTRY_OP, |
| 10 | + SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, |
| 11 | + SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, |
| 12 | + getClient, |
| 13 | +} from '@sentry/core'; |
| 14 | +import type { Client, Integration, Span } from '@sentry/types'; |
| 15 | +import { logger } from '@sentry/utils'; |
| 16 | +import { createEffect, mergeProps, splitProps } from 'solid-js'; |
| 17 | +import type { Component, JSX, ParentProps } from 'solid-js'; |
| 18 | +import { createComponent } from 'solid-js/web'; |
| 19 | +import { DEBUG_BUILD } from './debug-build'; |
| 20 | + |
| 21 | +// Vendored solid router types so that we don't need to depend on solid router. |
| 22 | +// These are not exhaustive and loose on purpose. |
| 23 | +interface Location { |
| 24 | + pathname: string; |
| 25 | +} |
| 26 | + |
| 27 | +interface BeforeLeaveEventArgs { |
| 28 | + from: Location; |
| 29 | + to: string | number; |
| 30 | +} |
| 31 | + |
| 32 | +interface RouteSectionProps<T = unknown> { |
| 33 | + location: Location; |
| 34 | + data?: T; |
| 35 | + children?: JSX.Element; |
| 36 | +} |
| 37 | + |
| 38 | +// eslint-disable-next-line @typescript-eslint/no-explicit-any |
| 39 | +type RouteDefinition<S extends string | string[] = any, T = unknown> = { |
| 40 | + path?: S; |
| 41 | + children?: RouteDefinition | RouteDefinition[]; |
| 42 | + component?: Component<RouteSectionProps<T>>; |
| 43 | +}; |
| 44 | + |
| 45 | +interface RouterProps { |
| 46 | + base?: string; |
| 47 | + root?: Component<RouteSectionProps>; |
| 48 | + children?: JSX.Element | RouteDefinition | RouteDefinition[]; |
| 49 | +} |
| 50 | + |
| 51 | +interface SolidRouterOptions { |
| 52 | + useBeforeLeave: UserBeforeLeave; |
| 53 | + useLocation: UseLocation; |
| 54 | +} |
| 55 | + |
| 56 | +type UserBeforeLeave = (listener: (e: BeforeLeaveEventArgs) => void) => void; |
| 57 | +type UseLocation = () => Location; |
| 58 | + |
| 59 | +const CLIENTS_WITH_INSTRUMENT_NAVIGATION = new WeakSet<Client>(); |
| 60 | + |
| 61 | +let _useBeforeLeave: UserBeforeLeave; |
| 62 | +let _useLocation: UseLocation; |
| 63 | + |
| 64 | +function handleNavigation(location: string): void { |
| 65 | + const client = getClient(); |
| 66 | + if (!client || !CLIENTS_WITH_INSTRUMENT_NAVIGATION.has(client)) { |
| 67 | + return; |
| 68 | + } |
| 69 | + |
| 70 | + startBrowserTracingNavigationSpan(client, { |
| 71 | + name: location, |
| 72 | + attributes: { |
| 73 | + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', |
| 74 | + [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.solidjs.solidrouter', |
| 75 | + [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url', |
| 76 | + }, |
| 77 | + }); |
| 78 | +} |
| 79 | + |
| 80 | +function getActiveRootSpan(): Span | undefined { |
| 81 | + const span = getActiveSpan(); |
| 82 | + return span ? getRootSpan(span) : undefined; |
| 83 | +} |
| 84 | + |
| 85 | +/** Pass-through component in case user didn't specify a root **/ |
| 86 | +function SentryDefaultRoot(props: ParentProps): JSX.Element { |
| 87 | + return props.children; |
| 88 | +} |
| 89 | + |
| 90 | +/** |
| 91 | + * Unfortunately, we cannot use router hooks directly in the Router, so we |
| 92 | + * need to wrap the `root` prop to instrument navigation. |
| 93 | + */ |
| 94 | +function withSentryRouterRoot(Root: Component<RouteSectionProps>): Component<RouteSectionProps> { |
| 95 | + const SentryRouterRoot = (props: RouteSectionProps): JSX.Element => { |
| 96 | + // TODO: This is a rudimentary first version of handling navigation spans |
| 97 | + // It does not |
| 98 | + // - use query params |
| 99 | + // - parameterize the route |
| 100 | + |
| 101 | + _useBeforeLeave(({ to }: BeforeLeaveEventArgs) => { |
| 102 | + // `to` could be `-1` if the browser back-button was used |
| 103 | + handleNavigation(to.toString()); |
| 104 | + }); |
| 105 | + |
| 106 | + const location = _useLocation(); |
| 107 | + createEffect(() => { |
| 108 | + const name = location.pathname; |
| 109 | + const rootSpan = getActiveRootSpan(); |
| 110 | + |
| 111 | + if (rootSpan) { |
| 112 | + const { op, description } = spanToJSON(rootSpan); |
| 113 | + |
| 114 | + // We only need to update navigation spans that have been created by |
| 115 | + // a browser back-button navigation (stored as `-1` by solid router) |
| 116 | + // everything else was already instrumented correctly in `useBeforeLeave` |
| 117 | + if (op === 'navigation' && description === '-1') { |
| 118 | + rootSpan.updateName(name); |
| 119 | + } |
| 120 | + } |
| 121 | + }); |
| 122 | + |
| 123 | + return createComponent(Root, props); |
| 124 | + }; |
| 125 | + |
| 126 | + return SentryRouterRoot; |
| 127 | +} |
| 128 | + |
| 129 | +/** |
| 130 | + * A browser tracing integration that uses Solid Router to instrument navigations. |
| 131 | + */ |
| 132 | +export function solidRouterBrowserTracingIntegration( |
| 133 | + options: Parameters<typeof browserTracingIntegration>[0] & SolidRouterOptions, |
| 134 | +): Integration { |
| 135 | + const integration = browserTracingIntegration({ |
| 136 | + ...options, |
| 137 | + instrumentNavigation: false, |
| 138 | + }); |
| 139 | + |
| 140 | + const { instrumentNavigation = true, useBeforeLeave, useLocation } = options; |
| 141 | + |
| 142 | + return { |
| 143 | + ...integration, |
| 144 | + setup() { |
| 145 | + _useBeforeLeave = useBeforeLeave; |
| 146 | + _useLocation = useLocation; |
| 147 | + }, |
| 148 | + afterAllSetup(client) { |
| 149 | + integration.afterAllSetup(client); |
| 150 | + |
| 151 | + if (instrumentNavigation) { |
| 152 | + CLIENTS_WITH_INSTRUMENT_NAVIGATION.add(client); |
| 153 | + } |
| 154 | + }, |
| 155 | + }; |
| 156 | +} |
| 157 | + |
| 158 | +/** |
| 159 | + * A higher-order component to instrument Solid Router to create navigation spans. |
| 160 | + */ |
| 161 | +export function withSentryRouterRouting(Router: Component<RouterProps>): Component<RouterProps> { |
| 162 | + if (!_useBeforeLeave || !_useLocation) { |
| 163 | + DEBUG_BUILD && |
| 164 | + logger.warn(`solidRouterBrowserTracingIntegration was unable to wrap Solid Router because of one or more missing hooks. |
| 165 | + useBeforeLeave: ${_useBeforeLeave}. useLocation: ${_useLocation}.`); |
| 166 | + |
| 167 | + return Router; |
| 168 | + } |
| 169 | + |
| 170 | + const SentryRouter = (props: RouterProps): JSX.Element => { |
| 171 | + const [local, others] = splitProps(props, ['root']); |
| 172 | + // We need to wrap root here in case the user passed in their own root |
| 173 | + const Root = withSentryRouterRoot(local.root ? local.root : SentryDefaultRoot); |
| 174 | + |
| 175 | + return createComponent(Router, mergeProps({ root: Root }, others)); |
| 176 | + }; |
| 177 | + |
| 178 | + return SentryRouter; |
| 179 | +} |
0 commit comments