Open History to see the last commit
1import { execFile } from 'node:child_process'
2import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'
3import path from 'node:path'
4import { promisify } from 'node:util'
5import { pathToFileURL } from 'node:url'
6import { build } from 'vite'
7import { expect, it } from 'vitest'
8import { tanstackRouter } from '../src/vite'
9import type { CodeSplitGroupings } from '../src/core/constants'
10β
11const runNode = promisify(execFile)
12const fixture = path.resolve(
13 __dirname,
14 'code-splitter/test-files/react/shared-runtime.tsx',
15)
16β
17const groupings: Array<{ name: string; groupings: CodeSplitGroupings }> = [
18 { name: 'eager loader', groupings: [['component']] },
19 { name: 'separate lazy loader', groupings: [['component'], ['loader']] },
20 { name: 'combined lazy loader', groupings: [['component', 'loader']] },
21]
22β
23it.each(groupings)(
24 'preserves executable route contracts with $name',
25 assertRuntimeContracts,
26 30_000,
27)
28β
29// Shared extraction currently duplicates named default function declarations and
30// drops TypeScript enum/namespace dependencies. Keep their intended contracts.
31it.fails.each(['named-default', 'enum', 'namespace'] as const)(
32 'preserves executable route contracts with shared %s declarations',
33 async (syntax) => {
34 await assertRuntimeContracts({
35 groupings: [['component'], ['loader']],
36 syntax,
37 })
38 },
39 30_000,
40)
41β
42async function assertRuntimeContracts({
43 groupings,
44 syntax,
45}: {
46 groupings: CodeSplitGroupings
47 syntax?: 'named-default' | 'enum' | 'namespace'
48}) {
49 // Keep the temporary app inside the package so real runtime imports resolve.
50 const root = await mkdtemp(path.join(__dirname, '.runtime-contract-'))
51 try {
52 await mkdir(path.join(root, 'routes'))
53 let source = await readFile(fixture, 'utf8')
54 if (syntax === 'named-default') {
55 source = source
56 .replace(
57 'function createSeed()',
58 'export default function createSeed()',
59 )
60 .replace('export default createSeed', '')
61 } else if (syntax === 'enum') {
62 source = source.replace(
63 'const Count = { Initial: 0 }',
64 'enum Count { Initial = 0 }',
65 )
66 } else if (syntax === 'namespace') {
67 source = source.replace(
68 "const Labels = { component: 'count' }",
69 "namespace Labels { export const component = 'count' }",
70 )
71 }
72 await writeFile(path.join(root, 'routes/shared-runtime.tsx'), source)
73 await writeFile(
74 path.join(root, 'routes/__root.tsx'),
75 `import { createRootRoute } from '@tanstack/react-router'
76export const Route = createRootRoute({})`,
77 )
78 await writeFile(
79 path.join(root, 'entry.ts'),
80 `import { createElement } from 'react'
81import { renderToString } from 'react-dom/server'
82import { Route } from './routes/shared-runtime'
83export { Route, firstState, secondState, 'odd-name' } from './routes/shared-runtime'
84export function render() {
85 return renderToString(createElement(Route.options.component))
86}`,
87 )
88β
89 await build({
90 root,
91 configFile: false,
92 logLevel: 'silent',
93 plugins: [
94 tanstackRouter({
95 target: 'react',
96 routesDirectory: './routes',
97 generatedRouteTree: './routeTree.gen.ts',
98 autoCodeSplitting: true,
99 codeSplittingOptions: {
100 addHmr: false,
101 defaultBehavior: groupings,
102 },
103 }),
104 ],
105 build: {
106 ssr: path.join(root, 'entry.ts'),
107 outDir: 'dist',
108 minify: false,
109 sourcemap: true,
110 rollupOptions: {
111 output: {
112 entryFileNames: 'entry.mjs',
113 chunkFileNames: '[name].mjs',
114 },
115 },
116 },
117 })
118β
119 const throwLine =
120 source.split('\n').findIndex((line) => line.includes('throw new Error')) +
121 1
122 const entryUrl = pathToFileURL(path.join(root, 'dist/entry.mjs')).href
123 const combined = groupings.some(
124 (group) => group.includes('component') && group.includes('loader'),
125 )
126 const { stdout } = await runNode(process.execPath, [
127 '--enable-source-maps',
128 '--input-type=module',
129 '--eval',
130 `import assert from 'node:assert/strict'
131const messages = []
132console.log = (message) => messages.push(message)
133const { Route, render, firstState, secondState, 'odd-name': oddState } = await import(${JSON.stringify(entryUrl)})
134assert.deepEqual(messages, ['shared-runtime:seed', 'shared-runtime:state', 'shared-runtime:reference'])
135const state = Route.options.beforeLoad({})
136assert.strictEqual(firstState, state)
137assert.strictEqual(secondState, state)
138assert.strictEqual(oddState, state)
139assert.equal(state.count, 0)
140assert.strictEqual(await Route.options.loader({}), state)
141assert.equal(state.count, 1)
142assert.deepEqual(messages, ${JSON.stringify(combined ? ['shared-runtime:seed', 'shared-runtime:state', 'shared-runtime:reference', 'shared-runtime:component'] : ['shared-runtime:seed', 'shared-runtime:state', 'shared-runtime:reference'])})
143await Route.options.component.preload()
144assert.equal(render(), 'count:1')
145assert.strictEqual(await Route.options.loader({}), state)
146assert.equal(render(), 'count:2')
147await Route.options.component.preload()
148assert.deepEqual(messages, ['shared-runtime:seed', 'shared-runtime:state', 'shared-runtime:reference', 'shared-runtime:component'])
149await Route.options.loader({})
150assert.throws(render, (error) => {
151 assert.equal(error.message, 'route source-map contract')
152 assert.match(error.stack, /shared-runtime\\.tsx(?:\\?[^\\n:]+)?:${throwLine}:/)
153 return true
154})
155process.stdout.write('route contracts passed')`,
156 ])
157 expect(stdout).toBe('route contracts passed')
158 } finally {
159 await rm(root, { recursive: true, force: true })
160 }
161}