Skip to content
Open
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
4 changes: 3 additions & 1 deletion codex-rs/app-server-protocol/schema/json/JSONRPCError.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion codex-rs/app-server-protocol/schema/json/JSONRPCMessage.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion codex-rs/app-server-protocol/schema/json/JSONRPCRequest.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

164 changes: 164 additions & 0 deletions codex-rs/app-server-protocol/src/jsonrpc_lite.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ pub enum JSONRPCMessage {

/// A request that expects a response.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema, TS)]
#[serde(deny_unknown_fields)]
pub struct JSONRPCRequest {
pub id: RequestId,
pub method: String,
Expand All @@ -57,6 +58,7 @@ pub struct JSONRPCRequest {

/// A notification which does not expect a response.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema, TS)]
#[serde(deny_unknown_fields)]
pub struct JSONRPCNotification {
pub method: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
Expand All @@ -66,23 +68,185 @@ pub struct JSONRPCNotification {

/// A successful (non-error) response to a request.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema, TS)]
#[serde(deny_unknown_fields)]
pub struct JSONRPCResponse {
pub id: RequestId,
pub result: Result,
}

/// A response to a request that indicates an error occurred.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema, TS)]
#[serde(deny_unknown_fields)]
pub struct JSONRPCError {
pub error: JSONRPCErrorError,
pub id: RequestId,
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema, TS)]
#[serde(deny_unknown_fields)]
pub struct JSONRPCErrorError {
pub code: i64,
#[serde(default, skip_serializing_if = "Option::is_none")]
#[ts(optional)]
pub data: Option<serde_json::Value>,
pub message: String,
}

#[cfg(test)]
mod tests {
use super::*;
use pretty_assertions::assert_eq;
use serde_json::json;

fn trace_context() -> W3cTraceContext {
W3cTraceContext {
traceparent: Some(
"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01".to_string(),
),
tracestate: Some("vendor=value".to_string()),
}
}

#[test]
fn request_round_trips_with_integer_id_params_and_trace() {
let request = JSONRPCRequest {
id: RequestId::Integer(7),
method: "thread/read".to_string(),
params: Some(json!({ "threadId": "thread-1" })),
trace: Some(trace_context()),
};

let value = serde_json::to_value(&request).expect("serialize request");
assert_eq!(
value,
json!({
"id": 7,
"method": "thread/read",
"params": { "threadId": "thread-1" },
"trace": {
"traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
"tracestate": "vendor=value",
},
})
);

let message: JSONRPCMessage = serde_json::from_value(value).expect("deserialize message");
assert_eq!(message, JSONRPCMessage::Request(request));
}

#[test]
fn request_omits_absent_optional_fields() {
let request = JSONRPCRequest {
id: RequestId::String("req-1".to_string()),
method: "thread/list".to_string(),
params: None,
trace: None,
};

let value = serde_json::to_value(&request).expect("serialize request");
assert_eq!(
value,
json!({
"id": "req-1",
"method": "thread/list",
})
);

let decoded: JSONRPCRequest = serde_json::from_value(value).expect("deserialize request");
assert_eq!(decoded, request);
}

#[test]
fn message_deserializes_notification_without_id() {
let value = json!({
"method": "thread/subscribe",
"params": { "threadId": "thread-1" },
});

let message: JSONRPCMessage = serde_json::from_value(value).expect("deserialize message");
assert_eq!(
message,
JSONRPCMessage::Notification(JSONRPCNotification {
method: "thread/subscribe".to_string(),
params: Some(json!({ "threadId": "thread-1" })),
})
);
}

#[test]
fn message_deserializes_success_response() {
let value = json!({
"id": "req-1",
"result": { "ok": true },
});

let message: JSONRPCMessage = serde_json::from_value(value).expect("deserialize message");
assert_eq!(
message,
JSONRPCMessage::Response(JSONRPCResponse {
id: RequestId::String("req-1".to_string()),
result: json!({ "ok": true }),
})
);
}

#[test]
fn message_deserializes_error_response_with_data() {
let value = json!({
"id": 9,
"error": {
"code": -32602,
"message": "invalid params",
"data": { "field": "threadId" },
},
});

let message: JSONRPCMessage = serde_json::from_value(value).expect("deserialize message");
assert_eq!(
message,
JSONRPCMessage::Error(JSONRPCError {
id: RequestId::Integer(9),
error: JSONRPCErrorError {
code: -32602,
message: "invalid params".to_string(),
data: Some(json!({ "field": "threadId" })),
},
})
);
}

#[test]
fn request_id_display_matches_wire_value() {
assert_eq!(RequestId::String("req-1".to_string()).to_string(), "req-1");
assert_eq!(RequestId::Integer(42).to_string(), "42");
}

#[test]
fn message_rejects_request_with_response_fields() {
let value = json!({
"id": 7,
"method": "thread/read",
"params": { "threadId": "thread-1" },
"result": { "ok": true },
});

serde_json::from_value::<JSONRPCMessage>(value)
.expect_err("request with response result should be invalid");
}

#[test]
fn message_rejects_request_with_error_fields() {
let value = json!({
"id": 7,
"method": "thread/read",
"params": { "threadId": "thread-1" },
"error": {
"code": -32603,
"message": "internal error",
},
});

serde_json::from_value::<JSONRPCMessage>(value)
.expect_err("request with response error should be invalid");
}
}