
This PR introduces a unified interface for both native and remote kernels through the `RunningKernel` trait. When either the native kernel or the remote kernels are started, they return a `Box<dyn RunningKernel>` to make it easier to work with the session. As a bonus of this refactor, I've dropped some of the mpsc channels to instead opt for passing messages directly to `session.route(message)`. There was a lot of simplification of `Session` by moving responsibilities to `NativeRunningKernel`. No release notes yet until this is finalized. * [x] Detect remote kernelspecs from configured remote servers * [x] Launch kernel on demand For now, this allows you to set env vars `JUPYTER_SERVER` and `JUPYTER_TOKEN` to access a remote server. `JUPYTER_SERVER` should be a base path like `http://localhost:8888` or `https://notebooks.gesis.org/binder/jupyter/user/rubydata-binder-w6igpy4l/` Release Notes: - N/A
285 lines
9.1 KiB
Rust
285 lines
9.1 KiB
Rust
use futures::{channel::mpsc, SinkExt as _};
|
|
use gpui::{Task, View, WindowContext};
|
|
use http_client::{AsyncBody, HttpClient, Request};
|
|
use jupyter_protocol::{ExecutionState, JupyterMessage, KernelInfoReply};
|
|
use runtimelib::JupyterKernelspec;
|
|
|
|
use futures::StreamExt;
|
|
use smol::io::AsyncReadExt as _;
|
|
|
|
use crate::Session;
|
|
|
|
use super::RunningKernel;
|
|
use anyhow::Result;
|
|
use jupyter_websocket_client::{
|
|
JupyterWebSocketReader, JupyterWebSocketWriter, KernelLaunchRequest, KernelSpecsResponse,
|
|
RemoteServer,
|
|
};
|
|
use std::{fmt::Debug, sync::Arc};
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct RemoteKernelSpecification {
|
|
pub name: String,
|
|
pub url: String,
|
|
pub token: String,
|
|
pub kernelspec: JupyterKernelspec,
|
|
}
|
|
|
|
pub async fn launch_remote_kernel(
|
|
remote_server: &RemoteServer,
|
|
http_client: Arc<dyn HttpClient>,
|
|
kernel_name: &str,
|
|
_path: &str,
|
|
) -> Result<String> {
|
|
//
|
|
let kernel_launch_request = KernelLaunchRequest {
|
|
name: kernel_name.to_string(),
|
|
// todo: add path to runtimelib
|
|
// path,
|
|
};
|
|
|
|
let kernel_launch_request = serde_json::to_string(&kernel_launch_request)?;
|
|
|
|
let request = Request::builder()
|
|
.method("POST")
|
|
.uri(&remote_server.api_url("/kernels"))
|
|
.header("Authorization", format!("token {}", remote_server.token))
|
|
.body(AsyncBody::from(kernel_launch_request))?;
|
|
|
|
let response = http_client.send(request).await?;
|
|
|
|
if !response.status().is_success() {
|
|
let mut body = String::new();
|
|
response.into_body().read_to_string(&mut body).await?;
|
|
return Err(anyhow::anyhow!("Failed to launch kernel: {}", body));
|
|
}
|
|
|
|
let mut body = String::new();
|
|
response.into_body().read_to_string(&mut body).await?;
|
|
|
|
let response: jupyter_websocket_client::Kernel = serde_json::from_str(&body)?;
|
|
|
|
Ok(response.id)
|
|
}
|
|
|
|
pub async fn list_remote_kernelspecs(
|
|
remote_server: RemoteServer,
|
|
http_client: Arc<dyn HttpClient>,
|
|
) -> Result<Vec<RemoteKernelSpecification>> {
|
|
let url = remote_server.api_url("/kernelspecs");
|
|
|
|
let request = Request::builder()
|
|
.method("GET")
|
|
.uri(&url)
|
|
.header("Authorization", format!("token {}", remote_server.token))
|
|
.body(AsyncBody::default())?;
|
|
|
|
let response = http_client.send(request).await?;
|
|
|
|
if response.status().is_success() {
|
|
let mut body = response.into_body();
|
|
|
|
let mut body_bytes = Vec::new();
|
|
body.read_to_end(&mut body_bytes).await?;
|
|
|
|
let kernel_specs: KernelSpecsResponse = serde_json::from_slice(&body_bytes)?;
|
|
|
|
let remote_kernelspecs = kernel_specs
|
|
.kernelspecs
|
|
.into_iter()
|
|
.map(|(name, spec)| RemoteKernelSpecification {
|
|
name: name.clone(),
|
|
url: remote_server.base_url.clone(),
|
|
token: remote_server.token.clone(),
|
|
// todo: line up the jupyter kernelspec from runtimelib with
|
|
// the kernelspec pulled from the API
|
|
//
|
|
// There are _small_ differences, so we may just want a impl `From`
|
|
kernelspec: JupyterKernelspec {
|
|
argv: spec.spec.argv,
|
|
display_name: spec.spec.display_name,
|
|
language: spec.spec.language,
|
|
// todo: fix up mismatch in types here
|
|
metadata: None,
|
|
interrupt_mode: None,
|
|
env: None,
|
|
},
|
|
})
|
|
.collect::<Vec<RemoteKernelSpecification>>();
|
|
|
|
if remote_kernelspecs.is_empty() {
|
|
Err(anyhow::anyhow!("No kernel specs found"))
|
|
} else {
|
|
Ok(remote_kernelspecs.clone())
|
|
}
|
|
} else {
|
|
Err(anyhow::anyhow!(
|
|
"Failed to fetch kernel specs: {}",
|
|
response.status()
|
|
))
|
|
}
|
|
}
|
|
|
|
impl PartialEq for RemoteKernelSpecification {
|
|
fn eq(&self, other: &Self) -> bool {
|
|
self.name == other.name && self.url == other.url
|
|
}
|
|
}
|
|
|
|
impl Eq for RemoteKernelSpecification {}
|
|
|
|
pub struct RemoteRunningKernel {
|
|
remote_server: RemoteServer,
|
|
_receiving_task: Task<Result<()>>,
|
|
_routing_task: Task<Result<()>>,
|
|
http_client: Arc<dyn HttpClient>,
|
|
pub working_directory: std::path::PathBuf,
|
|
pub request_tx: mpsc::Sender<JupyterMessage>,
|
|
pub execution_state: ExecutionState,
|
|
pub kernel_info: Option<KernelInfoReply>,
|
|
pub kernel_id: String,
|
|
}
|
|
|
|
impl RemoteRunningKernel {
|
|
pub fn new(
|
|
kernelspec: RemoteKernelSpecification,
|
|
working_directory: std::path::PathBuf,
|
|
session: View<Session>,
|
|
cx: &mut WindowContext,
|
|
) -> Task<Result<Box<dyn RunningKernel>>> {
|
|
let remote_server = RemoteServer {
|
|
base_url: kernelspec.url,
|
|
token: kernelspec.token,
|
|
};
|
|
|
|
let http_client = cx.http_client();
|
|
|
|
cx.spawn(|cx| async move {
|
|
let kernel_id = launch_remote_kernel(
|
|
&remote_server,
|
|
http_client.clone(),
|
|
&kernelspec.name,
|
|
working_directory.to_str().unwrap_or_default(),
|
|
)
|
|
.await?;
|
|
|
|
let kernel_socket = remote_server.connect_to_kernel(&kernel_id).await?;
|
|
|
|
let (mut w, mut r): (JupyterWebSocketWriter, JupyterWebSocketReader) =
|
|
kernel_socket.split();
|
|
|
|
let (request_tx, mut request_rx) =
|
|
futures::channel::mpsc::channel::<JupyterMessage>(100);
|
|
|
|
let routing_task = cx.background_executor().spawn({
|
|
async move {
|
|
while let Some(message) = request_rx.next().await {
|
|
w.send(message).await.ok();
|
|
}
|
|
Ok(())
|
|
}
|
|
});
|
|
|
|
let receiving_task = cx.spawn({
|
|
let session = session.clone();
|
|
|
|
|mut cx| async move {
|
|
while let Some(message) = r.next().await {
|
|
match message {
|
|
Ok(message) => {
|
|
session
|
|
.update(&mut cx, |session, cx| {
|
|
session.route(&message, cx);
|
|
})
|
|
.ok();
|
|
}
|
|
Err(e) => {
|
|
log::error!("Error receiving message: {:?}", e);
|
|
}
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|
|
});
|
|
|
|
anyhow::Ok(Box::new(Self {
|
|
_routing_task: routing_task,
|
|
_receiving_task: receiving_task,
|
|
remote_server,
|
|
working_directory,
|
|
request_tx,
|
|
// todo(kyle): pull this from the kernel API to start with
|
|
execution_state: ExecutionState::Idle,
|
|
kernel_info: None,
|
|
kernel_id,
|
|
http_client: http_client.clone(),
|
|
}) as Box<dyn RunningKernel>)
|
|
})
|
|
}
|
|
}
|
|
|
|
impl Debug for RemoteRunningKernel {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
f.debug_struct("RemoteRunningKernel")
|
|
// custom debug that keeps tokens out of logs
|
|
.field("remote_server url", &self.remote_server.base_url)
|
|
.field("working_directory", &self.working_directory)
|
|
.field("request_tx", &self.request_tx)
|
|
.field("execution_state", &self.execution_state)
|
|
.field("kernel_info", &self.kernel_info)
|
|
.finish()
|
|
}
|
|
}
|
|
|
|
impl RunningKernel for RemoteRunningKernel {
|
|
fn request_tx(&self) -> futures::channel::mpsc::Sender<runtimelib::JupyterMessage> {
|
|
self.request_tx.clone()
|
|
}
|
|
|
|
fn working_directory(&self) -> &std::path::PathBuf {
|
|
&self.working_directory
|
|
}
|
|
|
|
fn execution_state(&self) -> &runtimelib::ExecutionState {
|
|
&self.execution_state
|
|
}
|
|
|
|
fn set_execution_state(&mut self, state: runtimelib::ExecutionState) {
|
|
self.execution_state = state;
|
|
}
|
|
|
|
fn kernel_info(&self) -> Option<&runtimelib::KernelInfoReply> {
|
|
self.kernel_info.as_ref()
|
|
}
|
|
|
|
fn set_kernel_info(&mut self, info: runtimelib::KernelInfoReply) {
|
|
self.kernel_info = Some(info);
|
|
}
|
|
|
|
fn force_shutdown(&mut self, cx: &mut WindowContext) -> Task<anyhow::Result<()>> {
|
|
let url = self
|
|
.remote_server
|
|
.api_url(&format!("/kernels/{}", self.kernel_id));
|
|
let token = self.remote_server.token.clone();
|
|
let http_client = self.http_client.clone();
|
|
|
|
cx.spawn(|_| async move {
|
|
let request = Request::builder()
|
|
.method("DELETE")
|
|
.uri(&url)
|
|
.header("Authorization", format!("token {}", token))
|
|
.body(AsyncBody::default())?;
|
|
|
|
let response = http_client.send(request).await?;
|
|
|
|
if response.status().is_success() {
|
|
Ok(())
|
|
} else {
|
|
Err(anyhow::anyhow!(
|
|
"Failed to shutdown kernel: {}",
|
|
response.status()
|
|
))
|
|
}
|
|
})
|
|
}
|
|
}
|