Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions rust/src/errors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ use std::borrow::{Borrow, Cow};
use std::fmt;
use std::time::Duration;

use serde_json::Value;

use crate::types::SessionId;

/// Crate-specific [`Result`](std::result::Result).
Expand Down Expand Up @@ -252,6 +254,7 @@ impl fmt::Display for ErrorKind {
/// Errors returned by the SDK.
pub struct Error {
repr: Repr<ErrorKind>,
rpc_data: Option<Box<Value>>,
// Only `Some` when `RUST_BACKTRACE` is set; boxed so the `Some` variant
// doesn't inflate `Error` beyond `clippy::result_large_err` limits.
backtrace: Option<Box<Backtrace>>,
Expand All @@ -268,6 +271,7 @@ impl Error {
kind,
error: error.into(),
}),
rpc_data: None,
backtrace: capture_backtrace(),
}
}
Expand Down Expand Up @@ -297,6 +301,18 @@ impl Error {
{
Self {
repr: Repr::SimpleMessage(kind, message.into()),
rpc_data: None,
backtrace: capture_backtrace(),
}
}

pub(crate) fn from_rpc<C>(code: i32, message: C, data: Option<Value>) -> Self
where
C: Into<Cow<'static, str>>,
{
Self {
repr: Repr::SimpleMessage(ErrorKind::Rpc { code }, message.into()),
rpc_data: data.map(Box::new),
backtrace: capture_backtrace(),
}
}
Expand All @@ -319,6 +335,11 @@ impl Error {
_ => None,
}
}

/// Returns the structured JSON-RPC error data provided by the CLI, if any.
pub fn rpc_data(&self) -> Option<&Value> {
self.rpc_data.as_deref()
}
}

impl fmt::Display for Error {
Expand All @@ -341,6 +362,9 @@ impl fmt::Debug for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut dbg = f.debug_struct("Error");
dbg.field("context", &self.repr);
if let Some(rpc_data) = &self.rpc_data {
dbg.field("rpc_data", rpc_data);
}
if let Some(backtrace) = &self.backtrace {
return dbg.field("backtrace", backtrace).finish();
}
Expand All @@ -361,6 +385,7 @@ impl From<ErrorKind> for Error {
fn from(kind: ErrorKind) -> Self {
Self {
repr: Repr::Simple(kind),
rpc_data: None,
backtrace: capture_backtrace(),
}
}
Expand Down
5 changes: 1 addition & 4 deletions rust/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2321,10 +2321,7 @@ impl Client {
))
.into());
}
return Err(Error::with_message(
ErrorKind::Rpc { code: err.code },
err.message,
));
return Err(Error::from_rpc(err.code, err.message, err.data));
}
Ok(response.result.unwrap_or(serde_json::Value::Null))
}
Expand Down
66 changes: 65 additions & 1 deletion rust/tests/prepared_session_test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,22 @@ impl FakeServer {
}

async fn respond_error(&mut self, request: &Value, code: i64, message: &str) {
self.respond_error_with_data(request, code, message, None)
.await;
}

async fn respond_error_with_data(
&mut self,
request: &Value,
code: i64,
message: &str,
data: Option<Value>,
) {
let id = request["id"].as_u64().unwrap();
let response = json!({
"jsonrpc": "2.0",
"id": id,
"error": { "code": code, "message": message },
"error": { "code": code, "message": message, "data": data },
});
write_framed(&mut self.write, &serde_json::to_vec(&response).unwrap()).await;
}
Expand Down Expand Up @@ -178,6 +189,59 @@ fn cloud_options() -> CloudSessionOptions {
CloudSessionOptions::with_repository(CloudSessionRepository::new("octocat", "hello-world"))
}

#[tokio::test]
async fn client_call_preserves_structured_rpc_error_data() {
let (client, mut server) = make_client();
let call = tokio::spawn({
let client = client.clone();
async move { client.call("session.raw", None).await }
});

let request = server.read_request().await;
let data = json!({
"code": "managed_policy_blocked",
"setting": "extensions",
"message": "Extensions are disabled by policy",
});
server
.respond_error_with_data(
&request,
-32001,
"managed policy blocked",
Some(data.clone()),
)
.await;

let error = timeout(TIMEOUT, call).await.unwrap().unwrap().unwrap_err();
assert_eq!(error.rpc_code(), Some(-32001));
assert_eq!(error.message(), Some("managed policy blocked"));
assert_eq!(error.rpc_data(), Some(&data));
assert_eq!(
error.to_string(),
"RPC error -32001: managed policy blocked"
);
}

#[tokio::test]
async fn client_call_handles_rpc_error_without_data() {
let (client, mut server) = make_client();
let call = tokio::spawn({
let client = client.clone();
async move { client.call("session.raw", None).await }
});

let request = server.read_request().await;
server
.respond_error(&request, -32002, "request failed")
.await;

let error = timeout(TIMEOUT, call).await.unwrap().unwrap().unwrap_err();
assert_eq!(error.rpc_code(), Some(-32002));
assert_eq!(error.message(), Some("request failed"));
assert_eq!(error.rpc_data(), None);
assert_eq!(error.to_string(), "RPC error -32002: request failed");
}

fn create_result(session_id: &str) -> Value {
json!({ "sessionId": session_id, "workspacePath": "/tmp/workspace" })
}
Expand Down
Loading