//! A simplified version of lsp base protocol for rpc use std::{ fmt, io::{self, BufRead, Write}, }; use serde::{de::DeserializeOwned, Deserialize, Serialize}; #[derive(Serialize, Deserialize, Debug, Clone)] #[serde(untagged)] pub enum Message { Request(Request), Response(Response), } impl From for Message { fn from(request: Request) -> Message { Message::Request(request) } } impl From for Message { fn from(response: Response) -> Message { Message::Response(response) } } #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] #[serde(transparent)] pub struct RequestId(IdRepr); #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] #[serde(untagged)] enum IdRepr { U64(u64), String(String), } impl From for RequestId { fn from(id: u64) -> RequestId { RequestId(IdRepr::U64(id)) } } impl From for RequestId { fn from(id: String) -> RequestId { RequestId(IdRepr::String(id)) } } impl fmt::Display for RequestId { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match &self.0 { IdRepr::U64(it) => fmt::Display::fmt(it, f), IdRepr::String(it) => fmt::Display::fmt(it, f), } } } #[derive(Debug, Serialize, Deserialize, Clone)] pub struct Request { pub id: RequestId, pub method: String, pub params: serde_json::Value, } #[derive(Debug, Serialize, Deserialize, Clone)] pub struct Response { // JSON RPC allows this to be null if it was impossible // to decode the request's id. Ignore this special case // and just die horribly. pub id: RequestId, #[serde(skip_serializing_if = "Option::is_none")] pub result: Option, #[serde(skip_serializing_if = "Option::is_none")] pub error: Option, } #[derive(Debug, Serialize, Deserialize, Clone)] pub struct ResponseError { pub code: i32, pub message: String, #[serde(skip_serializing_if = "Option::is_none")] pub data: Option, } #[derive(Clone, Copy, Debug)] #[allow(unused)] pub enum ErrorCode { // Defined by JSON RPC ParseError = -32700, InvalidRequest = -32600, MethodNotFound = -32601, InvalidParams = -32602, InternalError = -32603, ServerErrorStart = -32099, ServerErrorEnd = -32000, ServerNotInitialized = -32002, UnknownErrorCode = -32001, // Defined by protocol ExpansionError = -32900, } #[derive(Debug, Serialize, Deserialize, Clone)] pub struct Notification { pub method: String, pub params: serde_json::Value, } impl Message { pub fn read(r: &mut impl BufRead) -> io::Result> { let text = match read_msg_text(r)? { None => return Ok(None), Some(text) => text, }; let msg = serde_json::from_str(&text)?; Ok(Some(msg)) } pub fn write(self, w: &mut impl Write) -> io::Result<()> { #[derive(Serialize)] struct JsonRpc { jsonrpc: &'static str, #[serde(flatten)] msg: Message, } let text = serde_json::to_string(&JsonRpc { jsonrpc: "2.0", msg: self })?; write_msg_text(w, &text) } } impl Response { pub fn new_ok(id: RequestId, result: R) -> Response { Response { id, result: Some(serde_json::to_value(result).unwrap()), error: None } } pub fn new_err(id: RequestId, code: i32, message: String) -> Response { let error = ResponseError { code, message, data: None }; Response { id, result: None, error: Some(error) } } } impl Request { pub fn new(id: RequestId, method: String, params: P) -> Request { Request { id, method, params: serde_json::to_value(params).unwrap() } } pub fn extract(self, method: &str) -> Result<(RequestId, P), Request> { if self.method == method { let params = serde_json::from_value(self.params).unwrap_or_else(|err| { panic!("Invalid request\nMethod: {}\n error: {}", method, err) }); Ok((self.id, params)) } else { Err(self) } } } impl Notification { pub fn new(method: String, params: impl Serialize) -> Notification { Notification { method, params: serde_json::to_value(params).unwrap() } } pub fn extract(self, method: &str) -> Result { if self.method == method { let params = serde_json::from_value(self.params).unwrap(); Ok(params) } else { Err(self) } } } fn read_msg_text(inp: &mut impl BufRead) -> io::Result> { fn invalid_data(error: impl Into>) -> io::Error { io::Error::new(io::ErrorKind::InvalidData, error) } macro_rules! invalid_data { ($($tt:tt)*) => (invalid_data(format!($($tt)*))) } let mut size = None; let mut buf = String::new(); loop { buf.clear(); if inp.read_line(&mut buf)? == 0 { return Ok(None); } if !buf.ends_with("\r\n") { return Err(invalid_data!("malformed header: {:?}", buf)); } let buf = &buf[..buf.len() - 2]; if buf.is_empty() { break; } let mut parts = buf.splitn(2, ": "); let header_name = parts.next().unwrap(); let header_value = parts.next().ok_or_else(|| invalid_data!("malformed header: {:?}", buf))?; if header_name == "Content-Length" { size = Some(header_value.parse::().map_err(invalid_data)?); } } let size: usize = size.ok_or_else(|| invalid_data!("no Content-Length"))?; let mut buf = buf.into_bytes(); buf.resize(size, 0); inp.read_exact(&mut buf)?; let buf = String::from_utf8(buf).map_err(invalid_data)?; log::debug!("< {}", buf); Ok(Some(buf)) } fn write_msg_text(out: &mut impl Write, msg: &str) -> io::Result<()> { log::debug!("> {}", msg); write!(out, "Content-Length: {}\r\n\r\n", msg.len())?; out.write_all(msg.as_bytes())?; out.flush()?; Ok(()) }