htm 0.0.1 → 0.0.10

data/CHANGELOG.md

@@ -7,22 +7,312 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.10] - 2025-12-02
+
+### Added
+- **Robot groups example with multi-process synchronization** - New `examples/robot_groups/` directory
+  - `RobotGroup` class for coordinating multiple robots with shared working memory
+  - `WorkingMemoryChannel` for real-time sync via PostgreSQL LISTEN/NOTIFY
+  - `same_process.rb` - Single-process demo of robot groups with failover
+  - `multi_process.rb` - Cross-process coordination with separate Ruby processes
+  - `robot_worker.rb` - Worker process for multi-process demo
+  - Demonstrates high-availability patterns: active/passive roles, warm standby, instant failover
+- **Examples directory README** - Comprehensive documentation for all example programs
+  - Describes 9 example programs across standalone scripts and application examples
+  - Usage instructions, features, and directory structure
+  - Quick reference table for choosing the right example
+
+### Changed
+- **YARD documentation updates** - Added documentation for metadata parameter support
+
+
+### Changed
+- **Refactored working memory persistence to robot_nodes join table** - Simpler, more efficient schema
+  - Added `working_memory` boolean column to `robot_nodes` table (default: false)
+  - Partial index `idx_robot_nodes_working_memory` for efficient queries on active working memory
+  - Working memory state now tracked per robot-node relationship
+  - `remember()` and `recall()` now set `working_memory = true` when adding to working memory
+  - Eviction sets `working_memory = false` on evicted nodes
+- **Updated `mark_evicted` signature** - Now requires `robot_id:` and `node_ids:` keyword arguments
+- **Added space check to `remember()`** - Now evicts old memories before adding if working memory is full (was missing, only `recall()` had this check)
+
+### Added
+- **`RobotNode.in_working_memory` scope** - Query nodes currently in a robot's working memory
+- **`Robot#memory_summary[:in_working_memory]`** - Now uses efficient scope instead of separate table
+
+### Removed
+- **`working_memories` table** - Replaced by `working_memory` boolean on `robot_nodes`
+- **`WorkingMemoryEntry` model** - No longer needed
+- **Migration `00008_create_working_memories.rb`** - Replaced by simpler approach
+
+### Migration
+| Migration | Table | Description |
+|-----------|-------|-------------|
+| `00009_add_working_memory_to_robot_nodes.rb` | `robot_nodes` | Adds working_memory boolean column |
+
+## [0.0.9] - 2025-11-29
+
+### Changed
+- **Consolidated database migrations** - Reduced 14 migrations to 8 clean migrations
+  - Each migration now handles exactly one table
+  - Removed incremental add/remove column migrations
+  - All indexes, constraints, and foreign keys included in table creation
+  - Migrations ordered by dependencies (extensions, then tables with FKs)
+  - Migration files now use simple numeric prefixes (00001-00008)
+
+### Migration Files
+| Migration | Table | Description |
+|-----------|-------|-------------|
+| `00001_enable_extensions.rb` | (extensions) | Enables vector and pg_trgm |
+| `00002_create_robots.rb` | `robots` | Robot registry |
+| `00003_create_file_sources.rb` | `file_sources` | Source file metadata |
+| `00004_create_nodes.rb` | `nodes` | Core memory storage |
+| `00005_create_tags.rb` | `tags` | Tag names |
+| `00006_create_node_tags.rb` | `node_tags` | Node-tag join table |
+| `00007_create_robot_nodes.rb` | `robot_nodes` | Robot-node join table |
+| `00008_create_working_memories.rb` | `working_memories` | Per-robot working memory |
+
+## [0.0.8] - 2025-11-29
+
+### Added
+- **Circuit breaker pattern for LLM services** - Prevents cascading failures from external APIs
+  - New `HTM::CircuitBreaker` class with configurable thresholds
+  - Three states: `:closed` (normal), `:open` (failing fast), `:half_open` (testing recovery)
+  - Configurable `failure_threshold` (default: 5), `reset_timeout` (default: 60s)
+  - Thread-safe implementation with Mutex protection
+  - Integrated into `EmbeddingService` and `TagService`
+  - Background jobs handle `CircuitBreakerOpenError` gracefully
+- **Thread-safe WorkingMemory** - All public methods now protected by Mutex
+  - `add`, `remove`, `has_space?`, `evict_to_make_space` synchronized
+  - `assemble_context`, `token_count`, `utilization_percentage`, `node_count` synchronized
+  - Internal helpers renamed to `*_unlocked` variants for safe internal use
+- **Observability module** (`HTM::Observability`) for system monitoring
+  - `connection_pool_stats` - Pool health with warning/critical/exhausted status
+  - `circuit_breaker_stats` - Service circuit breaker states
+  - `query_timing_stats` - Query performance metrics (avg, min, max, p50, p95, p99)
+  - `service_timing_stats` - Embedding/tag generation timing
+  - `memory_stats` - Process memory usage
+  - `health_check` - Comprehensive system health verification
+  - `healthy?` - Quick boolean health check
+  - Configurable thresholds: 75% warning, 90% critical for connection pool
+- **Comprehensive test suites**:
+  - `test/circuit_breaker_test.rb` - 13 tests for circuit breaker states and transitions
+  - `test/embedding_service_test.rb` - 19 tests for validation, generation, and circuit breaker
+  - `test/observability_test.rb` - 10 tests for observability module
+  - Updated `test/tag_service_test.rb` - Added 4 circuit breaker tests (total 33 tests)
+  - Expanded `test/integration_test.rb` - Added 13 new integration tests
+- **Architecture review document** - Comprehensive multi-perspective codebase review
+  - Reviews from 8 specialist perspectives (Systems, Domain, Security, etc.)
+  - Located at `.architecture/reviews/comprehensive-codebase-review.md`
+- **Enhanced YARD documentation** for all error classes with examples
+
+### Changed
+- **CircuitBreakerOpenError** now extends `HTM::Error` (was `EmbeddingError`)
+  - Allows both EmbeddingService and TagService to use it
+- **EmbeddingService and TagService** re-raise `CircuitBreakerOpenError` without wrapping
+  - Enables proper circuit breaker behavior in calling code
+- **GenerateEmbeddingJob and GenerateTagsJob** log warnings for circuit breaker open state
+  - Graceful degradation when LLM services are unavailable
+
+### Removed
+- **`embedding_dimension` column from nodes table** - Unused since embeddings are always padded to 2000
+- **`embedding_model` column from nodes table** - Not needed for current use cases
+
+## [0.0.7] - 2025-11-28
+
+### Security
+- **Fixed SQL injection vulnerabilities** in multiple locations:
+  - `LongTermMemory#build_timeframe_condition` - Now uses `connection.quote`
+  - `LongTermMemory#topic_relationships` - Now uses parameterized queries ($1, $2)
+  - `Node#similarity_to` - Added embedding validation and proper quoting
+  - `Database#run_activerecord_migrations` - Uses `sanitize_sql_array`
+- **Removed hardcoded database credentials** from default configuration
+
+### Added
+- **Thread-safe cache statistics** - Added `Mutex` synchronization for `@cache_stats`
+- **Input validation for `remember` method** - Validates content size and tag format
+- **URL format validation** - `Database.parse_connection_url` now validates scheme, host, and database name
+- **Encoding fallback in MarkdownLoader** - UTF-8 with binary fallback for non-UTF-8 files
+- **File size validation** - MarkdownLoader enforces 10 MB maximum file size
+- **New test suites**:
+  - `test/configuration_test.rb` - Configuration validation tests
+  - `test/working_memory_test.rb` - Working memory operations and eviction tests
+  - `test/tag_service_test.rb` - Tag validation and extraction tests
+
+### Changed
+- **Wrapped `LongTermMemory#add` in transaction** - Ensures atomicity for node creation
+- **Updated documentation** - Removed outdated TimescaleDB references, added pgvector and async processing info
+- **Defensive copies in WorkingMemory** - Uses `.dup` in `assemble_context` to prevent mutation
+- **Embedding validation** - `Node#similarity_to` validates embedding is array of finite numbers
+
+### Fixed
+- **N+1 query in `search_with_relevance`** - Added `batch_load_node_tags` helper
+- **Bare rescue in `get_node_tags`** - Now catches specific `ActiveRecord::RecordNotFound`
+
+## [0.0.6] - 2025-11-28
+
+### Added
+- **Automatic timeframe extraction from queries** - No LLM required
+  - `TimeframeExtractor` service parses natural language time expressions
+  - Uses `chronic` gem for robust date/time parsing
+  - Supports standard expressions: "yesterday", "last week", "this morning", etc.
+  - `FEW` constant (3) maps "few", "a few", "several" to numeric values
+  - "recently"/"recent" without units defaults to 3 days
+  - Custom weekend handling: "weekend before last", "N weekends ago"
+  - Returns cleaned query with temporal expression removed
+- **Flexible `timeframe` parameter in `recall` method** - Multiple input types:
+  - `nil` - No time filter (searches all time)
+  - `Date` / `DateTime` / `Time` - Entire day (00:00:00 to 23:59:59)
+  - `Range` - Exact time window
+  - `String` - Natural language parsing via Chronic
+  - `:auto` - Extract timeframe from query text automatically
+  - `Array<Range>` - Multiple time windows OR'd together
+- **`HTM::Timeframe` normalizer class** - Converts all input types to Range or Array<Range>
+  - `Timeframe.normalize(input, query:)` handles all conversions
+  - `Timeframe.valid?(input)` validates timeframe input
+  - Returns `Result` struct with `:timeframe`, `:query`, `:extracted` when using `:auto`
+- **Configurable week start** - `HTM.configuration.week_start`
+  - Options: `:sunday` (default) or `:monday`
+  - Passed to Chronic for "last week" and similar expressions
+- **Timeframe demo** - `examples/timeframe_demo.rb` showcasing all input types
+  - Run with `rake timeframe_demo`
+- **New rake task**: `rake timeframe_demo` to run the demo
+
+### Changed
+- **`recall` method** now accepts all new timeframe input types
+- **`validate_timeframe!`** uses `HTM::Timeframe.valid?` for validation
+- **`LongTermMemory` search methods** support `nil` and `Array<Range>` timeframes
+  - `apply_timeframe_scope` handles OR conditions for multiple ranges
+
+### Dependencies
+- Added `chronic` gem for natural language date parsing
+
+## [0.0.5] - 2025-11-28
+
+### Added
+- **Semantic tag matching for queries** - Query tags are now extracted using LLM
+  - Uses same `TagService.extract()` process as node storage
+  - 3-step search strategy: exact match → prefix match → component match
+  - Component matching searches right-to-left (most specific first)
+  - Replaces naive keyword substring matching
+- **New rake tasks for database maintenance**:
+  - `htm:db:stats` - Show record counts for all HTM tables with breakdowns
+  - `htm:db:rebuild:embeddings` - Clear and regenerate all embeddings with progress bar
+  - `htm:tags:rebuild` - Clear and regenerate all tags with progress bar
+- **Progress bar support** - Added `ruby-progressbar` gem for long-running rake tasks
+- **CLI demo enhancements** (`examples/cli_app/htm_cli.rb`):
+  - Shows extracted tags, searched tags, and matched tags during recall
+  - Generates context-aware responses using RubyLLM with Ollama
+  - Stores LLM responses in long-term memory for learning
+
+### Changed
+- **Improved tag extraction prompt** with CRITICAL CONSTRAINTS to prevent:
+  - Circular references (concept at both root and leaf)
+  - Self-containment (parent containing itself as descendant)
+  - Duplicate segments in hierarchy path
+  - Redundant duplicates across branches
+- **TagService validation** now programmatically enforces:
+  - Self-containment detection (root == leaf)
+  - Duplicate segment detection in hierarchy path
+  - Maximum depth reduced from 5 to 4 levels
+- **`find_query_matching_tags` method** completely rewritten:
+  - Now uses LLM-based semantic extraction instead of keyword matching
+  - Returns both extracted and matched tags via `include_extracted: true` option
+
+### Fixed
+- Tag search no longer matches unrelated tags via substring (e.g., "man" matching "management")
+
+## [0.0.4] - 2025-11-28
+
 ### Added
+- **Markdown file loader** - Load markdown files into long-term memory
+  - `FileSource` model to track loaded files with metadata and sync status
+  - `MarkdownLoader` with YAML frontmatter extraction
+  - `ParagraphChunker` for splitting content into semantic chunks
+  - DELTA_TIME tolerance (5 seconds) for reliable file change detection
+- **New HTM API methods** for file operations:
+  - `htm.load_file(path, force: false)` - Load single markdown file
+  - `htm.load_directory(path, pattern: '**/*.md', force: false)` - Load directory
+  - `htm.nodes_from_file(path)` - Query nodes from a loaded file
+  - `htm.unload_file(path)` - Unload file and soft-delete its chunks
+- **File loading rake tasks**:
+  - `htm:files:load[path]` - Load a markdown file
+  - `htm:files:load_dir[path,pattern]` - Load directory with glob pattern
+  - `htm:files:list` - List all loaded file sources
+  - `htm:files:info[path]` - Show details for a loaded file
+  - `htm:files:unload[path]` - Unload a file from memory
+  - `htm:files:sync` - Re-sync all loaded files (reload changed files)
+  - `htm:files:stats` - Show file loading statistics
+- **FileSource model features**:
+  - `needs_sync?(mtime)` with DELTA_TIME tolerance for mtime comparison
+  - `frontmatter_tags`, `title`, `author` accessors for frontmatter data
+  - `soft_delete_chunks!` for bulk soft-delete of associated nodes
+  - `by_path` scope for path-based lookups
+- **New example**: `examples/file_loader_usage.rb` demonstrating all file operations
+- **New tests**: FileSource model tests (19) and MarkdownLoader tests (18)
+
+### Changed
+- Node model now has optional `source_id` foreign key to FileSource
+- Node model has `chunk_position` column for ordering chunks within a file
+
+## [0.0.2] - 2025-11-28
+
+### Added
+- **Soft delete for memory nodes** - `forget()` now soft deletes by default (recoverable)
+  - `restore(node_id)` to recover soft-deleted nodes
+  - `purge_deleted(older_than:, confirm:)` to permanently remove old deleted nodes
+  - Permanent delete requires `soft: false, confirm: :confirmed`
+  - `deleted_at` column and scopes: `Node.deleted`, `Node.with_deleted`
+- **Tag hierarchy visualization** - Export tag trees in multiple formats
+  - `Tag.all.tree` returns nested hash structure
+  - `Tag.all.tree_string` returns directory-style text tree
+  - `Tag.all.tree_mermaid` generates Mermaid flowchart syntax
+  - `Tag.all.tree_svg` generates SVG with dark theme, transparent background
+  - Rake tasks: `htm:tags:tree`, `htm:tags:mermaid`, `htm:tags:svg`, `htm:tags:export`
+  - All rake tasks accept optional prefix filter parameter
+- **Per-robot working memory persistence** - Optional database-backed working memory
+  - New `working_memories` table for state restoration after process restart
+  - `WorkingMemoryEntry` model with `sync`, `load`, `clear` methods
+  - Enables cross-robot observability in hive mind architecture
+- **Temporal filtering in recall** - Parse timeframe strings (seconds/minutes/hours)
+- **Integration tests** for embeddings, vector search, and recall options
+- **Multi-provider LLM support via RubyLLM** - HTM now supports 9 LLM providers:
+  - OpenAI (`text-embedding-3-small`, `gpt-4o-mini`)
+  - Anthropic (`claude-3-haiku-20240307`)
+  - Google Gemini (`text-embedding-004`)
+  - Azure OpenAI
+  - Ollama (default, local-first)
+  - HuggingFace Inference API
+  - OpenRouter
+  - AWS Bedrock
+  - DeepSeek
+- Provider-specific configuration attributes for all supported providers
+- `HTM::Configuration#configure_ruby_llm` method for provider credential setup
+- `SUPPORTED_PROVIDERS` constant listing all available providers
+- `DEFAULT_DIMENSIONS` hash with typical embedding dimensions per provider
 - Architecture documentation using ai-software-architect framework
-- Comprehensive ADRs (Architecture Decision Records):
-  - ADR-001: PostgreSQL with TimescaleDB for storage
-  - ADR-002: Two-tier memory architecture (working + long-term)
-  - ADR-003: Ollama as default embedding provider
-  - ADR-004: Multi-robot shared memory (hive mind)
-  - ADR-005: RAG-based retrieval with hybrid search
-  - ADR-006: Context assembly strategies (recent, important, balanced)
-  - ADR-007: Working memory eviction strategy (hybrid importance + recency)
-  - ADR-008: Robot identification system (UUID + name)
-  - ADR-009: Never-forget philosophy with explicit deletion
-- Architecture review team with 8 specialist perspectives
-- Had the robot convert my notss and system analysis documentation into Architectural Decision Records (ADR)
-
-## [0.1.0] - 2025-10-25
+- Comprehensive ADRs (Architecture Decision Records) for all major design decisions
+
+### Changed
+- **Embedding generator now uses `RubyLLM.embed()`** instead of raw HTTP calls to Ollama
+- **Tag extractor now uses `RubyLLM.chat()`** instead of raw HTTP calls to Ollama
+- **Sinatra integration moved** to `lib/htm/integrations/sinatra.rb` (require path changed)
+- **Hybrid search includes nodes without embeddings** using 0.5 default similarity
+- Configuration validation now checks provider is in `SUPPORTED_PROVIDERS`
+- MkDocs documentation reorganized with tbls schema docs integration
+- Updated CLAUDE.md with multi-provider documentation and examples
+
+### Removed
+- Unused `nodes.in_working_memory` column (was never set to true)
+- Unused `robots.metadata` column (never referenced in codebase)
+- One-off test scripts replaced with proper Minitest integration tests
+
+### Fixed
+- Sinatra session secret error (Rack requires 64+ bytes)
+- Thread-safe database connection in Sinatra integration
+- tbls database documentation rake task configuration
+
+## [0.0.1] - 2025-10-25
 
 ### Added
 - Initial release of HTM (Hierarchical Temporary Memory)
@@ -146,5 +436,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Working memory size is user-configurable
 - See ADRs for detailed architectural decisions and rationale
 
-[Unreleased]: https://github.com/madbomber/htm/compare/v0.1.0...HEAD
-[0.1.0]: https://github.com/madbomber/htm/releases/tag/v0.1.0
+[Unreleased]: https://github.com/madbomber/htm/compare/v0.0.10...HEAD
+[0.0.10]: https://github.com/madbomber/htm/compare/v0.0.9...v0.0.10
+[0.0.9]: https://github.com/madbomber/htm/compare/v0.0.8...v0.0.9
+[0.0.8]: https://github.com/madbomber/htm/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/madbomber/htm/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/madbomber/htm/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/madbomber/htm/compare/v0.0.4...v0.0.5
+[0.0.4]: https://github.com/madbomber/htm/compare/v0.0.2...v0.0.4
+[0.0.2]: https://github.com/madbomber/htm/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/madbomber/htm/releases/tag/v0.0.1