onepipeline 0.38.0

//! The two commands a run fires once when it **ends**: a success hook when every
//! node settled `done`, and a failure hook when it ended any other way.
//!
//! `docs/contract.md`'s run-end hooks paragraph is the whole rule. What this file
//! adds is where each half of it lives: [`judge`] is the rule over a folded run,
//! [`at_let_go`] and [`at_stop`] are the only two moments it is asked, and `fire`
//! is the once-per-ending marker, the spawn, the wait and the record of how the
//! hook ended. Nothing here writes a node status, a result or a settlement, which
//! is what keeps a hook from changing any of them.
//!
//! The paragraph's idempotency **epoch** is two of those halves: [`fired`] holds
//! the marker against it, and [`live`] is the predicate the rule's "live again" is
//! measured by.

use std::collections::BTreeMap;
use std::io::{Read, Seek, SeekFrom, Write};
use std::num::NonZeroU64;
use std::path::{Path, PathBuf};
use std::process::Stdio;
use std::time::{Duration, Instant};

use serde::Serialize;
use serde_json::{json, Value};

use crate::cli::DEFAULT_HOOK_TIMEOUT_SECONDS;
use crate::error::Result;
use crate::graph::NodeStatus;
use crate::journal::{self, Journal, PipelineKind};
use crate::ledger::{self, LaunchRecord, RunPaths};
use crate::projection::RunState;
use crate::report;
use crate::sys;
use crate::views::{self, RunView};

/// The version of the document a hook reads on its stdin.
const DOCUMENT_VERSION: u32 = 1;

/// How many of a hook's last lines of output `results` repeats.
const RESULTS_OUTPUT_LINES: usize = 20;

/// The most of a hook's log `results` reads to find those lines.
///
/// A hook's output is external and unbounded, and a view reads its tail: what a
/// reader is shown is twenty lines, so what it reads for them is bounded too.
const MAX_TAIL_BYTES: u64 = 64 * 1024;

/// How often a wait on a hook looks again, and relays what it said since.
///
/// Shared with the dispatch-env hook's wait, which is the same wait without the
/// relay.
pub(crate) const POLL: Duration = Duration::from_millis(50);

/// The environment variable naming which hook is running.
///
/// Every hook this crate runs — the two run-end hooks and the dispatch-env hook
/// — is told which under this one name.
pub(crate) const HOOK_ENV: &str = "ONEPIPELINE_HOOK";

/// The environment variable naming the run a hook fired for.
pub(crate) const RUN_ID_ENV: &str = "ONEPIPELINE_RUN_ID";

/// The environment variable naming that run's own directory, absolute.
pub(crate) const RUN_ROOT_ENV: &str = "ONEPIPELINE_RUN_ROOT";

/// The settlement a driver lets go at when the run is paused rather than ended.
///
/// The word `start` and `adopt` print on their settlement line for the same
/// state, which is what a withheld hook's record carries so the two read alike.
pub(crate) const PAUSED: &str = "awaiting-planner";

/// One of the two run-end hooks.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub(crate) enum Hook {
    /// Every node settled `done`.
    Success,
    /// The run ended any other way.
    Failure,
}

impl Hook {
    fn as_str(self) -> &'static str {
        match self {
            Self::Success => "success",
            Self::Failure => "failure",
        }
    }

    /// The hook a record of this crate's own names, when it names one.
    fn parse(word: &str) -> Option<Self> {
        [Self::Success, Self::Failure]
            .into_iter()
            .find(|hook| hook.as_str() == word)
    }

    /// The command a launch record names for this hook.
    fn command(self, record: &LaunchRecord) -> Option<&str> {
        match self {
            Self::Success => record.success_hook(),
            Self::Failure => record.failure_hook(),
        }
    }
}

impl std::fmt::Display for Hook {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

/// Why the failure hook fired.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub(crate) enum ReasonKind {
    /// The graph holds a `failed` or `skipped` node.
    Nodes,
    /// The graph holds a node that is not `done`, none failed or skipped, and no
    /// decision is outstanding.
    Unfinished,
    /// `stop` established a clean teardown.
    Stopped,
}

/// One node that was not `done` when a hook was judged.
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
struct Unsettled {
    id: String,
    status: &'static str,
    /// Written as `null` rather than omitted: the document states the field.
    outcome: Option<String>,
}

/// Why the failure hook fired, and every node not `done` when it was judged.
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub(crate) struct Reason {
    kind: ReasonKind,
    nodes: Vec<Unsettled>,
}

/// Which hook fires, and why: a success carries no reason and a failure always
/// carries one, so neither can be recorded or handed over the other way round.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) enum Firing {
    /// Every node settled `done`.
    Success,
    /// The run ended any other way, for this reason.
    Failure(Reason),
}

impl Firing {
    fn hook(&self) -> Hook {
        match self {
            Self::Success => Hook::Success,
            Self::Failure(_) => Hook::Failure,
        }
    }

    /// The reason as the marker and the document write it: `null` for success.
    fn reason(&self) -> Option<&Reason> {
        match self {
            Self::Success => None,
            Self::Failure(reason) => Some(reason),
        }
    }
}

/// The one document a hook reads on its stdin.
///
/// Its `hook` and `reason` are one [`Firing`], written out as the two fields the
/// contract states.
struct Document<'a> {
    run_id: &'a str,
    run_root: String,
    firing: &'a Firing,
}

impl Serialize for Document<'_> {
    fn serialize<S: serde::Serializer>(
        &self,
        serializer: S,
    ) -> std::result::Result<S::Ok, S::Error> {
        use serde::ser::SerializeStruct;
        let mut document = serializer.serialize_struct("Document", 5)?;
        document.serialize_field("version", &DOCUMENT_VERSION)?;
        document.serialize_field("hook", &self.firing.hook())?;
        document.serialize_field("run_id", self.run_id)?;
        document.serialize_field("run_root", &self.run_root)?;
        document.serialize_field("reason", &self.firing.reason())?;
        document.end()
    }
}

/// How a hook ended.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "kebab-case")]
enum Ending {
    Succeeded,
    Failed,
    CouldNotStart,
    TimedOut,
}

/// What a driver letting go of a run owes it.
#[derive(Debug, PartialEq, Eq)]
pub(crate) enum Judged {
    /// The run has ended, and this is the hook it ended under.
    Fire(Firing),
    /// A decision is outstanding: the run is paused, not ended.
    Withhold,
    /// The run has not ended and is not paused on a decision either — a
    /// `complete-but-draft` node is waiting on a release.
    NotEnded,
}

/// Whether an attached driver repeats a hook's output on its own stderr.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum Relay {
    /// An attached driver: somebody is watching this process's stderr.
    Stderr,
    /// A detached driver, or a verb that is not a driver: the log is the record.
    Quiet,
}

/// Judge a run a driver has let go of, on the graph as it now stands.
///
/// In the contract's order, which is also the settlement line's: a complete graph
/// is success, an outstanding decision is a pause, a draft waiting on a release is
/// a run still going, and anything else not `done` is a failure — `nodes` where
/// something failed or was skipped, `unfinished` otherwise.
pub(crate) fn judge(state: &RunState, paths: &RunPaths) -> Judged {
    let statuses = state.statuses();
    // A graph with no nodes has not started, which is not an ending.
    if statuses.is_empty() {
        return Judged::NotEnded;
    }
    if statuses.values().all(|status| *status == NodeStatus::Done) {
        return Judged::Fire(Firing::Success);
    }
    if views::decision_outstanding(state, paths) {
        return Judged::Withhold;
    }
    if statuses
        .values()
        .any(|status| *status == NodeStatus::CompleteDraft)
    {
        return Judged::NotEnded;
    }
    let kind = if statuses
        .values()
        .any(|status| matches!(status, NodeStatus::Failed | NodeStatus::Skipped))
    {
        ReasonKind::Nodes
    } else {
        ReasonKind::Unfinished
    };
    Judged::Fire(Firing::Failure(Reason {
        kind,
        nodes: unsettled(state, &statuses),
    }))
}

/// Every node not `done`, in plan order, as a hook is handed it.
fn unsettled(state: &RunState, statuses: &BTreeMap<String, NodeStatus>) -> Vec<Unsettled> {
    state
        .graph
        .iter()
        .filter_map(|node| {
            let status = statuses
                .get(&node.id)
                .copied()
                .unwrap_or(NodeStatus::Pending);
            (status != NodeStatus::Done).then(|| Unsettled {
                id: node.id.clone(),
                status: status.as_str(),
                outcome: state.outcomes.get(&node.id).cloned(),
            })
        })
        .collect()
}

/// What a driver owes the run it has just let go of: the hook the run ended
/// under, a withheld record for a run paused on a decision, or nothing.
///
/// Called only once the ownership lock is released, so the hook runs while the
/// run reads as free — and never by a driver that left the run claimed.
pub(crate) fn at_let_go(paths: &RunPaths, relay: Relay) {
    let Some(view) = judged_view(paths) else {
        return;
    };
    match judge(&view.state, paths) {
        Judged::Fire(firing) => fire(paths, &view.launch, &firing, relay),
        Judged::Withhold => withhold(paths),
        Judged::NotEnded => {}
    }
}

/// What a clean `stop` owes the run it stopped: the failure hook, as `stopped`.
///
/// The stop verb's own, after it journals `run-stopped`. It is not the run's
/// driver — the driver is what it ended — so it journals the way the stop itself
/// did, from outside the lock.
pub(crate) fn at_stop(paths: &RunPaths) {
    let Some(view) = judged_view(paths) else {
        return;
    };
    let statuses = view.state.statuses();
    let firing = Firing::Failure(Reason {
        kind: ReasonKind::Stopped,
        nodes: unsettled(&view.state, &statuses),
    });
    fire(paths, &view.launch, &firing, Relay::Quiet);
}

/// The run, read once, where its record names a hook at all.
///
/// A run whose record names none is a launch that did exactly what launches did
/// before hooks existed, so nothing is judged or journaled for it. A record that
/// cannot be read is not one that names none: every caller has just driven or
/// stopped this run under that record, so it says so rather than firing nothing
/// in silence.
fn judged_view(paths: &RunPaths) -> Option<RunView> {
    let unjudged = |error: &dyn std::fmt::Display| {
        eprintln!(
            "onepipeline: whether run '{}' fires a run-end hook could not be judged: {error}",
            paths.run
        );
    };
    let record: LaunchRecord = match ledger::read_json(&paths.launch()) {
        Ok(record) => record,
        Err(error) => {
            unjudged(&error);
            return None;
        }
    };
    if record.success_hook().is_none() && record.failure_hook().is_none() {
        return None;
    }
    match RunView::open(paths) {
        Ok(view) => Some(view),
        Err(error) => {
            unjudged(&error);
            None
        }
    }
}

/// Record that a driver let go of a paused run, and say so.
fn withhold(paths: &RunPaths) {
    // A run that has already fired its hook is past every judgement, a pause
    // included.
    if fired(paths) {
        return;
    }
    eprintln!(
        "onepipeline: run '{}' is paused on a decision ({PAUSED}), so no run-end hook fired; \
         the driver that adopts it once the decision is answered fires the hook the run then \
         reaches",
        paths.run
    );
    if let Err(error) = Journal::open(paths).emit(
        PipelineKind::RunHookWithheld,
        journal::labels(&paths.run, None),
        journal::payload(&[("settlement", json!(PAUSED))]),
    ) {
        eprintln!(
            "onepipeline: the withheld run-end hook of run '{}' could not be recorded: {error}",
            paths.run
        );
    }
}

/// Fire one hook, once per ending: mark it, run it, and record how it ended.
fn fire(paths: &RunPaths, record: &LaunchRecord, firing: &Firing, relay: Relay) {
    let hook = firing.hook();
    // An ending whose hook the record does not name fires nothing, and marks
    // nothing — so a hook it does name is still reachable later.
    let Some(command) = hook.command(record) else {
        return;
    };
    match mark(paths, firing, command) {
        Ok(true) => {}
        Ok(false) => return,
        Err(error) => {
            eprintln!(
                "onepipeline: the {hook} hook of run '{}' was not fired, because its firing \
                 could not be recorded: {error}",
                paths.run
            );
            return;
        }
    }
    let log = log_path(paths, hook);
    let ran = run(paths, record, firing, command, &log, relay);
    if let Err(error) = Journal::open(paths).emit(
        PipelineKind::RunHookFinished,
        journal::labels(&paths.run, None),
        journal::payload(&[
            ("hook", json!(hook)),
            ("exit", json!(ran.exit())),
            ("ending", json!(ran.ending())),
            ("log", json!(log.to_string_lossy())),
        ]),
    ) {
        eprintln!(
            "onepipeline: how the {hook} hook of run '{}' ended could not be recorded: {error}",
            paths.run
        );
    }
}

/// Journal `run-hook-fired`, unless the run already carries one for this ending.
///
/// The check and the append are one section, under the gate a driver lets go of
/// the run under: a `stop` and a driver that let go on another host are two
/// processes that may both judge the run, and exactly one of them fires. Both
/// read the journal inside that section, so both read the same epoch and the same
/// marker, which is what makes "exactly one" hold across the edit that reopened
/// the run as well as across the ending itself.
fn mark(paths: &RunPaths, firing: &Firing, command: &str) -> Result<bool> {
    let handover = ledger::Handover::hold(paths)?;
    let marked = if fired(paths) {
        Ok(false)
    } else {
        Journal::open(paths)
            .emit(
                PipelineKind::RunHookFired,
                journal::labels(&paths.run, None),
                journal::payload(&[
                    ("hook", json!(firing.hook())),
                    ("command", json!(command)),
                    ("reason", json!(firing.reason())),
                ]),
            )
            .map(|()| true)
    };
    drop(handover);
    marked
}

/// Whether the run's journal carries the marker a firing leaves, **for the ending
/// the run is now at** — the contract's epoch rule, answered.
///
/// Answered by **folding** the journal through the same projection every other
/// reader uses, rather than by searching the record: the rule turns on the graph
/// an edit left behind, and no field of an `edit-committed` says what that graph
/// was. That is also why no list of operation kinds appears here — one could only
/// approximate the graph, and would get both of the contract's own examples
/// backwards.
///
/// `command-accepted` is deliberately not asked. It is the record for a command that
/// committed **nothing a reader folds** — a finding, a completion request — so it
/// cannot have made the run live; reading it as an epoch would only let an
/// unrelated report turn liveness that arrived some other way into a second hook
/// for an ending nobody edited.
///
/// The graph is asked **on both sides** of the edit, because the rule is that the
/// edit *made* the run live: a run already live when the edit arrived was made so
/// by something else, and an inert edit landing after it would otherwise inherit an
/// epoch it had nothing to do with.
///
/// A fold that has lost a record — [`RunState::strict`] — retires nothing. An
/// `edit-committed` whose operations this build cannot parse might have been the
/// graph mutation that matters, so the graph beside it is not evidence of anything;
/// the marker standing is the answer that cannot fire a hook twice. `strict` never
/// comes back, so a run carrying such a record recognises no further epoch and its
/// operator fires the hook by hand, which is the failure this whole rule prefers.
///
/// One fold of what [`RunView::open`] already does, and the statuses are derived
/// only for an edit arriving while a marker stands, so a run that has never fired
/// pays for none of it.
fn fired(paths: &RunPaths) -> bool {
    let mut state = RunState {
        strict: true,
        ..RunState::default()
    };
    let mut fired = false;
    for event in &journal::read(&paths.journal()) {
        let kind = PipelineKind::from_wire(&event.kind);
        let edit = kind == Some(PipelineKind::EditCommitted);
        let was_live = edit && fired && live(&state);
        crate::projection::fold_one(&mut state, event);
        if edit && fired && !was_live && state.strict && live(&state) {
            fired = false;
        } else if kind == Some(PipelineKind::RunHookFired) {
            fired = true;
        }
    }
    fired
}

/// Whether the run has work it can still carry out, on the graph as it stands.
///
/// The contract's "live again", as a question about one graph. Two of the answers
/// below cannot be checked against it by reading the match:
///
/// * `pending` answers `false` and is not an oversight. A node is `pending` only
///   while a dependency of it is pending, ready or running, so whatever ancestor
///   carries the liveness has already answered `true`; a dependency that is
///   parked, waiting or failed makes its dependents `blocked` or `skipped`
///   instead, so a `pending` node with no such ancestor cannot be derived.
/// * `complete-but-draft` is **unreachable from here**, which is why no journey
///   drives it: [`judge`] answers `NotEnded` for a graph holding one, so a run
///   that has ever held such a node has never fired and has no marker to retire.
///   It is answered rather than swept into the `false` arm because the day a
///   settlement can leave a draft node on an *ended* run, that arm would be wrong.
///
/// Exhaustive on purpose: a status added later has to decide this rather than
/// inherit `false`, which would silently stop a run that reaches it from ever
/// firing again.
fn live(state: &RunState) -> bool {
    state.statuses().values().any(|status| match status {
        NodeStatus::Ready | NodeStatus::Running => true,
        NodeStatus::Waiting | NodeStatus::CompleteDraft => true,
        NodeStatus::Pending
        | NodeStatus::Blocked
        | NodeStatus::Parked
        | NodeStatus::Cancelled
        | NodeStatus::Done
        | NodeStatus::Failed
        | NodeStatus::Skipped => false,
    })
}

/// Where a hook's output is kept: `hooks/<hook>.log` under the run's own
/// directory, absolute.
fn log_path(paths: &RunPaths, hook: Hook) -> PathBuf {
    hook_log(paths, &hook.to_string())
}

/// Where the output of the hook called `name` is kept: `hooks/<name>.log` under
/// the run's own directory, absolute. One spelling for every hook this crate
/// runs.
pub(crate) fn hook_log(paths: &RunPaths, name: &str) -> PathBuf {
    run_root(paths).join("hooks").join(format!("{name}.log"))
}

/// The run's own directory, absolute, as a hook is told it.
pub(crate) fn run_root(paths: &RunPaths) -> PathBuf {
    std::path::absolute(&paths.dir).unwrap_or_else(|_| paths.dir.clone())
}

/// How a hook's process ended, carrying an exit only where that ending has one.
enum Ran {
    /// It exited zero.
    Succeeded,
    /// It exited non-zero, or ended with no code this host could report.
    Failed(Option<i32>),
    CouldNotStart,
    TimedOut,
}

impl Ran {
    fn ending(&self) -> Ending {
        match self {
            Self::Succeeded => Ending::Succeeded,
            Self::Failed(_) => Ending::Failed,
            Self::CouldNotStart => Ending::CouldNotStart,
            Self::TimedOut => Ending::TimedOut,
        }
    }

    fn exit(&self) -> Option<i32> {
        match self {
            Self::Succeeded => Some(0),
            Self::Failed(code) => *code,
            Self::CouldNotStart | Self::TimedOut => None,
        }
    }
}

/// Spawn one hook, hand it its document, and wait for it — for up to the run's
/// hook timeout, and then end its process tree.
///
/// Its stdout and stderr both go straight to the log file rather than through a
/// pipe this process reads, so a hook that leaves something running behind it
/// holding those streams cannot keep this wait open past the hook itself.
fn run(
    paths: &RunPaths,
    record: &LaunchRecord,
    firing: &Firing,
    command: &str,
    log: &Path,
    relay: Relay,
) -> Ran {
    let hook = firing.hook();
    let opened = log
        .parent()
        .map_or(Ok(()), std::fs::create_dir_all)
        .and_then(|()| std::fs::File::create(log));
    let output = match opened {
        Ok(output) => output,
        Err(error) => {
            eprintln!(
                "onepipeline: the {hook} hook of run '{}' could not be started, because its log \
                 {} could not be opened: {error}",
                paths.run,
                log.display()
            );
            return Ran::CouldNotStart;
        }
    };
    let document = Document {
        run_id: &paths.run,
        run_root: run_root(paths).to_string_lossy().into_owned(),
        firing,
    };
    let mut spawning = std::process::Command::new(command);
    // The launch directory. A record from before the field existed names none, and
    // the hook starts where this process is, which is what that launch did.
    if !record.dir.as_os_str().is_empty() {
        spawning.current_dir(&record.dir);
    }
    spawning
        .env(HOOK_ENV, hook.as_str())
        .env(RUN_ID_ENV, &paths.run)
        .env(RUN_ROOT_ENV, run_root(paths))
        .stdin(Stdio::piped());
    // The run's owner, whichever process fired it: a follow-up a hook launches
    // belongs to whoever this run belongs to. A record naming nobody leaves both
    // unset rather than handing on this process's own.
    if record.owned_by(&record.session) {
        spawning
            .env(sys::LAUNCHER_ENV, &record.launcher)
            .env(sys::LAUNCHER_SESSION_ENV, &record.session);
    } else {
        spawning
            .env_remove(sys::LAUNCHER_ENV)
            .env_remove(sys::LAUNCHER_SESSION_ENV);
    }
    let spawned = serde_json::to_string(&document)
        .map_err(std::io::Error::other)
        .and_then(|document| {
            spawning
                .stdout(output.try_clone()?)
                .stderr(output.try_clone()?);
            Ok((spawning.spawn()?, document))
        });
    let (mut child, document) = match spawned {
        Ok(spawned) => spawned,
        Err(error) => {
            // The log is what a reader opens to find out why, so it says.
            let _ = writeln!(
                &output,
                "onepipeline: the {hook} hook '{command}' could not be started: {error}"
            );
            return Ran::CouldNotStart;
        }
    };
    if let Some(mut stdin) = child.stdin.take() {
        // On a thread of its own, so a hook that never reads its stdin cannot hold
        // this wait on a full pipe: the write ends when the hook does.
        std::thread::spawn(move || {
            let _ = stdin.write_all(document.as_bytes());
        });
    }

    let deadline = deadline_after(record.hook_timeout());
    let mut relayed = 0;
    let ran = loop {
        match child.try_wait() {
            Ok(Some(status)) => {
                break if status.success() {
                    Ran::Succeeded
                } else {
                    Ran::Failed(status.code())
                }
            }
            Ok(None) if deadline.is_none_or(|deadline| Instant::now() < deadline) => {}
            // Past the timeout — or a child this process can no longer ask about,
            // which is waited out the same way rather than left running unrecorded.
            waited => {
                let _ = sys::stop(child.id(), sys::Stop::Now);
                let _ = child.kill();
                let _ = child.wait();
                break if waited.is_ok() {
                    Ran::TimedOut
                } else {
                    Ran::Failed(None)
                };
            }
        }
        if relay == Relay::Stderr {
            relayed = relay_from(log, relayed);
        }
        std::thread::sleep(POLL);
    };
    if relay == Relay::Stderr {
        relay_from(log, relayed);
    }
    ran
}

/// When a hook started now has outlived its timeout, or `None` where that is
/// further off than this host's clock can count to.
///
/// A timeout is any positive whole number of seconds, so one can name an instant
/// no `Instant` holds. That is a timeout no hook can outlive, and it is waited
/// without a bound rather than panicking on a value the launch accepted.
pub(crate) fn deadline_after(timeout: NonZeroU64) -> Option<Instant> {
    Instant::now().checked_add(Duration::from_secs(timeout.get()))
}

/// Repeat what a hook's log gained since `from` on this process's stderr, and
/// answer how far that got.
fn relay_from(log: &Path, from: u64) -> u64 {
    let Ok(mut file) = open_log(log) else {
        return from;
    };
    let mut said = Vec::new();
    if file.seek(SeekFrom::Start(from)).is_err() || file.read_to_end(&mut said).is_err() {
        return from;
    }
    let _ = std::io::stderr().write_all(&said);
    from + said.len() as u64
}

/// What `results` says about a run's hooks: each that fired — which, why, how it
/// ended, its exit, its log, and the tail of its output — and each let-go that
/// withheld one.
pub(crate) fn results_lines(view: &RunView) -> String {
    let mut out = String::new();
    for (at, event) in view.events.iter().enumerate() {
        match PipelineKind::from_wire(&event.kind) {
            Some(PipelineKind::RunHookFired) => {
                let Some(hook) = event
                    .payload
                    .get("hook")
                    .and_then(Value::as_str)
                    .and_then(Hook::parse)
                else {
                    continue;
                };
                let reason = event
                    .payload
                    .get("reason")
                    .and_then(|reason| reason.get("kind"))
                    .and_then(Value::as_str)
                    .unwrap_or("none");
                // The log is derived from the run rather than taken from a record,
                // so a view opens only this run's own storage.
                let log = log_path(&view.paths, hook);
                let finished = view.events[at + 1..].iter().find(|later| {
                    PipelineKind::from_wire(&later.kind) == Some(PipelineKind::RunHookFinished)
                        && later.payload.get("hook").and_then(Value::as_str) == Some(hook.as_str())
                });
                let ended = match finished {
                    Some(finished) => format!(
                        "ending: {}; exit: {}",
                        views::one_line(
                            finished
                                .payload
                                .get("ending")
                                .and_then(Value::as_str)
                                .unwrap_or("unrecorded")
                        ),
                        finished
                            .payload
                            .get("exit")
                            .and_then(Value::as_i64)
                            .map_or_else(|| "none".to_string(), |code| code.to_string())
                    ),
                    None => "still running".to_string(),
                };
                out.push_str(&format!(
                    "  {hook} hook fired — reason: {}; {ended}; log: {}\n",
                    views::one_line(reason),
                    log.display()
                ));
                match tail(&log) {
                    Ok(lines) => {
                        for line in lines {
                            out.push_str(&format!("      output: {}\n", views::one_line(&line)));
                        }
                    }
                    // A hook that could not start may have had nowhere to log.
                    Err(error) if error.kind() == std::io::ErrorKind::NotFound => {}
                    Err(error) => out.push_str(&format!(
                        "      log not read: {}\n",
                        views::one_line(&error.to_string())
                    )),
                }
            }
            Some(PipelineKind::RunHookWithheld) => out.push_str(&format!(
                "  run-end hook withheld — the run is paused on a decision ({}), so no hook \
                 fired\n",
                views::one_line(
                    event
                        .payload
                        .get("settlement")
                        .and_then(Value::as_str)
                        .unwrap_or(PAUSED)
                )
            )),
            _ => {}
        }
    }
    out
}

/// Open a hook's log for reading as the plain file this run created — never
/// through a link, and never as anything else put under its name.
///
/// The hook is external and is told the run's own directory, so the name its log
/// is kept under is one it can replace: a reader shown whatever that name now
/// points at would be shown a file the hook chose.
fn open_log(log: &Path) -> std::io::Result<std::fs::File> {
    let not_plain = || {
        std::io::Error::new(
            std::io::ErrorKind::InvalidInput,
            format!("{} is not a plain file this run wrote", log.display()),
        )
    };
    // Asked of the name before the open too, so a FIFO put in its place is refused
    // rather than holding the open on a writer that never comes.
    if !std::fs::symlink_metadata(log)?.is_file() {
        return Err(not_plain());
    }
    let file = report::open_no_follow(log)?;
    if !file.metadata()?.is_file() {
        return Err(not_plain());
    }
    Ok(file)
}

/// The last lines of a hook's log, read from no further back than
/// [`MAX_TAIL_BYTES`].
fn tail(log: &Path) -> std::io::Result<Vec<String>> {
    let mut file = open_log(log)?;
    let length = file.metadata()?.len();
    let start = length.saturating_sub(MAX_TAIL_BYTES);
    let mut said = Vec::new();
    file.seek(SeekFrom::Start(start))?;
    file.read_to_end(&mut said)?;
    let text = String::from_utf8_lossy(&said);
    let mut lines: Vec<&str> = text.lines().collect();
    // A read that began mid-file began mid-line, and half a line is not one.
    if start > 0 && !lines.is_empty() {
        lines.remove(0);
    }
    let from = lines.len().saturating_sub(RESULTS_OUTPUT_LINES);
    Ok(lines[from..]
        .iter()
        .map(|line| (*line).to_string())
        .collect())
}

/// The hook command a launch names, resolved from its two rungs.
///
/// The **presence** of a rung decides which one answers, as it does for the node
/// validator: the flag beats the launch config even when what it names is blank,
/// and a blank command is this launch saying it has none rather than a
/// fall-through to the rung below. Not resolved against the launch directory — a
/// command may as legitimately be a name on `PATH` as a path, and it runs in that
/// directory anyway.
pub(crate) fn named(flag: Option<&str>, config: Option<&str>) -> Option<String> {
    flag.or(config)
        .map(str::trim)
        .filter(|command| !command.is_empty())
        .map(str::to_string)
}

/// The refusal for a hook timeout of zero, by the spelling that carried it.
///
/// One sentence for the flag and the launch-config key, as the write-back's
/// budget has one: a timeout of zero ends every hook before it has begun, so a
/// launch that wrote it asked for something it would not get.
pub(crate) fn refused_zero_timeout(spelling: &str) -> String {
    format!(
        "{spelling} names a hook timeout of zero seconds, which ends every hook before it has \
         begun — give it a positive whole number of seconds, or leave it out to take \
         {DEFAULT_HOOK_TIMEOUT_SECONDS} seconds"
    )
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::graph::Graph;
    use crate::plan::Node;
    use crate::projection::Recorded;

    fn scratch(name: &str) -> PathBuf {
        let root =
            std::env::temp_dir().join(format!("onepipeline-hooks-{name}-{}", std::process::id()));
        let _ = std::fs::remove_dir_all(&root);
        std::fs::create_dir_all(&root).expect("a scratch root");
        root
    }

    /// A run whose graph holds these nodes, each recorded at its status, in order.
    fn holding(nodes: &[(&str, NodeStatus)]) -> RunState {
        let mut graph = Graph::with_concurrency(4);
        for (id, _) in nodes {
            graph.insert(Node {
                id: (*id).to_string(),
                persona: Some("engineer".into()),
                task: Some("## What\ndo it".into()),
                ..Node::default()
            });
        }
        RunState {
            graph,
            recorded: nodes
                .iter()
                .map(|(id, status)| ((*id).to_string(), Recorded::At(*status)))
                .collect(),
            ..RunState::default()
        }
    }

    /// A draft waiting on a release has not ended, whatever else the graph holds —
    /// and a graph with no nodes has not begun.
    ///
    /// The one arm of the rule no journey can reach: a driver never lets go of a
    /// run holding such a draft, because the draft is a node that can still move.
    /// It is held here so a hook cannot come to fire over one if that ever changes.
    #[test]
    fn a_draft_waiting_on_a_release_has_not_ended_and_an_empty_graph_has_not_begun() {
        let root = scratch("not-ended");
        let paths = RunPaths::under(&root, "demo");
        for beside in [NodeStatus::Done, NodeStatus::Failed, NodeStatus::Parked] {
            assert_eq!(
                judge(
                    &holding(&[("build", beside), ("lift", NodeStatus::CompleteDraft)]),
                    &paths
                ),
                Judged::NotEnded,
                "a draft beside a {} node was judged an ending",
                beside.as_str()
            );
        }
        assert_eq!(judge(&RunState::default(), &paths), Judged::NotEnded);
        // And the draft landing is what ends it.
        assert_eq!(
            judge(
                &holding(&[("build", NodeStatus::Done), ("lift", NodeStatus::Done)]),
                &paths
            ),
            Judged::Fire(Firing::Success)
        );
        let _ = std::fs::remove_dir_all(&root);
    }

    /// A `cancelled` or a `pending` node, with nothing failed or skipped and no
    /// decision outstanding, is a run ended unfinished — listed in plan order.
    ///
    /// The two statuses of the `unfinished` rule no journey can reach at a let-go:
    /// the graph reads a park ahead of the `cancelled` a stopped dispatch settles,
    /// and a `retry` or `drop` takes the node it cancelled out of the graph; and a
    /// quiet graph derives `pending` only behind a `complete-but-draft` dependency,
    /// which is a run that has not ended. Held here so neither can come to fire
    /// success, or nothing, if either ever becomes reachable.
    #[test]
    fn a_cancelled_or_pending_node_ends_a_run_unfinished_in_plan_order() {
        let root = scratch("unfinished");
        let paths = RunPaths::under(&root, "demo");
        let unfinished = |nodes: &[(&str, &'static str)]| {
            Judged::Fire(Firing::Failure(Reason {
                kind: ReasonKind::Unfinished,
                nodes: nodes
                    .iter()
                    .map(|(id, status)| Unsettled {
                        id: (*id).to_string(),
                        status,
                        outcome: None,
                    })
                    .collect(),
            }))
        };
        assert_eq!(
            judge(
                &holding(&[
                    ("stopped", NodeStatus::Cancelled),
                    ("build", NodeStatus::Done),
                    ("waits", NodeStatus::Pending),
                ]),
                &paths
            ),
            unfinished(&[("stopped", "cancelled"), ("waits", "pending")])
        );
        for alone in [NodeStatus::Cancelled, NodeStatus::Pending] {
            assert_eq!(
                judge(
                    &holding(&[("build", NodeStatus::Done), ("left", alone)]),
                    &paths
                ),
                unfinished(&[("left", alone.as_str())])
            );
        }
        let _ = std::fs::remove_dir_all(&root);
    }

    /// The driver a firing names is read off the stream this crate stamps, and a
    /// stream in any other form names none — so it can never be taken for the
    /// driver a launch record claims.
    #[test]
    fn a_firing_names_its_driver_only_by_the_stream_this_crate_stamps() {
        use crate::projection::DriverClaim;
        let host = sys::hostname();
        let stamped = DriverClaim::of_stream(&format!("{host}-{}", sys::pid()))
            .expect("the stream a journal here writes names its driver");
        assert!(stamped.is(Some(&host), std::num::NonZeroU32::new(sys::pid())));
        assert!(!stamped.is(None, std::num::NonZeroU32::new(sys::pid())));
        assert!(!stamped.is(Some(&host), None));
        // A host carrying its own hyphens still splits at the last one.
        let hyphenated = DriverClaim::of_stream("build-host-01-4242").expect("a claim");
        assert!(hyphenated.is(Some("build-host-01"), std::num::NonZeroU32::new(4242)));
        assert!(!hyphenated.is(Some("build-host"), std::num::NonZeroU32::new(4242)));
        for malformed in ["", "4242", "-4242", "host-", "host-0", "host-pid", "host"] {
            assert_eq!(
                DriverClaim::of_stream(malformed),
                None,
                "`{malformed}` was read as naming a driver"
            );
        }
        // And a document — a checkpoint or a summary — cannot put back what the
        // stream refuses: a claim naming no host is refused where it is read.
        let written = serde_json::to_value(&hyphenated).expect("a claim serialises");
        assert_eq!(
            serde_json::from_value::<DriverClaim>(written).expect("it reads back"),
            hyphenated
        );
        for refused in [
            json!({"host": "", "pid": 4242}),
            json!({"host": "h", "pid": 0}),
            json!({"host": "h", "pid": 1, "stream": "h-1"}),
        ] {
            assert!(
                serde_json::from_value::<DriverClaim>(refused.clone()).is_err(),
                "{refused} was read as a driver claim"
            );
        }
    }

    /// A timeout too large for this host's clock is no deadline rather than a panic,
    /// and the shipped one is an instant still to come.
    #[test]
    fn a_timeout_past_what_the_clock_can_count_to_is_no_deadline_rather_than_a_panic() {
        assert_eq!(deadline_after(NonZeroU64::MAX), None);
        assert!(deadline_after(DEFAULT_HOOK_TIMEOUT_SECONDS)
            .is_some_and(|deadline| deadline > Instant::now()));
    }

    /// `results` reads a hook's log from no further back than its bound, and never
    /// repeats the half line a read begun mid-file starts on.
    #[test]
    fn the_tail_of_a_long_log_is_its_last_whole_lines() {
        let root = scratch("tail");
        let log = root.join("failure.log");
        let written: String = (1..=10_000).map(|n| format!("said line {n}\n")).collect();
        assert!(written.len() as u64 > MAX_TAIL_BYTES);
        std::fs::write(&log, &written).expect("the log is written");
        let tail = tail(&log).expect("a plain log reads");
        assert_eq!(tail.len(), RESULTS_OUTPUT_LINES);
        assert_eq!(tail.first().map(String::as_str), Some("said line 9981"));
        assert_eq!(tail.last().map(String::as_str), Some("said line 10000"));
        assert!(super::tail(&root.join("absent.log"))
            .is_err_and(|error| error.kind() == std::io::ErrorKind::NotFound));
        let _ = std::fs::remove_dir_all(&root);
    }

    /// A log whose name no longer holds a plain file is refused rather than read:
    /// a directory put in its place, and — where this host has them — a link and
    /// a FIFO, which would otherwise show a reader another file or hold the read.
    #[test]
    fn a_log_that_is_not_a_plain_file_is_refused_rather_than_read() {
        let root = scratch("not-plain");
        let refused = |path: &Path| {
            let error = tail(path).expect_err("a log that is not a plain file was read");
            assert_eq!(error.kind(), std::io::ErrorKind::InvalidInput, "{error}");
            assert!(error.to_string().contains("not a plain file"), "{error}");
            assert_eq!(relay_from(path, 0), 0, "{} was relayed", path.display());
        };
        let directory = root.join("directory.log");
        std::fs::create_dir_all(&directory).expect("a directory in the log's place");
        refused(&directory);
        #[cfg(unix)]
        {
            let elsewhere = root.join("elsewhere.txt");
            std::fs::write(&elsewhere, "not the log\n").expect("the linked file");
            let link = root.join("link.log");
            std::os::unix::fs::symlink(&elsewhere, &link).expect("a link in the log's place");
            refused(&link);
            let fifo = root.join("fifo.log");
            let name = std::ffi::CString::new(fifo.as_os_str().as_encoded_bytes())
                .expect("a path with no NUL");
            // SAFETY: `name` is a NUL-terminated path this test owns for the call.
            assert_eq!(unsafe { libc::mkfifo(name.as_ptr(), 0o600) }, 0, "mkfifo");
            refused(&fifo);
        }
        let _ = std::fs::remove_dir_all(&root);
    }
}