rio-rs

Distributed stateful services inspired by Orleans

This crate provides a framework for scalable, distributed and stateful services based on message passing between objects

Application

Most of your application code will be written in forms of ServiceObjects and Messages

use async_trait::async_trait;
use rio_rs::prelude::*;
use serde::{Deserialize, Serialize};
use std::sync::Arc;

#[derive(TypeName, Message, Deserialize, Serialize)]
pub struct HelloMessage {
    pub name: String
}

#[derive(TypeName, Message, Deserialize, Serialize)]
pub struct HelloResponse {}

#[derive(TypeName, WithId, Default)]
pub struct HelloWorldService {
    pub id: String,
}

#[async_trait]
impl Handler<HelloMessage> for HelloWorldService {
    type Returns = HelloResponse;
    async fn handle(
        &mut self,
        message: HelloMessage,
        app_data: Arc<AppData>,
    ) -> Result<Self::Returns, HandlerError> {
        println!("Hello world");
        Ok(HelloResponse {})
    }
}

Running Server

To run your application you need to spin up your servers, the Server

TODO: Include example of other databases

use rio_rs::prelude::*;
use rio_rs::cluster::storage::sql::{SqlMembersStorage};
use rio_rs::object_placement::sql::SqlObjectPlacementProvider;


#[tokio::main]
async fn main() {
    let addr = "0.0.0.0:5000";

    // Configure types on the server's registry
    let mut registry = Registry::new();
    registry.add_type::<HelloWorldService>();
    registry.add_handler::<HelloWorldService, HelloMessage>();

    // Configure the Cluster Membership provider
    let pool = SqlMembersStorage::pool()
        .connect("sqlite::memory:")
        .await
        .expect("Membership database connection failure");
    let members_storage = SqlMembersStorage::new(pool);
    members_storage.migrate().await;

    let membership_provider_config = PeerToPeerClusterConfig::default();
    let membership_provider =
        PeerToPeerClusterProvider::new(members_storage, membership_provider_config);

    // Configure the object placement
    let pool = SqlMembersStorage::pool()
        .connect("sqlite::memory:")
        .await
        .expect("Object placement database connection failure");
    let object_placement_provider = SqlObjectPlacementProvider::new(pool);
    object_placement_provider.migrate().await;

    // Create the server object
    let mut server = Server::new(
        addr.to_string(),
        registry,
        membership_provider,
        object_placement_provider,
    );

    // Run the server
    // server.run().await;
}

Client

Communicating with the cluster is just a matter of sending the serialized known messages via TCP. The [client] module provides an easy way of achieving this:

use rio_rs::prelude::*;
use rio_rs::cluster::storage::sql::{SqlMembersStorage};


#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Member storage configuration (Rendezvous)
    let pool = SqlMembersStorage::pool()
        .connect("sqlite::memory:")
        .await?;
    let members_storage = SqlMembersStorage::new(pool);
    # members_storage.migrate().await;

    // Create the client
    let mut client = ClientBuilder::new()
        .members_storage(members_storage)
        .build()?;

    let payload = HelloMessage { name: "Client".to_string() };
    let response: HelloResponse = client
        .send(
            "HelloWorldService".to_string(),
            "any-string-id".to_string(),
            &payload,
        ).await?;

    // response is a `HelloResponse {}`
    Ok(())
}

Roadmap

There are a few things that must be done before v0.1.0:

• [x] Naive server/client protocol
• [x] Basic cluster support
• [x] Basic placement support
• [x] Object self shutdown
• [x] Naive object persistence
• [x] Public API renaming
• [x] Reduce Boxed objects
• [x] Create a Server builder
• [x] Remove need to use add_static_fn(FromId::from_id) -> Removed in favour of Registry::add_type
• [x] Support service background task
• [x] Pub/sub
• [x] Examples covering most use cases
  • [x] Background async task on a service
  • [x] Background blocking task on a service (see black-jack)
  • [x] Pub/sub (see black-jack)
• [ ] Re-organize workspace
• [ ] Allow ServiceObject trait without state persistence
• [ ] Feature: Create server from config
• [ ] Bypass clustering for self messages
• [ ] Bypass networking for local messages
• [ ] Move all the client to user tower
• [ ] Remove the need to pass the StateSaver to ObjectStateManager::save_state
• [ ] Error and panic handling on life cycle hooks (probably kill the object)
• [ ] Handle panics on messages handling
• [ ] Include registry configuration in Server builder
• [ ] Create a getting started tutorial
  • [ ] Cargo init
  • [ ] Add deps (rio-rs, tokio, async_trait, serde, sqlx - optional)
  • [ ] Write a server
  • [ ] Write a client
  • [ ] Add service and messages
  • [ ] Cargo run --bin server
  • [ ] Cargo run --bin client
  • [ ] Life cycle
  • [ ] Life cycle depends on app_data(StateLoader + StateSaver)
  • [ ] Cargo test?
• [ ] Make all sql statements compatible with sqlite, mysql and pgsql
• [ ] Add more extensive tests to client/server integration
• [ ] Increase public API test coverage
• [ ] Client/server keep alive
• [ ] Reduce static lifetimes
• [ ] 100% documentation of public API
• [ ] Placement strategies (nodes work with different sets of trait objects)
• [ ] Dockerized examples
• [ ] Add pgsql jsonb support
• [ ] Add all SQL storage behind a feature flag (sqlite, mysql, pgsql, etc)
• [ ] Supervision
• [ ] Ephemeral objects (aka regular - local - actors)
• [ ] Remove magic numbers
• [ ] Object TTL
• [ ] Matrix test with different backends
• [ ] Replace prints with logging
• [?] Support 'typed' message/response on client
• [ ] Support ephemeral port
• [ ] Remove the need for an Option<T> value for managed_state attributes (as long as it has a 'Default')
• [ ] Code of conduct