pigeon-cli 0.4.22

Pigeon: authenticate, sink, and transform personal data from external services.
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
use std::path::PathBuf;

use dialoguer::Input;

use crate::commands::job::report_upload;
use crate::commands::job::shared_wizard::{
    CheckersInput, ConfirmInput, TpslimitInput, TransfersInput,
};
use crate::commands::keyring::store::Store;
use crate::commands::{FAILURE_EXIT_CODE, fail};
use crate::core::job::Job;
use crate::core::rclone::config::{RemoteTarget, write_sandboxed_config};
use crate::core::wizard::WizardInput;

use super::worker;
use super::{RcloneCopyJob, RcloneDeleteJob};

/// Resolves `--source-bucket`, a pigeon keyring `BucketConfig` alias
/// (ADR-0136, reversing ADR-0101's original raw-passthrough design) --
/// `rclone` only ever sees a config file pigeon itself generates from this
/// alias, never an externally-provisioned or user-general-purpose
/// `rclone.conf`. Structurally identical to
/// `shared_wizard::SourceBucketInput`'s flag/prompt/error shape; kept local
/// since no second consumer exists yet. Shared by both `copy` and `delete`.
///
/// Accepts the composed `alias[:prefix/]` form (ADR-0138) -- a bare alias
/// is the whole bucket root, as it was under ADR-0136. Unlike
/// `transform`'s version there is no prefix default: this job has no
/// file-type concept to derive one from, so an omitted prefix stays the
/// root. The interactive picker yields a bucket root too; a prefix is
/// expressible via the flag.
struct SourceBucketInput<'a> {
    flag: Option<String>,
    store: &'a Store,
}

impl WizardInput for SourceBucketInput<'_> {
    type Value = RemoteTarget;

    fn flag_value(&self) -> Option<Result<RemoteTarget, String>> {
        self.flag
            .as_deref()
            .map(|value| RemoteTarget::parse(value, self.store))
    }

    fn prompt(&self) -> Result<RemoteTarget, String> {
        match self.store.prompt_select_bucket() {
            Ok(bucket_config) => Ok(RemoteTarget::bucket_root(&bucket_config.alias)),
            Err(message) => Err(message),
        }
    }

    fn non_interactive_fallback(&self) -> Result<RemoteTarget, String> {
        Err("--source-bucket is required when not running interactively".to_string())
    }
}

/// Resolves `--destination-bucket`. Same shape as `SourceBucketInput`,
/// composed form included. `copy` only -- `delete` has no destination.
struct DestinationBucketInput<'a> {
    flag: Option<String>,
    store: &'a Store,
}

impl WizardInput for DestinationBucketInput<'_> {
    type Value = RemoteTarget;

    fn flag_value(&self) -> Option<Result<RemoteTarget, String>> {
        self.flag
            .as_deref()
            .map(|value| RemoteTarget::parse(value, self.store))
    }

    fn prompt(&self) -> Result<RemoteTarget, String> {
        match self.store.prompt_select_bucket() {
            Ok(bucket_config) => Ok(RemoteTarget::bucket_root(&bucket_config.alias)),
            Err(message) => Err(message),
        }
    }

    fn non_interactive_fallback(&self) -> Result<RemoteTarget, String> {
        Err("--destination-bucket is required when not running interactively".to_string())
    }
}

fn default_local_output() -> PathBuf {
    std::env::temp_dir().join("pigeon-job")
}

/// Where this run's rclone log (also serving as this job's report) and
/// transcript are written -- unlike every other job, not a staging area
/// for transferred data, since rclone transfers directly source ->
/// destination with no pigeon-side staging. Shared by both actions.
struct LocalOutputInput {
    flag: Option<PathBuf>,
}

impl WizardInput for LocalOutputInput {
    type Value = PathBuf;

    fn flag_value(&self) -> Option<Result<PathBuf, String>> {
        self.flag.clone().map(Ok)
    }

    fn prompt(&self) -> Result<PathBuf, String> {
        let default = default_local_output();
        let value = Input::<String>::new()
            .with_prompt("Local directory this run's rclone log and transcript are written under")
            .default(default.display().to_string())
            .interact_text()
            .map_err(|err| format!("failed to read local output directory: {err}"))?;
        Ok(PathBuf::from(value))
    }

    fn non_interactive_fallback(&self) -> Result<PathBuf, String> {
        Ok(default_local_output())
    }
}

/// Entry point for `pigeon job run rclone copy` (ADR-0101, restructured by
/// ADR-0110).
#[allow(clippy::too_many_arguments)]
pub fn dispatch_copy(
    source_bucket: Option<String>,
    destination_bucket: Option<String>,
    local_output: Option<PathBuf>,
    report_bucket: Option<String>,
    transfers: Option<usize>,
    checkers: Option<usize>,
    tpslimit: Option<usize>,
    job_name: &'static str,
    non_interactive: bool,
) -> i32 {
    let runtime = match tokio::runtime::Builder::new_multi_thread()
        .enable_all()
        .build()
    {
        Ok(runtime) => runtime,
        Err(err) => return fail(format!("failed to start async runtime: {err}")),
    };
    runtime.block_on(dispatch_copy_async(
        source_bucket,
        destination_bucket,
        local_output,
        report_bucket,
        transfers,
        checkers,
        tpslimit,
        job_name,
        non_interactive,
    ))
}

#[allow(clippy::too_many_arguments)]
async fn dispatch_copy_async(
    source_bucket: Option<String>,
    destination_bucket: Option<String>,
    local_output: Option<PathBuf>,
    report_bucket: Option<String>,
    transfers: Option<usize>,
    checkers: Option<usize>,
    tpslimit: Option<usize>,
    job_name: &'static str,
    non_interactive: bool,
) -> i32 {
    // Held for this whole async fn's lifetime -- every early `return
    // fail(...)` below drops it, aborting the sampling task automatically
    // (ADR-0073).
    let _sampler =
        crate::observability::resources::ResourceSampler::spawn(std::time::Duration::from_secs(5));

    // Checked before any prompts, mirroring `transform::wizard`'s
    // `check_ffmpeg_available()` call -- fail immediately on a missing
    // binary, not partway through a long-running `rclone copy` subprocess.
    if let Err(err) = worker::check_rclone_available().await {
        return fail(err);
    }

    let keyring_store_path = match Store::default_path() {
        Ok(path) => path,
        Err(err) => return fail(err),
    };
    let keyring_store = match Store::load(&keyring_store_path) {
        Ok(store) => store,
        Err(err) => return fail(err),
    };
    let rclone_config_path = match crate::core::rclone::config::rclone_config_path() {
        Ok(path) => path,
        Err(err) => return fail(err),
    };
    if let Err(err) = write_sandboxed_config(&keyring_store, &rclone_config_path) {
        return fail(err);
    }

    let source = match (SourceBucketInput {
        flag: source_bucket,
        store: &keyring_store,
    })
    .resolve(non_interactive)
    {
        Ok(target) => target.address(),
        Err(err) => return fail(err),
    };
    let destination = match (DestinationBucketInput {
        flag: destination_bucket,
        store: &keyring_store,
    })
    .resolve(non_interactive)
    {
        Ok(target) => target.address(),
        Err(err) => return fail(err),
    };
    let local_output = match (LocalOutputInput { flag: local_output }).resolve(non_interactive) {
        Ok(value) => value,
        Err(err) => return fail(err),
    };
    let transfers = match (TransfersInput { flag: transfers }).resolve(non_interactive) {
        Ok(value) => value,
        Err(err) => return fail(err),
    };
    let checkers = match (CheckersInput { flag: checkers }).resolve(non_interactive) {
        Ok(value) => value,
        Err(err) => return fail(err),
    };
    let tpslimit = match (TpslimitInput { flag: tpslimit }).resolve(non_interactive) {
        Ok(value) => value,
        Err(err) => return fail(err),
    };
    let (report_bucket_config, report_secret) =
        match report_upload::resolve(report_bucket, &keyring_store, non_interactive) {
            Ok(value) => value,
            Err(err) => return fail(err),
        };

    println!("Source:      {source}");
    println!("Destination: {destination}");

    match (ConfirmInput { non_interactive }).resolve(non_interactive) {
        Ok(true) => {}
        Ok(false) => {
            println!("Cancelled.");
            return 0;
        }
        Err(err) => return fail(err),
    }

    if let Err(err) = std::fs::create_dir_all(&local_output) {
        return fail(format!(
            "failed to create {}: {err}",
            local_output.display()
        ));
    }

    let run_id = report_upload::generate_run_id();
    let run_prefix = report_upload::run_prefix(job_name, &run_id);
    let (transcript, transcript_path) = match report_upload::new_transcript(&local_output) {
        Ok(value) => value,
        Err(err) => return fail(err),
    };
    let log_path = local_output.join(format!("rclone-{run_id}.jsonl"));
    let log_path_for_err = log_path.clone();

    let job = RcloneCopyJob {
        source,
        destination,
        log_path,
        transfers,
        checkers,
        tpslimit,
    };
    let plan = match job.gather().await {
        Ok(plan) => plan,
        Err(err) => return fail(err),
    };

    let (exit_code, report_path) = match job.run(plan, 1, 1).await {
        Ok(summary) => {
            let message = format!(
                "Transferred {} file(s) ({} bytes), {} error(s).",
                summary.transferred, summary.bytes, summary.errors
            );
            report_upload::say(&transcript, message);
            let exit_code = if summary.errors > 0 {
                FAILURE_EXIT_CODE
            } else {
                0
            };
            (exit_code, summary.log_path)
        }
        Err(err) => {
            report_upload::say_error(&transcript, &err);
            (fail(err), log_path_for_err)
        }
    };

    println!("Report: {}", report_path.display());

    report_upload::log_run_outcome(exit_code);
    report_upload::upload_run_artifacts(
        &report_bucket_config,
        &report_secret,
        &run_prefix,
        &report_path,
        &transcript_path,
    )
    .await;

    exit_code
}

/// Entry point for `pigeon job run rclone delete` (ADR-0110).
pub fn dispatch_delete(
    source_bucket: Option<String>,
    local_output: Option<PathBuf>,
    report_bucket: Option<String>,
    checkers: Option<usize>,
    job_name: &'static str,
    non_interactive: bool,
) -> i32 {
    let runtime = match tokio::runtime::Builder::new_multi_thread()
        .enable_all()
        .build()
    {
        Ok(runtime) => runtime,
        Err(err) => return fail(format!("failed to start async runtime: {err}")),
    };
    runtime.block_on(dispatch_delete_async(
        source_bucket,
        local_output,
        report_bucket,
        checkers,
        job_name,
        non_interactive,
    ))
}

async fn dispatch_delete_async(
    source_bucket: Option<String>,
    local_output: Option<PathBuf>,
    report_bucket: Option<String>,
    checkers: Option<usize>,
    job_name: &'static str,
    non_interactive: bool,
) -> i32 {
    let _sampler =
        crate::observability::resources::ResourceSampler::spawn(std::time::Duration::from_secs(5));

    if let Err(err) = worker::check_rclone_available().await {
        return fail(err);
    }

    let keyring_store_path = match Store::default_path() {
        Ok(path) => path,
        Err(err) => return fail(err),
    };
    let keyring_store = match Store::load(&keyring_store_path) {
        Ok(store) => store,
        Err(err) => return fail(err),
    };
    let rclone_config_path = match crate::core::rclone::config::rclone_config_path() {
        Ok(path) => path,
        Err(err) => return fail(err),
    };
    if let Err(err) = write_sandboxed_config(&keyring_store, &rclone_config_path) {
        return fail(err);
    }

    let source = match (SourceBucketInput {
        flag: source_bucket,
        store: &keyring_store,
    })
    .resolve(non_interactive)
    {
        Ok(target) => target.address(),
        Err(err) => return fail(err),
    };
    let local_output = match (LocalOutputInput { flag: local_output }).resolve(non_interactive) {
        Ok(value) => value,
        Err(err) => return fail(err),
    };
    let checkers = match (CheckersInput { flag: checkers }).resolve(non_interactive) {
        Ok(value) => value,
        Err(err) => return fail(err),
    };
    let (report_bucket_config, report_secret) =
        match report_upload::resolve(report_bucket, &keyring_store, non_interactive) {
            Ok(value) => value,
            Err(err) => return fail(err),
        };

    println!("Source: {source}");
    println!("WARNING: this will recursively and permanently delete everything under this path.");

    match (ConfirmInput { non_interactive }).resolve(non_interactive) {
        Ok(true) => {}
        Ok(false) => {
            println!("Cancelled.");
            return 0;
        }
        Err(err) => return fail(err),
    }

    if let Err(err) = std::fs::create_dir_all(&local_output) {
        return fail(format!(
            "failed to create {}: {err}",
            local_output.display()
        ));
    }

    let run_id = report_upload::generate_run_id();
    let run_prefix = report_upload::run_prefix(job_name, &run_id);
    let (transcript, transcript_path) = match report_upload::new_transcript(&local_output) {
        Ok(value) => value,
        Err(err) => return fail(err),
    };
    // Distinct name from `copy`'s `rclone-{run_id}.jsonl` so a shared
    // `--local-output` directory never conflates the two actions' logs.
    let log_path = local_output.join(format!("rclone-purge-{run_id}.jsonl"));
    let log_path_for_err = log_path.clone();

    let job = RcloneDeleteJob {
        source,
        log_path,
        checkers,
    };
    let plan = match job.gather().await {
        Ok(plan) => plan,
        Err(err) => return fail(err),
    };

    let (exit_code, report_path) = match job.run(plan, 1, 1).await {
        Ok(summary) => {
            let message = format!(
                "Deleted {} object(s), {} error(s).",
                summary.deleted, summary.errors
            );
            report_upload::say(&transcript, message);
            let exit_code = if summary.errors > 0 {
                FAILURE_EXIT_CODE
            } else {
                0
            };
            (exit_code, summary.log_path)
        }
        Err(err) => {
            report_upload::say_error(&transcript, &err);
            (fail(err), log_path_for_err)
        }
    };

    println!("Report: {}", report_path.display());

    report_upload::log_run_outcome(exit_code);
    report_upload::upload_run_artifacts(
        &report_bucket_config,
        &report_secret,
        &run_prefix,
        &report_path,
        &transcript_path,
    )
    .await;

    exit_code
}

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

    #[test]
    fn transcript_contains_the_error_message_after_a_post_creation_failure() {
        let dir = tempfile::tempdir().unwrap();
        let (transcript, transcript_path) = report_upload::new_transcript(dir.path()).unwrap();
        report_upload::say_error(&transcript, "simulated rclone copy failure");
        let contents = std::fs::read_to_string(&transcript_path).unwrap();
        assert!(!contents.is_empty());
        assert!(contents.contains("simulated rclone copy failure"));
    }

    #[test]
    fn source_bucket_input_non_interactive_fallback_errors() {
        let store = Store::default();
        let input = SourceBucketInput {
            flag: None,
            store: &store,
        };
        assert_eq!(
            input.non_interactive_fallback(),
            Err("--source-bucket is required when not running interactively".to_string())
        );
    }

    #[test]
    fn source_bucket_input_flag_value_rejects_an_unknown_alias() {
        let store = Store::default();
        let input = SourceBucketInput {
            flag: Some("nope".to_string()),
            store: &store,
        };
        assert_eq!(
            input.flag_value(),
            Some(Err("no bucket-config named 'nope'".to_string()))
        );
    }

    #[test]
    fn destination_bucket_input_non_interactive_fallback_errors() {
        let store = Store::default();
        let input = DestinationBucketInput {
            flag: None,
            store: &store,
        };
        assert_eq!(
            input.non_interactive_fallback(),
            Err("--destination-bucket is required when not running interactively".to_string())
        );
    }
}