chore: move crates into crates/ dir (#1958)

I'd like to tidy up the root a little, and it's nice to have all the
rust crates in one place

8 files changed, 0 insertions, 648 deletions

diff --git a/atuin-dotfiles/Cargo.toml b/atuin-dotfiles/Cargo.toml
deleted file mode 100644
index 1bd16223..00000000
--- a/atuin-dotfiles/Cargo.toml
+++ /dev/null
@@ -1,25 +0,0 @@
-[package]
-name = "atuin-dotfiles"
-description = "The dotfiles crate for Atuin"
-edition = "2021"
-version = "0.2.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.2.0" }
-atuin-client = { path = "../atuin-client", version = "18.2.0" }
-
-eyre = { workspace = true }
-tokio = { workspace = true }
-rmp = { version = "0.8.11" }
-rand = { workspace = true }
-serde = { workspace = true }
-crypto_secretbox = "0.1.1"
diff --git a/atuin-dotfiles/src/lib.rs b/atuin-dotfiles/src/lib.rs
deleted file mode 100644
index 74daf8ef..00000000
--- a/atuin-dotfiles/src/lib.rs
+++ /dev/null
@@ -1,2 +0,0 @@
-pub mod shell;
-pub mod store;
diff --git a/atuin-dotfiles/src/shell.rs b/atuin-dotfiles/src/shell.rs
deleted file mode 100644
index 7912bc34..00000000
--- a/atuin-dotfiles/src/shell.rs
+++ /dev/null
@@ -1,100 +0,0 @@
-use eyre::Result;
-use serde::Serialize;
-
-use atuin_common::shell::{Shell, ShellError};
-
-use crate::store::AliasStore;
-
-pub mod bash;
-pub mod fish;
-pub mod xonsh;
-pub mod zsh;
-
-#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
-pub struct Alias {
-    pub name: String,
-    pub value: String,
-}
-
-pub fn parse_alias(line: &str) -> Alias {
-    let mut parts = line.split('=');
-
-    let name = parts.next().unwrap().to_string();
-    let remaining = parts.collect::<Vec<&str>>().join("=").to_string();
-
-    Alias {
-        name,
-        value: remaining,
-    }
-}
-
-pub fn existing_aliases(shell: Option<Shell>) -> Result<Vec<Alias>, ShellError> {
-    let shell = if let Some(shell) = shell {
-        shell
-    } else {
-        Shell::current()
-    };
-
-    // this only supports posix-y shells atm
-    if !shell.is_posixish() {
-        return Err(ShellError::NotSupported);
-    }
-
-    // This will return a list of aliases, each on its own line
-    // They will be in the form foo=bar
-    let aliases = shell.run_interactive(["alias"])?;
-    let aliases: Vec<Alias> = aliases.lines().map(parse_alias).collect();
-
-    Ok(aliases)
-}
-
-/// Import aliases from the current shell
-/// This will not import aliases already in the store
-/// Returns aliases that were set
-pub async fn import_aliases(store: AliasStore) -> Result<Vec<Alias>> {
-    let shell_aliases = existing_aliases(None)?;
-    let store_aliases = store.aliases().await?;
-
-    let mut res = Vec::new();
-
-    for alias in shell_aliases {
-        // O(n), but n is small, and imports infrequent
-        // can always make a map
-        if store_aliases.contains(&alias) {
-            continue;
-        }
-
-        res.push(alias.clone());
-        store.set(&alias.name, &alias.value).await?;
-    }
-
-    Ok(res)
-}
-
-#[cfg(test)]
-mod tests {
-    #[test]
-    fn test_parse_simple_alias() {
-        let alias = super::parse_alias("foo=bar");
-        assert_eq!(alias.name, "foo");
-        assert_eq!(alias.value, "bar");
-    }
-
-    #[test]
-    fn test_parse_quoted_alias() {
-        let alias = super::parse_alias("emacs='TERM=xterm-24bits emacs -nw'");
-        assert_eq!(alias.name, "emacs");
-        assert_eq!(alias.value, "'TERM=xterm-24bits emacs -nw'");
-
-        let git_alias = super::parse_alias("gwip='git add -A; git rm $(git ls-files --deleted) 2> /dev/null; git commit --no-verify --no-gpg-sign --message \"--wip-- [skip ci]\"'");
-        assert_eq!(git_alias.name, "gwip");
-        assert_eq!(git_alias.value, "'git add -A; git rm $(git ls-files --deleted) 2> /dev/null; git commit --no-verify --no-gpg-sign --message \"--wip-- [skip ci]\"'");
-    }
-
-    #[test]
-    fn test_parse_quoted_alias_equals() {
-        let alias = super::parse_alias("emacs='TERM=xterm-24bits emacs -nw --foo=bar'");
-        assert_eq!(alias.name, "emacs");
-        assert_eq!(alias.value, "'TERM=xterm-24bits emacs -nw --foo=bar'");
-    }
-}
diff --git a/atuin-dotfiles/src/shell/bash.rs b/atuin-dotfiles/src/shell/bash.rs
deleted file mode 100644
index 5bdd7dce..00000000
--- a/atuin-dotfiles/src/shell/bash.rs
+++ /dev/null
@@ -1,39 +0,0 @@
-use std::path::PathBuf;
-
-use crate::store::AliasStore;
-
-async fn cached_aliases(path: PathBuf, store: &AliasStore) -> String {
-    match tokio::fs::read_to_string(path).await {
-        Ok(aliases) => aliases,
-        Err(r) => {
-            // we failed to read the file for some reason, but the file does exist
-            // fallback to generating new aliases on the fly
-
-            store.posix().await.unwrap_or_else(|e| {
-                format!("echo 'Atuin: failed to read and generate aliases: \n{r}\n{e}'",)
-            })
-        }
-    }
-}
-
-/// Return bash dotfile config
-///
-/// Do not return an error. We should not prevent the shell from starting.
-///
-/// In the worst case, Atuin should not function but the shell should start correctly.
-///
-/// While currently this only returns aliases, it will be extended to also return other synced dotfiles
-pub async fn config(store: &AliasStore) -> String {
-    // First try to read the cached config
-    let aliases = atuin_common::utils::dotfiles_cache_dir().join("aliases.bash");
-
-    if aliases.exists() {
-        return cached_aliases(aliases, store).await;
-    }
-
-    if let Err(e) = store.build().await {
-        return format!("echo 'Atuin: failed to generate aliases: {}'", e);
-    }
-
-    cached_aliases(aliases, store).await
-}
diff --git a/atuin-dotfiles/src/shell/fish.rs b/atuin-dotfiles/src/shell/fish.rs
deleted file mode 100644
index bf4e1a3b..00000000
--- a/atuin-dotfiles/src/shell/fish.rs
+++ /dev/null
@@ -1,40 +0,0 @@
-// Configuration for fish
-use std::path::PathBuf;
-
-use crate::store::AliasStore;
-
-async fn cached_aliases(path: PathBuf, store: &AliasStore) -> String {
-    match tokio::fs::read_to_string(path).await {
-        Ok(aliases) => aliases,
-        Err(r) => {
-            // we failed to read the file for some reason, but the file does exist
-            // fallback to generating new aliases on the fly
-
-            store.posix().await.unwrap_or_else(|e| {
-                format!("echo 'Atuin: failed to read and generate aliases: \n{r}\n{e}'",)
-            })
-        }
-    }
-}
-
-/// Return fish dotfile config
-///
-/// Do not return an error. We should not prevent the shell from starting.
-///
-/// In the worst case, Atuin should not function but the shell should start correctly.
-///
-/// While currently this only returns aliases, it will be extended to also return other synced dotfiles
-pub async fn config(store: &AliasStore) -> String {
-    // First try to read the cached config
-    let aliases = atuin_common::utils::dotfiles_cache_dir().join("aliases.fish");
-
-    if aliases.exists() {
-        return cached_aliases(aliases, store).await;
-    }
-
-    if let Err(e) = store.build().await {
-        return format!("echo 'Atuin: failed to generate aliases: {}'", e);
-    }
-
-    cached_aliases(aliases, store).await
-}
diff --git a/atuin-dotfiles/src/shell/xonsh.rs b/atuin-dotfiles/src/shell/xonsh.rs
deleted file mode 100644
index 383df4ec..00000000
--- a/atuin-dotfiles/src/shell/xonsh.rs
+++ /dev/null
@@ -1,39 +0,0 @@
-use std::path::PathBuf;
-
-use crate::store::AliasStore;
-
-async fn cached_aliases(path: PathBuf, store: &AliasStore) -> String {
-    match tokio::fs::read_to_string(path).await {
-        Ok(aliases) => aliases,
-        Err(r) => {
-            // we failed to read the file for some reason, but the file does exist
-            // fallback to generating new aliases on the fly
-
-            store.xonsh().await.unwrap_or_else(|e| {
-                format!("echo 'Atuin: failed to read and generate aliases: \n{r}\n{e}'",)
-            })
-        }
-    }
-}
-
-/// Return xonsh dotfile config
-///
-/// Do not return an error. We should not prevent the shell from starting.
-///
-/// In the worst case, Atuin should not function but the shell should start correctly.
-///
-/// While currently this only returns aliases, it will be extended to also return other synced dotfiles
-pub async fn config(store: &AliasStore) -> String {
-    // First try to read the cached config
-    let aliases = atuin_common::utils::dotfiles_cache_dir().join("aliases.xsh");
-
-    if aliases.exists() {
-        return cached_aliases(aliases, store).await;
-    }
-
-    if let Err(e) = store.build().await {
-        return format!("echo 'Atuin: failed to generate aliases: {}'", e);
-    }
-
-    cached_aliases(aliases, store).await
-}
diff --git a/atuin-dotfiles/src/shell/zsh.rs b/atuin-dotfiles/src/shell/zsh.rs
deleted file mode 100644
index d863b261..00000000
--- a/atuin-dotfiles/src/shell/zsh.rs
+++ /dev/null
@@ -1,39 +0,0 @@
-use std::path::PathBuf;
-
-use crate::store::AliasStore;
-
-async fn cached_aliases(path: PathBuf, store: &AliasStore) -> String {
-    match tokio::fs::read_to_string(path).await {
-        Ok(aliases) => aliases,
-        Err(r) => {
-            // we failed to read the file for some reason, but the file does exist
-            // fallback to generating new aliases on the fly
-
-            store.posix().await.unwrap_or_else(|e| {
-                format!("echo 'Atuin: failed to read and generate aliases: \n{r}\n{e}'",)
-            })
-        }
-    }
-}
-
-/// Return zsh dotfile config
-///
-/// Do not return an error. We should not prevent the shell from starting.
-///
-/// In the worst case, Atuin should not function but the shell should start correctly.
-///
-/// While currently this only returns aliases, it will be extended to also return other synced dotfiles
-pub async fn config(store: &AliasStore) -> String {
-    // First try to read the cached config
-    let aliases = atuin_common::utils::dotfiles_cache_dir().join("aliases.zsh");
-
-    if aliases.exists() {
-        return cached_aliases(aliases, store).await;
-    }
-
-    if let Err(e) = store.build().await {
-        return format!("echo 'Atuin: failed to generate aliases: {}'", e);
-    }
-
-    cached_aliases(aliases, store).await
-}
diff --git a/atuin-dotfiles/src/store.rs b/atuin-dotfiles/src/store.rs
deleted file mode 100644
index 425a5e1e..00000000
--- a/atuin-dotfiles/src/store.rs
+++ /dev/null
@@ -1,364 +0,0 @@
-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 posix(&self) -> Result<String> {
-        let aliases = self.aliases().await?;
-
-        let mut config = String::new();
-
-        for alias in aliases {
-            config.push_str(&format!("alias {}='{}'\n", alias.name, alias.value));
-        }
-
-        Ok(config)
-    }
-
-    pub async fn xonsh(&self) -> Result<String> {
-        let aliases = self.aliases().await?;
-
-        let mut config = String::new();
-
-        for alias in aliases {
-            config.push_str(&format!("aliases['{}'] ='{}'\n", alias.name, alias.value));
-        }
-
-        Ok(config)
-    }
-
-    pub async fn build(&self) -> Result<()> {
-        let dir = atuin_common::utils::dotfiles_cache_dir();
-        tokio::fs::create_dir_all(dir.clone()).await?;
-
-        // Build for all supported shells
-        let posix = self.posix().await?;
-        let xonsh = self.xonsh().await?;
-
-        // All the same contents, maybe optimize in the future or perhaps there will be quirks
-        // per-shell
-        // I'd prefer separation atm
-        let zsh = dir.join("aliases.zsh");
-        let bash = dir.join("aliases.bash");
-        let fish = dir.join("aliases.fish");
-        let xsh = dir.join("aliases.xsh");
-
-        tokio::fs::write(zsh, &posix).await?;
-        tokio::fs::write(bash, &posix).await?;
-        tokio::fs::write(fish, &posix).await?;
-        tokio::fs::write(xsh, &xonsh).await?;
-
-        Ok(())
-    }
-
-    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?;
-
-        // set mutates shell config, so build again
-        self.build().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?;
-
-        // delete mutates shell config, so build again
-        self.build().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")
-            }
-        );
-    }
-}