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

Debugger Client in core #804

Closed
wants to merge 17 commits into from
Closed
Show file tree
Hide file tree
Changes from all 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
76 changes: 76 additions & 0 deletions core/src/debug_client.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
//! This module contains code for an http client that is used for the VSCode debug plugin.

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,

/// Underlying HTTP client
client: reqwest::Client,
}

impl DebugClient {
/// Create a new instance of a DebugClient with the specified url.
pub fn new(url: String) -> DebugClient {
DebugClient {
debugger_url: Url::parse(&url).expect(
"debugger url malformatted, is process.env.TEMPORAL_DEBUGGER_PLUGIN_URL 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.as_str().to_owned() + "/history";
let resp = self
.client
.get(url)
.header("Temporal-Client-Name", CLIENT_NAME)
.header("Temporal-Client-Version", CLIENT_VERSION)
.send()
.await?;

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

/// Post to current-wft-started to communicate with debug plugin server
pub async fn post_wft_started(
&self,
event_id: &i64,
) -> Result<reqwest::Response, anyhow::Error> {
let url = self.debugger_url.as_str().to_owned() + "/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(event_id)
.send()
.await?)
}
}

#[cfg(test)]
mod tests {
use super::*;
// this test wont work without a local instance of the debugger running.
#[ignore]
#[tokio::test]
async fn test_debug_client_delete() {
let dc = DebugClient::new("http://127.0.0.1:51563".into());
dc.get_history().await.unwrap();
}
}
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