Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

Asset.test.tsx

166 lines5.0 KB

1import { afterEach, expect, test, vi } from 'vitest'
2import { cleanup, render } from '@testing-library/react'
3import {
4 Asset,
5 RouterContextProvider,
6 createMemoryHistory,
7 createRootRoute,
8 createRouter,
9} from '../src'
10import type { RouterManagedTag } from '@tanstack/router-core'
11​
12afterEach(() => {
13 cleanup()
14 vi.unstubAllEnvs()
15})
16​
17test.each([
18 ['style', { tag: 'style' }],
19 ['inline CSS', { tag: 'style', inlineCss: true }],
20 ['JSON-LD script', { tag: 'script', attrs: { type: 'application/ld+json' } }],
21 ['JSON script', { tag: 'script', attrs: { type: 'application/json' } }],
22] satisfies Array<[string, RouterManagedTag]>)(
23 '%s only replaces content when it changes',
24 (_name, asset: Extract<RouterManagedTag, { tag: 'style' | 'script' }>) => {
25 vi.stubEnv('TSS_INLINE_CSS_ENABLED', 'true')
26 const router = createRouter({
27 routeTree: createRootRoute(),
28 history: createMemoryHistory(),
29 })
30 const initial =
31 asset.tag === 'style' ? '.asset{color:red}' : '{"value":"initial"}'
32 const updated =
33 asset.tag === 'style' ? '.asset{color:blue}' : '{"value":"updated"}'
34 const renderAsset = (children: string, version: string) => (
35 <RouterContextProvider router={router}>
36 <Asset
37 {...asset}
38 attrs={{
39 ...asset.attrs,
40 'data-testid': 'asset',
41 'data-version': version,
42 }}
43 >
44 {children}
45 </Asset>
46 </RouterContextProvider>
47 )
48 const { getByTestId, rerender } = render(renderAsset(initial, 'initial'))
49 const element = getByTestId('asset')
50 const text = element.firstChild
51 expect(element.textContent).toBe(initial)
52 expect(text).not.toBeNull()
53​
54 rerender(renderAsset(initial, 'rerender'))
55 expect(getByTestId('asset')).toBe(element)
56 expect(element).toHaveAttribute('data-version', 'rerender')
57 expect(element.firstChild).toBe(text)
58​
59 rerender(renderAsset(updated, 'updated'))
60 expect(getByTestId('asset')).toBe(element)
61 expect(element.textContent).toBe(updated)
62 expect(element.firstChild).not.toBe(text)
63​
64 rerender(renderAsset('', 'empty'))
65 expect(element.textContent).toBe('')
66 },
68​
69test.each([undefined, '/asset.js'])(
70 'injects and cleans up executable scripts with src=%s',
71 (src) => {
72 const router = createRouter({
73 routeTree: createRootRoute(),
74 history: createMemoryHistory(),
75 })
76 const { unmount } = render(
77 <RouterContextProvider router={router}>
78 <Asset
79 tag="script"
80 attrs={{
81 id: 'injected-asset',
82 src,
83 async: true,
84 defer: false,
85 nonce: 'asset-nonce',
86 'data-empty': '',
87 'data-omitted': undefined,
88 suppressHydrationWarning: true,
89 }}
90 >
91 {src ? undefined : 'void 0'}
92 </Asset>
93 </RouterContextProvider>,
94 )
95 const script =
96 document.head.querySelector<HTMLScriptElement>('#injected-asset')
97 expect(script).toHaveAttribute('async', '')
98 expect(script).not.toHaveAttribute('defer')
99 expect(script).toHaveAttribute('data-empty', '')
100 expect(script).not.toHaveAttribute('data-omitted')
101 expect(script).not.toHaveAttribute('suppresshydrationwarning')
102 expect(script?.nonce).toBe('asset-nonce')
103 expect(script?.textContent).toBe(src ? '' : 'void 0')
104 expect(script?.getAttribute('src')).toBe(src ?? null)
105​
106 unmount()
107 expect(script).not.toBeInTheDocument()
108 },
110​
111test.each(['/asset.js', '//cdn.example.com/asset.js', 'http://['])(
112 'reuses existing executable scripts with src=%s',
113 (src) => {
114 const existing = document.createElement('script')
115 existing.src = src
116 document.head.appendChild(existing)
117 const router = createRouter({
118 routeTree: createRootRoute(),
119 history: createMemoryHistory(),
120 })
121​
122 try {
123 const { unmount } = render(
124 <RouterContextProvider router={router}>
125 <Asset tag="script" attrs={{ src }} />
126 </RouterContextProvider>,
127 )
128 expect(Array.from(document.scripts)).toEqual([existing])
129​
130 unmount()
131 expect(existing).toBeInTheDocument()
132 } finally {
133 existing.remove()
134 }
135 },
137​
138test.each([undefined, '', '/asset.js'])(
139 'only deduplicates inline content against scripts without src (src=%s)',
140 (src) => {
141 const existing = document.createElement('script')
142 existing.textContent = 'void 0'
143 if (src !== undefined) {
144 existing.setAttribute('src', src)
145 }
146 document.head.appendChild(existing)
147 const router = createRouter({
148 routeTree: createRootRoute(),
149 history: createMemoryHistory(),
150 })
151​
152 try {
153 const { unmount } = render(
154 <RouterContextProvider router={router}>
155 <Asset tag="script">void 0</Asset>
156 </RouterContextProvider>,
157 )
158 expect(document.scripts).toHaveLength(src === undefined ? 1 : 2)
159​
160 unmount()
161 expect(Array.from(document.scripts)).toEqual([existing])
162 } finally {
163 existing.remove()
164 }
165 },