transact 0.4.7

/*
 * Copyright 2019 Bitwise IO, Inc.
 * Copyright 2019 Cargill Incorporated
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -----------------------------------------------------------------------------
 */
pub mod sync;

use std::collections::HashMap;
use std::collections::VecDeque;
use std::str;

use crate::collections::RefMap;
pub use crate::context::error::ContextManagerError;
use crate::context::{Context, ContextId, ContextLifecycle};
use crate::error::InternalError;
use crate::protocol::receipt::{Event, StateChange, TransactionReceipt, TransactionReceiptBuilder};
use crate::state::Read;

#[derive(Clone)]
pub struct ContextManager {
    contexts: HashMap<ContextId, Context>,
    context_refs: RefMap<ContextId>,
    database: Box<dyn Read<StateId = String, Key = String, Value = Vec<u8>>>,
}

impl ContextLifecycle for ContextManager {
    /// Creates a Context, and returns the resulting ContextId.
    fn create_context(&mut self, dependent_contexts: &[ContextId], state_id: &str) -> ContextId {
        for ctx_id in dependent_contexts {
            self.context_refs.add_ref(*ctx_id);
        }

        let new_context = Context::new(state_id, dependent_contexts.to_vec());
        self.contexts.insert(*new_context.id(), new_context.clone());
        self.context_refs.add_ref(*new_context.id());
        *new_context.id()
    }

    fn drop_context(&mut self, context_id: ContextId) -> Result<(), InternalError> {
        let mut contexts = VecDeque::new();
        contexts.push_back(context_id);

        while let Some(context_id) = contexts.pop_front() {
            if let Ok(Some(_)) = self.context_refs.remove_ref(&context_id) {
                if let Some(context) = self.contexts.remove(&context_id) {
                    contexts.extend(context.base_contexts.into_iter());
                } else {
                    return Err(InternalError::with_message(
                        "Failed to remove a context whose ref count was 0 \
                         but was not in the context collection"
                            .into(),
                    ));
                }
            }
        }
        Ok(())
    }

    /// Generates a valid `TransactionReceipt` based on the information available within the
    /// specified `Context`.
    fn get_transaction_receipt(
        &self,
        context_id: &ContextId,
        transaction_id: &str,
    ) -> Result<TransactionReceipt, ContextManagerError> {
        let context = self.get_context(context_id)?;
        let new_transaction_receipt = TransactionReceiptBuilder::new()
            .valid()
            .with_state_changes(context.state_changes().to_vec())
            .with_events(context.events().to_vec())
            .with_data(context.data().to_vec())
            .with_transaction_id(transaction_id.to_string())
            .build()?;
        Ok(new_transaction_receipt)
    }

    fn clone_box(&self) -> Box<dyn ContextLifecycle> {
        Box::new(self.clone())
    }
}

impl ContextManager {
    pub fn new(database: Box<dyn Read<StateId = String, Key = String, Value = Vec<u8>>>) -> Self {
        ContextManager {
            contexts: HashMap::new(),
            context_refs: RefMap::new(),
            database,
        }
    }

    /// Returns a mutable Context within the ContextManager's Context list specified by the ContextId
    fn get_context_mut(
        &mut self,
        context_id: &ContextId,
    ) -> Result<&mut Context, ContextManagerError> {
        self.contexts
            .get_mut(context_id)
            .ok_or_else(|| ContextManagerError::MissingContextError(context_id.to_string()))
    }

    /// Returns a Context within the ContextManager's Context list specified by the ContextId
    fn get_context(&self, context_id: &ContextId) -> Result<&Context, ContextManagerError> {
        self.contexts
            .get(context_id)
            .ok_or_else(|| ContextManagerError::MissingContextError(context_id.to_string()))
    }

    /// Get the values associated with list of keys, from a specific Context.
    /// If a key is not found in the context, State is then checked for these keys.
    /// Keys are returned with the associated value, if found in Context or State.
    pub fn get(
        &self,
        context_id: &ContextId,
        keys: &[String],
    ) -> Result<Vec<(String, Vec<u8>)>, ContextManagerError> {
        let mut key_values = Vec::new();
        for key in keys.iter().rev() {
            let mut context = self.get_context(context_id)?;
            let mut contexts = VecDeque::new();
            for context_id in context.base_contexts().iter() {
                contexts.push_back(self.get_context(context_id)?);
            }
            if !context.contains(key) && !contexts.is_empty() {
                while let Some(current_context) = contexts.pop_front() {
                    context = current_context;
                    if current_context.contains(key) {
                        break;
                    } else {
                        for context_id in context.base_contexts().iter() {
                            contexts.push_back(self.get_context(context_id)?);
                        }
                    }
                }
            }
            if context.contains(key) {
                if let Some(StateChange::Set { key: k, value: v }) = context
                    .state_changes()
                    .iter()
                    .rev()
                    .find(|state_change| state_change.has_key(key))
                {
                    key_values.push((k.clone(), v.clone()));
                }
            } else if let Some(v) = self
                .database
                .get(context.state_id(), &[key.to_string()])?
                .get(key)
            {
                key_values.push((key.to_string(), v.clone()));
            }
        }
        Ok(key_values)
    }

    /// Adds a StateChange::Set to the specified Context
    pub fn set_state(
        &mut self,
        context_id: &ContextId,
        key: String,
        value: Vec<u8>,
    ) -> Result<(), ContextManagerError> {
        let context = self.get_context_mut(context_id)?;
        context.set_state(key, value);
        Ok(())
    }

    /// Adds a StateChange::Delete to the specified Context, returning the value, if found, that is
    /// associated with the specified key.
    pub fn delete_state(
        &mut self,
        context_id: &ContextId,
        key: &str,
    ) -> Result<Option<Vec<u8>>, ContextManagerError> {
        // Adding a StateChange::Delete to the specified Context, which will occur no matter which
        // Context or State the key and associated value is found in.
        let context_value = self.get_context_mut(context_id)?.delete_state(key);
        if let Some(value) = context_value {
            return Ok(Some(value));
        }

        let current_context = self.get_context(context_id)?;
        let mut containing_context = self.get_context(context_id)?;

        let mut contexts = VecDeque::new();
        contexts.push_front(containing_context);
        // Adding dependent Contexts to search for the Key
        for context_id in containing_context.base_contexts().iter() {
            contexts.push_back(self.get_context(context_id)?);
        }

        while let Some(context) = contexts.pop_front() {
            if context.contains(key) {
                containing_context = context;
                break;
            } else {
                for context_id in context.base_contexts().iter() {
                    contexts.push_back(self.get_context(context_id)?);
                }
            }
        }
        if containing_context.contains(key) {
            if let Some(v) = containing_context.get_state(key) {
                return Ok(Some(v.to_vec()));
            }
        } else if let Some(value) = self
            .database
            .get(current_context.state_id(), &[key.to_string()])?
            .get(&key.to_string())
        {
            return Ok(Some(value.to_vec()));
        }
        Ok(None)
    }

    /// Adds an Event to the specified Context.
    pub fn add_event(
        &mut self,
        context_id: &ContextId,
        event: Event,
    ) -> Result<(), ContextManagerError> {
        let context = self.get_context_mut(context_id)?;
        context.add_event(event);
        Ok(())
    }

    /// Adds Data to the specified Context.
    pub fn add_data(
        &mut self,
        context_id: &ContextId,
        data: Vec<u8>,
    ) -> Result<(), ContextManagerError> {
        let context = self.get_context_mut(context_id)?;
        context.add_data(data);
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashMap;

    use crate::protocol::receipt::{EventBuilder, TransactionResult};
    use crate::state;
    use crate::state::hashmap::HashMapState;
    use crate::state::Write;

    static KEY1: &str = "111111111111111111111111111111111111111111111111111111111111111111";
    static KEY2: &str = "222222222222222222222222222222222222222222222222222222222222222222";
    static KEY3: &str = "333333333333333333333333333333333333333333333333333333333333333333";
    static KEY4: &str = "444444444444444444444444444444444444444444444444444444444444444444";
    static KEY5: &str = "555555555555555555555555555555555555555555555555555555555555555555";

    static BYTES1: [u8; 4] = [0x01, 0x02, 0x03, 0x04];
    static BYTES2: [u8; 4] = [0x05, 0x06, 0x07, 0x08];
    static BYTES3: [u8; 4] = [0x09, 0x10, 0x11, 0x12];
    static BYTES4: [u8; 4] = [0x13, 0x14, 0x15, 0x16];

    static EVENT_TYPE1: &str = "sawtooth/block-commit";
    static ATTR1: (&str, &str) = (
        "block_id",
        "f40b90d06b4a9074af2ab09e0187223da7466be75ec0f472 \
         f2edd5f22960d76e402e6c07c90b7816374891d698310dd25d9b88dce7dbcba8219d9f7c9cae1861",
    );
    static ATTR2: (&str, &str) = ("block_num", "3");

    fn make_manager(state_changes: Option<Vec<state::StateChange>>) -> (ContextManager, String) {
        let state = HashMapState::new();
        let mut state_id = HashMapState::state_id(&HashMap::new());
        if let Some(changes) = state_changes {
            state_id = state.commit(&state_id, changes.as_slice()).unwrap();
        }

        (ContextManager::new(Box::new(state)), state_id)
    }

    fn check_state_change(state_change: StateChange) {
        match state_change {
            StateChange::Set { key, value } => {
                assert_eq!(KEY1, key);
                assert_eq!(BYTES1.to_vec(), value);
            }
            StateChange::Delete { key } => {
                assert_eq!(KEY1, key);
            }
        }
    }

    fn check_transaction_receipt(transaction_receipt: TransactionReceipt, event: Event) {
        match transaction_receipt.transaction_result {
            TransactionResult::Valid {
                state_changes,
                events,
                data,
            } => {
                for state_change in state_changes {
                    check_state_change(state_change)
                }
                assert_eq!(vec!(event), events);
                assert_eq!(vec!(BYTES2.to_vec()), data);
            }
            TransactionResult::Invalid { .. } => panic!("transaction result is invalid"),
        }
    }

    #[test]
    fn create_contexts() {
        let (mut manager, state_id) = make_manager(None);
        let first_context_id = manager.create_context(&[], &state_id);
        assert!(!manager.contexts.is_empty());
        assert!(manager.contexts.get(&first_context_id).is_some());

        let second_context_id = manager.create_context(&[], &state_id);
        let second_context = manager.get_context(&second_context_id).unwrap();
        assert_eq!(&second_context_id, second_context.id());
        assert_eq!(manager.contexts.len(), 2);
    }

    #[test]
    fn add_context_event() {
        let (mut manager, state_id) = make_manager(None);
        let context_id = manager.create_context(&[], &state_id);
        let event = EventBuilder::new()
            .with_event_type(EVENT_TYPE1.to_string())
            .with_attributes(vec![
                (ATTR1.0.to_string(), ATTR1.1.to_string()),
                (ATTR2.0.to_string(), ATTR2.1.to_string()),
            ])
            .with_data(BYTES1.to_vec())
            .build()
            .unwrap();
        let event_add_result = manager.add_event(&context_id, event.clone());
        assert!(event_add_result.is_ok());
        let context = manager.get_context(&context_id).unwrap();
        assert_eq!(context.events()[0], event.clone());
    }

    #[test]
    fn add_context_data() {
        let (mut manager, state_id) = make_manager(None);
        let context_id = manager.create_context(&[], &state_id);

        let data_add_result = manager.add_data(&context_id, BYTES2.to_vec());
        let context = manager.get_context(&context_id).unwrap();
        assert!(data_add_result.is_ok());
        assert_eq!(context.data()[0], BYTES2);
    }

    #[test]
    fn create_transaction_receipt() {
        let (mut manager, state_id) = make_manager(None);

        let context_id = manager.create_context(&[], &state_id);
        let mut context = manager.get_context(&context_id).unwrap();
        assert_eq!(&context_id, context.id());

        let set_result = manager.set_state(&context_id, KEY1.to_string(), BYTES3.to_vec());
        assert!(set_result.is_ok());
        let delete_result = manager.delete_state(&context_id, KEY1).unwrap();
        assert!(delete_result.is_some());

        // Adding an Event to the Context, to be used to build the TransactionReceipt
        let event = EventBuilder::new()
            .with_event_type(EVENT_TYPE1.to_string())
            .with_attributes(vec![
                (ATTR1.0.to_string(), ATTR1.1.to_string()),
                (ATTR2.0.to_string(), ATTR2.1.to_string()),
            ])
            .with_data(BYTES1.to_vec())
            .build()
            .unwrap();
        let event_add_result = manager.add_event(&context_id, event.clone());
        assert!(event_add_result.is_ok());
        context = manager.get_context(&context_id).unwrap();
        assert_eq!(context.events()[0], event.clone());

        // Adding Data to the Context, to be used to build the TransactionReceipt
        let data_add_result = manager.add_data(&context_id, BYTES2.to_vec());
        context = manager.get_context(&context_id).unwrap();
        assert!(data_add_result.is_ok());
        assert_eq!(context.data()[0], BYTES2);

        // Building the TransactionReceipt from the objects within the specified Context
        let transaction_receipt = manager.get_transaction_receipt(&context_id, KEY2).unwrap();
        check_transaction_receipt(transaction_receipt, event)
    }

    #[test]
    fn add_set_state_change() {
        let (mut manager, state_id) = make_manager(None);

        let context_id = manager.create_context(&[], &state_id);

        let set_result = manager.set_state(&context_id, KEY1.to_string(), BYTES3.to_vec());
        assert!(set_result.is_ok());

        let get_value = manager
            .get_context(&context_id)
            .unwrap()
            .get_state(&KEY1.to_string());
        assert_eq!(get_value, Some(BYTES3.as_ref()));
    }

    #[test]
    fn add_delete_state_change() {
        // Creating a ContextManager with a single Context.
        let state_changes = vec![state::StateChange::Set {
            key: KEY1.to_string(),
            value: BYTES1.to_vec(),
        }];
        let (mut manager, state_id) = make_manager(Some(state_changes));
        let ancestor_context = manager.create_context(&[], &state_id);

        assert!(manager
            .set_state(&ancestor_context, KEY2.to_string(), BYTES2.to_vec())
            .is_ok());

        let current_context_id = manager.create_context(&[ancestor_context], &state_id);
        assert!(manager
            .set_state(&current_context_id, KEY3.to_string(), BYTES3.to_vec())
            .is_ok());
        assert!(manager
            .set_state(&current_context_id, KEY4.to_string(), BYTES4.to_vec())
            .is_ok());

        let deleted_state_value = manager.delete_state(&current_context_id, KEY1).unwrap();
        assert!(deleted_state_value.is_some());
        assert_eq!(deleted_state_value, Some(BYTES1.to_vec()));

        let deleted_ancestor_value = manager.delete_state(&current_context_id, KEY2).unwrap();
        assert!(deleted_ancestor_value.is_some());
        assert_eq!(deleted_ancestor_value, Some(BYTES2.to_vec()));

        let deleted_current_value = manager.delete_state(&current_context_id, KEY3).unwrap();
        assert!(deleted_current_value.is_some());
        assert_eq!(deleted_current_value, Some(BYTES3.to_vec()));

        assert!(manager
            .delete_state(&current_context_id, KEY5)
            .unwrap()
            .is_none());
    }

    #[test]
    fn get_values() {
        // Creating a ContextManager with a single Context, with a HashMapState backing it
        let state_changes = vec![state::StateChange::Set {
            key: KEY1.to_string(),
            value: BYTES1.to_vec(),
        }];
        let (mut manager, state_id) = make_manager(Some(state_changes));
        let ancestor_context = manager.create_context(&[], &state_id);
        let add_result = manager.set_state(&ancestor_context, KEY2.to_string(), BYTES2.to_vec());
        assert!(add_result.is_ok());

        let context_id = manager.create_context(&[ancestor_context], &state_id);

        // Validates the result from adding the state change to the Context within the ContextManager.
        assert!(manager
            .set_state(&context_id, KEY3.to_string(), BYTES3.to_vec())
            .is_ok());
        assert!(manager
            .set_state(&context_id, KEY4.to_string(), BYTES4.to_vec())
            .is_ok());
        assert!(manager.delete_state(&context_id, KEY4).unwrap().is_some());

        // Creating a collection of keys to retrieve the values saved in Context or State.
        let keys = [
            KEY1.to_string(),
            KEY2.to_string(),
            KEY4.to_string(),
            KEY5.to_string(),
        ];
        let mut key_values = manager.get(&context_id, &keys).unwrap();
        // Two Values are found from the Keys list as KEY4 was deleted and KEY5 does not exist
        assert_eq!(key_values.len(), 2);
        assert_eq!(
            key_values.pop().unwrap(),
            (KEY1.to_string(), BYTES1.to_vec())
        );
        assert_eq!(
            key_values.pop().unwrap(),
            (KEY2.to_string(), BYTES2.to_vec())
        );
    }

    /// Test that a context with no base contexts may be dropped.
    /// 1) Create a context
    /// 2) Add some state to it
    /// 3) Drop the context
    /// 4) Validate that the context can no longer be used.
    #[test]
    fn drop_context_with_no_dependencies() -> Result<(), Box<dyn std::error::Error>> {
        let state_changes = vec![state::StateChange::Set {
            key: KEY1.to_string(),
            value: BYTES1.to_vec(),
        }];
        let (mut manager, state_id) = make_manager(Some(state_changes));
        let context_id = manager.create_context(&[], &state_id);
        manager.set_state(&context_id, KEY2.to_string(), BYTES2.to_vec())?;

        manager.drop_context(context_id.clone())?;

        assert!(matches!(
            manager.set_state(&context_id, KEY3.to_string(), BYTES3.to_vec()),
            Err(ContextManagerError::MissingContextError { .. })
        ));

        Ok(())
    }

    /// Test that a context with base contexts may be dropped
    /// 1) Create a parent context
    /// 2) Create a context with the parent as its base context
    /// 3) Add some state to it
    /// 4) Drop the ancestor context
    /// 5) Validate that the ancestor is still available
    /// 6) Drop the context
    /// 7) Validate that both the ancestor context and the context are no longer available
    #[test]
    fn drop_context_with_dependencies() -> Result<(), Box<dyn std::error::Error>> {
        let state_changes = vec![state::StateChange::Set {
            key: KEY1.to_string(),
            value: BYTES1.to_vec(),
        }];
        let (mut manager, state_id) = make_manager(Some(state_changes));
        let ancestor_context = manager.create_context(&[], &state_id);
        manager.set_state(&ancestor_context, KEY2.to_string(), BYTES2.to_vec())?;

        let context_id = manager.create_context(&[ancestor_context], &state_id);
        manager.set_state(&context_id, KEY3.to_string(), BYTES3.to_vec())?;

        manager.drop_context(ancestor_context.clone())?;

        assert!(manager.get_context(&ancestor_context).is_ok());

        manager.drop_context(context_id.clone())?;

        assert!(
            matches!(
                manager.get_context(&context_id),
                Err(ContextManagerError::MissingContextError { .. })
            ),
            "Did not drop context"
        );

        assert!(
            matches!(
                manager.get_context(&ancestor_context),
                Err(ContextManagerError::MissingContextError { .. })
            ),
            "Did not drop ancestor context"
        );

        Ok(())
    }
}