carwash 0.4.0

Reclaim disk space across every project on your machine: finds build outputs, dependency installs and caches for 40+ ecosystems, then cleans, updates and runs tasks from one TUI
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
//! The interactive UI.
//!
//! [`app::App`] holds all state and turns messages into effects; this module is the only
//! place with side effects: terminal I/O, engine threads, the filesystem.

mod app;
mod caches;
mod folder;
mod keymap;
mod pty;
mod query;
mod store;
mod tasks;
mod theme;
mod updates;
mod view;
mod widgets;

use crate::context::Context;
use anyhow::Result;
use app::{App, Effect, Msg};
use carwash_core::clean::CleanOptions;
use carwash_core::deps::Checker;
use carwash_core::tasks::Task;
use carwash_core::{Cancel, Counters, ScanOptions, history};
use crossbeam_channel::{Receiver, RecvTimeoutError, Sender};
use ratatui::crossterm::event::{self, DisableMouseCapture, EnableMouseCapture, Event};
use ratatui::crossterm::execute;
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::time::Duration;

/// Messages processed before a redraw, so bursts of engine events cost one frame.
const MAX_BATCH: usize = 2_000;
const FAST_TICK: Duration = Duration::from_millis(90);
const IDLE_TICK: Duration = Duration::from_secs(1);

pub fn run(ctx: &Context, root: PathBuf, options: ScanOptions) -> Result<()> {
    let cache = ctx
        .dirs
        .as_ref()
        .map(|d| carwash_core::cache::SizeCache::load(&d.size_cache_file()))
        .unwrap_or_default();
    let mut app = App::new(
        root.clone(),
        ctx.engine.registry().clone(),
        cache,
        ctx.policy(false, false),
        ctx.config.clean.mode,
        theme::Theme::named(&ctx.config.ui.theme),
        theme::Glyphs::named(&ctx.config.ui.icons),
    );

    let mut terminal = ratatui::init();
    let _ = execute!(std::io::stdout(), EnableMouseCapture);
    let previous_hook = std::panic::take_hook();
    std::panic::set_hook(Box::new(move |info| {
        let _ = execute!(std::io::stdout(), DisableMouseCapture);
        previous_hook(info);
    }));

    let (tx, rx) = crossbeam_channel::unbounded();
    let stop = Arc::new(AtomicBool::new(false));
    let input = spawn_input(tx.clone(), stop.clone());
    let mut runtime = Runtime {
        ctx,
        root,
        options,
        tx,
        scan_cancel: None,
        scan_generation: 0,
        clean_cancel: None,
        jobs: HashMap::new(),
        next_job: 0,
        pty_size: (24, 80),
        checker: Arc::new(crate::commands::outdated::checker(ctx)),
    };
    for effect in app.startup() {
        runtime.execute(effect);
    }

    let result = event_loop(&mut terminal, &mut app, &mut runtime, &rx);

    stop.store(true, Ordering::Relaxed);
    runtime.cancel_all();
    let _ = execute!(std::io::stdout(), DisableMouseCapture);
    ratatui::restore();
    let _ = input.join();
    if let Some(dirs) = &ctx.dirs
        && let Err(error) = app.cache.save(&dirs.size_cache_file())
    {
        tracing::warn!(%error, "cannot save size cache");
    }
    result
}

fn event_loop(
    terminal: &mut ratatui::DefaultTerminal,
    app: &mut App,
    runtime: &mut Runtime<'_>,
    rx: &Receiver<Msg>,
) -> Result<()> {
    loop {
        if app.dirty {
            terminal.draw(|frame| view::render(frame, app))?;
            app.dirty = false;
            runtime.resize_jobs(app.tasks.pty_size);
        }
        let timeout = if app.animating() {
            FAST_TICK
        } else {
            IDLE_TICK
        };
        let first = match rx.recv_timeout(timeout) {
            Ok(msg) => msg,
            Err(RecvTimeoutError::Timeout) => Msg::Tick,
            Err(RecvTimeoutError::Disconnected) => return Ok(()),
        };
        let mut effects = app.update(first);
        for msg in rx.try_iter().take(MAX_BATCH) {
            effects.extend(app.update(msg));
        }
        if app.animating() {
            // Keep spinners moving even while events stream in.
            effects.extend(app.update(Msg::Tick));
        }
        for effect in effects {
            runtime.execute(effect);
        }
        if app.quit {
            return Ok(());
        }
    }
}

fn spawn_input(tx: Sender<Msg>, stop: Arc<AtomicBool>) -> std::thread::JoinHandle<()> {
    std::thread::spawn(move || {
        while !stop.load(Ordering::Relaxed) {
            match event::poll(Duration::from_millis(50)) {
                Ok(true) => {
                    let msg = match event::read() {
                        Ok(Event::Key(key)) => Msg::Key(key),
                        Ok(Event::Mouse(mouse)) => Msg::Mouse(mouse),
                        Ok(Event::Resize(..)) => Msg::Resize,
                        Ok(_) => continue,
                        Err(_) => break,
                    };
                    if tx.send(msg).is_err() {
                        break;
                    }
                }
                Ok(false) => {}
                Err(_) => break,
            }
        }
    })
}

struct Runtime<'a> {
    ctx: &'a Context,
    root: PathBuf,
    options: ScanOptions,
    tx: Sender<Msg>,
    scan_cancel: Option<Cancel>,
    /// Numbers scans, so events of a superseded one can be told apart.
    scan_generation: u64,
    clean_cancel: Option<Cancel>,
    jobs: HashMap<u64, pty::PtyJob>,
    next_job: u64,
    pty_size: (u16, u16),
    checker: Arc<Checker>,
}

impl Runtime<'_> {
    fn cancel_all(&mut self) {
        for cancel in [self.scan_cancel.take(), self.clean_cancel.take()]
            .into_iter()
            .flatten()
        {
            cancel.cancel();
        }
        for (_, job) in self.jobs.drain() {
            job.kill();
        }
    }

    /// Runs `task` on a new terminal; its output streams into the Tasks tab.
    fn start_job(&mut self, label: String, task: Task, size: (u16, u16), after: tasks::After) {
        let id = self.next_job;
        self.next_job += 1;
        let _ = self.tx.send(Msg::JobStarted {
            id,
            label,
            task: task.clone(),
            after,
        });
        match pty::spawn(id, &task, size, self.tx.clone()) {
            Ok(job) => {
                self.jobs.insert(id, job);
            }
            Err(error) => {
                let _ = self.tx.send(Msg::JobExited(id, Err(error)));
            }
        }
    }

    /// Keeps every job's terminal the size of the output pane.
    fn resize_jobs(&mut self, size: (u16, u16)) {
        if size != self.pty_size {
            self.pty_size = size;
            for job in self.jobs.values() {
                job.resize(size);
            }
        }
    }

    fn execute(&mut self, effect: Effect) {
        match effect {
            Effect::Scan => {
                if let Some(previous) = self.scan_cancel.take() {
                    previous.cancel();
                }
                let cancel = Cancel::new();
                self.scan_cancel = Some(cancel.clone());
                let counters = Arc::new(Counters::default());
                self.scan_generation += 1;
                let generation = self.scan_generation;
                let _ = self.tx.send(Msg::ScanStarted(generation, counters.clone()));
                let engine = self.ctx.engine.clone();
                let (root, options, tx) =
                    (self.root.clone(), self.options.clone(), self.tx.clone());
                std::thread::spawn(move || {
                    engine.scan(&root, &options, &counters, &cancel, &|event| {
                        let _ = tx.send(Msg::Scan(generation, event));
                    });
                });
            }
            Effect::CompletePath(input) => {
                let (base, tx) = (self.root.clone(), self.tx.clone());
                std::thread::spawn(move || {
                    let home = carwash_core::paths::home();
                    let candidates = folder::complete_dirs(&input, &base, home.as_deref());
                    let _ = tx.send(Msg::PathCompletions { input, candidates });
                });
            }
            Effect::ChangeRoot(raw) => {
                let home = carwash_core::paths::home();
                let path = folder::resolve(&raw, &self.root, home.as_deref());
                let walk = crate::cli::WalkArgs::for_path(path);
                let result = match self.ctx.scan_options(&walk, true, true) {
                    Ok((root, options)) => {
                        if let Some(cancel) = self.scan_cancel.take() {
                            cancel.cancel();
                        }
                        self.root = root.clone();
                        self.options = options;
                        Ok(root)
                    }
                    Err(error) => Err(format!("{error:#}")),
                };
                let _ = self.tx.send(Msg::RootChanged(result));
            }
            Effect::CancelScan => {
                if let Some(cancel) = self.scan_cancel.take() {
                    cancel.cancel();
                }
            }
            Effect::Clean {
                items,
                mode,
                allowed_roots,
            } => {
                let cancel = Cancel::new();
                self.clean_cancel = Some(cancel.clone());
                let engine = self.ctx.engine.clone();
                let tx = self.tx.clone();
                std::thread::spawn(move || {
                    let options = CleanOptions {
                        mode,
                        allowed_roots,
                        dry_run: false,
                    };
                    let report = engine.clean(&items, &options, &cancel, &|event| {
                        let _ = tx.send(Msg::Clean(event));
                    });
                    let _ = tx.send(Msg::CleanFinished(report));
                });
            }
            Effect::CancelClean => {
                if let Some(cancel) = self.clean_cancel.take() {
                    cancel.cancel();
                }
            }
            Effect::RecordHistory(records) => {
                if let Some(dirs) = &self.ctx.dirs
                    && let Err(error) = history::append(&dirs.history_file(), &records)
                {
                    tracing::warn!(%error, "cannot write history");
                }
            }
            Effect::Reveal(path) => reveal(&path),
            Effect::DiscoverTasks { path, ecosystems } => {
                let (registry, tx) = (self.ctx.engine.registry().clone(), self.tx.clone());
                std::thread::spawn(move || {
                    let tasks = carwash_core::tasks::discover(&path, &ecosystems, &registry);
                    let _ = tx.send(Msg::TasksDiscovered(path, tasks));
                });
            }
            Effect::RunTask {
                name,
                targets,
                size,
            } => {
                let registry = self.ctx.engine.registry().clone();
                for target in targets {
                    let Some(task) =
                        carwash_core::tasks::discover(&target.path, &target.ecosystems, &registry)
                            .into_iter()
                            .find(|t| t.name == name)
                    else {
                        continue;
                    };
                    self.start_job(target.label, task, size, tasks::After::Nothing);
                }
            }
            Effect::CheckDeps { specs, refresh } => {
                let (checker, registry, tx) = (
                    self.checker.clone(),
                    self.ctx.engine.registry().clone(),
                    self.tx.clone(),
                );
                let vulnerabilities = self.ctx.config.updates.vulnerabilities;
                std::thread::spawn(move || {
                    let progress = Arc::new(carwash_core::deps::CheckProgress::default());
                    let _ = tx.send(Msg::DepsProgress(progress.clone()));
                    let results =
                        checker.check(&specs, &registry, vulnerabilities, refresh, &progress);
                    if let Err(error) = checker.save() {
                        tracing::warn!(%error, "cannot save dependency cache");
                    }
                    let _ = tx.send(Msg::DepsChecked(results));
                });
            }
            Effect::ApplyUpdates {
                dir,
                label,
                deps,
                latest,
                size,
            } => {
                let refs: Vec<&carwash_core::deps::Dependency> = deps.iter().collect();
                match carwash_core::deps::update_tasks(&dir, &refs, latest) {
                    Ok(tasks) => {
                        for task in tasks {
                            self.start_job(
                                label.clone(),
                                task,
                                size,
                                tasks::After::Recheck(dir.clone()),
                            );
                        }
                    }
                    Err(error) => {
                        let _ = self.tx.send(Msg::UpdateFailed(
                            dir,
                            format!("Cannot update {label}: {error}"),
                        ));
                    }
                }
            }
            Effect::DiscoverCaches => {
                // Fingerprinting reads the top of each cache: keep it off the event loop.
                let (dirs, tx) = (self.ctx.dirs.clone(), self.tx.clone());
                std::thread::spawn(move || {
                    let caches =
                        crate::commands::caches::present(dirs.as_ref()).unwrap_or_else(|error| {
                            tracing::warn!(%error, "cannot list caches");
                            Vec::new()
                        });
                    let _ = tx.send(Msg::CachesDiscovered(caches));
                });
            }
            Effect::MeasureCaches(targets) => {
                let (engine, tx) = (self.ctx.engine.clone(), self.tx.clone());
                std::thread::spawn(move || {
                    for (id, path) in targets {
                        let _ = tx.send(measure_cache(&engine, id, &path));
                    }
                });
            }
            Effect::SaveSizes(sizes) => {
                if let Some(dirs) = &self.ctx.dirs {
                    let mut sizes = sizes;
                    if let Err(error) = sizes.save(&dirs.size_cache_file()) {
                        tracing::warn!(%error, "cannot save size cache");
                    }
                }
            }
            Effect::CleanCaches { caches, size } => {
                for cache in caches {
                    if let Some(task) = cache.prune_task() {
                        let after = tasks::After::Remeasure {
                            id: cache.id.clone(),
                            path: cache.path.clone(),
                        };
                        self.start_job(cache.name.clone(), task, size, after);
                        continue;
                    }
                    let (engine, tx) = (self.ctx.engine.clone(), self.tx.clone());
                    let history = self.ctx.dirs.as_ref().map(|d| d.history_file());
                    std::thread::spawn(move || {
                        let before = cache.size.map_or(0, |s| s.on_disk);
                        if cache.deletable
                            && let Some(parent) = cache.path.parent()
                        {
                            let report = engine.clean(
                                &[carwash_core::clean::CleanItem {
                                    id: carwash_core::ArtifactId(0),
                                    path: cache.path.clone(),
                                    expected_bytes: before,
                                }],
                                &CleanOptions {
                                    mode: carwash_core::clean::DeleteMode::Permanent,
                                    allowed_roots: vec![parent.to_path_buf()],
                                    dry_run: false,
                                },
                                &Cancel::new(),
                                &|_| {},
                            );
                            if report.removed == 1
                                && let Some(file) = history
                            {
                                let record = carwash_core::history::Record::now(
                                    cache.path.clone(),
                                    before,
                                    carwash_core::ArtifactKind::Cache,
                                    cache.ecosystem.clone(),
                                    carwash_core::clean::DeleteMode::Permanent,
                                );
                                let _ = history::append(&file, &[record]);
                            }
                        }
                        let _ = tx.send(measure_cache(&engine, cache.id, &cache.path));
                    });
                }
            }
            Effect::KillJob(id) => {
                if let Some(job) = self.jobs.remove(&id) {
                    job.kill();
                }
            }
            Effect::RefreshDisk => {
                let (root, tx) = (self.root.clone(), self.tx.clone());
                std::thread::spawn(move || {
                    if let (Ok(free), Ok(total)) =
                        (fs4::available_space(&root), fs4::total_space(&root))
                    {
                        let _ = tx.send(Msg::Disk { free, total });
                    }
                });
            }
        }
    }
}

/// Shows `path` in the platform file manager, detached from the terminal.
/// Fingerprints then measures one global cache (a missing directory measures as empty).
fn measure_cache(engine: &carwash_core::Engine, id: String, path: &Path) -> Msg {
    let fingerprint = carwash_core::cache::Fingerprint::of(path);
    let size = if path.exists() {
        engine.measure_path(path, &Cancel::new())
    } else {
        carwash_core::Size::default()
    };
    Msg::CacheMeasured {
        id,
        size,
        fingerprint,
    }
}

fn reveal(path: &Path) {
    use std::process::{Command, Stdio};
    let mut command = if cfg!(target_os = "macos") {
        let mut c = Command::new("open");
        c.arg("-R").arg(path);
        c
    } else if cfg!(windows) {
        let mut c = Command::new("explorer");
        c.arg(format!("/select,{}", path.display()));
        c
    } else {
        let mut c = Command::new("xdg-open");
        c.arg(path.parent().unwrap_or(path));
        c
    };
    let _ = command
        .stdin(Stdio::null())
        .stdout(Stdio::null())
        .stderr(Stdio::null())
        .spawn();
}