LightRAG/logs/2025-12-04-11-50-fix-tenant-stats-document-count.md
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

3.9 KiB

Session Log: Fix Tenant Statistics - Document Count Issue

Date: 2025-12-04

Summary

Fixed the tenant card statistics to correctly display document count and storage usage. The issue was that documents were stored in lightrag_doc_full table (with workspace column) instead of the documents table.

Problem

The tenant selection cards were showing "0 Docs" for TechStart tenant even though there was 1 document in the Main KB. Additionally, storage_used_gb was always 0.

Root Cause Analysis

The SQL query in list_tenants was looking for documents in the documents table, which was empty. The actual documents are stored in the lightrag_doc_full table with a workspace column in format {tenant_id}:{kb_id}.

Database investigation showed:

  • documents table: Empty (0 rows)
  • lightrag_doc_full table: Contains actual documents with workspace field
  • Example: workspace = techstart:kb-main for TechStart tenant's Main KB

Solution

Updated the SQL query to:

  1. Count documents from lightrag_doc_full table
  2. Extract tenant_id from the workspace column using SPLIT_PART(workspace, ':', 1)
  3. Calculate storage from content length instead of file_size
  4. Join this data with tenant and KB statistics

Updated SQL Query

SELECT 
    t.tenant_id, 
    t.name, 
    t.description, 
    t.created_at, 
    t.updated_at,
    COALESCE(kb_stats.kb_count, 0) as kb_count,
    COALESCE(doc_stats.doc_count, 0) as total_documents,
    COALESCE(doc_stats.total_size_bytes, 0) as total_size_bytes
FROM tenants t
LEFT JOIN (
    SELECT tenant_id, COUNT(*) as kb_count 
    FROM knowledge_bases 
    GROUP BY tenant_id
) kb_stats ON t.tenant_id = kb_stats.tenant_id
LEFT JOIN (
    SELECT 
        SPLIT_PART(workspace, ':', 1) as tenant_id,
        COUNT(*) as doc_count, 
        COALESCE(SUM(LENGTH(content)), 0) as total_size_bytes
    FROM lightrag_doc_full 
    GROUP BY SPLIT_PART(workspace, ':', 1)
) doc_stats ON t.tenant_id = doc_stats.tenant_id
ORDER BY t.created_at DESC

Results

Before Fix:

{
    "tenant_id": "techstart",
    "num_knowledge_bases": 2,
    "num_documents": 0,
    "storage_used_gb": 0.0
}

After Fix:

{
    "tenant_id": "techstart",
    "num_knowledge_bases": 2,
    "num_documents": 1,
    "storage_used_gb": 0.00010807719081640244
}

Verification

Tenant cards now show correct document count:

  • TechStart Inc: "1 Doc" (was "0 Docs")
  • Acme Corporation: "0 Docs" (correct, no documents)

Storage usage now calculated from actual content:

  • TechStart Inc: 0.00010807719081640244 GB (was 0.0)

KB count remains correct:

  • Both tenants: "2 KBs"

Code Changes

File: /lightrag/services/tenant_service.py (lines 612-644)

  • Updated SQL query to use lightrag_doc_full table
  • Used SPLIT_PART(workspace, ':', 1) to extract tenant_id
  • Changed storage calculation to use SUM(LENGTH(content))

Files Modified

  1. /lightrag/services/tenant_service.py - Updated list_tenants SQL query

Testing

  • Restarted backend server
  • Verified API returns correct stats via curl
  • Verified tenant selection cards display correct values
  • Document count matches actual data in database

Task Logs

Actions:

  • Investigated database schema to find actual document storage location
  • Updated SQL query to count from lightrag_doc_full instead of documents table
  • Extracted tenant_id from workspace column using SPLIT_PART
  • Restarted backend and verified stats are now correct

Decisions:

  • Used LENGTH(content) for storage calculation since file_size was not available
  • Used SPLIT_PART to parse workspace field rather than a JOIN on a computed column

Insights:

  • LightRAG uses two document storage modes: workspace mode (lightrag_doc_full) and tenant mode (documents)
  • The system was using workspace mode which stores workspace as {tenant_id}:{kb_id}
  • Statistics need to aggregate data across both storage modes or correctly identify which one is in use