memtui 0.2.0

An interactive TUI (Terminal User Interface) for browsing and inspecting key-value stores (Redis, Memcached, etc.)
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
mod etcd;
mod memcached;
mod mock;
mod redis;
pub mod utils;

use crate::types::{BackendType, KeyMetadata, KeyScanResult, Value};
use std::time::Duration;
use thiserror::Error;

pub use etcd::EtcdBackend;
pub use memcached::MemcachedBackend;
pub use mock::MockBackend;
pub use redis::RedisBackend;

/// Main abstraction for all backend stores
#[async_trait::async_trait]
pub trait Backend: Send + Sync {
    /// Get backend type (redis, memcached, etcd, etc.)
    fn backend_type(&self) -> BackendType;

    /// Get backend capabilities (what features are supported)
    fn capabilities(&self) -> BackendCapabilities;

    /// Connect to the backend
    async fn connect(&mut self) -> Result<ConnectionInfo, BackendError>;

    /// Disconnect gracefully
    async fn disconnect(&mut self) -> Result<(), BackendError>;

    /// Check if connection is alive
    async fn ping(&self) -> Result<Duration, BackendError>;

    /// Get server/cluster information
    async fn info(&self) -> Result<ServerInfo, BackendError>;

    // ===== Key Operations (Read-only by default) =====

    /// List keys matching a pattern (returns paginated results)
    async fn scan_keys(
        &self,
        pattern: Option<&str>,
        cursor: Option<String>,
        limit: usize,
    ) -> Result<KeyScanResult, BackendError>;

    /// Search keys with pattern - backends implement this optimally
    /// Redis: Uses SCAN MATCH efficiently (server-side)
    /// Memcached: Falls back to client-side filtering of cached keys
    async fn search_keys(&self, pattern: &str, limit: usize)
        -> Result<KeyScanResult, BackendError>;

    /// Get total key count (approximate if expensive)
    async fn key_count(&self, pattern: Option<&str>) -> Result<u64, BackendError>;

    /// Get metadata for a specific key
    async fn key_info(&self, key: &str) -> Result<KeyMetadata, BackendError>;

    /// Get value for a key
    async fn get(&self, key: &str) -> Result<Value, BackendError>;

    /// Get multiple values at once (optimized batch fetch)
    async fn get_many(&self, keys: &[String]) -> Result<Vec<(String, Value)>, BackendError>;

    // ===== Write Operations (requires write_enabled flag) =====

    /// Set a value (only if write_enabled)
    async fn set(&self, key: &str, value: &[u8], ttl: Option<Duration>)
        -> Result<(), BackendError>;

    /// Delete a key (only if write_enabled)
    async fn delete(&self, key: &str) -> Result<bool, BackendError>;

    // ===== Advanced Operations =====

    /// Execute a raw command (if supported)
    async fn execute_raw(&self, command: &str) -> Result<RawCommandResult, BackendError>;
}

/// Backend capabilities (feature flags)
#[derive(Debug, Clone)]
pub struct BackendCapabilities {
    pub supports_ttl: bool,
    pub supports_scan: bool,
    pub supports_raw_commands: bool,
    pub supports_batch_get: bool,
    /// Whether the backend can efficiently search keys server-side (Redis: true, Memcached: false)
    pub supports_efficient_pattern_search: bool,
}

#[derive(Debug, Clone)]
pub struct ConnectionInfo {
    pub connected: bool,
    pub server_version: String,
    pub address: String,
}

#[derive(Debug, Clone)]
pub struct ServerInfo {
    pub version: String,
    pub uptime: Duration,
    pub memory_used: u64,
    pub memory_max: Option<u64>,
    pub clients_connected: usize,
    pub keys_total: u64,
}

#[derive(Debug, Clone)]
pub struct RawCommandResult {
    pub output: String,
    pub status: CommandStatus,
    pub duration: Duration,
    pub error_message: Option<String>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CommandStatus {
    Success,
    Error,
    Timeout,
    PermissionDenied,
    InvalidCommand,
}

#[derive(Debug, Error)]
pub enum BackendError {
    #[error("Connection error: {0}")]
    ConnectionError(String),

    #[error("Authentication failed: {0}")]
    AuthenticationError(String),

    #[error("Key not found: {0}")]
    KeyNotFound(String),

    #[error("Operation not supported")]
    NotSupported,

    #[error("Write operation not allowed (read-only mode)")]
    ReadOnly,

    #[error("Timeout")]
    Timeout,

    #[error("Invalid command: {0}")]
    InvalidCommand(String),

    #[error("Internal error: {0}")]
    Internal(String),
}

#[cfg(test)]
mod tests {
    use super::*;

    /// Test MockBackend basic functionality (no external services required)
    #[tokio::test]
    async fn test_connect_disconnect() {
        let mut backend = MockBackend::new(false);

        // Initially not connected
        let ping_result = backend.ping().await;
        assert!(ping_result.is_err());

        // Connect
        let conn_info = backend.connect().await.unwrap();
        assert!(conn_info.connected);
        assert_eq!(conn_info.server_version, "7.0.0-mock");

        // Ping should work now
        let duration = backend.ping().await.unwrap();
        assert!(duration.as_millis() < 100);

        // Disconnect
        backend.disconnect().await.unwrap();

        // Ping should fail after disconnect
        let ping_result = backend.ping().await;
        assert!(ping_result.is_err());
    }

    #[tokio::test]
    async fn test_info() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let info = backend.info().await.unwrap();
        assert_eq!(info.version, "7.0.0-mock");
        assert!(info.uptime.as_secs() > 0);
        assert!(info.memory_used > 0);
        assert!(info.memory_max.is_some());
        assert_eq!(info.clients_connected, 5);
        assert_eq!(info.keys_total, 4);
    }

    #[tokio::test]
    async fn test_capabilities() {
        let backend = MockBackend::new(false);
        let caps = backend.capabilities();

        assert!(caps.supports_ttl);
        assert!(caps.supports_scan);
        assert!(caps.supports_raw_commands);
        assert!(caps.supports_batch_get);
        assert!(caps.supports_efficient_pattern_search);
    }

    #[tokio::test]
    async fn test_backend_type() {
        let backend = MockBackend::new(false);
        assert_eq!(backend.backend_type(), BackendType::Redis);
    }

    #[tokio::test]
    async fn test_scan_keys_all() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let result = backend.scan_keys(None, None, 100).await.unwrap();
        assert_eq!(result.keys.len(), 4);
        assert!(!result.has_more);
        assert!(result.cursor.is_none());

        // Verify key names
        let key_names: Vec<String> = result.keys.iter().map(|k| k.name.clone()).collect();
        assert!(key_names.contains(&"user:123".to_string()));
        assert!(key_names.contains(&"user:456".to_string()));
        assert!(key_names.contains(&"session:abc".to_string()));
        assert!(key_names.contains(&"cache:config".to_string()));
    }

    #[tokio::test]
    async fn test_scan_keys_with_pattern() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let result = backend.scan_keys(Some("user:"), None, 100).await.unwrap();
        assert_eq!(result.keys.len(), 2);

        let key_names: Vec<String> = result.keys.iter().map(|k| k.name.clone()).collect();
        assert!(key_names.contains(&"user:123".to_string()));
        assert!(key_names.contains(&"user:456".to_string()));
    }

    #[tokio::test]
    async fn test_key_count() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let count = backend.key_count(None).await.unwrap();
        assert_eq!(count, 4);
    }

    #[tokio::test]
    async fn test_key_info() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let info = backend.key_info("user:123").await.unwrap();
        assert_eq!(info.name, "user:123");
        assert_eq!(info.value_type, crate::types::ValueType::Json);
        assert!(info.size_bytes > 0);
        assert!(info.ttl.is_some());
    }

    #[tokio::test]
    async fn test_key_info_not_found() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let result = backend.key_info("nonexistent").await;
        assert!(matches!(result, Err(BackendError::KeyNotFound(_))));
    }

    #[tokio::test]
    async fn test_get() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        // Test JSON key
        let value = backend.get("user:123").await.unwrap();
        assert!(!value.data.is_empty());
        assert_eq!(value.value_type, crate::types::ValueType::Json);
        assert!(String::from_utf8_lossy(&value.data).contains("Alice"));

        // Test string key
        let value = backend.get("session:abc").await.unwrap();
        assert!(!value.data.is_empty());
        assert_eq!(value.value_type, crate::types::ValueType::String);
    }

    #[tokio::test]
    async fn test_get_not_found() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let result = backend.get("nonexistent").await;
        assert!(matches!(result, Err(BackendError::KeyNotFound(_))));
    }

    #[tokio::test]
    async fn test_get_many() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let keys = vec![
            "user:123".to_string(),
            "user:456".to_string(),
            "session:abc".to_string(),
        ];

        let results = backend.get_many(&keys).await.unwrap();
        assert_eq!(results.len(), 3);

        // Verify we got all the keys
        let result_keys: Vec<String> = results.iter().map(|(k, _)| k.clone()).collect();
        assert!(result_keys.contains(&"user:123".to_string()));
        assert!(result_keys.contains(&"user:456".to_string()));
        assert!(result_keys.contains(&"session:abc".to_string()));
    }

    #[tokio::test]
    async fn test_get_many_with_missing() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let keys = vec![
            "user:123".to_string(),
            "nonexistent".to_string(),
            "user:456".to_string(),
        ];

        let results = backend.get_many(&keys).await.unwrap();
        // Only existing keys should be returned
        assert_eq!(results.len(), 2);
    }

    #[tokio::test]
    async fn test_set() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        // Set without TTL
        let result = backend.set("newkey", b"newvalue", None).await;
        assert!(result.is_ok());

        // Set with TTL
        let result = backend
            .set("newkey2", b"value2", Some(Duration::from_secs(60)))
            .await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_set_read_only() {
        let mut backend = MockBackend::new(true); // Read-only mode
        backend.connect().await.unwrap();

        let result = backend.set("key", b"value", None).await;
        assert!(matches!(result, Err(BackendError::ReadOnly)));
    }

    #[tokio::test]
    async fn test_mock_backend_set_not_connected() {
        let backend = MockBackend::new(false);

        let result = backend.set("key", b"value", None).await;
        assert!(matches!(result, Err(BackendError::ConnectionError(_))));
    }

    #[tokio::test]
    async fn test_mock_backend_delete() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let result = backend.delete("user:123").await;
        assert!(result.is_ok());
        assert!(result.unwrap());
    }

    #[tokio::test]
    async fn test_mock_backend_delete_read_only() {
        let mut backend = MockBackend::new(true); // Read-only mode
        backend.connect().await.unwrap();

        let result = backend.delete("user:123").await;
        assert!(matches!(result, Err(BackendError::ReadOnly)));
    }

    #[tokio::test]
    async fn test_mock_backend_delete_not_connected() {
        let backend = MockBackend::new(false);

        let result = backend.delete("key").await;
        assert!(matches!(result, Err(BackendError::ConnectionError(_))));
    }

    #[tokio::test]
    async fn test_mock_backend_execute_raw() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        let result = backend.execute_raw("PING").await.unwrap();
        assert_eq!(result.status, CommandStatus::Success);
        assert!(result.output.contains("PING"));
        assert!(result.error_message.is_none());
        assert!(result.duration.as_millis() < 100);
    }

    #[tokio::test]
    async fn test_mock_backend_execute_raw_not_connected() {
        let backend = MockBackend::new(false);

        let result = backend.execute_raw("PING").await;
        assert!(matches!(result, Err(BackendError::ConnectionError(_))));
    }

    #[tokio::test]
    async fn test_mock_backend_multiple_operations() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        // Test a sequence of operations
        let info = backend.info().await.unwrap();
        assert!(!info.version.is_empty());

        let keys = backend.scan_keys(None, None, 10).await.unwrap();
        assert!(!keys.keys.is_empty());

        let value = backend.get("user:123").await.unwrap();
        assert!(!value.data.is_empty());

        let key_info = backend.key_info("user:123").await.unwrap();
        assert_eq!(key_info.name, "user:123");

        let count = backend.key_count(None).await.unwrap();
        assert!(count > 0);
    }

    #[tokio::test]
    async fn test_mock_backend_json_value_types() {
        let mut backend = MockBackend::new(false);
        backend.connect().await.unwrap();

        // JSON keys should have Json value type
        let value = backend.get("user:123").await.unwrap();
        assert_eq!(value.value_type, crate::types::ValueType::Json);

        let value = backend.get("cache:config").await.unwrap();
        assert_eq!(value.value_type, crate::types::ValueType::Json);

        // Non-JSON keys should have String value type
        let value = backend.get("session:abc").await.unwrap();
        assert_eq!(value.value_type, crate::types::ValueType::String);
    }
}