rootle 0.12.0

Modal TUI for browsing remote source-control systems from the terminal
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

//! Resolve native log paths before startup and finalize every command outcome.

use crate::cli::{Cli, ProviderCommand};
use rootle_trace::{ContentPolicy, EventKind, TraceOptions, TraceSession};
use serde_json::json;
use std::ffi::OsStr;
use std::io;
use std::path::PathBuf;
use std::time::{SystemTime, UNIX_EPOCH};

pub struct Session {
    trace: TraceSession,
    path: PathBuf,
}

impl Session {
    pub fn start(cli: &Cli) -> io::Result<Option<Self>> {
        let path = if let Some(path) = &cli.log_file {
            Some(path.clone())
        } else if let Some(selection) = &cli.log {
            Some(if selection == OsStr::new("ALL") {
                automatic_path()?
            } else {
                PathBuf::from(selection)
            })
        } else {
            std::env::var_os("ROOTLE_TRACE")
                .filter(|value| !value.is_empty())
                .map(PathBuf::from)
        };
        let Some(path) = path else {
            if cli.log_content {
                return Err(io::Error::other(
                    "--log-content requires --log, --log-file or ROOTLE_TRACE",
                ));
            }
            return Ok(None);
        };
        let path = if path.is_absolute() {
            path
        } else {
            std::env::current_dir()?.join(path)
        };
        let content = if cli.log_content {
            ContentPolicy::Full
        } else {
            ContentPolicy::Metadata
        };
        let options = TraceOptions {
            content,
            ..TraceOptions::default()
        };
        let trace = rootle_trace::start(&path, options).map_err(io::Error::other)?;
        rootle_trace::record_with(EventKind::SessionStart, || {
            json!({
                "application": "rootle", "version": env!("CARGO_PKG_VERSION"),
                "pid": std::process::id(), "os": std::env::consts::OS,
                "architecture": std::env::consts::ARCH,
                "unix_ms": SystemTime::now().duration_since(UNIX_EPOCH).unwrap_or_default().as_millis(),
                "driver": driver(cli), "command": command(cli),
                "content_policy": if cli.log_content { "full" } else { "metadata" },
                "path": path.to_string_lossy(),
                "max_bytes": options.limits.max_bytes,
                "max_events": options.limits.max_events,
                "max_record_bytes": options.limits.max_record_bytes,
            })
        });
        // This happens before raw mode and never touches machine-readable stdout.
        eprintln!(
            "trace: {}{}",
            path.display(),
            if cli.log_content {
                " (sensitive content capture)"
            } else {
                ""
            }
        );
        Ok(Some(Self { trace, path }))
    }

    pub fn finish(self, result: io::Result<()>) -> io::Result<()> {
        rootle_trace::record_with(EventKind::SessionEnd, || {
            json!({
                "outcome": if result.is_ok() { "success" } else { "error" },
                "error_kind": result.as_ref().err().map(|error| format!("{:?}", error.kind())),
            })
        });
        let trace_result = self.trace.finish();
        match (result, trace_result) {
            (result, Ok(())) => result,
            (Ok(()), Err(error)) => Err(io::Error::other(format!(
                "trace {}: {error}",
                self.path.display()
            ))),
            (Err(primary), Err(trace)) => Err(io::Error::other(format!(
                "{primary}; trace {}: {trace}",
                self.path.display()
            ))),
        }
    }
}

fn automatic_path() -> io::Result<PathBuf> {
    let state = rootle_provider::paths::state_dir().ok_or_else(|| {
        io::Error::other("cannot resolve a state directory for --log; use --log-file PATH")
    })?;
    let directory = state.join("rootle").join("logs");
    let mut builder = std::fs::DirBuilder::new();
    builder.recursive(true);
    #[cfg(unix)]
    {
        use std::os::unix::fs::DirBuilderExt;
        builder.mode(0o700);
    }
    builder.create(&directory)?;
    let timestamp = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap_or_default()
        .as_nanos();
    Ok(directory.join(format!("session-{timestamp}-{}.jsonl", std::process::id())))
}

fn driver(cli: &Cli) -> &'static str {
    if cli.provider.is_some() {
        "provider"
    } else if cli.update {
        "update"
    } else if cli.headless.is_some() {
        "headless"
    } else {
        "terminal"
    }
}

fn command(cli: &Cli) -> &'static str {
    match cli.provider.as_ref() {
        Some(ProviderCommand::Install { .. }) => "install",
        Some(ProviderCommand::List { .. }) => "list",
        Some(ProviderCommand::Update { .. }) => "update",
        Some(ProviderCommand::Upgrade { .. }) => "upgrade",
        Some(ProviderCommand::Pin { .. }) => "pin",
        Some(ProviderCommand::Unpin { .. }) => "unpin",
        Some(ProviderCommand::Remove { .. }) => "remove",
        Some(ProviderCommand::Use { .. }) => "use",
        None if cli.update && cli.check => "update_check",
        None if cli.update => "self_update",
        None => "browse",
    }
}