-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathrouterResolver.test.ts
More file actions
542 lines (465 loc) · 16.1 KB
/
routerResolver.test.ts
File metadata and controls
542 lines (465 loc) · 16.1 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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
import * as assert from "node:assert"
import { Parser } from "../../core/parser"
import { findProjectRoot } from "../../core/pathUtils"
import { buildRouterGraph } from "../../core/routerResolver"
import {
fixtures,
fixturesPath,
nodeFileSystem,
wasmBinaries,
} from "../testUtils"
suite("routerResolver", () => {
let parser: Parser
suiteSetup(async () => {
parser = new Parser()
await parser.init(wasmBinaries)
})
suiteTeardown(() => {
parser.dispose()
})
suite("buildRouterGraph", () => {
test("builds graph from main.py entry point", async () => {
const result = await buildRouterGraph(
fixtures.standard.mainPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "FastAPI")
assert.strictEqual(result.variableName, "app")
assert.strictEqual(result.filePath, fixtures.standard.mainPy)
})
test("includes direct routes on app", async () => {
const result = await buildRouterGraph(
fixtures.standard.mainPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
// app/main.py has @app.get("/health")
const healthRoute = result.routes.find((r) => r.path === "/health")
assert.ok(healthRoute)
assert.strictEqual(healthRoute.method, "get")
assert.strictEqual(healthRoute.function, "health")
})
test("follows include_router to child routers", async () => {
const result = await buildRouterGraph(
fixtures.standard.mainPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
// app/main.py includes users and items routers
assert.ok(
result.children.length >= 2,
"Should have at least 2 child routers",
)
})
test("captures prefix from router definition", async () => {
const result = await buildRouterGraph(
fixtures.standard.mainPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
// users.router has prefix="/users" in its definition
const usersChild = result.children.find(
(c) => c.router.prefix === "/users",
)
assert.ok(usersChild, "Should have child with /users prefix")
})
test("returns null for non-existent file", async () => {
const result = await buildRouterGraph(
"file:///nonexistent/file.py",
parser,
`file://${fixturesPath}`,
nodeFileSystem,
)
assert.strictEqual(result, null)
})
test("returns null for file without FastAPI/APIRouter", async () => {
const result = await buildRouterGraph(
fixtures.standard.initPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
// __init__.py has no FastAPI or APIRouter
assert.strictEqual(result, null)
})
test("builds graph from APIRouter file", async () => {
const result = await buildRouterGraph(
fixtures.standard.usersPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "APIRouter")
assert.strictEqual(result.variableName, "router")
// Should have routes (users.py has 3 routes: list, get, create)
assert.ok(result.routes.length >= 3)
})
test("includes line numbers for routes", async () => {
const result = await buildRouterGraph(
fixtures.standard.usersPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
for (const route of result.routes) {
assert.ok(route.line > 0, "Route should have valid line number")
assert.ok(route.column >= 0, "Route should have valid column number")
}
})
test("includes router location info", async () => {
const result = await buildRouterGraph(
fixtures.standard.usersPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.filePath, fixtures.standard.usersPy)
assert.ok(result.line > 0)
assert.ok(result.column >= 0)
})
test("follows __init__.py re-exports to actual router file", async () => {
const result = await buildRouterGraph(
fixtures.reexport.initPy,
parser,
fixtures.reexport.root,
nodeFileSystem,
)
assert.ok(result, "Should find router via re-export")
assert.strictEqual(result.type, "APIRouter")
assert.strictEqual(result.variableName, "router")
assert.ok(
result.filePath.endsWith("router.py"),
`Expected filePath to end with router.py, got ${result.filePath}`,
)
assert.ok(result.routes.length >= 3, "Should have routes from router.py")
const githubRoute = result.routes.find((r) => r.path === "/github")
assert.ok(githubRoute, "Should find github route")
assert.strictEqual(
result.children.length,
1,
"Should have one nested router (neon)",
)
const neonChild = result.children[0]
assert.strictEqual(neonChild.router.prefix, "/neon")
assert.ok(
neonChild.router.routes.length >= 2,
"neon router should have routes",
)
})
test("includes router when following include_router chain", async () => {
const result = await buildRouterGraph(
fixtures.standard.mainPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
// app/main.py includes users.router and items.router
assert.ok(result.children.length >= 2, "Should have child routers")
// Find the users router child
const usersChild = result.children.find(
(c) => c.router.prefix === "/users",
)
assert.ok(usersChild, "Should have users router child")
// users router should have routes
assert.ok(
usersChild.router.routes.length >= 3,
"users router should have routes",
)
})
test("prioritizes FastAPI over APIRouter in same file", async () => {
const result = await buildRouterGraph(
fixtures.sameFile.mainPy,
parser,
fixtures.sameFile.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "FastAPI")
assert.strictEqual(result.variableName, "app")
})
test("assigns routes to correct owner in same file", async () => {
const result = await buildRouterGraph(
fixtures.sameFile.mainPy,
parser,
fixtures.sameFile.root,
nodeFileSystem,
)
assert.ok(result)
// App routes should only include @app.xxx routes
const appRoutePaths = result.routes.map((r) => r.path)
assert.ok(
!appRoutePaths.includes("/items"),
"App should not have /items route (belongs to router)",
)
})
test("resolves local router as child in same file", async () => {
const result = await buildRouterGraph(
fixtures.sameFile.mainPy,
parser,
fixtures.sameFile.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(
result.children.length,
1,
"Should have one child router",
)
const apiRouter = result.children[0]
assert.strictEqual(apiRouter.router.type, "APIRouter")
assert.strictEqual(apiRouter.router.prefix, "/api")
// Router should have its own routes
const routerRoutePaths = apiRouter.router.routes.map((r) => r.path)
assert.ok(
routerRoutePaths.includes("/items"),
"Router should have /items route",
)
})
test("selects specific app by targetVariable", async () => {
// Without targetVariable, should pick first FastAPI app (public_app)
const defaultResult = await buildRouterGraph(
fixtures.multiApp.mainPy,
parser,
fixtures.multiApp.root,
nodeFileSystem,
)
assert.ok(defaultResult)
assert.strictEqual(defaultResult.variableName, "public_app")
// With targetVariable, should select admin_app
const adminResult = await buildRouterGraph(
fixtures.multiApp.mainPy,
parser,
fixtures.multiApp.root,
nodeFileSystem,
"admin_app",
)
assert.ok(adminResult)
assert.strictEqual(adminResult.variableName, "admin_app")
assert.strictEqual(adminResult.type, "FastAPI")
// admin_app has 3 routes: /, /users, /users/{user_id}
assert.strictEqual(adminResult.routes.length, 3)
const routePaths = adminResult.routes.map((r) => r.path)
assert.ok(routePaths.includes("/"))
assert.ok(routePaths.includes("/users"))
assert.ok(routePaths.includes("/users/{user_id}"))
})
test("returns null for non-existent targetVariable", async () => {
const result = await buildRouterGraph(
fixtures.multiApp.mainPy,
parser,
fixtures.multiApp.root,
nodeFileSystem,
"nonexistent_app",
)
assert.strictEqual(result, null)
})
test("resolves aliased import (from .tokens import router as tokens_router)", async () => {
const result = await buildRouterGraph(
fixtures.aliasedImport.mainPy,
parser,
fixtures.aliasedImport.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "FastAPI")
assert.strictEqual(result.variableName, "app")
assert.strictEqual(
result.children.length,
1,
"Should have one child router",
)
const tokensRouter = result.children[0]
assert.strictEqual(tokensRouter.router.type, "APIRouter")
assert.strictEqual(tokensRouter.router.prefix, "/tokens")
assert.ok(
tokensRouter.router.routes.length >= 3,
`Expected at least 3 routes, got ${tokensRouter.router.routes.length}`,
)
assert.ok(
tokensRouter.router.filePath.endsWith("tokens.py"),
`Expected filePath to end with tokens.py, got ${tokensRouter.router.filePath}`,
)
})
test("discovers nested routers (router.include_router)", async () => {
const result = await buildRouterGraph(
fixtures.nestedRouter.mainPy,
parser,
fixtures.nestedRouter.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "FastAPI")
assert.strictEqual(result.variableName, "app")
// App includes apps_router with /api prefix
assert.strictEqual(
result.children.length,
1,
"Should have one child router (apps)",
)
const appsChild = result.children[0]
assert.strictEqual(appsChild.prefix, "/api")
assert.strictEqual(appsChild.router.prefix, "/apps")
assert.strictEqual(appsChild.router.variableName, "router")
// Apps router should have its direct routes
const appsRoutes = appsChild.router.routes.map((r) => r.path)
assert.ok(appsRoutes.includes("/"), "apps router should have / route")
assert.ok(
appsRoutes.includes("/{app_id}"),
"apps router should have /{app_id} route",
)
// Apps router includes tokens_router and settings_router (nested)
assert.strictEqual(
appsChild.router.children.length,
2,
"apps router should have 2 nested routers",
)
const childPrefixes = appsChild.router.children.map(
(c) => c.router.prefix,
)
assert.ok(
childPrefixes.includes("/{app_id}/tokens"),
"Should have tokens router",
)
assert.ok(
childPrefixes.includes("/{app_id}/settings"),
"Should have settings router",
)
// Verify nested routers have their routes
const tokensChild = appsChild.router.children.find(
(c) => c.router.prefix === "/{app_id}/tokens",
)
assert.ok(tokensChild)
assert.ok(
tokensChild.router.routes.length >= 2,
"tokens router should have routes",
)
// Verify tag merging from include_router(tokens_router, tags=["tokens"])
assert.ok(
tokensChild.router.tags.includes("tokens"),
"tokens router should have merged tags from include_router call",
)
const settingsChild = appsChild.router.children.find(
(c) => c.router.prefix === "/{app_id}/settings",
)
assert.ok(settingsChild)
assert.ok(
settingsChild.router.routes.length >= 2,
"settings router should have routes",
)
})
test("follows mount() calls to subapps", async () => {
const result = await buildRouterGraph(
fixtures.standard.rootMainPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "FastAPI")
assert.strictEqual(result.variableName, "app")
// root main.py mounts sub_app at /v1
const mountChild = result.children.find((c) => c.prefix === "/v1")
assert.ok(mountChild, "Should have child mounted at /v1")
assert.strictEqual(mountChild.router.type, "FastAPI")
})
test("merges tags from include_router call with router tags", async () => {
const result = await buildRouterGraph(
fixtures.standard.mainPy,
parser,
fixtures.standard.root,
nodeFileSystem,
)
assert.ok(result)
const usersChild = result.children.find(
(c) => c.router.prefix === "/users",
)
assert.ok(usersChild, "Should have users router")
// Router has tags=["users"], include_router adds tags=["user-management"]
assert.ok(
usersChild.router.tags.includes("users"),
"Should keep router's own tags",
)
assert.ok(
usersChild.router.tags.includes("user-management"),
"Should include tags from include_router call",
)
})
test("handles circular and unresolvable imports gracefully", async () => {
const result = await buildRouterGraph(
fixtures.errorCases.mainPy,
parser,
fixtures.errorCases.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "FastAPI")
// Should still have the direct route
const rootRoute = result.routes.find((r) => r.path === "/")
assert.ok(rootRoute)
// Circular import resolves, unresolvable is skipped
assert.strictEqual(result.routes.length, 1)
})
test("discovers nested routers via __init__.py re-export", async () => {
// This tests the pattern: main.py imports from integrations (package),
// integrations/__init__.py re-exports router from router.py,
// router.py has include_router calls for nested routers
const result = await buildRouterGraph(
fixtures.reexport.mainPy,
parser,
fixtures.reexport.root,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "FastAPI")
assert.strictEqual(
result.children.length,
1,
"Should have one child router (integrations)",
)
const integrationsChild = result.children[0]
assert.strictEqual(integrationsChild.router.prefix, "/integrations")
assert.strictEqual(
integrationsChild.router.children.length,
1,
"integrations router should have nested neon router",
)
const neonChild = integrationsChild.router.children[0]
assert.strictEqual(neonChild.router.prefix, "/neon")
assert.ok(
neonChild.router.routes.length >= 2,
"neon router should have routes",
)
})
test("resolves imports in a monorepo with pyproject.toml in a subdirectory", async () => {
const projectRoot = await findProjectRoot(
fixtures.monorepo.mainPy,
fixtures.monorepo.workspaceRoot,
nodeFileSystem,
)
const result = await buildRouterGraph(
fixtures.monorepo.mainPy,
parser,
projectRoot,
nodeFileSystem,
)
assert.ok(result)
assert.strictEqual(result.type, "FastAPI")
assert.strictEqual(result.children.length, 1)
assert.strictEqual(result.children[0].router.prefix, "/users")
assert.ok(result.children[0].router.routes.length >= 2)
})
})
})