feat(powershell): wrap potentially invalid expressions in Invoke-Expression

Author: ltrzesniewski

Diff for: crates/atuin-dotfiles/src/shell/powershell.rs

@@ -1,6 +1,6 @@
-use std::path::PathBuf;
-
+use crate::shell::{Alias, Var};
 use crate::store::{var::VarStore, AliasStore};
+use std::path::PathBuf;
 
 async fn cached_aliases(path: PathBuf, store: &AliasStore) -> String {
     match tokio::fs::read_to_string(path).await {
@@ -66,3 +66,104 @@ pub async fn var_config(store: &VarStore) -> String {
 
     cached_vars(vars, store).await
 }
+
+pub fn format_alias(alias: &Alias) -> String {
+    // Set-Alias doesn't support adding implicit arguments, so use a function.
+    // See https://github.com/PowerShell/PowerShell/issues/12962
+
+    let mut result = secure_command(&format!(
+        "function {} {{\n    {}{} @args\n}}",
+        alias.name,
+        if alias.value.starts_with(['"', '\'']) {
+            "& "
+        } else {
+            ""
+        },
+        alias.value
+    ));
+
+    // This makes the file layout prettier
+    result.insert(0, '\n');
+    result
+}
+
+pub fn format_var(var: &Var) -> String {
+    secure_command(&format!(
+        "${}{} = '{}'",
+        if var.export { "env:" } else { "" },
+        var.name,
+        var.value.replace("'", "''")
+    ))
+}
+
+/// Wraps the given command in an Invoke-Expression to ensure the outer script is not halted
+/// if the inner command contains a syntax error.
+fn secure_command(command: &str) -> String {
+    format!(
+        "Invoke-Expression -ErrorAction Continue -Command '{}'\n",
+        command.replace("'", "''")
+    )
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn aliases() {
+        assert_eq!(
+            format_alias(&Alias {
+                name: "gp".to_string(),
+                value: "git push".to_string(),
+            }),
+            "\n".to_string()
+                + &secure_command(
+                    "function gp {
+    git push @args
+}"
+                )
+        );
+
+        assert_eq!(
+            format_alias(&Alias {
+                name: "spc".to_string(),
+                value: "\"path with spaces\" arg".to_string(),
+            }),
+            "\n".to_string()
+                + &secure_command(
+                    "function spc {
+    & \"path with spaces\" arg @args
+}"
+                )
+        );
+    }
+
+    #[test]
+    fn vars() {
+        assert_eq!(
+            format_var(&Var {
+                name: "FOO".to_owned(),
+                value: "bar 'baz'".to_owned(),
+                export: true,
+            }),
+            secure_command("$env:FOO = 'bar ''baz'''")
+        );
+
+        assert_eq!(
+            format_var(&Var {
+                name: "TEST".to_owned(),
+                value: "1".to_owned(),
+                export: false,
+            }),
+            secure_command("$TEST = '1'")
+        );
+    }
+
+    #[test]
+    fn invoke_expression() {
+        assert_eq!(
+            secure_command("echo 'foo'"),
+            "Invoke-Expression -ErrorAction Continue -Command 'echo ''foo'''\n"
+        )
+    }
+}

Diff for: crates/atuin-dotfiles/src/store.rs

@@ -183,18 +183,7 @@ impl AliasStore {
         let mut config = String::new();
 
         for alias in aliases {
-            // Set-Alias doesn't support adding implicit arguments, so use a function.
-            // See https://github.com/PowerShell/PowerShell/issues/12962
-            config.push_str(&format!(
-                "\nfunction {} {{\n    {}{} @args\n}}\n",
-                alias.name,
-                if alias.value.starts_with(['"', '\'']) {
-                    "& "
-                } else {
-                    ""
-                },
-                alias.value
-            ));
+            config.push_str(&crate::shell::powershell::format_alias(alias));
         }
 
         config
@@ -426,35 +415,6 @@ mod tests {
             "alias gp='git push'
 alias k='kubectl'
 alias kgap='kubectl get pods --all-namespaces'
-"
-        )
-    }
-
-    #[test]
-    fn format_powershell() {
-        let aliases = [
-            Alias {
-                name: "gp".to_string(),
-                value: "git push".to_string(),
-            },
-            Alias {
-                name: "spc".to_string(),
-                value: "\"path with spaces\" arg".to_string(),
-            },
-        ];
-
-        let result = AliasStore::format_powershell(&aliases);
-
-        assert_eq!(
-            result,
-            "
-function gp {
-    git push @args
-}
-
-function spc {
-    & \"path with spaces\" arg @args
-}
 "
         )
     }

Diff for: crates/atuin-dotfiles/src/store/var.rs

@@ -173,12 +173,7 @@ impl VarStore {
         let mut config = String::new();
 
         for env in env {
-            config.push_str(&format!(
-                "${}{} = '{}'\n",
-                if env.export { "env:" } else { "" },
-                env.name,
-                env.value.replace("'", "''")
-            ));
+            config.push_str(&crate::shell::powershell::format_var(env));
         }
 
         config
@@ -388,24 +383,4 @@ mod tests {
             }
         );
     }
-
-    #[test]
-    fn format_powershell() {
-        let env = [
-            Var {
-                name: "FOO".to_owned(),
-                value: "bar 'baz'".to_owned(),
-                export: true,
-            },
-            Var {
-                name: "TEST".to_owned(),
-                value: "1".to_owned(),
-                export: false,
-            },
-        ];
-
-        let result = VarStore::format_powershell(&env);
-
-        assert_eq!(result, "$env:FOO = 'bar ''baz'''\n$TEST = '1'\n");
-    }
 }