serde rename fields

Author: brandonskiser

crates/agent/src/agent/agent_loop/mod.rs

@@ -22,6 +22,7 @@ use protocol::{
     LoopError,
     SendRequestArgs,
     StreamMetadata,
+    StreamResult,
     UserTurnMetadata,
 };
 use serde::{
@@ -124,10 +125,7 @@ pub struct AgentLoop {
 
     /// The current response stream future being received along with it's associated parse state
     #[allow(clippy::type_complexity)]
-    curr_stream: Option<(
-        StreamParseState,
-        Pin<Box<dyn Stream<Item = Result<StreamEvent, StreamError>> + Send>>,
-    )>,
+    curr_stream: Option<(StreamParseState, Pin<Box<dyn Stream<Item = StreamResult> + Send>>)>,
 
     /// List of completed stream parse states
     stream_states: Vec<StreamParseState>,
@@ -434,7 +432,9 @@ impl StreamParseState {
         }
     }
 
-    pub fn next(&mut self, ev: Option<Result<StreamEvent, StreamError>>, buf: &mut Vec<AgentLoopEventKind>) {
+    // pub fn next(&mut self, ev: Option<Result<StreamEvent, StreamError>>, buf: &mut
+    // Vec<AgentLoopEventKind>) {
+    pub fn next(&mut self, ev: Option<StreamResult>, buf: &mut Vec<AgentLoopEventKind>) {
         if self.errored {
             if let Some(ev) = ev {
                 warn!(?ev, "ignoring unexpected event after having received an error");
@@ -457,13 +457,10 @@ impl StreamParseState {
 
         // Pushing low-level stream events in case end users want to consume these directly. Likely
         // not required.
-        match &ev {
-            Ok(e) => buf.push(AgentLoopEventKind::StreamEvent(e.clone())),
-            Err(e) => buf.push(AgentLoopEventKind::StreamError(e.clone())),
-        }
+        buf.push(AgentLoopEventKind::Stream(ev.clone()));
 
         match ev {
-            Ok(s) => match s {
+            StreamResult::Ok(s) => match s {
                 StreamEvent::MessageStart(ev) => {
                     debug_assert!(ev.role == Role::Assistant);
                 },
@@ -543,7 +540,7 @@ impl StreamParseState {
 
             // Parse invariant - we don't expect any further events after receiving a single
             // error.
-            Err(err) => {
+            StreamResult::Err(err) => {
                 debug_assert!(
                     self.stream_err.is_none(),
                     "Only one stream error event is expected. Previously found: {:?}, just received: {:?}",

crates/agent/src/agent/agent_loop/model.rs

@@ -7,10 +7,9 @@ use serde::{
 };
 use tokio_util::sync::CancellationToken;
 
+use super::protocol::StreamResult;
 use super::types::{
     Message,
-    StreamError,
-    StreamEvent,
     ToolSpec,
 };
 use crate::agent::rts::RtsModel;
@@ -26,7 +25,7 @@ pub trait Model: std::fmt::Debug + Send + Sync + 'static {
         tool_specs: Option<Vec<ToolSpec>>,
         system_prompt: Option<String>,
         cancel_token: CancellationToken,
-    ) -> Pin<Box<dyn Stream<Item = Result<StreamEvent, StreamError>> + Send + 'static>>;
+    ) -> Pin<Box<dyn Stream<Item = StreamResult> + Send + 'static>>;
 
     /// Dump serializable state required by the model implementation.
     ///
@@ -82,7 +81,7 @@ impl Model for Models {
         tool_specs: Option<Vec<ToolSpec>>,
         system_prompt: Option<String>,
         cancel_token: CancellationToken,
-    ) -> Pin<Box<dyn Stream<Item = Result<StreamEvent, StreamError>> + Send + 'static>> {
+    ) -> Pin<Box<dyn Stream<Item = StreamResult> + Send + 'static>> {
         match self {
             Models::Rts(rts_model) => rts_model.stream(messages, tool_specs, system_prompt, cancel_token),
             Models::Test(test_model) => test_model.stream(messages, tool_specs, system_prompt, cancel_token),
@@ -106,7 +105,7 @@ impl Model for TestModel {
         _tool_specs: Option<Vec<ToolSpec>>,
         _system_prompt: Option<String>,
         _cancel_token: CancellationToken,
-    ) -> Pin<Box<dyn Stream<Item = Result<StreamEvent, StreamError>> + Send + 'static>> {
+    ) -> Pin<Box<dyn Stream<Item = StreamResult> + Send + 'static>> {
         panic!("unimplemented")
     }
 }

crates/agent/src/agent/agent_loop/protocol.rs

@@ -95,6 +95,8 @@ impl AgentLoopEvent {
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(tag = "kind", content = "content")]
+#[serde(rename_all = "camelCase")]
 pub enum AgentLoopEventKind {
     /// Text returned by the assistant.
     AssistantText(String),
@@ -139,12 +141,26 @@ pub enum AgentLoopEventKind {
     ///
     /// This reflects the exact event the agent loop parses from a [Model::stream] response as part
     /// of executing a user turn.
-    StreamEvent(StreamEvent),
-    /// Low level event. Generally only useful for [AgentLoop].
-    ///
-    /// This reflects the exact event the agent loop parses from a [Model::stream] response as part
-    /// of executing a user turn.
-    StreamError(StreamError),
+    // Stream(StreamResult<StreamEvent, StreamError>),
+    Stream(StreamResult),
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(tag = "result")]
+#[serde(rename_all = "lowercase")]
+pub enum StreamResult {
+    Ok(StreamEvent),
+    #[serde(rename = "error")]
+    Err(StreamError),
+}
+
+impl StreamResult {
+    pub fn unwrap_err(self) -> StreamError {
+        match self {
+            StreamResult::Ok(t) => panic!("called `StreamResult::unwrap_err()` on an `Ok` value: {:?}", &t),
+            StreamResult::Err(e) => e,
+        }
+    }
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, thiserror::Error)]

crates/agent/src/agent/agent_loop/types.rs

@@ -107,6 +107,7 @@ impl std::error::Error for StreamError {
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
 pub enum StreamErrorKind {
     /// The request failed due to the context window overflowing.
     ///
@@ -245,7 +246,7 @@ impl Message {
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 pub enum ContentBlock {
     Text(String),
     ToolUse(ToolUseBlock),

crates/agent/src/agent/protocol.rs

@@ -26,6 +26,8 @@ use super::types::AgentSnapshot;
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[allow(clippy::large_enum_variant)]
+#[serde(tag = "kind", content = "content")]
+#[serde(rename_all = "camelCase")]
 pub enum AgentEvent {
     /// Agent has finished initialization, and is ready to receive requests.
     ///