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