things3-cli 1.0.0

CLI tool for Things 3 with integrated MCP server
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
//! Metrics collection and monitoring
//!
//! This module provides comprehensive metrics collection for the Things 3 CLI application,
//! including performance monitoring, error tracking, and operational metrics.

use std::sync::Arc;
use std::time::{Duration, Instant};
use things3_core::{ObservabilityManager, ThingsDatabase};
use tokio::time::interval;
use tracing::{debug, error, info, instrument, warn};

/// Metrics collector for continuous monitoring
pub struct MetricsCollector {
    observability: Arc<ObservabilityManager>,
    database: Arc<ThingsDatabase>,
    collection_interval: Duration,
}

impl MetricsCollector {
    /// Create a new metrics collector
    #[must_use]
    pub fn new(
        observability: Arc<ObservabilityManager>,
        database: Arc<ThingsDatabase>,
        collection_interval: Duration,
    ) -> Self {
        Self {
            observability,
            database,
            collection_interval,
        }
    }

    /// Start metrics collection in background
    ///
    /// # Errors
    ///
    /// Returns an error if metrics collection fails
    #[instrument(skip(self))]
    pub async fn start_collection(self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        info!(
            "Starting metrics collection with interval: {:?}",
            self.collection_interval
        );

        let mut interval = interval(self.collection_interval);

        loop {
            interval.tick().await;

            if let Err(e) = self.collect_metrics().await {
                error!("Failed to collect metrics: {}", e);
            }
        }
    }

    /// Collect current metrics
    #[instrument(skip(self))]
    async fn collect_metrics(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        debug!("Collecting metrics");

        // Collect system metrics
        self.collect_system_metrics().await?;

        // Collect database metrics
        self.collect_database_metrics().await?;

        // Collect application metrics
        self.collect_application_metrics().await?;

        debug!("Metrics collection completed");
        Ok(())
    }

    /// Collect system metrics (memory, CPU, etc.)
    #[instrument(skip(self))]
    async fn collect_system_metrics(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        use sysinfo::{Pid, System};

        let mut system = System::new_all();
        system.refresh_all();

        // Get current process
        let current_pid = Pid::from_u32(std::process::id());
        let process = system.process(current_pid);

        if let Some(process) = process {
            let memory_usage = process.memory() * 1024; // Convert to bytes
            let cpu_usage = f64::from(process.cpu_usage());

            // Update cache metrics (placeholder values for now)
            let cache_hit_rate = 0.85; // 85% hit rate
            let cache_size = 1024 * 1024; // 1MB cache size

            self.observability.update_performance_metrics(
                memory_usage,
                cpu_usage,
                cache_hit_rate,
                cache_size,
            );

            debug!(
                memory_usage = memory_usage,
                cpu_usage = cpu_usage,
                cache_hit_rate = cache_hit_rate,
                cache_size = cache_size,
                "System metrics collected"
            );
        }

        Ok(())
    }

    /// Collect database metrics
    #[instrument(skip(self))]
    async fn collect_database_metrics(
        &self,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        // Check database connection health
        let is_connected = true; // Simplified - in a real implementation, this would check the actual connection

        if !is_connected {
            warn!("Database connection is not healthy");
            self.observability
                .record_error("database_connection", "Database connection lost");
        }

        // Record database operation metrics
        // This would typically involve querying database statistics
        // For now, we'll use placeholder values

        debug!("Database metrics collected");
        Ok(())
    }

    /// Collect application-specific metrics
    #[instrument(skip(self))]
    async fn collect_application_metrics(
        &self,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        // Collect task-related metrics
        self.collect_task_metrics().await?;

        // Collect search metrics
        self.collect_search_metrics().await?;

        // Collect export metrics
        self.collect_export_metrics().await?;

        debug!("Application metrics collected");
        Ok(())
    }

    /// Collect task-related metrics
    #[instrument(skip(self))]
    async fn collect_task_metrics(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        // This would typically involve querying the database for task statistics
        // For now, we'll use placeholder values

        // Example: Count tasks by status
        let inbox_count = self
            .database
            .get_inbox(Some(1000))
            .await
            .map_err(|e| {
                error!("Failed to get inbox count: {}", e);
                e
            })?
            .len();

        let today_count = self
            .database
            .get_today(Some(1000))
            .await
            .map_err(|e| {
                error!("Failed to get today count: {}", e);
                e
            })?
            .len();

        debug!(
            inbox_count = inbox_count,
            today_count = today_count,
            "Task metrics collected"
        );

        Ok(())
    }

    /// Collect search metrics
    #[instrument(skip(self))]
    async fn collect_search_metrics(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        // This would typically involve tracking search performance
        // For now, we'll use placeholder values

        debug!("Search metrics collected");
        Ok(())
    }

    /// Collect export metrics
    #[instrument(skip(self))]
    async fn collect_export_metrics(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        // This would typically involve tracking export performance
        // For now, we'll use placeholder values

        debug!("Export metrics collected");
        Ok(())
    }
}

/// Performance monitoring utilities
pub struct PerformanceMonitor {
    observability: Arc<ObservabilityManager>,
}

impl PerformanceMonitor {
    /// Create a new performance monitor
    #[must_use]
    pub fn new(observability: Arc<ObservabilityManager>) -> Self {
        Self { observability }
    }

    /// Monitor a database operation
    #[instrument(skip(self, f))]
    pub fn monitor_db_operation<F, R>(&self, operation: &str, f: F) -> R
    where
        F: FnOnce() -> R,
    {
        self.observability.record_db_operation(operation, f)
    }

    /// Monitor a search operation
    #[instrument(skip(self, f))]
    pub fn monitor_search<F, R>(&self, query: &str, f: F) -> R
    where
        F: FnOnce() -> R,
    {
        self.observability.record_search_operation(query, f)
    }

    /// Monitor a task operation
    #[instrument(skip(self))]
    pub fn monitor_task_operation(&self, operation: &str, count: u64) {
        self.observability.record_task_operation(operation, count);
    }

    /// Monitor an export operation
    #[instrument(skip(self, f))]
    pub fn monitor_export<F, R>(&self, format: &str, f: F) -> R
    where
        F: FnOnce() -> R,
    {
        let start = Instant::now();
        let result = f();
        let duration = start.elapsed();

        // In a real implementation, this would update metrics atomically

        debug!(
            format = format,
            duration_ms = duration.as_millis(),
            "Export operation completed"
        );

        result
    }
}

/// Error tracking utilities
pub struct ErrorTracker {
    observability: Arc<ObservabilityManager>,
}

impl ErrorTracker {
    /// Create a new error tracker
    #[must_use]
    pub fn new(observability: Arc<ObservabilityManager>) -> Self {
        Self { observability }
    }

    /// Track an error
    #[instrument(skip(self))]
    pub fn track_error(&self, error_type: &str, error_message: &str) {
        self.observability.record_error(error_type, error_message);
    }

    /// Track a database error
    #[instrument(skip(self))]
    pub fn track_db_error(&self, operation: &str, error: &dyn std::error::Error) {
        let error_type = format!("database_{operation}");
        let error_message = format!("Database operation '{operation}' failed: {error}");
        self.track_error(&error_type, &error_message);
    }

    /// Track a search error
    #[instrument(skip(self))]
    pub fn track_search_error(&self, query: &str, error: &dyn std::error::Error) {
        let error_type = "search_error";
        let error_message = format!("Search query '{query}' failed: {error}");
        self.track_error(error_type, &error_message);
    }

    /// Track an export error
    #[instrument(skip(self))]
    pub fn track_export_error(&self, format: &str, error: &dyn std::error::Error) {
        let error_type = "export_error";
        let error_message = format!("Export in '{format}' format failed: {error}");
        self.track_error(error_type, &error_message);
    }
}

/// Start metrics collection in background
///
/// # Errors
///
/// Returns an error if metrics collection fails
pub async fn start_metrics_collection(
    observability: Arc<ObservabilityManager>,
    database: Arc<ThingsDatabase>,
    collection_interval: Duration,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let collector = MetricsCollector::new(observability, database, collection_interval);
    collector.start_collection().await
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Arc;
    use std::time::Duration;
    use tempfile::NamedTempFile;
    use things3_core::{ObservabilityConfig, ThingsConfig};

    #[test]
    fn test_performance_monitor_creation() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let rt = tokio::runtime::Runtime::new().unwrap();
        let _database = Arc::new(
            rt.block_on(async { ThingsDatabase::new(&config.database_path).await.unwrap() }),
        );

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let _monitor = PerformanceMonitor::new(observability);
        // Test that monitor can be created without panicking
    }

    #[test]
    fn test_error_tracker_creation() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let rt = tokio::runtime::Runtime::new().unwrap();
        let _database = Arc::new(
            rt.block_on(async { ThingsDatabase::new(&config.database_path).await.unwrap() }),
        );

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let _tracker = ErrorTracker::new(observability);
        // Test that tracker can be created without panicking
    }

    #[test]
    fn test_metrics_collector_creation() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let rt = tokio::runtime::Runtime::new().unwrap();
        let database = Arc::new(
            rt.block_on(async { ThingsDatabase::new(&config.database_path).await.unwrap() }),
        );

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let _collector = MetricsCollector::new(observability, database, Duration::from_secs(30));
        // Test that collector can be created without panicking
    }

    #[tokio::test]
    async fn test_performance_monitor_timing() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let _database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let monitor = PerformanceMonitor::new(Arc::clone(&observability));

        // Test monitoring a database operation
        let result = monitor.monitor_db_operation("test_operation", || {
            // Simulate some work
            "test_result"
        });
        assert_eq!(result, "test_result");
    }

    #[tokio::test]
    async fn test_performance_monitor_error_tracking() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let _database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let monitor = PerformanceMonitor::new(Arc::clone(&observability));

        // Test monitoring a task operation
        monitor.monitor_task_operation("test_operation", 5);
    }

    #[tokio::test]
    async fn test_error_tracker_database_error() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let _database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let tracker = ErrorTracker::new(Arc::clone(&observability));

        // Test tracking a database error
        let error = std::io::Error::new(std::io::ErrorKind::NotFound, "Database not found");
        tracker.track_db_error("test_operation", &error);
    }

    #[tokio::test]
    async fn test_error_tracker_search_error() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let _database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let tracker = ErrorTracker::new(Arc::clone(&observability));

        // Test tracking a search error
        let error = std::io::Error::new(std::io::ErrorKind::InvalidInput, "Invalid search query");
        tracker.track_search_error("test query", &error);
    }

    #[tokio::test]
    async fn test_error_tracker_export_error() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let _database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let tracker = ErrorTracker::new(Arc::clone(&observability));

        // Test tracking an export error
        let error = std::io::Error::new(std::io::ErrorKind::PermissionDenied, "Export failed");
        tracker.track_export_error("json", &error);
    }

    #[tokio::test]
    async fn test_metrics_collector_system_metrics() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let collector = MetricsCollector::new(
            Arc::clone(&observability),
            Arc::clone(&database),
            Duration::from_secs(30),
        );

        // Test collecting system metrics
        let result = collector.collect_system_metrics().await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_metrics_collector_database_metrics() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let collector = MetricsCollector::new(
            Arc::clone(&observability),
            Arc::clone(&database),
            Duration::from_secs(30),
        );

        // Test collecting database metrics
        let result = collector.collect_database_metrics().await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_metrics_collector_search_metrics() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let collector = MetricsCollector::new(
            Arc::clone(&observability),
            Arc::clone(&database),
            Duration::from_secs(30),
        );

        // Test collecting search metrics
        let result = collector.collect_search_metrics().await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_metrics_collector_export_metrics() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let collector = MetricsCollector::new(
            Arc::clone(&observability),
            Arc::clone(&database),
            Duration::from_secs(30),
        );

        // Test collecting export metrics
        let result = collector.collect_export_metrics().await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_start_metrics_collection() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let database = Arc::new(ThingsDatabase::new(&config.database_path).await.unwrap());

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        // Test starting metrics collection (we'll just test that it doesn't panic immediately)
        let collection_handle = tokio::spawn(async move {
            start_metrics_collection(observability, database, Duration::from_millis(100)).await
        });

        // Give it a moment to start, then cancel
        tokio::time::sleep(Duration::from_millis(50)).await;
        collection_handle.abort();
    }

    #[test]
    fn test_performance_monitor_with_custom_observability() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let rt = tokio::runtime::Runtime::new().unwrap();
        let _database = Arc::new(
            rt.block_on(async { ThingsDatabase::new(&config.database_path).await.unwrap() }),
        );

        let obs_config = ObservabilityConfig {
            service_name: "test-service".to_string(),
            ..Default::default()
        };
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let _monitor = PerformanceMonitor::new(observability);
        // Test that monitor can be created with custom observability config
    }

    #[test]
    fn test_error_tracker_with_custom_observability() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let rt = tokio::runtime::Runtime::new().unwrap();
        let _database = Arc::new(
            rt.block_on(async { ThingsDatabase::new(&config.database_path).await.unwrap() }),
        );

        let obs_config = ObservabilityConfig {
            service_name: "test-service".to_string(),
            ..Default::default()
        };
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        let _tracker = ErrorTracker::new(observability);
        // Test that tracker can be created with custom observability config
    }

    #[test]
    fn test_metrics_collector_with_different_intervals() {
        let temp_file = NamedTempFile::new().unwrap();
        let db_path = temp_file.path();

        let config = ThingsConfig::new(db_path, false);
        let rt = tokio::runtime::Runtime::new().unwrap();
        let database = Arc::new(
            rt.block_on(async { ThingsDatabase::new(&config.database_path).await.unwrap() }),
        );

        let obs_config = ObservabilityConfig::default();
        let observability = Arc::new(ObservabilityManager::new(obs_config).unwrap());

        // Test with different collection intervals
        let _collector1 = MetricsCollector::new(
            Arc::clone(&observability),
            Arc::clone(&database),
            Duration::from_secs(1),
        );
        let _collector2 = MetricsCollector::new(
            Arc::clone(&observability),
            Arc::clone(&database),
            Duration::from_secs(60),
        );
        let _collector3 = MetricsCollector::new(
            Arc::clone(&observability),
            Arc::clone(&database),
            Duration::from_millis(500),
        );
    }
}