Add SSH compress to nix copy

Author: timothyklim

README.md

@@ -220,6 +220,10 @@ This is a set of options that can be put in any of the above definitions, with t
   # This defaults to `false`
   fastConnection = false;
 
+  # Use SSH gzip compress for `nix copy`.
+  # This defaults to `false`
+  compress = true;
+
   # If the previous profile should be re-activated if activation fails.
   # This defaults to `true`
   autoRollback = true;

examples/system/flake.nix

@@ -26,6 +26,7 @@
       sshOpts = [ "-p" "2221" ];
       hostname = "localhost";
       fastConnection = true;
+      compress = true;
       interactiveSudo = true;
       profiles = {
         system = {

interface.json

@@ -21,6 +21,9 @@
                 "fastConnection": {
                     "type": "boolean"
                 },
+                "compress": {
+                    "type": "boolean"
+                },
                 "autoRollback": {
                     "type": "boolean"
                 },

src/cli.rs

@@ -74,6 +74,9 @@ pub struct Opts {
     /// Override the SSH options used
     #[arg(long, allow_hyphen_values = true)]
     ssh_opts: Option<String>,
+    /// Override the SSH compression when using `nix copy`
+    #[clap(long)]
+    compress: Option<bool>,
     /// Override if the connecting to the target node should be considered fast
     #[arg(long)]
     fast_connection: Option<bool>,
@@ -702,6 +705,7 @@ pub async fn run(args: Option<&ArgMatches>) -> Result<(), RunError> {
         profile_user: opts.profile_user,
         ssh_opts: opts.ssh_opts,
         fast_connection: opts.fast_connection,
+        compress: opts.compress,
         auto_rollback: opts.auto_rollback,
         hostname: opts.hostname,
         magic_rollback: opts.magic_rollback,

src/data.rs

@@ -19,6 +19,8 @@ pub struct GenericSettings {
     )]
     #[merge(strategy = merge::vec::append)]
     pub ssh_opts: Vec<String>,
+    #[serde(rename(deserialize = "compress"))]
+    pub compress: Option<bool>,
     #[serde(rename(deserialize = "fastConnection"))]
     pub fast_connection: Option<bool>,
     #[serde(rename(deserialize = "autoRollback"))]

src/lib.rs

@@ -157,6 +157,7 @@ pub struct CmdOverrides {
     pub ssh_user: Option<String>,
     pub profile_user: Option<String>,
     pub ssh_opts: Option<String>,
+    pub compress: Option<bool>,
     pub fast_connection: Option<bool>,
     pub auto_rollback: Option<bool>,
     pub hostname: Option<String>,
@@ -454,6 +455,9 @@ pub fn make_deploy_data<'a, 's>(
     if let Some(fast_connection) = cmd_overrides.fast_connection {
         merged_settings.fast_connection = Some(fast_connection);
     }
+    if let Some(compress) = cmd_overrides.compress {
+        merged_settings.compress = Some(compress);
+    }
     if let Some(auto_rollback) = cmd_overrides.auto_rollback {
         merged_settings.auto_rollback = Some(auto_rollback);
     }

src/push.rs

@@ -351,9 +351,11 @@ pub async fn push_profile(data: PushProfileData<'_>) -> Result<(), PushProfileEr
             None => &data.deploy_data.node.node_settings.hostname,
         };
 
+        let compress = data.deploy_data.merged_settings.compress.unwrap_or_else(|| false);
+
         let copy_exit_status = copy_command
             .arg("--to")
-            .arg(format!("ssh://{}@{}", data.deploy_defs.ssh_user, hostname))
+            .arg(format!("ssh://{}@{}?compress={}", data.deploy_defs.ssh_user, hostname, compress))
             .arg(&data.deploy_data.profile.profile_settings.path)
             .env("NIX_SSHOPTS", ssh_opts_str)
             .status()