-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Expand file tree
/
Copy pathcreateServerFn.test.ts
More file actions
520 lines (467 loc) 路 16.2 KB
/
Copy pathcreateServerFn.test.ts
File metadata and controls
520 lines (467 loc) 路 16.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
import { readFile, readdir } from 'node:fs/promises'
import path from 'node:path'
import { describe, expect, test, vi } from 'vitest'
import { StartCompiler } from '../../src/start-compiler/compiler'
// Default test options for StartCompiler
function getDefaultTestOptions(env: 'client' | 'server') {
const envName = env === 'client' ? 'client' : 'ssr'
return {
envName,
root: '/test',
framework: 'react' as const,
providerEnvName: 'ssr',
}
}
async function getFilenames() {
return await readdir(path.resolve(import.meta.dirname, './test-files'))
}
const TSS_SERVERFN_SPLIT_PARAM = 'tss-serverfn-split'
async function compile(opts: {
env: 'client' | 'server'
code: string
isProviderFile: boolean
mode: 'dev' | 'build'
}) {
// Use an absolute path inside the test root to ensure consistent filename output
let id = '/test/src/test.ts'
if (opts.isProviderFile) {
id += `?${TSS_SERVERFN_SPLIT_PARAM}`
}
const compiler = new StartCompiler({
...opts,
...getDefaultTestOptions(opts.env),
loadModule: async (id) => {
// do nothing in test
},
lookupKinds: new Set(['ServerFn']),
lookupConfigurations: [
{
libName: `@tanstack/react-start`,
rootExport: 'createServerFn',
kind: 'Root',
},
],
getKnownServerFns: () => ({}),
resolveId: async (id) => {
return id
},
})
const result = await compiler.compile({
code: opts.code,
id,
})
return result
}
describe('createServerFn compiles correctly', async () => {
const filenames = await getFilenames()
describe.each(filenames)('should handle "%s"', async (filename) => {
const file = await readFile(
path.resolve(import.meta.dirname, `./test-files/${filename}`),
)
const code = file.toString()
test.each([
{ type: 'client', isProviderFile: false },
{ type: 'server', isProviderFile: false },
{ type: 'server', isProviderFile: true },
] as const)(`should compile for ${filename} %s`, async (env) => {
const result = await compile({
env: env.type,
isProviderFile: env.isProviderFile,
code,
mode: 'build',
})
const folder =
env.type === 'client'
? 'client'
: env.isProviderFile
? 'server-provider'
: 'server-caller'
await expect(result!.code).toMatchFileSnapshot(
`./snapshots/${folder}/${filename}`,
)
})
})
test('should work with identifiers of functions', async () => {
const code = `
import { createServerFn } from '@tanstack/react-start'
const myFunc = () => {
return 'hello from the server'
}
const myServerFn = createServerFn().handler(myFunc)`
const compiledResultClient = await compile({
code,
env: 'client',
isProviderFile: false,
mode: 'build',
})
// Server caller (route file - no split param)
// Should NOT have the second argument since implementation comes from extracted chunk
const compiledResultServerCaller = await compile({
code,
env: 'server',
isProviderFile: false,
mode: 'build',
})
// Server provider (extracted file - has split param)
// Should HAVE the second argument since this is the implementation file
const compiledResultServerProvider = await compile({
code,
env: 'server',
isProviderFile: true,
mode: 'build',
})
expect(compiledResultClient!.code).toMatchInlineSnapshot(`
"import { createClientRpc } from '@tanstack/react-start/client-rpc';
import { createServerFn } from '@tanstack/react-start';
const myServerFn = createServerFn().handler(createClientRpc("2c205add8e6755de551521133ddff3d48859b1631add5f1bbe5c48a5664f319b"));"
`)
// Server caller: no second argument (implementation from extracted chunk)
expect(compiledResultServerCaller!.code).toMatchInlineSnapshot(`
"import { createSsrRpc } from '@tanstack/react-start/ssr-rpc';
import { createServerFn } from '@tanstack/react-start';
const myServerFn = createServerFn().handler(createSsrRpc("2c205add8e6755de551521133ddff3d48859b1631add5f1bbe5c48a5664f319b"));"
`)
// Server provider: has second argument (this is the implementation file)
expect(compiledResultServerProvider!.code).toMatchInlineSnapshot(`
"import { createServerRpc } from '@tanstack/react-start/server-rpc';
import { createServerFn } from '@tanstack/react-start';
const myFunc = () => {
return 'hello from the server';
};
const myServerFn_createServerFn_handler = createServerRpc({
id: "2c205add8e6755de551521133ddff3d48859b1631add5f1bbe5c48a5664f319b",
name: "myServerFn",
filename: "src/test.ts"
}, opts => myServerFn.__executeServer(opts));
const myServerFn = createServerFn().handler(myServerFn_createServerFn_handler, myFunc);
export { myServerFn_createServerFn_handler };"
`)
})
test('should use dce by default', async () => {
const code = `
import { createServerFn } from '@tanstack/react-start'
const exportedVar = 'exported'
export const exportedFn = createServerFn().handler(async () => {
return exportedVar
})
const nonExportedVar = 'non-exported'
const nonExportedFn = createServerFn().handler(async () => {
return nonExportedVar
})`
// Client
const compiledResult = await compile({
code,
env: 'client',
isProviderFile: false,
mode: 'build',
})
expect(compiledResult!.code).toMatchInlineSnapshot(`
"import { createClientRpc } from '@tanstack/react-start/client-rpc';
import { createServerFn } from '@tanstack/react-start';
export const exportedFn = createServerFn().handler(createClientRpc("c306c96e9256c7604f2a6022c4c94eb89f863274c022bc45b03970f067ea9864"));
const nonExportedFn = createServerFn().handler(createClientRpc("f4403dc0b18e216dfe0a9711cab028bc1b9768175daa9236d7115e29c99d76c2"));"
`)
// Server caller (route file) - no second argument
const compiledResultServerCaller = await compile({
code,
env: 'server',
isProviderFile: false,
mode: 'build',
})
expect(compiledResultServerCaller!.code).toMatchInlineSnapshot(`
"import { createSsrRpc } from '@tanstack/react-start/ssr-rpc';
import { createServerFn } from '@tanstack/react-start';
export const exportedFn = createServerFn().handler(createSsrRpc("c306c96e9256c7604f2a6022c4c94eb89f863274c022bc45b03970f067ea9864"));
const nonExportedFn = createServerFn().handler(createSsrRpc("f4403dc0b18e216dfe0a9711cab028bc1b9768175daa9236d7115e29c99d76c2"));"
`)
// Server provider (extracted file) - has second argument
const compiledResultServerProvider = await compile({
code,
env: 'server',
isProviderFile: true,
mode: 'build',
})
expect(compiledResultServerProvider!.code).toMatchInlineSnapshot(`
"import { createServerRpc } from '@tanstack/react-start/server-rpc';
import { createServerFn } from '@tanstack/react-start';
const exportedVar = 'exported';
const exportedFn_createServerFn_handler = createServerRpc({
id: "c306c96e9256c7604f2a6022c4c94eb89f863274c022bc45b03970f067ea9864",
name: "exportedFn",
filename: "src/test.ts"
}, opts => exportedFn.__executeServer(opts));
const exportedFn = createServerFn().handler(exportedFn_createServerFn_handler, async () => {
return exportedVar;
});
const nonExportedVar = 'non-exported';
const nonExportedFn_createServerFn_handler = createServerRpc({
id: "f4403dc0b18e216dfe0a9711cab028bc1b9768175daa9236d7115e29c99d76c2",
name: "nonExportedFn",
filename: "src/test.ts"
}, opts => nonExportedFn.__executeServer(opts));
const nonExportedFn = createServerFn().handler(nonExportedFn_createServerFn_handler, async () => {
return nonExportedVar;
});
export { exportedFn_createServerFn_handler, nonExportedFn_createServerFn_handler };"
`)
})
test('should use fast path for direct imports from known library (no extra resolveId calls)', async () => {
const code = `
import { createServerFn } from '@tanstack/react-start'
const myServerFn = createServerFn().handler(async () => {
return 'hello'
})`
const resolveIdMock = vi.fn(async (id: string) => id)
const compiler = new StartCompiler({
env: 'client',
...getDefaultTestOptions('client'),
loadModule: async () => {},
lookupKinds: new Set(['ServerFn']),
lookupConfigurations: [
{
libName: '@tanstack/react-start',
rootExport: 'createServerFn',
kind: 'Root',
},
],
getKnownServerFns: () => ({}),
resolveId: resolveIdMock,
mode: 'build',
})
await compiler.compile({
code,
id: '/test/src/test.ts',
})
// Direct known-library imports use the knownRootImports fast path, so they
// do not need resolveId.
expect(resolveIdMock).not.toHaveBeenCalled()
})
test('should use slow path for factory pattern (resolveId called for import resolution)', async () => {
// This simulates a factory pattern where createServerFn is re-exported from a local file
const factoryCode = `
import { createFooServerFn } from './factory'
const myServerFn = createFooServerFn().handler(async () => {
return 'hello'
})`
const resolveIdMock = vi.fn(async (id: string) => id)
const compiler = new StartCompiler({
env: 'client',
...getDefaultTestOptions('client'),
loadModule: async (id) => {
// Simulate the factory module being loaded
if (id === './factory') {
compiler.ingestModule({
code: `
import { createServerFn } from '@tanstack/react-start'
export const createFooServerFn = createServerFn
`,
id: './factory',
})
}
},
lookupKinds: new Set(['ServerFn']),
lookupConfigurations: [
{
libName: '@tanstack/react-start',
rootExport: 'createServerFn',
kind: 'Root',
},
],
getKnownServerFns: () => ({}),
resolveId: resolveIdMock,
mode: 'build',
})
await compiler.compile({
code: factoryCode,
id: '/test/src/test.ts',
})
// resolveId should only be called for './factory'. Direct known-library
// imports use the knownRootImports fast path.
//
// Note: The factory module's import from '@tanstack/react-start' ALSO uses
// the fast path (knownRootImports), so no additional resolveId call is needed there.
expect(resolveIdMock).toHaveBeenCalledTimes(1)
expect(resolveIdMock).toHaveBeenNthCalledWith(
1,
'./factory',
'/test/src/test.ts',
)
})
test('should resolve local named re-exports of createServerFn', async () => {
const code = `
import { createFooServerFn } from './factory'
const myServerFn = createFooServerFn().handler(async () => {
return 'hello'
})`
const resolveIdMock = vi.fn(async (id: string) => id)
const compiler = new StartCompiler({
env: 'client',
...getDefaultTestOptions('client'),
loadModule: async (id) => {
if (id === './factory') {
compiler.ingestModule({
code: `
export { createServerFn as createFooServerFn } from '@tanstack/react-start'
`,
id: './factory',
})
}
},
lookupKinds: new Set(['ServerFn']),
lookupConfigurations: [
{
libName: '@tanstack/react-start',
rootExport: 'createServerFn',
kind: 'Root',
},
],
getKnownServerFns: () => ({}),
resolveId: resolveIdMock,
mode: 'build',
})
const result = await compiler.compile({
code,
id: '/test/src/test.ts',
})
expect(result).not.toBeNull()
expect(result!.code).toContain('createClientRpc')
expect(resolveIdMock).toHaveBeenCalledTimes(1)
expect(resolveIdMock).toHaveBeenNthCalledWith(
1,
'./factory',
'/test/src/test.ts',
)
})
test('should resolve export-star re-export chains of createServerFn', async () => {
const code = `
import { createFooServerFn } from './factory'
const myServerFn = createFooServerFn().handler(async () => {
return 'hello'
})`
const resolveIdMock = vi.fn(async (id: string) => id)
const compiler = new StartCompiler({
env: 'client',
...getDefaultTestOptions('client'),
loadModule: async (id) => {
if (id === './factory') {
compiler.ingestModule({
code: `
export * from './factory-inner'
`,
id: './factory',
})
}
if (id === './factory-inner') {
compiler.ingestModule({
code: `
export { createServerFn as createFooServerFn } from '@tanstack/react-start'
`,
id: './factory-inner',
})
}
},
lookupKinds: new Set(['ServerFn']),
lookupConfigurations: [
{
libName: '@tanstack/react-start',
rootExport: 'createServerFn',
kind: 'Root',
},
],
getKnownServerFns: () => ({}),
resolveId: resolveIdMock,
mode: 'build',
})
const result = await compiler.compile({
code,
id: '/test/src/test.ts',
})
expect(result).not.toBeNull()
expect(result!.code).toContain('createClientRpc')
expect(resolveIdMock).toHaveBeenCalledTimes(2)
expect(resolveIdMock).toHaveBeenNthCalledWith(
1,
'./factory',
'/test/src/test.ts',
)
expect(resolveIdMock).toHaveBeenNthCalledWith(
2,
'./factory-inner',
'./factory',
)
})
test('reuses deduped custom IDs across compiler instances', async () => {
const serverFnsById: Record<
string,
{
functionName: string
functionId: string
extractedFilename: string
filename: string
isClientReferenced?: boolean
}
> = {}
function createCompiler() {
return new StartCompiler({
env: 'server',
...getDefaultTestOptions('server'),
mode: 'build',
loadModule: async () => {},
lookupKinds: new Set(['ServerFn']),
lookupConfigurations: [
{
libName: '@tanstack/react-start',
rootExport: 'createServerFn',
kind: 'Root',
},
],
resolveId: async (id) => id,
generateFunctionId: ({ functionName }) =>
functionName === 'greetUser_createServerFn_handler'
? 'constant_id'
: undefined,
getKnownServerFns: () => serverFnsById,
onServerFnsById: (discovered) => {
Object.assign(serverFnsById, discovered)
},
})
}
const firstCompiler = createCompiler()
await firstCompiler.compile({
code: `
import { createServerFn } from '@tanstack/react-start'
export const greetUser = createServerFn().handler(async () => 'first')
`,
id: '/test/src/submit-post-formdata.tsx',
})
await firstCompiler.compile({
code: `
import { createServerFn } from '@tanstack/react-start'
export const greetUser = createServerFn().handler(async () => 'second')
`,
id: '/test/src/formdata-redirect/index.tsx',
})
expect(
Object.values(serverFnsById)
.map((serverFn) => serverFn.functionId)
.sort(),
).toEqual(['constant_id', 'constant_id_1'])
const secondCompiler = createCompiler()
const firstResult = await secondCompiler.compile({
code: `
import { createServerFn } from '@tanstack/react-start'
export const greetUser = createServerFn().handler(async () => 'first')
`,
id: '/test/src/submit-post-formdata.tsx',
})
const secondResult = await secondCompiler.compile({
code: `
import { createServerFn } from '@tanstack/react-start'
export const greetUser = createServerFn().handler(async () => 'second')
`,
id: '/test/src/formdata-redirect/index.tsx',
})
expect(firstResult!.code).toContain('createSsrRpc("constant_id"')
expect(secondResult!.code).toContain('createSsrRpc("constant_id_1"')
})
})