From 6d1c6188f31795e09761d049b9a9ff458f429e41 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Sun, 15 Nov 2026 11:56:16 +0000 Subject: [PATCH] Expose validated single JSON-RPC request inspection --- crates/jsonrpc/src/lib.rs | 22 +++++++++++++--------- crates/jsonrpc/tests/server.rs | 12 ++++++++++++ 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/crates/jsonrpc/src/lib.rs b/crates/jsonrpc/src/lib.rs index 7389869c3..8d2aa6c6e 100644 --- a/crates/jsonrpc/src/lib.rs +++ b/crates/jsonrpc/src/lib.rs @@ -107,6 +107,17 @@ pub struct Request<'a> { pub params: Option<&'a Value>, } +/// Inspect a single request envelope. This validates its JSON-RPC version, method and ID; +/// [`process`] additionally validates parameter shape before dispatching it. +pub fn request(value: &Value) -> Option> { + let object = value.as_object()?; + let id = object.get("id"); + if object.get("jsonrpc").and_then(Value::as_str) != Some("2.0") || !id.is_none_or(|v| v.is_null() || v.is_string() || v.is_i64() || v.is_u64()) { + return None; + } + Some(Request { id, method: object.get("method")?.as_str()?, params: object.get("params") }) +} + /// A JSON-RPC error returned by a method handler. #[derive(Clone, Debug, PartialEq)] pub struct RpcError { @@ -144,15 +155,8 @@ where F: FnMut(Request<'_>) -> Result, N: FnMut(Request<'_>), { - let Some(object) = value.as_object() else { return Some(invalid_request()) }; - let id = object.get("id"); - let valid_id = id.is_none_or(|v| v.is_null() || v.is_string() || v.is_i64() || v.is_u64()); - let method = object.get("method").and_then(Value::as_str); - if object.get("jsonrpc").and_then(Value::as_str) != Some("2.0") || method.is_none() || !valid_id { - return Some(invalid_request()); - } - let Some(method) = method else { return Some(invalid_request()) }; - let request = Request { id, method, params: object.get("params") }; + let Some(request) = request(value) else { return Some(invalid_request()) }; + let id = request.id; if request.params.is_some_and(|v| !v.is_object() && !v.is_array()) { return id.map(|id| error_response(id.clone(), RpcError::new(-32602, "Invalid params"))); } diff --git a/crates/jsonrpc/tests/server.rs b/crates/jsonrpc/tests/server.rs index 2a03d57b4..c2ff1d0d2 100644 --- a/crates/jsonrpc/tests/server.rs +++ b/crates/jsonrpc/tests/server.rs @@ -143,3 +143,15 @@ fn bounded_line_read_propagates_io_errors() { let mut reader = std::io::BufReader::new(Broken); assert!(matches!(craft_jsonrpc::read_line(&mut reader, 1), Err(craft_jsonrpc::LineError::Io(_)))); } + +#[test] +fn inspect_single_request_distinguishes_null_ids_and_invalid_envelopes() { + let request = json!({"jsonrpc":"2.0", "id":null, "method":"ping"}); + let parsed = craft_jsonrpc::request(&request).unwrap(); + assert_eq!(parsed.id, Some(&Value::Null)); + assert_eq!(parsed.method, "ping"); + let notification = json!({"jsonrpc":"2.0", "method":"ping"}); + assert!(craft_jsonrpc::request(¬ification).unwrap().id.is_none()); + assert!(craft_jsonrpc::request(&json!({"jsonrpc":"2.0", "id":false, "method":"ping"})).is_none()); + assert!(craft_jsonrpc::request(&json!({"method":"ping"})).is_none()); +}