LightRAG/lightrag_webui/src/features/TenantSelectionPage.tsx
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

203 lines
7.8 KiB
TypeScript

import { useState, useEffect, useMemo } from 'react'
import { fetchTenantsPaginated } from '@/api/tenant'
import { Tenant, useTenantState } from '@/stores/tenant'
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from '@/components/ui/Card'
import Button from '@/components/ui/Button'
import Input from '@/components/ui/Input'
import { Loader2, Search, Building2, Clock, Database, FileText, HardDrive } from 'lucide-react'
// Storage key for last selected tenant
const LAST_TENANT_KEY = 'lightrag:lastSelectedTenant'
interface TenantSelectionPageProps {
onSelect: (tenant: Tenant) => void
}
export default function TenantSelectionPage({ onSelect }: TenantSelectionPageProps) {
const [tenants, setTenants] = useState<Tenant[]>([])
const [loading, setLoading] = useState(true)
const [search, setSearch] = useState('')
const [page, setPage] = useState(1)
const [totalPages, setTotalPages] = useState(1)
const [error, setError] = useState<string | null>(null)
const setSelectedTenant = useTenantState.use.setSelectedTenant()
// Track last selected tenant ID
const [lastTenantId] = useState<string | null>(() => {
try {
return sessionStorage.getItem(LAST_TENANT_KEY)
} catch {
return null
}
})
const loadTenants = async () => {
setLoading(true)
setError(null)
try {
const response = await fetchTenantsPaginated(page, 12, search)
setTenants(response.items)
setTotalPages(response.total_pages)
} catch (err) {
console.error('Failed to load tenants', err)
setError('Failed to load tenants. Please try again.')
} finally {
setLoading(false)
}
}
useEffect(() => {
const timer = setTimeout(() => {
loadTenants()
}, 300)
return () => clearTimeout(timer)
}, [page, search])
const handleSelect = (tenant: Tenant) => {
// Set in store (which handles localStorage)
setSelectedTenant(tenant)
// Save as last selected tenant for next time
try {
sessionStorage.setItem(LAST_TENANT_KEY, tenant.tenant_id)
} catch (e) {
console.warn('Failed to save last tenant', e)
}
onSelect(tenant)
}
// Sort tenants to show last selected first
const sortedTenants = useMemo(() => {
if (!lastTenantId) return tenants
return [...tenants].sort((a, b) => {
if (a.tenant_id === lastTenantId) return -1
if (b.tenant_id === lastTenantId) return 1
return 0
})
}, [tenants, lastTenantId])
// Check if a tenant was recently selected
const isLastSelected = (tenantId: string) => tenantId === lastTenantId
return (
<div className="min-h-screen bg-background flex flex-col items-center justify-center p-4">
<div className="w-full max-w-4xl space-y-8">
<div className="text-center space-y-2">
<h1 className="text-4xl font-bold tracking-tight">Welcome to LightRAG</h1>
<p className="text-muted-foreground text-lg">Select a tenant to continue to the dashboard</p>
</div>
<div className="flex items-center space-x-2 max-w-md mx-auto">
<div className="relative flex-1">
<Search className="absolute left-2.5 top-2.5 h-4 w-4 text-muted-foreground" />
<Input
type="search"
placeholder="Search tenants..."
className="pl-9"
value={search}
onChange={(e) => setSearch(e.target.value)}
/>
</div>
</div>
{error && (
<div className="text-center text-destructive bg-destructive/10 p-4 rounded-md">
{error}
<Button variant="link" onClick={loadTenants} className="ml-2">Retry</Button>
</div>
)}
{loading ? (
<div className="flex justify-center py-12">
<Loader2 className="h-8 w-8 animate-spin text-primary" />
</div>
) : (
<div className="grid grid-cols-1 md:grid-cols-2 gap-6">
{sortedTenants.map((tenant) => (
<Card
key={tenant.tenant_id}
className={`cursor-pointer hover:border-primary hover:shadow-lg transition-all duration-200 ${
isLastSelected(tenant.tenant_id) ? 'border-primary/50 bg-primary/5 ring-2 ring-primary/20' : ''
}`}
onClick={() => handleSelect(tenant)}
>
<CardHeader className="pb-3">
<div className="flex items-start justify-between gap-3">
<div className="flex-1 min-w-0">
<div className="flex items-center gap-2 mb-1">
<Building2 className="h-5 w-5 text-primary flex-shrink-0" />
<CardTitle className="text-lg font-semibold leading-tight">
{tenant.name || tenant.tenant_name || tenant.tenant_id}
</CardTitle>
</div>
{isLastSelected(tenant.tenant_id) && (
<span className="inline-flex items-center gap-1 text-xs text-primary bg-primary/10 px-2 py-0.5 rounded-full mb-2">
<Clock className="h-3 w-3" />
Recently used
</span>
)}
</div>
</div>
<CardDescription className="text-sm leading-relaxed mt-1">
{tenant.description || 'No description available'}
</CardDescription>
</CardHeader>
<CardContent className="pt-0">
<div className="grid grid-cols-3 gap-3 pt-3 border-t border-border/50">
<div className="flex flex-col items-center p-2 rounded-lg bg-muted/50">
<Database className="h-4 w-4 text-blue-500 mb-1" />
<span className="text-lg font-bold">{tenant.num_knowledge_bases || 0}</span>
<span className="text-xs text-muted-foreground">KBs</span>
</div>
<div className="flex flex-col items-center p-2 rounded-lg bg-muted/50">
<FileText className="h-4 w-4 text-green-500 mb-1" />
<span className="text-lg font-bold">{tenant.num_documents || 0}</span>
<span className="text-xs text-muted-foreground">Docs</span>
</div>
<div className="flex flex-col items-center p-2 rounded-lg bg-muted/50">
<HardDrive className="h-4 w-4 text-orange-500 mb-1" />
<span className="text-lg font-bold">
{tenant.storage_used_gb ? `${tenant.storage_used_gb.toFixed(1)}` : '0'}
</span>
<span className="text-xs text-muted-foreground">GB</span>
</div>
</div>
</CardContent>
</Card>
))}
{tenants.length === 0 && !loading && (
<div className="col-span-full text-center py-12 text-muted-foreground">
No tenants found matching your search.
</div>
)}
</div>
)}
{totalPages > 1 && (
<div className="flex justify-center space-x-2 mt-8">
<Button
variant="outline"
disabled={page <= 1}
onClick={() => setPage(p => p - 1)}
>
Previous
</Button>
<div className="flex items-center px-4 text-sm">
Page {page} of {totalPages}
</div>
<Button
variant="outline"
disabled={page >= totalPages}
onClick={() => setPage(p => p + 1)}
>
Next
</Button>
</div>
)}
</div>
</div>
)
}