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
|
use std::fmt;
use crate::api::schema::{ErrorBody, ErrorResponse};
#[derive(Debug)]
pub(super) struct ProtocolMismatchReported;
impl fmt::Display for ProtocolMismatchReported {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("protocol mismatch was already reported")
}
}
impl std::error::Error for ProtocolMismatchReported {}
pub(super) fn mismatch_response(
request_id: &str,
server_protocol: u32,
restart_guidance: &str,
) -> Option<ErrorResponse> {
let client_protocol = crate::protocol::PROTOCOL_VERSION;
if client_protocol == server_protocol {
return None;
}
let message = if client_protocol > server_protocol {
format!(
"client protocol {client_protocol} is newer than server protocol {server_protocol}; restart the Herdr server before using this command. {restart_guidance}"
)
} else {
format!(
"client protocol {client_protocol} is older than server protocol {server_protocol}; upgrade the Herdr client before using this command"
)
};
Some(ErrorResponse {
id: request_id.to_string(),
error: ErrorBody {
code: "protocol_mismatch".into(),
message,
},
})
}
pub(super) fn reported_error() -> std::io::Error {
std::io::Error::other(ProtocolMismatchReported)
}
pub(super) fn was_reported(err: &std::io::Error) -> bool {
err.get_ref()
.and_then(|source| source.downcast_ref::<ProtocolMismatchReported>())
.is_some()
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn matching_protocol_has_no_error() {
assert!(mismatch_response("req", crate::protocol::PROTOCOL_VERSION, "restart").is_none());
}
#[test]
fn older_server_error_preserves_request_id_and_guidance() {
let response = mismatch_response(
"cli:wait:agent-status",
crate::protocol::PROTOCOL_VERSION - 1,
"Run the session stop command, then restart.",
)
.unwrap();
assert_eq!(response.id, "cli:wait:agent-status");
assert_eq!(response.error.code, "protocol_mismatch");
assert!(response.error.message.contains(&format!(
"client protocol {}",
crate::protocol::PROTOCOL_VERSION
)));
assert!(response.error.message.contains(&format!(
"server protocol {}",
crate::protocol::PROTOCOL_VERSION - 1
)));
assert!(response.error.message.contains("restart"));
}
#[test]
fn newer_server_error_tells_user_to_upgrade_client() {
let response = mismatch_response(
"cli:pane:list",
crate::protocol::PROTOCOL_VERSION + 1,
"unused restart guidance",
)
.unwrap();
assert!(response
.error
.message
.contains("older than server protocol"));
assert!(response.error.message.contains("upgrade the Herdr client"));
assert!(!response.error.message.contains("unused restart guidance"));
}
#[test]
fn reported_error_is_recognizable_without_string_matching() {
assert!(was_reported(&reported_error()));
assert!(!was_reported(&std::io::Error::other(
"protocol mismatch was already reported"
)));
}
}
|
