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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
use std::fmt;
use std::io::{self, BufRead, BufReader, Write};
use std::path::PathBuf;
use std::time::Duration;
use interprocess::local_socket::traits::Stream as _;
use serde::de::DeserializeOwned;
use crate::api::schema::{
ErrorResponse, Method, PingParams, Request, ResponseResult, SuccessResponse,
};
use crate::ipc::LocalStream;
/// API connection target resolved by clients at the process edge.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ConnectionTarget {
LocalSession(Option<String>),
SocketPath(PathBuf),
}
impl ConnectionTarget {
fn socket_path(&self) -> PathBuf {
match self {
Self::LocalSession(None) => crate::api::socket_path(),
Self::LocalSession(Some(name)) => crate::session::api_socket_path_for(Some(name)),
Self::SocketPath(path) => path.clone(),
}
}
}
/// Reusable client for Herdr's newline-delimited JSON API.
#[derive(Debug, Clone)]
pub struct ApiClient {
target: ConnectionTarget,
}
impl ApiClient {
pub fn local() -> Self {
Self::for_target(ConnectionTarget::LocalSession(None))
}
pub fn for_target(target: ConnectionTarget) -> Self {
Self { target }
}
pub fn socket_path(&self) -> PathBuf {
self.target.socket_path()
}
pub fn request(&self, request: Request) -> Result<SuccessResponse, ApiClientError> {
let value = self.request_value(&request)?;
parse_response_value(value)
}
pub fn request_value(&self, request: &Request) -> Result<serde_json::Value, ApiClientError> {
let mut stream = self.connect()?;
write_request(&mut stream, request)?;
let mut reader = BufReader::new(stream);
read_json_line(&mut reader)
}
pub fn request_value_with_timeout(
&self,
request: &Request,
timeout: Duration,
) -> Result<serde_json::Value, ApiClientError> {
let mut stream = self.connect()?;
set_timeout_best_effort(&stream, TimeoutKind::Send, timeout)?;
set_timeout_best_effort(&stream, TimeoutKind::Recv, timeout)?;
write_request(&mut stream, request)?;
let mut reader = BufReader::new(stream);
read_json_line(&mut reader)
}
pub fn status(&self) -> Result<crate::api::RuntimeStatus, ApiClientError> {
let response = self.request(Request {
id: "api-client:status".into(),
method: Method::Ping(PingParams::default()),
})?;
match response.result {
ResponseResult::Pong {
version,
protocol,
capabilities,
} => Ok(crate::api::RuntimeStatus {
version: Some(version),
protocol: Some(protocol),
capabilities,
}),
result => Err(ApiClientError::UnexpectedResult(format!("{result:?}"))),
}
}
fn connect(&self) -> io::Result<LocalStream> {
crate::ipc::connect_local_stream(&self.socket_path())
}
}
enum TimeoutKind {
Send,
Recv,
}
fn set_timeout_best_effort(
stream: &LocalStream,
kind: TimeoutKind,
timeout: Duration,
) -> io::Result<()> {
let result = match kind {
TimeoutKind::Send => stream.set_send_timeout(Some(timeout)),
TimeoutKind::Recv => stream.set_recv_timeout(Some(timeout)),
};
match result {
Ok(()) => Ok(()),
#[cfg(windows)]
Err(err) if err.kind() == io::ErrorKind::Unsupported => Ok(()),
Err(err) => Err(err),
}
}
#[derive(Debug)]
pub enum ApiClientError {
Io(io::Error),
Json(serde_json::Error),
ErrorResponse(ErrorResponse),
EmptyResponse,
UnexpectedResult(String),
}
impl fmt::Display for ApiClientError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Io(err) => write!(f, "{err}"),
Self::Json(err) => write!(f, "{err}"),
Self::ErrorResponse(response) => write!(f, "{}", response.error.message),
Self::EmptyResponse => write!(f, "empty api response"),
Self::UnexpectedResult(result) => write!(f, "unexpected api result: {result}"),
}
}
}
impl std::error::Error for ApiClientError {}
impl From<io::Error> for ApiClientError {
fn from(err: io::Error) -> Self {
Self::Io(err)
}
}
impl From<serde_json::Error> for ApiClientError {
fn from(err: serde_json::Error) -> Self {
Self::Json(err)
}
}
fn write_request(stream: &mut LocalStream, request: &Request) -> Result<(), ApiClientError> {
stream.write_all(serde_json::to_string(request)?.as_bytes())?;
stream.write_all(b"\n")?;
stream.flush()?;
Ok(())
}
fn read_json_line<T: DeserializeOwned>(
reader: &mut BufReader<LocalStream>,
) -> Result<T, ApiClientError> {
let mut line = String::new();
let read = reader.read_line(&mut line)?;
if read == 0 || line.trim().is_empty() {
return Err(ApiClientError::EmptyResponse);
}
serde_json::from_str(&line).map_err(ApiClientError::Json)
}
#[derive(serde::Deserialize)]
#[serde(untagged)]
enum WireResponse {
Success(Box<SuccessResponse>),
Error(ErrorResponse),
}
pub(crate) fn parse_response_value(
value: serde_json::Value,
) -> Result<SuccessResponse, ApiClientError> {
match serde_json::from_value(value)? {
WireResponse::Success(response) => Ok(*response),
WireResponse::Error(response) => Err(ApiClientError::ErrorResponse(response)),
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn local_session_target_resolves_named_session_socket() {
let client = ApiClient::for_target(ConnectionTarget::LocalSession(Some("work".into())));
assert!(client.socket_path().ends_with("sessions/work/herdr.sock"));
}
#[test]
fn socket_path_target_uses_explicit_path() {
let path = PathBuf::from("/tmp/herdr-test.sock");
let client = ApiClient::for_target(ConnectionTarget::SocketPath(path.clone()));
assert_eq!(client.socket_path(), path);
}
}
|
