52 lines
2.0 KiB
TypeScript
52 lines
2.0 KiB
TypeScript
/**
|
|
* React Router v7 Sentry tracing glue.
|
|
*
|
|
* `@sentry/react-router` v10 supports the React Router v7 Framework Mode
|
|
* natively. The auto-instrumentation is set up by `reactRouterTracingIntegration()`
|
|
* which is registered in `apps/web/app/sentry.client.ts` — no manual
|
|
* `wrapCreateBrowserRouter` is required.
|
|
*
|
|
* This module exposes two thin helpers:
|
|
*
|
|
* - {@link sentryHydrationErrorHandler} — to be passed to `<HydratedRouter onError={...}>`.
|
|
* Delegates to `Sentry.sentryOnError` when the SDK is loaded; falls
|
|
* back to a no-op so non-Sentry builds stay green.
|
|
* - {@link RouteTracingProvider} — a tiny provider that exists so the
|
|
* manual fallback path is wired uniformly. Today it is a passthrough
|
|
* because the official integration handles navigation spans
|
|
* internally; the wrapping component gives us a stable seam for
|
|
* bug fixes that need to capture extra navigation context without
|
|
* editing `root.tsx` again.
|
|
*
|
|
* @see docs/improvement-plan/02-observability/sentry-wiring-web.md (Step 7)
|
|
*/
|
|
import type { ReactNode } from "react";
|
|
|
|
export function sentryHydrationErrorHandler(error: unknown, info: { errorInfo?: React.ErrorInfo }): void {
|
|
void import("@sentry/react-router")
|
|
.then((Sentry) => {
|
|
Sentry.sentryOnError(error, info);
|
|
})
|
|
.catch(() => {
|
|
// If the SDK has not been initialized (DSN unset) or the export is
|
|
// missing on older versions, fall back silently. The framework's
|
|
// built-in default error handler still runs because React Router's
|
|
// `onError` is purely additive — it does not replace the default
|
|
// logging.
|
|
});
|
|
}
|
|
|
|
export interface RouteTracingProviderProps {
|
|
children: ReactNode;
|
|
}
|
|
|
|
/**
|
|
* Passthrough provider that documents the integration point. Wrapping
|
|
* `<Outlet />` (or the entire app tree) in this component gives us a
|
|
* stable seam to add navigation-context enrichment later without
|
|
* needing to edit `root.tsx` again.
|
|
*/
|
|
export function RouteTracingProvider({ children }: RouteTracingProviderProps) {
|
|
return <>{children}</>;
|
|
}
|