pointbreak 0.7.0

Durable terminal code review for changes humans and coding agents collaborate on together
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

use std::io::Write;
use std::net::{IpAddr, SocketAddr};
use std::path::PathBuf;

use clap::{Args, ValueEnum};

mod api;
mod cache;
mod server;

#[derive(Clone, Copy, Debug, Eq, PartialEq, ValueEnum)]
enum StartupOutputFormat {
    Text,
    Json,
}

/// `pointbreak inspect` starts a small local web server that visualizes a `.pointbreak/data`
/// store: the event timeline, captured Revisions, and recorded outcomes.
///
/// The server is intentionally synchronous (thread-per-connection, std only).
/// It introduces no async runtime, matching the storage-model guidance, and
/// reuses the same validated projections as `pointbreak history` /
/// `pointbreak revision list`, so it never parses raw `.pointbreak/data/` files itself.
#[derive(Debug, Args)]
pub(super) struct InspectArgs {
    /// Repository root or a path inside the repository.
    #[arg(long, default_value = ".")]
    repo: PathBuf,

    /// Loopback IP address to bind the inspector server to.
    #[arg(long, default_value = "127.0.0.1")]
    host: String,

    /// Port to bind the inspector server to.
    #[arg(long, default_value_t = 7878)]
    port: u16,

    /// Open the inspector in the default browser after the server starts.
    #[arg(long)]
    open: bool,

    /// Serve only the authenticated API, without the browser inspector shell.
    #[arg(long)]
    api_only: bool,

    /// Startup output encoding.
    #[arg(long, value_enum, default_value_t = StartupOutputFormat::Text)]
    format: StartupOutputFormat,
}

pub(super) fn run(
    args: InspectArgs,
    stdout: &mut dyn Write,
) -> Result<(), Box<dyn std::error::Error>> {
    let span = tracing::info_span!("shore.inspect");
    let _entered = span.enter();
    tracing::debug!(command = "inspect", "command_start");

    let ip: IpAddr = args
        .host
        .parse()
        .map_err(|_| format!("invalid --host value: {}", args.host))?;
    if !ip.is_loopback() {
        return Err(format!("--host must be a loopback IP address: {ip}").into());
    }
    validate_flag_compatibility(args.api_only, args.open)?;
    let addr = SocketAddr::new(ip, args.port);
    server::serve(
        addr,
        args.repo,
        args.open,
        args.api_only,
        args.format,
        stdout,
    )
}

fn validate_flag_compatibility(
    api_only: bool,
    open: bool,
) -> Result<(), Box<dyn std::error::Error>> {
    if api_only && open {
        return Err("--open cannot be used with --api-only".into());
    }
    Ok(())
}

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

    #[test]
    fn open_depends_only_on_the_served_surface() {
        assert!(validate_flag_compatibility(false, false).is_ok());
        assert!(validate_flag_compatibility(false, true).is_ok());
        assert!(validate_flag_compatibility(true, false).is_ok());
        assert!(validate_flag_compatibility(true, true).is_err());
    }
}