@bleedingdev/modern-js-plugin-tanstack 3.5.0-ultramodern.3 → 3.5.0-ultramodern.31

package/tests/router/tanstackTypes.test.ts

@@ -1,19 +1,163 @@
 import { execFile } from 'node:child_process';
-import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises';
+import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
 import { tmpdir } from 'node:os';
 import path from 'node:path';
 import { promisify } from 'node:util';
+import { isRedirect } from '@tanstack/react-router';
+
+const resolverDelays = new Map<string, number>();
+
+rstest.mock('../../src/cli/tanstackTypes/shared', () => {
+  const actual = rstest.requireActual(
+    '../../src/cli/tanstackTypes/shared',
+  ) as typeof import('../../src/cli/tanstackTypes/shared');
+
+  return {
+    ...actual,
+    resolveFileNoExt: async (inputNoExtPath: string) => {
+      const normalized = inputNoExtPath.replaceAll('\\', '/');
+      const delay =
+        [...resolverDelays.entries()].find(([suffix]) =>
+          normalized.endsWith(suffix),
+        )?.[1] ?? 0;
+
+      if (delay > 0) {
+        await new Promise(resolve => setTimeout(resolve, delay));
+      }
+
+      return actual.resolveFileNoExt(inputNoExtPath);
+    },
+  };
+});
+
 import {
   collectCanonicalRoutesForEntry,
   generateTanstackRouterTypesSourceForEntry,
 } from '../../src/cli/tanstackTypes';
+import { throwTanstackRedirect } from '../../src/runtime/loaderBridge';
 
 const execFileAsync = promisify(execFile);
+const routerGenGoldenPath = path.join(
+  __dirname,
+  'fixtures',
+  'router-gen.golden.txt',
+);
+
+type RedirectLike = {
+  options?: {
+    href?: string;
+    to?: string;
+  };
+};
+
+function catchThrown(fn: () => unknown): unknown {
+  try {
+    fn();
+  } catch (err) {
+    return err;
+  }
+  throw new Error('expected function to throw');
+}
+
+function extractRouteGenerationOrder(source: string) {
+  return source.split('\n').filter(line => {
+    return (
+      line.startsWith('import component_') ||
+      line.startsWith('const route_') ||
+      line.includes('component: component_') ||
+      line.startsWith('export const routeTree')
+    );
+  });
+}
+
+async function writeGoldenRouterFixture(srcDirectory: string) {
+  const files = new Map([
+    [
+      'routes/(app)/layout.tsx',
+      'export default function AppLayout() { return null; }',
+    ],
+    [
+      'routes/(app)/users/(userId)/page.tsx',
+      'export default function UserPage() { return null; }',
+    ],
+    [
+      'routes/(app)/users/(userId)/page.data.ts',
+      [
+        'export const loader = () => ({ userId: "42" });',
+        'export const action = () => Response.json({ ok: true });',
+      ].join('\n'),
+    ],
+    [
+      'routes/(app)/docs/splat.tsx',
+      'export default function DocsSplatPage() { return null; }',
+    ],
+    [
+      'routes/search.contract.ts',
+      [
+        'export const validateSearch = (search: { tab?: string }) => ({ tab: search.tab ?? "overview" });',
+        'export const loaderDeps = ({ search }: { search: { tab: string } }) => ({ tab: search.tab });',
+      ].join('\n'),
+    ],
+  ]);
+
+  for (const [relativePath, contents] of files) {
+    const filePath = path.join(srcDirectory, relativePath);
+    await mkdir(path.dirname(filePath), { recursive: true });
+    await writeFile(filePath, contents);
+  }
+}
+
+async function generateGoldenRouterGen(srcDirectory: string) {
+  await writeGoldenRouterFixture(srcDirectory);
+
+  const { routerGenTs } = await generateTanstackRouterTypesSourceForEntry({
+    appContext: {
+      srcDirectory,
+      internalSrcAlias: '@/_',
+    } as any,
+    entryName: 'golden',
+    routes: [
+      {
+        type: 'nested',
+        id: 'layout',
+        isRoot: true,
+        children: [
+          {
+            type: 'nested',
+            id: '(app)/layout',
+            _component: '@/_/routes/(app)/layout',
+            children: [
+              {
+                type: 'nested',
+                id: '(app)/users/(userId)/page',
+                path: 'users/:userId',
+                _component: '@/_/routes/(app)/users/(userId)/page',
+                data: '@/_/routes/(app)/users/(userId)/page.data',
+                action: '@/_/routes/(app)/users/(userId)/page.data',
+                validateSearch: '@/_/routes/search.contract',
+                loaderDeps: '@/_/routes/search.contract',
+              },
+              {
+                type: 'nested',
+                id: '(app)/docs/splat/page',
+                path: 'docs/*',
+                _component: '@/_/routes/(app)/docs/splat',
+              },
+            ],
+          },
+        ],
+      },
+    ] as any,
+  });
+
+  return routerGenTs;
+}
 
 describe('tanstack router type generation', () => {
   let tempDir: string | undefined;
 
   afterEach(async () => {
+    resolverDelays.clear();
     if (tempDir) {
       await rm(tempDir, { recursive: true, force: true });
       tempDir = undefined;
@@ -77,6 +221,15 @@ describe('tanstack router type generation', () => {
     expect(routerGenTs).not.toContain('function modernLoaderToTanstack');
     expect(routerGenTs).not.toContain('function createRouteStaticData');
     expect(routerGenTs).not.toContain('function throwTanstackRedirect');
+    expect(routerGenTs).not.toContain('new URL(target)');
+    expect(routerGenTs).not.toContain('redirect({ to: target })');
+
+    const redirectError = catchThrown(() =>
+      throwTanstackRedirect('https://example.com/absolute'),
+    ) as RedirectLike;
+    expect(isRedirect(redirectError)).toBe(true);
+    expect(redirectError.options?.href).toBe('https://example.com/absolute');
+    expect(redirectError.options?.to).toBeUndefined();
   });
 
   test('emits resolvable relative component imports for routes carrying _component', async () => {
@@ -167,6 +320,106 @@ describe('tanstack router type generation', () => {
     expect(dataOnlyRoute).not.toContain('component:');
   });
 
+  test('keeps generated source stable when route module resolution races', async () => {
+    tempDir = await mkdtemp(path.join(tmpdir(), 'modern-tanstack-types-'));
+    const srcDirectory = path.join(tempDir, 'src');
+
+    for (const componentFile of [
+      'routes/slow-page.tsx',
+      'routes/fast-page.tsx',
+      'routes/shared-page.tsx',
+    ]) {
+      const componentPath = path.join(srcDirectory, componentFile);
+      await mkdir(path.dirname(componentPath), { recursive: true });
+      await writeFile(
+        componentPath,
+        'export default function Page() { return null; }',
+      );
+    }
+
+    const routes = [
+      {
+        type: 'nested',
+        id: 'layout',
+        isRoot: true,
+        children: [
+          {
+            type: 'nested',
+            id: 'slow/page',
+            path: 'slow',
+            _component: '@/_/routes/slow-page',
+          },
+          {
+            type: 'nested',
+            id: 'fast/page',
+            path: 'fast',
+            _component: '@/_/routes/fast-page',
+          },
+          {
+            type: 'nested',
+            id: 'shared-a/page',
+            path: 'shared-a',
+            _component: '@/_/routes/shared-page',
+          },
+          {
+            type: 'nested',
+            id: 'shared-b/page',
+            path: 'shared-b',
+            _component: '@/_/routes/shared-page',
+          },
+        ],
+      },
+    ] as any;
+
+    const generateWithResolverDelays = async (
+      delays: Record<string, number>,
+    ) => {
+      resolverDelays.clear();
+      for (const [suffix, delay] of Object.entries(delays)) {
+        resolverDelays.set(suffix, delay);
+      }
+
+      const { routerGenTs } = await generateTanstackRouterTypesSourceForEntry({
+        appContext: {
+          srcDirectory,
+          internalSrcAlias: '@/_',
+        } as any,
+        entryName: 'index',
+        routes,
+      });
+
+      return routerGenTs;
+    };
+
+    const sequentialOutput = await generateWithResolverDelays({});
+    const racedOutput = await generateWithResolverDelays({
+      '/routes/slow-page': 25,
+    });
+
+    expect(
+      racedOutput.match(/from "\.\.\/\.\.\/routes\/shared-page";/g),
+    ).toHaveLength(1);
+    expect(extractRouteGenerationOrder(racedOutput)).toEqual(
+      extractRouteGenerationOrder(sequentialOutput),
+    );
+    expect(racedOutput).toBe(sequentialOutput);
+  });
+
+  test('matches checked-in router.gen golden output', async () => {
+    tempDir = await mkdtemp(path.join(tmpdir(), 'modern-tanstack-types-'));
+    const srcDirectory = path.join(tempDir, 'src');
+    const routerGenTs = await generateGoldenRouterGen(srcDirectory);
+
+    if (process.env.UPDATE_TANSTACK_ROUTER_GOLDEN === '1') {
+      await mkdir(path.dirname(routerGenGoldenPath), { recursive: true });
+      await writeFile(routerGenGoldenPath, routerGenTs);
+    }
+
+    await expect(readFile(routerGenGoldenPath, 'utf8')).resolves.toBe(
+      routerGenTs,
+    );
+  });
+
   test('typechecks generated TanStack search contracts', async () => {
     tempDir = await mkdtemp(path.join(tmpdir(), 'modern-tanstack-types-'));
     const srcDirectory = path.join(tempDir, 'src');

package/dist/esm/runtime/pluginCore.mjs

@@ -1,14 +0,0 @@
-import { getGlobalLayoutApp, getGlobalRoutes } from "@modern-js/runtime/context";
-import { merge } from "@modern-js/runtime-utils/merge";
-function getMergedRouterConfig(api, userConfig) {
-    const pluginConfig = api.getRuntimeConfig();
-    return merge(pluginConfig.router || {}, userConfig);
-}
-function getFinalRouteConfig(mergedConfig) {
-    return {
-        routes: getGlobalRoutes(),
-        globalApp: getGlobalLayoutApp(),
-        ...mergedConfig.routesConfig
-    };
-}
-export { getFinalRouteConfig, getMergedRouterConfig };

package/dist/esm-node/runtime/pluginCore.mjs

@@ -1,15 +0,0 @@
-import "node:module";
-import { getGlobalLayoutApp, getGlobalRoutes } from "@modern-js/runtime/context";
-import { merge } from "@modern-js/runtime-utils/merge";
-function getMergedRouterConfig(api, userConfig) {
-    const pluginConfig = api.getRuntimeConfig();
-    return merge(pluginConfig.router || {}, userConfig);
-}
-function getFinalRouteConfig(mergedConfig) {
-    return {
-        routes: getGlobalRoutes(),
-        globalApp: getGlobalLayoutApp(),
-        ...mergedConfig.routesConfig
-    };
-}
-export { getFinalRouteConfig, getMergedRouterConfig };

package/dist/types/runtime/pluginCore.d.ts

@@ -1,21 +0,0 @@
-import type { Plugin, RuntimePluginExtends } from '@modern-js/plugin';
-import type { RuntimePluginAPI } from '@modern-js/plugin/runtime';
-import { type TInternalRuntimeContext } from '@modern-js/runtime/context';
-import type { RouterExtendsHooks } from './hooks';
-import type { RouterConfig } from './types';
-export type TanstackRouterRuntimeConfig = {
-    plugins?: TanstackRouterRuntimePlugin[];
-    router?: Partial<RouterConfig>;
-    [key: string]: unknown;
-};
-type TanstackRouterRuntimeExtends = Required<RuntimePluginExtends<TanstackRouterRuntimeConfig, TInternalRuntimeContext>> & {
-    extendHooks: RouterExtendsHooks;
-};
-export type TanstackRouterPluginAPI = RuntimePluginAPI<TanstackRouterRuntimeExtends>;
-export type TanstackRouterRuntimePlugin = Plugin<TanstackRouterPluginAPI, TInternalRuntimeContext>;
-export declare function getMergedRouterConfig(api: TanstackRouterPluginAPI, userConfig: Partial<RouterConfig>): RouterConfig;
-export declare function getFinalRouteConfig(mergedConfig: RouterConfig): {
-    routes: (import("@modern-js/types").NestedRoute<string | (() => JSX.Element)> | import("@modern-js/types").PageRoute)[] | undefined;
-    globalApp: import("react").ComponentClass<{}, any> | import("react").FunctionComponent<{}> | undefined;
-};
-export {};

package/src/runtime/pluginCore.ts

@@ -1,48 +0,0 @@
-import type { Plugin, RuntimePluginExtends } from '@modern-js/plugin';
-import type { RuntimePluginAPI } from '@modern-js/plugin/runtime';
-import {
-  getGlobalLayoutApp,
-  getGlobalRoutes,
-  type TInternalRuntimeContext,
-} from '@modern-js/runtime/context';
-import { merge } from '@modern-js/runtime-utils/merge';
-import type { RouterExtendsHooks } from './hooks';
-import type { RouterConfig } from './types';
-
-export type TanstackRouterRuntimeConfig = {
-  plugins?: TanstackRouterRuntimePlugin[];
-  router?: Partial<RouterConfig>;
-  [key: string]: unknown;
-};
-
-type TanstackRouterRuntimeExtends = Required<
-  RuntimePluginExtends<TanstackRouterRuntimeConfig, TInternalRuntimeContext>
-> & {
-  extendHooks: RouterExtendsHooks;
-};
-
-export type TanstackRouterPluginAPI =
-  RuntimePluginAPI<TanstackRouterRuntimeExtends>;
-
-export type TanstackRouterRuntimePlugin = Plugin<
-  TanstackRouterPluginAPI,
-  TInternalRuntimeContext
->;
-
-export function getMergedRouterConfig(
-  api: TanstackRouterPluginAPI,
-  userConfig: Partial<RouterConfig>,
-): RouterConfig {
-  const pluginConfig = api.getRuntimeConfig() as {
-    router?: Partial<RouterConfig>;
-  };
-  return merge(pluginConfig.router || {}, userConfig) as RouterConfig;
-}
-
-export function getFinalRouteConfig(mergedConfig: RouterConfig) {
-  return {
-    routes: getGlobalRoutes(),
-    globalApp: getGlobalLayoutApp(),
-    ...mergedConfig.routesConfig,
-  };
-}