silicon-extend-cli 1.3.0

The extend command: find and use the devices a Silicon has access to
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

//! The CLI's errors: what failed, why, and what to run next, with a stable code and exit code
//! (`understanding/cli.yaml`, `errors` and `exit_codes`).

use extend_protocol::{ApiError, ErrorCode};
use serde_json::{Value, json};

#[derive(Debug)]
pub struct CliError {
    pub code: ErrorCode,
    pub message: String,
    pub hint: Option<String>,
    pub request_id: Option<String>,
    pub docs_url: Option<String>,
    /// Boxed to keep `Result<_, CliError>` small.
    pub details: Box<Value>,
    /// The HTTP status, when Extend answered.
    pub status: Option<u16>,
}

pub type R<T> = Result<T, CliError>;

impl CliError {
    pub fn new(code: ErrorCode, message: impl Into<String>) -> Self {
        Self {
            code,
            message: message.into(),
            hint: None,
            request_id: None,
            docs_url: None,
            details: Box::new(Value::Null),
            status: None,
        }
    }
    pub fn hint(mut self, h: impl Into<String>) -> Self {
        self.hint = Some(h.into());
        self
    }
    pub fn details(mut self, d: Value) -> Self {
        self.details = Box::new(d);
        self
    }
    /// A usage error (exit 2). Every one says what to type instead.
    pub fn usage(message: impl Into<String>, hint: impl Into<String>) -> Self {
        Self::new(ErrorCode::InvalidInput, message).hint(hint)
    }
    pub fn exit(&self) -> i32 {
        self.code.exit_code()
    }
    /// The `--json` form: `{"error": {code, message, hint, request_id, docs_url, details, exit_code}}`.
    pub fn to_json(&self) -> Value {
        json!({"error": {
            "code": self.code.as_str(),
            "message": self.message,
            "hint": self.hint,
            "request_id": self.request_id,
            "docs_url": self.docs_url,
            "details": self.details,
            "exit_code": self.exit(),
        }})
    }
}

impl From<silicon_extend_client::Error> for CliError {
    fn from(e: silicon_extend_client::Error) -> Self {
        match e {
            silicon_extend_client::Error::Api { status, error } => {
                let ApiError {
                    code,
                    message,
                    hint,
                    request_id,
                    details,
                    docs_url,
                } = *error;
                Self {
                    code,
                    message,
                    hint,
                    request_id: Some(request_id).filter(|r| !r.is_empty()),
                    docs_url,
                    details: Box::new(details),
                    status: Some(status),
                }
            }
            silicon_extend_client::Error::Transport { url, source } => Self::new(
                ErrorCode::ServiceUnavailable,
                format!("Could not reach Silicon Extend at {url}: {source}"),
            )
            .hint("Check your network, or the api_url setting (`extend config get api_url`, or EXTEND_API_URL)."),
            silicon_extend_client::Error::Decode { status, detail } => {
                let mut e = Self::new(
                    ErrorCode::Internal,
                    format!("Extend answered {status} with something this CLI can't read: {detail}"),
                )
                .hint("Update the CLI with `honeycomb install 'extend'`; if it persists, `extend report` it.");
                e.status = Some(status);
                e
            }
            silicon_extend_client::Error::Invalid(m) => Self::usage(
                m,
                "Check the value named above; `extend config ls` shows the settings and EXTEND_API_URL overrides api_url.",
            ),
        }
    }
}

impl From<anyhow::Error> for CliError {
    /// Local state problems (reading or writing files under the state directory).
    fn from(e: anyhow::Error) -> Self {
        Self::usage(
            format!("{e:#}"),
            format!(
                "Extend keeps its state in {}. Check that it exists and this user can write it, or move it with `extend config home <dir>`.",
                crate::store::root().display()
            ),
        )
    }
}