LightRAG/Makefile
Raphael MANSUY fe9b8ec02a
tests: stabilize integration tests + skip external services; fix multi-tenant API behavior and idempotency (#4)
* 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
2025-12-04 16:04:21 +08:00

169 lines
6.7 KiB
Makefile

# ============================================================================
# LightRAG Development Makefile
# ============================================================================
# Quick commands for local development
# Uses .env file at project root for configuration
# ============================================================================
.PHONY: help dev dev-start dev-stop dev-status dev-logs dev-logs-api dev-logs-webui \
db-only db-stop db-shell db-logs clean-db install test lint
# Colors
BLUE := \033[0;34m
GREEN := \033[0;32m
YELLOW := \033[1;33m
CYAN := \033[0;36m
RED := \033[0;31m
BOLD := \033[1m
DIM := \033[2m
NC := \033[0m
# ============================================================================
# HELP - Default target
# ============================================================================
help:
@echo ""
@echo "$(BLUE)╔══════════════════════════════════════════════════════════════════════════╗$(NC)"
@echo "$(BLUE)$(NC) $(CYAN)$(BOLD)⚡ LightRAG Development Commands$(NC) $(BLUE)$(NC)"
@echo "$(BLUE)╚══════════════════════════════════════════════════════════════════════════╝$(NC)"
@echo ""
@echo "$(GREEN)$(BOLD)🚀 Quick Start:$(NC)"
@echo " $(YELLOW)make dev$(NC) Start full dev stack (Docker DBs + local API/WebUI)"
@echo " $(YELLOW)make dev CONFIRM_KILL=yes$(NC) Auto-kill processes/containers occupying dev ports (use carefully)"
@echo ""
@echo "$(GREEN)$(BOLD)📋 Development Commands:$(NC)"
@echo " $(YELLOW)make dev$(NC) Start everything (PostgreSQL, Redis, API, WebUI)"
@echo " $(YELLOW)make dev-stop$(NC) Stop all development services"
@echo " $(YELLOW)make dev-status$(NC) Check status of all services"
@echo " $(YELLOW)make dev-logs$(NC) View all logs (API + WebUI)"
@echo " $(YELLOW)make dev-logs-api$(NC) View API server logs only"
@echo " $(YELLOW)make dev-logs-webui$(NC) View WebUI logs only"
@echo ""
@echo "$(GREEN)$(BOLD)🗄️ Database Only (Docker):$(NC)"
@echo " $(YELLOW)make db-only$(NC) Start only PostgreSQL + Redis in Docker"
@echo " $(YELLOW)make db-stop$(NC) Stop PostgreSQL + Redis containers"
@echo " $(YELLOW)make db-shell$(NC) Connect to PostgreSQL shell"
@echo " $(YELLOW)make db-logs$(NC) View database container logs"
@echo " $(YELLOW)make clean-db$(NC) Remove database volumes (⚠️ deletes data!)"
@echo ""
@echo "$(GREEN)$(BOLD)🔧 Setup & Utilities:$(NC)"
@echo " $(YELLOW)make install$(NC) Install Python + WebUI dependencies"
@echo " $(YELLOW)make test$(NC) Run tests"
@echo " $(YELLOW)make lint$(NC) Run linters"
@echo ""
@echo "$(GREEN)$(BOLD)📡 Service URLs (when running):$(NC)"
@echo " • WebUI: $(BLUE)http://localhost:5173$(NC)"
@echo " • API Server: $(BLUE)http://localhost:9621$(NC)"
@echo " • API Docs: $(BLUE)http://localhost:9621/docs$(NC)"
@echo ""
@echo "$(GREEN)$(BOLD)🔐 Default Credentials:$(NC)"
@echo " • Username: $(YELLOW)admin$(NC)"
@echo " • Password: $(YELLOW)admin123$(NC)"
@echo ""
@echo "$(DIM)Configuration: .env at project root$(NC)"
@echo ""
# ============================================================================
# DEVELOPMENT - Full Stack
# ============================================================================
## Start full development stack
dev: dev-start
## Start development stack (alias)
dev-start:
@chmod +x ./dev-start.sh
@if [ "$(CONFIRM_KILL)" = "yes" ] || [ "$(CONFIRM_KILL)" = "true" ]; then \
./dev-start.sh --yes ; \
else \
./dev-start.sh ; \
fi
## Stop development stack
dev-stop:
@chmod +x ./dev-stop.sh
@./dev-stop.sh
## Check status of services
dev-status:
@chmod +x ./dev-status.sh
@./dev-status.sh
## View all logs
dev-logs:
@echo "$(CYAN)$(BOLD)📄 API Server Logs:$(NC)"
@tail -n 50 /tmp/lightrag-dev-api.log 2>/dev/null || echo " No API logs found"
@echo ""
@echo "$(CYAN)$(BOLD)📄 WebUI Logs:$(NC)"
@tail -n 50 /tmp/lightrag-dev-webui.log 2>/dev/null || echo " No WebUI logs found"
## View API logs
dev-logs-api:
@tail -f /tmp/lightrag-dev-api.log
## View WebUI logs
dev-logs-webui:
@tail -f /tmp/lightrag-dev-webui.log
# ============================================================================
# DATABASE ONLY - Docker
# ============================================================================
## Start only database services (PostgreSQL + Redis)
db-only:
@echo "$(CYAN)$(BOLD)🗄️ Starting PostgreSQL + Redis...$(NC)"
@docker compose -f docker-compose.dev-db.yml --env-file .env up -d
@echo ""
@echo "$(GREEN)✓ Database services started$(NC)"
@echo ""
@echo " PostgreSQL: localhost:$${POSTGRES_PORT:-15432}"
@echo " Redis: localhost:$${REDIS_PORT:-16379}"
@echo ""
@echo "$(DIM)To start the full stack, run: make dev$(NC)"
## Stop database services
db-stop:
@echo "$(CYAN)$(BOLD)🛑 Stopping PostgreSQL + Redis...$(NC)"
@docker compose -f docker-compose.dev-db.yml down
@echo "$(GREEN)✓ Database services stopped$(NC)"
## Connect to PostgreSQL shell
db-shell:
@docker exec -it lightrag-dev-postgres psql -U $${POSTGRES_USER:-lightrag} -d $${POSTGRES_DATABASE:-lightrag_multitenant}
## View database logs
db-logs:
@docker compose -f docker-compose.dev-db.yml logs -f
## Remove database volumes (WARNING: deletes all data!)
clean-db:
@echo "$(RED)$(BOLD)⚠️ WARNING: This will delete all database data!$(NC)"
@echo "Press Ctrl+C to cancel, or wait 5 seconds to continue..."
@sleep 5
@docker compose -f docker-compose.dev-db.yml down -v
@echo "$(GREEN)✓ Database volumes removed$(NC)"
# ============================================================================
# SETUP & UTILITIES
# ============================================================================
## Install all dependencies
install:
@echo "$(CYAN)$(BOLD)📦 Installing Python dependencies...$(NC)"
@pip install -e ".[dev]" || pip install -e .
@echo ""
@echo "$(CYAN)$(BOLD)📦 Installing WebUI dependencies...$(NC)"
@cd lightrag_webui && (bun install 2>/dev/null || npm install)
@echo ""
@echo "$(GREEN)✓ All dependencies installed$(NC)"
## Run tests
test:
@echo "$(CYAN)$(BOLD)🧪 Running tests...$(NC)"
@python -m pytest tests/ -v
## Run linters
lint:
@echo "$(CYAN)$(BOLD)🔍 Running linters...$(NC)"
@python -m ruff check lightrag/ || true
@cd lightrag_webui && (bun run lint 2>/dev/null || npm run lint) || true