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// A default-exported function declaration that the loader and the component
30// both reach is shared like any other declaration, and declared once.
31it('preserves executable route contracts with a shared named default function', async () => {
32 await assertRuntimeContracts({
33 groupings: [['component'], ['loader']],
34 syntax: 'named-default',
35 })
36}, 30_000)
37β
38async function assertRuntimeContracts({
39 groupings,
40 syntax,
41}: {
42 groupings: CodeSplitGroupings
43 syntax?: 'named-default'
44}) {
45 // Keep the temporary app inside the package so real runtime imports resolve.
46 const root = await mkdtemp(path.join(__dirname, '.runtime-contract-'))
47 try {
48 await mkdir(path.join(root, 'routes'))
49 let source = await readFile(fixture, 'utf8')
50 if (syntax === 'named-default') {
51 source = source
52 .replace(
53 'function createSeed()',
54 'export default function createSeed()',
55 )
56 .replace('export default createSeed', '')
57 }
58 await writeFile(path.join(root, 'routes/shared-runtime.tsx'), source)
59 await writeFile(
60 path.join(root, 'routes/__root.tsx'),
61 `import { createRootRoute } from '@tanstack/react-router'
62export const Route = createRootRoute({})`,
63 )
64 await writeFile(
65 path.join(root, 'entry.ts'),
66 `import { createElement } from 'react'
67import { renderToString } from 'react-dom/server'
68import { Route } from './routes/shared-runtime'
69export { Route, firstState, secondState, 'odd-name' } from './routes/shared-runtime'
70export function render() {
71 return renderToString(createElement(Route.options.component))
72}`,
73 )
74β
75 await build({
76 root,
77 configFile: false,
78 logLevel: 'silent',
79 plugins: [
80 tanstackRouter({
81 target: 'react',
82 routesDirectory: './routes',
83 generatedRouteTree: './routeTree.gen.ts',
84 autoCodeSplitting: true,
85 codeSplittingOptions: {
86 addHmr: false,
87 defaultBehavior: groupings,
88 },
89 }),
90 ],
91 build: {
92 ssr: path.join(root, 'entry.ts'),
93 outDir: 'dist',
94 minify: false,
95 sourcemap: true,
96 rollupOptions: {
97 output: {
98 entryFileNames: 'entry.mjs',
99 chunkFileNames: '[name].mjs',
100 },
101 },
102 },
103 })
104β
105 const throwLine =
106 source.split('\n').findIndex((line) => line.includes('throw new Error')) +
107 1
108 const entryUrl = pathToFileURL(path.join(root, 'dist/entry.mjs')).href
109 const combined = groupings.some(
110 (group) => group.includes('component') && group.includes('loader'),
111 )
112 const { stdout } = await runNode(process.execPath, [
113 '--enable-source-maps',
114 '--input-type=module',
115 '--eval',
116 `import assert from 'node:assert/strict'
117const messages = []
118console.log = (message) => messages.push(message)
119const { Route, render, firstState, secondState, 'odd-name': oddState } = await import(${JSON.stringify(entryUrl)})
120assert.deepEqual(messages, ['shared-runtime:seed', 'shared-runtime:state', 'shared-runtime:reference'])
121const state = Route.options.beforeLoad({})
122assert.strictEqual(firstState, state)
123assert.strictEqual(secondState, state)
124assert.strictEqual(oddState, state)
125assert.equal(state.count, 0)
126assert.strictEqual(await Route.options.loader({}), state)
127assert.equal(state.count, 1)
128assert.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'])})
129await Route.options.component.preload()
130assert.equal(render(), 'count:1')
131assert.strictEqual(await Route.options.loader({}), state)
132assert.equal(render(), 'count:2')
133await Route.options.component.preload()
134assert.deepEqual(messages, ['shared-runtime:seed', 'shared-runtime:state', 'shared-runtime:reference', 'shared-runtime:component'])
135await Route.options.loader({})
136assert.throws(render, (error) => {
137 assert.equal(error.message, 'route source-map contract')
138 assert.match(error.stack, /shared-runtime\\.tsx(?:\\?[^\\n:]+)?:${throwLine}:/)
139 return true
140})
141process.stdout.write('route contracts passed')`,
142 ])
143 expect(stdout).toBe('route contracts passed')
144 } finally {
145 await rm(root, { recursive: true, force: true })
146 }
147}