Skip to main content

videre_core/
pipeline_runs.rs

1//! Per-command pipeline run history and liveness, surfaced by `videre stats`
2//! and other dashboard-style callers.
3//! See docs/superpowers/specs/2026-07-31-dashboard-stats-pass-b-design.md
4//! for the full design, and in particular why `track_in()` below does not rely
5//! on Drop/RAII for the success/failure bookkeeping: the library-scoped command
6//! lock's release does, backstopped by the OS releasing `flock` on any process
7//! death.
8
9use anyhow::{Context, Result};
10use rusqlite::{params, Connection, OptionalExtension};
11use serde::Serialize;
12
13/// The eight commands tracked so far. Extended with `locations` on
14/// 2026-08-01 (was seven after `prune`'s addition earlier the same day).
15/// It's a clean fit for the same one-shot start/finish model the others
16/// use: `videre locations` is a full-recompute batch pass, not an
17/// interactive per-query command. `gallery`, `search`, `mcp`, and `config`
18/// remain deliberately excluded: `report --faces`/`--show-faces` and `mcp`
19/// are long-running servers with no natural "finished" moment (the same
20/// reason `videre watch` itself is excluded. See below), `search` is an
21/// interactive per-query command rather than a library-processing pipeline
22/// stage (true even for its new `--location` mode, which is a single query
23/// like any other `search` invocation, not a batch job), and `config` is a
24/// trivial instant read/write with nothing meaningful to time. Revisit only
25/// if a real driver for tracking one of those emerges. See TECH_DEBT.md.
26///
27/// `videre watch` itself is deliberately not in this list, it has no
28/// "finished" moment during normal operation, so it gets its own liveness
29/// lock (see `watch_lock_path`) but no `pipeline_runs` row.
30pub const TRACKED_COMMANDS: [&str; 8] = [
31    "scan",
32    "faces",
33    "embed",
34    "classify",
35    "dedupe",
36    "fix-dates",
37    "prune",
38    "locations",
39];
40
41pub fn ensure_pipeline_runs_table(conn: &Connection) -> rusqlite::Result<()> {
42    conn.execute_batch(
43        "CREATE TABLE IF NOT EXISTS pipeline_runs (
44            command      TEXT PRIMARY KEY,
45            started_at   TEXT NOT NULL,
46            finished_at  TEXT,
47            status       TEXT NOT NULL,
48            duration_ms  INTEGER,
49            summary      TEXT
50        );",
51    )
52}
53
54pub fn start_run(conn: &Connection, command: &str) -> rusqlite::Result<()> {
55    conn.execute(
56        "INSERT INTO pipeline_runs (command, started_at, status)
57         VALUES (?1, datetime('now'), 'running')
58         ON CONFLICT(command) DO UPDATE SET
59             started_at = excluded.started_at,
60             status = 'running',
61             finished_at = NULL,
62             duration_ms = NULL,
63             summary = NULL",
64        params![command],
65    )?;
66    Ok(())
67}
68
69pub fn finish_run(
70    conn: &Connection,
71    command: &str,
72    status: &str,
73    duration_ms: i64,
74    summary: Option<&str>,
75) -> rusqlite::Result<()> {
76    conn.execute(
77        "UPDATE pipeline_runs SET
78             finished_at = datetime('now'),
79             status = ?2,
80             duration_ms = ?3,
81             summary = ?4
82         WHERE command = ?1",
83        params![command, status, duration_ms, summary],
84    )?;
85    Ok(())
86}
87
88/// Wraps `f` with pipeline-run bookkeeping for a command whose per-command
89/// lock is already held as a
90/// [`library_locks::CommandGuard`](crate::library_locks::CommandGuard).
91///
92/// The guard is verified rather than trusted: it must have been taken for
93/// exactly `ctx` and `command`, because a mismatched pairing would record
94/// one library's run against another (or one command's row against another
95/// command's) with nothing visibly wrong. The model is `start_run` before
96/// `f`, `success`/`failed` (with the error message) after, all before
97/// returning. It never reacquires the supplied guard, so converting a command
98/// to the library-scoped locks cannot double-lock.
99pub fn track_in<T, F>(
100    conn: &Connection,
101    ctx: &crate::library::LibraryContext,
102    guard: &crate::library_locks::CommandGuard,
103    command: &str,
104    f: F,
105) -> Result<T>
106where
107    F: FnOnce() -> Result<T>,
108{
109    track_in_as(conn, ctx, guard, command, command, f)
110}
111
112/// Like [`track_in`], but the recorded label may differ from the command the
113/// guard was taken for. Watch's location stage shares the `locations` command
114/// lock with the standalone clustering recompute (so the two cannot overlap
115/// on SQLite's single writer) while writing its own `location-names` row.
116/// The guard is still verified to belong to this library and to the command
117/// it was actually taken for, so a mismatched guard is refused exactly as
118/// `track_in` refuses one; only the row's name comes from `label`.
119pub fn track_in_as<T, F>(
120    conn: &Connection,
121    ctx: &crate::library::LibraryContext,
122    guard: &crate::library_locks::CommandGuard,
123    lock_command: &str,
124    label: &str,
125    f: F,
126) -> Result<T>
127where
128    F: FnOnce() -> Result<T>,
129{
130    guard.ensure_matches(ctx, lock_command)?;
131    // The guard's match is a wiring check on path strings; this rechecks that
132    // the root still names the same library before any run row is written, so
133    // a root swapped out between guard acquisition and now is refused rather
134    // than recorded against whatever now sits at the path.
135    ctx.ensure_root_identity()?;
136    ensure_pipeline_runs_table(conn)?;
137    start_run(conn, label)?;
138    let started = std::time::Instant::now();
139    let result = f();
140    let duration_ms = started.elapsed().as_millis().min(i64::MAX as u128) as i64;
141    match result {
142        Ok(value) => {
143            finish_run(conn, label, "success", duration_ms, None)?;
144            Ok(value)
145        }
146        Err(error) => {
147            // Record the failure, but never let a bookkeeping error mask the
148            // real one: the original error is what the caller acted on.
149            if let Err(record_error) =
150                finish_run(conn, label, "failed", duration_ms, Some(&error.to_string()))
151            {
152                return Err(error.context(format!(
153                    "also could not record the failed run: {record_error}"
154                )));
155            }
156            Err(error)
157        }
158    }
159}
160
161/// Records that a recurring command (`watch`) completed one cycle. Unlike a
162/// start/stop run, the heartbeat is the whole record: `started_at` is the
163/// moment of the last successful cycle, and there is no duration to keep. A
164/// watcher that dies mid-cycle leaves the previous cycle's heartbeat, so a
165/// dead watcher reads as a stale last-cycle time, never as a fake crash.
166pub fn record_heartbeat_in(
167    conn: &Connection,
168    ctx: &crate::library::LibraryContext,
169    command: &str,
170) -> Result<()> {
171    // Same identity check as `track_in`: a root swapped between the cycle's
172    // start and now must not have its cycle recorded against another library.
173    ctx.ensure_root_identity()?;
174    ensure_pipeline_runs_table(conn)?;
175    conn.execute(
176        "INSERT INTO pipeline_runs (command, started_at, status, summary)
177         VALUES (?1, datetime('now'), 'success', 'last successful cycle')
178         ON CONFLICT(command) DO UPDATE SET
179             started_at = excluded.started_at,
180             status = 'success',
181             finished_at = NULL,
182             duration_ms = NULL,
183             summary = excluded.summary",
184        params![command],
185    )?;
186    Ok(())
187}
188
189/// Every tracked command's last run and current liveness. Liveness is probed
190/// through the library's own lock files (`library_locks::command_locked`), so a
191/// library-scoped command shows up as running exactly when a library-scoped
192/// reader asks; a `running` row whose lock no live process holds reads back as
193/// `crashed`.
194pub fn read_all_in(
195    conn: &Connection,
196    ctx: &crate::library::LibraryContext,
197) -> Result<Vec<PipelineRunStatus>> {
198    ensure_pipeline_runs_table(conn)?;
199    let mut out = Vec::with_capacity(TRACKED_COMMANDS.len());
200    for command in TRACKED_COMMANDS {
201        out.push(read_one_in(conn, ctx, command)?);
202    }
203    // `watch` is deliberately absent from TRACKED_COMMANDS: it is a recurring
204    // loop, not a start/stop run, so it never takes the per-command run-row
205    // machinery. Its heartbeat (see `record_heartbeat_in`) makes it reportable
206    // all the same; it appears here only once a heartbeat exists, so a library
207    // never watched is not lectured about a stage it never started.
208    if conn
209        .query_row(
210            "SELECT 1 FROM pipeline_runs WHERE command = 'watch'",
211            [],
212            |r| r.get::<_, i64>(0),
213        )
214        .optional()?
215        .is_some()
216    {
217        out.push(read_one_in(conn, ctx, "watch")?);
218    }
219    // `location-names` is watch's incremental reverse-geocoding stage, on the
220    // same only-once-a-row-exists rule as the heartbeat: a library that never
221    // watched with --location is not lectured about it. It is deliberately
222    // distinct from `locations`, whose row means the standalone clustering
223    // recompute, and deliberately not called `geocode`, which in this codebase
224    // means forward geocoding (see `videre_core::geocode`).
225    if conn
226        .query_row(
227            "SELECT 1 FROM pipeline_runs WHERE command = 'location-names'",
228            [],
229            |r| r.get::<_, i64>(0),
230        )
231        .optional()?
232        .is_some()
233    {
234        out.push(read_one_in(conn, ctx, "location-names")?);
235    }
236    Ok(out)
237}
238
239/// One command's row plus lock-derived liveness. Shared by the tracked loop
240/// and the watch heartbeat read, which need identical semantics.
241///
242/// The `locations` row is the one special case: its lock is shared with
243/// watch's location-names stage, which holds both locks while it runs, so a
244/// recompute is active exactly when the shared lock is held and the stage's
245/// own lock is not. Every other command's liveness is its own lock.
246fn read_one_in(
247    conn: &Connection,
248    ctx: &crate::library::LibraryContext,
249    command: &str,
250) -> Result<PipelineRunStatus> {
251    let row: Option<(String, Option<i64>, String)> = conn
252        .query_row(
253            "SELECT started_at, duration_ms, status FROM pipeline_runs WHERE command = ?1",
254            params![command],
255            |r| Ok((r.get(0)?, r.get(1)?, r.get(2)?)),
256        )
257        .optional()?;
258    let currently_running = match command {
259        "locations" => {
260            crate::library_locks::command_locked(ctx, "locations")?
261                && !crate::library_locks::command_locked(ctx, "location-names")?
262        }
263        other => crate::library_locks::command_locked(ctx, other)?,
264    };
265    let (last_run_at, status, duration_ms) = match row {
266        None => (None, None, None),
267        Some((started_at, duration_ms, stored_status)) => {
268            let status = if stored_status == "running" && !currently_running {
269                "crashed".to_string()
270            } else {
271                stored_status
272            };
273            (Some(started_at), Some(status), duration_ms)
274        }
275    };
276    Ok(PipelineRunStatus {
277        command: command.to_string(),
278        last_run_at,
279        status,
280        duration_ms,
281        currently_running,
282    })
283}
284
285/// Install a SIGINT handler that marks `command`'s row `interrupted` and exits
286/// 130, against the library the context pins.
287///
288/// The library's identity is validated before the handler is installed (and
289/// again inside it): a handler bound to a root that no longer names its
290/// library would write another library's database on the way out. The
291/// handler's connection opens without `CREATE`, so an exiting process can
292/// never conjure a database that initialization is responsible for. Same
293/// best-effort contract as the global version: errors inside the handler
294/// are swallowed, there is no useful way to report them once the process is
295/// already exiting on a signal.
296/// A `videre pipeline` runs several tracked stages in one process, but the
297/// `ctrlc` crate permits exactly one handler per process. So the handler is
298/// installed once and then retargeted: each stage records the command it is
299/// running, and the single handler marks whichever command is current when the
300/// signal arrives. Re-installing is a silent no-op rather than the "already
301/// registered" error every stage after the first used to raise.
302static SIGINT_INSTALLED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
303static SIGINT_COMMAND: std::sync::Mutex<Option<&'static str>> = std::sync::Mutex::new(None);
304
305pub fn install_sigint_handler_in(
306    ctx: std::sync::Arc<crate::library::LibraryContext>,
307    command: &'static str,
308) -> Result<()> {
309    ctx.ensure_root_identity()
310        .context("validating the library before installing the SIGINT handler")?;
311    // Point the single, process-wide handler at the stage now running.
312    if let Ok(mut current) = SIGINT_COMMAND.lock() {
313        *current = Some(command);
314    }
315    // Later stages in the same process only retarget the handler above; one
316    // handler per process is all `ctrlc` allows.
317    if SIGINT_INSTALLED.load(std::sync::atomic::Ordering::SeqCst) {
318        return Ok(());
319    }
320    ctrlc::set_handler(move || {
321        let command = SIGINT_COMMAND
322            .lock()
323            .ok()
324            .and_then(|c| *c)
325            .unwrap_or(command);
326        if ctx.ensure_root_identity().is_ok() {
327            if let Ok(conn) = crate::library_db::open_without_create(&ctx.paths.db) {
328                let _ = conn.busy_timeout(std::time::Duration::from_secs(5));
329                let started_at: Option<String> = conn
330                    .query_row(
331                        "SELECT started_at FROM pipeline_runs WHERE command = ?1",
332                        params![command],
333                        |r| r.get(0),
334                    )
335                    .optional()
336                    .ok()
337                    .flatten();
338                let duration_ms = started_at
339                    .and_then(|s| {
340                        chrono::NaiveDateTime::parse_from_str(&s, "%Y-%m-%d %H:%M:%S").ok()
341                    })
342                    .map(|started| {
343                        (chrono::Utc::now().naive_utc() - started)
344                            .num_milliseconds()
345                            .max(0)
346                    })
347                    .unwrap_or(0);
348                let _ = finish_run(&conn, command, "interrupted", duration_ms, None);
349            }
350        }
351        std::process::exit(130);
352    })
353    .context("installing SIGINT handler")?;
354    SIGINT_INSTALLED.store(true, std::sync::atomic::Ordering::SeqCst);
355    Ok(())
356}
357
358#[derive(Debug, Clone, PartialEq, Serialize)]
359pub struct PipelineRunStatus {
360    pub command: String,
361    pub last_run_at: Option<String>,
362    /// "running" | "success" | "failed" | "interrupted" | "crashed" | None if never run.
363    /// "crashed" is computed here, never a stored value. See the design doc.
364    pub status: Option<String>,
365    pub duration_ms: Option<i64>,
366    pub currently_running: bool,
367}
368
369#[cfg(test)]
370mod tests {
371    use super::*;
372
373    fn test_db() -> Connection {
374        let conn = Connection::open_in_memory().unwrap();
375        ensure_pipeline_runs_table(&conn).unwrap();
376        conn
377    }
378
379    #[test]
380    fn heartbeat_records_last_cycle_and_reads_back() {
381        let (_t, ctx, conn) = in_library();
382        // A fresh library has never run watch: no row, no liveness time.
383        assert!(read_all_in(&conn, &ctx)
384            .unwrap()
385            .iter()
386            .all(|r| r.command != "watch"));
387        record_heartbeat_in(&conn, &ctx, "watch").unwrap();
388        let w = read_all_in(&conn, &ctx)
389            .unwrap()
390            .into_iter()
391            .find(|r| r.command == "watch")
392            .expect("the heartbeat row must surface in the run read");
393        assert!(w.last_run_at.is_some(), "started_at is the last-cycle time");
394        assert_eq!(w.status.as_deref(), Some("success"));
395        assert!(!w.currently_running, "no watch process holds the lock");
396
397        // A second heartbeat is an update of the same row, not an error or a
398        // second entry: recurring commands have exactly one now.
399        record_heartbeat_in(&conn, &ctx, "watch").unwrap();
400        assert_eq!(
401            read_all_in(&conn, &ctx)
402                .unwrap()
403                .iter()
404                .filter(|r| r.command == "watch")
405                .count(),
406            1
407        );
408    }
409
410    #[test]
411    fn ensure_pipeline_runs_table_is_idempotent() {
412        let conn = test_db();
413        ensure_pipeline_runs_table(&conn).unwrap();
414    }
415
416    #[test]
417    fn start_run_then_finish_run_records_success() {
418        let conn = test_db();
419        start_run(&conn, "embed").unwrap();
420
421        let status: String = conn
422            .query_row(
423                "SELECT status FROM pipeline_runs WHERE command = 'embed'",
424                [],
425                |r| r.get(0),
426            )
427            .unwrap();
428        assert_eq!(status, "running");
429
430        finish_run(&conn, "embed", "success", 1234, None).unwrap();
431
432        let (status, duration_ms, summary): (String, i64, Option<String>) = conn
433            .query_row(
434                "SELECT status, duration_ms, summary FROM pipeline_runs WHERE command = 'embed'",
435                [],
436                |r| Ok((r.get(0)?, r.get(1)?, r.get(2)?)),
437            )
438            .unwrap();
439        assert_eq!(status, "success");
440        assert_eq!(duration_ms, 1234);
441        assert_eq!(summary, None);
442    }
443
444    #[test]
445    fn start_run_upserts_resetting_prior_finish_fields() {
446        let conn = test_db();
447        start_run(&conn, "embed").unwrap();
448        finish_run(&conn, "embed", "failed", 500, Some("boom")).unwrap();
449
450        start_run(&conn, "embed").unwrap(); // second run begins
451
452        let (status, duration_ms, summary): (String, Option<i64>, Option<String>) = conn
453            .query_row(
454                "SELECT status, duration_ms, summary FROM pipeline_runs WHERE command = 'embed'",
455                [],
456                |r| Ok((r.get(0)?, r.get(1)?, r.get(2)?)),
457            )
458            .unwrap();
459        assert_eq!(status, "running");
460        assert_eq!(duration_ms, None);
461        assert_eq!(summary, None);
462
463        let count: i64 = conn
464            .query_row("SELECT COUNT(*) FROM pipeline_runs", [], |r| r.get(0))
465            .unwrap();
466        assert_eq!(count, 1, "upsert, not a second row");
467    }
468
469    /// One library with its state and locks directories in place, plus a
470    /// connection with the runs table: the minimum the library-scoped
471    /// bookkeeping needs, without pulling the database layer's
472    /// initialization in. Locks only need the directories to exist.
473    fn in_library() -> (
474        tempfile::TempDir,
475        crate::library::LibraryContext,
476        Connection,
477    ) {
478        let temp = tempfile::tempdir().unwrap();
479        let root = temp.path().join("photos");
480        std::fs::create_dir(&root).unwrap();
481        let ctx = crate::library::LibraryContext::new(&root, &temp.path().join("cache")).unwrap();
482        std::fs::create_dir_all(&ctx.paths.locks).unwrap();
483        let conn = Connection::open_in_memory().unwrap();
484        ensure_pipeline_runs_table(&conn).unwrap();
485        (temp, ctx, conn)
486    }
487
488    #[test]
489    fn track_in_records_runs_under_an_already_held_command_guard() {
490        let (_t, ctx, conn) = in_library();
491        let guard = crate::library_locks::try_command(&ctx, "scan").unwrap();
492        let result = track_in(&conn, &ctx, &guard, "scan", || Ok(7)).unwrap();
493        assert_eq!(result, 7);
494        let (status, summary): (String, Option<String>) = conn
495            .query_row(
496                "SELECT status, summary FROM pipeline_runs WHERE command = 'scan'",
497                [],
498                |r| Ok((r.get(0)?, r.get(1)?)),
499            )
500            .unwrap();
501        assert_eq!(status, "success");
502        assert_eq!(summary, None);
503        // The other commands' rows are untouched: one command's bookkeeping
504        // never overwrites another's.
505        let count: i64 = conn
506            .query_row("SELECT COUNT(*) FROM pipeline_runs", [], |r| r.get(0))
507            .unwrap();
508        assert_eq!(count, 1);
509        let failed: Result<()> =
510            track_in(&conn, &ctx, &guard, "scan", || Err(anyhow::anyhow!("boom")));
511        failed.unwrap_err();
512        let (status, summary): (String, Option<String>) = conn
513            .query_row(
514                "SELECT status, summary FROM pipeline_runs WHERE command = 'scan'",
515                [],
516                |r| Ok((r.get(0)?, r.get(1)?)),
517            )
518            .unwrap();
519        assert_eq!(status, "failed");
520        assert_eq!(summary.as_deref(), Some("boom"));
521    }
522
523    #[test]
524    fn track_in_refuses_a_guard_from_another_command_or_library() {
525        let (_t, ctx, conn) = in_library();
526        let guard = crate::library_locks::try_command(&ctx, "scan").unwrap();
527        // A guard held for scan must not bookkeep embed's row.
528        let result: Result<()> = track_in(&conn, &ctx, &guard, "embed", || Ok(()));
529        let err = result.unwrap_err();
530        assert!(format!("{err:#}").contains("scan"), "{err:#}");
531        let count: i64 = conn
532            .query_row("SELECT COUNT(*) FROM pipeline_runs", [], |r| r.get(0))
533            .unwrap();
534        assert_eq!(count, 0, "a refused guard must write no row");
535
536        // Nor may one library's guard bookkeep another library's run, even
537        // under the same command name.
538        let temp = tempfile::tempdir().unwrap();
539        let other_root = temp.path().join("other");
540        std::fs::create_dir(&other_root).unwrap();
541        let other =
542            crate::library::LibraryContext::new(&other_root, &temp.path().join("cache")).unwrap();
543        let result: Result<()> = track_in(&conn, &other, &guard, "scan", || Ok(()));
544        let err = result.unwrap_err();
545        assert!(
546            format!("{err:#}").contains(other_root.file_name().unwrap().to_string_lossy().as_ref()),
547            "{err:#}"
548        );
549        let count: i64 = conn
550            .query_row("SELECT COUNT(*) FROM pipeline_runs", [], |r| r.get(0))
551            .unwrap();
552        assert_eq!(count, 0);
553    }
554
555    #[test]
556    fn read_all_in_answers_liveness_from_the_library_locks() {
557        let (_t, ctx, conn) = in_library();
558        let guard = crate::library_locks::try_command(&ctx, "scan").unwrap();
559        track_in(&conn, &ctx, &guard, "scan", || Ok(())).unwrap();
560        // Released: the finished run is not running.
561        drop(guard);
562        // A held command lock shows up as running to a library-scoped
563        // reader, with no row of its own: the probe is what says live, not
564        // the presence of a row.
565        let _faces = crate::library_locks::try_command(&ctx, "faces").unwrap();
566        let statuses = read_all_in(&conn, &ctx).unwrap();
567        let scan = statuses.iter().find(|s| s.command == "scan").unwrap();
568        assert_eq!(scan.status.as_deref(), Some("success"));
569        assert!(!scan.currently_running);
570        let faces = statuses.iter().find(|s| s.command == "faces").unwrap();
571        assert_eq!(faces.status, None);
572        assert!(faces.currently_running);
573    }
574
575    #[test]
576    fn location_names_stage_surfaces_only_once_a_row_exists() {
577        let (_t, ctx, conn) = in_library();
578        // A library never watched with --location has no location-names row:
579        // the read must not lecture about a stage it never ran (same rule as
580        // the watch heartbeat above).
581        assert!(read_all_in(&conn, &ctx)
582            .unwrap()
583            .iter()
584            .all(|r| r.command != "location-names"));
585        // One watch cycle writes the row; from then on the stage reports
586        // like any tracked command.
587        start_run(&conn, "location-names").unwrap();
588        finish_run(&conn, "location-names", "success", 5, None).unwrap();
589        let names = read_all_in(&conn, &ctx)
590            .unwrap()
591            .into_iter()
592            .find(|r| r.command == "location-names")
593            .expect("a written location-names row must surface in the run read");
594        assert_eq!(names.status.as_deref(), Some("success"));
595        assert!(!names.currently_running);
596    }
597
598    #[test]
599    fn a_running_location_names_stage_reads_running_not_crashed() {
600        // The stage holds BOTH locks while it runs: `locations` for
601        // coordination with the standalone recompute, and its own
602        // `location-names` lock as its identity. A healthy cycle therefore
603        // reads as running and active on both rows' behalf, never crashed,
604        // and `status --check` cannot fail during normal operation.
605        let (_t, ctx, conn) = in_library();
606        let guard = crate::library_locks::try_command(&ctx, "locations").unwrap();
607        let names_guard = crate::library_locks::try_command(&ctx, "location-names").unwrap();
608        start_run(&conn, "location-names").unwrap();
609
610        let names = read_all_in(&conn, &ctx)
611            .unwrap()
612            .into_iter()
613            .find(|r| r.command == "location-names")
614            .expect("a started location-names row must surface");
615        assert_eq!(
616            names.status.as_deref(),
617            Some("running"),
618            "an actively running stage is running, not crashed"
619        );
620        assert!(names.currently_running);
621        // The lock's holder is the location-names stage, so the locations
622        // entry must not claim a recompute is running on the strength of the
623        // shared lock alone.
624        let locations = read_all_in(&conn, &ctx)
625            .unwrap()
626            .into_iter()
627            .find(|r| r.command == "locations")
628            .unwrap();
629        assert!(!locations.currently_running);
630
631        // Once the stage is gone without finishing, the stale running row
632        // reads back as exactly what it is.
633        drop(guard);
634        drop(names_guard);
635        let names = read_all_in(&conn, &ctx)
636            .unwrap()
637            .into_iter()
638            .find(|r| r.command == "location-names")
639            .unwrap();
640        assert_eq!(names.status.as_deref(), Some("crashed"));
641    }
642
643    #[test]
644    fn a_stale_names_row_does_not_mask_a_running_recompute() {
645        // Watch died mid-stage: the location-names row is left "running"
646        // while the OS released both locks. A standalone recompute then
647        // starts and takes the locations lock. The stale row must read as
648        // crashed, and the live recompute must keep its running report: the
649        // stage's own lock being free is what proves the holder is the
650        // recompute, not the stage.
651        let (_t, ctx, conn) = in_library();
652        start_run(&conn, "location-names").unwrap();
653
654        let guard = crate::library_locks::try_command(&ctx, "locations").unwrap();
655        start_run(&conn, "locations").unwrap();
656
657        let statuses = read_all_in(&conn, &ctx).unwrap();
658        let names = statuses
659            .iter()
660            .find(|r| r.command == "location-names")
661            .unwrap();
662        assert_eq!(
663            names.status.as_deref(),
664            Some("crashed"),
665            "a stale row must not borrow the recompute's lock liveness"
666        );
667        let locations = statuses.iter().find(|r| r.command == "locations").unwrap();
668        assert_eq!(locations.status.as_deref(), Some("running"));
669        assert!(
670            locations.currently_running,
671            "the recompute is the real live holder and must be reported as such"
672        );
673        drop(guard);
674    }
675
676    #[test]
677    fn track_in_as_records_a_label_under_another_commands_guard() {
678        // Watch's location stage shares the `locations` command lock with the
679        // standalone recompute while writing its own `location-names` row:
680        // the guard is verified against the command it was taken for, and the
681        // label is what lands in the table.
682        let (_t, ctx, conn) = in_library();
683        let guard = crate::library_locks::try_command(&ctx, "locations").unwrap();
684        track_in_as(
685            &conn,
686            &ctx,
687            &guard,
688            "locations",
689            "location-names",
690            || Ok(()),
691        )
692        .unwrap();
693        let (command, status): (String, String) = conn
694            .query_row("SELECT command, status FROM pipeline_runs", [], |r| {
695                Ok((r.get(0)?, r.get(1)?))
696            })
697            .unwrap();
698        assert_eq!(command, "location-names");
699        assert_eq!(status, "success");
700
701        // A guard taken for a different command than the claimed lock is
702        // still refused, exactly as track_in refuses one.
703        let guard = crate::library_locks::try_command(&ctx, "scan").unwrap();
704        let result: Result<()> = track_in_as(
705            &conn,
706            &ctx,
707            &guard,
708            "locations",
709            "location-names",
710            || Ok(()),
711        );
712        assert!(
713            result.is_err(),
714            "a scan guard must not bookkeep under the locations lock"
715        );
716    }
717
718    #[test]
719    fn install_sigint_handler_in_validates_the_library_before_installing() {
720        // A context whose root was replaced after construction must be
721        // refused before any handler is installed, so this deliberately
722        // never reaches ctrlc::set_handler (only one handler can exist per
723        // process, and another test in this suite owns that slot).
724        let temp = tempfile::tempdir().unwrap();
725        let root = temp.path().join("photos");
726        std::fs::create_dir(&root).unwrap();
727        let ctx = std::sync::Arc::new(
728            crate::library::LibraryContext::new(&root, &temp.path().join("cache")).unwrap(),
729        );
730        std::fs::rename(&root, temp.path().join("moved")).unwrap();
731        std::fs::create_dir(&root).unwrap();
732        let err = install_sigint_handler_in(ctx, "scan").unwrap_err();
733        assert!(format!("{err:#}").contains("no longer names"), "{err:#}");
734    }
735
736    #[test]
737    fn install_sigint_handler_in_is_idempotent_within_a_process() {
738        // A pipeline installs the handler once and retargets it for each later
739        // stage, so a second install must succeed silently rather than raise
740        // "already registered" - the warning pipeline used to print between
741        // scan and faces.
742        let temp = tempfile::tempdir().unwrap();
743        let root = temp.path().join("photos");
744        std::fs::create_dir(&root).unwrap();
745        let ctx = std::sync::Arc::new(
746            crate::library::LibraryContext::new(&root, &temp.path().join("cache")).unwrap(),
747        );
748        install_sigint_handler_in(ctx.clone(), "scan").expect("first install");
749        install_sigint_handler_in(ctx, "faces")
750            .expect("a second install in the same process must be a no-op, not an error");
751    }
752}