|
96b97a1…
|
lmata
|
1 |
""" |
|
96b97a1…
|
lmata
|
2 |
Express.js framework enricher. |
|
96b97a1…
|
lmata
|
3 |
|
|
96b97a1…
|
lmata
|
4 |
Promotes generic Function/Class nodes to semantic Express types: |
|
96b97a1…
|
lmata
|
5 |
- Route — app.get / app.post / app.put / app.delete / app.patch calls |
|
96b97a1…
|
lmata
|
6 |
- Middleware — app.use calls |
|
96b97a1…
|
lmata
|
7 |
- Controller — functions/classes defined in a controllers/ directory |
|
96b97a1…
|
lmata
|
8 |
- Router — Router() instantiations / express.Router() |
|
96b97a1…
|
lmata
|
9 |
""" |
|
96b97a1…
|
lmata
|
10 |
|
|
96b97a1…
|
lmata
|
11 |
from navegador.enrichment.base import EnrichmentResult, FrameworkEnricher |
|
96b97a1…
|
lmata
|
12 |
|
|
96b97a1…
|
lmata
|
13 |
# HTTP method prefixes that indicate a route definition |
|
e5e1a3b…
|
lmata
|
14 |
_ROUTE_PREFIXES = ( |
|
e5e1a3b…
|
lmata
|
15 |
"app.get", |
|
e5e1a3b…
|
lmata
|
16 |
"app.post", |
|
e5e1a3b…
|
lmata
|
17 |
"app.put", |
|
e5e1a3b…
|
lmata
|
18 |
"app.delete", |
|
e5e1a3b…
|
lmata
|
19 |
"app.patch", |
|
e5e1a3b…
|
lmata
|
20 |
"router.get", |
|
e5e1a3b…
|
lmata
|
21 |
"router.post", |
|
e5e1a3b…
|
lmata
|
22 |
"router.put", |
|
e5e1a3b…
|
lmata
|
23 |
"router.delete", |
|
e5e1a3b…
|
lmata
|
24 |
"router.patch", |
|
e5e1a3b…
|
lmata
|
25 |
) |
|
96b97a1…
|
lmata
|
26 |
|
|
96b97a1…
|
lmata
|
27 |
|
|
96b97a1…
|
lmata
|
28 |
class ExpressEnricher(FrameworkEnricher): |
|
96b97a1…
|
lmata
|
29 |
"""Enricher for Express.js codebases.""" |
|
96b97a1…
|
lmata
|
30 |
|
|
96b97a1…
|
lmata
|
31 |
@property |
|
96b97a1…
|
lmata
|
32 |
def framework_name(self) -> str: |
|
96b97a1…
|
lmata
|
33 |
return "express" |
|
96b97a1…
|
lmata
|
34 |
|
|
96b97a1…
|
lmata
|
35 |
@property |
|
96b97a1…
|
lmata
|
36 |
def detection_patterns(self) -> list[str]: |
|
2c266d2…
|
lmata
|
37 |
return ["express"] |
|
96b97a1…
|
lmata
|
38 |
|
|
96b97a1…
|
lmata
|
39 |
def enrich(self) -> EnrichmentResult: |
|
96b97a1…
|
lmata
|
40 |
result = EnrichmentResult() |
|
96b97a1…
|
lmata
|
41 |
|
|
96b97a1…
|
lmata
|
42 |
# ── Routes: app.<method> or router.<method> patterns ───────────────── |
|
e5e1a3b…
|
lmata
|
43 |
route_rows = ( |
|
e5e1a3b…
|
lmata
|
44 |
self.store.query( |
|
e5e1a3b…
|
lmata
|
45 |
"MATCH (n) WHERE (n.name STARTS WITH 'app.get' " |
|
e5e1a3b…
|
lmata
|
46 |
"OR n.name STARTS WITH 'app.post' " |
|
e5e1a3b…
|
lmata
|
47 |
"OR n.name STARTS WITH 'app.put' " |
|
e5e1a3b…
|
lmata
|
48 |
"OR n.name STARTS WITH 'app.delete' " |
|
e5e1a3b…
|
lmata
|
49 |
"OR n.name STARTS WITH 'app.patch' " |
|
e5e1a3b…
|
lmata
|
50 |
"OR n.name STARTS WITH 'router.get' " |
|
e5e1a3b…
|
lmata
|
51 |
"OR n.name STARTS WITH 'router.post' " |
|
e5e1a3b…
|
lmata
|
52 |
"OR n.name STARTS WITH 'router.put' " |
|
e5e1a3b…
|
lmata
|
53 |
"OR n.name STARTS WITH 'router.delete' " |
|
e5e1a3b…
|
lmata
|
54 |
"OR n.name STARTS WITH 'router.patch') " |
|
e5e1a3b…
|
lmata
|
55 |
"AND n.file_path IS NOT NULL " |
|
e5e1a3b…
|
lmata
|
56 |
"RETURN n.name, n.file_path", |
|
e5e1a3b…
|
lmata
|
57 |
).result_set |
|
e5e1a3b…
|
lmata
|
58 |
or [] |
|
e5e1a3b…
|
lmata
|
59 |
) |
|
96b97a1…
|
lmata
|
60 |
for name, file_path in route_rows: |
|
96b97a1…
|
lmata
|
61 |
self._promote_node(name, file_path, "ExpressRoute") |
|
96b97a1…
|
lmata
|
62 |
result.promoted += 1 |
|
96b97a1…
|
lmata
|
63 |
result.patterns_found["routes"] = len(route_rows) |
|
96b97a1…
|
lmata
|
64 |
|
|
96b97a1…
|
lmata
|
65 |
# ── Middleware: app.use calls ───────────────────────────────────────── |
|
e5e1a3b…
|
lmata
|
66 |
middleware_rows = ( |
|
e5e1a3b…
|
lmata
|
67 |
self.store.query( |
|
e5e1a3b…
|
lmata
|
68 |
"MATCH (n) WHERE (n.name STARTS WITH 'app.use' " |
|
e5e1a3b…
|
lmata
|
69 |
"OR n.name STARTS WITH 'router.use') " |
|
e5e1a3b…
|
lmata
|
70 |
"AND n.file_path IS NOT NULL " |
|
e5e1a3b…
|
lmata
|
71 |
"RETURN n.name, n.file_path", |
|
e5e1a3b…
|
lmata
|
72 |
).result_set |
|
e5e1a3b…
|
lmata
|
73 |
or [] |
|
e5e1a3b…
|
lmata
|
74 |
) |
|
96b97a1…
|
lmata
|
75 |
for name, file_path in middleware_rows: |
|
96b97a1…
|
lmata
|
76 |
self._promote_node(name, file_path, "ExpressMiddleware") |
|
96b97a1…
|
lmata
|
77 |
result.promoted += 1 |
|
96b97a1…
|
lmata
|
78 |
result.patterns_found["middleware"] = len(middleware_rows) |
|
96b97a1…
|
lmata
|
79 |
|
|
96b97a1…
|
lmata
|
80 |
# ── Controllers: nodes whose file_path contains /controllers/ ───────── |
|
e5e1a3b…
|
lmata
|
81 |
controller_rows = ( |
|
e5e1a3b…
|
lmata
|
82 |
self.store.query( |
|
e5e1a3b…
|
lmata
|
83 |
"MATCH (n) WHERE n.file_path CONTAINS '/controllers/' " |
|
e5e1a3b…
|
lmata
|
84 |
"AND n.name IS NOT NULL " |
|
e5e1a3b…
|
lmata
|
85 |
"RETURN n.name, n.file_path", |
|
e5e1a3b…
|
lmata
|
86 |
).result_set |
|
e5e1a3b…
|
lmata
|
87 |
or [] |
|
e5e1a3b…
|
lmata
|
88 |
) |
|
96b97a1…
|
lmata
|
89 |
for name, file_path in controller_rows: |
|
96b97a1…
|
lmata
|
90 |
self._promote_node(name, file_path, "ExpressController") |
|
96b97a1…
|
lmata
|
91 |
result.promoted += 1 |
|
96b97a1…
|
lmata
|
92 |
result.patterns_found["controllers"] = len(controller_rows) |
|
96b97a1…
|
lmata
|
93 |
|
|
96b97a1…
|
lmata
|
94 |
# ── Routers: Router() / express.Router() instantiations ────────────── |
|
e5e1a3b…
|
lmata
|
95 |
router_rows = ( |
|
e5e1a3b…
|
lmata
|
96 |
self.store.query( |
|
e5e1a3b…
|
lmata
|
97 |
"MATCH (n) WHERE (n.name = 'Router' OR n.name CONTAINS 'Router()' " |
|
e5e1a3b…
|
lmata
|
98 |
"OR n.name CONTAINS 'express.Router') " |
|
e5e1a3b…
|
lmata
|
99 |
"AND n.file_path IS NOT NULL " |
|
e5e1a3b…
|
lmata
|
100 |
"RETURN n.name, n.file_path", |
|
e5e1a3b…
|
lmata
|
101 |
).result_set |
|
e5e1a3b…
|
lmata
|
102 |
or [] |
|
e5e1a3b…
|
lmata
|
103 |
) |
|
96b97a1…
|
lmata
|
104 |
for name, file_path in router_rows: |
|
96b97a1…
|
lmata
|
105 |
self._promote_node(name, file_path, "ExpressRouter") |
|
96b97a1…
|
lmata
|
106 |
result.promoted += 1 |
|
96b97a1…
|
lmata
|
107 |
result.patterns_found["routers"] = len(router_rows) |
|
96b97a1…
|
lmata
|
108 |
|
|
96b97a1…
|
lmata
|
109 |
return result |