fix: compress_status_file -> compress_state_file

Author: Nukesor

CHANGELOG.md

@@ -79,7 +79,7 @@ Upon updating Pueue and restarting the daemon, the previous state will be wiped,
 - Print most of Pueue's info/log messages to `stderr`. Only keep useful stuff like json and task log output on `stdout`.
 - **Breaking**: Ported from `anyhow` to `color_eyre` for prettier log output.
 - **Breaking**: Switch `cbor` handling library, potentially breaking backwards-compatible communication on a data format level.
-- Option to save the state in compressed form. This can be toggled with the `daemon.compress_status_file` config file.
+- Option to save the state in compressed form. This can be toggled with the `daemon.compress_state_file` config file.
   Preliminary testing shows significant compression ratios (up to x15), which helps with large states in embedded and I/O bound environments.
 
 ### Add

pueue/src/daemon/internal_state/state.rs

@@ -254,7 +254,7 @@ impl InternalState {
         let mut temp = path.join("state.json.partial");
         let mut real = path.join("state.json");
 
-        if settings.daemon.compress_status_file {
+        if settings.daemon.compress_state_file {
             temp = path.join("state.json.gz.partial");
             real = path.join("state.json.gz");
 
@@ -290,7 +290,7 @@ impl InternalState {
         let pueue_directory = settings.shared.pueue_directory();
         let mut path = pueue_directory.join("state.json");
 
-        if settings.daemon.compress_status_file {
+        if settings.daemon.compress_state_file {
             path = pueue_directory.join("state.json.gz");
         }
 
@@ -302,7 +302,7 @@ impl InternalState {
         info!("Restoring state");
 
         // Try to load the file.
-        let data = if settings.daemon.compress_status_file {
+        let data = if settings.daemon.compress_state_file {
             let file = File::open(path)?;
             let mut decoder = flate2::read::GzDecoder::new(file);
             let mut data = String::new();

pueue/tests/daemon/integration/restore.rs

@@ -11,7 +11,7 @@ use crate::{helper::*, internal_prelude::*};
 #[tokio::test]
 async fn test_start_running(#[case] compress: bool) -> Result<()> {
     let (mut settings, tempdir) = daemon_base_setup()?;
-    settings.daemon.compress_status_file = compress;
+    settings.daemon.compress_state_file = compress;
     settings
         .save(&Some(tempdir.path().join("pueue.yml")))
         .context("Couldn't write pueue config to temporary directory")?;
@@ -46,7 +46,7 @@ async fn test_start_running(#[case] compress: bool) -> Result<()> {
 #[tokio::test]
 async fn test_start_paused(#[case] compress: bool) -> Result<()> {
     let (mut settings, tempdir) = daemon_base_setup()?;
-    settings.daemon.compress_status_file = compress;
+    settings.daemon.compress_state_file = compress;
     settings
         .save(&Some(tempdir.path().join("pueue.yml")))
         .context("Couldn't write pueue config to temporary directory")?;

pueue_lib/src/settings.rs

@@ -143,7 +143,7 @@ pub struct Daemon {
     /// The state tends to be quite large for many tasks, as the whole environment is copied every
     /// time. You can expect a ~10 compression ratio.
     #[serde(default = "Default::default")]
-    pub compress_status_file: bool,
+    pub compress_state_file: bool,
     /// The callback that's called whenever a task finishes.
     pub callback: Option<String>,
     /// Environment variables that can be will be injected into all executed processes.
@@ -218,7 +218,7 @@ impl Default for Daemon {
             pause_all_on_failure: false,
             callback: None,
             callback_log_lines: default_callback_log_lines(),
-            compress_status_file: false,
+            compress_state_file: false,
             shell_command: None,
             env_vars: HashMap::new(),
         }