Skip to content

feat: update ReplicateStatusCause serialization and worker_api to support new WorkflowError format #21

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Oct 21, 2025
+269 −152
Merged

feat: update ReplicateStatusCause serialization and worker_api to support new WorkflowError format #21

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
95e0f4e
feat: update ReplicateStatusCause serialization and worker_api to sup…
nabil-Tounarti Oct 14, 2025
cac78db
style: clean up serde imports in errors.rs
nabil-Tounarti Oct 14, 2025
31565cf
refactor: simplify serialize method implementation using strum crate
nabil-Tounarti Oct 15, 2025
d825047
style: format the code
nabil-Tounarti Oct 15, 2025
b92beb5
refactor: use slice instead of Vec reference for exit_causes
nabil-Tounarti Oct 16, 2025
4889743
fix:: correct endpoint path to /exit-causes
nabil-Tounarti Oct 16, 2025
b5fb947
fix: adapt worker_api tests
nabil-Tounarti Oct 17, 2025
0f59f59
test: improve test naming for clarity and consistency
nabil-Tounarti Oct 17, 2025
c05a9a3
fix: revert changes on post-compute
nabil-Tounarti Oct 17, 2025
70d4c7b
feat: use dataset address for improved error handling
nabil-Tounarti Oct 20, 2025
bb1b672
feat: use dataset file name for improved error handling
nabil-Tounarti Oct 21, 2025
0f9d086
style: format the code
nabil-Tounarti Oct 21, 2025
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
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

147 changes: 64 additions & 83 deletions pre-compute/src/api/worker_api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,6 @@ use crate::compute::{
};
use log::error;
use reqwest::{blocking::Client, header::AUTHORIZATION};
use serde::Serialize;

/// Represents payload that can be sent to the worker API to report the outcome of the
/// pre‑compute stage.
///
/// The JSON structure expected by the REST endpoint is:
/// ```json
/// {
/// "cause": "<ReplicateStatusCause as string>"
/// }
/// ```
///
/// # Arguments
///
/// * `cause` - A reference to the ReplicateStatusCause indicating why the pre-compute operation exited
///
/// # Example
///
/// ```rust
/// use tee_worker_pre_compute::api::worker_api::ExitMessage;
/// use tee_worker_pre_compute::compute::errors::ReplicateStatusCause;
///
/// let exit_message = ExitMessage::from(&ReplicateStatusCause::PreComputeInvalidTeeSignature);
/// ```
#[derive(Serialize, Debug)]
pub struct ExitMessage<'a> {
pub cause: &'a ReplicateStatusCause,
}

impl<'a> From<&'a ReplicateStatusCause> for ExitMessage<'a> {
fn from(cause: &'a ReplicateStatusCause) -> Self {
Self { cause }
}
}

/// Thin wrapper around a [`Client`] that knows how to reach the iExec worker API.
///
Expand Down Expand Up @@ -93,21 +59,21 @@ impl WorkerApiClient {
Self::new(&base_url)
}

/// Sends an exit cause for a pre-compute operation to the Worker API.
/// Sends exit causes for a pre-compute operation to the Worker API.
///
/// This method reports the exit cause of a pre-compute operation to the Worker API,
/// This method reports the exit causes of a pre-compute operation to the Worker API,
/// which can be used for tracking and debugging purposes.
///
/// # Arguments
///
/// * `authorization` - The authorization token to use for the API request
/// * `chain_task_id` - The chain task ID for which to report the exit cause
/// * `exit_cause` - The exit cause to report
/// * `chain_task_id` - The chain task ID for which to report the exit causes
/// * `exit_causes` - The list of exit causes to report
///
/// # Returns
///
/// * `Ok(())` - If the exit cause was successfully reported
/// * `Err(Error)` - If the exit cause could not be reported due to an HTTP error
/// * `Ok(())` - If the exit causes were successfully reported
/// * `Err(Error)` - If the exit causes could not be reported due to an HTTP error
///
/// # Errors
///
Expand All @@ -117,33 +83,33 @@ impl WorkerApiClient {
/// # Example
///
/// ```rust
/// use tee_worker_pre_compute::api::worker_api::{ExitMessage, WorkerApiClient};
/// use tee_worker_pre_compute::api::worker_api::WorkerApiClient;
/// use tee_worker_pre_compute::compute::errors::ReplicateStatusCause;
///
/// let client = WorkerApiClient::new("http://worker:13100");
/// let exit_message = ExitMessage::from(&ReplicateStatusCause::PreComputeInvalidTeeSignature);
/// let exit_causes = vec![ReplicateStatusCause::PreComputeInvalidTeeSignature];
///
/// match client.send_exit_cause_for_pre_compute_stage(
/// match client.send_exit_causes_for_pre_compute_stage(
/// "authorization_token",
/// "0x123456789abcdef",
/// &exit_message,
/// &exit_causes,
/// ) {
/// Ok(()) => println!("Exit cause reported successfully"),
/// Err(error) => eprintln!("Failed to report exit cause: {error}"),
/// Ok(()) => println!("Exit causes reported successfully"),
/// Err(error) => eprintln!("Failed to report exit causes: {error}"),
/// }
/// ```
pub fn send_exit_cause_for_pre_compute_stage(
pub fn send_exit_causes_for_pre_compute_stage(
&self,
authorization: &str,
chain_task_id: &str,
exit_cause: &ExitMessage,
exit_causes: &Vec<ReplicateStatusCause>,
) -> Result<(), ReplicateStatusCause> {
let url = format!("{}/compute/pre/{chain_task_id}/exit", self.base_url);
match self
.client
.post(&url)
.header(AUTHORIZATION, authorization)
.json(exit_cause)
.json(exit_causes)
.send()
{
Ok(resp) => {
Expand All @@ -152,12 +118,12 @@ impl WorkerApiClient {
Ok(())
} else {
let body = resp.text().unwrap_or_default();
error!("Failed to send exit cause: [status:{status}, body:{body}]");
error!("Failed to send exit causes: [status:{status}, body:{body}]");
Err(ReplicateStatusCause::PreComputeFailedUnknownIssue)
}
}
Err(err) => {
error!("HTTP request failed when sending exit cause to {url}: {err:?}");
error!("HTTP request failed when sending exit causes to {url}: {err:?}");
Err(ReplicateStatusCause::PreComputeFailedUnknownIssue)
}
}
Expand All @@ -175,31 +141,45 @@ mod tests {
matchers::{body_json, header, method, path},
};

// region ExitMessage()
// region Serialization tests
#[test]
fn should_serialize_exit_message() {
let causes = [
fn should_serialize_replicate_status_cause() {
let causes = vec![
(
ReplicateStatusCause::PreComputeInvalidTeeSignature,
"PRE_COMPUTE_INVALID_TEE_SIGNATURE",
r#"{"cause":"PRE_COMPUTE_INVALID_TEE_SIGNATURE","message":"Invalid TEE signature"}"#,
),
(
ReplicateStatusCause::PreComputeWorkerAddressMissing,
"PRE_COMPUTE_WORKER_ADDRESS_MISSING",
r#"{"cause":"PRE_COMPUTE_WORKER_ADDRESS_MISSING","message":"Worker address related environment variable is missing"}"#,
),
(
ReplicateStatusCause::PreComputeFailedUnknownIssue,
"PRE_COMPUTE_FAILED_UNKNOWN_ISSUE",
ReplicateStatusCause::PreComputeDatasetUrlMissing(2),
r#"{"cause":"PRE_COMPUTE_DATASET_URL_MISSING","message":"Dataset URL related environment variable is missing for dataset 2"}"#,
),
(
ReplicateStatusCause::PreComputeInvalidDatasetChecksum(1),
r#"{"cause":"PRE_COMPUTE_INVALID_DATASET_CHECKSUM","message":"Invalid dataset checksum for dataset 1"}"#,
),
];

for (cause, message) in causes {
let exit_message = ExitMessage::from(&cause);
let serialized = to_string(&exit_message).expect("Failed to serialize");
let expected = format!("{{\"cause\":\"{message}\"}}");
assert_eq!(serialized, expected);
for (cause, expected_json) in causes {
let serialized = to_string(&cause).expect("Failed to serialize");
assert_eq!(serialized, expected_json);
}
}

#[test]
fn should_serialize_vec_of_causes() {
let causes = vec![
ReplicateStatusCause::PreComputeDatasetUrlMissing(0),
ReplicateStatusCause::PreComputeInvalidDatasetChecksum(1),
];

let serialized = to_string(&causes).expect("Failed to serialize");
let expected = r#"[{"cause":"PRE_COMPUTE_DATASET_URL_MISSING","message":"Dataset URL related environment variable is missing for dataset 0"},{"cause":"PRE_COMPUTE_INVALID_DATASET_CHECKSUM","message":"Invalid dataset checksum for dataset 1"}]"#;
assert_eq!(serialized, expected);
}
// endregion

// region get_worker_api_client
Expand All @@ -223,18 +203,21 @@ mod tests {
}
// endregion

// region send_exit_cause_for_pre_compute_stage()
// region send_exit_causes_for_pre_compute_stage()
const CHALLENGE: &str = "challenge";
const CHAIN_TASK_ID: &str = "0x123456789abcdef";

#[tokio::test]
async fn should_send_exit_cause() {
async fn should_send_exit_causes() {
let mock_server = MockServer::start().await;
let server_url = mock_server.uri();

let expected_body = json!({
"cause": ReplicateStatusCause::PreComputeInvalidTeeSignature,
});
let expected_body = json!([
{
"cause": "PRE_COMPUTE_INVALID_TEE_SIGNATURE",
"message": "Invalid TEE signature"
}
]);

Mock::given(method("POST"))
.and(path(format!("/compute/pre/{CHAIN_TASK_ID}/exit")))
Expand All @@ -246,13 +229,12 @@ mod tests {
.await;

let result = tokio::task::spawn_blocking(move || {
let exit_message =
ExitMessage::from(&ReplicateStatusCause::PreComputeInvalidTeeSignature);
let exit_causes = vec![ReplicateStatusCause::PreComputeInvalidTeeSignature];
let worker_api_client = WorkerApiClient::new(&server_url);
worker_api_client.send_exit_cause_for_pre_compute_stage(
worker_api_client.send_exit_causes_for_pre_compute_stage(
CHALLENGE,
CHAIN_TASK_ID,
&exit_message,
&exit_causes,
)
})
.await
Expand All @@ -262,7 +244,7 @@ mod tests {
}

#[tokio::test]
async fn should_not_send_exit_cause() {
async fn should_not_send_exit_causes() {
testing_logger::setup();
let mock_server = MockServer::start().await;
let server_url = mock_server.uri();
Expand All @@ -275,13 +257,12 @@ mod tests {
.await;

let result = tokio::task::spawn_blocking(move || {
let exit_message =
ExitMessage::from(&ReplicateStatusCause::PreComputeFailedUnknownIssue);
let exit_causes = vec![ReplicateStatusCause::PreComputeFailedUnknownIssue];
let worker_api_client = WorkerApiClient::new(&server_url);
let response = worker_api_client.send_exit_cause_for_pre_compute_stage(
let response = worker_api_client.send_exit_causes_for_pre_compute_stage(
CHALLENGE,
CHAIN_TASK_ID,
&exit_message,
&exit_causes,
);
testing_logger::validate(|captured_logs| {
let logs = captured_logs
Expand All @@ -292,7 +273,7 @@ mod tests {
assert_eq!(logs.len(), 1);
assert_eq!(
logs[0].body,
"Failed to send exit cause: [status:503 Service Unavailable, body:Service Unavailable]"
"Failed to send exit causes: [status:503 Service Unavailable, body:Service Unavailable]"
);
});
response
Expand All @@ -308,14 +289,14 @@ mod tests {
}

#[test]
fn test_send_exit_cause_http_request_failure() {
fn test_send_exit_causes_http_request_failure() {
testing_logger::setup();
let exit_message = ExitMessage::from(&ReplicateStatusCause::PreComputeFailedUnknownIssue);
let exit_causes = vec![ReplicateStatusCause::PreComputeFailedUnknownIssue];
let worker_api_client = WorkerApiClient::new("wrong_url");
let result = worker_api_client.send_exit_cause_for_pre_compute_stage(
let result = worker_api_client.send_exit_causes_for_pre_compute_stage(
CHALLENGE,
CHAIN_TASK_ID,
&exit_message,
&exit_causes,
);
testing_logger::validate(|captured_logs| {
let logs = captured_logs
Expand All @@ -326,7 +307,7 @@ mod tests {
assert_eq!(logs.len(), 1);
assert_eq!(
logs[0].body,
"HTTP request failed when sending exit cause to wrong_url/compute/pre/0x123456789abcdef/exit: reqwest::Error { kind: Builder, source: RelativeUrlWithoutBase }"
"HTTP request failed when sending exit causes to wrong_url/compute/pre/0x123456789abcdef/exit: reqwest::Error { kind: Builder, source: RelativeUrlWithoutBase }"
);
});
assert!(result.is_err());
Expand Down
18 changes: 8 additions & 10 deletions pre-compute/src/compute/app_runner.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::api::worker_api::{ExitMessage, WorkerApiClient};
use crate::api::worker_api::WorkerApiClient;
use crate::compute::pre_compute_app::{PreComputeApp, PreComputeAppTrait};
use crate::compute::{
errors::ReplicateStatusCause,
Expand Down Expand Up @@ -61,14 +61,12 @@ pub fn start_with_app<A: PreComputeAppTrait>(
}
};

let exit_message = ExitMessage {
cause: &exit_cause.clone(),
};
let exit_causes = vec![exit_cause.clone()];

match WorkerApiClient::from_env().send_exit_cause_for_pre_compute_stage(
match WorkerApiClient::from_env().send_exit_causes_for_pre_compute_stage(
&authorization,
chain_task_id,
&exit_message,
&exit_causes,
) {
Ok(_) => ExitMode::ReportedFailure,
Err(_) => {
Expand Down Expand Up @@ -231,10 +229,10 @@ mod pre_compute_start_with_app_tests {
async fn start_succeeds_when_send_exit_cause_api_success() {
let mock_server = MockServer::start().await;

let expected_cause_enum = ReplicateStatusCause::PreComputeOutputFolderNotFound;
let expected_exit_message_payload = json!({
"cause": expected_cause_enum // Relies on ReplicateStatusCause's Serialize impl
});
let expected_exit_message_payload = json!([{
"cause": "PRE_COMPUTE_OUTPUT_FOLDER_NOT_FOUND",
"message": "Input files number related environment variable is missing"
}]);

// Mock the worker API to return success
Mock::given(method("POST"))
Expand Down
Loading