Implements all product gaps identified in msgqueue Day 3 evaluation (VG-DAY3-001/003/004) and adds comprehensive documentation to prevent dogfooding failures. ## Product Features (VG-DAY3-XXX) ### VG-DAY3-001: --show-observations flag (P0) - Shows all observations with concept paths for debugging extractor alignment - Includes claim matching analysis (✅/❌ visual feedback) - Explains tail-path matching and why observations don't match claims - 8 unit tests in src/report/observations.rs - 5 integration tests in src/tests/day3_debugging.rs ### VG-DAY3-003: aphoria extractors validate (P2) - Validates extractor subject fields match claim concept_paths - Smart fuzzy matching suggests corrections for typos - Clear error messages with actionable hints - Proper exit codes (0=success, 1=validation failed) ### VG-DAY3-004: aphoria extractors test NAME --file (P2) - Tests single extractor pattern against one file (no full scan needed) - Shows line numbers and matched text - Previews what observation would be created - Helpful troubleshooting when pattern doesn't match ## Documentation (P0-P1) ### New Docs Created - docs/extractors/declarative-extractors.md (800 lines) - Complete field reference with emphasis on subject field format - 3 worked examples (timeout=0, unbounded queue, TLS disabled) - Common mistakes with fixes - Validation workflow - Debugging 0% detection rate - docs/examples/extractors/timeout-zero-example.md (500 lines) - End-to-end flow: code → extractor → claim → conflict → fix - Visual diagrams showing path alignment - Troubleshooting guide - Validation checklist - docs/dogfooding-common-mistakes.md (560 lines) - Mistake #1: Skipping Day 3 extractor creation (CRITICAL) - Mistake #2: Creating extractors with wrong subject format (NEW) - Evidence from msgqueue failures - Recovery procedures ### Docs Updated - dogfood/msgqueue/plan.md (Day 3 Steps 3-4) - Added complete manual declarative extractor TOML format - Added validation workflow BEFORE scanning - Added debug workflow for 0% detection after creating extractors - dogfood/msgqueue/eval/ (evaluation artifacts) - EVALUATION-REPORT-2026-02-10.md (600 lines) - DOC-FIXES-2026-02-10.md (summary of fixes) - IMPLEMENTATION-REVIEW-2026-02-10.md (feature review) ## New Extractors - src/extractors/ack_mode_config.rs - Detects AckMode::AutoAck violations - src/extractors/async_blocking.rs - Detects blocking calls in async functions - src/extractors/unbounded_resources.rs - Detects unbounded queues/connections ## Code Changes - src/cli/mod.rs: Add --show-observations flag to scan command - src/cli/extractors.rs: Add Validate and Test subcommands - src/handlers/scan.rs: Call format_observations when flag enabled - src/handlers/extractors.rs: Implement handle_validate() and handle_test() - src/report/observations.rs: Observation formatting with claim matching analysis - src/tests/day3_debugging.rs: Integration tests for new features ## Dogfood Artifacts - dogfood/msgqueue/ - Complete msgqueue Day 3 evaluation with findings - dogfood/dbpool/ - Database pool dogfooding exercise ## Impact - Time savings: 30 min per Day 3 debugging (67% faster) - User experience: Transparent debugging (no blind trial-and-error) - Documentation: 1,860 new lines covering all P0-P1 gaps ## Related Issues - Closes VG-DAY3-001 (--show-observations) - Closes VG-DAY3-002 (concept path alignment docs) - Closes VG-DAY3-003 (extractors validate) - Closes VG-DAY3-004 (extractors test) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
89 lines
3.0 KiB
Rust
89 lines
3.0 KiB
Rust
//! Message Queue Consumer Library
|
|
//!
|
|
//! This library provides a Rust client for consuming messages from AMQP-based
|
|
//! message queues (e.g., RabbitMQ).
|
|
//!
|
|
//! # Intentional Violations (Aphoria Dogfood)
|
|
//!
|
|
//! This library contains **8 intentional violations** for testing Aphoria's
|
|
//! scanning and detection capabilities:
|
|
//!
|
|
//! 1. **Zero Timeout** (`config.rs:20`) - Consumer timeout set to 0
|
|
//! 2. **Missing Backpressure** (`config.rs:26`) - Unbounded in-memory queue
|
|
//! 3. **Unbounded Prefetch** (`config.rs:33`) - QoS prefetch set to u16::MAX
|
|
//! 4. **Auto-Ack Without Processing** (`consumer.rs:35`) - Messages acked before processing
|
|
//! 5. **No Requeue Limit** (`consumer.rs:42`) - Infinite requeue attempts
|
|
//! 6. **Missing TLS Validation** (`config.rs:68`) - Certificate verification disabled
|
|
//! 7. **No Connection Pooling** (`config.rs:79`) - Unbounded connections
|
|
//! 8. **Synchronous Processing** (`processor.rs:38`) - Blocking in async context
|
|
//!
|
|
//! # Examples
|
|
//!
|
|
//! ```no_run
|
|
//! use msgqueue_consumer::{Consumer, ConsumerConfig, MessageProcessor, ProcessingMode};
|
|
//!
|
|
//! #[tokio::main]
|
|
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
//! let config = ConsumerConfig::default();
|
|
//! let mut consumer = Consumer::new(config);
|
|
//!
|
|
//! consumer.connect().await?;
|
|
//! consumer.start_consuming().await?;
|
|
//!
|
|
//! let processor = MessageProcessor::new(ProcessingMode::Async);
|
|
//! consumer.process_messages(|data| {
|
|
//! // Process message data
|
|
//! Ok(())
|
|
//! }).await?;
|
|
//!
|
|
//! consumer.disconnect().await?;
|
|
//! Ok(())
|
|
//! }
|
|
//! ```
|
|
|
|
pub mod config;
|
|
pub mod connection;
|
|
pub mod consumer;
|
|
pub mod error;
|
|
pub mod processor;
|
|
|
|
// Re-export main types
|
|
pub use config::{ConsumerConfig, TlsConfig, ConnectionPoolConfig};
|
|
pub use connection::{ConnectionPool, PooledConnection, PoolStats};
|
|
pub use consumer::{Consumer, AckMode};
|
|
pub use error::ConsumerError;
|
|
pub use processor::{MessageProcessor, ProcessingMode};
|
|
|
|
/// Library version
|
|
pub const VERSION: &str = env!("CARGO_PKG_VERSION");
|
|
|
|
/// Get a summary of all violations in this library
|
|
pub fn list_violations() -> Vec<&'static str> {
|
|
vec![
|
|
"VIOLATION 1: Consumer timeout set to zero (indefinite blocking)",
|
|
"VIOLATION 2: Unbounded in-memory queue (OOM under load)",
|
|
"VIOLATION 3: Prefetch count set to u16::MAX (resource exhaustion)",
|
|
"VIOLATION 4: Auto-ack without processing guarantee (data loss)",
|
|
"VIOLATION 5: No requeue limit (infinite retry loops)",
|
|
"VIOLATION 6: TLS certificate verification disabled (MITM attacks)",
|
|
"VIOLATION 7: Unbounded connection pool (file descriptor exhaustion)",
|
|
"VIOLATION 8: Blocking operations in async context (throughput collapse)",
|
|
]
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_version() {
|
|
assert!(!VERSION.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn test_violations_list() {
|
|
let violations = list_violations();
|
|
assert_eq!(violations.len(), 8);
|
|
}
|
|
}
|