Files
Claude-Code-Workflow/codex-lens/tests/test_performance_optimizations.py
catlog22 0529b57694 Implement database migration framework and performance optimizations
- Added active memory configuration for manual interval and Gemini tool.
- Created file modification rules for handling edits and writes.
- Implemented migration manager for managing database schema migrations.
- Added migration 001 to normalize keywords into separate tables.
- Developed tests for validating performance optimizations including keyword normalization, path lookup, and symbol search.
- Created validation script to manually verify optimization implementations.
2025-12-14 18:08:32 +08:00

468 lines
17 KiB
Python

"""Tests for performance optimizations in CodexLens storage.
This module tests the following optimizations:
1. Normalized keywords search (migration_001)
2. Optimized path lookup in registry
3. Prefix-mode symbol search
"""
import json
import sqlite3
import tempfile
import time
from pathlib import Path
import pytest
from codexlens.storage.dir_index import DirIndexStore
from codexlens.storage.registry import RegistryStore
from codexlens.storage.migration_manager import MigrationManager
from codexlens.storage.migrations import migration_001_normalize_keywords
@pytest.fixture
def temp_index_db():
"""Create a temporary dir index database."""
with tempfile.TemporaryDirectory() as tmpdir:
db_path = Path(tmpdir) / "test_index.db"
store = DirIndexStore(db_path)
store.initialize() # Initialize schema
yield store
store.close()
@pytest.fixture
def temp_registry_db():
"""Create a temporary registry database."""
with tempfile.TemporaryDirectory() as tmpdir:
db_path = Path(tmpdir) / "test_registry.db"
store = RegistryStore(db_path)
store.initialize() # Initialize schema
yield store
store.close()
@pytest.fixture
def populated_index_db(temp_index_db):
"""Create an index database with sample data.
Uses 100 files to provide meaningful performance comparison between
optimized and fallback implementations.
"""
from codexlens.entities import Symbol
store = temp_index_db
# Add files with symbols and keywords
# Using 100 files to show performance improvements
file_ids = []
# Define keyword pools for cycling
keyword_pools = [
["auth", "security", "jwt"],
["database", "sql", "query"],
["auth", "login", "password"],
["api", "rest", "endpoint"],
["cache", "redis", "performance"],
["auth", "oauth", "token"],
["test", "unittest", "pytest"],
["database", "postgres", "migration"],
["api", "graphql", "resolver"],
["security", "encryption", "crypto"]
]
for i in range(100):
# Create symbols for first 50 files to have more symbol search data
symbols = None
if i < 50:
symbols = [
Symbol(name=f"get_user_{i}", kind="function", range=(1, 10)),
Symbol(name=f"create_user_{i}", kind="function", range=(11, 20)),
Symbol(name=f"UserClass_{i}", kind="class", range=(21, 40)),
]
file_id = store.add_file(
name=f"file_{i}.py",
full_path=Path(f"/test/path/file_{i}.py"),
content=f"def function_{i}(): pass\n" * 10,
language="python",
symbols=symbols
)
file_ids.append(file_id)
# Add semantic metadata with keywords (cycle through keyword pools)
keywords = keyword_pools[i % len(keyword_pools)]
store.add_semantic_metadata(
file_id=file_id,
summary=f"Test file {file_id}",
keywords=keywords,
purpose="Testing",
llm_tool="gemini"
)
return store
class TestKeywordNormalization:
"""Test normalized keywords functionality."""
def test_migration_creates_tables(self, temp_index_db):
"""Test that migration creates keywords and file_keywords tables."""
conn = temp_index_db._get_connection()
# Verify tables exist (created by _create_schema)
tables = conn.execute("""
SELECT name FROM sqlite_master
WHERE type='table' AND name IN ('keywords', 'file_keywords')
""").fetchall()
assert len(tables) == 2
def test_migration_creates_indexes(self, temp_index_db):
"""Test that migration creates necessary indexes."""
conn = temp_index_db._get_connection()
# Check for indexes
indexes = conn.execute("""
SELECT name FROM sqlite_master
WHERE type='index' AND name IN (
'idx_keywords_keyword',
'idx_file_keywords_file_id',
'idx_file_keywords_keyword_id'
)
""").fetchall()
assert len(indexes) == 3
def test_add_semantic_metadata_populates_normalized_tables(self, temp_index_db):
"""Test that adding metadata populates both old and new tables."""
# Add a file
file_id = temp_index_db.add_file(
name="test.py",
full_path=Path("/test/test.py"),
language="python",
content="test"
)
# Add semantic metadata
keywords = ["auth", "security", "jwt"]
temp_index_db.add_semantic_metadata(
file_id=file_id,
summary="Test summary",
keywords=keywords,
purpose="Testing",
llm_tool="gemini"
)
conn = temp_index_db._get_connection()
# Check semantic_metadata table (backward compatibility)
row = conn.execute(
"SELECT keywords FROM semantic_metadata WHERE file_id=?",
(file_id,)
).fetchone()
assert row is not None
assert json.loads(row["keywords"]) == keywords
# Check normalized keywords table
keyword_rows = conn.execute("""
SELECT k.keyword
FROM file_keywords fk
JOIN keywords k ON fk.keyword_id = k.id
WHERE fk.file_id = ?
""", (file_id,)).fetchall()
assert len(keyword_rows) == 3
normalized_keywords = [row["keyword"] for row in keyword_rows]
assert set(normalized_keywords) == set(keywords)
def test_search_semantic_keywords_normalized(self, populated_index_db):
"""Test optimized keyword search using normalized tables."""
results = populated_index_db.search_semantic_keywords("auth", use_normalized=True)
# Should find 3 files with "auth" keyword
assert len(results) >= 3
# Verify results structure
for file_entry, keywords in results:
assert file_entry.name.startswith("file_")
assert isinstance(keywords, list)
assert any("auth" in k.lower() for k in keywords)
def test_search_semantic_keywords_fallback(self, populated_index_db):
"""Test that fallback search still works."""
results = populated_index_db.search_semantic_keywords("auth", use_normalized=False)
# Should find files with "auth" keyword
assert len(results) >= 3
for file_entry, keywords in results:
assert isinstance(keywords, list)
class TestPathLookupOptimization:
"""Test optimized path lookup in registry."""
def test_find_nearest_index_shallow(self, temp_registry_db):
"""Test path lookup with shallow directory structure."""
# Register a project first
project = temp_registry_db.register_project(
source_root=Path("/test"),
index_root=Path("/tmp")
)
# Register directory mapping
temp_registry_db.register_dir(
project_id=project.id,
source_path=Path("/test"),
index_path=Path("/tmp/index.db"),
depth=0,
files_count=0
)
# Search for subdirectory
result = temp_registry_db.find_nearest_index(Path("/test/subdir/file.py"))
assert result is not None
# Compare as strings for cross-platform compatibility
assert "/test" in str(result.source_path) or "\\test" in str(result.source_path)
def test_find_nearest_index_deep(self, temp_registry_db):
"""Test path lookup with deep directory structure."""
# Register a project
project = temp_registry_db.register_project(
source_root=Path("/a"),
index_root=Path("/tmp")
)
# Add directory mappings at different levels
temp_registry_db.register_dir(
project_id=project.id,
source_path=Path("/a"),
index_path=Path("/tmp/index_a.db"),
depth=0,
files_count=0
)
temp_registry_db.register_dir(
project_id=project.id,
source_path=Path("/a/b/c"),
index_path=Path("/tmp/index_abc.db"),
depth=2,
files_count=0
)
# Should find nearest (longest) match
result = temp_registry_db.find_nearest_index(Path("/a/b/c/d/e/f/file.py"))
assert result is not None
# Check that path contains the key parts
result_path = str(result.source_path)
assert "a" in result_path and "b" in result_path and "c" in result_path
def test_find_nearest_index_not_found(self, temp_registry_db):
"""Test path lookup when no mapping exists."""
result = temp_registry_db.find_nearest_index(Path("/nonexistent/path"))
assert result is None
def test_find_nearest_index_performance(self, temp_registry_db):
"""Basic performance test for path lookup."""
# Register a project
project = temp_registry_db.register_project(
source_root=Path("/root"),
index_root=Path("/tmp")
)
# Add mapping at root
temp_registry_db.register_dir(
project_id=project.id,
source_path=Path("/root"),
index_path=Path("/tmp/index.db"),
depth=0,
files_count=0
)
# Test with very deep path (10 levels)
deep_path = Path("/root/a/b/c/d/e/f/g/h/i/j/file.py")
start = time.perf_counter()
result = temp_registry_db.find_nearest_index(deep_path)
elapsed = time.perf_counter() - start
# Should complete quickly (< 50ms even on slow systems)
assert elapsed < 0.05
assert result is not None
class TestSymbolSearchOptimization:
"""Test optimized symbol search."""
def test_symbol_search_prefix_mode(self, populated_index_db):
"""Test symbol search with prefix mode."""
results = populated_index_db.search_symbols("get", prefix_mode=True)
# Should find symbols starting with "get"
assert len(results) > 0
for symbol in results:
assert symbol.name.startswith("get")
def test_symbol_search_substring_mode(self, populated_index_db):
"""Test symbol search with substring mode."""
results = populated_index_db.search_symbols("user", prefix_mode=False)
# Should find symbols containing "user"
assert len(results) > 0
for symbol in results:
assert "user" in symbol.name.lower()
def test_symbol_search_with_kind_filter(self, populated_index_db):
"""Test symbol search with kind filter."""
results = populated_index_db.search_symbols(
"UserClass",
kind="class",
prefix_mode=True
)
# Should find only class symbols
assert len(results) > 0
for symbol in results:
assert symbol.kind == "class"
def test_symbol_search_limit(self, populated_index_db):
"""Test symbol search respects limit."""
results = populated_index_db.search_symbols("", prefix_mode=True, limit=5)
# Should return at most 5 results
assert len(results) <= 5
class TestMigrationManager:
"""Test migration manager functionality."""
def test_migration_manager_tracks_version(self, temp_index_db):
"""Test that migration manager tracks schema version."""
conn = temp_index_db._get_connection()
manager = MigrationManager(conn)
current_version = manager.get_current_version()
assert current_version >= 0
def test_migration_001_can_run(self, temp_index_db):
"""Test that migration_001 can be applied."""
conn = temp_index_db._get_connection()
# Add some test data to semantic_metadata first
conn.execute("""
INSERT INTO files(id, name, full_path, language, content, mtime, line_count)
VALUES(100, 'test.py', '/test_migration.py', 'python', 'def test(): pass', 0, 10)
""")
conn.execute("""
INSERT INTO semantic_metadata(file_id, keywords)
VALUES(100, ?)
""", (json.dumps(["test", "keyword"]),))
conn.commit()
# Run migration (should be idempotent, tables already created by initialize())
try:
migration_001_normalize_keywords.upgrade(conn)
success = True
except Exception as e:
success = False
print(f"Migration failed: {e}")
assert success
# Verify data was migrated
keyword_count = conn.execute("""
SELECT COUNT(*) as c FROM file_keywords WHERE file_id=100
""").fetchone()["c"]
assert keyword_count == 2 # "test" and "keyword"
class TestPerformanceComparison:
"""Compare performance of old vs new implementations."""
def test_keyword_search_performance(self, populated_index_db):
"""Compare keyword search performance.
IMPORTANT: The normalized query optimization is designed for large datasets
(1000+ files). On small datasets (< 1000 files), the overhead of JOINs and
GROUP BY operations can make the normalized query slower than the simple
LIKE query on JSON fields. This is expected behavior.
Performance benefits appear when:
- Dataset size > 1000 files
- Full-table scans on JSON LIKE become the bottleneck
- Index-based lookups provide O(log N) complexity advantage
"""
# Normalized search
start = time.perf_counter()
normalized_results = populated_index_db.search_semantic_keywords(
"auth",
use_normalized=True
)
normalized_time = time.perf_counter() - start
# Fallback search
start = time.perf_counter()
fallback_results = populated_index_db.search_semantic_keywords(
"auth",
use_normalized=False
)
fallback_time = time.perf_counter() - start
# Verify correctness: both queries should return identical results
assert len(normalized_results) == len(fallback_results)
# Verify result content matches
normalized_files = {entry.id for entry, _ in normalized_results}
fallback_files = {entry.id for entry, _ in fallback_results}
assert normalized_files == fallback_files, "Both queries must return same files"
# Document performance characteristics (no strict assertion)
# On datasets < 1000 files, normalized may be slower due to JOIN overhead
print(f"\nKeyword search performance (100 files):")
print(f" Normalized: {normalized_time*1000:.3f}ms")
print(f" Fallback: {fallback_time*1000:.3f}ms")
print(f" Ratio: {normalized_time/fallback_time:.2f}x")
print(f" Note: Performance benefits appear with 1000+ files")
def test_prefix_vs_substring_symbol_search(self, populated_index_db):
"""Compare prefix vs substring symbol search performance.
IMPORTANT: Prefix search optimization (LIKE 'prefix%') benefits from B-tree
indexes, but on small datasets (< 1000 symbols), the performance difference
may not be measurable or may even be slower due to query planner overhead.
Performance benefits appear when:
- Symbol count > 1000
- Index-based prefix search provides O(log N) advantage
- Full table scans with LIKE '%substring%' become bottleneck
"""
# Prefix search (optimized)
start = time.perf_counter()
prefix_results = populated_index_db.search_symbols("get", prefix_mode=True)
prefix_time = time.perf_counter() - start
# Substring search (fallback)
start = time.perf_counter()
substring_results = populated_index_db.search_symbols("get", prefix_mode=False)
substring_time = time.perf_counter() - start
# Verify correctness: prefix results should be subset of substring results
prefix_names = {s.name for s in prefix_results}
substring_names = {s.name for s in substring_results}
assert prefix_names.issubset(substring_names), "Prefix must be subset of substring"
# Verify all prefix results actually start with search term
for symbol in prefix_results:
assert symbol.name.startswith("get"), f"Symbol {symbol.name} should start with 'get'"
# Document performance characteristics (no strict assertion)
# On datasets < 1000 symbols, performance difference is negligible
print(f"\nSymbol search performance (150 symbols):")
print(f" Prefix: {prefix_time*1000:.3f}ms ({len(prefix_results)} results)")
print(f" Substring: {substring_time*1000:.3f}ms ({len(substring_results)} results)")
print(f" Ratio: {prefix_time/substring_time:.2f}x")
print(f" Note: Performance benefits appear with 1000+ symbols")