1use futures::{SinkExt as _, channel::mpsc};
2use gpui::{App, AppContext as _, Entity, Task, Window};
3use http_client::{AsyncBody, HttpClient, Request};
4use jupyter_protocol::{ExecutionState, JupyterKernelspec, JupyterMessage, KernelInfoReply};
5
6use async_tungstenite::tokio::connect_async;
7use async_tungstenite::tungstenite::{client::IntoClientRequest, http::HeaderValue};
8
9use futures::StreamExt;
10use smol::io::AsyncReadExt as _;
11
12use super::{KernelSession, RunningKernel};
13use anyhow::Result;
14use jupyter_websocket_client::{
15 JupyterWebSocket, JupyterWebSocketReader, JupyterWebSocketWriter, KernelLaunchRequest,
16 KernelSpecsResponse, RemoteServer,
17};
18use std::{fmt::Debug, sync::Arc};
19
20#[derive(Debug, Clone)]
21pub struct RemoteKernelSpecification {
22 pub name: String,
23 pub url: String,
24 pub token: String,
25 pub kernelspec: JupyterKernelspec,
26}
27
28pub async fn launch_remote_kernel(
29 remote_server: &RemoteServer,
30 http_client: Arc<dyn HttpClient>,
31 kernel_name: &str,
32 _path: &str,
33) -> Result<String> {
34 //
35 let kernel_launch_request = KernelLaunchRequest {
36 name: kernel_name.to_string(),
37 // Note: since the path we have locally may not be the same as the one on the remote server,
38 // we don't send it. We'll have to evaluate this decision along the way.
39 path: None,
40 };
41
42 let kernel_launch_request = serde_json::to_string(&kernel_launch_request)?;
43
44 let request = Request::builder()
45 .method("POST")
46 .uri(&remote_server.api_url("/kernels"))
47 .header("Authorization", format!("token {}", remote_server.token))
48 .body(AsyncBody::from(kernel_launch_request))?;
49
50 let response = http_client.send(request).await?;
51
52 if !response.status().is_success() {
53 let mut body = String::new();
54 response.into_body().read_to_string(&mut body).await?;
55 anyhow::bail!("Failed to launch kernel: {body}");
56 }
57
58 let mut body = String::new();
59 response.into_body().read_to_string(&mut body).await?;
60
61 let response: jupyter_websocket_client::Kernel = serde_json::from_str(&body)?;
62
63 Ok(response.id)
64}
65
66pub async fn list_remote_kernelspecs(
67 remote_server: RemoteServer,
68 http_client: Arc<dyn HttpClient>,
69) -> Result<Vec<RemoteKernelSpecification>> {
70 let url = remote_server.api_url("/kernelspecs");
71
72 let request = Request::builder()
73 .method("GET")
74 .uri(&url)
75 .header("Authorization", format!("token {}", remote_server.token))
76 .body(AsyncBody::default())?;
77
78 let response = http_client.send(request).await?;
79
80 anyhow::ensure!(
81 response.status().is_success(),
82 "Failed to fetch kernel specs: {}",
83 response.status()
84 );
85 let mut body = response.into_body();
86
87 let mut body_bytes = Vec::new();
88 body.read_to_end(&mut body_bytes).await?;
89
90 let kernel_specs: KernelSpecsResponse = serde_json::from_slice(&body_bytes)?;
91
92 let remote_kernelspecs = kernel_specs
93 .kernelspecs
94 .into_iter()
95 .map(|(name, spec)| RemoteKernelSpecification {
96 name,
97 url: remote_server.base_url.clone(),
98 token: remote_server.token.clone(),
99 kernelspec: spec.spec,
100 })
101 .collect::<Vec<RemoteKernelSpecification>>();
102
103 anyhow::ensure!(!remote_kernelspecs.is_empty(), "No kernel specs found");
104 Ok(remote_kernelspecs)
105}
106
107impl PartialEq for RemoteKernelSpecification {
108 fn eq(&self, other: &Self) -> bool {
109 self.name == other.name && self.url == other.url
110 }
111}
112
113impl Eq for RemoteKernelSpecification {}
114
115pub struct RemoteRunningKernel {
116 remote_server: RemoteServer,
117 _receiving_task: Task<Result<()>>,
118 _routing_task: Task<Result<()>>,
119 http_client: Arc<dyn HttpClient>,
120 pub working_directory: std::path::PathBuf,
121 pub request_tx: mpsc::Sender<JupyterMessage>,
122 pub execution_state: ExecutionState,
123 pub kernel_info: Option<KernelInfoReply>,
124 pub kernel_id: String,
125}
126
127impl RemoteRunningKernel {
128 pub fn new<S: KernelSession + 'static>(
129 kernelspec: RemoteKernelSpecification,
130 working_directory: std::path::PathBuf,
131 session: Entity<S>,
132 window: &mut Window,
133 cx: &mut App,
134 ) -> Task<Result<Box<dyn RunningKernel>>> {
135 let remote_server = RemoteServer {
136 base_url: kernelspec.url,
137 token: kernelspec.token,
138 };
139
140 let http_client = cx.http_client();
141
142 window.spawn(cx, async move |cx| {
143 let kernel_id = launch_remote_kernel(
144 &remote_server,
145 http_client.clone(),
146 &kernelspec.name,
147 working_directory.to_str().unwrap_or_default(),
148 )
149 .await?;
150
151 let ws_url = format!(
152 "{}/api/kernels/{}/channels?token={}",
153 remote_server.base_url.replace("http", "ws"),
154 kernel_id,
155 remote_server.token
156 );
157
158 let mut req: Request<()> = ws_url.into_client_request()?;
159 let headers = req.headers_mut();
160
161 headers.insert(
162 "User-Agent",
163 HeaderValue::from_str(&format!(
164 "Zed/{} ({}; {})",
165 "repl",
166 std::env::consts::OS,
167 std::env::consts::ARCH
168 ))?,
169 );
170
171 let response = connect_async(req).await;
172
173 let (ws_stream, _response) = response?;
174
175 let kernel_socket = JupyterWebSocket { inner: ws_stream };
176
177 let (mut w, mut r): (JupyterWebSocketWriter, JupyterWebSocketReader) =
178 kernel_socket.split();
179
180 let (request_tx, mut request_rx) =
181 futures::channel::mpsc::channel::<JupyterMessage>(100);
182
183 let routing_task = cx.background_spawn({
184 async move {
185 while let Some(message) = request_rx.next().await {
186 w.send(message).await.ok();
187 }
188 Ok(())
189 }
190 });
191
192 let receiving_task = cx.spawn({
193 let session = session.clone();
194
195 async move |cx| {
196 while let Some(message) = r.next().await {
197 match message {
198 Ok(message) => {
199 session
200 .update_in(cx, |session, window, cx| {
201 session.route(&message, window, cx);
202 })
203 .ok();
204 }
205 Err(e) => {
206 log::error!("Error receiving message: {:?}", e);
207 }
208 }
209 }
210 Ok(())
211 }
212 });
213
214 anyhow::Ok(Box::new(Self {
215 _routing_task: routing_task,
216 _receiving_task: receiving_task,
217 remote_server,
218 working_directory,
219 request_tx,
220 // todo(kyle): pull this from the kernel API to start with
221 execution_state: ExecutionState::Idle,
222 kernel_info: None,
223 kernel_id,
224 http_client: http_client.clone(),
225 }) as Box<dyn RunningKernel>)
226 })
227 }
228}
229
230impl Debug for RemoteRunningKernel {
231 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
232 f.debug_struct("RemoteRunningKernel")
233 // custom debug that keeps tokens out of logs
234 .field("remote_server url", &self.remote_server.base_url)
235 .field("working_directory", &self.working_directory)
236 .field("request_tx", &self.request_tx)
237 .field("execution_state", &self.execution_state)
238 .field("kernel_info", &self.kernel_info)
239 .finish()
240 }
241}
242
243impl RunningKernel for RemoteRunningKernel {
244 fn request_tx(&self) -> futures::channel::mpsc::Sender<runtimelib::JupyterMessage> {
245 self.request_tx.clone()
246 }
247
248 fn working_directory(&self) -> &std::path::PathBuf {
249 &self.working_directory
250 }
251
252 fn execution_state(&self) -> &runtimelib::ExecutionState {
253 &self.execution_state
254 }
255
256 fn set_execution_state(&mut self, state: runtimelib::ExecutionState) {
257 self.execution_state = state;
258 }
259
260 fn kernel_info(&self) -> Option<&runtimelib::KernelInfoReply> {
261 self.kernel_info.as_ref()
262 }
263
264 fn set_kernel_info(&mut self, info: runtimelib::KernelInfoReply) {
265 self.kernel_info = Some(info);
266 }
267
268 fn force_shutdown(&mut self, window: &mut Window, cx: &mut App) -> Task<anyhow::Result<()>> {
269 let url = self
270 .remote_server
271 .api_url(&format!("/kernels/{}", self.kernel_id));
272 let token = self.remote_server.token.clone();
273 let http_client = self.http_client.clone();
274
275 window.spawn(cx, async move |_| {
276 let request = Request::builder()
277 .method("DELETE")
278 .uri(&url)
279 .header("Authorization", format!("token {}", token))
280 .body(AsyncBody::default())?;
281
282 let response = http_client.send(request).await?;
283
284 anyhow::ensure!(
285 response.status().is_success(),
286 "Failed to shutdown kernel: {}",
287 response.status()
288 );
289 Ok(())
290 })
291 }
292}