rabbitmq-backup-core 0.1.0

Core engine for RabbitMQ backup and restore operations
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
//! SQLite-based offset storage for checkpoint persistence.

use std::path::Path;
use std::sync::Arc;

use bytes::Bytes;
use sqlx::sqlite::{SqliteConnectOptions, SqlitePoolOptions};
use sqlx::{Row, SqlitePool};
use tracing::{debug, info};

use crate::error::{Error, Result};
use crate::storage::StorageBackend;

/// Progress record for a single queue backup.
#[derive(Debug, Clone)]
pub struct QueueProgress {
    pub backup_id: String,
    pub vhost: String,
    pub queue_name: String,
    pub messages_backed_up: u64,
    pub last_segment_sequence: u64,
    pub target_message_count: u64,
    pub completed: bool,
    pub updated_at: i64,
}

/// Update payload for queue checkpoint progress.
pub struct QueueProgressUpdate<'a> {
    pub backup_id: &'a str,
    pub vhost: &'a str,
    pub queue_name: &'a str,
    pub messages_backed_up: u64,
    pub last_segment_sequence: u64,
    pub target_message_count: u64,
    pub completed: bool,
}

/// Tracks backup progress (delivery tags, segment sequences) in a SQLite database
/// with periodic sync to remote storage.
pub struct SqliteOffsetStore {
    pool: SqlitePool,
    db_path: String,
}

impl SqliteOffsetStore {
    /// Create or open the offset store database.
    pub async fn new(db_path: &Path) -> Result<Self> {
        let db_path_str = db_path.to_string_lossy().to_string();

        let options = SqliteConnectOptions::new()
            .filename(db_path)
            .create_if_missing(true)
            .journal_mode(sqlx::sqlite::SqliteJournalMode::Wal)
            .synchronous(sqlx::sqlite::SqliteSynchronous::Normal);

        let pool = SqlitePoolOptions::new()
            .max_connections(2)
            .connect_with(options)
            .await
            .map_err(|e| Error::Checkpoint(format!("Failed to open offset DB: {}", e)))?;

        let store = Self {
            pool,
            db_path: db_path_str,
        };

        store.run_migrations().await?;

        Ok(store)
    }

    /// Run database migrations.
    async fn run_migrations(&self) -> Result<()> {
        sqlx::query(
            "CREATE TABLE IF NOT EXISTS queue_progress (
                backup_id TEXT NOT NULL,
                vhost TEXT NOT NULL,
                queue_name TEXT NOT NULL,
                messages_backed_up INTEGER NOT NULL DEFAULT 0,
                last_segment_sequence INTEGER NOT NULL DEFAULT 0,
                target_message_count INTEGER NOT NULL DEFAULT 0,
                completed INTEGER NOT NULL DEFAULT 0,
                updated_at INTEGER NOT NULL,
                PRIMARY KEY (backup_id, vhost, queue_name)
            )",
        )
        .execute(&self.pool)
        .await?;

        self.ensure_column(
            "queue_progress",
            "target_message_count",
            "ALTER TABLE queue_progress ADD COLUMN target_message_count INTEGER NOT NULL DEFAULT 0",
        )
        .await?;
        self.ensure_column(
            "queue_progress",
            "completed",
            "ALTER TABLE queue_progress ADD COLUMN completed INTEGER NOT NULL DEFAULT 0",
        )
        .await?;

        sqlx::query(
            "CREATE TABLE IF NOT EXISTS backup_jobs (
                backup_id TEXT PRIMARY KEY,
                status TEXT NOT NULL DEFAULT 'running',
                created_at INTEGER NOT NULL,
                last_heartbeat INTEGER NOT NULL
            )",
        )
        .execute(&self.pool)
        .await?;

        debug!("Offset store migrations complete");
        Ok(())
    }

    async fn ensure_column(&self, table: &str, column: &str, alter_sql: &str) -> Result<()> {
        let rows = sqlx::query(&format!("PRAGMA table_info({})", table))
            .fetch_all(&self.pool)
            .await?;
        let exists = rows
            .iter()
            .any(|row| row.get::<String, _>("name") == column);

        if !exists {
            sqlx::query(alter_sql).execute(&self.pool).await?;
        }

        Ok(())
    }

    /// Get the progress for a specific queue.
    pub async fn get_progress(
        &self,
        backup_id: &str,
        vhost: &str,
        queue_name: &str,
    ) -> Result<Option<QueueProgress>> {
        let row = sqlx::query(
            "SELECT backup_id, vhost, queue_name, messages_backed_up, last_segment_sequence,
                    target_message_count, completed, updated_at
             FROM queue_progress
             WHERE backup_id = ? AND vhost = ? AND queue_name = ?",
        )
        .bind(backup_id)
        .bind(vhost)
        .bind(queue_name)
        .fetch_optional(&self.pool)
        .await?;

        Ok(row.map(|r| QueueProgress {
            backup_id: r.get("backup_id"),
            vhost: r.get("vhost"),
            queue_name: r.get("queue_name"),
            messages_backed_up: r.get::<i64, _>("messages_backed_up") as u64,
            last_segment_sequence: r.get::<i64, _>("last_segment_sequence") as u64,
            target_message_count: r.get::<i64, _>("target_message_count") as u64,
            completed: r.get::<i64, _>("completed") != 0,
            updated_at: r.get("updated_at"),
        }))
    }

    /// Update the progress for a specific queue.
    pub async fn set_progress(
        &self,
        backup_id: &str,
        vhost: &str,
        queue_name: &str,
        messages_backed_up: u64,
        last_segment_sequence: u64,
    ) -> Result<()> {
        self.set_progress_state(QueueProgressUpdate {
            backup_id,
            vhost,
            queue_name,
            messages_backed_up,
            last_segment_sequence,
            target_message_count: 0,
            completed: false,
        })
        .await
    }

    /// Update the full progress state for a specific queue.
    pub async fn set_progress_state(&self, update: QueueProgressUpdate<'_>) -> Result<()> {
        let now = chrono::Utc::now().timestamp();

        sqlx::query(
            "INSERT INTO queue_progress (
                backup_id, vhost, queue_name, messages_backed_up, last_segment_sequence,
                target_message_count, completed, updated_at
             )
             VALUES (?, ?, ?, ?, ?, ?, ?, ?)
             ON CONFLICT (backup_id, vhost, queue_name) DO UPDATE SET
                messages_backed_up = excluded.messages_backed_up,
                last_segment_sequence = excluded.last_segment_sequence,
                target_message_count = excluded.target_message_count,
                completed = excluded.completed,
                updated_at = excluded.updated_at",
        )
        .bind(update.backup_id)
        .bind(update.vhost)
        .bind(update.queue_name)
        .bind(update.messages_backed_up as i64)
        .bind(update.last_segment_sequence as i64)
        .bind(update.target_message_count as i64)
        .bind(if update.completed { 1_i64 } else { 0_i64 })
        .bind(now)
        .execute(&self.pool)
        .await?;

        Ok(())
    }

    /// Record or update a backup job.
    pub async fn set_job_status(&self, backup_id: &str, status: &str) -> Result<()> {
        let now = chrono::Utc::now().timestamp();

        sqlx::query(
            "INSERT INTO backup_jobs (backup_id, status, created_at, last_heartbeat)
             VALUES (?, ?, ?, ?)
             ON CONFLICT (backup_id) DO UPDATE SET
                status = excluded.status,
                last_heartbeat = excluded.last_heartbeat",
        )
        .bind(backup_id)
        .bind(status)
        .bind(now)
        .bind(now)
        .execute(&self.pool)
        .await?;

        Ok(())
    }

    /// Flush WAL checkpoint.
    pub async fn checkpoint(&self) -> Result<()> {
        sqlx::query("PRAGMA wal_checkpoint(TRUNCATE)")
            .execute(&self.pool)
            .await?;
        debug!("SQLite WAL checkpoint complete");
        Ok(())
    }

    /// Upload the database file to remote storage.
    pub async fn sync_to_storage(
        &self,
        storage: &Arc<dyn StorageBackend>,
        key: &str,
    ) -> Result<()> {
        self.checkpoint().await?;

        let data = tokio::fs::read(&self.db_path)
            .await
            .map_err(|e| Error::Checkpoint(format!("Failed to read offset DB: {}", e)))?;

        storage.put(key, Bytes::from(data)).await?;
        info!("Synced offset store to {}", key);
        Ok(())
    }

    /// Try to load the database from remote storage (if local is empty/missing).
    pub async fn try_load_from_storage(
        storage: &Arc<dyn StorageBackend>,
        key: &str,
        local_path: &Path,
    ) -> Result<bool> {
        match storage.get(key).await {
            Ok(data) => {
                if let Some(parent) = local_path.parent() {
                    tokio::fs::create_dir_all(parent).await.map_err(|e| {
                        Error::Checkpoint(format!("Failed to create directory: {}", e))
                    })?;
                }
                tokio::fs::write(local_path, &data)
                    .await
                    .map_err(|e| Error::Checkpoint(format!("Failed to write offset DB: {}", e)))?;
                info!("Loaded offset store from {}", key);
                Ok(true)
            }
            Err(_) => {
                debug!("No remote offset store found at {}", key);
                Ok(false)
            }
        }
    }
}

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

    #[tokio::test]
    async fn test_sqlite_offset_store_basic() {
        let temp_dir = tempfile::tempdir().unwrap();
        let db_path = temp_dir.path().join("test-offsets.db");
        let store = SqliteOffsetStore::new(&db_path).await.unwrap();

        // Initially no progress
        let progress = store.get_progress("backup-1", "/", "orders").await.unwrap();
        assert!(progress.is_none());

        // Set progress
        store
            .set_progress("backup-1", "/", "orders", 100, 3)
            .await
            .unwrap();

        // Read back
        let progress = store
            .get_progress("backup-1", "/", "orders")
            .await
            .unwrap()
            .unwrap();
        assert_eq!(progress.messages_backed_up, 100);
        assert_eq!(progress.last_segment_sequence, 3);
        assert_eq!(progress.target_message_count, 0);
        assert!(!progress.completed);

        // Update
        store
            .set_progress_state(QueueProgressUpdate {
                backup_id: "backup-1",
                vhost: "/",
                queue_name: "orders",
                messages_backed_up: 200,
                last_segment_sequence: 5,
                target_message_count: 200,
                completed: true,
            })
            .await
            .unwrap();

        let progress = store
            .get_progress("backup-1", "/", "orders")
            .await
            .unwrap()
            .unwrap();
        assert_eq!(progress.messages_backed_up, 200);
        assert_eq!(progress.last_segment_sequence, 5);
        assert_eq!(progress.target_message_count, 200);
        assert!(progress.completed);
    }

    #[tokio::test]
    async fn test_sqlite_offset_store_job_status() {
        let temp_dir = tempfile::tempdir().unwrap();
        let db_path = temp_dir.path().join("test-offsets.db");
        let store = SqliteOffsetStore::new(&db_path).await.unwrap();

        store.set_job_status("backup-1", "running").await.unwrap();
        store.set_job_status("backup-1", "completed").await.unwrap();
    }

    #[tokio::test]
    async fn test_sqlite_offset_store_checkpoint() {
        let temp_dir = tempfile::tempdir().unwrap();
        let db_path = temp_dir.path().join("test-offsets.db");
        let store = SqliteOffsetStore::new(&db_path).await.unwrap();

        store
            .set_progress("backup-1", "/", "queue1", 50, 1)
            .await
            .unwrap();
        store.checkpoint().await.unwrap();
    }

    #[tokio::test]
    async fn test_sqlite_offset_store_sync_roundtrip() {
        use crate::storage::MemoryBackend;

        let temp_dir = tempfile::tempdir().unwrap();
        let db_path = temp_dir.path().join("test-offsets.db");
        let store = SqliteOffsetStore::new(&db_path).await.unwrap();

        store
            .set_progress("backup-1", "/", "queue1", 42, 2)
            .await
            .unwrap();

        // Sync to memory storage
        let backend: Arc<dyn StorageBackend> = Arc::new(MemoryBackend::new());
        store
            .sync_to_storage(&backend, "state/offsets.db")
            .await
            .unwrap();

        // Load from storage to a new location
        let new_db_path = temp_dir.path().join("loaded-offsets.db");
        let loaded =
            SqliteOffsetStore::try_load_from_storage(&backend, "state/offsets.db", &new_db_path)
                .await
                .unwrap();
        assert!(loaded);

        // Open the loaded DB and verify data
        let store2 = SqliteOffsetStore::new(&new_db_path).await.unwrap();
        let progress = store2
            .get_progress("backup-1", "/", "queue1")
            .await
            .unwrap()
            .unwrap();
        assert_eq!(progress.messages_backed_up, 42);
        assert_eq!(progress.last_segment_sequence, 2);
        assert_eq!(progress.target_message_count, 0);
        assert!(!progress.completed);
    }
}