use crate::proto::Directory; use crate::{proto, B3Digest, Error}; use futures::stream::BoxStream; use prost::Message; use std::ops::Deref; use std::path::Path; use std::sync::Arc; use tonic::async_trait; use tracing::{instrument, warn}; use super::utils::traverse_directory; use super::{DirectoryGraph, DirectoryPutter, DirectoryService, LeavesToRootValidator}; use crate::composition::{CompositionContext, ServiceBuilder}; #[derive(Clone)] pub struct SledDirectoryService { db: sled::Db, } impl SledDirectoryService { pub fn new>(p: P) -> Result { if p.as_ref() == Path::new("/") { return Err(sled::Error::Unsupported( "cowardly refusing to open / with sled".to_string(), )); } let config = sled::Config::default() .use_compression(false) // is a required parameter .path(p); let db = config.open()?; Ok(Self { db }) } pub fn new_temporary() -> Result { let config = sled::Config::default().temporary(true); let db = config.open()?; Ok(Self { db }) } } #[async_trait] impl DirectoryService for SledDirectoryService { #[instrument(skip(self, digest), fields(directory.digest = %digest))] async fn get(&self, digest: &B3Digest) -> Result, Error> { let resp = tokio::task::spawn_blocking({ let db = self.db.clone(); let digest = digest.clone(); move || db.get(digest.as_slice()) }) .await? .map_err(|e| { warn!("failed to retrieve directory: {}", e); Error::StorageError(format!("failed to retrieve directory: {}", e)) })?; match resp { // The directory was not found, return None => Ok(None), // The directory was found, try to parse the data as Directory message Some(data) => match Directory::decode(&*data) { Ok(directory) => { // Validate the retrieved Directory indeed has the // digest we expect it to have, to detect corruptions. let actual_digest = directory.digest(); if actual_digest != *digest { return Err(Error::StorageError(format!( "requested directory with digest {}, but got {}", digest, actual_digest ))); } // Validate the Directory itself is valid. if let Err(e) = directory.validate() { warn!("directory failed validation: {}", e.to_string()); return Err(Error::StorageError(format!( "directory {} failed validation: {}", actual_digest, e, ))); } Ok(Some(directory)) } Err(e) => { warn!("unable to parse directory {}: {}", digest, e); Err(Error::StorageError(e.to_string())) } }, } } #[instrument(skip(self, directory), fields(directory.digest = %directory.digest()))] async fn put(&self, directory: proto::Directory) -> Result { tokio::task::spawn_blocking({ let db = self.db.clone(); move || { let digest = directory.digest(); // validate the directory itself. if let Err(e) = directory.validate() { return Err(Error::InvalidRequest(format!( "directory {} failed validation: {}", digest, e, ))); } // store it db.insert(digest.as_slice(), directory.encode_to_vec()) .map_err(|e| Error::StorageError(e.to_string()))?; Ok(digest) } }) .await? } #[instrument(skip_all, fields(directory.digest = %root_directory_digest))] fn get_recursive( &self, root_directory_digest: &B3Digest, ) -> BoxStream<'static, Result> { traverse_directory(self.clone(), root_directory_digest) } #[instrument(skip_all)] fn put_multiple_start(&self) -> Box<(dyn DirectoryPutter + 'static)> where Self: Clone, { Box::new(SledDirectoryPutter { tree: self.db.deref().clone(), directory_validator: Some(Default::default()), }) } } #[derive(serde::Deserialize)] #[serde(deny_unknown_fields)] pub struct SledDirectoryServiceConfig { is_temporary: bool, #[serde(default)] /// required when is_temporary = false path: Option, } impl TryFrom for SledDirectoryServiceConfig { type Error = Box; fn try_from(url: url::Url) -> Result { // sled doesn't support host, and a path can be provided (otherwise // it'll live in memory only). if url.has_host() { return Err(Error::StorageError("no host allowed".to_string()).into()); } // TODO: expose compression and other parameters as URL parameters? Ok(if url.path().is_empty() { SledDirectoryServiceConfig { is_temporary: true, path: None, } } else { SledDirectoryServiceConfig { is_temporary: false, path: Some(url.path().to_string()), } }) } } #[async_trait] impl ServiceBuilder for SledDirectoryServiceConfig { type Output = dyn DirectoryService; async fn build<'a>( &'a self, _instance_name: &str, _context: &CompositionContext, ) -> Result, Box> { match self { SledDirectoryServiceConfig { is_temporary: true, path: None, } => Ok(Arc::new(SledDirectoryService::new_temporary()?)), SledDirectoryServiceConfig { is_temporary: true, path: Some(_), } => Err(Error::StorageError( "Temporary SledDirectoryService can not have path".into(), ) .into()), SledDirectoryServiceConfig { is_temporary: false, path: None, } => Err(Error::StorageError("SledDirectoryService is missing path".into()).into()), SledDirectoryServiceConfig { is_temporary: false, path: Some(path), } => Ok(Arc::new(SledDirectoryService::new(path)?)), } } } /// Buffers Directory messages to be uploaded and inserts them in a batch /// transaction on close. pub struct SledDirectoryPutter { tree: sled::Tree, /// The directories (inside the directory validator) that we insert later, /// or None, if they were already inserted. directory_validator: Option>, } #[async_trait] impl DirectoryPutter for SledDirectoryPutter { #[instrument(level = "trace", skip_all, fields(directory.digest=%directory.digest()), err)] async fn put(&mut self, directory: proto::Directory) -> Result<(), Error> { match self.directory_validator { None => return Err(Error::StorageError("already closed".to_string())), Some(ref mut validator) => { validator .add(directory) .map_err(|e| Error::StorageError(e.to_string()))?; } } Ok(()) } #[instrument(level = "trace", skip_all, ret, err)] async fn close(&mut self) -> Result { match self.directory_validator.take() { None => Err(Error::InvalidRequest("already closed".to_string())), Some(validator) => { // Insert all directories as a batch. tokio::task::spawn_blocking({ let tree = self.tree.clone(); move || { // retrieve the validated directories. let directories = validator .validate() .map_err(|e| Error::StorageError(e.to_string()))? .drain_leaves_to_root() .collect::>(); // Get the root digest, which is at the end (cf. insertion order) let root_digest = directories .last() .ok_or_else(|| Error::InvalidRequest("got no directories".to_string()))? .digest(); let mut batch = sled::Batch::default(); for directory in directories { batch.insert(directory.digest().as_slice(), directory.encode_to_vec()); } tree.apply_batch(batch).map_err(|e| { Error::StorageError(format!("unable to apply batch: {}", e)) })?; Ok(root_digest) } }) .await? } } } }