refactor: rename atuin-config to atuin-dotfiles (#1817)

8 files changed, 393 insertions, 0 deletions

diff --git a/atuin-dotfiles/Cargo.toml b/atuin-dotfiles/Cargo.toml
new file mode 100644
index 00000000..1305f521
--- /dev/null
+++ b/atuin-dotfiles/Cargo.toml
@@ -0,0 +1,23 @@
+[package]
+name = "atuin-dotfiles"
+edition = "2021"
+version = "0.1.0" # intentionally not the same as the rest
+
+authors.workspace = true
+rust-version.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+readme.workspace = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+atuin-common = { path = "../atuin-common", version = "18.0.1" }
+atuin-client = { path = "../atuin-client", version = "18.0.1" }
+
+eyre = { workspace = true }
+tokio = { workspace = true }
+rmp = { version = "0.8.11" }
+rand = { workspace = true }
+crypto_secretbox = "0.1.1"
diff --git a/atuin-dotfiles/src/lib.rs b/atuin-dotfiles/src/lib.rs
new file mode 100644
index 00000000..74daf8ef
--- /dev/null
+++ b/atuin-dotfiles/src/lib.rs
@@ -0,0 +1,2 @@
+pub mod shell;
+pub mod store;
diff --git a/atuin-dotfiles/src/shell.rs b/atuin-dotfiles/src/shell.rs
new file mode 100644
index 00000000..a69a2d6b
--- /dev/null
+++ b/atuin-dotfiles/src/shell.rs
@@ -0,0 +1,10 @@
+pub mod bash;
+pub mod fish;
+pub mod xonsh;
+pub mod zsh;
+
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct Alias {
+    pub name: String,
+    pub value: String,
+}
diff --git a/atuin-dotfiles/src/shell/bash.rs b/atuin-dotfiles/src/shell/bash.rs
new file mode 100644
index 00000000..c5bd87b2
--- /dev/null
+++ b/atuin-dotfiles/src/shell/bash.rs
@@ -0,0 +1,12 @@
+use super::Alias;
+
+// Configuration for bash
+pub fn build(aliases: &[Alias]) -> String {
+    let mut config = String::new();
+
+    for alias in aliases {
+        config.push_str(&format!("alias {}='{}'\n", alias.name, alias.value));
+    }
+
+    config
+}
diff --git a/atuin-dotfiles/src/shell/fish.rs b/atuin-dotfiles/src/shell/fish.rs
new file mode 100644
index 00000000..c6277f34
--- /dev/null
+++ b/atuin-dotfiles/src/shell/fish.rs
@@ -0,0 +1,12 @@
+use super::Alias;
+
+// Configuration for fish
+pub fn build(aliases: &[Alias]) -> String {
+    let mut config = String::new();
+
+    for alias in aliases {
+        config.push_str(&format!("alias {}='{}'\n", alias.name, alias.value));
+    }
+
+    config
+}
diff --git a/atuin-dotfiles/src/shell/xonsh.rs b/atuin-dotfiles/src/shell/xonsh.rs
new file mode 100644
index 00000000..8b61ff4c
--- /dev/null
+++ b/atuin-dotfiles/src/shell/xonsh.rs
@@ -0,0 +1,12 @@
+use super::Alias;
+
+// Configuration for xonsh
+pub fn build(aliases: &[Alias]) -> String {
+    let mut config = String::new();
+
+    for alias in aliases {
+        config.push_str(&format!("aliases['{}'] ='{}'\n", alias.name, alias.value));
+    }
+
+    config
+}
diff --git a/atuin-dotfiles/src/shell/zsh.rs b/atuin-dotfiles/src/shell/zsh.rs
new file mode 100644
index 00000000..6f81ed55
--- /dev/null
+++ b/atuin-dotfiles/src/shell/zsh.rs
@@ -0,0 +1,12 @@
+use super::Alias;
+
+// Configuration for zsh
+pub fn build(aliases: &[Alias]) -> String {
+    let mut config = String::new();
+
+    for alias in aliases {
+        config.push_str(&format!("alias {}='{}'\n", alias.name, alias.value));
+    }
+
+    config
+}
diff --git a/atuin-dotfiles/src/store.rs b/atuin-dotfiles/src/store.rs
new file mode 100644
index 00000000..96e0fb32
--- /dev/null
+++ b/atuin-dotfiles/src/store.rs
@@ -0,0 +1,310 @@
+use std::collections::BTreeMap;
+
+use atuin_client::record::sqlite_store::SqliteStore;
+// Sync aliases
+// This will be noticeable similar to the kv store, though I expect the two shall diverge
+// While we will support a range of shell config, I'd rather have a larger number of small records
+// + stores, rather than one mega config store.
+use atuin_common::record::{DecryptedData, Host, HostId};
+use eyre::{bail, ensure, eyre, Result};
+
+use atuin_client::record::encryption::PASETO_V4;
+use atuin_client::record::store::Store;
+
+use crate::shell::Alias;
+
+const CONFIG_SHELL_ALIAS_VERSION: &str = "v0";
+const CONFIG_SHELL_ALIAS_TAG: &str = "config-shell-alias";
+const CONFIG_SHELL_ALIAS_FIELD_MAX_LEN: usize = 20000; // 20kb max total len, way more than should be needed.
+
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub enum AliasRecord {
+    Create(Alias),  // create a full record
+    Delete(String), // delete by name
+}
+
+impl AliasRecord {
+    pub fn serialize(&self) -> Result<DecryptedData> {
+        use rmp::encode;
+
+        let mut output = vec![];
+
+        match self {
+            AliasRecord::Create(alias) => {
+                encode::write_u8(&mut output, 0)?; // create
+                encode::write_array_len(&mut output, 2)?; // 2 fields
+
+                encode::write_str(&mut output, alias.name.as_str())?;
+                encode::write_str(&mut output, alias.value.as_str())?;
+            }
+            AliasRecord::Delete(name) => {
+                encode::write_u8(&mut output, 1)?; // delete
+                encode::write_array_len(&mut output, 1)?; // 1 field
+
+                encode::write_str(&mut output, name.as_str())?;
+            }
+        }
+
+        Ok(DecryptedData(output))
+    }
+
+    pub fn deserialize(data: &DecryptedData, version: &str) -> Result<Self> {
+        use rmp::decode;
+
+        fn error_report<E: std::fmt::Debug>(err: E) -> eyre::Report {
+            eyre!("{err:?}")
+        }
+
+        match version {
+            CONFIG_SHELL_ALIAS_VERSION => {
+                let mut bytes = decode::Bytes::new(&data.0);
+
+                let record_type = decode::read_u8(&mut bytes).map_err(error_report)?;
+
+                match record_type {
+                    // create
+                    0 => {
+                        let nfields = decode::read_array_len(&mut bytes).map_err(error_report)?;
+                        ensure!(
+                            nfields == 2,
+                            "too many entries in v0 shell alias create record"
+                        );
+
+                        let bytes = bytes.remaining_slice();
+
+                        let (key, bytes) =
+                            decode::read_str_from_slice(bytes).map_err(error_report)?;
+                        let (value, bytes) =
+                            decode::read_str_from_slice(bytes).map_err(error_report)?;
+
+                        if !bytes.is_empty() {
+                            bail!("trailing bytes in encoded shell alias record. malformed")
+                        }
+
+                        Ok(AliasRecord::Create(Alias {
+                            name: key.to_owned(),
+                            value: value.to_owned(),
+                        }))
+                    }
+
+                    // delete
+                    1 => {
+                        let nfields = decode::read_array_len(&mut bytes).map_err(error_report)?;
+                        ensure!(
+                            nfields == 1,
+                            "too many entries in v0 shell alias delete record"
+                        );
+
+                        let bytes = bytes.remaining_slice();
+
+                        let (key, bytes) =
+                            decode::read_str_from_slice(bytes).map_err(error_report)?;
+
+                        if !bytes.is_empty() {
+                            bail!("trailing bytes in encoded shell alias record. malformed")
+                        }
+
+                        Ok(AliasRecord::Delete(key.to_owned()))
+                    }
+
+                    n => {
+                        bail!("unknown AliasRecord type {n}")
+                    }
+                }
+            }
+            _ => {
+                bail!("unknown version {version:?}")
+            }
+        }
+    }
+}
+
+#[derive(Debug, Clone)]
+pub struct AliasStore {
+    pub store: SqliteStore,
+    pub host_id: HostId,
+    pub encryption_key: [u8; 32],
+}
+
+impl AliasStore {
+    // will want to init the actual kv store when that is done
+    pub fn new(store: SqliteStore, host_id: HostId, encryption_key: [u8; 32]) -> AliasStore {
+        AliasStore {
+            store,
+            host_id,
+            encryption_key,
+        }
+    }
+
+    pub async fn set(&self, name: &str, value: &str) -> Result<()> {
+        if name.len() + value.len() > CONFIG_SHELL_ALIAS_FIELD_MAX_LEN {
+            return Err(eyre!(
+                "alias record too large: max len {} bytes",
+                CONFIG_SHELL_ALIAS_FIELD_MAX_LEN
+            ));
+        }
+
+        let record = AliasRecord::Create(Alias {
+            name: name.to_string(),
+            value: value.to_string(),
+        });
+
+        let bytes = record.serialize()?;
+
+        let idx = self
+            .store
+            .last(self.host_id, CONFIG_SHELL_ALIAS_TAG)
+            .await?
+            .map_or(0, |entry| entry.idx + 1);
+
+        let record = atuin_common::record::Record::builder()
+            .host(Host::new(self.host_id))
+            .version(CONFIG_SHELL_ALIAS_VERSION.to_string())
+            .tag(CONFIG_SHELL_ALIAS_TAG.to_string())
+            .idx(idx)
+            .data(bytes)
+            .build();
+
+        self.store
+            .push(&record.encrypt::<PASETO_V4>(&self.encryption_key))
+            .await?;
+
+        Ok(())
+    }
+
+    pub async fn delete(&self, name: &str) -> Result<()> {
+        if name.len() > CONFIG_SHELL_ALIAS_FIELD_MAX_LEN {
+            return Err(eyre!(
+                "alias record too large: max len {} bytes",
+                CONFIG_SHELL_ALIAS_FIELD_MAX_LEN
+            ));
+        }
+
+        let record = AliasRecord::Delete(name.to_string());
+
+        let bytes = record.serialize()?;
+
+        let idx = self
+            .store
+            .last(self.host_id, CONFIG_SHELL_ALIAS_TAG)
+            .await?
+            .map_or(0, |entry| entry.idx + 1);
+
+        let record = atuin_common::record::Record::builder()
+            .host(Host::new(self.host_id))
+            .version(CONFIG_SHELL_ALIAS_VERSION.to_string())
+            .tag(CONFIG_SHELL_ALIAS_TAG.to_string())
+            .idx(idx)
+            .data(bytes)
+            .build();
+
+        self.store
+            .push(&record.encrypt::<PASETO_V4>(&self.encryption_key))
+            .await?;
+
+        Ok(())
+    }
+
+    pub async fn aliases(&self) -> Result<Vec<Alias>> {
+        let mut build = BTreeMap::new();
+
+        // this is sorted, oldest to newest
+        let tagged = self.store.all_tagged(CONFIG_SHELL_ALIAS_TAG).await?;
+
+        for record in tagged {
+            let version = record.version.clone();
+
+            let decrypted = match version.as_str() {
+                CONFIG_SHELL_ALIAS_VERSION => record.decrypt::<PASETO_V4>(&self.encryption_key)?,
+                version => bail!("unknown version {version:?}"),
+            };
+
+            let ar = AliasRecord::deserialize(&decrypted.data, version.as_str())?;
+
+            match ar {
+                AliasRecord::Create(a) => {
+                    build.insert(a.name.clone(), a);
+                }
+                AliasRecord::Delete(d) => {
+                    build.remove(&d);
+                }
+            }
+        }
+
+        Ok(build.into_values().collect())
+    }
+}
+
+#[cfg(test)]
+pub(crate) fn test_sqlite_store_timeout() -> f64 {
+    std::env::var("ATUIN_TEST_SQLITE_STORE_TIMEOUT")
+        .ok()
+        .and_then(|x| x.parse().ok())
+        .unwrap_or(0.1)
+}
+
+#[cfg(test)]
+mod tests {
+    use rand::rngs::OsRng;
+
+    use atuin_client::record::sqlite_store::SqliteStore;
+
+    use crate::shell::Alias;
+
+    use super::{test_sqlite_store_timeout, AliasRecord, AliasStore, CONFIG_SHELL_ALIAS_VERSION};
+    use crypto_secretbox::{KeyInit, XSalsa20Poly1305};
+
+    #[test]
+    fn encode_decode() {
+        let record = Alias {
+            name: "k".to_owned(),
+            value: "kubectl".to_owned(),
+        };
+        let record = AliasRecord::Create(record);
+
+        let snapshot = [204, 0, 146, 161, 107, 167, 107, 117, 98, 101, 99, 116, 108];
+
+        let encoded = record.serialize().unwrap();
+        let decoded = AliasRecord::deserialize(&encoded, CONFIG_SHELL_ALIAS_VERSION).unwrap();
+
+        assert_eq!(encoded.0, &snapshot);
+        assert_eq!(decoded, record);
+    }
+
+    #[tokio::test]
+    async fn build_aliases() {
+        let store = SqliteStore::new(":memory:", test_sqlite_store_timeout())
+            .await
+            .unwrap();
+        let key: [u8; 32] = XSalsa20Poly1305::generate_key(&mut OsRng).into();
+        let host_id = atuin_common::record::HostId(atuin_common::utils::uuid_v7());
+
+        let alias = AliasStore::new(store, host_id, key);
+
+        alias.set("k", "kubectl").await.unwrap();
+
+        alias.set("gp", "git push").await.unwrap();
+
+        let mut aliases = alias.aliases().await.unwrap();
+
+        aliases.sort_by_key(|a| a.name.clone());
+
+        assert_eq!(aliases.len(), 2);
+
+        assert_eq!(
+            aliases[0],
+            Alias {
+                name: String::from("gp"),
+                value: String::from("git push")
+            }
+        );
+
+        assert_eq!(
+            aliases[1],
+            Alias {
+                name: String::from("k"),
+                value: String::from("kubectl")
+            }
+        );
+    }
+}