Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Client for VSCode Debug Plugin #829

Merged
merged 20 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ otel = ["dep:opentelemetry", "dep:opentelemetry_sdk", "dep:opentelemetry-otlp",
"dep:opentelemetry-prometheus", "dep:hyper", "dep:hyper-util", "dep:http-body-util"]
tokio-console = ["console-subscriber"]
ephemeral-server = ["dep:flate2", "dep:reqwest", "dep:tar", "dep:zip"]
debug-plugin = ["dep:reqwest"]

[dependencies]
anyhow = "1.0"
Expand Down
72 changes: 72 additions & 0 deletions core/src/debug_client.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
//! Defines an http client that is used for the VSCode debug plugin and any other associated
//! machinery.

use anyhow::Context;
use prost::Message;
use reqwest;
use std::time::Duration;
use temporal_sdk_core_protos::temporal::api::history::v1::History;
use url::Url;

const CLIENT_NAME: &str = "temporal-core";
const CLIENT_VERSION: &str = "0.1.0";

/// A client for interacting with the VSCode debug plugin
#[derive(Clone)]
pub struct DebugClient {
/// URL for the local instance of the debugger server
debugger_url: Url,
client: reqwest::Client,
}

#[derive(Clone, serde::Serialize)]
struct WFTStartedMsg {
event_id: i64,
}

impl DebugClient {
/// Create a new instance of a DebugClient with the specified url.
pub fn new(url: String) -> Result<DebugClient, anyhow::Error> {
Ok(DebugClient {
debugger_url: Url::parse(&url).context(
"debugger url malformed, is the TEMPORAL_DEBUGGER_PLUGIN_URL env var correct?",
)?,
client: reqwest::Client::new(),
})
}

/// Get the history from the instance of the debug plugin server
pub async fn get_history(&self) -> Result<History, anyhow::Error> {
let url = self.debugger_url.join("history")?;
let resp = self
.client
.get(url)
.header("Temporal-Client-Name", CLIENT_NAME)
.header("Temporal-Client-Version", CLIENT_VERSION)
Sushisource marked this conversation as resolved.
Show resolved Hide resolved
Sushisource marked this conversation as resolved.
Show resolved Hide resolved
.send()
.await?;

let bytes = resp.bytes().await?;
Ok(History::decode(bytes)?)
}

/// Post to current-wft-started to tell the debug plugin which event we've most recently made it
/// to
pub async fn post_wft_started(
&self,
event_id: &i64,
) -> Result<reqwest::Response, anyhow::Error> {
let url = self.debugger_url.join("current-wft-started")?;
Ok(self
.client
.get(url)
.header("Temporal-Client-Name", CLIENT_NAME)
.header("Temporal-Client-Version", CLIENT_VERSION)
.timeout(Duration::from_secs(5))
.json(&WFTStartedMsg {
event_id: *event_id,
})
.send()
.await?)
}
}
2 changes: 2 additions & 0 deletions core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ extern crate tracing;
extern crate core;

mod abstractions;
#[cfg(feature = "debug-plugin")]
pub mod debug_client;
#[cfg(feature = "ephemeral-server")]
pub mod ephemeral_server;
mod internal_flags;
Expand Down
Loading