fe9b8ec02a
* feat: Implement multi-tenant architecture with tenant and knowledge base models - Added data models for tenants, knowledge bases, and related configurations. - Introduced role and permission management for users in the multi-tenant system. - Created a service layer for managing tenants and knowledge bases, including CRUD operations. - Developed a tenant-aware instance manager for LightRAG with caching and isolation features. - Added a migration script to transition existing workspace-based deployments to the new multi-tenant architecture. * chore: ignore lightrag/api/webui/assets/ directory * chore: stop tracking lightrag/api/webui/assets (ignore in .gitignore) * feat: Initialize LightRAG Multi-Tenant Stack with PostgreSQL - Added README.md for project overview, setup instructions, and architecture details. - Created docker-compose.yml to define services: PostgreSQL, Redis, LightRAG API, and Web UI. - Introduced env.example for environment variable configuration. - Implemented init-postgres.sql for PostgreSQL schema initialization with multi-tenant support. - Added reproduce_issue.py for testing default tenant access via API. * feat: Enhance TenantSelector and update related components for improved multi-tenant support * feat: Enhance testing capabilities and update documentation - Updated Makefile to include new test commands for various modes (compatibility, isolation, multi-tenant, security, coverage, and dry-run). - Modified API health check endpoint in Makefile to reflect new port configuration. - Updated QUICK_START.md and README.md to reflect changes in service URLs and ports. - Added environment variables for testing modes in env.example. - Introduced run_all_tests.sh script to automate testing across different modes. - Created conftest.py for pytest configuration, including database fixtures and mock services. - Implemented database helper functions for streamlined database operations in tests. - Added test collection hooks to skip tests based on the current MULTITENANT_MODE. * feat: Implement multi-tenant support with demo mode enabled by default - Added multi-tenant configuration to the environment and Docker setup. - Created pre-configured demo tenants (acme-corp and techstart) for testing. - Updated API endpoints to support tenant-specific data access. - Enhanced Makefile commands for better service management and database operations. - Introduced user-tenant membership system with role-based access control. - Added comprehensive documentation for multi-tenant setup and usage. - Fixed issues with document visibility in multi-tenant environments. - Implemented necessary database migrations for user memberships and legacy support. * feat(audit): Add final audit report for multi-tenant implementation - Documented overall assessment, architecture overview, test results, security findings, and recommendations. - Included detailed findings on critical security issues and architectural concerns. fix(security): Implement security fixes based on audit findings - Removed global RAG fallback and enforced strict tenant context. - Configured super-admin access and required user authentication for tenant access. - Cleared localStorage on logout and improved error handling in WebUI. chore(logs): Create task logs for audit and security fixes implementation - Documented actions, decisions, and next steps for both audit and security fixes. - Summarized test results and remaining recommendations. chore(scripts): Enhance development stack management scripts - Added scripts for cleaning, starting, and stopping the development stack. - Improved output messages and ensured graceful shutdown of services. feat(starter): Initialize PostgreSQL with AGE extension support - Created initialization scripts for PostgreSQL extensions including uuid-ossp, vector, and AGE. - Ensured successful installation and verification of extensions. * feat: Implement auto-select for first tenant and KB on initial load in WebUI - Removed WEBUI_INITIAL_STATE_FIX.md as the issue is resolved. - Added useTenantInitialization hook to automatically select the first available tenant and KB on app load. - Integrated the new hook into the Root component of the WebUI. - Updated RetrievalTesting component to ensure a KB is selected before allowing user interaction. - Created end-to-end tests for multi-tenant isolation and real service interactions. - Added scripts for starting, stopping, and cleaning the development stack. - Enhanced API and tenant routes to support tenant-specific pipeline status initialization. - Updated constants for backend URL to reflect the correct port. - Improved error handling and logging in various components. * feat: Add multi-tenant support with enhanced E2E testing scripts and client functionality * update client * Add integration and unit tests for multi-tenant API, models, security, and storage - Implement integration tests for tenant and knowledge base management endpoints in `test_tenant_api_routes.py`. - Create unit tests for tenant isolation, model validation, and role permissions in `test_tenant_models.py`. - Add security tests to enforce role-based permissions and context validation in `test_tenant_security.py`. - Develop tests for tenant-aware storage operations and context isolation in `test_tenant_storage_phase3.py`. * feat(e2e): Implement OpenAI model support and database reset functionality * Add comprehensive test suite for gpt-5-nano compatibility - Introduced tests for parameter normalization, embeddings, and entity extraction. - Implemented direct API testing for gpt-5-nano. - Validated .env configuration loading and OpenAI API connectivity. - Analyzed reasoning token overhead with various token limits. - Documented test procedures and expected outcomes in README files. - Ensured all tests pass for production readiness. * kg(postgres_impl): ensure AGE extension is loaded in session and configure graph initialization * dev: add hybrid dev helper scripts, Makefile, docker-compose.dev-db and local development docs * feat(dev): add dev helper scripts and local development documentation for hybrid setup * feat(multi-tenant): add detailed specifications and logs for multi-tenant improvements, including UX, backend handling, and ingestion pipeline * feat(migration): add generated tenant/kb columns, indexes, triggers; drop unused tables; update schema and docs * test(backward-compat): adapt tests to new StorageNameSpace/TenantService APIs (use concrete dummy storages) * chore: multi-tenant and UX updates — docs, webui, storage, tenant service adjustments * tests: stabilize integration tests + skip external services; fix multi-tenant API behavior and idempotency - gpt5_nano_compatibility: add pytest-asyncio markers, skip when OPENAI key missing, prevent module-level asyncio.run collection, add conftest - Ollama tests: add server availability check and skip markers; avoid pytest collection warnings by renaming helper classes - Graph storage tests: rename interactive test functions to avoid pytest collection - Document & Tenant routes: support external_ids for idempotency; ensure HTTPExceptions are re-raised - LightRAG core: support external_ids in apipeline_enqueue_documents and idempotent logic - Tests updated to match API changes (tenant routes & document routes) - Add logs and scripts for inspection and audit
169 lines
5.2 KiB
Markdown
169 lines
5.2 KiB
Markdown
# Multi-Tenant Audit - Test Execution Log
|
|
|
|
**Date:** November 29, 2025
|
|
**Status:** In Progress
|
|
|
|
---
|
|
|
|
## Environment Setup
|
|
|
|
### Docker Containers (Audit)
|
|
| Container | Image | Port | Status |
|
|
|-----------|-------|------|--------|
|
|
| lightrag-audit-postgres | pgvector/pgvector:pg16 | 5433 | ✅ Healthy |
|
|
| lightrag-audit-redis | redis:7-alpine | 6380 | ✅ Healthy |
|
|
|
|
### Test Configuration
|
|
- PostgreSQL: `localhost:5433` (User: lightrag, DB: lightrag_audit)
|
|
- Redis: `localhost:6380`
|
|
- API will run locally on port 9622 (to avoid conflict)
|
|
- WebUI will run locally on port 5173
|
|
|
|
---
|
|
|
|
## Execution Timeline
|
|
|
|
### Session 1: Initial Setup and Codebase Review
|
|
|
|
**Time:** 2025-11-29 [Start]
|
|
|
|
#### Observation 1: Multi-Tenant Architecture Components Identified
|
|
|
|
1. **Web UI Layer:**
|
|
- `tenant.ts` store: Zustand store for tenant/KB selection with localStorage persistence
|
|
- `client.ts`: Axios interceptor adds X-Tenant-ID and X-KB-ID headers
|
|
- Console logging enabled for debugging header propagation
|
|
|
|
2. **REST API Layer:**
|
|
- `dependencies.py`: `get_tenant_context()` extracts tenant from headers
|
|
- `tenant_routes.py`: CRUD for tenants and KBs
|
|
- `document_routes.py`: Tenant-scoped document operations
|
|
- `query_routes.py`: Tenant-scoped query operations
|
|
|
|
3. **Storage Layer:**
|
|
- PostgreSQL tables have `tenant_id` and `kb_id` columns with composite PKs
|
|
- SQL queries use `TenantSQLBuilder` for automatic filtering
|
|
- Redis uses namespace prefixes
|
|
|
|
#### Initial Findings from Code Review
|
|
|
|
**Finding 1: Potential Issue in Document Routes**
|
|
- Location: `lightrag/api/routers/document_routes.py`
|
|
- Need to verify tenant context is consistently applied to all endpoints
|
|
|
|
**Finding 2: Query Route Tenant Handling**
|
|
- Location: `lightrag/api/routers/query_routes.py`
|
|
- The `get_tenant_rag()` dependency falls back to global RAG if no context
|
|
- This could be a security issue if headers are missing
|
|
|
|
**Finding 3: WebUI State Management**
|
|
- Recent fix in `DocumentManager.tsx` to clear state on tenant/KB change
|
|
- Need to verify this works correctly in practice
|
|
|
|
---
|
|
|
|
## Test Execution
|
|
|
|
### Phase 1: Setup Python Environment
|
|
|
|
```bash
|
|
source ~/.venv/bin/activate
|
|
pip install ".[dev]" -q
|
|
```
|
|
|
|
**Status:** ✅ Completed
|
|
|
|
### Phase 2: Unit Test Execution
|
|
|
|
#### Test Suite: test_multitenant_e2e.py
|
|
**Status:** ✅ PASSED (32/32 tests) in 0.47s
|
|
|
|
| Test Class | Tests | Status |
|
|
|------------|-------|--------|
|
|
| TestCompositeKeyPattern | 4 | ✅ |
|
|
| TestDataIsolation | 3 | ✅ |
|
|
| TestRedisNamespaceIsolation | 5 | ✅ |
|
|
| TestContextPropagation | 2 | ✅ |
|
|
| TestTenantManagement | 2 | ✅ |
|
|
| TestKnowledgeBaseManagement | 2 | ✅ |
|
|
| TestDocumentOperations | 3 | ✅ |
|
|
| TestEntityRelationIsolation | 2 | ✅ |
|
|
| TestEdgeCases | 5 | ✅ |
|
|
| TestConcurrentAccess | 2 | ✅ |
|
|
| TestDataConsistency | 2 | ✅ |
|
|
|
|
#### Test Suite: test_tenant_security.py
|
|
**Status:** ✅ PASSED (11/11 tests) in 0.26s
|
|
|
|
| Test Class | Tests | Status |
|
|
|------------|-------|--------|
|
|
| TestPermissionEnforcement | 5 | ✅ |
|
|
| TestTenantContextValidation | 4 | ✅ |
|
|
| TestRoleHierarchy | 2 | ✅ |
|
|
|
|
#### Test Suite: test_multi_tenant_backends.py
|
|
**Status:** ✅ PASSED (37/37 tests) in 0.45s
|
|
|
|
| Test Class | Tests | Status |
|
|
|------------|-------|--------|
|
|
| TestPostgresMultiTenant | 7 | ✅ |
|
|
| TestMongoMultiTenant | 5 | ✅ |
|
|
| TestRedisMultiTenant | 6 | ✅ |
|
|
| TestVectorMultiTenant | 6 | ✅ |
|
|
| TestGraphMultiTenant | 6 | ✅ |
|
|
| TestTenantIsolationSecurity | 3 | ✅ |
|
|
| TestBackwardCompatibility | 3 | ✅ |
|
|
|
|
#### Test Suite: test_tenant_storage_phase3.py
|
|
**Status:** ✅ PASSED (22/22 tests) in 0.34s
|
|
|
|
| Test Class | Tests | Status |
|
|
|------------|-------|--------|
|
|
| TestTenantRAGManagerBasics | 4 | ✅ |
|
|
| TestTenantContextUnit | 5 | ✅ |
|
|
| TestTenantModel | 4 | ✅ |
|
|
| TestTenantConfigModel | 3 | ✅ |
|
|
| TestMultiTenantStructure | 4 | ✅ |
|
|
| TestTenantContextIsolation | 2 | ✅ |
|
|
|
|
#### Test Summary
|
|
| Test Suite | Tests | Passed | Status |
|
|
|------------|-------|--------|--------|
|
|
| test_multitenant_e2e.py | 32 | 32 | ✅ |
|
|
| test_tenant_security.py | 11 | 11 | ✅ |
|
|
| test_multi_tenant_backends.py | 37 | 37 | ✅ |
|
|
| test_tenant_storage_phase3.py | 22 | 22 | ✅ |
|
|
| **Total** | **102** | **102** | ✅ |
|
|
|
|
### Phase 3: API Endpoint Testing
|
|
|
|
**Status:** In Progress
|
|
|
|
### Phase 4: WebUI Testing
|
|
|
|
**Status:** Pending
|
|
|
|
---
|
|
|
|
## Issues Found
|
|
|
|
### Issue 1: Test Import Errors
|
|
**Files:** `test_document_routes_tenant_scoped.py`, `test_tenant_api_routes.py`
|
|
**Problem:** These files have import issues when run outside API context
|
|
**Root Cause:** `lightrag.api.routers.document_routes` imports trigger CLI argument parsing
|
|
**Impact:** 2 test files cannot be run
|
|
**Recommendation:** Fix import structure or mock CLI initialization
|
|
|
|
### Issue 2: Deprecation Warnings
|
|
**Files:** Multiple test files
|
|
**Warning:** `datetime.datetime.utcnow()` is deprecated
|
|
**Recommendation:** Update to `datetime.datetime.now(datetime.UTC)`
|
|
|
|
---
|
|
|
|
## Lessons Learned
|
|
|
|
1. **All 102 unit tests pass** - The multi-tenant implementation at the model and storage layer is solid
|
|
2. **Import issues** exist in API route tests due to CLI argument parsing at import time
|
|
3. **Test coverage** is comprehensive for backend multi-tenant isolation
|
|
4. **Role-based access control** is properly tested with clear permission boundaries
|