use crate::composition::{Registry, ServiceBuilder}; use crate::{B3Digest, Directory, Error}; use futures::stream::BoxStream; use tonic::async_trait; mod combinators; mod directory_graph; mod from_addr; mod grpc; mod memory; mod object_store; mod order_validator; mod redb; mod simple_putter; mod sled; #[cfg(test)] pub mod tests; mod traverse; mod utils; pub use self::combinators::{Cache, CacheConfig}; pub use self::directory_graph::DirectoryGraph; pub use self::from_addr::from_addr; pub use self::grpc::{GRPCDirectoryService, GRPCDirectoryServiceConfig}; pub use self::memory::{MemoryDirectoryService, MemoryDirectoryServiceConfig}; pub use self::object_store::{ObjectStoreDirectoryService, ObjectStoreDirectoryServiceConfig}; pub use self::order_validator::{LeavesToRootValidator, OrderValidator, RootToLeavesValidator}; pub use self::redb::{RedbDirectoryService, RedbDirectoryServiceConfig}; pub use self::simple_putter::SimplePutter; pub use self::sled::{SledDirectoryService, SledDirectoryServiceConfig}; pub use self::traverse::descend_to; pub use self::utils::traverse_directory; #[cfg(feature = "cloud")] mod bigtable; #[cfg(feature = "cloud")] pub use self::bigtable::{BigtableDirectoryService, BigtableParameters}; /// The base trait all Directory services need to implement. /// This is a simple get and put of [Directory], returning their /// digest. #[async_trait] pub trait DirectoryService: Send + Sync { /// Looks up a single Directory message by its digest. /// The returned Directory message *must* be valid. /// In case the directory is not found, Ok(None) is returned. /// /// It is okay for certain implementations to only allow retrieval of /// Directory digests that are at the "root", aka the last element that's /// sent to a DirectoryPutter. This makes sense for implementations bundling /// closures of directories together in batches. async fn get(&self, digest: &B3Digest) -> Result, Error>; /// Uploads a single Directory message, and returns the calculated /// digest, or an error. An error *must* also be returned if the message is /// not valid. async fn put(&self, directory: Directory) -> Result; /// Looks up a closure of [Directory]. /// Ideally this would be a `impl Stream>`, /// and we'd be able to add a default implementation for it here, but /// we can't have that yet. /// /// This returns a pinned, boxed stream. The pinning allows for it to be polled easily, /// and the box allows different underlying stream implementations to be returned since /// Rust doesn't support this as a generic in traits yet. This is the same thing that /// [async_trait] generates, but for streams instead of futures. /// /// The individually returned Directory messages *must* be valid. /// Directories are sent in an order from the root to the leaves, so that /// the receiving side can validate each message to be a connected to the root /// that has initially been requested. /// /// In case the directory can not be found, this should return an empty stream. fn get_recursive( &self, root_directory_digest: &B3Digest, ) -> BoxStream<'static, Result>; /// Allows persisting a closure of [Directory], which is a graph of /// connected Directory messages. fn put_multiple_start(&self) -> Box; } #[async_trait] impl DirectoryService for A where A: AsRef + Send + Sync, { async fn get(&self, digest: &B3Digest) -> Result, Error> { self.as_ref().get(digest).await } async fn put(&self, directory: Directory) -> Result { self.as_ref().put(directory).await } fn get_recursive( &self, root_directory_digest: &B3Digest, ) -> BoxStream<'static, Result> { self.as_ref().get_recursive(root_directory_digest) } fn put_multiple_start(&self) -> Box { self.as_ref().put_multiple_start() } } /// Provides a handle to put a closure of connected [Directory] elements. /// /// The consumer can periodically call [DirectoryPutter::put], starting from the /// leaves. Once the root is reached, [DirectoryPutter::close] can be called to /// retrieve the root digest (or an error). /// /// DirectoryPutters might be created without a single [DirectoryPutter::put], /// and then dropped without calling [DirectoryPutter::close], /// for example when ingesting a path that ends up not pointing to a directory, /// but a single file or symlink. #[async_trait] pub trait DirectoryPutter: Send { /// Put a individual [Directory] into the store. /// Error semantics and behaviour is up to the specific implementation of /// this trait. /// Due to bursting, the returned error might refer to an object previously /// sent via `put`. async fn put(&mut self, directory: Directory) -> Result<(), Error>; /// Close the stream, and wait for any errors. /// If there's been any invalid Directory message uploaded, and error *must* /// be returned. async fn close(&mut self) -> Result; } /// Registers the builtin DirectoryService implementations with the registry pub(crate) fn register_directory_services(reg: &mut Registry) { reg.register::>, super::directoryservice::ObjectStoreDirectoryServiceConfig>("objectstore"); reg.register::>, super::directoryservice::MemoryDirectoryServiceConfig>("memory"); reg.register::>, super::directoryservice::CacheConfig>("cache"); reg.register::>, super::directoryservice::GRPCDirectoryServiceConfig>("grpc"); reg.register::>, super::directoryservice::SledDirectoryServiceConfig>("sled"); reg.register::>, super::directoryservice::RedbDirectoryServiceConfig>("redb"); #[cfg(feature = "cloud")] { reg.register::>, super::directoryservice::BigtableParameters>("bigtable"); } }