Issue #81 & #74 message repository (#82)

* validator - domain - validator - MessageRepository

* validator - persistence - validator - memory - dummy MemoryMessageRepository

* validator - domain - validator - MessageRepository - make `add` a method

* memory-repository - extract generic impl to be used in MemoryRepositories

* memory-repository - remove ExistCmp

* Cargo.toml - add `memory-repository` to workspace

* memory-repository - add denies: `clippy` & `rust_2018_idioms`

* sentry - Remove `derive(Debug)` from ChannelResource & ChannelRepository

* memory - make `cmp` function `Arc` & `Send` + `Sync` for thread safety requirements

* sentry - use `memory-repository`

* memory-repository - impl `list_all` & cleanup `list`

* [test] memory-repository - list_all

* memory-repository:
- cmp_value instead of direct record search
- `find()` method

* sentry - persistence - channel - memory - refactor to use `MemoryRepository`

* validator - Cargo.toml - add `memory-repository`

* memory-repository - add comment for the `new` method

* domain - validator - message - `derive(Clone)`

* sentry - persistence - channel - memory - fix `clippy` warnings

* validator - domain - validator - MessageRepository add generic for State

* validator - persistence - validator - MemoryMessageRepository `add()` impl

* domain - validator - ValidatorId

* domain - validator - message:
- add constants for all types
- Message - impl `is_type` & `is_types`

* validator - domain - validator - `latest` method
- persistence - validator - MemoryMessageRepository - `latest` method
- persistence - validator - MemoryMessageRepository - `add` method fix
- persistence - validator - MemoryMessage struct

* domain - validator - add TODO for ValidatorDesc

* validator - persistence - validator - fix comment

Author: elpiel

Cargo.lock

@@ -5,4 +5,5 @@ members = [
     "domain",
     "sentry",
     "validator",
+    "memory-repository",
 ]

Cargo.toml

@@ -6,9 +6,14 @@ use crate::BigNum;
 
 pub mod message;
 
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
+#[serde(transparent)]
+pub struct ValidatorId(String);
+
 #[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct ValidatorDesc {
+    // @TODO: Replace id `String` with `ValidatorId` https://github.com/AdExNetwork/adex-validator-stack-rust/issues/83
     pub id: String,
     pub url: String,
     pub fee: BigNum,

domain/src/validator.rs

@@ -1,16 +1,17 @@
+use std::fmt;
+
 use chrono::{DateTime, Utc};
 use serde::de::DeserializeOwned;
-use serde::export::fmt::Debug;
 use serde::{Deserialize, Serialize};
 
 use crate::BalancesMap;
 
 pub trait State {
-    type Signature: DeserializeOwned + Serialize + Debug;
-    type StateRoot: DeserializeOwned + Serialize + Debug;
+    type Signature: DeserializeOwned + Serialize + fmt::Debug + Clone;
+    type StateRoot: DeserializeOwned + Serialize + fmt::Debug + Clone;
 }
 
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Serialize, Deserialize, Clone)]
 #[serde(tag = "type")]
 pub enum Message<S: State> {
     ApproveState(ApproveState<S>),
@@ -20,36 +21,72 @@ pub enum Message<S: State> {
     Accounting(Accounting),
 }
 
-#[derive(Serialize, Deserialize, Debug)]
+impl<S: State> Message<S> {
+    pub fn is_type(&self, message_type: &MessageType) -> bool {
+        assert!(ALL_TYPES.contains(&message_type));
+
+        let self_message_type = match self {
+            Message::ApproveState(_) => &TYPE_APPROVE,
+            Message::NewState(_) => &TYPE_NEW,
+            Message::RejectState(_) => &TYPE_REJECT,
+            Message::Heartbeat(_) => &TYPE_HEARTBEAT,
+            Message::Accounting(_) => &TYPE_ACCOUNTING,
+        };
+
+        self_message_type == message_type
+    }
+
+    pub fn is_types(&self, types: &[&MessageType]) -> bool {
+        types.iter().any(|&m_type| self.is_type(m_type))
+    }
+}
+
+#[derive(Debug, PartialEq, Eq)]
+pub struct MessageType(&'static str);
+
+pub const TYPE_APPROVE: MessageType = MessageType("approve");
+pub const TYPE_NEW: MessageType = MessageType("new");
+pub const TYPE_REJECT: MessageType = MessageType("reject");
+pub const TYPE_HEARTBEAT: MessageType = MessageType("heartbeat");
+pub const TYPE_ACCOUNTING: MessageType = MessageType("accounting");
+pub const ALL_TYPES: [&MessageType; 5] = [
+    &TYPE_APPROVE,
+    &TYPE_NEW,
+    &TYPE_REJECT,
+    &TYPE_HEARTBEAT,
+    &TYPE_ACCOUNTING,
+];
+
+#[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct ApproveState<S: State> {
     state_root: S::StateRoot,
     signature: S::Signature,
     is_healthy: bool,
 }
 
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct NewState<S: State> {
     state_root: S::StateRoot,
     signature: S::Signature,
     balances: BalancesMap,
 }
 
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct RejectState {
     reason: String,
 }
 
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct Heartbeat<S: State> {
     signature: S::Signature,
     timestamp: DateTime<Utc>,
 }
 
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct Accounting {
     #[serde(rename = "last_ev_aggr")]

domain/src/validator/message.rs

@@ -0,0 +1,12 @@
+[package]
+name = "memory-repository"
+version = "0.1.0"
+authors = ["Lachezar Lechev <[email protected]>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+domain = { version = "0.1", path = "../domain", features = ["repositories"] }
+# Futures
+futures-preview = { version = "=0.3.0-alpha.16", features = ["compat"] }