Move under folder

Author: onurtemizkan

packages/react/src/reactrouter-compat-utils/index.ts

@@ -0,0 +1,33 @@
+// Main exports from instrumentation
+export type { ReactRouterOptions } from './instrumentation';
+export {
+  createReactRouterV6CompatibleTracingIntegration,
+  createV6CompatibleWithSentryReactRouterRouting,
+  createV6CompatibleWrapCreateBrowserRouter,
+  createV6CompatibleWrapCreateMemoryRouter,
+  createV6CompatibleWrapUseRoutes,
+  handleNavigation,
+  handleExistingNavigationSpan,
+  createNewNavigationSpan,
+  addResolvedRoutesToParent,
+} from './instrumentation';
+
+// Utility exports
+export {
+  initializeRouterUtils,
+  prefixWithSlash,
+  rebuildRoutePathFromAllRoutes,
+  locationIsInsideDescendantRoute,
+  getNormalizedName,
+  resolveRouteNameAndSource,
+  pathEndsWithWildcard,
+  pathIsWildcardAndHasChildren,
+} from './utils';
+
+// Lazy route exports
+export {
+  updateNavigationSpanWithLazyRoutes,
+  createAsyncHandlerProxy,
+  handleAsyncHandlerResult,
+  checkRouteForAsyncHandler,
+} from './lazy-routes';

…react/src/reactrouterv6-compat-utils.tsx …trouter-compat-utils/instrumentation.tsxpackages/react/src/reactrouterv6-compat-utils.tsx renamed to packages/react/src/reactrouter-compat-utils/instrumentation.tsx packages/react/src/reactrouterv6-compat-utils.tsx renamed to packages/react/src/reactrouter-compat-utils/instrumentation.tsx

@@ -22,12 +22,8 @@ import {
   spanToJSON,
 } from '@sentry/core';
 import * as React from 'react';
-import { DEBUG_BUILD } from './debug-build';
-import { hoistNonReactStatics } from './hoist-non-react-statics';
-import { checkRouteForAsyncHandler, updateNavigationSpanWithLazyRoutes } from './lazy-route-utils';
-import {
-  initializeRouterUtils,
-} from './reactrouterv6-utils';
+import { DEBUG_BUILD } from '../debug-build';
+import { hoistNonReactStatics } from '../hoist-non-react-statics';
 import type {
   Action,
   AgnosticDataRouteMatch,
@@ -43,14 +39,22 @@ import type {
   UseLocation,
   UseNavigationType,
   UseRoutes,
-} from './types';
+} from '../types';
+import { checkRouteForAsyncHandler, updateNavigationSpanWithLazyRoutes } from './lazy-routes';
+import {
+  getNormalizedName,
+  initializeRouterUtils,
+  locationIsInsideDescendantRoute,
+  prefixWithSlash,
+  rebuildRoutePathFromAllRoutes,
+  resolveRouteNameAndSource,
+} from './utils';
 
 let _useEffect: UseEffect;
 let _useLocation: UseLocation;
 let _useNavigationType: UseNavigationType;
 let _createRoutesFromChildren: CreateRoutesFromChildren;
 let _matchRoutes: MatchRoutes;
-let _stripBasename: boolean = false;
 let _enableAsyncRouteHandlers: boolean = false;
 
 const CLIENTS_WITH_INSTRUMENT_NAVIGATION = new WeakSet<Client>();
@@ -152,13 +156,7 @@ function processResolvedRoutes(
         );
       } else if (spanOp === 'navigation') {
         // For navigation spans, update the name with the newly loaded routes
-        updateNavigationSpanWithLazyRoutes(
-          activeRootSpan,
-          location,
-          Array.from(allRoutes),
-          false,
-          _matchRoutes,
-        );
+        updateNavigationSpanWithLazyRoutes(activeRootSpan, location, Array.from(allRoutes), false, _matchRoutes);
       }
     }
   }
@@ -440,7 +438,6 @@ export function createReactRouterV6CompatibleTracingIntegration(
       _useNavigationType = useNavigationType;
       _matchRoutes = matchRoutes;
       _createRoutesFromChildren = createRoutesFromChildren;
-      _stripBasename = stripBasename || false;
       _enableAsyncRouteHandlers = enableAsyncRouteHandlers;
 
       // Initialize the router utils with the required dependencies
@@ -570,74 +567,6 @@ export function handleNavigation(opts: {
   }
 }
 
-/**
- * Strip the basename from a pathname if exists.
- *
- * Vendored and modified from `react-router`
- * https://github.com/remix-run/react-router/blob/462bb712156a3f739d6139a0f14810b76b002df6/packages/router/utils.ts#L1038
- */
-function stripBasenameFromPathname(pathname: string, basename: string): string {
-  if (!basename || basename === '/') {
-    return pathname;
-  }
-
-  if (!pathname.toLowerCase().startsWith(basename.toLowerCase())) {
-    return pathname;
-  }
-
-  // We want to leave trailing slash behavior in the user's control, so if they
-  // specify a basename with a trailing slash, we should support it
-  const startIndex = basename.endsWith('/') ? basename.length - 1 : basename.length;
-  const nextChar = pathname.charAt(startIndex);
-  if (nextChar && nextChar !== '/') {
-    // pathname does not start with basename/
-    return pathname;
-  }
-
-  return pathname.slice(startIndex) || '/';
-}
-
-function sendIndexPath(pathBuilder: string, pathname: string, basename: string): [string, TransactionSource] {
-  const reconstructedPath = pathBuilder || _stripBasename ? stripBasenameFromPathname(pathname, basename) : pathname;
-
-  const formattedPath =
-    // If the path ends with a slash, remove it
-    reconstructedPath[reconstructedPath.length - 1] === '/'
-      ? reconstructedPath.slice(0, -1)
-      : // If the path ends with a wildcard, remove it
-        reconstructedPath.slice(-2) === '/*'
-        ? reconstructedPath.slice(0, -1)
-        : reconstructedPath;
-
-  return [formattedPath, 'route'];
-}
-
-function pathEndsWithWildcard(path: string): boolean {
-  return path.endsWith('*');
-}
-
-function pathIsWildcardAndHasChildren(path: string, branch: RouteMatch<string>): boolean {
-  return (pathEndsWithWildcard(path) && !!branch.route.children?.length) || false;
-}
-
-function routeIsDescendant(route: RouteObject): boolean {
-  return !!(!route.children && route.element && route.path?.endsWith('/*'));
-}
-
-function locationIsInsideDescendantRoute(location: Location, routes: RouteObject[]): boolean {
-  const matchedRoutes = _matchRoutes(routes, location) as RouteMatch[];
-
-  if (matchedRoutes) {
-    for (const match of matchedRoutes) {
-      if (routeIsDescendant(match.route) && pickSplat(match)) {
-        return true;
-      }
-    }
-  }
-
-  return false;
-}
-
 function addRoutesToAllRoutes(routes: RouteObject[]): void {
   routes.forEach(route => {
     const extractedChildRoutes = getChildRoutesRecursively(route);
@@ -666,118 +595,6 @@ function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObjec
   return allRoutes;
 }
 
-function pickPath(match: RouteMatch): string {
-  return trimWildcard(match.route.path || '');
-}
-
-function pickSplat(match: RouteMatch): string {
-  return match.params['*'] || '';
-}
-
-function trimWildcard(path: string): string {
-  return path[path.length - 1] === '*' ? path.slice(0, -1) : path;
-}
-
-function trimSlash(path: string): string {
-  return path[path.length - 1] === '/' ? path.slice(0, -1) : path;
-}
-
-function prefixWithSlash(path: string): string {
-  return path[0] === '/' ? path : `/${path}`;
-}
-
-function rebuildRoutePathFromAllRoutes(allRoutes: RouteObject[], location: Location): string {
-  const matchedRoutes = _matchRoutes(allRoutes, location) as RouteMatch[];
-
-  if (!matchedRoutes || matchedRoutes.length === 0) {
-    return '';
-  }
-
-  for (const match of matchedRoutes) {
-    if (match.route.path && match.route.path !== '*') {
-      const path = pickPath(match);
-      const strippedPath = stripBasenameFromPathname(location.pathname, prefixWithSlash(match.pathnameBase));
-
-      if (location.pathname === strippedPath) {
-        return trimSlash(strippedPath);
-      }
-
-      return trimSlash(
-        trimSlash(path || '') +
-          prefixWithSlash(
-            rebuildRoutePathFromAllRoutes(
-              allRoutes.filter(route => route !== match.route),
-              {
-                pathname: strippedPath,
-              },
-            ),
-          ),
-      );
-    }
-  }
-
-  return '';
-}
-
-function getNormalizedName(
-  routes: RouteObject[],
-  location: Location,
-  branches: RouteMatch[],
-  basename: string = '',
-): [string, TransactionSource] {
-  if (!routes || routes.length === 0) {
-    return [_stripBasename ? stripBasenameFromPathname(location.pathname, basename) : location.pathname, 'url'];
-  }
-
-  let pathBuilder = '';
-
-  if (branches) {
-    for (const branch of branches) {
-      const route = branch.route;
-      if (route) {
-        // Early return if index route
-        if (route.index) {
-          return sendIndexPath(pathBuilder, branch.pathname, basename);
-        }
-        const path = route.path;
-
-        // If path is not a wildcard and has no child routes, append the path
-        if (path && !pathIsWildcardAndHasChildren(path, branch)) {
-          const newPath = path[0] === '/' || pathBuilder[pathBuilder.length - 1] === '/' ? path : `/${path}`;
-          pathBuilder = trimSlash(pathBuilder) + prefixWithSlash(newPath);
-
-          // If the path matches the current location, return the path
-          if (trimSlash(location.pathname) === trimSlash(basename + branch.pathname)) {
-            if (
-              // If the route defined on the element is something like
-              // <Route path="/stores/:storeId/products/:productId" element={<div>Product</div>} />
-              // We should check against the branch.pathname for the number of / separators
-              getNumberOfUrlSegments(pathBuilder) !== getNumberOfUrlSegments(branch.pathname) &&
-              // We should not count wildcard operators in the url segments calculation
-              !pathEndsWithWildcard(pathBuilder)
-            ) {
-              return [(_stripBasename ? '' : basename) + newPath, 'route'];
-            }
-
-            // if the last character of the pathbuilder is a wildcard and there are children, remove the wildcard
-            if (pathIsWildcardAndHasChildren(pathBuilder, branch)) {
-              pathBuilder = pathBuilder.slice(0, -1);
-            }
-
-            return [(_stripBasename ? '' : basename) + pathBuilder, 'route'];
-          }
-        }
-      }
-    }
-  }
-
-  const fallbackTransactionName = _stripBasename
-    ? stripBasenameFromPathname(location.pathname, basename)
-    : location.pathname;
-
-  return [fallbackTransactionName, 'url'];
-}
-
 function updatePageloadTransaction(
   activeRootSpan: Span | undefined,
   location: Location,
@@ -884,33 +701,6 @@ function getActiveRootSpan(): Span | undefined {
   return op === 'navigation' || op === 'pageload' ? rootSpan : undefined;
 }
 
-/**
- * Shared helper function to resolve route name and source
- */
-export function resolveRouteNameAndSource(
-  location: Location,
-  routes: RouteObject[],
-  allRoutes: RouteObject[],
-  branches: RouteMatch[],
-  basename: string = '',
-): [string, TransactionSource] {
-  let name: string | undefined;
-  let source: TransactionSource = 'url';
-
-  const isInDescendantRoute = locationIsInsideDescendantRoute(location, allRoutes);
-
-  if (isInDescendantRoute) {
-    name = prefixWithSlash(rebuildRoutePathFromAllRoutes(allRoutes, location));
-    source = 'route';
-  }
-
-  if (!isInDescendantRoute || !name) {
-    [name, source] = getNormalizedName(routes, location, branches, basename);
-  }
-
-  return [name || location.pathname, source];
-}
-
 /**
  * Handles updating an existing navigation span
  */
@@ -997,11 +787,3 @@ export function addResolvedRoutesToParent(resolvedRoutes: RouteObject[], parentR
     parentRoute.children = [...existingChildren, ...newRoutes];
   }
 }
-
-/**
- * Returns number of URL segments of a passed string URL.
- */
-export function getNumberOfUrlSegments(url: string): number {
-  // split at '/' or at '\/' to split regex urls correctly
-  return url.split(/\\?\//).filter(s => s.length > 0 && s !== ',').length;
-}

packages/react/src/lazy-route-utils.tsx …reactrouter-compat-utils/lazy-routes.tsxpackages/react/src/lazy-route-utils.tsx renamed to packages/react/src/reactrouter-compat-utils/lazy-routes.tsx packages/react/src/lazy-route-utils.tsx renamed to packages/react/src/reactrouter-compat-utils/lazy-routes.tsx

@@ -1,8 +1,8 @@
 import type { Span } from '@sentry/core';
 import { addNonEnumerableProperty, debug, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
-import { DEBUG_BUILD } from './debug-build';
-import { resolveRouteNameAndSource } from './reactrouterv6-compat-utils';
-import type { Location, MatchRoutes, RouteMatch, RouteObject } from './types';
+import { DEBUG_BUILD } from '../debug-build';
+import type { Location, MatchRoutes, RouteMatch, RouteObject } from '../types';
+import { resolveRouteNameAndSource } from './utils';
 
 /**
  * Updates a navigation span with the correct route name after lazy routes have been loaded.