Spaces:
Sleeping
Sleeping
File size: 72,600 Bytes
3786a3f | 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 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 | # Backend Completion Plan β GraphRAG Knowledge AI
**Created:** 2026-07-08
**Scope:** Backend only (`/backend/` directory)
**Duration:** 2 days (Phase 01 + Phase 02)
**Goal:** 20/20 endpoints PASS, all bugs fixed, security hardened
---
## Current State Summary
| Category | Count | Status |
|----------|-------|--------|
| Endpoints PASS | 7/20 | 35% β auth, upload, list, delete, query, cypher, path |
| Endpoints MISSING | 9/20 | 45% β compare, graph, entity, stats, communities, search, evaluation, health, dedicated graph/vector URLs |
| Endpoints WRONG URL | 2/20 | path + cypher at `/query/` instead of `/graph/` |
| Endpoints FUNCTIONAL EQUIVALENT | 2/20 | graph-only + vector-only achievable via mode param |
| Bugs | 9 | Critical: Neo4j auth, Cypher injection, error leaks, singleton |
| Empty Files | 2 | community_detector.py, admin.py |
| Unused Models | 2 | QueryLog, EvaluationPair |
---
# PHASE 01 β Day 1: Critical Bugs + Missing Endpoints + Community Detection
**Estimated Total Time: 8β10 hours**
**Deliverable:** All 9 bugs fixed, community detection working, 15+ endpoints functional
---
## Task 1.1 β Fix Neo4j Auth Bug (CRITICAL)
**File:** `graphrag/services/neo4j_client.py`
**Time:** 15 minutes
**Priority:** P0 β Blocks ALL Neo4j operations
### What's Wrong
```python
# Line 22 β WRONG: settings has NEO4J_USERNAME, client reads NEO4J_USER
self.user = getattr(settings, 'NEO4J_USER', 'neo4j') # β BUG
```
```python
# Line 13 β WRONG: super().__new__ receives *args, **kwargs it shouldn't
cls._instance = super().__new__(cls, *args, **kwargs) # β BUG
```
### Fix
```python
# Line 10-14: Fix singleton __new__
def __new__(cls, *args, **kwargs):
if not cls._instance:
cls._instance = super().__new__(cls) # No *args, **kwargs
return cls._instance
# Line 22: Fix setting name
self.user = getattr(settings, 'NEO4J_USERNAME', 'neo4j') # β FIXED
```
### Verification
- Run: `python manage.py shell -c "from graphrag.services.neo4j_client import Neo4jClient; c = Neo4jClient(); print(c.user)"`
- Expected: prints `neo4j` (from settings.NEO4J_USERNAME)
---
## Task 1.2 β Add Missing Neo4j Methods
**File:** `graphrag/services/neo4j_client.py`
**Time:** 45 minutes
**Priority:** P0 β Required by endpoints #11, #12, #15, #18
### Methods to Add
```python
def get_all_graph_data(self, user_id):
"""
Returns all nodes and relationships for frontend visualization.
Endpoint #11: GET /api/graph/
"""
nodes_query = (
"MATCH (e:Entity {user_id: $user_id}) "
"RETURN e.name AS name, e.type AS type, e.description AS description, "
" e.source_doc AS source_doc, e.page AS page "
"LIMIT 500"
)
edges_query = (
"MATCH (s:Entity {user_id: $user_id})-[r]->(t:Entity {user_id: $user_id}) "
"RETURN s.name AS source, t.name AS target, "
" type(r) AS relationship_type, r.description AS description, "
" r.confidence AS confidence, r.source_doc AS source_doc "
"LIMIT 1000"
)
try:
nodes = self.execute_query(nodes_query, {"user_id": str(user_id)})
edges = self.execute_query(edges_query, {"user_id": str(user_id)})
return {"nodes": nodes, "edges": edges}
except Exception as e:
logger.error("Failed to get all graph data: %s", str(e))
return {"nodes": [], "edges": []}
def get_entity_details(self, name, user_id):
"""
Returns entity details + direct subgraph for a specific entity.
Endpoint #12: GET /api/graph/entity/{name}/
"""
entity_query = (
"MATCH (e:Entity {name: $name, user_id: $user_id}) "
"RETURN e.name AS name, e.type AS type, e.description AS description, "
" e.source_doc AS source_doc, e.page AS page"
)
rels_query = (
"MATCH (e:Entity {name: $name, user_id: $user_id})-[r]-(neighbor:Entity {user_id: $user_id}) "
"RETURN neighbor.name AS neighbor_name, neighbor.type AS neighbor_type, "
" type(r) AS relationship_type, r.description AS description, "
" r.confidence AS confidence, "
" CASE WHEN startNode(r) = e THEN 'outgoing' ELSE 'incoming' END AS direction "
"LIMIT 50"
)
try:
entities = self.execute_query(entity_query, {"name": name, "user_id": str(user_id)})
if not entities:
return None
relationships = self.execute_query(rels_query, {"name": name, "user_id": str(user_id)})
return {
"entity": entities[0],
"relationships": relationships
}
except Exception as e:
logger.error("Failed to get entity details for '%s': %s", name, str(e))
return None
def search_entities(self, search_term, user_id, limit=20):
"""
Searches entities by name (case-insensitive contains) or description.
Endpoint #18: POST /api/graph/search/
"""
query = (
"MATCH (e:Entity {user_id: $user_id}) "
"WHERE toLower(e.name) CONTAINS toLower($search_term) "
" OR toLower(e.description) CONTAINS toLower($search_term) "
"RETURN e.name AS name, e.type AS type, e.description AS description, "
" e.source_doc AS source_doc "
"LIMIT $limit"
)
try:
return self.execute_query(query, {
"search_term": search_term,
"user_id": str(user_id),
"limit": limit
})
except Exception as e:
logger.error("Failed to search entities: %s", str(e))
return []
```
### Verification
- Each method should execute against Neo4j without errors
- `get_all_graph_data()` returns `{"nodes": [...], "edges": [...]}` format
- `search_entities("Google", user_id)` returns matching entities
---
## Task 1.3 β Fix Cypher Injection Vulnerability
**File:** `graphrag/services/nl_to_cypher.py`
**Time:** 30 minutes
**Priority:** P0 β Security: injection risk
### What's Wrong
No validation on the LLM-generated Cypher. An LLM could generate `DETACH DELETE` or `CREATE` operations.
### Fix β Add Post-Generation Validation
```python
import re
class NLToCypher:
FORBIDDEN_KEYWORDS = [
'MERGE', 'CREATE', 'SET', 'DELETE', 'REMOVE', 'DETACH',
'DROP', 'ALTER', 'INSERT', 'UPDATE', 'WRITE'
]
def _validate_read_only(self, cypher: str) -> bool:
"""
Returns True if the Cypher is read-only, False if it contains write operations.
"""
cypher_upper = cypher.upper()
# Split into words to avoid false positives (e.g., 'RESET' contains 'SET')
words = re.findall(r'\b\w+\b', cypher_upper)
for keyword in self.FORBIDDEN_KEYWORDS:
if keyword in words:
return False
return True
def execute_nl_query(self, question: str, user_id: str) -> Dict[str, Any]:
# ... existing code ...
result: CypherQuery = self.chain.invoke({"question": question})
# VALIDATION: Ensure read-only
if not self._validate_read_only(result.cypher):
logger.warning("BLOCKED write Cypher query: %s", result.cypher)
return {
"cypher": result.cypher,
"explanation": "Query blocked: only read-only Cypher queries are allowed.",
"records": [],
"success": False,
"error": "Generated query contains write operations. Only read queries are permitted."
}
# ... rest of existing code ...
```
### Verification
- Attempt to generate Cypher with injection payload
- Confirm write operations are blocked and logged
- Confirm legitimate read queries still pass
---
## Task 1.4 β Fix Error Message Information Leaks
**File:** `graphrag/views.py`
**Time:** 20 minutes
**Priority:** P0 β Security: internal error details exposed
### What's Wrong
```python
# Lines 202, 237, 268 β All leak str(e) to the client
return Response(
{"error": f"Internal Server Error: {str(e)}"},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
```
### Fix
```python
# Replace ALL instances of str(e) leak with safe messages:
# In QueryView (line ~202):
except Exception as e:
logger.error("Error in QueryView: %s", str(e), exc_info=True)
return Response(
{"error": "An internal error occurred while processing your query."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# In CypherQueryView (line ~237):
except Exception as e:
logger.error("Error in CypherQueryView: %s", str(e), exc_info=True)
return Response(
{"error": "An internal error occurred while translating your query."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# In ShortestPathView (line ~268):
except Exception as e:
logger.error("Error in ShortestPathView: %s", str(e), exc_info=True)
return Response(
{"error": "An internal error occurred while finding the path."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# In DocumentViewSet.destroy (line ~163):
except Exception as e:
logger.error("Failed to delete document: %s. Error: %s", doc.id, str(e), exc_info=True)
return Response(
{"error": "Failed to delete document."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
```
### Verification
- Trigger a 500 error in tests
- Confirm response contains NO internal details (no stack traces, no DB errors)
- Confirm the error IS logged server-side with full details
---
## Task 1.5 β Fix Settings Security Issues
**File:** `config/settings.py`
**Time:** 15 minutes
**Priority:** P0 β Security: production-readiness
### Fixes
```python
# Line 16: DEBUG should default to False in production
DEBUG = os.getenv('DEBUG', 'False') == 'True' # Changed from 'True'
# Line 109: CORS should be restricted
CORS_ALLOW_ALL_ORIGINS = False
CORS_ALLOWED_ORIGINS = [
origin.strip()
for origin in os.getenv('CORS_ALLOWED_ORIGINS', 'http://localhost:3000').split(',')
if origin.strip()
]
# Lines 122-136: JWT access token lifetime too long
SIMPLE_JWT = {
'ACCESS_TOKEN_LIFETIME': timedelta(minutes=30), # Changed from days=1
'REFRESH_TOKEN_LIFETIME': timedelta(days=7),
# ... rest unchanged
}
```
### Verification
- Confirm DEBUG=False by default
- Confirm CORS blocks unrecognized origins
- Confirm JWT access tokens expire in 30 minutes
---
## Task 1.6 β Fix vector_retriever.py Page Metadata Bug
**File:** `graphrag/services/vector_retriever.py`
**Time:** 10 minutes
**Priority:** P2 β Data correctness
### What's Wrong
```python
# Line 64: Page metadata is arbitrary β divides index by 2
metadatas = [{"source_doc": doc_name, "page": (i // 2) + 1} for i in range(len(chunks))]
```
### Fix
```python
# Use actual chunk numbering (page tracking comes from graph_builder.py context)
metadatas = [
{"source_doc": doc_name, "page": i + 1, "chunk_index": i}
for i in range(len(chunks))
]
```
### Verification
- Upload a document, query ChromaDB metadata
- Confirm chunk_index increments correctly
---
## Task 1.7 β Fix graph_retriever.py Node ID Bug
**File:** `graphrag/services/graph_retriever.py`
**Time:** 15 minutes
**Priority:** P1 β Correctness: relationship parsing
### What's Wrong
```python
# Lines 122-123: rel.start_node.id returns an internal Neo4j ID, NOT an index into nodes[]
start_node = nodes[rel.start_node.id if hasattr(rel.start_node, 'id') else 0]
end_node = nodes[rel.end_node.id if hasattr(rel.end_node, 'id') else 0]
```
This indexes into `nodes[]` using Neo4j's internal ID, which is wrong.
### Fix
```python
# Use the path's node list and find nodes by matching properties
# The path object already has the correct node ordering
def _parse_subgraph_paths(self, paths, unique_nodes, unique_rels):
for record in paths:
path_obj = record.get("path")
if not path_obj:
continue
nodes = path_obj.nodes
relationships = path_obj.relationships
# Parse nodes
for node in nodes:
properties = dict(node)
name = properties.get("name")
if name:
unique_nodes[name] = {
"type": properties.get("type", "Unknown"),
"description": properties.get("description", "")
}
# Parse relationships β use relationship properties to get source/target names
for rel in relationships:
# The relationship object contains start_node and end_node references
# Use their properties directly, not array indexing
start_props = dict(rel.start_node) if hasattr(rel, 'start_node') else {}
end_props = dict(rel.end_node) if hasattr(rel, 'end_node') else {}
start_name = start_props.get("name", "Unknown")
end_name = end_props.get("name", "Unknown")
rel_type = rel.type
rel_props = dict(rel)
desc = rel_props.get("description", "")
conf = rel_props.get("confidence", 1.0)
desc_suffix = f" (Details: {desc})" if desc else ""
rel_str = (
f"[{start_props.get('type', 'Entity')}] **{start_name}** "
f"--[{rel_type} (Confidence: {conf})]--> "
f"[{end_props.get('type', 'Entity')}] **{end_name}**{desc_suffix}"
)
unique_rels.add(rel_str)
```
### Verification
- Upload a document with multiple relationships
- Query graph context for an entity
- Confirm relationships parse correctly without IndexError
---
## Task 1.8 β Implement community_detector.py
**File:** `graphrag/services/community_detector.py`
**Time:** 90 minutes
**Priority:** P1 β Assignment requirement (endpoints #16, #17)
### Full Implementation
```python
import logging
from typing import List, Dict, Any, Optional
from collections import defaultdict
from .neo4j_client import Neo4jClient
from .llm_client import get_llm
from langchain_core.prompts import ChatPromptTemplate
logger = logging.getLogger(__name__)
class CommunityDetector:
"""
Detects communities/clusters in the knowledge graph using
Label Propagation algorithm (simpler than Louvain, works well for Neo4j),
then uses LLM to generate descriptive labels and summaries.
"""
def __init__(self):
logger.info("Initializing CommunityDetector service.")
self.neo4j_client = Neo4jClient()
self.llm = get_llm(temperature=0.3)
self._community_cache = {} # user_id -> communities
def detect_communities(self, user_id: str) -> List[Dict[str, Any]]:
"""
Runs Label Propagation community detection on the user's subgraph.
Returns list of community dicts with id, members, and labels.
"""
logger.info("Running community detection for user: %s", user_id)
# 1. Fetch the graph structure (adjacency list)
edges_query = (
"MATCH (a:Entity {user_id: $user_id})-[r]-(b:Entity {user_id: $user_id}) "
"RETURN a.name AS source, b.name AS target"
)
edges = self.neo4j_client.execute_query(edges_query, {"user_id": str(user_id)})
if not edges:
logger.info("No edges found. Cannot detect communities.")
return []
# 2. Build adjacency list
adjacency = defaultdict(set)
all_nodes = set()
for edge in edges:
adjacency[edge["source"]].add(edge["target"])
adjacency[edge["target"]].add(edge["source"])
all_nodes.add(edge["source"])
all_nodes.add(edge["target"])
# 3. Label Propagation Algorithm (synchronous)
communities = self._label_propagation(all_nodes, adjacency)
# 4. Fetch entity details for each community
entity_details = self._fetch_entity_details(list(all_nodes), user_id)
# 5. Build community objects
community_list = []
for comm_id, members in communities.items():
if len(members) < 2:
continue # Skip singleton communities
member_details = [
entity_details.get(m, {"name": m, "type": "Unknown", "description": ""})
for m in members
]
community_list.append({
"id": comm_id,
"members": members,
"member_count": len(members),
"member_details": member_details
})
# 6. Generate LLM labels and summaries for each community
for comm in community_list:
label_summary = self._generate_community_label_summary(comm)
comm["label"] = label_summary.get("label", f"Community {comm['id']}")
comm["summary"] = label_summary.get("summary", "")
logger.info("Detected %d communities for user: %s", len(community_list), user_id)
self._community_cache[str(user_id)] = community_list
return community_list
def _label_propagation(self, nodes: set, adjacency: dict, max_iterations: int = 20) -> Dict[int, set]:
"""
Synchronous Label Propagation algorithm.
Each node starts with its own label. Labels propagate through edges.
Converges when no label changes.
"""
# Initialize: each node gets its own label
labels = {node: node for node in nodes}
for iteration in range(max_iterations):
new_labels = {}
changed = False
for node in nodes:
if not adjacency[node]:
new_labels[node] = labels[node]
continue
# Count labels among neighbors
label_counts = defaultdict(int)
for neighbor in adjacency[node]:
label_counts[labels[neighbor]] += 1
# Pick the most common label (ties broken by random/deterministic)
max_count = max(label_counts.values())
candidates = [l for l, c in label_counts.items() if c == max_count]
new_label = min(candidates) # Deterministic: pick smallest
if new_labels.get(node, None) != new_label:
changed = True
new_labels[node] = new_label
labels = new_labels
if not changed:
logger.info("Label Propagation converged after %d iterations.", iteration + 1)
break
# Group nodes by their final label
communities = defaultdict(set)
for node, label in labels.items():
communities[label].add(node)
return dict(communities)
def _fetch_entity_details(self, names: List[str], user_id: str) -> Dict[str, dict]:
"""Fetch entity type and description for a list of entity names."""
if not names:
return {}
query = (
"MATCH (e:Entity {user_id: $user_id}) "
"WHERE e.name IN $names "
"RETURN e.name AS name, e.type AS type, e.description AS description"
)
try:
records = self.neo4j_client.execute_query(query, {
"user_id": str(user_id),
"names": names
})
return {r["name"]: r for r in records}
except Exception as e:
logger.error("Failed to fetch entity details: %s", str(e))
return {}
def _generate_community_label_summary(self, community: Dict) -> Dict[str, str]:
"""Uses LLM to generate a descriptive label and summary for a community."""
members_text = "\n".join([
f"- {m['name']} ({m.get('type', 'Unknown')}): {m.get('description', 'No description')}"
for m in community["member_details"]
])
prompt = ChatPromptTemplate.from_messages([
("system", (
"You are an expert at analyzing knowledge graph communities.\n"
"Given a list of entities in a community cluster, generate:\n"
"1. A short descriptive label (2-5 words) summarizing the community theme\n"
"2. A 2-3 paragraph summary describing what this community represents, "
"how the entities relate, and what themes they represent.\n\n"
"Be factual and grounded in the entity descriptions."
)),
("human", (
"Community with {count} members:\n\n{members}\n\n"
"Generate a label and summary."
))
])
try:
chain = prompt | self.llm
response = chain.invoke({
"count": community["member_count"],
"members": members_text
})
# Parse response β expect "Label: ...\n\nSummary: ..."
text = response.content.strip()
lines = text.split("\n", 1)
label = lines[0].strip().lstrip("#").strip()
summary = lines[1].strip() if len(lines) > 1 else ""
return {"label": label, "summary": summary}
except Exception as e:
logger.error("Failed to generate community label: %s", str(e))
return {"label": f"Community {community['id']}", "summary": ""}
def get_community_by_id(self, community_id: int, user_id: str) -> Optional[Dict]:
"""Returns a single community by ID, re-detecting if cache is empty."""
cached = self._community_cache.get(str(user_id), [])
if not cached:
cached = self.detect_communities(user_id)
for comm in cached:
if comm["id"] == community_id:
return comm
return None
def get_all_communities(self, user_id: str) -> List[Dict]:
"""Returns all communities, using cache if available."""
cached = self._community_cache.get(str(user_id), [])
if not cached:
cached = self.detect_communities(user_id)
return cached
```
### Verification
- Upload a document with rich relationships
- Call `detect_communities(user_id)`
- Confirm returns list of communities with labels and summaries
- Confirm community member counts are reasonable
---
## Task 1.9 β Implement admin.py
**File:** `graphrag/admin.py`
**Time:** 10 minutes
**Priority:** P1 β Assignment requirement
### Implementation
```python
from django.contrib import admin
from .models import User, Document, QueryLog, EvaluationPair
@admin.register(User)
class UserAdmin(admin.ModelAdmin):
list_display = ('username', 'email', 'is_staff', 'date_joined')
search_fields = ('username', 'email')
@admin.register(Document)
class DocumentAdmin(admin.ModelAdmin):
list_display = ('name', 'user', 'status', 'entity_count', 'relationship_count', 'created_at')
list_filter = ('status', 'created_at')
search_fields = ('name',)
readonly_fields = ('entity_count', 'relationship_count', 'error_message')
@admin.register(QueryLog)
class QueryLogAdmin(admin.ModelAdmin):
list_display = ('query_text', 'user', 'retrieval_mode', 'response_time', 'created_at')
list_filter = ('retrieval_mode', 'created_at')
search_fields = ('query_text',)
@admin.register(EvaluationPair)
class EvaluationPairAdmin(admin.ModelAdmin):
list_display = ('question', 'user', 'is_active', 'created_at')
list_filter = ('is_active', 'created_at')
search_fields = ('question',)
```
### Verification
- Run: `python manage.py migrate` (if needed)
- Access `/admin/` β confirm all 4 models appear
- Confirm list views display correct columns
---
## Task 1.10 β Fix graph_retriever.py + add get_entity_subgraph serialization
**File:** `graphrag/services/graph_retriever.py`
**Time:** 20 minutes (already partially covered in Task 1.7)
**Priority:** P1
This is the complete fix including the serialization for the frontend (nodes + edges JSON format):
```python
def get_graph_as_json(self, user_id: str) -> Dict[str, Any]:
"""
Serializes the full graph as JSON for frontend visualization.
Endpoint #11: GET /api/graph/
"""
raw_data = self.neo4j_client.get_all_graph_data(user_id)
# Assign numeric IDs for vis.js / react-force-graph
node_id_map = {}
nodes = []
for i, node in enumerate(raw_data["nodes"]):
node_id_map[node["name"]] = i
nodes.append({
"id": i,
"label": node["name"],
"type": node.get("type", "Unknown"),
"description": node.get("description", ""),
"source_doc": node.get("source_doc", ""),
"page": node.get("page", 0)
})
edges = []
for edge in raw_data["edges"]:
source_id = node_id_map.get(edge["source"])
target_id = node_id_map.get(edge["target"])
if source_id is not None and target_id is not None:
edges.append({
"source": source_id,
"target": target_id,
"label": edge["relationship_type"],
"description": edge.get("description", ""),
"confidence": edge.get("confidence", 1.0),
"source_doc": edge.get("source_doc", "")
})
return {"nodes": nodes, "edges": edges}
```
---
# PHASE 02 β Day 2: Remaining Endpoints + Security Hardening + Testing
**Estimated Total Time: 8β10 hours**
**Deliverable:** All 20 endpoints PASS, security hardened, comprehensive tests
---
## Task 2.1 β Add Query Logging to All Query Endpoints
**File:** `graphrag/views.py`
**Time:** 30 minutes
**Priority:** P1 β Assignment requirement (QueryLog model is defined but never used)
### Implementation
```python
import time
from .models import QueryLog
# Add to imports at top of views.py
# Modify QueryView.post:
class QueryView(APIView):
permission_classes = [IsAuthenticated]
def post(self, request):
query = request.data.get("query")
mode = request.data.get("mode", "hybrid")
if not query or not query.strip():
return Response(
{"error": "The 'query' field is required and cannot be empty."},
status=status.HTTP_400_BAD_REQUEST
)
logger.info("Executing RAG Query for user: %s | Mode: %s", request.user.username, mode)
start_time = time.time()
try:
rag_chain = RAGChain()
result = rag_chain.generate_answer(query, request.user.id, mode)
elapsed = time.time() - start_time
# Log query
QueryLog.objects.create(
user=request.user,
query_text=query,
retrieval_mode=mode.upper(),
answer_text=result.get("answer", ""),
response_time=round(elapsed, 3)
)
if result.get("success", False):
return Response(result, status=status.HTTP_200_OK)
else:
return Response(
{"error": "Failed to generate RAG response."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
except Exception as e:
elapsed = time.time() - start_time
logger.error("Error in QueryView: %s", str(e), exc_info=True)
# Log failed query too
QueryLog.objects.create(
user=request.user,
query_text=query,
retrieval_mode=mode.upper(),
answer_text="ERROR",
response_time=round(elapsed, 3)
)
return Response(
{"error": "An internal error occurred while processing your query."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
```
### Verification
- Run a query, check `QueryLog` table has a new row
- Confirm `response_time` is reasonable (not 0, not 1000)
---
## Task 2.2 β Add File Upload Validation
**File:** `graphrag/views.py` (DocumentUploadView)
**Time:** 20 minutes
**Priority:** P1 β Security: reject dangerous files
### Implementation
```python
ALLOWED_EXTENSIONS = {'.pdf', '.txt', '.md', '.docx', '.doc', '.csv', '.json', '.html', '.xml'}
MAX_FILE_SIZE_MB = 10
class DocumentUploadView(APIView):
permission_classes = [IsAuthenticated]
def post(self, request):
if 'file' not in request.FILES:
return Response(
{"error": "No file was uploaded."},
status=status.HTTP_400_BAD_REQUEST
)
file_obj = request.FILES['file']
# 1. Validate file extension
import os
ext = os.path.splitext(file_obj.name)[1].lower()
if ext not in ALLOWED_EXTENSIONS:
return Response(
{"error": f"File type '{ext}' is not allowed. Supported: {', '.join(sorted(ALLOWED_EXTENSIONS))}"},
status=status.HTTP_400_BAD_REQUEST
)
# 2. Validate file size
if file_obj.size > MAX_FILE_SIZE_MB * 1024 * 1024:
return Response(
{"error": f"File size exceeds {MAX_FILE_SIZE_MB}MB limit."},
status=status.HTTP_413_REQUEST_ENTITY_TOO_LARGE
)
# 3. Validate file is not empty
if file_obj.size == 0:
return Response(
{"error": "Empty files are not allowed."},
status=status.HTTP_400_BAD_REQUEST
)
# ... rest of existing code ...
```
### Verification
- Upload `.exe` file β 400
- Upload 15MB file β 413
- Upload empty file β 400
- Upload `.pdf` β 202
---
## Task 2.3 β Create Missing Endpoints (views.py additions)
**File:** `graphrag/views.py`
**Time:** 90 minutes
**Priority:** P0 β 9 missing/wrong-URL endpoints
### New Views to Add
```python
import time
import logging
from rest_framework import status
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.permissions import AllowAny, IsAuthenticated
from django.db.models import Avg, Count
from .models import QueryLog, EvaluationPair
from .serializers import (
QueryLogSerializer, EvaluationPairSerializer
)
from .services.rag_chain import RAGChain
from .services.graph_retriever import GraphRetriever
from .services.vector_retriever import VectorRetriever
from .services.hybrid_retriever import HybridRetriever
from .services.nl_to_cypher import NLToCypher
from .services.multihop_reasoner import MultiHopReasoner
from .services.community_detector import CommunityDetector
from .services.neo4j_client import Neo4jClient
logger = logging.getLogger(__name__)
# ============================================================
# Endpoint #8: POST /api/query/graph-only/
# ============================================================
class GraphOnlyQueryView(APIView):
"""Dedicated endpoint for graph-only retrieval."""
permission_classes = [IsAuthenticated]
def post(self, request):
query = request.data.get("query")
if not query or not query.strip():
return Response(
{"error": "The 'query' field is required and cannot be empty."},
status=status.HTTP_400_BAD_REQUEST
)
start_time = time.time()
try:
rag_chain = RAGChain()
result = rag_chain.generate_answer(query, request.user.id, mode="graph")
elapsed = time.time() - start_time
# Log
QueryLog.objects.create(
user=request.user, query_text=query,
retrieval_mode='GRAPH',
answer_text=result.get("answer", ""),
response_time=round(elapsed, 3)
)
if result.get("success", False):
return Response(result, status=status.HTTP_200_OK)
return Response(
{"error": "Failed to generate graph retrieval response."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
except Exception as e:
logger.error("Error in GraphOnlyQueryView: %s", str(e), exc_info=True)
return Response(
{"error": "An internal error occurred during graph retrieval."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #9: POST /api/query/vector-only/
# ============================================================
class VectorOnlyQueryView(APIView):
"""Dedicated endpoint for vector-only retrieval."""
permission_classes = [IsAuthenticated]
def post(self, request):
query = request.data.get("query")
if not query or not query.strip():
return Response(
{"error": "The 'query' field is required and cannot be empty."},
status=status.HTTP_400_BAD_REQUEST
)
start_time = time.time()
try:
rag_chain = RAGChain()
result = rag_chain.generate_answer(query, request.user.id, mode="vector")
elapsed = time.time() - start_time
QueryLog.objects.create(
user=request.user, query_text=query,
retrieval_mode='VECTOR',
answer_text=result.get("answer", ""),
response_time=round(elapsed, 3)
)
if result.get("success", False):
return Response(result, status=status.HTTP_200_OK)
return Response(
{"error": "Failed to generate vector retrieval response."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
except Exception as e:
logger.error("Error in VectorOnlyQueryView: %s", str(e), exc_info=True)
return Response(
{"error": "An internal error occurred during vector retrieval."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #10: POST /api/query/compare/
# ============================================================
class QueryCompareView(APIView):
"""Runs all 3 retrieval modes and returns side-by-side comparison."""
permission_classes = [IsAuthenticated]
def post(self, request):
query = request.data.get("query")
if not query or not query.strip():
return Response(
{"error": "The 'query' field is required and cannot be empty."},
status=status.HTTP_400_BAD_REQUEST
)
try:
rag_chain = RAGChain()
results = {}
for mode in ["graph", "vector", "hybrid"]:
start = time.time()
result = rag_chain.generate_answer(query, request.user.id, mode)
elapsed = time.time() - start
results[mode] = {
"answer": result.get("answer", ""),
"sources": result.get("sources", []),
"strategy": result.get("strategy", mode.upper()),
"response_time": round(elapsed, 3),
"success": result.get("success", False)
}
return Response({
"query": query,
"comparisons": results,
"success": True
}, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in QueryCompareView: %s", str(e), exc_info=True)
return Response(
{"error": "An internal error occurred during comparison."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #11: GET /api/graph/
# ============================================================
class GraphDataView(APIView):
"""Returns full graph data (nodes + edges) for frontend visualization."""
permission_classes = [IsAuthenticated]
def get(self, request):
try:
graph_retriever = GraphRetriever()
graph_json = graph_retriever.get_graph_as_json(request.user.id)
return Response(graph_json, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in GraphDataView: %s", str(e), exc_info=True)
return Response(
{"error": "Failed to retrieve graph data."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #12: GET /api/graph/entity/{name}/
# ============================================================
class GraphEntityDetailView(APIView):
"""Returns entity details and its direct subgraph."""
permission_classes = [IsAuthenticated]
def get(self, request, name):
if not name:
return Response(
{"error": "Entity name is required."},
status=status.HTTP_400_BAD_REQUEST
)
try:
neo4j_client = Neo4jClient()
entity_data = neo4j_client.get_entity_details(name, request.user.id)
if not entity_data:
return Response(
{"error": f"Entity '{name}' not found."},
status=status.HTTP_404_NOT_FOUND
)
return Response(entity_data, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in GraphEntityDetailView: %s", str(e), exc_info=True)
return Response(
{"error": "Failed to retrieve entity details."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #13: GET /api/graph/path/
# ============================================================
class GraphPathView(APIView):
"""Finds paths between two entities. Moved from /query/shortest-path/."""
permission_classes = [IsAuthenticated]
def get(self, request):
entity_a = request.query_params.get("entity_a")
entity_b = request.query_params.get("entity_b")
if not entity_a or not entity_b:
return Response(
{"error": "Both 'entity_a' and 'entity_b' query parameters are required."},
status=status.HTTP_400_BAD_REQUEST
)
try:
reasoner = MultiHopReasoner()
result = reasoner.explain_connection(entity_a, entity_b, request.user.id)
return Response(result, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in GraphPathView: %s", str(e), exc_info=True)
return Response(
{"error": "Failed to find path between entities."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #14: POST /api/graph/cypher/
# ============================================================
class GraphCypherView(APIView):
"""Executes raw Cypher query. Moved from /query/cypher/."""
permission_classes = [IsAuthenticated]
def post(self, request):
query = request.data.get("query")
if not query or not query.strip():
return Response(
{"error": "The 'query' field is required and cannot be empty."},
status=status.HTTP_400_BAD_REQUEST
)
try:
nl_to_cypher = NLToCypher()
result = nl_to_cypher.execute_nl_query(query, request.user.id)
if result.get("success", False):
return Response(result, status=status.HTTP_200_OK)
return Response(
{"error": result.get("error", "Failed to translate and execute Cypher query.")},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
except Exception as e:
logger.error("Error in GraphCypherView: %s", str(e), exc_info=True)
return Response(
{"error": "An internal error occurred while executing Cypher."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #15: GET /api/graph/stats/
# ============================================================
class GraphStatsView(APIView):
"""Returns graph statistics: total nodes, edges, type distribution."""
permission_classes = [IsAuthenticated]
def get(self, request):
try:
neo4j_client = Neo4jClient()
stats = neo4j_client.get_graph_statistics(request.user.id)
return Response(stats, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in GraphStatsView: %s", str(e), exc_info=True)
return Response(
{"error": "Failed to retrieve graph statistics."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #16: GET /api/graph/communities/
# ============================================================
class CommunityListView(APIView):
"""Lists all detected communities with summaries."""
permission_classes = [IsAuthenticated]
def get(self, request):
try:
detector = CommunityDetector()
communities = detector.get_all_communities(request.user.id)
# Simplify response β don't send full member_details in list
summary_list = []
for comm in communities:
summary_list.append({
"id": comm["id"],
"label": comm.get("label", ""),
"summary": comm.get("summary", ""),
"member_count": comm["member_count"],
"members": comm["members"]
})
return Response({
"communities": summary_list,
"count": len(summary_list)
}, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in CommunityListView: %s", str(e), exc_info=True)
return Response(
{"error": "Failed to retrieve communities."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #17: GET /api/graph/communities/{id}/
# ============================================================
class CommunityDetailView(APIView):
"""Returns a single community's full details and members."""
permission_classes = [IsAuthenticated]
def get(self, request, community_id):
try:
detector = CommunityDetector()
community = detector.get_community_by_id(int(community_id), request.user.id)
if not community:
return Response(
{"error": f"Community with ID {community_id} not found."},
status=status.HTTP_404_NOT_FOUND
)
return Response(community, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in CommunityDetailView: %s", str(e), exc_info=True)
return Response(
{"error": "Failed to retrieve community details."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #18: POST /api/graph/search/
# ============================================================
class GraphSearchView(APIView):
"""Search entities by name or description."""
permission_classes = [IsAuthenticated]
def post(self, request):
search_term = request.data.get("query", "").strip()
if not search_term:
return Response(
{"error": "The 'query' field is required and cannot be empty."},
status=status.HTTP_400_BAD_REQUEST
)
try:
neo4j_client = Neo4jClient()
results = neo4j_client.search_entities(search_term, request.user.id)
return Response({
"query": search_term,
"results": results,
"count": len(results)
}, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in GraphSearchView: %s", str(e), exc_info=True)
return Response(
{"error": "Failed to search entities."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #19: GET /api/evaluation/
# ============================================================
class EvaluationView(APIView):
"""Returns evaluation results comparing retrieval modes."""
permission_classes = [IsAuthenticated]
def get(self, request):
try:
# Get evaluation pairs for this user
pairs = EvaluationPair.objects.filter(
user=request.user, is_active=True
)
if not pairs.exists():
return Response({
"evaluations": [],
"message": "No evaluation pairs found. Create evaluation pairs first.",
"summary": None
}, status=status.HTTP_200_OK)
rag_chain = RAGChain()
eval_results = []
for pair in pairs:
modes_results = {}
for mode in ["graph", "vector", "hybrid"]:
start = time.time()
result = rag_chain.generate_answer(
pair.question, request.user.id, mode
)
elapsed = time.time() - start
modes_results[mode] = {
"answer": result.get("answer", ""),
"response_time": round(elapsed, 3),
"success": result.get("success", False)
}
eval_results.append({
"question": pair.question,
"expected_answer": pair.expected_answer,
"results": modes_results
})
# Summary stats
summary = {
"total_pairs": len(eval_results),
"avg_response_times": {}
}
for mode in ["graph", "vector", "hybrid"]:
times = [e["results"][mode]["response_time"] for e in eval_results]
summary["avg_response_times"][mode] = round(sum(times) / len(times), 3) if times else 0
return Response({
"evaluations": eval_results,
"summary": summary
}, status=status.HTTP_200_OK)
except Exception as e:
logger.error("Error in EvaluationView: %s", str(e), exc_info=True)
return Response(
{"error": "Failed to run evaluation."},
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
# ============================================================
# Endpoint #20: GET /api/health/
# ============================================================
class HealthCheckView(APIView):
"""Health check endpoint β verifies Django + Neo4j connectivity."""
permission_classes = [AllowAny]
def get(self, request):
health = {
"django": "healthy",
"neo4j": "unknown",
"timestamp": time.time()
}
# Check Neo4j connectivity
try:
neo4j_client = Neo4jClient()
neo4j_client.execute_query("RETURN 1 AS test")
health["neo4j"] = "healthy"
except Exception as e:
logger.error("Neo4j health check failed: %s", str(e))
health["neo4j"] = "unhealthy"
overall = "healthy" if health["neo4j"] == "healthy" else "degraded"
return Response({
"status": overall,
"services": health
}, status=status.HTTP_200_OK)
```
---
## Task 2.4 β Update URLs
**File:** `graphrag/urls.py`
**Time:** 20 minutes
**Priority:** P0 β Wire up all new endpoints
### Full Replacement
```python
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from rest_framework_simplejwt.views import TokenRefreshView
from .views import (
RegisterView,
CustomTokenObtainPairView,
DocumentViewSet,
DocumentUploadView,
QueryView,
CypherQueryView,
ShortestPathView,
# New endpoints
GraphOnlyQueryView,
VectorOnlyQueryView,
QueryCompareView,
GraphDataView,
GraphEntityDetailView,
GraphPathView,
GraphCypherView,
GraphStatsView,
CommunityListView,
CommunityDetailView,
GraphSearchView,
EvaluationView,
HealthCheckView,
)
router = DefaultRouter()
router.register(r'documents', DocumentViewSet, basename='document')
urlpatterns = [
# === Authentication ===
path('auth/register/', RegisterView.as_view(), name='auth_register'),
path('auth/login/', CustomTokenObtainPairView.as_view(), name='auth_login'),
path('auth/token/refresh/', TokenRefreshView.as_view(), name='auth_token_refresh'),
# === Documents ===
path('documents/upload/', DocumentUploadView.as_view(), name='document_upload'),
# === Query Endpoints ===
path('query/', QueryView.as_view(), name='query'),
path('query/graph-only/', GraphOnlyQueryView.as_view(), name='query_graph_only'),
path('query/vector-only/', VectorOnlyQueryView.as_view(), name='query_vector_only'),
path('query/compare/', QueryCompareView.as_view(), name='query_compare'),
# === Legacy endpoints (kept for backwards compat) ===
path('query/cypher/', CypherQueryView.as_view(), name='query_cypher'),
path('query/shortest-path/', ShortestPathView.as_view(), name='query_shortest_path'),
# === Graph Endpoints (NEW) ===
path('graph/', GraphDataView.as_view(), name='graph_data'),
path('graph/entity/<str:name>/', GraphEntityDetailView.as_view(), name='graph_entity_detail'),
path('graph/path/', GraphPathView.as_view(), name='graph_path'),
path('graph/cypher/', GraphCypherView.as_view(), name='graph_cypher'),
path('graph/stats/', GraphStatsView.as_view(), name='graph_stats'),
path('graph/communities/', CommunityListView.as_view(), name='graph_communities'),
path('graph/communities/<int:community_id>/', CommunityDetailView.as_view(), name='graph_community_detail'),
path('graph/search/', GraphSearchView.as_view(), name='graph_search'),
# === Evaluation ===
path('evaluation/', EvaluationView.as_view(), name='evaluation'),
# === Health ===
path('health/', HealthCheckView.as_view(), name='health'),
# === Document Management (router) ===
path('', include(router.urls)),
]
```
### Endpoint Map Verification
| # | Method | URL | View | Status |
|---|--------|-----|------|--------|
| 1 | POST | /api/auth/register/ | RegisterView | DONE |
| 2 | POST | /api/auth/login/ | CustomTokenObtainPairView | DONE |
| 3 | POST | /api/auth/token/refresh/ | TokenRefreshView | DONE |
| 4 | POST | /api/documents/upload/ | DocumentUploadView | DONE |
| 5 | GET | /api/documents/ | DocumentViewSet.list | DONE |
| 6 | DELETE | /api/documents/{id}/ | DocumentViewSet.destroy | DONE |
| 7 | POST | /api/query/ | QueryView | DONE |
| 8 | POST | /api/query/graph-only/ | GraphOnlyQueryView | NEW |
| 9 | POST | /api/query/vector-only/ | VectorOnlyQueryView | NEW |
| 10 | POST | /api/query/compare/ | QueryCompareView | NEW |
| 11 | GET | /api/graph/ | GraphDataView | NEW |
| 12 | GET | /api/graph/entity/{name}/ | GraphEntityDetailView | NEW |
| 13 | GET | /api/graph/path/ | GraphPathView | NEW |
| 14 | POST | /api/graph/cypher/ | GraphCypherView | NEW |
| 15 | GET | /api/graph/stats/ | GraphStatsView | NEW |
| 16 | GET | /api/graph/communities/ | CommunityListView | NEW |
| 17 | GET | /api/graph/communities/{id}/ | CommunityDetailView | NEW |
| 18 | POST | /api/graph/search/ | GraphSearchView | NEW |
| 19 | GET | /api/evaluation/ | EvaluationView | NEW |
| 20 | GET | /api/health/ | HealthCheckView | NEW |
---
## Task 2.5 β Add Serializers for New Models
**File:** `graphrag/serializers.py`
**Time:** 15 minutes
**Priority:** P1
### Add (already exist in file but verify they're imported in views)
```python
# Already in serializers.py β just ensure they're imported in views.py:
from .serializers import (
RegisterSerializer,
UserSerializer,
DocumentSerializer,
QueryLogSerializer, # Add import
EvaluationPairSerializer # Add import
)
```
### Verify existing serializers work:
- `QueryLogSerializer` β fields: id, user, query_text, retrieval_mode, answer_text, response_time, created_at
- `EvaluationPairSerializer` β fields: id, user, question, expected_answer, is_active, created_at
---
## Task 2.6 β Update Comprehensive Tests
**File:** `graphrag/tests_comprehensive.py`
**Time:** 90 minutes
**Priority:** P1 β Verify all endpoints work
### Tests to Add
```python
# ============================================================
# NEW TEST CLASS: Graph Endpoints Tests
# ============================================================
class GraphEndpointTests(APITestCase):
"""Tests for all /api/graph/* endpoints."""
def setUp(self):
self.user = _create_user(username="graphep", email="graphep@gmail.com")
self.client.force_authenticate(user=self.user)
@patch("graphrag.views.GraphRetriever")
def test_graph_data_view(self, mock_retriever):
"""GET /api/graph/ returns nodes and edges."""
mock_retriever.return_value.get_graph_as_json.return_value = {
"nodes": [{"id": 0, "label": "Google", "type": "ORGANIZATION"}],
"edges": []
}
response = self.client.get(reverse("graph_data"))
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertIn("nodes", response.data)
self.assertIn("edges", response.data)
@patch("graphrag.views.Neo4jClient")
def test_graph_entity_detail(self, mock_neo4j):
"""GET /api/graph/entity/{name}/ returns entity details."""
mock_neo4j.return_value.get_entity_details.return_value = {
"entity": {"name": "Google", "type": "ORGANIZATION", "description": "Tech company"},
"relationships": []
}
response = self.client.get(reverse("graph_entity_detail", args=["Google"]))
self.assertEqual(response.status_code, status.HTTP_200_OK)
@patch("graphrag.views.Neo4jClient")
def test_graph_entity_not_found(self, mock_neo4j):
"""GET /api/graph/entity/{name}/ returns 404 for missing entity."""
mock_neo4j.return_value.get_entity_details.return_value = None
response = self.client.get(reverse("graph_entity_detail", args=["Nonexistent"]))
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
@patch("graphrag.views.Neo4jClient")
def test_graph_stats(self, mock_neo4j):
"""GET /api/graph/stats/ returns graph statistics."""
mock_neo4j.return_value.get_graph_statistics.return_value = {
"nodes_count": 10,
"edges_count": 15,
"type_distribution": [{"type": "PERSON", "count": 5}]
}
response = self.client.get(reverse("graph_stats"))
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data["nodes_count"], 10)
@patch("graphrag.views.Neo4jClient")
def test_graph_search(self, mock_neo4j):
"""POST /api/graph/search/ returns matching entities."""
mock_neo4j.return_value.search_entities.return_value = [
{"name": "Google", "type": "ORGANIZATION", "description": "Tech company"}
]
response = self.client.post(
reverse("graph_search"), {"query": "Google"}, format="json"
)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(len(response.data["results"]), 1)
@patch("graphrag.views.Neo4jClient")
def test_graph_search_empty_query(self, mock_neo4j):
"""POST /api/graph/search/ rejects empty query."""
response = self.client.post(
reverse("graph_search"), {"query": ""}, format="json"
)
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
@patch("graphrag.views.CommunityDetector")
def test_community_list(self, mock_detector):
"""GET /api/graph/communities/ returns community list."""
mock_detector.return_value.get_all_communities.return_value = [
{
"id": 1,
"label": "Tech Companies",
"summary": "A community of technology organizations.",
"member_count": 3,
"members": ["Google", "Microsoft", "Apple"],
"member_details": []
}
]
response = self.client.get(reverse("graph_communities"))
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data["count"], 1)
@patch("graphrag.views.CommunityDetector")
def test_community_detail(self, mock_detector):
"""GET /api/graph/communities/{id}/ returns community detail."""
mock_detector.return_value.get_community_by_id.return_value = {
"id": 1,
"label": "Tech Companies",
"summary": "Summary here.",
"member_count": 3,
"members": ["Google", "Microsoft", "Apple"],
"member_details": [
{"name": "Google", "type": "ORGANIZATION", "description": "..."}
]
}
response = self.client.get(reverse("graph_community_detail", args=[1]))
self.assertEqual(response.status_code, status.HTTP_200_OK)
@patch("graphrag.views.CommunityDetector")
def test_community_not_found(self, mock_detector):
"""GET /api/graph/communities/{id}/ returns 404 for missing."""
mock_detector.return_value.get_community_by_id.return_value = None
response = self.client.get(reverse("graph_community_detail", args=[999]))
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
# ============================================================
# NEW TEST CLASS: Query Comparison Tests
# ============================================================
class QueryCompareTests(APITestCase):
"""Tests for POST /api/query/compare/."""
def setUp(self):
self.user = _create_user(username="cmpuser", email="cmpuser@gmail.com")
self.client.force_authenticate(user=self.user)
@patch("graphrag.views.RAGChain")
def test_compare_returns_all_modes(self, mock_rag):
"""Compare endpoint returns graph, vector, and hybrid results."""
mock_rag.return_value.generate_answer.return_value = {
"success": True, "answer": "Test answer", "sources": ["doc.pdf"]
}
response = self.client.post(
reverse("query_compare"), {"query": "What is AI?"}, format="json"
)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertIn("graph", response.data["comparisons"])
self.assertIn("vector", response.data["comparisons"])
self.assertIn("hybrid", response.data["comparisons"])
self.assertEqual(mock_rag.return_value.generate_answer.call_count, 3)
# ============================================================
# NEW TEST CLASS: Graph-only / Vector-only Query Tests
# ============================================================
class DedicatedQueryModeTests(APITestCase):
"""Tests for dedicated /api/query/graph-only/ and /api/query/vector-only/."""
def setUp(self):
self.user = _create_user(username="modeuser", email="modeuser@gmail.com")
self.client.force_authenticate(user=self.user)
@patch("graphrag.views.RAGChain")
def test_graph_only_query(self, mock_rag):
"""POST /api/query/graph-only/ uses graph mode."""
mock_rag.return_value.generate_answer.return_value = {
"success": True, "answer": "Graph answer"
}
response = self.client.post(
reverse("query_graph_only"), {"query": "Show relationships"}, format="json"
)
self.assertEqual(response.status_code, status.HTTP_200_OK)
call_args = mock_rag.return_value.generate_answer.call_args
self.assertEqual(call_args[0][2], "graph")
@patch("graphrag.views.RAGChain")
def test_vector_only_query(self, mock_rag):
"""POST /api/query/vector-only/ uses vector mode."""
mock_rag.return_value.generate_answer.return_value = {
"success": True, "answer": "Vector answer"
}
response = self.client.post(
reverse("query_vector_only"), {"query": "Semantic search"}, format="json"
)
self.assertEqual(response.status_code, status.HTTP_200_OK)
call_args = mock_rag.return_value.generate_answer.call_args
self.assertEqual(call_args[0][2], "vector")
# ============================================================
# NEW TEST CLASS: Health Check Tests
# ============================================================
class HealthCheckTests(APITestCase):
"""Tests for GET /api/health/."""
def test_health_check_no_auth_required(self):
"""Health check does not require authentication."""
response = self.client.get(reverse("health"))
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertIn("status", response.data)
self.assertIn("services", response.data)
@patch("graphrag.views.Neo4jClient")
def test_health_check_neo4j_healthy(self, mock_neo4j):
"""Health check returns healthy when Neo4j is reachable."""
mock_neo4j.return_value.execute_query.return_value = [{"test": 1}]
response = self.client.get(reverse("health"))
self.assertEqual(response.data["services"]["neo4j"], "healthy")
self.assertEqual(response.data["status"], "healthy")
@patch("graphrag.views.Neo4jClient")
def test_health_check_neo4j_unhealthy(self, mock_neo4j):
"""Health check returns degraded when Neo4j is unreachable."""
mock_neo4j.return_value.execute_query.side_effect = Exception("Connection refused")
response = self.client.get(reverse("health"))
self.assertEqual(response.data["services"]["neo4j"], "unhealthy")
self.assertEqual(response.data["status"], "degraded")
# ============================================================
# NEW TEST CLASS: Query Logging Tests
# ============================================================
class QueryLoggingTests(APITestCase):
"""Tests that queries are logged to QueryLog model."""
def setUp(self):
self.user = _create_user(username="logtester", email="logtester@gmail.com")
self.client.force_authenticate(user=self.user)
@patch("graphrag.views.RAGChain")
def test_query_creates_log_entry(self, mock_rag):
"""Successful query creates a QueryLog record."""
mock_rag.return_value.generate_answer.return_value = {
"success": True, "answer": "Test answer"
}
initial_count = QueryLog.objects.count()
self.client.post(
reverse("query"), {"query": "Test query"}, format="json"
)
self.assertEqual(QueryLog.objects.count(), initial_count + 1)
log = QueryLog.objects.latest("created_at")
self.assertEqual(log.query_text, "Test query")
self.assertEqual(log.user, self.user)
@patch("graphrag.views.RAGChain")
def test_failed_query_creates_log_entry(self, mock_rag):
"""Failed query also creates a QueryLog record."""
mock_rag.return_value.generate_answer.side_effect = Exception("Boom")
initial_count = QueryLog.objects.count()
self.client.post(
reverse("query"), {"query": "Failing query"}, format="json"
)
self.assertEqual(QueryLog.objects.count(), initial_count + 1)
# ============================================================
# NEW TEST CLASS: File Validation Tests
# ============================================================
class FileValidationTests(APITestCase):
"""Tests for file upload validation."""
def setUp(self):
self.user = _create_user(username="fileval", email="fileval@gmail.com")
self.client.force_authenticate(user=self.user)
@patch("graphrag.views.trigger_ingestion_background")
def test_reject_exe_file(self, mock_bg):
"""Executable files are rejected."""
exe_file = SimpleUploadedFile(
"malware.exe", b"MZ\x90\x00", content_type="application/octet-stream"
)
response = self.client.post(
reverse("document_upload"), {"file": exe_file}, format="multipart"
)
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
@patch("graphrag.views.trigger_ingestion_background")
def test_reject_empty_file(self, mock_bg):
"""Empty files are rejected."""
empty_file = SimpleUploadedFile("empty.txt", b"", content_type="text/plain")
response = self.client.post(
reverse("document_upload"), {"file": empty_file}, format="multipart"
)
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
@patch("graphrag.views.trigger_ingestion_background")
def test_accept_valid_pdf(self, mock_bg):
"""Valid PDF files are accepted."""
pdf_file = SimpleUploadedFile(
"test.pdf", b"%PDF-1.4 fake", content_type="application/pdf"
)
response = self.client.post(
reverse("document_upload"), {"file": pdf_file}, format="multipart"
)
self.assertEqual(response.status_code, status.HTTP_202_ACCEPTED)
# ============================================================
# NEW TEST CLASS: Security Hardening Tests
# ============================================================
class SecurityHardeningTests(APITestCase):
"""Tests verifying security fixes are in place."""
def setUp(self):
self.user = _create_user(username="secfix", email="secfix@gmail.com")
self.client.force_authenticate(user=self.user)
@patch("graphrag.views.RAGChain")
def test_500_error_no_internal_leak(self, mock_rag):
"""500 errors should NOT leak internal details."""
mock_rag.return_value.generate_answer.side_effect = Exception("secret_db_password")
response = self.client.post(
reverse("query"), {"query": "leak test"}, format="json"
)
self.assertEqual(response.status_code, status.HTTP_500_INTERNAL_SERVER_ERROR)
body = json.dumps(response.data)
self.assertNotIn("secret_db_password", body)
self.assertNotIn("internal", body.lower().replace("internal error", ""))
def test_health_check_accessible_without_auth(self):
"""Health endpoint should be accessible without auth."""
client = APIClient()
response = client.get(reverse("health"))
self.assertEqual(response.status_code, status.HTTP_200_OK)
```
---
## Task 2.7 β Verify Settings Changes
**File:** `config/settings.py`
**Time:** 10 minutes
**Priority:** P1
### Confirm these are set:
```python
DEBUG = os.getenv('DEBUG', 'False') == 'True' # Was 'True'
CORS_ALLOW_ALL_ORIGINS = False # Was True
CORS_ALLOWED_ORIGINS = [...] # Added
ACCESS_TOKEN_LIFETIME = timedelta(minutes=30) # Was days=1
NEO4J_USERNAME = os.getenv('NEO4J_USERNAME', 'neo4j') # Confirmed correct
```
---
## Task 2.8 β Run Full Test Suite
**File:** All files (no changes)
**Time:** 30 minutes
**Priority:** P0 β Final verification
### Commands
```bash
# Run the comprehensive test suite
cd /home/creator/Desktop/ExcellenceTechnology/07.graphrag-knowledge-ai/backend
python manage.py test graphrag.tests_comprehensive --verbosity=2
# Expected: 50+ tests, ALL PASS
# Run Django system check
python manage.py check --deploy 2>&1 | head -30
# Verify migrations
python manage.py makemigrations --check
# Test URL resolution
python manage.py show_urls 2>/dev/null || python -c "
from django.urls import reverse
endpoints = [
'auth_register', 'auth_login', 'auth_token_refresh',
'document_upload', 'document-list',
'query', 'query_graph_only', 'query_vector_only', 'query_compare',
'query_cypher', 'query_shortest_path',
'graph_data', 'graph_path', 'graph_cypher', 'graph_stats',
'graph_communities', 'graph_search',
'evaluation', 'health'
]
for ep in endpoints:
try:
url = reverse(ep)
print(f' OK: {ep} -> {url}')
except Exception as e:
print(f' MISSING: {ep} -> {e}')
"
```
---
# Dependency Graph
```
Task 1.1 (Neo4j Auth Fix) ββββββββββββββββββββββββββ
Task 1.2 (Neo4j Methods) βββββββββββββββββββββββββββ€
Task 1.3 (Cypher Validation) βββββββββββββββββββββββ€
Task 1.4 (Error Leak Fix) ββββββββββββββββββββββββββ€
Task 1.5 (Settings Security) βββββββββββββββββββββββ€
Task 1.6 (Vector Page Bug) βββββββββββββββββββββββββ€
Task 1.7 (Graph Retriever Bug) βββββββββββββββββββββ€
βΌ
Task 1.8 (Community Detector) βββββββββββββββββΊ Task 2.3 (New Endpoints)
Task 1.9 (Admin Registrations) ββββββββββββββββΊ Task 2.4 (URL Updates)
β
Task 2.1 (Query Logging) βββββββββββββββββββββββ β
Task 2.2 (File Validation) ββββββββββββββββββββ€ β
Task 2.5 (Serializer Imports) βββββββββββββββββ€ β
βΌ βΌ
Task 2.6 (Tests)
β
βΌ
Task 2.8 (Full Run)
```
---
# Verification Checklist (End of Day 2)
| # | Endpoint | Method | URL | Expected | β |
|---|----------|--------|-----|----------|---|
| 1 | Register | POST | /api/auth/register/ | 201 | β |
| 2 | Login | POST | /api/auth/login/ | 200 + JWT | β |
| 3 | Token Refresh | POST | /api/auth/token/refresh/ | 200 | β |
| 4 | Upload | POST | /api/documents/upload/ | 202 | β |
| 5 | List Docs | GET | /api/documents/ | 200 | β |
| 6 | Delete Doc | DELETE | /api/documents/{id}/ | 200 | β |
| 7 | Query | POST | /api/query/ | 200 | β |
| 8 | Graph Only | POST | /api/query/graph-only/ | 200 | β |
| 9 | Vector Only | POST | /api/query/vector-only/ | 200 | β |
| 10 | Compare | POST | /api/query/compare/ | 200 | β |
| 11 | Graph Data | GET | /api/graph/ | 200 | β |
| 12 | Entity Detail | GET | /api/graph/entity/{name}/ | 200 | β |
| 13 | Path | GET | /api/graph/path/ | 200 | β |
| 14 | Cypher | POST | /api/graph/cypher/ | 200 | β |
| 15 | Stats | GET | /api/graph/stats/ | 200 | β |
| 16 | Communities | GET | /api/graph/communities/ | 200 | β |
| 17 | Community Detail | GET | /api/graph/communities/{id}/ | 200 | β |
| 18 | Search | POST | /api/graph/search/ | 200 | β |
| 19 | Evaluation | GET | /api/evaluation/ | 200 | β |
| 20 | Health | GET | /api/health/ | 200 | β |
| Bug | Fix Applied | Verified |
|-----|-------------|----------|
| NEO4J_USER β NEO4J_USERNAME | β | β |
| Singleton __new__ args | β | β |
| Cypher injection (no validation) | β | β |
| Error messages leak internals | β | β |
| CORS_ALLOW_ALL_ORIGINS = True | β | β |
| JWT 24h access tokens | β | β |
| DEBUG=True default | β | β |
| vector_retriever page metadata | β | β |
| graph_retriever node.id indexing | β | β |
| File | Empty β Implemented | Verified |
|------|---------------------|----------|
| community_detector.py | β | β |
| admin.py | β | β |
| Model | Used in Endpoint | Verified |
|-------|------------------|----------|
| QueryLog | QueryView + all query endpoints | β |
| EvaluationPair | EvaluationView | β |
|