rouchdb 0.3.2

Local-first document database with CouchDB replication protocol support
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

//! Tests for Plugin architecture and Partitioned databases:
//! - Plugin trait (before_write, after_write, on_destroy)
//! - Multiple plugins
//! - Partition scoped queries (all_docs, find, get, put)

use std::collections::HashMap;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};

use rouchdb::{AllDocsOptions, Database, DocResult, Document, FindOptions, Plugin, Result};

// =========================================================================
// Plugin: before_write hook
// =========================================================================

struct TimestampPlugin;

#[async_trait::async_trait]
impl Plugin for TimestampPlugin {
    fn name(&self) -> &str {
        "timestamp"
    }

    async fn before_write(&self, docs: &mut Vec<Document>) -> Result<()> {
        for doc in docs.iter_mut() {
            if let serde_json::Value::Object(ref mut map) = doc.data {
                map.insert(
                    "created_at".to_string(),
                    serde_json::json!("2026-02-10T00:00:00Z"),
                );
            }
        }
        Ok(())
    }
}

#[tokio::test]
async fn plugin_before_write_modifies_docs() {
    let db = Database::memory("test").with_plugin(Arc::new(TimestampPlugin));

    let result = db
        .put("doc1", serde_json::json!({"name": "Alice"}))
        .await
        .unwrap();
    assert!(result.ok);

    let doc = db.get("doc1").await.unwrap();
    assert_eq!(doc.data["name"], "Alice");
    assert_eq!(doc.data["created_at"], "2026-02-10T00:00:00Z");
}

// =========================================================================
// Plugin: after_write hook
// =========================================================================

struct CountPlugin {
    write_count: AtomicU64,
}

impl CountPlugin {
    fn new() -> Self {
        Self {
            write_count: AtomicU64::new(0),
        }
    }

    fn count(&self) -> u64 {
        self.write_count.load(Ordering::SeqCst)
    }
}

#[async_trait::async_trait]
impl Plugin for CountPlugin {
    fn name(&self) -> &str {
        "counter"
    }

    async fn after_write(&self, results: &[DocResult]) -> Result<()> {
        let successful = results.iter().filter(|r| r.ok).count() as u64;
        self.write_count.fetch_add(successful, Ordering::SeqCst);
        Ok(())
    }
}

#[tokio::test]
async fn plugin_after_write_tracks_count() {
    let counter = Arc::new(CountPlugin::new());
    let db = Database::memory("test").with_plugin(counter.clone());

    db.put("doc1", serde_json::json!({})).await.unwrap();
    assert_eq!(counter.count(), 1);

    db.put("doc2", serde_json::json!({})).await.unwrap();
    assert_eq!(counter.count(), 2);

    // bulk_docs
    let docs = vec![
        Document {
            id: "doc3".into(),
            rev: None,
            deleted: false,
            data: serde_json::json!({}),
            attachments: HashMap::new(),
        },
        Document {
            id: "doc4".into(),
            rev: None,
            deleted: false,
            data: serde_json::json!({}),
            attachments: HashMap::new(),
        },
    ];
    db.bulk_docs(docs, rouchdb::BulkDocsOptions::new())
        .await
        .unwrap();
    assert_eq!(counter.count(), 4);
}

// =========================================================================
// Plugin: on_destroy hook
// =========================================================================

struct DestroyPlugin {
    destroyed: AtomicBool,
}

impl DestroyPlugin {
    fn new() -> Self {
        Self {
            destroyed: AtomicBool::new(false),
        }
    }

    fn was_destroyed(&self) -> bool {
        self.destroyed.load(Ordering::SeqCst)
    }
}

#[async_trait::async_trait]
impl Plugin for DestroyPlugin {
    fn name(&self) -> &str {
        "destroy-tracker"
    }

    async fn on_destroy(&self) -> Result<()> {
        self.destroyed.store(true, Ordering::SeqCst);
        Ok(())
    }
}

#[tokio::test]
async fn plugin_on_destroy_called() {
    let destroy_plugin = Arc::new(DestroyPlugin::new());
    let db = Database::memory("test").with_plugin(destroy_plugin.clone());

    db.put("doc1", serde_json::json!({})).await.unwrap();

    assert!(!destroy_plugin.was_destroyed());
    db.destroy().await.unwrap();
    assert!(destroy_plugin.was_destroyed());
}

// =========================================================================
// Multiple plugins
// =========================================================================

#[tokio::test]
async fn multiple_plugins_all_called() {
    let counter = Arc::new(CountPlugin::new());
    let destroy_tracker = Arc::new(DestroyPlugin::new());

    let db = Database::memory("test")
        .with_plugin(Arc::new(TimestampPlugin))
        .with_plugin(counter.clone())
        .with_plugin(destroy_tracker.clone());

    db.put("doc1", serde_json::json!({"name": "Test"}))
        .await
        .unwrap();

    // TimestampPlugin should have added created_at
    let doc = db.get("doc1").await.unwrap();
    assert_eq!(doc.data["created_at"], "2026-02-10T00:00:00Z");

    // CountPlugin should have counted
    assert_eq!(counter.count(), 1);

    // DestroyPlugin should trigger on destroy
    db.destroy().await.unwrap();
    assert!(destroy_tracker.was_destroyed());
}

// =========================================================================
// Plugin: before_write can reject writes
// =========================================================================

struct ValidationPlugin;

#[async_trait::async_trait]
impl Plugin for ValidationPlugin {
    fn name(&self) -> &str {
        "validation"
    }

    async fn before_write(&self, docs: &mut Vec<Document>) -> Result<()> {
        for doc in docs.iter() {
            if doc.data.get("name").is_none() && !doc.deleted {
                return Err(rouchdb::RouchError::BadRequest(
                    "name field is required".into(),
                ));
            }
        }
        Ok(())
    }
}

#[tokio::test]
async fn plugin_validation_rejects_invalid_docs() {
    let db = Database::memory("test").with_plugin(Arc::new(ValidationPlugin));

    // Valid doc — has name
    let result = db.put("doc1", serde_json::json!({"name": "Alice"})).await;
    assert!(result.is_ok());

    // Invalid doc — no name field
    let result = db.put("doc2", serde_json::json!({"age": 25})).await;
    assert!(result.is_err());
}

// =========================================================================
// Partitioned databases
// =========================================================================

#[tokio::test]
async fn partition_put_and_get() {
    let db = Database::memory("test");
    let partition = db.partition("users");

    let result = partition
        .put("alice", serde_json::json!({"name": "Alice"}))
        .await
        .unwrap();
    assert!(result.ok);
    assert_eq!(result.id, "users:alice");

    let doc = partition.get("alice").await.unwrap();
    assert_eq!(doc.data["name"], "Alice");
    assert_eq!(doc.id, "users:alice");

    // Also accessible from the main db with full ID
    let doc2 = db.get("users:alice").await.unwrap();
    assert_eq!(doc2.data["name"], "Alice");
}

#[tokio::test]
async fn partition_put_with_full_id() {
    let db = Database::memory("test");
    let partition = db.partition("products");

    // Put with full partition prefix
    partition
        .put("products:widget", serde_json::json!({"name": "Widget"}))
        .await
        .unwrap();

    let doc = partition.get("widget").await.unwrap();
    assert_eq!(doc.id, "products:widget");
    assert_eq!(doc.data["name"], "Widget");
}

#[tokio::test]
async fn partition_all_docs() {
    let db = Database::memory("test");

    // Put docs in different partitions
    db.put("users:alice", serde_json::json!({"type": "user"}))
        .await
        .unwrap();
    db.put("users:bob", serde_json::json!({"type": "user"}))
        .await
        .unwrap();
    db.put("orders:o1", serde_json::json!({"type": "order"}))
        .await
        .unwrap();
    db.put("orders:o2", serde_json::json!({"type": "order"}))
        .await
        .unwrap();
    db.put("orders:o3", serde_json::json!({"type": "order"}))
        .await
        .unwrap();

    let users_partition = db.partition("users");
    let user_docs = users_partition
        .all_docs(AllDocsOptions {
            include_docs: true,
            ..AllDocsOptions::new()
        })
        .await
        .unwrap();
    assert_eq!(user_docs.rows.len(), 2);

    let orders_partition = db.partition("orders");
    let order_docs = orders_partition
        .all_docs(AllDocsOptions {
            include_docs: true,
            ..AllDocsOptions::new()
        })
        .await
        .unwrap();
    assert_eq!(order_docs.rows.len(), 3);
}

#[tokio::test]
async fn partition_find() {
    let db = Database::memory("test");

    db.put(
        "users:alice",
        serde_json::json!({"type": "user", "name": "Alice", "age": 30}),
    )
    .await
    .unwrap();
    db.put(
        "users:bob",
        serde_json::json!({"type": "user", "name": "Bob", "age": 25}),
    )
    .await
    .unwrap();
    db.put(
        "orders:o1",
        serde_json::json!({"type": "order", "amount": 100}),
    )
    .await
    .unwrap();

    let users = db.partition("users");
    let result = users
        .find(FindOptions {
            selector: serde_json::json!({"age": {"$gte": 28}}),
            ..Default::default()
        })
        .await
        .unwrap();

    assert_eq!(result.docs.len(), 1);
    assert_eq!(result.docs[0]["name"], "Alice");
}

#[tokio::test]
async fn partition_get_nonexistent() {
    let db = Database::memory("test");
    let partition = db.partition("users");

    let err = partition.get("nonexistent").await;
    assert!(err.is_err());
}

#[tokio::test]
async fn partition_isolation() {
    let db = Database::memory("test");

    // Put same short ID in different partitions
    db.put("team_a:doc1", serde_json::json!({"team": "A"}))
        .await
        .unwrap();
    db.put("team_b:doc1", serde_json::json!({"team": "B"}))
        .await
        .unwrap();

    let team_a = db.partition("team_a");
    let doc = team_a.get("doc1").await.unwrap();
    assert_eq!(doc.data["team"], "A");

    let team_b = db.partition("team_b");
    let doc = team_b.get("doc1").await.unwrap();
    assert_eq!(doc.data["team"], "B");
}

// =========================================================================
// Database constructors
// =========================================================================

#[tokio::test]
async fn from_adapter_works() {
    let adapter = Arc::new(rouchdb::MemoryAdapter::new("custom"));
    let db = Database::from_adapter(adapter);

    db.put("doc1", serde_json::json!({"v": 1})).await.unwrap();
    let info = db.info().await.unwrap();
    assert_eq!(info.doc_count, 1);
    assert_eq!(info.db_name, "custom");
}

#[tokio::test]
async fn redb_adapter_persistence() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("test.redb");

    // Write data
    {
        let db = Database::open(&path, "persist_test").unwrap();
        db.put("doc1", serde_json::json!({"persistent": true}))
            .await
            .unwrap();
    }

    // Reopen and verify
    {
        let db = Database::open(&path, "persist_test").unwrap();
        let doc = db.get("doc1").await.unwrap();
        assert_eq!(doc.data["persistent"], true);
    }
}