Move the full reply to its own file, but use KernelInfoReply name everywhere

Author: DavisVaughan

crates/amalthea/src/socket/shell.rs

@@ -42,7 +42,7 @@ use crate::wire::jupyter_message::JupyterMessage;
 use crate::wire::jupyter_message::Message;
 use crate::wire::jupyter_message::ProtocolMessage;
 use crate::wire::jupyter_message::Status;
-use crate::wire::kernel_info_reply::KernelInfoReplyFull;
+use crate::wire::kernel_info_full_reply;
 use crate::wire::originator::Originator;
 use crate::wire::status::ExecutionState;
 use crate::wire::status::KernelStatus;
@@ -128,9 +128,8 @@ impl Shell {
         let shell_handler = &mut self.shell_handler.borrow_mut();
         match msg {
             Message::KernelInfoRequest(req) => self.handle_request(req.clone(), |msg| {
-                let reply: KernelInfoReplyFull =
-                    block_on(shell_handler.handle_info_request(msg))?.into();
-                Ok(reply)
+                block_on(shell_handler.handle_info_request(msg))
+                    .map(kernel_info_full_reply::KernelInfoReply::from)
             }),
             Message::IsCompleteRequest(req) => self.handle_request(req, |msg| {
                 block_on(shell_handler.handle_is_complete_request(msg))

crates/amalthea/src/wire/jupyter_message.rs

@@ -11,7 +11,7 @@ use serde::Serialize;
 use super::display_data::DisplayData;
 use super::handshake_reply::HandshakeReply;
 use super::handshake_request::HandshakeRequest;
-use super::kernel_info_reply::KernelInfoReplyFull;
+use super::kernel_info_full_reply::KernelInfoReply;
 use super::stream::StreamOutput;
 use super::update_display_data::UpdateDisplayData;
 use super::welcome::Welcome;
@@ -81,7 +81,7 @@ impl<T> ProtocolMessage for T where T: MessageType + Serialize + std::fmt::Debug
 #[derive(Debug)]
 pub enum Message {
     // Shell
-    KernelInfoReply(JupyterMessage<KernelInfoReplyFull>),
+    KernelInfoReply(JupyterMessage<KernelInfoReply>),
     KernelInfoRequest(JupyterMessage<KernelInfoRequest>),
     CompleteReply(JupyterMessage<CompleteReply>),
     CompleteRequest(JupyterMessage<CompleteRequest>),
@@ -197,7 +197,7 @@ impl TryFrom<&WireMessage> for Message {
         if kind == KernelInfoRequest::message_type() {
             return Ok(Message::KernelInfoRequest(JupyterMessage::try_from(msg)?));
         }
-        if kind == KernelInfoReplyFull::message_type() {
+        if kind == KernelInfoReply::message_type() {
             return Ok(Message::KernelInfoReply(JupyterMessage::try_from(msg)?));
         }
         if kind == IsCompleteRequest::message_type() {

crates/amalthea/src/wire/kernel_info_full_reply.rs

@@ -0,0 +1,69 @@
+/*
+ * kernel_info_full_reply.rs
+ *
+ * Copyright (C) 2024 Posit Software, PBC. All rights reserved.
+ *
+ */
+
+use serde::Deserialize;
+use serde::Serialize;
+
+use crate::wire::help_link::HelpLink;
+use crate::wire::jupyter_message::MessageType;
+use crate::wire::jupyter_message::Status;
+use crate::wire::kernel_info_reply;
+use crate::wire::language_info::LanguageInfo;
+
+/// Complete version of `kernel_info_reply`
+///
+/// Private to Amalthea. Includes fields owned by Amalthea such as the protocol
+/// version and feature flags.
+///
+/// Kernel authors should use [kernel_info_reply::KernelInfoReply] instead.
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct KernelInfoReply {
+    /// Version of messaging protocol
+    pub protocol_version: String,
+
+    /// List of feature flags supported by the kernel. See JEP 92.
+    pub supported_features: Vec<String>,
+
+    /// The execution status ("ok" or "error")
+    pub status: Status,
+
+    /// Information about the language the kernel supports
+    pub language_info: LanguageInfo,
+
+    /// A startup banner
+    pub banner: String,
+
+    /// Whether debugging is supported
+    pub debugger: bool,
+
+    /// A list of help links
+    pub help_links: Vec<HelpLink>,
+}
+
+impl MessageType for KernelInfoReply {
+    fn message_type() -> String {
+        String::from("kernel_info_reply")
+    }
+}
+
+/// Adds Amalthea fields to partial [kernel_info_reply::KernelInfoReply].
+impl From<kernel_info_reply::KernelInfoReply> for KernelInfoReply {
+    fn from(value: kernel_info_reply::KernelInfoReply) -> Self {
+        Self {
+            // These fields are set by Amalthea
+            protocol_version: String::from("5.4"),
+            supported_features: vec![String::from("iopub_welcome")],
+
+            // These fields are set by the Amalthea user
+            status: value.status,
+            language_info: value.language_info,
+            banner: value.banner,
+            debugger: value.debugger,
+            help_links: value.help_links,
+        }
+    }
+}

crates/amalthea/src/wire/kernel_info_reply.rs

@@ -1,49 +1,23 @@
 /*
  * kernel_info_reply.rs
  *
- * Copyright (C) 2022 Posit Software, PBC. All rights reserved.
+ * Copyright (C) 2022-2024 Posit Software, PBC. All rights reserved.
  *
  */
 
 use serde::Deserialize;
 use serde::Serialize;
 
 use crate::wire::help_link::HelpLink;
-use crate::wire::jupyter_message::MessageType;
 use crate::wire::jupyter_message::Status;
 use crate::wire::language_info::LanguageInfo;
 
-/// Represents a reply to a kernel_info_request
-#[derive(Debug, Serialize, Deserialize, Clone)]
-pub struct KernelInfoReply {
-    /// The execution status ("ok" or "error")
-    pub status: Status,
-
-    /// Information about the language the kernel supports
-    pub language_info: LanguageInfo,
-
-    /// A startup banner
-    pub banner: String,
-
-    /// Whether debugging is supported
-    pub debugger: bool,
-
-    /// A list of help links
-    pub help_links: Vec<HelpLink>,
-}
-
-/// Complete version of `kernel_info_request`.
+/// Represents a reply to a `kernel_info_request`
 ///
-/// Private to Amalthea. Includes fields owned by Amalthea such as the protocol
-/// version and feature flags
+/// When implementing a kernel, use this struct. Amalthea is in charge of
+/// providing the `protocol_version` to complete the reply.
 #[derive(Debug, Serialize, Deserialize, Clone)]
-pub struct KernelInfoReplyFull {
-    /// Version of messaging protocol
-    pub protocol_version: String,
-
-    /// List of feature flags supported by the kernel. See JEP 92.
-    pub supported_features: Vec<String>,
-
+pub struct KernelInfoReply {
     /// The execution status ("ok" or "error")
     pub status: Status,
 
@@ -59,27 +33,3 @@ pub struct KernelInfoReplyFull {
     /// A list of help links
     pub help_links: Vec<HelpLink>,
 }
-
-impl MessageType for KernelInfoReplyFull {
-    fn message_type() -> String {
-        String::from("kernel_info_reply")
-    }
-}
-
-/// Adds Amalthea fields to `KernelInfoReply`.
-impl From<KernelInfoReply> for KernelInfoReplyFull {
-    fn from(value: KernelInfoReply) -> Self {
-        Self {
-            // These fields are set by Amalthea
-            protocol_version: String::from("5.4"),
-            supported_features: vec![String::from("iopub_welcome")],
-
-            // These fields are set by the Amalthea user
-            status: value.status,
-            language_info: value.language_info,
-            banner: value.banner,
-            debugger: value.debugger,
-            help_links: value.help_links,
-        }
-    }
-}

crates/amalthea/src/wire/mod.rs

@@ -34,6 +34,7 @@ pub mod interrupt_request;
 pub mod is_complete_reply;
 pub mod is_complete_request;
 pub mod jupyter_message;
+pub mod kernel_info_full_reply;
 pub mod kernel_info_reply;
 pub mod kernel_info_request;
 pub mod language_info;