arrows 0.1.16

An actor framework in rust with message durability and ingestion order processing of of messages
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
#![allow(clippy::wrong_self_convention)]
use crate::common::utils::from_bytes;
use crate::constants::*;
use crate::dbconnection::DBConnection;
use crate::events::DBEvent;
use crate::pubsub::Publisher;
use crate::Addr;
use crate::RichMail;
use crate::{Config, Mail, Mail::*, Msg};
use fallible_streaming_iterator::FallibleStreamingIterator;
use rusqlite::{named_params, params, types::Value, Error::InvalidQuery, Result, ToSql};
use std::collections::HashMap;
use std::io::{Error, ErrorKind};

use std::thread::JoinHandle;

unsafe impl Send for Store {}
unsafe impl Sync for Store {}

impl Drop for Store {
    fn drop(&mut self) {
        self.publisher.loopbreak();
        self.publisher
            .subscriber
            .take()
            .map(|mut subscriber| subscriber.join_handle.take().map(JoinHandle::join));
    }
}

pub(crate) struct Store {
    buffer: Vec<Msg>,
    conn: DBConnection,
    message_insert_stmt: Option<String>,
    inbox_select_stmts: HashMap<String, String>,
    actor_create_stmts: HashMap<String, String>,
    publisher: Publisher,
    subscriber_handle: Option<JoinHandle<()>>,
}
impl std::fmt::Debug for Store {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Store")
            .field("message_insert_stmt", &self.message_insert_stmt)
            .field("inbox_select_stmts", &self.inbox_select_stmts)
            .field("actor_create_stmts", &self.actor_create_stmts)
            .finish()
    }
}
impl Store {
    pub(crate) fn new() -> Self {
        Self {
            buffer: Vec::new(),
            conn: DBConnection::new(),
            message_insert_stmt: None,
            inbox_select_stmts: HashMap::new(),
            actor_create_stmts: HashMap::new(),
            publisher: Publisher::new(),
            subscriber_handle: None,
        }
    }
    fn flush_buffer(&mut self) -> Result<()> {
        if self.buffer.len() >= Config::get_shared().db_buff_size() {
            self.persist(Blank)
        } else {
            Ok(())
        }
    }

    pub(crate) fn persist(&mut self, mail: Mail) -> Result<()> {
        match mail {
            Blank if self.buffer.is_empty() => Ok(()),
            Blank => self.persist_buffer(),
            Trade(msg) => {
                self.buffer.push(msg);
                self.flush_buffer()
            }
            Bulk(msgs) => {
                self.buffer.extend(msgs);
                self.flush_buffer()
            }
        }
    }

    fn persist_buffer(&mut self) -> Result<()> {
        //Commit any active tx to avoid nested transaction issue
        match self.conn.inner.execute_batch(TX_COMMIT) {
            Ok(_any_tx) => (),
            //Err(err) => println!("{}", err),
            Err(_err) => (),
        }
        self.conn.inner.execute_batch(TX_BEGIN)?;
        let stmt = Self::message_insert_stmt(&mut self.message_insert_stmt);
        let mut stmt = self.conn.inner.prepare_cached(stmt).ok();
        match stmt {
            Some(ref mut s) => {
                for msg in self.buffer.drain(..) {
                    let actor_id = msg.get_to_id().to_string();
                    let bytes = msg.as_bytes();
                    let _status = s.execute(named_params! {":actor_id": &actor_id as &dyn ToSql, ":msg_id": &msg.id_as_string() as &dyn ToSql,":actor_id": &actor_id as &dyn ToSql, ":msg": &bytes as &dyn ToSql })?;
                }
            }
            None => panic!(),
        }
        self.conn.inner.execute_batch(TX_COMMIT)?;
        Ok(())
    }

    //UPDATE_ACTOR_EVENT_SEQ
    pub(crate) fn update_actor_event_seq(
        store: &mut Store,
        msg_seq: i64,
        actor_id: &str,
    ) -> Result<()> {
        let mut stmt = store.conn.inner.prepare_cached(UPDATE_ACTOR_EVENT_SEQ)?;
        stmt.execute(params![msg_seq, actor_id])?;
        Ok(())
    }

    pub(crate) fn egress_messages(store: &mut Store, mut mail: RichMail) -> Result<()> {
        match store.conn.inner.execute_batch(TX_COMMIT) {
            Ok(_any_tx) => (),
            Err(_err) => (),
            //Err(err) => println!("{}", err),
        }
        store.conn.inner.execute_batch(TX_BEGIN)?;
        let stmt = Self::message_insert_stmt(&mut store.message_insert_stmt);
        let mut stmt = store.conn.inner.prepare_cached(stmt).ok();
        match stmt {
            Some(ref mut s) => {
                for msg in mail.mail_out().take_all().drain(..) {
                    let actor_id = msg.get_to_id().to_string();
                    let bytes = msg.as_bytes();
                    let _status = s.execute(named_params! {":actor_id": &actor_id as &dyn ToSql, ":msg_id": &msg.id_as_string() as &dyn ToSql,":actor_id": &actor_id as &dyn ToSql, ":msg": &bytes as &dyn ToSql })?;
                }
            }
            None => panic!(),
        }
        store.conn.inner.execute_batch(TX_COMMIT)?;
        Ok(())
    }
    pub(crate) fn egress(&mut self, mail: RichMail) -> Result<()> {
        let from = &mail.from().expect("address").get_id().to_string();
        let msg_seq = mail.seq();
        Self::egress_messages(self, mail)?;
        Self::update_actor_event_seq(self, msg_seq, from)?;
        Ok(())
    }
    pub(crate) fn setup(&mut self) -> Result<()> {
        self.conn.inner.execute(MESSAGES, [])?;
        self.conn.inner.execute(ACTORS, [])?;
        self.conn.inner.execute(EVENTS, [])?;
        self.publisher.start(&mut self.conn);
        println!("Set up arrows schema");
        Ok(())
    }

    pub(crate) fn all_actors(&mut self) -> Result<Vec<String>> {
        let mut stmt = self
            .conn
            .inner
            .prepare_cached("SELECT actor_id FROM actors")
            .ok();
        let mut actors = Vec::with_capacity(FETCH_LIMIT);
        match stmt {
            Some(ref mut s) => {
                let rows = s.query_map([], |row| row.get(0))?;
                for row in rows {
                    let value: String = row?;
                    actors.push(value);
                }
            }
            None => panic!("Error retrieving actors!"),
        }
        Ok(actors)
    }

    pub(crate) fn purge_inbox_of(&mut self, actor_id: &str) -> Result<()> {
        let stmt = format!(
            "SELECT count(1) FROM sqlite_master WHERE type='table' AND name='inbox_{}'",
            actor_id
        );
        let mut stmt = self.conn.inner.prepare(&stmt)?;
        let mut rows = stmt.query([])?;
        if let Some(row) = rows.next()? {
            let value: usize = row.get(0)?;
            if value == 1 {
                let stmt = format!("DELETE FROM inbox_{}", actor_id);
                match self.conn.inner.execute(&stmt, []) {
                    Ok(deleted) => println!("Rows deleted: {}", deleted),
                    Err(err) => println!("Error occured: {}", err),
                }
            } else {
                println!("Table does not exist");
            }
        }
        Ok(())
    }

    pub(crate) fn delete_actor_messages(
        &mut self,
        actor_id: &str,
        msg_ids: Vec<&str>,
    ) -> std::io::Result<()> {
        let msg_ids: String = msg_ids
            .into_iter()
            .map(|id| {
                let mut s = String::from("'");
                s += id;
                s += "'";
                s
            })
            .collect::<Vec<_>>()
            .join(",");
        let stmt = format!(
            "DELETE FROM messages WHERE actor_id = '{}' AND msg_id in ({})",
            actor_id, msg_ids
        );
        let _rs = self.conn.inner.execute_batch(TX_BEGIN).map_err(sql_to_io);
        let mut stmt = self.conn.inner.prepare(&stmt).map_err(sql_to_io)?;
        let _rs = stmt.execute(params![]).map_err(sql_to_io);
        let _rs = self.conn.inner.execute_batch(TX_COMMIT).map_err(sql_to_io);
        Ok(())
    }

    pub(crate) fn save_producer(
        &mut self,
        identity: &str,
        addr: Addr,
        actor_def: &str,
    ) -> Result<()> {
        let mut stmt = self.conn.inner.prepare_cached(ACTOR_DEF_INSERT).ok();
        match stmt {
            Some(ref mut s) => s.execute(
                named_params! { ":actor_id": &identity as &dyn ToSql,":actor_name": addr.get_name() as &dyn ToSql, ":actor_def": &actor_def as &dyn ToSql },
            )?,
            None => panic!(),
        };
        Ok(())
    }
    pub(crate) fn remove_actor_permanent(&mut self, identity: &str) -> Result<()> {
        let mut stmt = self.conn.inner.prepare_cached(DELETE_ACTOR)?;
        stmt.execute(params![identity]).and_then(
            |c| {
                if c == 1 {
                    Ok(())
                } else {
                    Err(InvalidQuery)
                }
            },
        )
    }
    pub(crate) fn actor_is_present(&mut self, actor_id: &str) -> Result<()> {
        let mut stmt = self.conn.inner.prepare_cached(ACTOR_ROWID)?;
        let status = stmt
            .query(rusqlite::params![actor_id])?
            .count()
            .and_then(|c| if c == 1 { Ok(()) } else { Err(InvalidQuery) });
        status
    }
    pub(crate) fn retrieve_actor_def(
        &mut self,
        actor_id: &str,
    ) -> Result<Option<(String, String, i64)>> {
        let mut stmt = self.conn.inner.prepare_cached(ACTOR_DEF)?;
        let mut rows = stmt.query(rusqlite::params![actor_id])?;
        if let Some(row) = rows.next()? {
            let actor_name: String = row.get(0)?;
            let actor_def: String = row.get(1)?;
            let msg_seq: i64 = row.get(2)?;
            return Ok(Some((actor_name, actor_def, msg_seq)));
        }
        Ok(None)
    }

    fn message_insert_stmt(stmt: &mut Option<String>) -> &str {
        match stmt {
            Some(ref s) => s,
            None => {
                *stmt = Some(INSERT_INTO_MESSAGES.to_string());
                INSERT_INTO_MESSAGES
            }
        }
    }

    pub(crate) fn from_messages(&mut self, rowids: Vec<i64>) -> Result<Vec<RichMail>> {
        let rowids = rowids
            .iter()
            .map(|id| id.to_string())
            .collect::<Vec<_>>()
            .join(",");
        let stmt = format!(
            "SELECT msg, inbound, msg_seq FROM messages WHERE rowid IN ({})",
            rowids
        );
        let mut stmt = self.conn.inner.prepare(&stmt)?;
        let mut rows = stmt.query([])?;
        let mut msgs = Vec::new();
        while let Some(row) = rows.next()? {
            let value: Value = row.get(0)?;
            let inbound: i64 = row.get(1)?;
            let msg_seq: i64 = row.get(2)?;
            let msg = value_to_msg(value);
            let to = msg.get_to().clone();
            msgs.push(RichMail::RichContent(
                Mail::Trade(msg),
                inbound == 1,
                msg_seq,
                None,
                to,
            ));
        }
        Ok(msgs)
    }

    pub(crate) fn min_msg_seq(&mut self, actor_id: &str) -> Result<Option<(i64, i64, i64)>> {
        let mut stmt = self.conn.inner.prepare_cached(MIN_MSG_SEQ)?;
        let mut rows = stmt.query(rusqlite::params![actor_id])?;
        if let Some(row) = rows.next()? {
            let seq: i64 = row.get(0)?;
            let rowid: i64 = row.get(1)?;
            let row_id: i64 = row.get(2)?;
            return Ok(Some((seq, rowid, row_id)));
        }
        Ok(None)
    }

    pub(crate) fn update_events(&mut self, row_id: i64) -> Result<()> {
        let mut stmt = self.conn.inner.prepare_cached("UPDATE_EVENTS")?;
        stmt.execute(params![row_id])?;
        Ok(())
    }

    pub(crate) fn into_inbox(&mut self, msg: Msg) -> Result<()> {
        let stmt = Self::message_insert_stmt(&mut self.message_insert_stmt);
        let mut stmt = self.conn.inner.prepare_cached(stmt).ok();
        let msg_id = msg.id_as_string();
        let actor_id = msg.get_to_id().to_string();
        let bytes = msg.as_bytes();
        match stmt {
            Some(ref mut s) => s.execute(
                named_params! {":actor_id": &actor_id as &dyn ToSql, ":msg_id": &msg_id as &dyn ToSql, ":actor_id": &actor_id as &dyn ToSql, ":msg": &bytes as &dyn ToSql },
            )?,
            None => panic!(),
        };
        Ok(())
    }
    pub(crate) fn actor_messages(&mut self, actor_id: &str) -> Result<Vec<Msg>> {
        let stmt = self
            .inbox_select_stmts
            .entry(actor_id.to_string())
            .or_insert_with(|| {
                format!(
                    "SELECT msg FROM messages where actor_id = {} ORDER BY rowid ASC LIMIT {}",
                    actor_id, FETCH_LIMIT
                )
            });

        let mut stmt = self.conn.inner.prepare_cached(stmt).ok();
        let mut msgs = Vec::with_capacity(FETCH_LIMIT);
        match stmt {
            Some(ref mut s) => {
                //let rows = s.query_and_then([], |row| row.get::<_, Msg>(0))?;
                let rows = s.query_map([], |row| row.get(0))?;
                for row in rows {
                    let value: Value = row?;
                    msgs.push(value_to_msg(value));
                }
            }
            None => {
                panic!("Error draining inbox - CachedStatement not found")
            }
        }
        Ok(msgs)
    }

    pub(crate) fn rowids_of(&mut self, actor_id: &str) -> Result<Vec<i64>> {
        let stmt = format!(
            "SELECT rowid FROM messages WHERE actor_id = '{}' ORDER BY rowid ASC",
            actor_id
        );
        let mut stmt = self.conn.inner.prepare_cached(&stmt)?;
        let mut rows = stmt.query([])?;
        let mut rowids = Vec::new();
        while let Some(row) = rows.next()? {
            rowids.push(row.get(0)?);
        }
        Ok(rowids)
    }

    pub(crate) fn messages_from(&mut self, actor_id: &str, start_at: i64) -> Result<Vec<Msg>> {
        let stmt =format!("SELECT msg FROM inbox WHERE actor_id = '{}' and rowid >= {} ORDER BY rowid ASC LIMIT {}", actor_id, start_at, FETCH_LIMIT);
        let mut stmt = self.conn.inner.prepare_cached(&stmt).ok();
        let mut msgs = Vec::with_capacity(FETCH_LIMIT);
        match stmt {
            Some(ref mut s) => {
                let rows = s.query_map([], |row| row.get(0))?;
                for row in rows {
                    let value: Value = row?;
                    msgs.push(value_to_msg(value));
                }
            }
            None => panic!("Error reading inbox!"),
        }
        Ok(msgs)
    }

    pub(crate) fn read_events(&mut self) -> Result<Vec<i64>> {
        let mut stmt = self.conn.inner.prepare_cached(EVENTS_SELECT)?;
        let mut rows = stmt.query([])?;
        let mut events = Vec::new();
        while let Some(row) = rows.next()? {
            events.push(row.get(0)?);
        }
        Ok(events)
    }

    pub(crate) fn persist_events(
        &mut self,
        events: impl Iterator<Item = DBEvent>,
    ) -> Result<Vec<i64>> {
        let tx = self.conn.inner.transaction()?;
        let mut persisted_events = Vec::new();
        for event in events {
            event.persist(&tx)?;
            persisted_events.push(event.0);
        }
        tx.commit()?;
        Ok(persisted_events)
    }

    pub(crate) fn into_inbox_batch(&mut self, msgs: impl Iterator<Item = Msg>) -> Result<()> {
        self.conn.inner.execute_batch(TX_BEGIN)?;
        let stmt = Self::message_insert_stmt(&mut self.message_insert_stmt);
        let mut stmt = self.conn.inner.prepare_cached(stmt).ok();
        match stmt {
            Some(ref mut s) => {
                for msg in msgs {
                    let bytes = msg.as_bytes();
                    let actor_id = msg.get_to_id().to_string();
                    let _status = s.execute(named_params! { ":actor_id": &actor_id as &dyn ToSql, ":msg_id": &msg.id_as_string() as &dyn ToSql, ":actor_id": &actor_id as &dyn ToSql, ":msg": &bytes as &dyn ToSql })?;
                }
            }
            None => panic!(),
        };
        self.conn.inner.execute_batch(TX_COMMIT)?;
        Ok(())
    }
}
fn sql_to_io(err: rusqlite::Error) -> std::io::Error {
    eprintln!("rusqlite::Error has occured: {:?}", err);
    Error::new(ErrorKind::Other, "rusqlite error")
}

pub(crate) fn value_to_msg(v: Value) -> Msg {
    if let Value::Blob(bytes) = v {
        return match from_bytes::<'_, Msg>(&bytes) {
            Ok(msg) => msg,
            _ => Msg::default(),
        };
    }
    Msg::default()
}

pub(crate) fn value_to_addr(v: Value) -> Addr {
    if let Value::Blob(bytes) = v {
        return match from_bytes::<'_, Addr>(&bytes) {
            Ok(addr) => addr,
            _ => Addr::default(),
        };
    }
    Addr::default()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::common::mail::Msg;
    use crate::events::DBEvent;
    use crate::Addr;
    use rand::{thread_rng, Rng};
    use std::iter::repeat;

    fn store_messages(actor_name: &str) -> (String, String) {
        //Add randomness to the message text
        let mut rng = thread_rng();
        let random: u64 = rng.gen();
        let message = format!("Actor message-{}", random);
        //Generate as many messages as required to flush buffer
        let messages = repeat(&message).take(Config::get_shared().db_buff_size());
        let messages: Vec<_> = messages
            .map(|msg| Msg::with_text(msg, "from", actor_name))
            .collect();

        let mut store = Store::new();
        let _ = store.setup();
        //Persist messages
        let rs = store.persist(Mail::Bulk(messages));
        assert!(rs.is_ok());
        let actor_id = Addr::new("actor").get_id().to_string();
        //Return random generated message and actor_id for actor_name
        (message.to_string(), actor_id)
    }
    #[test]
    fn select_from_inbox_test() -> Result<()> {
        let (message, actor_id) = store_messages("actor");

        let mut store = Store::new();
        let _ = store.setup();

        let rowids = store.rowids_of(&actor_id).unwrap();
        let msgs = store.from_messages(rowids).unwrap();
        let count = msgs
            .iter()
            .filter(|msg| msg.mail().message().as_text() == Some(&message))
            .count();
        assert!(count == Config::get_shared().db_buff_size());
        Ok(())
    }

    #[test]
    fn read_message_from_test() {
        let (message, actor_id) = store_messages("actor");
        let mut store = Store::new();
        let _ = store.setup();
        let mut rowids = store.rowids_of(&actor_id).unwrap();
        let last = rowids.pop().unwrap();
        let msgs = store.messages_from(&actor_id, last).unwrap();

        assert!(msgs[0].as_text() == Some(&message));
    }


    #[test]
    fn into_inbox_no_batch_test_1() {
        let _num = 100;
        //InvalidParameterCount
        //Err(SqliteFailure(
        //Err(ToSqlConversionFailure(TryFromIntError
        //Err(SqliteFailure(Error { code: ReadOnly, extended_code: 1032 }
        //Err(SqliteFailure(Error { code: TypeMismatch
        //Err(SqliteFailure(Error { code: ConstraintViolation, extended_code: 1555 },
        // Some("UNIQUE constraint failed: actors.actor_id")
        //let _status = into_inbox_no_batch_func(num);
    }


    #[test]
    fn save_producer_1001() -> Result<()> {
        let mut store = Store::new();
        let _ = store.setup();
        let addr = Addr::new("1001");
        let identity = "1001";
        let insert = store.save_producer(identity, addr, r#"{"new_actor_builder":null}"#);
        assert!(insert.is_ok());
        Ok(())
    }

    #[test]
    fn actor_is_present_1001_test_1() -> Result<()> {
        let mut store = Store::new();
        let _ = store.setup();
        let actor_id = "1001";
        let present = store.actor_is_present(actor_id);
        assert!(present.is_ok());
        Ok(())
    }

    #[test]
    fn retrieve_actor_def_1001_test_1() -> Result<()> {
        let mut store = Store::new();
        let _ = store.setup();
        let actor_id = "1001";
        let actor_def = store.retrieve_actor_def(actor_id);
        assert!(actor_def.is_ok());
        Ok(())
    }

    #[test]
    fn serialize_db_event_test1() {
        let db_event = DBEvent(100);
        let json = serde_json::to_string(&db_event).unwrap();
        let expected = "[100]";
        assert_eq!(json, expected);
    }
}