// // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. // use std::pin::Pin; use anyhow::Result; use anyhow::anyhow; use futures::stream::StreamExt; use futures::task::Poll; use crate::Node; use crate::NodeId; use crate::DagBackend; /// An async DAG, generic over Node, Node identifier and Backend implementation pub struct AsyncDag where Id: NodeId + Send, N: Node, Backend: DagBackend { head: Id, backend: Backend, _node: std::marker::PhantomData, } impl AsyncDag where Id: NodeId + Send, N: Node, Backend: DagBackend { pub async fn new(backend: Backend, head: N) -> Result { backend .get(head.id().clone()) .await? .map(|node| { AsyncDag { head: node.id().clone(), backend: backend, _node: std::marker::PhantomData, } }) .ok_or_else(|| anyhow!("Head not found in backend")) } pub async fn has_id(&self, id: &Id) -> Result { self.stream() .map(|r| -> Result { r.map(|node| node.id() == id) }) .collect::>>() .await .into_iter() .fold(Ok(false), |acc, e| { match (acc, e) { (Err(e), _) => Err(e), (Ok(_), Err(e)) => Err(e), (Ok(a), Ok(b)) => Ok(a || b), } }) } pub async fn get_next(&self, id: Id) -> Result> { self.backend .get(id) .await? .ok_or_else(|| anyhow!("ID Not found"))? .parent_ids() .into_iter() .map(|id| async move { self.backend .get(id) .await .transpose() }) .collect::>() .collect::>() .await .into_iter() .filter_map(|o| o) .collect() } pub fn stream(&self) -> Stream { Stream { dag: self, backlog: { let mut v = Vec::with_capacity(2); v.push(self.backend.get(self.head.clone())); v } } } pub async fn update_head(&mut self, node: N) -> Result { if node.parent_ids().iter().any(|id| id == &self.head) { self.update_head_unchecked(node).await } else { Err(anyhow!("Node does not have HEAD as parent")) } } pub async fn update_head_unchecked(&mut self, node: N) -> Result { let id = self.backend.put(node).await?; self.head = id.clone(); Ok(id) } /// Branch from the current head. /// /// This function creates a new AsyncDag object with the same backend (thus the backend must be /// `Clone` in this case). pub fn branch(&self) -> AsyncDag where Backend: Clone { AsyncDag { head: self.head.clone(), backend: self.backend.clone(), _node: std::marker::PhantomData, } } /// Merge another AsyncDag into this one /// /// Use the `merger` function to merge the two head IDs and generate a new Node instance for /// the new HEAD of `self`. pub async fn merge(&mut self, other: &AsyncDag, merger: M) -> Result where M: Merger { let node = merger.create_merge_node(&self.head, &other.head)?; let id = self.backend.put(node).await?; self.head = id.clone(); Ok(id) } } pub trait Merger where Id: NodeId, N: Node { fn create_merge_node(&self, left_id: &Id, right_id: &Id) -> Result; } pub struct Stream<'a, Id, N, Backend> where Id: NodeId + Send, N: Node, Backend: DagBackend { dag: &'a AsyncDag, backlog: Vec>> + std::marker::Send + 'a)>>>, } impl<'a, Id, N, Backend> futures::stream::Stream for Stream<'a, Id, N, Backend> where Id: NodeId + Send, N: Node, Backend: DagBackend { type Item = Result; /// Attempt to resolve the next item in the stream. /// Returns `Poll::Pending` if not ready, `Poll::Ready(Some(x))` if a value /// is ready, and `Poll::Ready(None)` if the stream has completed. fn poll_next(mut self: std::pin::Pin<&mut Self>, cx: &mut futures::task::Context<'_>) -> futures::task::Poll> { if let Some(mut fut) = self.as_mut().backlog.pop() { match fut.as_mut().poll(cx) { Poll::Ready(Err(e)) => Poll::Ready(Some(Err(e))), Poll::Ready(Ok(Some(node))) => { for parent in node.parent_ids().into_iter() { let fut = self.dag.backend.get(parent); self.as_mut().backlog.push(fut); } Poll::Ready(Some(Ok(node))) }, Poll::Ready(Ok(None)) => { // backend.get() returned Ok(None), so the referenced node seems not to exist // // TODO: Decide whether we should return an error here. cx.waker().wake_by_ref(); Poll::Pending }, Poll::Pending => { cx.waker().wake_by_ref(); Poll::Pending } } } else { Poll::Ready(None) } } } #[cfg(test)] mod tests { use std::pin::Pin; use anyhow::Result; use anyhow::anyhow; use async_trait::async_trait; use tokio_test::block_on; use futures::StreamExt; use crate::DagBackend; use crate::AsyncDag; use crate::test_impl as test; #[test] fn test_dag_two_nodes() { let head = test::Node { id: test::Id(1), parents: vec![test::Id(0)], data: 43, }; let b = test::Backend::new(vec![ { Some(test::Node { id: test::Id(0), parents: vec![], data: 42, }) }, { Some(head.clone()) }, ]); { let node = tokio_test::block_on(b.get(test::Id(1))).unwrap().unwrap(); assert_eq!(node.data, 43); assert_eq!(node.id, test::Id(1)); assert!(!node.parents.is_empty()); // to check whether the parent is set } let dag = tokio_test::block_on(AsyncDag::new(b, head)); assert!(dag.is_ok()); let dag = dag.unwrap(); { let has_id = tokio_test::block_on(dag.has_id(&test::Id(0))); assert!(has_id.is_ok()); let has_id = has_id.unwrap(); assert!(has_id); } { let has_id = tokio_test::block_on(dag.has_id(&test::Id(1))); assert!(has_id.is_ok()); let has_id = has_id.unwrap(); assert!(has_id); } { let next = tokio_test::block_on(dag.get_next(test::Id(1))); assert!(next.is_ok()); let mut next = next.unwrap(); assert_eq!(next.len(), 1); let node = next.pop(); assert!(node.is_some()); let node = node.unwrap(); assert_eq!(node.id, test::Id(0)); assert_eq!(node.data, 42); assert!(node.parents.is_empty()); } } #[test] fn test_dag_two_nodes_stream() { let head = test::Node { id: test::Id(1), parents: vec![test::Id(0)], data: 43, }; let b = test::Backend::new(vec![ { Some(test::Node { id: test::Id(0), parents: vec![], data: 42, }) }, { Some(head.clone()) }, ]); let dag = tokio_test::block_on(AsyncDag::new(b, head)); assert!(dag.is_ok()); let dag = dag.unwrap(); let v = tokio_test::block_on(dag.stream().collect::>()); assert_eq!(v.len(), 2, "Expected two nodes: {:?}", v); assert_eq!(v[0].as_ref().unwrap().id, test::Id(1)); assert_eq!(v[1].as_ref().unwrap().id, test::Id(0)); } #[test] fn test_adding_head() { let head = test::Node { id: test::Id(0), parents: vec![], data: 42, }; let b = test::Backend::new(vec![Some(head.clone())]); let dag = tokio_test::block_on(AsyncDag::new(b, head)); assert!(dag.is_ok()); let mut dag = dag.unwrap(); let new_head = test::Node { id: test::Id(1), parents: vec![test::Id(0)], data: 43, }; assert_eq!(dag.backend.0.read().unwrap().len(), 1); assert_eq!(dag.head, test::Id(0)); let id = tokio_test::block_on(dag.update_head(new_head)); assert!(id.is_ok()); let id = id.unwrap(); assert_eq!(dag.backend.0.read().unwrap().len(), 2); assert_eq!(dag.head, test::Id(1)); assert_eq!(dag.backend.0.read().unwrap()[0].as_ref().unwrap().id, test::Id(0)); assert!(dag.backend.0.read().unwrap()[0].as_ref().unwrap().parents.is_empty()); assert_eq!(dag.backend.0.read().unwrap()[1].as_ref().unwrap().id, test::Id(1)); assert_eq!(dag.backend.0.read().unwrap()[1].as_ref().unwrap().parents.len(), 1); assert_eq!(dag.backend.0.read().unwrap()[1].as_ref().unwrap().parents[0], test::Id(0)); } #[test] fn test_branch() { let mut dag = { let head = test::Node { id: test::Id(0), parents: vec![], data: 42, }; let b = test::Backend::new(vec![Some(head.clone())]); let dag = tokio_test::block_on(AsyncDag::new(b, head)); assert!(dag.is_ok()); dag.unwrap() }; let branched = dag.branch(); { assert_eq!(dag.backend.0.read().unwrap().len(), 1); assert_eq!(dag.head, test::Id(0)); let new_head = test::Node { id: test::Id(1), parents: vec![test::Id(0)], data: 43, }; let id = tokio_test::block_on(dag.update_head(new_head)); assert!(id.is_ok()); let id = id.unwrap(); assert_eq!(dag.backend.0.read().unwrap().len(), 2); assert_eq!(dag.head, test::Id(1)); } assert_eq!(branched.backend.0.read().unwrap().len(), 2); assert_eq!(branched.head, test::Id(0)); } #[test] fn test_merging() { let mut dag = { let head = test::Node { id: test::Id(0), parents: vec![], data: 42, }; let b = test::Backend::new(vec![Some(head.clone())]); let dag = tokio_test::block_on(AsyncDag::new(b, head)); assert!(dag.is_ok()); dag.unwrap() }; let mut branched = dag.branch(); { assert_eq!(dag.backend.0.read().unwrap().len(), 1); assert_eq!(dag.head, test::Id(0)); let new_head = test::Node { id: test::Id(1), parents: vec![test::Id(0)], data: 43, }; let id = tokio_test::block_on(dag.update_head(new_head)); assert!(id.is_ok()); let id = id.unwrap(); assert_eq!(dag.backend.0.read().unwrap().len(), 2); assert_eq!(dag.head, test::Id(1)); } { assert_eq!(branched.backend.0.read().unwrap().len(), 2); assert_eq!(branched.head, test::Id(0)); let new_head = test::Node { id: test::Id(2), parents: vec![test::Id(0)], data: 44, }; let id = tokio_test::block_on(branched.update_head(new_head)); assert!(id.is_ok()); let id = id.unwrap(); assert_eq!(branched.backend.0.read().unwrap().len(), 3); assert_eq!(branched.head, test::Id(2)); } struct M; impl super::Merger for M { fn create_merge_node(&self, left_id: &test::Id, right_id: &test::Id) -> Result { Ok(test::Node { id: test::Id(3), parents: vec![left_id.clone(), right_id.clone()], data: 45, }) } } let merge = tokio_test::block_on(dag.merge(&branched, M)); assert!(merge.is_ok()); let merge = merge.unwrap(); assert_eq!(dag.backend.0.read().unwrap().len(), 4); assert_eq!(dag.head, test::Id(3)); } }