* 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
101 lines
3.9 KiB
Markdown
101 lines
3.9 KiB
Markdown
# Session Log: Fix Loading State Race Condition
|
|
|
|
## Date: 2025-12-04
|
|
|
|
## Summary
|
|
Fixed the infinite loading spinner issue when selecting an empty Knowledge Base in the DocumentManager component.
|
|
|
|
## Problem Description
|
|
When a user selected an empty Knowledge Base from the KB selector dropdown, the loading spinner would spin forever instead of showing the "No Documents Yet" empty state.
|
|
|
|
## Root Cause Analysis
|
|
**Race condition between localStorage and Zustand state updates:**
|
|
|
|
1. When `setSelectedKB` is called, it updates:
|
|
- localStorage (synchronously)
|
|
- Zustand store state (asynchronously via React batch updates)
|
|
|
|
2. The central data-fetching effect in DocumentManager was using Zustand state (`selectedKB`) in its dependency array and comparisons
|
|
|
|
3. When the effect triggered, it captured the OLD closure value of `selectedKB` (which was `undefined` or the previous KB)
|
|
|
|
4. The `isTenantContextReady()` check compared localStorage values against Zustand values:
|
|
```typescript
|
|
if (parsedKB?.kb_id !== selectedKB?.kb_id) return false; // FAILS!
|
|
```
|
|
|
|
5. This check failed because localStorage had the new KB but Zustand still had the old value
|
|
|
|
6. Result: The effect returned early, never fetched documents, spinner never stopped
|
|
|
|
## Solution
|
|
Made DocumentManager rely on localStorage as the authoritative source instead of comparing against Zustand state:
|
|
|
|
### 1. Fixed `isTenantContextReady()` function (lines 683-715)
|
|
- Changed from checking Zustand+localStorage match to only checking localStorage
|
|
- Now only verifies that valid tenant and KB exist in localStorage
|
|
- Removed dependency on Zustand state values
|
|
|
|
### 2. Fixed Central Effect (lines 1183-1237)
|
|
- Removed `selectedKB` from closure dependencies
|
|
- Now reads directly from localStorage instead of `selectedKB?.kb_id`
|
|
- Uses `getStoredTenantContext()` helper for localStorage access
|
|
|
|
### 3. Fixed Render Guard (lines 1253-1268)
|
|
- Added fallback to check localStorage when Zustand state is undefined
|
|
- Prevents flash of "Please select a KB" message during state sync
|
|
|
|
## Key Code Changes
|
|
|
|
### isTenantContextReady() - Before:
|
|
```typescript
|
|
if (parsedKB?.kb_id !== selectedKB?.kb_id) return false;
|
|
if (parsedTenant?.id !== selectedTenant?.id) return false;
|
|
```
|
|
|
|
### isTenantContextReady() - After:
|
|
```typescript
|
|
// Only check localStorage - don't compare against Zustand state
|
|
// The axios interceptor reads from localStorage anyway
|
|
if (!parsedTenant?.id || !parsedKB?.kb_id) return false;
|
|
return true;
|
|
```
|
|
|
|
## Verification
|
|
- Tested with Playwright MCP browser automation
|
|
- Empty KB "Backup KB" now shows "No Documents Yet" empty state
|
|
- KB "Main KB" with 1 document loads and displays correctly
|
|
- Switching between KBs works without infinite spinner
|
|
- TypeScript build passes with no errors
|
|
- Production build successful
|
|
|
|
## Files Modified
|
|
- `/lightrag_webui/src/features/DocumentManager.tsx`
|
|
|
|
## Lessons Learned
|
|
1. When using both localStorage and Zustand state, be aware of timing differences
|
|
2. Effects capture closure values at time of creation, not current values
|
|
3. For components that need sync with localStorage (like axios interceptors), read from localStorage directly rather than comparing against async state
|
|
4. Playwright MCP is excellent for debugging UX issues with real browser interactions
|
|
|
|
---
|
|
|
|
## Task Logs
|
|
|
|
### Actions:
|
|
- Fixed isTenantContextReady() to only validate localStorage
|
|
- Fixed central effect to read KB from localStorage
|
|
- Fixed render guard to check localStorage fallback
|
|
- Verified with Playwright testing
|
|
- Ran TypeScript and production builds
|
|
|
|
### Decisions:
|
|
- Chose localStorage as authority since axios interceptor reads from it
|
|
- Removed Zustand state comparison to avoid race condition
|
|
|
|
### Next Steps:
|
|
- Monitor for any edge cases with KB switching
|
|
- Consider adding localStorage change listener for more robust sync
|
|
|
|
### Lessons/Insights:
|
|
- Zustand updates are async; localStorage is sync; effects capture closures at trigger time
|