@bleedingdev/modern-js-plugin-tanstack 3.9.0-ultramodern.9 → 3.9.3-ultramodern.1

package/src/runtime/navigation.ts

@@ -0,0 +1,78 @@
+import type {
+  RouterNavigationCapability,
+  RouterNavigationSnapshot,
+} from '@modern-js/runtime-extensions/router-state';
+import type { AnyRouter } from '@tanstack/react-router';
+import { Link } from './prefetchLink';
+
+/** Native TanStack navigation, exposed through the provider contract. */
+export function createTanstackNavigation(
+  router: AnyRouter,
+): RouterNavigationCapability {
+  let location: AnyRouter['state']['location'] | undefined;
+  let matches: AnyRouter['state']['matches'] | undefined;
+  let snapshot: RouterNavigationSnapshot;
+  return {
+    Link: Link as RouterNavigationCapability['Link'],
+    getSnapshot() {
+      const state = router.state;
+      if (
+        location !== state.location ||
+        matches === undefined ||
+        matches.length !== state.matches.length ||
+        matches.some(
+          (match, index) => match.params !== state.matches[index]?.params,
+        )
+      ) {
+        location = state.location;
+        matches = state.matches;
+        snapshot = {
+          location: {
+            pathname: location.pathname,
+            search: location.searchStr,
+            hash:
+              location.hash !== '' ? `#${location.hash.replace(/^#/, '')}` : '',
+          },
+          params: Object.assign({}, ...matches.map(match => match.params)),
+        };
+      }
+      return snapshot;
+    },
+    subscribe(listener) {
+      const stops = (
+        ['onBeforeNavigate', 'onBeforeLoad', 'onLoad', 'onResolved'] as const
+      ).map(event => router.subscribe(event, listener));
+      return () => {
+        for (const stop of stops) stop();
+      };
+    },
+    navigate(href, options) {
+      return router.navigate({
+        to: href,
+        replace: options?.replace,
+        ...(options?.state === undefined
+          ? {}
+          : { state: options.state as never }),
+      });
+    },
+    createLinkProps(target) {
+      const preload =
+        target.preload !== undefined
+          ? target.preload
+          : target.prefetch === 'none'
+            ? false
+            : target.prefetch;
+      return {
+        to: target.pathname,
+        ...(target.search !== undefined ? { search: target.search } : {}),
+        ...(target.hash !== undefined && target.hash !== ''
+          ? { hash: target.hash }
+          : {}),
+        ...(target.hashScrollIntoView === undefined
+          ? {}
+          : { hashScrollIntoView: target.hashScrollIntoView }),
+        ...(preload === undefined ? {} : { preload }),
+      };
+    },
+  };
+}

package/src/runtime/plugin.node.tsx

@@ -5,6 +5,7 @@ import {
   type TInternalRuntimeContext,
 } from '@modern-js/runtime/context';
 import type { InternalRouterServerSnapshot } from '@modern-js/runtime-extensions/router-state';
+import { createRouterStatePlugin } from '@modern-js/runtime-extensions/router-state-plugin';
 import {
   createRequestContext,
   type RequestContext,
@@ -23,11 +24,13 @@ import { createModernBasepathRewrite } from './basepathRewrite';
 import { routerProviderRegistryHooks } from './hooks';
 import { wrapTanstackSsrHydrationBoundary } from './hydrationBoundary';
 import {
+  applyRouterRuntimeState,
   applyRouterServerPrepareResult,
-  createRouterServerSnapshot,
   getRouterRuntimeState,
+  getRouterServerSnapshot,
   type RouterLifecycleContext,
 } from './lifecycle';
+import { createTanstackNavigation } from './navigation';
 import {
   createTanstackRouteObjects,
   getTanstackRouteConfig,
@@ -54,7 +57,6 @@ import {
   collectRouterErrors,
   createGetSsrHref,
   routerManagedTagsToHtml,
-  waitForRouterSerialization,
 } from './ssrManagedTags';
 import { preloadMatchedRouteComponents } from './ssrPreload';
 import type {
@@ -73,6 +75,9 @@ export const tanstackRouterPlugin = (
     name: '@modern-js/plugin-router-tanstack',
     registryHooks: routerProviderRegistryHooks,
     setup: (api: TanstackRouterPluginAPI) => {
+      createRouterStatePlugin({
+        registryHooks: routerProviderRegistryHooks,
+      }).setup(api);
       api.onBeforeRender(async (context, interrupt) => {
         const routeConfig = getTanstackRouteConfig(api, userConfig);
         const { mergedConfig } = routeConfig;
@@ -168,116 +173,141 @@ export const tanstackRouterPlugin = (
           setTanstackRscRouter(serverRouter);
         }
 
-        await attachServerSsrUtils(serverRouter);
-
-        const end = time();
-
+        let disposed = false;
+        let prepared = false;
+        const onAbort = () => controller.abort(rawRequest.signal.reason);
+        const cleanup = () => {
+          if (disposed) return;
+          disposed = true;
+          rawRequest.signal.removeEventListener('abort', onAbort);
+          controller.abort();
+          serverRouter.serverSsr?.cleanup();
+        };
+        // Acquire the disposer before attachment: every subsequent failure,
+        // including partial attachment, has an owner. Successful preparation
+        // leaves disposal to the response lifetime in the SSR pipeline.
+        applyRouterRuntimeState(context, {
+          framework: 'tanstack',
+          basename: _basename,
+          instance: serverRouter,
+          cleanup,
+        });
+        rawRequest.signal.addEventListener('abort', onAbort, { once: true });
         try {
-          await tanstackRouter.load({ sync: true });
-        } finally {
-          const cost = end();
-          context.ssrContext?.onTiming?.(LOADER_REPORTER_NAME, cost);
-        }
+          rawRequest.signal.throwIfAborted();
+          await attachServerSsrUtils(serverRouter);
+          rawRequest.signal.throwIfAborted();
+
+          const end = time();
 
-        const serverLoadResult = serverRouter._serverResult;
-        if (!serverLoadResult) {
           try {
-            serverRouter.serverSsr?.cleanup?.();
-          } catch {}
-          throw new Error(
-            'TanStack Router completed an SSR load without a server result.',
-          );
-        }
+            await tanstackRouter.load({ sync: true });
+          } finally {
+            const cost = end();
+            context.ssrContext?.onTiming?.(LOADER_REPORTER_NAME, cost);
+          }
 
-        if (serverLoadResult.type === 'redirect') {
-          const { redirect } = serverLoadResult;
+          rawRequest.signal.throwIfAborted();
+          const serverLoadResult = serverRouter._serverResult;
+          if (!serverLoadResult) {
+            throw new Error(
+              'TanStack Router completed an SSR load without a server result.',
+            );
+          }
 
-          try {
-            serverRouter.serverSsr?.cleanup?.();
-          } catch {}
-
-          return interrupt(
-            isRSCNavigation
-              ? handleTanstackRscRedirect(
-                  redirect.headers,
-                  _basename,
-                  redirect.status,
-                )
-              : redirect,
-          );
-        }
+          if (serverLoadResult.type === 'redirect') {
+            const { redirect } = serverLoadResult;
+
+            return interrupt(
+              isRSCNavigation
+                ? handleTanstackRscRedirect(
+                    redirect.headers,
+                    _basename,
+                    redirect.status,
+                  )
+                : redirect,
+            );
+          }
+
+          const routerErrors = collectRouterErrors(tanstackRouter);
+          if (routerErrors && loaderFailureMode === 'clientRender') {
+            (
+              context.ssrContext?.response as
+                | { status: (code: number) => void }
+                | undefined
+            )?.status(200);
+            throw Object.values(routerErrors)[0];
+          }
+
+          await preloadMatchedRouteComponents(serverRouter);
 
-        const routerErrors = collectRouterErrors(tanstackRouter);
-        if (routerErrors && loaderFailureMode === 'clientRender') {
           (
             context.ssrContext?.response as
               | { status: (code: number) => void }
               | undefined
-          )?.status(200);
-          try {
-            serverRouter.serverSsr?.cleanup?.();
-          } catch {}
-          throw Object.values(routerErrors)[0];
-        }
-
-        await preloadMatchedRouteComponents(serverRouter);
-
-        (
-          context.ssrContext?.response as
-            | { status: (code: number) => void }
-            | undefined
-        )?.status(serverLoadResult.status);
+          )?.status(serverLoadResult.status);
 
-        await serverRouter.serverSsr?.dehydrate?.();
+          await serverRouter.serverSsr?.dehydrate();
 
-        if (enableRsc) {
-          if (isRSCNavigation) {
-            // RSC navigations consume the server payload directly. Normal HTML SSR
-            // emits the buffered bootstrap script below and must not wait here
-            // because Modern's non-streaming hook has not rendered the app yet.
-            await waitForRouterSerialization(serverRouter);
+          if (enableRsc) {
+            setTanstackRscServerPayload(
+              createTanstackRscServerPayload(serverRouter, {
+                omitClientLoaderData: isRSCNavigation,
+              }),
+            );
+            if (isRSCNavigation) {
+              context.ssrContext!.response.setHeader(
+                'Content-Type',
+                'text/x-component',
+              );
+            }
           }
 
-          setTanstackRscServerPayload(
-            createTanstackRscServerPayload(serverRouter, {
-              omitClientLoaderData: isRSCNavigation,
-            }),
-          );
-        }
-
-        const ssrScriptTags = serverRouter.serverSsr?.takeBufferedScripts?.();
-        const hydrationScripts = routerManagedTagsToHtml(ssrScriptTags);
-        const matchedRouteIds = getModernRouteIdsFromMatches(serverRouter);
-        const routerServerSnapshot: InternalRouterServerSnapshot =
-          createRouterServerSnapshot({
+          const initialScriptTags =
+            serverRouter.serverSsr?.takeInitialHydrationScriptTags();
+          const hydrationScripts = initialScriptTags
+            ? routerManagedTagsToHtml([
+                ...initialScriptTags.before,
+                initialScriptTags.boundary,
+              ])
+            : [];
+          const matchedRouteIds = getModernRouteIdsFromMatches(serverRouter);
+          const routerServerSnapshot: InternalRouterServerSnapshot = {
             framework: 'tanstack',
             basename: _basename,
             statusCode: serverLoadResult.status,
             errors: routerErrors,
             matchedRouteIds,
             hydrationScripts,
-          });
-        const runtimeContext = applyRouterServerPrepareResult(
-          context as TInternalRuntimeContext,
-          {
-            snapshot: routerServerSnapshot,
-            cleanup: () => serverRouter.serverSsr?.cleanup?.(),
-            state: {
-              framework: 'tanstack',
-              basename: _basename,
-              instance: serverRouter,
-              hydrationScripts,
-              matchedRouteIds,
-              serverSnapshot: routerServerSnapshot,
+          };
+          const runtimeContext = applyRouterServerPrepareResult(
+            context as TInternalRuntimeContext,
+            {
+              snapshot: routerServerSnapshot,
+              cleanup,
+              state: {
+                framework: 'tanstack',
+                basename: _basename,
+                instance: serverRouter,
+                navigation: createTanstackNavigation(tanstackRouter),
+              },
             },
-          },
-        );
-        hooks.onAfterCreateRouter.call({
-          ...routerLifecycleContext,
-          router: serverRouter,
-          serverSnapshot: routerServerSnapshot,
-          runtimeContext,
-        });
+          );
+          rawRequest.signal.throwIfAborted();
+          hooks.onAfterCreateRouter.call({
+            ...routerLifecycleContext,
+            router: serverRouter,
+            serverSnapshot: getRouterServerSnapshot(runtimeContext),
+            runtimeContext,
+          });
+          prepared = true;
+        } finally {
+          if (!prepared) {
+            try {
+              cleanup();
+            } catch {}
+          }
+        }
       });
 
       api.wrapRoot(App => {

package/src/runtime/plugin.tsx

@@ -4,6 +4,7 @@ import {
   InternalRuntimeContext,
   type TInternalRuntimeContext,
 } from '@modern-js/runtime/context';
+import { createRouterStatePlugin } from '@modern-js/runtime-extensions/router-state-plugin';
 import type { RouteObject } from '@modern-js/runtime-utils/router';
 import { normalizePathname } from '@modern-js/runtime-utils/url';
 import {
@@ -32,6 +33,7 @@ import {
   applyRouterRuntimeState,
   type RouterLifecycleContext,
 } from './lifecycle';
+import { createTanstackNavigation } from './navigation';
 import {
   createTanstackRouteObjects,
   getMergedRouterConfig,
@@ -56,6 +58,9 @@ export const tanstackRouterPlugin = (
     name: '@modern-js/plugin-router-tanstack',
     registryHooks: routerProviderRegistryHooks,
     setup: (api: TanstackRouterPluginAPI) => {
+      createRouterStatePlugin({
+        registryHooks: routerProviderRegistryHooks,
+      }).setup(api);
       const hooks = api.getHooks();
       let cachedRouteObjects: RouteObject[] | undefined;
       let cachedRouteTree: ReturnType<
@@ -259,10 +264,15 @@ export const tanstackRouterPlugin = (
           if (!router) {
             return App ? <App /> : null;
           }
+          const navigation = useMemo(
+            () => createTanstackNavigation(router),
+            [router],
+          );
           const runtimeState = applyRouterRuntimeState(runtimeContext, {
             framework: 'tanstack',
             basename: _basename,
             instance: router,
+            navigation,
           });
           const lifecycleContext: RouterLifecycleContext = {
             framework: 'tanstack',

package/src/runtime/pluginShared.ts

@@ -1,3 +1,7 @@
+import type {
+  OnRenderPreparedFn,
+  OnRequestEndFn,
+} from '@modern-js/plugin/runtime';
 import {
   getGlobalLayoutApp,
   getGlobalRoutes,
@@ -6,6 +10,7 @@ import {
 import { merge } from '@modern-js/runtime-utils/merge';
 import type { RouteObject } from '@modern-js/runtime-utils/router';
 import type { RouterExtendsHooks } from './hooks';
+import type { RouterLifecycleContext } from './lifecycle';
 import type { RouterConfig } from './types';
 import { createTanstackRouteObjectsFromConfig } from './utils';
 
@@ -26,6 +31,13 @@ export type TanstackRouterPluginAPI = {
       interrupt: RuntimeInterrupt,
     ) => unknown,
   ) => void;
+  onRenderPrepared: (
+    listener: OnRenderPreparedFn<TInternalRuntimeContext>,
+  ) => void;
+  onRequestEnd: (listener: OnRequestEndFn<TInternalRuntimeContext>) => void;
+  onAfterCreateRouter: (
+    listener: (event: RouterLifecycleContext) => void,
+  ) => void;
   wrapRoot: (listener: (App: any) => any) => void;
   [key: string]: any;
 };

package/src/runtime/routeTree/construction.ts

@@ -1,11 +1,14 @@
 // @effect-diagnostics asyncFunction:off strictBooleanExpressions:off
 
-import { canonicaliseLocalisedRoutes } from '@modern-js/i18n-runtime-extensions';
 import { DefaultNotFound } from '@modern-js/runtime/context';
 import type { RouteObject } from '@modern-js/runtime-utils/router';
 import type { AnyRoute, AnyRouter } from '@tanstack/react-router';
 import { rootRouteId } from '@tanstack/react-router';
 
+import {
+  describeRouteTree,
+  type RouteDescriptor,
+} from '../../shared/routeDescriptor';
 import { createRouteStaticData } from '../../shared/routeStaticData';
 import { withModernRouteMatchContext } from '../outlet';
 import {
@@ -14,7 +17,6 @@ import {
   toRouteComponent,
 } from './components';
 import { createModernShouldReload, wrapRouteObjectLoader } from './loaders';
-import { isRouteObjectPathlessLayout, toTanstackPath } from './paths';
 import { mergeModernRouteHandle } from './staticData';
 import {
   createTanstackRootRoute,
@@ -24,25 +26,16 @@ import {
 import type {
   ModernRouteObject,
   ModernTanstackRootRoute,
-  MutableTanstackRoute,
   RouteRevalidationState,
   RouteTreeOptions,
   TanstackRootRouteOptions,
   TanstackRouteOptions,
 } from './types';
 
-function createRouteFromRouteObject(opts: {
-  options?: RouteTreeOptions;
-  parent: AnyRoute;
-  pathlessFallbackId?: string;
-  routeObject: RouteObject;
-}): AnyRoute {
-  const {
-    options = {},
-    parent,
-    pathlessFallbackId = 'pathless',
-    routeObject,
-  } = opts;
+function createRouteOptions(
+  routeObject: RouteObject,
+  options: RouteTreeOptions,
+): TanstackRouteOptions {
   const modernRouteObject = routeObject as ModernRouteObject;
   const revalidationState: RouteRevalidationState = {};
   const shouldRevalidate = modernRouteObject.shouldRevalidate;
@@ -50,13 +43,8 @@ function createRouteFromRouteObject(opts: {
     shouldRevalidate,
     revalidationState,
   );
-
-  const stableFallbackId =
-    routeObject.id || modernRouteObject.file || pathlessFallbackId;
-
   const component = toRouteComponent(routeObject);
   const base: TanstackRouteOptions = {
-    getParentRoute: () => parent,
     component,
     pendingComponent: toPendingComponent(routeObject),
     errorComponent: toErrorComponent(routeObject),
@@ -87,117 +75,49 @@ function createRouteFromRouteObject(opts: {
     base.shouldReload = shouldReload;
   }
 
-  if (isRouteObjectPathlessLayout(routeObject)) {
-    base.id = stableFallbackId;
-  } else {
-    base.path = routeObject.index
-      ? '/'
-      : toTanstackPath((routeObject.path as string) || '');
-  }
-
-  const route = createTanstackRoute(base);
-  wrapRouteComponentWithModernContext(route, component, routeObject.id);
+  return base;
+}
 
-  const children = routeObject.children;
-  if (children && children.length > 0) {
-    const childRoutes = children.map((child: RouteObject, index) =>
-      createRouteFromRouteObject({
-        options,
-        parent: route,
-        pathlessFallbackId: `pathless-${index}`,
-        routeObject: child,
-      }),
+function createRouteFromDescriptor(
+  descriptor: RouteDescriptor<RouteObject>,
+  parent: AnyRoute,
+  options: RouteTreeOptions,
+): AnyRoute {
+  const { source, location, children } = descriptor;
+  const routeOptions = createRouteOptions(source, options);
+  const route = createTanstackRoute({
+    ...routeOptions,
+    ...location,
+    getParentRoute: () => parent,
+  });
+  wrapRouteComponentWithModernContext(route, routeOptions.component, source.id);
+  if (children.length) {
+    route.addChildren(
+      children.map(child => createRouteFromDescriptor(child, route, options)),
     );
-    route.addChildren(childRoutes);
   }
-
   return route;
 }
 
-function getRootLikeRouteObject(routes: RouteObject[]) {
-  return routes.find(route => route.path === '/' && !route.index);
-}
-
 export function createRouteTreeFromRouteObjects(
   routes: RouteObject[],
   options: RouteTreeOptions = {},
 ): ModernTanstackRootRoute {
-  routes = canonicaliseLocalisedRoutes(routes);
-  const rootLikeRoute = getRootLikeRouteObject(routes) as
-    | ModernRouteObject
-    | undefined;
-  const rootRevalidationState: RouteRevalidationState = {};
-  const rootShouldRevalidate = rootLikeRoute?.shouldRevalidate;
-  const rootShouldReload = createModernShouldReload(
-    rootShouldRevalidate,
-    rootRevalidationState,
-  );
-
-  const rootComponent = rootLikeRoute
-    ? toRouteComponent(rootLikeRoute)
-    : undefined;
+  const { root, children } = describeRouteTree(routes);
   const rootRouteOptions: TanstackRootRouteOptions = {
-    component: rootComponent,
-    pendingComponent: rootLikeRoute
-      ? toPendingComponent(rootLikeRoute)
-      : undefined,
-    errorComponent: rootLikeRoute ? toErrorComponent(rootLikeRoute) : undefined,
-    validateSearch: rootLikeRoute?.validateSearch,
-    loaderDeps: rootLikeRoute?.loaderDeps,
+    ...(root ? createRouteOptions(root, options) : {}),
     notFoundComponent: DefaultNotFound,
-    staticData: createRouteStaticData({
-      modernRouteId: rootLikeRoute?.id,
-      modernRouteAction: rootLikeRoute?.action,
-      modernRouteHandle: rootLikeRoute
-        ? mergeModernRouteHandle(rootLikeRoute)
-        : undefined,
-      modernRouteHasAction:
-        rootLikeRoute?.hasAction || Boolean(rootLikeRoute?.action),
-      modernRouteHasClientLoader:
-        rootLikeRoute?.hasClientLoader ||
-        typeof rootLikeRoute?.clientData !== 'undefined',
-      modernRouteHasLoader:
-        rootLikeRoute?.hasLoader || typeof rootLikeRoute?.loader === 'function',
-      modernRouteIsClientComponent: rootLikeRoute?.isClientComponent,
-      modernRouteLoader: rootLikeRoute?.loader,
-      modernRouteShouldRevalidate: rootShouldRevalidate,
-    }),
-    loader: rootLikeRoute
-      ? wrapRouteObjectLoader(rootLikeRoute, rootRevalidationState, options)
-      : undefined,
   };
-  if (rootShouldReload) {
-    rootRouteOptions.shouldReload = rootShouldReload;
-  }
-  if (rootLikeRoute?.inValidSSRRoute) {
-    rootRouteOptions.ssr = false;
-  }
-
   const rootRoute = createTanstackRootRoute(rootRouteOptions);
-  if (rootComponent) {
+  if (rootRouteOptions.component) {
     rootRoute.options.component = withModernRouteMatchContext(
-      rootComponent,
+      rootRouteOptions.component,
       rootRouteId,
     ) as typeof rootRoute.options.component;
   }
-
-  const topLevel = rootLikeRoute
-    ? [
-        ...((rootLikeRoute.children as RouteObject[] | undefined) || []),
-        ...routes.filter(route => route !== rootLikeRoute),
-      ]
-    : routes;
-
-  const childRoutes = topLevel.map((routeObject, index) =>
-    createRouteFromRouteObject({
-      options,
-      parent: rootRoute,
-      pathlessFallbackId: `pathless-${index}`,
-      routeObject,
-    }),
+  rootRoute.addChildren(
+    children.map(child => createRouteFromDescriptor(child, rootRoute, options)),
   );
-
-  rootRoute.addChildren(childRoutes);
   return rootRoute as unknown as ModernTanstackRootRoute;
 }
 

package/src/runtime/routeTree/loaders.ts

@@ -3,6 +3,7 @@
 import type { RouteObject } from '@modern-js/runtime-utils/router';
 import {
   getLoaderHref,
+  getLoaderSignal,
   handleModernLoaderError,
   handleModernLoaderResult,
   mapSplatParamsForModernLoader,
@@ -118,10 +119,7 @@ export function wrapRouteObjectLoader(
         } catch {}
       }
 
-      const signal: AbortSignal =
-        ctx?.abortController?.signal ||
-        ctx?.signal ||
-        new AbortController().signal;
+      const signal = getLoaderSignal(ctx);
       const baseRequest: Request | undefined =
         ctx?.context?.request instanceof Request
           ? ctx.context.request

package/src/runtime/routeTree/paths.ts

@@ -1,7 +1,5 @@
 // @effect-diagnostics asyncFunction:off strictBooleanExpressions:off
 
-import type { RouteObject } from '@modern-js/runtime-utils/router';
-
 export function toTanstackPath(pathname: string): string {
   // TanStack Router uses `$param` and `$` (splat) style params.
   // Modern's conventional routing currently generates React Router style params (e.g. `:id`, `*`).
@@ -30,7 +28,3 @@ export function toTanstackPath(pathname: string): string {
     })
     .join('/');
 }
-
-export function isRouteObjectPathlessLayout(route: RouteObject) {
-  return !route.path && !route.index;
-}