Skip to content

armgit / Cap

Public Imported from GitHub
0

Open source Loom alternative. Beautiful, shareable screen recordings.

fix(project): sync staged configs and clean up failed writes

Aditya Garude0c7323d10d4
diff --git a/crates/project/src/configuration.rs b/crates/project/src/configuration.rs
index 9a2aa35eb..2ba9cbd76 100644
--- a/crates/project/src/configuration.rs
+++ b/crates/project/src/configuration.rs
@@ -2,6 +2,7 @@ use std::{
borrow::Cow,
collections::BTreeMap,
fmt,
+ io::Write,
ops::{Add, Div, Mul, Sub, SubAssign},
path::Path,
sync::LazyLock,
@@ -2985,17 +2986,16 @@ impl ProjectConfiguration {
let project_path = project_path.as_ref();
let config_path = project_path.join("project-config.json");
- let temp_path =
- project_path.join(format!(".project-config-{}.json.tmp", uuid::Uuid::new_v4()));
-
- std::fs::write(&temp_path, serde_json::to_string_pretty(self)?)?;
-
- if let Err(error) = std::fs::rename(&temp_path, &config_path) {
- let _ = std::fs::remove_file(&temp_path);
- return Err(error);
- }
+ let temp_path = tempfile::TempPath::from_path(
+ project_path.join(format!(".project-config-{}.json.tmp", uuid::Uuid::new_v4())),
+ );
+ let config = serde_json::to_string_pretty(self)?;
+ let mut file = std::fs::File::create(&temp_path)?;
+ file.write_all(config.as_bytes())?;
+ file.sync_all()?;
+ drop(file);
- Ok(())
+ std::fs::rename(&temp_path, &config_path)
}
pub fn get_segment_time(&self, frame_time: f64) -> Option<(f64, &TimelineSegment)> {
diff --git a/crates/project/tests/config_write.rs b/crates/project/tests/config_write.rs
new file mode 100644
index 000000000..9f134c10d
--- /dev/null
+++ b/crates/project/tests/config_write.rs
@@ -0,0 +1,79 @@
+use cap_project::ProjectConfiguration;
+use std::io::Read;
+
+#[test]
+fn replacing_config_keeps_the_previous_file_intact() {
+ let project = tempfile::tempdir().unwrap();
+ let path = project.path().join("project-config.json");
+ let mut config = ProjectConfiguration::default();
+ config.write(project.path()).unwrap();
+ let original = std::fs::read(&path).unwrap();
+ let mut previous = std::fs::File::open(&path).unwrap();
+ config.background.padding = 23.0;
+
+ config.write(project.path()).unwrap();
+
+ let mut retained = Vec::new();
+ previous.read_to_end(&mut retained).unwrap();
+ assert_eq!(retained, original);
+ assert_eq!(
+ std::fs::read(&path).unwrap(),
+ serde_json::to_vec_pretty(&config).unwrap()
+ );
+ assert_eq!(std::fs::read_dir(project.path()).unwrap().count(), 1);
+}
+
+#[test]
+fn failed_replacement_keeps_the_destination_and_cleans_up() {
+ let project = tempfile::tempdir().unwrap();
+ let path = project.path().join("project-config.json");
+ std::fs::create_dir(&path).unwrap();
+ std::fs::write(path.join("retained"), b"original").unwrap();
+
+ assert!(
+ ProjectConfiguration::default()
+ .write(project.path())
+ .is_err()
+ );
+
+ assert_eq!(std::fs::read(path.join("retained")).unwrap(), b"original");
+ assert_eq!(std::fs::read_dir(project.path()).unwrap().count(), 1);
+}
+
+#[cfg(unix)]
+#[test]
+fn failed_write_keeps_the_previous_config_and_cleans_up() {
+ const CHILD_PROJECT: &str = "CAP_PROJECT_LIMITED_WRITE_TEST";
+ if let Some(project) = std::env::var_os(CHILD_PROJECT) {
+ let config = ProjectConfiguration::default();
+ assert!(serde_json::to_vec_pretty(&config).unwrap().len() > 1024);
+ assert!(config.write(project).is_err());
+ return;
+ }
+
+ let project = tempfile::tempdir().unwrap();
+ let path = project.path().join("project-config.json");
+ let mut config = ProjectConfiguration::default();
+ config.background.padding = 23.0;
+ config.write(project.path()).unwrap();
+ let original = std::fs::read(&path).unwrap();
+
+ let output = std::process::Command::new("sh")
+ .args([
+ "-c",
+ "trap '' XFSZ; ulimit -f 1; exec \"$@\"",
+ "config-write-test",
+ ])
+ .arg(std::env::current_exe().unwrap())
+ .args([
+ "--exact",
+ "failed_write_keeps_the_previous_config_and_cleans_up",
+ ])
+ .env(CHILD_PROJECT, project.path())
+ .output()
+ .unwrap();
+
+ assert!(output.status.success(), "{output:?}");
+ assert_eq!(std::fs::read(path).unwrap(), original);
+ assert_eq!(std::fs::read_dir(project.path()).unwrap().count(), 1);
+}