cycles-quartz/crates/cli/src/cache.rs

use std::path::{Path, PathBuf};

use serde::{Deserialize, Serialize};
use tokio::{
    fs::File,
    io::{AsyncReadExt, BufReader},
};
use tracing::debug;
use xxhash_rust::xxh3::Xxh3;

use crate::{config::Config, error::Error};

const BUFFER_SIZE: usize = 16384; // 16 KB buffer
type Hash = u64;

#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
struct DeployedContract {
    code_id: u64,
    contract_hash: Hash,
}

// Porcelain

impl Config {
    pub async fn contract_has_changed(&self, file: &Path) -> Result<bool, Error> {
        let cur_hash: Hash = Self::gen_hash(file).await?;
        debug!("current file hash: {}", cur_hash);

        let cached_file_path = Self::to_cache_path(self, file)?;

        if !cached_file_path.exists() {
            return Ok(true);
        }

        let cached_contract = Self::read_from_cache(cached_file_path.as_path()).await?;
        debug!("cached file hash: {}", cached_contract.contract_hash);

        Ok(cur_hash != cached_contract.contract_hash)
    }

    /// Return a hash of the given file's contents
    pub async fn gen_hash(file: &Path) -> Result<Hash, Error> {
        let file = File::open(file)
            .await
            .map_err(|e| Error::GenericErr(e.to_string()))?;
        let mut reader = BufReader::new(file);

        let mut hasher = Xxh3::new();

        let mut buffer = [0; BUFFER_SIZE];
        loop {
            let bytes_read = reader
                .read(&mut buffer)
                .await
                .map_err(|e| Error::GenericErr(e.to_string()))?;
            if bytes_read == 0 {
                break;
            }
            hasher.update(&buffer[..bytes_read]);
        }

        // Finalize the hash
        let hash = hasher.digest();

        Ok(hash)
    }

    pub async fn save_codeid_to_cache(&self, file: &Path, code_id: u64) -> Result<(), Error> {
        let contract_hash = Self::gen_hash(file).await?;
        let dest = Self::to_cache_path(self, file)?;
        let deployed_contract = DeployedContract {
            code_id,
            contract_hash,
        };

        Self::write_to_cache(dest.as_path(), &deployed_contract).await
    }

    pub async fn get_cached_codeid(&self, file: &Path) -> Result<u64, Error> {
        let cache_path = Self::to_cache_path(self, file)?;
        let code_id = Self::read_from_cache(cache_path.as_path()).await?.code_id;

        Ok(code_id)
    }

    // Plumbing

    fn to_cache_path(&self, file: &Path) -> Result<PathBuf, Error> {
        // Get cache filepath (".quartz/cache/example.wasm.json") from "example.wasm" filepath
        let mut filename = file
            .file_name()
            .ok_or(Error::PathNotFile(file.display().to_string()))?
            .to_os_string();
        filename.push(".json");

        let cached_file_path = Self::cache_dir(self)?.join::<PathBuf>(filename.into());

        Ok(cached_file_path)
    }

    /// Retreive hash from cache file
    async fn read_from_cache(cache_file: &Path) -> Result<DeployedContract, Error> {
        let content = tokio::fs::read_to_string(cache_file)
            .await
            .map_err(|e| Error::GenericErr(e.to_string()))?;
        serde_json::from_str(&content).map_err(|e| Error::GenericErr(e.to_string()))
    }

    /// Write a given file's contents hash to a file in cache directory
    async fn write_to_cache(cache_file: &Path, data: &DeployedContract) -> Result<(), Error> {
        let content = serde_json::to_string(data).map_err(|e| Error::GenericErr(e.to_string()))?;
        tokio::fs::write(cache_file, content)
            .await
            .map_err(|e| Error::GenericErr(e.to_string()))
    }

    pub fn cache_dir(&self) -> Result<PathBuf, Error> {
        Ok(self.app_dir.join(".cache/"))
    }

    pub fn build_log_dir(&self) -> Result<PathBuf, Error> {
        Ok(self.app_dir.join(".cache/log/"))
    }

    /// Creates the build log if it isn't created already, returns relative path from app_dir to log directory
    pub async fn create_build_log(&self) -> Result<PathBuf, Error> {
        let log_dir = Self::build_log_dir(self)?;
        if !log_dir.exists() {
            tokio::fs::create_dir_all(&log_dir)
                .await
                .map_err(|e| Error::GenericErr(e.to_string()))?;
        }

        Ok(log_dir)
    }

    pub async fn log_build(&self, is_enclave: bool) -> Result<(), Error> {
        let log_dir = Self::create_build_log(self).await?;

        let filename = match is_enclave {
            true => "enclave",
            false => "contract",
        };

        tokio::fs::write(log_dir.join(filename), "test")
            .await
            .map_err(|e| Error::GenericErr(e.to_string()))?;

        Ok(())
    }
}