Skip to content

feat: use temporary directory for zip file handling #26

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 3 commits into from
Nov 7, 2025
Merged

feat: use temporary directory for zip file handling #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
653d496
feat: use temporary directory for zip file handling
Natchica Nov 6, 2025
91944e4
fix: update path formatting in zip file handling for consistency
Natchica Nov 6, 2025
220ca37
chore: update dependencies placement in Cargo.toml for consistency
Natchica Nov 7, 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 post-compute/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ sha256 = "1.6.0"
sha3 = "0.10.8"
strum = "0.27.2"
strum_macros = "0.27.2"
tempfile = "3.20.0"
thiserror = "2.0.12"
walkdir = "2.5.0"
zip = "4.0.0"
Expand All @@ -34,6 +35,5 @@ mockall = "0.13.1"
once_cell = "1.21.3"
serial_test = "3.2.0"
temp-env = "0.3.6"
tempfile = "3.20.0"
tokio = "1.45.0"
wiremock = "0.6.3"
75 changes: 45 additions & 30 deletions post-compute/src/compute/web2_result.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ use std::{
io::{self, Write},
path::{Path, PathBuf},
};
use tempfile::TempDir;
use walkdir::WalkDir;
use zip::{ZipWriter, write::FileOptions};

const SLASH_POST_COMPUTE_TMP: &str = "/post-compute-tmp";
const RESULT_FILE_NAME_MAX_LENGTH: usize = 31;
const IPFS_RESULT_STORAGE_PROVIDER: &str = "ipfs";
const DROPBOX_RESULT_STORAGE_PROVIDER: &str = "dropbox";
Expand Down Expand Up @@ -225,6 +225,10 @@ impl Web2ResultInterface for Web2ResultService {
/// The method name maintains compatibility with the Java implementation, though
/// encryption is not yet implemented.
///
/// The method creates a temporary directory for intermediate files (zip archive and
/// encrypted files if encryption is enabled). The temporary directory is automatically
/// cleaned up when the function completes, whether successfully or with an error.
///
/// # Arguments
///
/// * `computed_file` - The [`ComputedFile`] containing task information and metadata
Expand All @@ -247,24 +251,29 @@ impl Web2ResultInterface for Web2ResultService {
// check result file names are not too long
self.check_result_files_name(computed_file.task_id.as_ref().unwrap(), "/iexec_out")?;

// save zip file to the protected region /post-compute-tmp (temporarily)
let zip_path = match self.zip_iexec_out("/iexec_out", SLASH_POST_COMPUTE_TMP) {
Ok(path) => path,
Err(..) => {
error!("zipIexecOut stage failed");
return Err(ReplicateStatusCause::PostComputeOutFolderZipFailed);
}
};
// Create a temporary directory for the zip file
let temp_dir = TempDir::new().map_err(|e| {
error!("Failed to create temporary directory: {e}");
ReplicateStatusCause::PostComputeOutFolderZipFailed
})?;

// Get the path as a string - to_str() returns Option<&str>
let temp_dir_path = temp_dir.path().to_str().ok_or_else(|| {
error!("Failed to convert temporary directory path to string");
ReplicateStatusCause::PostComputeOutFolderZipFailed
})?;

// save zip file to the temporary directory
let zip_path = self
.zip_iexec_out("/iexec_out", temp_dir_path)
.map_err(|e| {
error!("zipIexecOut stage failed: {e}");
ReplicateStatusCause::PostComputeOutFolderZipFailed
})?;

let result_path = self.eventually_encrypt_result(&zip_path)?;
self.upload_result(computed_file, &result_path)?; //TODO Share result link to beneficiary

// Clean up the temporary zip file
if let Err(e) = fs::remove_file(&zip_path) {
error!("Failed to remove temporary zip file {zip_path}: {e}");
// We don't return an error here as the upload was successful
};

Ok(())
}

Expand Down Expand Up @@ -640,7 +649,12 @@ mod tests {
computed_file: &ComputedFile,
) -> Result<(), ReplicateStatusCause> {
service.check_result_files_name(computed_file.task_id.as_ref().unwrap(), "/iexec_out")?;
let zip_path = match service.zip_iexec_out("/iexec_out", SLASH_POST_COMPUTE_TMP) {
let temp_dir = TempDir::new().map_err(|e| {
error!("Failed to create temporary directory: {e}");
ReplicateStatusCause::PostComputeOutFolderZipFailed
})?;
let zip_path = match service.zip_iexec_out("/iexec_out", temp_dir.path().to_str().unwrap())
{
Ok(path) => path,
Err(..) => {
error!("zipIexecOut stage failed");
Expand All @@ -649,14 +663,14 @@ mod tests {
};
let result_path = service.eventually_encrypt_result(&zip_path)?;
service.upload_result(computed_file, &result_path)?;
drop(temp_dir);
Ok(())
}

#[test]
fn encrypt_and_upload_result_completes_successfully_when_all_operations_succeed() {
let mut web2_result_mock = MockWeb2ResultInterface::new();
let computed_file = create_test_computed_file("0x123");
let zip_path = "/post-compute-tmp/iexec_out.zip";

web2_result_mock
.expect_check_result_files_name()
Expand All @@ -666,19 +680,22 @@ mod tests {

web2_result_mock
.expect_zip_iexec_out()
.with(eq("/iexec_out"), eq(SLASH_POST_COMPUTE_TMP))
.with(eq("/iexec_out"), function(|path: &str| !path.is_empty()))
.times(1)
.returning(move |_, _| Ok(String::from(zip_path)));
.returning(|_, path| Ok(format!("{path}/iexec_out.zip")));

web2_result_mock
.expect_eventually_encrypt_result()
.with(eq(zip_path))
.with(function(|path: &str| path.ends_with("iexec_out.zip")))
.times(1)
.returning(|_| Ok(String::from("/post-compute-tmp/iexec_out.zip")));
.returning(|path| Ok(path.to_string()));

web2_result_mock
.expect_upload_result()
.with(eq(computed_file.clone()), eq(zip_path))
.with(
eq(computed_file.clone()),
function(|path: &str| path.ends_with("iexec_out.zip")),
)
.times(1)
.returning(|_, _| Ok(String::from("https://ipfs.io/ipfs/QmHash")));

Expand Down Expand Up @@ -726,7 +743,6 @@ mod tests {
fn encrypt_and_upload_result_returns_error_when_encryption_returns_error() {
let mut web2_result_mock = MockWeb2ResultInterface::new();
let computed_file = create_test_computed_file("0x123");
let zip_path = "/post-compute-tmp/iexec_out.zip";

web2_result_mock
.expect_check_result_files_name()
Expand All @@ -736,13 +752,13 @@ mod tests {

web2_result_mock
.expect_zip_iexec_out()
.with(eq("/iexec_out"), eq(SLASH_POST_COMPUTE_TMP))
.with(eq("/iexec_out"), function(|path: &str| !path.is_empty()))
.times(1)
.returning(move |_, _| Ok(String::from(zip_path)));
.returning(|_, path| Ok(format!("{path}/iexec_out.zip")));

web2_result_mock
.expect_eventually_encrypt_result()
.with(eq(zip_path))
.with(function(|path: &str| path.ends_with("iexec_out.zip")))
.times(1)
.returning(|_| Err(ReplicateStatusCause::PostComputeEncryptionFailed));

Expand All @@ -757,21 +773,20 @@ mod tests {
fn encrypt_and_upload_result_returns_error_when_upload_fails() {
let mut web2_result_mock = MockWeb2ResultInterface::new();
let computed_file = create_test_computed_file("0x123");
let zip_path = "/post-compute-tmp/iexec_out.zip";

web2_result_mock
.expect_check_result_files_name()
.returning(|_, _| Ok(()));

web2_result_mock
.expect_zip_iexec_out()
.returning(move |_, _| Ok(String::from(zip_path)));
.returning(|_, path| Ok(format!("{path}/iexec_out.zip")));

web2_result_mock
.expect_eventually_encrypt_result()
.with(eq(zip_path))
.with(function(|path: &str| path.ends_with("iexec_out.zip")))
.times(1)
.returning(move |_| Ok(String::from("/post-compute-tmp/iexec_out.zip")));
.returning(|path| Ok(path.to_string()));

web2_result_mock
.expect_upload_result()
Expand Down