Skip to content

Commit 96818b8

Browse files
fix(router-plugin): isolate route metadata per plugin instance (#7313)
1 parent 8b9ea22 commit 96818b8

18 files changed

Lines changed: 415 additions & 98 deletions
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@tanstack/router-plugin': patch
3+
'@tanstack/start-plugin-core': patch
4+
---
5+
6+
Replace global route metadata with explicit router plugin contexts so multiple router plugin instances cannot cross-transform route files.

‎packages/router-plugin/package.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,16 @@
6363
"default": "./dist/cjs/vite.cjs"
6464
}
6565
},
66+
"./context": {
67+
"import": {
68+
"types": "./dist/esm/context.d.ts",
69+
"default": "./dist/esm/context.js"
70+
},
71+
"require": {
72+
"types": "./dist/cjs/context.d.cts",
73+
"default": "./dist/cjs/context.cjs"
74+
}
75+
},
6676
"./rspack": {
6777
"import": {
6878
"types": "./dist/esm/rspack.d.ts",
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export { createRouterPluginContext } from './core/router-plugin-context'
2+
export type { RouterPluginContext } from './core/router-plugin-context'

‎packages/router-plugin/src/core/router-code-splitter-plugin.ts‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ import {
2222
} from './constants'
2323
import { decodeIdentifier } from './code-splitter/path-ids'
2424
import { debug, normalizePath } from './utils'
25+
import { createRouterPluginContext } from './router-plugin-context'
2526
import type { CodeSplitGroupings, SplitRouteIdentNodes } from './constants'
2627
import type { GetRoutesByFileMapResultValue } from '@tanstack/router-generator'
2728
import type { Config } from './config'
29+
import type { RouterPluginContext } from './router-plugin-context'
2830
import type {
2931
UnpluginFactory,
3032
TransformResult as UnpluginTransformResult,
@@ -76,9 +78,10 @@ const TRANSFORMATION_PLUGINS_BY_FRAMEWORK: Record<
7678
],
7779
}
7880

79-
export const unpluginRouterCodeSplitterFactory: UnpluginFactory<
80-
Partial<Config | (() => Config)> | undefined
81-
> = (options = {}, { framework: _framework }) => {
81+
export function createRouterCodeSplitterPlugin(
82+
options: Partial<Config | (() => Config)> | undefined = {},
83+
routerPluginContext: RouterPluginContext,
84+
): ReturnType<UnpluginFactory<Partial<Config | (() => Config)> | undefined>> {
8285
let ROOT: string = process.cwd()
8386
let userConfig: Config
8487

@@ -259,7 +262,7 @@ export const unpluginRouterCodeSplitterFactory: UnpluginFactory<
259262
handler(code, id) {
260263
const normalizedId = normalizePath(id)
261264
const generatorFileInfo =
262-
globalThis.TSR_ROUTES_BY_ID_MAP?.get(normalizedId)
265+
routerPluginContext.routesByFile.get(normalizedId)
263266
if (
264267
generatorFileInfo &&
265268
includedCode.some((included) => code.includes(included))
@@ -402,3 +405,9 @@ export const unpluginRouterCodeSplitterFactory: UnpluginFactory<
402405
},
403406
]
404407
}
408+
409+
export const unpluginRouterCodeSplitterFactory: UnpluginFactory<
410+
Partial<Config | (() => Config)> | undefined
411+
> = (options = {}) => {
412+
return createRouterCodeSplitterPlugin(options, createRouterPluginContext())
413+
}

‎packages/router-plugin/src/core/router-composed-plugin.ts‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import { getConfig } from '@tanstack/router-generator'
2-
import { unpluginRouterGeneratorFactory } from './router-generator-plugin'
3-
import { unpluginRouterCodeSplitterFactory } from './router-code-splitter-plugin'
4-
import { unpluginRouterHmrFactory } from './router-hmr-plugin'
2+
import { createRouterGeneratorPlugin } from './router-generator-plugin'
3+
import { createRouterCodeSplitterPlugin } from './router-code-splitter-plugin'
4+
import { createRouterHmrPlugin } from './router-hmr-plugin'
5+
import { createRouterPluginContext } from './router-plugin-context'
56
import type { Config } from './config'
67
import type {
78
RspackCompiler,
@@ -29,25 +30,27 @@ function applyRspackInlineCssDefaultDefinePlugin(compiler: RspackCompiler) {
2930

3031
export const unpluginRouterComposedFactory: UnpluginFactory<
3132
Partial<Config | (() => Config)> | undefined
32-
> = (options = {}, meta) => {
33+
> = (options = {}, _meta) => {
3334
const ROOT: string = process.cwd()
3435
const userConfig = getConfig(
3536
(typeof options === 'function' ? options() : options) as Partial<Config>,
3637
ROOT,
3738
)
39+
const routerPluginContext = createRouterPluginContext()
3840

39-
const getPlugin = (
40-
pluginFactory: UnpluginFactory<Partial<Config | (() => Config)>>,
41-
) => {
42-
const plugin = pluginFactory(options, meta)
41+
const getPlugin = (plugin: ReturnType<UnpluginFactory<any>>) => {
4342
if (!Array.isArray(plugin)) {
4443
return [plugin]
4544
}
4645
return plugin
4746
}
4847

49-
const routerGenerator = getPlugin(unpluginRouterGeneratorFactory)
50-
const routerCodeSplitter = getPlugin(unpluginRouterCodeSplitterFactory)
48+
const routerGenerator = getPlugin(
49+
createRouterGeneratorPlugin(options, routerPluginContext),
50+
)
51+
const routerCodeSplitter = getPlugin(
52+
createRouterCodeSplitterPlugin(options, routerPluginContext),
53+
)
5154

5255
const result = [
5356
{
@@ -85,7 +88,9 @@ export const unpluginRouterComposedFactory: UnpluginFactory<
8588
const isProduction = process.env.NODE_ENV === 'production'
8689

8790
if (!isProduction && !userConfig.autoCodeSplitting) {
88-
const routerHmr = getPlugin(unpluginRouterHmrFactory)
91+
const routerHmr = getPlugin(
92+
createRouterHmrPlugin(options, routerPluginContext),
93+
)
8994
result.push(...routerHmr)
9095
}
9196
return result

‎packages/router-plugin/src/core/router-generator-plugin.ts‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
import { isAbsolute, join, normalize } from 'node:path'
22
import { Generator, resolveConfigPath } from '@tanstack/router-generator'
33
import { getConfig } from './config'
4+
import { createRouterPluginContext } from './router-plugin-context'
45

56
import type { GeneratorEvent } from '@tanstack/router-generator'
67
import type { FSWatcher } from 'chokidar'
78
import type { UnpluginFactory } from 'unplugin'
89
import type { Config } from './config'
10+
import type { RouterPluginContext } from './router-plugin-context'
911

1012
const PLUGIN_NAME = 'unplugin:router-generator'
1113

12-
export const unpluginRouterGeneratorFactory: UnpluginFactory<
13-
Partial<Config | (() => Config)> | undefined
14-
> = (options = {}) => {
14+
export function createRouterGeneratorPlugin(
15+
options: Partial<Config | (() => Config)> | undefined = {},
16+
routerPluginContext: RouterPluginContext,
17+
): ReturnType<UnpluginFactory<Partial<Config | (() => Config)> | undefined>> {
1518
let ROOT: string = process.cwd()
1619
let userConfig: Config
1720
let generator: Generator
@@ -58,7 +61,7 @@ export const unpluginRouterGeneratorFactory: UnpluginFactory<
5861

5962
try {
6063
await generator.run(generatorEvent)
61-
globalThis.TSR_ROUTES_BY_ID_MAP = generator.getRoutesByFileMap()
64+
routerPluginContext.routesByFile = generator.getRoutesByFileMap()
6265
} catch (e) {
6366
console.error(e)
6467
}
@@ -146,3 +149,9 @@ export const unpluginRouterGeneratorFactory: UnpluginFactory<
146149
},
147150
}
148151
}
152+
153+
export const unpluginRouterGeneratorFactory: UnpluginFactory<
154+
Partial<Config | (() => Config)> | undefined
155+
> = (options = {}) => {
156+
return createRouterGeneratorPlugin(options, createRouterPluginContext())
157+
}

‎packages/router-plugin/src/core/router-hmr-plugin.ts‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ import { getReferenceRouteCompilerPlugins } from './code-splitter/plugins/framew
44
import { createRouteHmrStatement } from './hmr'
55
import { debug, normalizePath } from './utils'
66
import { getConfig } from './config'
7+
import { createRouterPluginContext } from './router-plugin-context'
78
import type { UnpluginFactory } from 'unplugin'
89
import type { Config } from './config'
10+
import type { RouterPluginContext } from './router-plugin-context'
911

1012
/**
1113
* This plugin adds HMR support for file routes.
@@ -18,11 +20,18 @@ const includeCode = [
1820
'createRootRoute(',
1921
'createRootRouteWithContext(',
2022
]
21-
export const unpluginRouterHmrFactory: UnpluginFactory<
22-
Partial<Config> | undefined
23-
> = (options = {}) => {
23+
24+
export function createRouterHmrPlugin(
25+
options: Partial<Config | (() => Config)> | undefined = {},
26+
routerPluginContext: RouterPluginContext,
27+
): ReturnType<UnpluginFactory<Partial<Config> | undefined>> {
2428
let ROOT: string = process.cwd()
25-
let userConfig = options as Config
29+
30+
const resolveUserConfig = () => {
31+
return getConfig(typeof options === 'function' ? options() : options, ROOT)
32+
}
33+
34+
let userConfig = resolveUserConfig()
2635

2736
return {
2837
name: 'tanstack-router:hmr',
@@ -37,7 +46,7 @@ export const unpluginRouterHmrFactory: UnpluginFactory<
3746
},
3847
handler(code, id) {
3948
const normalizedId = normalizePath(id)
40-
const routeEntry = globalThis.TSR_ROUTES_BY_ID_MAP?.get(normalizedId)
49+
const routeEntry = routerPluginContext.routesByFile.get(normalizedId)
4150
if (!routeEntry) {
4251
return null
4352
}
@@ -97,7 +106,7 @@ export const unpluginRouterHmrFactory: UnpluginFactory<
97106
vite: {
98107
configResolved(config) {
99108
ROOT = config.root
100-
userConfig = getConfig(options, ROOT)
109+
userConfig = resolveUserConfig()
101110
},
102111
applyToEnvironment(environment) {
103112
if (userConfig.plugin?.vite?.environmentName) {
@@ -108,3 +117,9 @@ export const unpluginRouterHmrFactory: UnpluginFactory<
108117
},
109118
}
110119
}
120+
121+
export const unpluginRouterHmrFactory: UnpluginFactory<
122+
Partial<Config> | undefined
123+
> = (options = {}) => {
124+
return createRouterHmrPlugin(options, createRouterPluginContext())
125+
}
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import type { GetRoutesByFileMapResult } from '@tanstack/router-generator'
2+
3+
export type RouterPluginContext = {
4+
routesByFile: GetRoutesByFileMapResult
5+
}
6+
7+
export function createRouterPluginContext(): RouterPluginContext {
8+
return {
9+
routesByFile: new Map(),
10+
}
11+
}

‎packages/router-plugin/src/esbuild.ts‎

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
import { createEsbuildPlugin } from 'unplugin'
22

33
import { configSchema } from './core/config'
4-
import { unpluginRouterCodeSplitterFactory } from './core/router-code-splitter-plugin'
5-
import { unpluginRouterGeneratorFactory } from './core/router-generator-plugin'
4+
import { createRouterCodeSplitterPlugin } from './core/router-code-splitter-plugin'
5+
import { createRouterGeneratorPlugin } from './core/router-generator-plugin'
66
import { unpluginRouterComposedFactory } from './core/router-composed-plugin'
7+
import { createRouterPluginContext } from './core/router-plugin-context'
78

89
import type { CodeSplittingOptions, Config } from './core/config'
10+
import type { RouterPluginContext } from './core/router-plugin-context'
11+
12+
type RouterPluginOptions = Partial<Config | (() => Config)> | undefined
13+
14+
const defaultRouterPluginContext = createRouterPluginContext()
915

1016
/**
1117
* @example
@@ -16,9 +22,15 @@ import type { CodeSplittingOptions, Config } from './core/config'
1622
* }
1723
* ```
1824
*/
19-
const TanStackRouterGeneratorEsbuild = createEsbuildPlugin(
20-
unpluginRouterGeneratorFactory,
21-
)
25+
const TanStackRouterGeneratorEsbuild = (
26+
options?: RouterPluginOptions,
27+
routerPluginContext?: RouterPluginContext,
28+
) => {
29+
const pluginContext = routerPluginContext ?? defaultRouterPluginContext
30+
return createEsbuildPlugin((pluginOptions: RouterPluginOptions) =>
31+
createRouterGeneratorPlugin(pluginOptions, pluginContext),
32+
)(options)
33+
}
2234

2335
/**
2436
* @example
@@ -29,9 +41,15 @@ const TanStackRouterGeneratorEsbuild = createEsbuildPlugin(
2941
* }
3042
* ```
3143
*/
32-
const TanStackRouterCodeSplitterEsbuild = createEsbuildPlugin(
33-
unpluginRouterCodeSplitterFactory,
34-
)
44+
const TanStackRouterCodeSplitterEsbuild = (
45+
options?: RouterPluginOptions,
46+
routerPluginContext?: RouterPluginContext,
47+
) => {
48+
const pluginContext = routerPluginContext ?? defaultRouterPluginContext
49+
return createEsbuildPlugin((pluginOptions: RouterPluginOptions) =>
50+
createRouterCodeSplitterPlugin(pluginOptions, pluginContext),
51+
)(options)
52+
}
3553

3654
/**
3755
* @example
@@ -54,4 +72,4 @@ export {
5472
tanstackRouter,
5573
}
5674

57-
export type { Config, CodeSplittingOptions }
75+
export type { Config, CodeSplittingOptions, RouterPluginContext }

‎packages/router-plugin/src/global.d.ts‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)