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