s3tui 0.5.0

Simple TUI application for multiple s3 account 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
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
//! Transfer Queue Manager
//!
//! Provides centralized management for file transfers with:
//! - Queue management with FIFO ordering
//! - Configurable concurrency limits
//! - Pause/resume/cancel functionality
//! - Priority adjustment

use serde::{Deserialize, Serialize};
use std::collections::{HashMap, VecDeque};
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use std::sync::Arc;
use tokio::sync::{Mutex, Semaphore};

/// Signal used to pause/cancel a running transfer
pub type PauseSignal = Arc<AtomicBool>;

/// Unique identifier for a transfer job
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct JobId(u64);

impl JobId {
    fn new(id: u64) -> Self {
        JobId(id)
    }
}

impl From<u64> for JobId {
    fn from(id: u64) -> Self {
        JobId(id)
    }
}

impl std::fmt::Display for JobId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "Job-{}", self.0)
    }
}

/// Status of a transfer job
#[derive(Debug, Clone, PartialEq)]
pub enum TransferStatus {
    /// Waiting in queue
    Queued,
    /// Currently transferring
    Active { progress: f64 },
    /// Paused by user
    Paused { progress: f64 },
    /// Successfully completed
    Completed,
    /// Failed with error
    Failed { error: String },
    /// Cancelled by user
    Cancelled,
}


/// Represents a single transfer job
#[derive(Debug, Clone)]
pub struct TransferJob {
    /// Unique job identifier
    pub id: JobId,
    /// Current status
    pub status: TransferStatus,
    /// Priority (higher = more urgent, default is 0)
    pub priority: i32,
}

impl TransferJob {
    /// Create a new job
    fn new(id: JobId) -> Self {
        TransferJob {
            id,
            status: TransferStatus::Queued,
            priority: 0,
        }
    }
}

/// Priority queue for transfer jobs
#[derive(Debug)]
struct TransferQueue {
    jobs: VecDeque<TransferJob>,
}

impl TransferQueue {
    fn new() -> Self {
        TransferQueue {
            jobs: VecDeque::new(),
        }
    }

    /// Add a job to the queue (maintains priority ordering)
    fn enqueue(&mut self, job: TransferJob) {
        // Find insertion point based on priority (higher priority first)
        let pos = self
            .jobs
            .iter()
            .position(|j| j.priority < job.priority)
            .unwrap_or(self.jobs.len());
        self.jobs.insert(pos, job);
    }

    /// Remove and return the next job to process
    fn dequeue(&mut self) -> Option<TransferJob> {
        self.jobs.pop_front()
    }

    /// Get a job by ID without removing it
    fn get(&self, job_id: JobId) -> Option<&TransferJob> {
        self.jobs.iter().find(|j| j.id == job_id)
    }

    /// Remove a job from the queue
    fn remove(&mut self, job_id: JobId) -> Option<TransferJob> {
        if let Some(pos) = self.jobs.iter().position(|j| j.id == job_id) {
            self.jobs.remove(pos)
        } else {
            None
        }
    }

    /// Move a job to the front of the queue
    fn prioritize(&mut self, job_id: JobId) {
        if let Some(pos) = self.jobs.iter().position(|j| j.id == job_id) {
            if let Some(job) = self.jobs.remove(pos) {
                self.jobs.push_front(job);
            }
        }
    }

}

/// Central coordinator for all transfers
pub struct TransferManager {
    /// Counter for generating unique job IDs
    next_job_id: AtomicU64,
    /// Pending jobs queue
    pending: Arc<Mutex<TransferQueue>>,
    /// Active jobs (currently transferring)
    active: Arc<Mutex<Vec<TransferJob>>>,
    /// Paused jobs
    paused: Arc<Mutex<Vec<TransferJob>>>,
    /// Completed/failed/cancelled jobs history
    history: Arc<Mutex<Vec<TransferJob>>>,
    /// Semaphore for concurrency control
    semaphore: Arc<Semaphore>,
    /// Pause signals for active jobs - set to true to signal task to stop
    pause_signals: Arc<Mutex<HashMap<JobId, PauseSignal>>>,
}

impl TransferManager {
    /// Create a new transfer manager with specified concurrency limit
    pub fn new(concurrency: usize) -> Self {
        TransferManager {
            next_job_id: AtomicU64::new(1),
            pending: Arc::new(Mutex::new(TransferQueue::new())),
            active: Arc::new(Mutex::new(Vec::new())),
            paused: Arc::new(Mutex::new(Vec::new())),
            history: Arc::new(Mutex::new(Vec::new())),
            semaphore: Arc::new(Semaphore::new(concurrency)),
            pause_signals: Arc::new(Mutex::new(HashMap::new())),
        }
    }

    /// Generate a new unique job ID
    fn generate_job_id(&self) -> JobId {
        JobId::new(self.next_job_id.fetch_add(1, Ordering::SeqCst))
    }

    /// Add a new upload job to the queue
    pub async fn enqueue_upload(&self, _local_path: String, _s3_path: String, _size: Option<u64>) -> JobId {
        let job_id = self.generate_job_id();
        let job = TransferJob::new(job_id);
        self.pending.lock().await.enqueue(job);
        job_id
    }

    /// Add a new download job to the queue
    pub async fn enqueue_download(&self, _s3_path: String, _local_path: String, _size: Option<u64>) -> JobId {
        let job_id = self.generate_job_id();
        let job = TransferJob::new(job_id);
        self.pending.lock().await.enqueue(job);
        job_id
    }

    /// Pause a transfer (move from active or pending to paused)
    /// For active transfers, this also signals the running task to stop
    pub async fn pause(&self, job_id: JobId) -> Result<(), String> {
        // First try active list
        {
            let mut active = self.active.lock().await;
            if let Some(pos) = active.iter().position(|j| j.id == job_id) {
                let mut job = active.remove(pos);
                if let TransferStatus::Active { progress } = job.status {
                    job.status = TransferStatus::Paused { progress };
                }
                self.paused.lock().await.push(job);

                // Signal the running task to stop
                if let Some(signal) = self.pause_signals.lock().await.remove(&job_id) {
                    signal.store(true, Ordering::SeqCst);
                }

                // Release the concurrency slot so other jobs can run
                drop(active);
                self.release_slot();
                return Ok(());
            }
        }

        // Also check pending queue (job might be resumed but not yet picked up by worker)
        {
            let mut pending = self.pending.lock().await;
            if let Some(job) = pending.remove(job_id) {
                let progress = match job.status {
                    TransferStatus::Active { progress } => progress,
                    TransferStatus::Queued => 0.0,
                    _ => 0.0,
                };
                let mut paused_job = job;
                paused_job.status = TransferStatus::Paused { progress };
                self.paused.lock().await.push(paused_job);
                return Ok(());
            }
        }

        Err(format!("Job {} is not active or pending", job_id))
    }

    /// Resume a paused transfer (move from paused back to pending queue front)
    pub async fn resume(&self, job_id: JobId) -> Result<(), String> {
        let mut paused = self.paused.lock().await;
        if let Some(pos) = paused.iter().position(|j| j.id == job_id) {
            let mut job = paused.remove(pos);
            if let TransferStatus::Paused { progress } = job.status {
                job.status = TransferStatus::Active { progress };
            } else {
                job.status = TransferStatus::Queued;
            }
            // Add to front of queue for immediate processing
            let mut pending = self.pending.lock().await;
            pending.prioritize(job_id);
            if pending.get(job_id).is_none() {
                job.priority = i32::MAX; // Highest priority
                pending.enqueue(job);
            }
            Ok(())
        } else {
            Err(format!("Job {} is not paused", job_id))
        }
    }

    /// Cancel a transfer (remove from any queue and mark as cancelled)
    pub async fn cancel(&self, job_id: JobId) -> Result<(), String> {
        // Try to remove from pending (no slot to release - wasn't started)
        {
            let mut pending = self.pending.lock().await;
            if let Some(mut job) = pending.remove(job_id) {
                job.status = TransferStatus::Cancelled;
                self.history.lock().await.push(job);
                return Ok(());
            }
        }

        // Try to remove from paused (no slot to release - was paused)
        {
            let mut paused = self.paused.lock().await;
            if let Some(pos) = paused.iter().position(|j| j.id == job_id) {
                let mut job = paused.remove(pos);
                job.status = TransferStatus::Cancelled;
                self.history.lock().await.push(job);
                return Ok(());
            }
        }

        // Try to remove from active (need to release slot and signal task to stop)
        {
            let mut active = self.active.lock().await;
            if let Some(pos) = active.iter().position(|j| j.id == job_id) {
                let mut job = active.remove(pos);
                job.status = TransferStatus::Cancelled;
                self.history.lock().await.push(job);
                // Signal the running task to stop
                if let Some(signal) = self.pause_signals.lock().await.remove(&job_id) {
                    signal.store(true, Ordering::SeqCst);
                }
                drop(active); // Release lock before adding permit
                self.release_slot();
                return Ok(());
            }
        }

        Err(format!("Job {} not found", job_id))
    }

    /// Mark a job as completed
    pub async fn mark_completed(&self, job_id: JobId) {
        let mut active = self.active.lock().await;
        if let Some(pos) = active.iter().position(|j| j.id == job_id) {
            let mut job = active.remove(pos);
            job.status = TransferStatus::Completed;
            self.history.lock().await.push(job);
            // Clean up pause signal
            self.pause_signals.lock().await.remove(&job_id);
            // Release the concurrency slot
            drop(active); // Release lock before adding permit
            self.release_slot();
        }
    }

    /// Mark a job as failed
    pub async fn mark_failed(&self, job_id: JobId, error: String) {
        let mut active = self.active.lock().await;
        if let Some(pos) = active.iter().position(|j| j.id == job_id) {
            let mut job = active.remove(pos);
            job.status = TransferStatus::Failed { error };
            self.history.lock().await.push(job);
            // Clean up pause signal
            self.pause_signals.lock().await.remove(&job_id);
            // Release the concurrency slot
            drop(active); // Release lock before adding permit
            self.release_slot();
        }
    }

    /// Get the next job to process (if concurrency allows)
    /// Returns None if no jobs are pending or concurrency limit is reached
    /// Returns the job and a pause signal that can be used to stop the transfer
    pub async fn try_get_next(&self) -> Option<(TransferJob, PauseSignal)> {
        // Check if we can acquire a permit (don't actually acquire yet)
        let available = self.semaphore.available_permits();
        if available == 0 {
            return None;
        }

        // Dequeue job while holding pending lock, then release it
        let job = {
            let mut pending = self.pending.lock().await;
            pending.dequeue()
        };

        if let Some(mut job) = job {
            // Now acquire the permit (we know one is available)
            let _permit = self.semaphore.try_acquire().ok()?;
            // Forget the permit - it will be released when mark_completed/mark_failed is called
            std::mem::forget(_permit);

            job.status = TransferStatus::Active { progress: 0.0 };
            let job_id = job.id;
            self.active.lock().await.push(job.clone());

            // Create a pause signal for this job
            let pause_signal = Arc::new(AtomicBool::new(false));
            self.pause_signals
                .lock()
                .await
                .insert(job_id, pause_signal.clone());

            Some((job, pause_signal))
        } else {
            None
        }
    }

    /// Release a concurrency slot (called when transfer completes/fails/cancels)
    pub fn release_slot(&self) {
        self.semaphore.add_permits(1);
    }
}

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

    #[tokio::test]
    async fn test_job_id_generation() {
        let manager = TransferManager::new(4);
        let id1 = manager.enqueue_upload("local1".into(), "s3/path1".into(), Some(100)).await;
        let id2 = manager.enqueue_upload("local2".into(), "s3/path2".into(), Some(200)).await;
        assert_ne!(id1, id2);
    }

    #[tokio::test]
    async fn test_transfer_queue_ordering() {
        let manager = TransferManager::new(4);

        // Enqueue jobs
        let id1 = manager.enqueue_upload("file1".into(), "s3/file1".into(), None).await;
        let id2 = manager.enqueue_upload("file2".into(), "s3/file2".into(), None).await;
        let id3 = manager.enqueue_upload("file3".into(), "s3/file3".into(), None).await;

        // Should come out in FIFO order
        let (job1, _) = manager.try_get_next().await.unwrap();
        assert_eq!(job1.id, id1);

        let (job2, _) = manager.try_get_next().await.unwrap();
        assert_eq!(job2.id, id2);

        let (job3, _) = manager.try_get_next().await.unwrap();
        assert_eq!(job3.id, id3);
    }

    #[tokio::test]
    async fn test_transfer_pause_resume() {
        let manager = TransferManager::new(4);

        let job_id = manager.enqueue_upload("file".into(), "s3/file".into(), None).await;

        // Start the job
        let (job, _) = manager.try_get_next().await.unwrap();
        assert_eq!(job.id, job_id);

        // Pause
        manager.pause(job_id).await.unwrap();

        // Resume
        manager.resume(job_id).await.unwrap();

        // Job should be back in pending queue - can get it again
        let (job, _) = manager.try_get_next().await.unwrap();
        assert_eq!(job.id, job_id);
    }

    #[tokio::test]
    async fn test_pause_immediately_after_resume() {
        let manager = TransferManager::new(4);

        let job_id = manager.enqueue_upload("file".into(), "s3/file".into(), None).await;

        // Start the job
        let (job, _) = manager.try_get_next().await.unwrap();
        assert_eq!(job.id, job_id);

        // Pause
        manager.pause(job_id).await.unwrap();

        // Resume - job goes to pending queue
        manager.resume(job_id).await.unwrap();

        // Immediately pause again (before worker picks it up)
        // This should work - job is in pending queue
        manager.pause(job_id).await.unwrap();

        // Job should now be in paused state, not in pending
        assert!(manager.try_get_next().await.is_none());

        // Resume again and verify it can be retrieved
        manager.resume(job_id).await.unwrap();
        let (job, _) = manager.try_get_next().await.unwrap();
        assert_eq!(job.id, job_id);
    }

    #[tokio::test]
    async fn test_transfer_cancel() {
        let manager = TransferManager::new(4);

        let job_id = manager.enqueue_upload("file".into(), "s3/file".into(), None).await;

        // Cancel from pending
        manager.cancel(job_id).await.unwrap();

        // Job is no longer available
        assert!(manager.try_get_next().await.is_none());
    }

    #[tokio::test]
    async fn test_concurrent_transfer_limit() {
        let manager = TransferManager::new(2); // Only 2 concurrent

        // Enqueue 4 jobs
        manager.enqueue_upload("file1".into(), "s3/file1".into(), None).await;
        manager.enqueue_upload("file2".into(), "s3/file2".into(), None).await;
        manager.enqueue_upload("file3".into(), "s3/file3".into(), None).await;
        manager.enqueue_upload("file4".into(), "s3/file4".into(), None).await;

        // Should only get 2 jobs (concurrency limit)
        assert!(manager.try_get_next().await.is_some());
        assert!(manager.try_get_next().await.is_some());
        assert!(manager.try_get_next().await.is_none()); // No more permits
    }

    #[tokio::test]
    async fn test_mark_completed() {
        let manager = TransferManager::new(4);

        let job_id = manager.enqueue_upload("file".into(), "s3/file".into(), None).await;
        manager.try_get_next().await;

        manager.mark_completed(job_id).await;

        // After completion, slot is released - can process another job
        manager.enqueue_upload("file2".into(), "s3/file2".into(), None).await;
        assert!(manager.try_get_next().await.is_some());
    }

    #[tokio::test]
    async fn test_mark_failed() {
        let manager = TransferManager::new(4);

        let job_id = manager.enqueue_upload("file".into(), "s3/file".into(), None).await;
        manager.try_get_next().await;

        manager.mark_failed(job_id, "Network error".into()).await;

        // After failure, slot is released - can process another job
        manager.enqueue_upload("file2".into(), "s3/file2".into(), None).await;
        assert!(manager.try_get_next().await.is_some());
    }
}