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

virtualModules.ts

303 lines7.8 KB

1import {
2 MARKER_PREFIX,
3 MOCK_BUILD_PREFIX,
4 MOCK_EDGE_PREFIX,
5 MOCK_MODULE_ID,
6 MOCK_RUNTIME_PREFIX,
7} from './constants'
8import { isValidExportName } from './analysis'
9import { CLIENT_ENV_SUGGESTIONS } from './trace'
10import { relativizePath } from './utils'
11import type { ViolationInfo } from './trace'
12​
13function toBase64Url(input: string): string {
14 return Buffer.from(input, 'utf8').toString('base64url')
16​
17function fromBase64Url(input: string): string {
18 return Buffer.from(input, 'base64url').toString('utf8')
20​
21type MockAccessMode = 'error' | 'warn' | 'off'
22​
23export const RUNTIME_SUGGESTION_TEXT =
24 'Fix: ' +
25 CLIENT_ENV_SUGGESTIONS.join('. ') +
26 '. To disable these runtime diagnostics, set importProtection.mockAccess: "off".'
27​
28export function mockRuntimeModuleIdFromViolation(
29 info: ViolationInfo,
30 mode: MockAccessMode,
31 root: string,
32): string {
33 if (mode === 'off') return MOCK_MODULE_ID
34 if (info.env !== 'client') return MOCK_MODULE_ID
35​
36 const rel = (p: string) => relativizePath(p, root)
37 const trace = info.trace.map((s) => {
38 const file = rel(s.file)
39 if (s.line == null) return file
40 return `${file}:${s.line}:${s.column ?? 1}`
41 })
42​
43 const payload = {
44 env: info.env,
45 importer: info.importer,
46 specifier: info.specifier,
47 trace,
48 mode,
49 }
50​
51 return `${MOCK_RUNTIME_PREFIX}${toBase64Url(JSON.stringify(payload))}`
53​
54export function makeMockEdgeModuleId(
55 exports: Array<string>,
56 runtimeId: string,
57): string {
58 const payload = { exports, runtimeId }
59 return `${MOCK_EDGE_PREFIX}${toBase64Url(JSON.stringify(payload))}`
61​
62function generateMockCode(diagnostics?: {
63 meta: {
64 env: string
65 importer: string
66 specifier: string
67 trace: Array<unknown>
68 }
69 mode: 'error' | 'warn' | 'off'
70}): string {
71 const fnName = diagnostics ? '__createMock' : 'createMock'
72 const hasDiag = !!diagnostics
73​
74 const preamble = hasDiag
75 ? `const __meta = ${JSON.stringify(diagnostics.meta)};
76const __mode = ${JSON.stringify(diagnostics.mode)};
77​
78const __seen = new Set();
79function __report(action, accessPath) {
80 if (__mode === 'off') return;
81 const key = action + ':' + accessPath;
82 if (__seen.has(key)) return;
83 __seen.add(key);
84​
85 const traceLines = Array.isArray(__meta.trace) && __meta.trace.length
86 ? "\\n\\nTrace:\\n" + __meta.trace.map((t, i) => ' ' + (i + 1) + '. ' + String(t)).join('\\n')
87 : '';
88​
89 const msg =
90 '[import-protection] Mocked import used in dev client\\n\\n' +
91 'Denied import: "' + __meta.specifier + '"\\n' +
92 'Importer: ' + __meta.importer + '\\n' +
93 'Access: ' + accessPath + ' (' + action + ')' +
94 traceLines +
95 '\\n\\n' + ${JSON.stringify(RUNTIME_SUGGESTION_TEXT)};
96​
97 const err = new Error(msg);
98 if (__mode === 'warn') {
99 console.warn(err);
100 } else {
101 console.error(err);
102 }
105 : ''
106​
107 const primitiveGetTraps = `
108 if (prop === Symbol.toPrimitive) {
109 return () => {
110 ${hasDiag ? `__report('toPrimitive', name);` : ''}
111 return '[import-protection mock]';
112 };
113 }
114 if (prop === 'toString' || prop === 'valueOf' || prop === 'toJSON') {
115 return () => {
116 ${hasDiag ? `__report(String(prop), name);` : ''}
117 return '[import-protection mock]';
118 };
119 }`
120​
121 const applyBody = hasDiag
122 ? `__report('call', name + '()');
123 return ${fnName}(name + '()');`
124 : `return ${fnName}(name + '()');`
125​
126 const constructBody = hasDiag
127 ? `__report('construct', 'new ' + name);
128 return ${fnName}('new ' + name);`
129 : `return ${fnName}('new ' + name);`
130​
131 const setTrap = hasDiag
132 ? `
133 set(_target, prop) {
134 __report('set', name + '.' + String(prop));
135 return true;
136 },`
137 : ''
138​
139 return `
140${preamble}/* @__NO_SIDE_EFFECTS__ */
141function ${fnName}(name) {
142 const fn = function () {};
143 fn.prototype.name = name;
144 const children = Object.create(null);
145 const proxy = new Proxy(fn, {
146 get(_target, prop) {
147 if (prop === '__esModule') return true;
148 if (prop === 'default') return proxy;
149 if (prop === 'caller') return null;
150 if (prop === 'then') return (f) => Promise.resolve(f(proxy));
151 if (prop === 'catch') return () => Promise.resolve(proxy);
152 if (prop === 'finally') return (f) => { f(); return Promise.resolve(proxy); };${primitiveGetTraps}
153 if (typeof prop === 'symbol') return undefined;
154 if (!(prop in children)) {
155 children[prop] = ${fnName}(name + '.' + prop);
156 }
157 return children[prop];
158 },
159 apply() {
160 ${applyBody}
161 },
162 construct() {
163 ${constructBody}
164 },${setTrap}
165 });
166 return proxy;
168const mock = /* @__PURE__ */ ${fnName}('mock');
169export default mock;
172​
173export function loadSilentMockModule(): { code: string } {
174 return { code: generateMockCode() }
176​
177function filterExportNames(exports: ReadonlyArray<string>): Array<string> {
178 return exports.filter((n) => n.length > 0 && n !== 'default')
180​
181function generateExportLines(names: ReadonlyArray<string>): Array<string> {
182 const lines: Array<string> = []
183 const stringExports: Array<{ alias: string; name: string }> = []
184​
185 for (let i = 0; i < names.length; i++) {
186 const n = names[i]!
187 if (isValidExportName(n)) {
188 lines.push(`export const ${n} = mock.${n};`)
189 } else {
190 const alias = `__tss_str_${i}`
191 lines.push(`const ${alias} = mock[${JSON.stringify(n)}];`)
192 stringExports.push({ alias, name: n })
193 }
194 }
195​
196 if (stringExports.length > 0) {
197 const reexports = stringExports
198 .map((s) => `${s.alias} as ${JSON.stringify(s.name)}`)
199 .join(', ')
200 lines.push(`export { ${reexports} };`)
201 }
202​
203 return lines
205​
206export function generateSelfContainedMockModule(exportNames: Array<string>): {
207 code: string
208} {
209 const mockCode = generateMockCode()
210 const exportLines = generateExportLines(filterExportNames(exportNames))
211​
212 return {
213 code: `${mockCode}
214${exportLines.join('\n')}
215`,
216 }
218​
219export function generateDevSelfDenialModule(
220 exportNames: Array<string>,
221 runtimeId: string,
222): { code: string } {
223 const names = filterExportNames(exportNames)
224 const exportLines = generateExportLines(names)
225​
226 return {
227 code: `import mock from ${JSON.stringify(runtimeId)};
228${exportLines.join('\n')}
229export default mock;
230`,
231 }
233​
234export function loadMockEdgeModule(encodedPayload: string): { code: string } {
235 let payload: { exports?: Array<string>; runtimeId?: string }
236​
237 try {
238 payload = JSON.parse(fromBase64Url(encodedPayload)) as typeof payload
239 } catch {
240 payload = { exports: [] }
241 }
242​
243 const names = filterExportNames(payload.exports ?? [])
244 const runtimeId =
245 typeof payload.runtimeId === 'string' && payload.runtimeId.length > 0
246 ? payload.runtimeId
247 : MOCK_MODULE_ID
248 const exportLines = generateExportLines(names)
249​
250 return {
251 code: `import mock from ${JSON.stringify(runtimeId)};
252${exportLines.join('\n')}
253export default mock;
254`,
255 }
257​
258export function loadMockRuntimeModule(encodedPayload: string): {
259 code: string
260} {
261 let payload: {
262 mode?: string
263 env?: string
264 importer?: string
265 specifier?: string
266 trace?: Array<unknown>
267 }
268​
269 try {
270 payload = JSON.parse(fromBase64Url(encodedPayload)) as typeof payload
271 } catch {
272 payload = {}
273 }
274​
275 const mode: 'error' | 'warn' | 'off' =
276 payload.mode === 'warn' || payload.mode === 'off' ? payload.mode : 'error'
277​
278 return {
279 code: generateMockCode({
280 meta: {
281 env: String(payload.env ?? ''),
282 importer: String(payload.importer ?? ''),
283 specifier: String(payload.specifier ?? ''),
284 trace: Array.isArray(payload.trace) ? payload.trace : [],
285 },
286 mode,
287 }),
288 }
290​
291const MARKER_MODULE_RESULT = { code: 'export {}' } as const
292​
293export function loadMarkerModule(): { code: string } {
294 return MARKER_MODULE_RESULT
296​
297export {
298 MARKER_PREFIX,
299 MOCK_BUILD_PREFIX,
300 MOCK_EDGE_PREFIX,
301 MOCK_MODULE_ID,
302 MOCK_RUNTIME_PREFIX,