react-router 0.0.0-experimental-e613d4238 → 0.0.0-experimental-4e44d47

package/dist/production/index-react-server.d.ts

@@ -351,6 +351,11 @@ type DefaultContext = MiddlewareEnabled extends true ? Readonly<RouterContextPro
 interface DataFunctionArgs<Context> {
     /** A {@link https://developer.mozilla.org/en-US/docs/Web/API/Request Fetch Request instance} which you can use to read headers (like cookies, and {@link https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams URLSearchParams} from the request. */
     request: Request;
+    /**
+     * Matched un-interpolated route pattern for the current path (i.e., /blog/:slug).
+     * Mostly useful as a identifier to aggregate on for logging/tracing/etc.
+     */
+    pattern: string;
     /**
      * {@link https://reactrouter.com/start/framework/routing#dynamic-segments Dynamic route params} for the current route.
      * @example
@@ -571,7 +576,7 @@ type AgnosticPatchRoutesOnNavigationFunction<O extends AgnosticRouteObject = Agn
  * properties from framework-agnostic properties
  */
 interface MapRoutePropertiesFunction {
-    (route: AgnosticRouteObject): {
+    (route: AgnosticDataRouteObject): {
         hasErrorBoundary: boolean;
     } & Record<string, any>;
 }
@@ -887,6 +892,99 @@ type ErrorResponse = {
  */
 declare function isRouteErrorResponse(error: any): error is ErrorResponse;
 
+type unstable_ServerInstrumentation = {
+    handler?: unstable_InstrumentRequestHandlerFunction;
+    route?: unstable_InstrumentRouteFunction;
+};
+type unstable_ClientInstrumentation = {
+    router?: unstable_InstrumentRouterFunction;
+    route?: unstable_InstrumentRouteFunction;
+};
+type unstable_InstrumentRequestHandlerFunction = (handler: InstrumentableRequestHandler) => void;
+type unstable_InstrumentRouterFunction = (router: InstrumentableRouter) => void;
+type unstable_InstrumentRouteFunction = (route: InstrumentableRoute) => void;
+interface GenericInstrumentFunction {
+    (handler: () => Promise<void>, info: unknown): Promise<void>;
+}
+type InstrumentableRoute = {
+    id: string;
+    index: boolean | undefined;
+    path: string | undefined;
+    instrument(instrumentations: RouteInstrumentations): void;
+};
+type RouteInstrumentations = {
+    lazy?: InstrumentLazyFunction;
+    "lazy.loader"?: InstrumentLazyFunction;
+    "lazy.action"?: InstrumentLazyFunction;
+    "lazy.middleware"?: InstrumentLazyFunction;
+    middleware?: InstrumentRouteHandlerFunction;
+    loader?: InstrumentRouteHandlerFunction;
+    action?: InstrumentRouteHandlerFunction;
+};
+type RouteHandlerInstrumentationInfo = Readonly<{
+    request: {
+        method: string;
+        url: string;
+        headers: Pick<Headers, "get">;
+    };
+    params: LoaderFunctionArgs["params"];
+    pattern: string;
+    context: Pick<RouterContextProvider, "get">;
+}>;
+interface InstrumentLazyFunction extends GenericInstrumentFunction {
+    (handler: () => Promise<void>): Promise<void>;
+}
+interface InstrumentRouteHandlerFunction extends GenericInstrumentFunction {
+    (handler: () => Promise<void>, info: RouteHandlerInstrumentationInfo): Promise<void>;
+}
+type InstrumentableRouter = {
+    instrument(instrumentations: RouterInstrumentations): void;
+};
+type RouterInstrumentations = {
+    navigate?: InstrumentNavigateFunction;
+    fetch?: InstrumentFetchFunction;
+};
+type RouterNavigationInstrumentationInfo = Readonly<{
+    to: string | number;
+    currentUrl: string;
+    formMethod?: HTMLFormMethod;
+    formEncType?: FormEncType;
+    formData?: FormData;
+    body?: any;
+}>;
+type RouterFetchInstrumentationInfo = Readonly<{
+    href: string;
+    currentUrl: string;
+    fetcherKey: string;
+    formMethod?: HTMLFormMethod;
+    formEncType?: FormEncType;
+    formData?: FormData;
+    body?: any;
+}>;
+interface InstrumentNavigateFunction extends GenericInstrumentFunction {
+    (handler: () => Promise<void>, info: RouterNavigationInstrumentationInfo): MaybePromise<void>;
+}
+interface InstrumentFetchFunction extends GenericInstrumentFunction {
+    (handler: () => Promise<void>, info: RouterFetchInstrumentationInfo): MaybePromise<void>;
+}
+type InstrumentableRequestHandler = {
+    instrument(instrumentations: RequestHandlerInstrumentations): void;
+};
+type RequestHandlerInstrumentations = {
+    request?: InstrumentRequestHandlerFunction;
+};
+type RequestHandlerInstrumentationInfo = Readonly<{
+    request: {
+        method: string;
+        url: string;
+        headers: Pick<Headers, "get">;
+    };
+    context: Pick<RouterContextProvider, "get">;
+}>;
+interface InstrumentRequestHandlerFunction extends GenericInstrumentFunction {
+    (handler: () => Promise<void>, info: RequestHandlerInstrumentationInfo): MaybePromise<void>;
+}
+
 /**
  * A Router instance manages all navigation and data loading/mutations
  */
@@ -1171,6 +1269,7 @@ interface RouterInit {
     history: History;
     basename?: string;
     getContext?: () => MaybePromise<RouterContextProvider>;
+    unstable_instrumentations?: unstable_ClientInstrumentation[];
     mapRouteProperties?: MapRoutePropertiesFunction;
     future?: Partial<FutureConfig>;
     hydrationRouteProperties?: string[];
@@ -1437,6 +1536,7 @@ type BlockerFunction = (args: {
 interface CreateStaticHandlerOptions {
     basename?: string;
     mapRouteProperties?: MapRoutePropertiesFunction;
+    unstable_instrumentations?: Pick<unstable_ServerInstrumentation, "route">[];
     future?: {};
 }
 declare function createStaticHandler(routes: AgnosticRouteObject[], opts?: CreateStaticHandlerOptions): StaticHandler;
@@ -1807,6 +1907,11 @@ type ClientDataFunctionArgs<Params> = {
      * }
      **/
     params: Params;
+    /**
+     * Matched un-interpolated route pattern for the current path (i.e., /blog/:slug).
+     * Mostly useful as a identifier to aggregate on for logging/tracing/etc.
+     */
+    pattern: string;
     /**
      * When `future.v8_middleware` is not enabled, this is undefined.
      *

package/dist/production/index-react-server.js

@@ -27,7 +27,7 @@ function _interopNamespace(e) {
 var React2__namespace = /*#__PURE__*/_interopNamespace(React2);
 
 /**
- * react-router v0.0.0-experimental-e613d4238
+ * react-router v0.0.0-experimental-4e44d47
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -107,6 +107,134 @@ function parsePath(path) {
   return parsedPath;
 }
 
+// lib/router/instrumentation.ts
+var UninstrumentedSymbol = Symbol("Uninstrumented");
+function getInstrumentedImplementation(impls, handler, getInfo = () => void 0) {
+  if (impls.length === 0) {
+    return null;
+  }
+  return async (...args) => {
+    let value;
+    let info = getInfo(...args);
+    await recurseRight(
+      impls,
+      info,
+      async () => {
+        value = await handler(...args);
+      },
+      impls.length - 1
+    );
+    return value;
+  };
+}
+async function recurseRight(impls, info, handler, index) {
+  let impl = impls[index];
+  if (!impl) {
+    await handler();
+  } else {
+    await impl(async () => {
+      await recurseRight(impls, info, handler, index - 1);
+    }, info);
+  }
+}
+function getInstrumentationInfo(args) {
+  let { request, context, params, pattern } = args;
+  return {
+    // pseudo "Request" with the info they may want to read from
+    request: {
+      method: request.method,
+      url: request.url,
+      // Maybe make this a proxy that only supports `get`?
+      headers: {
+        get: (...args2) => request.headers.get(...args2)
+      }
+    },
+    params: { ...params },
+    pattern,
+    context: {
+      get: (...args2) => context.get(...args2)
+    }
+  };
+}
+function getInstrumentationsByType(instrumentations, key) {
+  let value = [];
+  for (let i in instrumentations) {
+    let instrumentation = instrumentations[i];
+    if (key in instrumentation && instrumentation[key] != null) {
+      value.push(instrumentation[key]);
+    }
+  }
+  return value;
+}
+function getInstrumentationUpdates(fns, route) {
+  let instrumentations = [];
+  fns.forEach(
+    (fn) => fn({
+      id: route.id,
+      index: route.index,
+      path: route.path,
+      instrument(i) {
+        instrumentations.push(i);
+      }
+    })
+  );
+  let updates = {};
+  if (instrumentations.length > 0) {
+    ["lazy", "loader", "action"].forEach((key) => {
+      let func = route[key];
+      if (typeof func === "function") {
+        let original = func[UninstrumentedSymbol] ?? func;
+        let instrumented = getInstrumentedImplementation(
+          getInstrumentationsByType(instrumentations, key),
+          original,
+          key === "lazy" ? () => void 0 : (...args) => getInstrumentationInfo(
+            args[0]
+          )
+        );
+        if (instrumented) {
+          instrumented[UninstrumentedSymbol] = original;
+          updates[key] = instrumented;
+        }
+      }
+    });
+    if (route.middleware && route.middleware.length > 0) {
+      updates.middleware = route.middleware.map((middleware) => {
+        let original = middleware[UninstrumentedSymbol] ?? middleware;
+        let instrumented = getInstrumentedImplementation(
+          getInstrumentationsByType(instrumentations, "middleware"),
+          original,
+          (...args) => getInstrumentationInfo(
+            args[0]
+          )
+        );
+        if (instrumented) {
+          instrumented[UninstrumentedSymbol] = original;
+          return instrumented;
+        }
+        return middleware;
+      });
+    }
+    if (typeof route.lazy === "object") {
+      let lazyObject = route.lazy;
+      ["middleware", "loader", "action"].forEach((key) => {
+        let func = lazyObject[key];
+        if (typeof func === "function") {
+          let instrumented = getInstrumentedImplementation(
+            getInstrumentationsByType(instrumentations, `lazy.${key}`),
+            func
+          );
+          if (instrumented) {
+            updates.lazy = Object.assign(updates.lazy || {}, {
+              [key]: instrumented
+            });
+          }
+        }
+      });
+    }
+  }
+  return updates;
+}
+
 // lib/router/utils.ts
 function createContext(defaultValue) {
   return { defaultValue };
@@ -200,19 +328,23 @@ function convertRoutesToDataRoutes(routes, mapRouteProperties, parentPath = [],
     if (isIndexRoute(route)) {
       let indexRoute = {
         ...route,
-        ...mapRouteProperties(route),
         id
       };
-      manifest[id] = indexRoute;
+      manifest[id] = mergeRouteUpdates(
+        indexRoute,
+        mapRouteProperties(indexRoute)
+      );
       return indexRoute;
     } else {
       let pathOrLayoutRoute = {
         ...route,
-        ...mapRouteProperties(route),
         id,
         children: void 0
       };
-      manifest[id] = pathOrLayoutRoute;
+      manifest[id] = mergeRouteUpdates(
+        pathOrLayoutRoute,
+        mapRouteProperties(pathOrLayoutRoute)
+      );
       if (route.children) {
         pathOrLayoutRoute.children = convertRoutesToDataRoutes(
           route.children,
@@ -226,6 +358,17 @@ function convertRoutesToDataRoutes(routes, mapRouteProperties, parentPath = [],
     }
   });
 }
+function mergeRouteUpdates(route, updates) {
+  return Object.assign(route, {
+    ...updates,
+    ...typeof updates.lazy === "object" && updates.lazy != null ? {
+      lazy: {
+        ...route.lazy,
+        ...updates.lazy
+      }
+    } : {}
+  });
+}
 function matchRoutes(routes, locationArg, basename = "/") {
   return matchRoutesImpl(routes, locationArg, basename, false);
 }
@@ -652,6 +795,9 @@ var ErrorResponseImpl = class {
 function isRouteErrorResponse(error) {
   return error != null && typeof error.status === "number" && typeof error.statusText === "string" && typeof error.internal === "boolean" && "data" in error;
 }
+function getRoutePattern(paths) {
+  return paths.filter(Boolean).join("/").replace(/\/\/*/g, "/");
+}
 
 // lib/router/router.ts
 var validMutationMethodsArr = [
@@ -682,7 +828,20 @@ function createStaticHandler(routes, opts) {
   );
   let manifest = {};
   let basename = (opts ? opts.basename : null) || "/";
-  let mapRouteProperties = opts?.mapRouteProperties || defaultMapRouteProperties;
+  let _mapRouteProperties = opts?.mapRouteProperties || defaultMapRouteProperties;
+  let mapRouteProperties = _mapRouteProperties;
+  if (opts?.unstable_instrumentations) {
+    let instrumentations = opts.unstable_instrumentations;
+    mapRouteProperties = (route) => {
+      return {
+        ..._mapRouteProperties(route),
+        ...getInstrumentationUpdates(
+          instrumentations.map((i) => i.route).filter(Boolean),
+          route
+        )
+      };
+    };
+  }
   let dataRoutes = convertRoutesToDataRoutes(
     routes,
     mapRouteProperties,
@@ -752,6 +911,7 @@ function createStaticHandler(routes, opts) {
         let response = await runServerMiddlewarePipeline(
           {
             request,
+            pattern: getRoutePattern(matches.map((m) => m.route.path)),
             matches,
             params: matches[0].params,
             // If we're calling middleware then it must be enabled so we can cast
@@ -897,6 +1057,7 @@ function createStaticHandler(routes, opts) {
       let response = await runServerMiddlewarePipeline(
         {
           request,
+          pattern: getRoutePattern(matches.map((m) => m.route.path)),
           matches,
           params: matches[0].params,
           // If we're calling middleware then it must be enabled so we can cast
@@ -1178,6 +1339,7 @@ function createStaticHandler(routes, opts) {
             mapRouteProperties,
             manifest,
             request,
+            getRoutePattern(matches.map((m) => m.route.path)),
             match,
             [],
             requestContext,
@@ -1188,6 +1350,7 @@ function createStaticHandler(routes, opts) {
           mapRouteProperties,
           manifest,
           request,
+          getRoutePattern(matches.map((m) => m.route.path)),
           match,
           [],
           requestContext,
@@ -1531,7 +1694,12 @@ async function runMiddlewarePipeline(args, handler, processResult, isResult, err
     (m) => m.route.middleware ? m.route.middleware.map((fn) => [m.route.id, fn]) : []
   );
   let result = await callRouteMiddleware(
-    { request, params, context },
+    {
+      request,
+      params,
+      context,
+      pattern: getRoutePattern(matches.map((m) => m.route.path))
+    },
     tuples,
     handler,
     processResult,
@@ -1609,7 +1777,7 @@ function getDataStrategyMatchLazyPromises(mapRouteProperties, manifest, request,
     handler: lazyRoutePromises.lazyHandlerPromise
   };
 }
-function getDataStrategyMatch(mapRouteProperties, manifest, request, match, lazyRoutePropertiesToSkip, scopedContext, shouldLoad, unstable_shouldRevalidateArgs = null) {
+function getDataStrategyMatch(mapRouteProperties, manifest, request, pattern, match, lazyRoutePropertiesToSkip, scopedContext, shouldLoad, unstable_shouldRevalidateArgs = null) {
   let isUsingNewApi = false;
   let _lazyPromises = getDataStrategyMatchLazyPromises(
     mapRouteProperties,
@@ -1643,6 +1811,7 @@ function getDataStrategyMatch(mapRouteProperties, manifest, request, match, lazy
       if (callHandler && !isMiddlewareOnlyRoute) {
         return callLoaderOrAction({
           request,
+          pattern,
           match,
           lazyHandlerPromise: _lazyPromises?.handler,
           lazyRoutePromise: _lazyPromises?.route,
@@ -1676,6 +1845,7 @@ function getTargetedDataStrategyMatches(mapRouteProperties, manifest, request, m
       mapRouteProperties,
       manifest,
       request,
+      getRoutePattern(matches.map((m) => m.route.path)),
       match,
       lazyRoutePropertiesToSkip,
       scopedContext,
@@ -1690,6 +1860,7 @@ async function callDataStrategyImpl(dataStrategyImpl, request, matches, fetcherK
   }
   let dataStrategyArgs = {
     request,
+    pattern: getRoutePattern(matches.map((m) => m.route.path)),
     params: matches[0].params,
     context: scopedContext,
     matches
@@ -1717,6 +1888,7 @@ async function callDataStrategyImpl(dataStrategyImpl, request, matches, fetcherK
 }
 async function callLoaderOrAction({
   request,
+  pattern,
   match,
   lazyHandlerPromise,
   lazyRoutePromise,
@@ -1743,6 +1915,7 @@ async function callLoaderOrAction({
       return handler(
         {
           request,
+          pattern,
           params: match.params,
           context: scopedContext
         },