* 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
383 lines
12 KiB
Python
383 lines
12 KiB
Python
"""
|
|
API routes for tenant membership management.
|
|
|
|
Handles user invitations, role management, and member listing.
|
|
"""
|
|
|
|
from fastapi import APIRouter, Depends, HTTPException, status, Query
|
|
from typing import Optional
|
|
|
|
from lightrag.api.models import (
|
|
AddMemberRequest,
|
|
UpdateMemberRoleRequest,
|
|
MemberResponse,
|
|
PaginatedMembersResponse,
|
|
UserRole
|
|
)
|
|
from lightrag.api.dependencies import get_tenant_context_no_kb
|
|
from lightrag.models.tenant import TenantContext
|
|
from lightrag.api.utils_api import get_combined_auth_dependency
|
|
import logging
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
router = APIRouter(prefix="/api/v1", tags=["membership"])
|
|
|
|
|
|
@router.post(
|
|
"/tenants/{tenant_id}/members",
|
|
response_model=MemberResponse,
|
|
status_code=status.HTTP_201_CREATED,
|
|
dependencies=[Depends(get_combined_auth_dependency())]
|
|
)
|
|
async def add_member_to_tenant(
|
|
tenant_id: str,
|
|
request: AddMemberRequest,
|
|
context: TenantContext = Depends(get_tenant_context_no_kb)
|
|
):
|
|
"""
|
|
Add a user to a tenant with specified role.
|
|
|
|
Requires admin or owner role in the tenant.
|
|
"""
|
|
from fastapi import Request as FastAPIRequest
|
|
from starlette.requests import Request
|
|
|
|
# Get tenant service from app state
|
|
try:
|
|
# Access via starlette request
|
|
import inspect
|
|
frame = inspect.currentframe()
|
|
while frame:
|
|
if 'request' in frame.f_locals and isinstance(frame.f_locals['request'], Request):
|
|
req = frame.f_locals['request']
|
|
break
|
|
frame = frame.f_back
|
|
|
|
if not req or not hasattr(req.app.state, 'rag_manager'):
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail="Service not initialized"
|
|
)
|
|
|
|
tenant_service = req.app.state.rag_manager.tenant_service
|
|
|
|
# Verify requester has admin or owner role
|
|
has_permission = await tenant_service.verify_user_access(
|
|
user_id=context.user_id,
|
|
tenant_id=tenant_id,
|
|
required_role="admin"
|
|
)
|
|
|
|
if not has_permission:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_403_FORBIDDEN,
|
|
detail="Insufficient permissions. Admin or owner role required."
|
|
)
|
|
|
|
# Add member
|
|
membership = await tenant_service.add_user_to_tenant(
|
|
user_id=request.user_id,
|
|
tenant_id=tenant_id,
|
|
role=request.role.value,
|
|
created_by=context.user_id
|
|
)
|
|
|
|
return MemberResponse(
|
|
user_id=membership["user_id"],
|
|
role=UserRole(membership["role"]),
|
|
created_at=membership["created_at"],
|
|
created_by=membership["created_by"]
|
|
)
|
|
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Error adding member to tenant: {e}")
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail=str(e)
|
|
)
|
|
|
|
|
|
@router.get(
|
|
"/tenants/{tenant_id}/members",
|
|
response_model=PaginatedMembersResponse,
|
|
dependencies=[Depends(get_combined_auth_dependency())]
|
|
)
|
|
async def list_tenant_members(
|
|
tenant_id: str,
|
|
context: TenantContext = Depends(get_tenant_context_no_kb),
|
|
skip: int = Query(0, ge=0),
|
|
limit: int = Query(20, ge=1, le=100)
|
|
):
|
|
"""
|
|
List all members of a tenant.
|
|
|
|
Requires at least viewer role in the tenant.
|
|
"""
|
|
from fastapi import Request as FastAPIRequest
|
|
from starlette.requests import Request
|
|
|
|
try:
|
|
# Get tenant service
|
|
import inspect
|
|
frame = inspect.currentframe()
|
|
while frame:
|
|
if 'request' in frame.f_locals and isinstance(frame.f_locals['request'], Request):
|
|
req = frame.f_locals['request']
|
|
break
|
|
frame = frame.f_back
|
|
|
|
if not req or not hasattr(req.app.state, 'rag_manager'):
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail="Service not initialized"
|
|
)
|
|
|
|
tenant_service = req.app.state.rag_manager.tenant_service
|
|
|
|
# Verify requester has access
|
|
has_access = await tenant_service.verify_user_access(
|
|
user_id=context.user_id,
|
|
tenant_id=tenant_id,
|
|
required_role="viewer"
|
|
)
|
|
|
|
if not has_access:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_403_FORBIDDEN,
|
|
detail="Access denied to tenant"
|
|
)
|
|
|
|
# Get members
|
|
result = await tenant_service.get_tenant_members(
|
|
tenant_id=tenant_id,
|
|
skip=skip,
|
|
limit=limit
|
|
)
|
|
|
|
members = [
|
|
MemberResponse(
|
|
user_id=m["user_id"],
|
|
role=UserRole(m["role"]),
|
|
created_at=m["created_at"],
|
|
created_by=m["created_by"]
|
|
)
|
|
for m in result["items"]
|
|
]
|
|
|
|
return PaginatedMembersResponse(
|
|
items=members,
|
|
total=result["total"],
|
|
skip=skip,
|
|
limit=limit
|
|
)
|
|
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Error listing tenant members: {e}")
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail=str(e)
|
|
)
|
|
|
|
|
|
@router.put(
|
|
"/tenants/{tenant_id}/members/{user_id}",
|
|
response_model=MemberResponse,
|
|
dependencies=[Depends(get_combined_auth_dependency())]
|
|
)
|
|
async def update_member_role(
|
|
tenant_id: str,
|
|
user_id: str,
|
|
request: UpdateMemberRoleRequest,
|
|
context: TenantContext = Depends(get_tenant_context_no_kb)
|
|
):
|
|
"""
|
|
Update a member's role in a tenant.
|
|
|
|
Requires admin or owner role in the tenant.
|
|
"""
|
|
from fastapi import Request as FastAPIRequest
|
|
from starlette.requests import Request
|
|
|
|
try:
|
|
# Get tenant service
|
|
import inspect
|
|
frame = inspect.currentframe()
|
|
while frame:
|
|
if 'request' in frame.f_locals and isinstance(frame.f_locals['request'], Request):
|
|
req = frame.f_locals['request']
|
|
break
|
|
frame = frame.f_back
|
|
|
|
if not req or not hasattr(req.app.state, 'rag_manager'):
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail="Service not initialized"
|
|
)
|
|
|
|
tenant_service = req.app.state.rag_manager.tenant_service
|
|
|
|
# Verify requester has admin or owner role
|
|
has_permission = await tenant_service.verify_user_access(
|
|
user_id=context.user_id,
|
|
tenant_id=tenant_id,
|
|
required_role="admin"
|
|
)
|
|
|
|
if not has_permission:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_403_FORBIDDEN,
|
|
detail="Insufficient permissions. Admin or owner role required."
|
|
)
|
|
|
|
# Update role
|
|
membership = await tenant_service.update_user_role(
|
|
user_id=user_id,
|
|
tenant_id=tenant_id,
|
|
new_role=request.role.value
|
|
)
|
|
|
|
return MemberResponse(
|
|
user_id=membership["user_id"],
|
|
role=UserRole(membership["role"]),
|
|
created_at=membership["created_at"],
|
|
created_by=membership["created_by"]
|
|
)
|
|
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Error updating member role: {e}")
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail=str(e)
|
|
)
|
|
|
|
|
|
@router.delete(
|
|
"/tenants/{tenant_id}/members/{user_id}",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
dependencies=[Depends(get_combined_auth_dependency())]
|
|
)
|
|
async def remove_member_from_tenant(
|
|
tenant_id: str,
|
|
user_id: str,
|
|
context: TenantContext = Depends(get_tenant_context_no_kb)
|
|
):
|
|
"""
|
|
Remove a member from a tenant.
|
|
|
|
Requires admin or owner role in the tenant.
|
|
"""
|
|
from fastapi import Request as FastAPIRequest
|
|
from starlette.requests import Request
|
|
|
|
try:
|
|
# Get tenant service
|
|
import inspect
|
|
frame = inspect.currentframe()
|
|
while frame:
|
|
if 'request' in frame.f_locals and isinstance(frame.f_locals['request'], Request):
|
|
req = frame.f_locals['request']
|
|
break
|
|
frame = frame.f_back
|
|
|
|
if not req or not hasattr(req.app.state, 'rag_manager'):
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail="Service not initialized"
|
|
)
|
|
|
|
tenant_service = req.app.state.rag_manager.tenant_service
|
|
|
|
# Verify requester has admin or owner role
|
|
has_permission = await tenant_service.verify_user_access(
|
|
user_id=context.user_id,
|
|
tenant_id=tenant_id,
|
|
required_role="admin"
|
|
)
|
|
|
|
if not has_permission:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_403_FORBIDDEN,
|
|
detail="Insufficient permissions. Admin or owner role required."
|
|
)
|
|
|
|
# Remove member
|
|
removed = await tenant_service.remove_user_from_tenant(
|
|
user_id=user_id,
|
|
tenant_id=tenant_id
|
|
)
|
|
|
|
if not removed:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_404_NOT_FOUND,
|
|
detail=f"User {user_id} is not a member of tenant {tenant_id}"
|
|
)
|
|
|
|
return None
|
|
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Error removing member from tenant: {e}")
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail=str(e)
|
|
)
|
|
|
|
|
|
@router.get(
|
|
"/users/me/tenants",
|
|
dependencies=[Depends(get_combined_auth_dependency())]
|
|
)
|
|
async def get_my_tenants(
|
|
context: TenantContext = Depends(get_tenant_context_no_kb),
|
|
skip: int = Query(0, ge=0),
|
|
limit: int = Query(20, ge=1, le=100)
|
|
):
|
|
"""
|
|
Get all tenants the current user has access to.
|
|
"""
|
|
from fastapi import Request as FastAPIRequest
|
|
from starlette.requests import Request
|
|
|
|
try:
|
|
# Get tenant service
|
|
import inspect
|
|
frame = inspect.currentframe()
|
|
while frame:
|
|
if 'request' in frame.f_locals and isinstance(frame.f_locals['request'], Request):
|
|
req = frame.f_locals['request']
|
|
break
|
|
frame = frame.f_back
|
|
|
|
if not req or not hasattr(req.app.state, 'rag_manager'):
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail="Service not initialized"
|
|
)
|
|
|
|
tenant_service = req.app.state.rag_manager.tenant_service
|
|
|
|
# Get user's tenants
|
|
result = await tenant_service.get_user_tenants(
|
|
user_id=context.user_id,
|
|
skip=skip,
|
|
limit=limit
|
|
)
|
|
|
|
return result
|
|
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Error getting user tenants: {e}")
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
detail=str(e)
|
|
)
|