dapr 0.19.0-rc.2

Rust SDK for dapr
Documentation
use axum::{Router, handler::Handler, routing::put};
use std::{collections::HashMap, sync::Arc};
use tokio::sync::RwLock;

use crate::client::TonicClient;

use super::{Actor, ActorError, ActorFactory, context_client::ActorContextClient};

#[derive(Clone)]
pub struct ActorState {
    pub actor_type: String,
    pub runtime: Arc<ActorRuntime>,
}

type MethodRegistrationMap =
    HashMap<String, Box<dyn (FnOnce(Router, Arc<ActorRuntime>) -> Router) + Send + Sync>>;

/// Describes the registration of an actor type, including the methods that can be invoked on it and the factory to create instances of it.
/// # Example:
/// ```ignore
/// # use std::sync::Arc;
/// # use dapr::server::actor::{context_client::ActorContextClient, Actor, ActorError, ActorFactory, runtime::ActorTypeRegistration};
/// # use dapr::server::utils::DaprJson;
/// # use dapr::actor;
/// # use axum::{Json, Router};
/// # use serde::{Deserialize, Serialize};
/// # #[dapr::actor]
/// # struct MyActor {
/// #     id: String,
/// #     client: ActorContextClient,
/// # }
/// #
/// # #[derive(Serialize, Deserialize)]
/// # pub struct MyRequest {
/// # pub name: String,
/// # }
/// #
/// # #[derive(Serialize, Deserialize)]
/// # pub struct MyResponse {
/// #   pub available: bool,
/// # }
/// #
/// # impl MyActor {
/// #     async fn do_stuff(&self, DaprJson(req): DaprJson<MyRequest>) -> Json<MyResponse> {
/// #         todo!()
/// #     }
/// #     async fn do_other_stuff(&self, DaprJson(req): DaprJson<MyRequest>) -> Json<MyResponse> {
/// #         todo!()
/// #     }
/// # }
/// #
/// #
/// # #[async_trait::async_trait]
/// # impl Actor for MyActor {
/// #    async fn on_activate(&self) -> Result<(), ActorError> {
/// #        todo!()
/// #    }
/// #    async fn on_deactivate(&self) -> Result<(), ActorError> {
/// #         todo!()
/// #    }
/// #    async fn on_reminder(&self, reminder_name: &str, data: Vec<u8>) -> Result<(), ActorError> {
/// #         todo!()
/// #    }
/// #    async fn on_timer(&self, timer_name: &str, data: Vec<u8>) -> Result<(), ActorError> {
/// #         todo!()
/// #    }
/// # }
///
/// # async fn main_async() {
/// let mut dapr_server = dapr::server::DaprHttpServer::new().await;
///
/// dapr_server.register_actor(ActorTypeRegistration::new::<MyActor>("MyActor", Box::new(|_actor_type, actor_id, context| {
///    Arc::new(MyActor {
///        id: actor_id.to_string(),
///        client: context,
///    })}))
///    .register_method("do_stuff", MyActor::do_stuff)
///    .register_method("do_other_stuff", MyActor::do_other_stuff))
/// .await;
/// # }
/// ```
pub struct ActorTypeRegistration {
    name: String,
    factory: ActorFactory,
    method_registrations: MethodRegistrationMap,
}

impl ActorTypeRegistration {
    pub fn new<TActor>(name: &str, factory: ActorFactory) -> Self
    where
        TActor: Actor + Send + Sync + 'static,
    {
        ActorTypeRegistration {
            name: name.to_string(),
            factory,
            method_registrations: HashMap::new(),
        }
    }

    /// Registers a method on the actor type to be exposed to actor clients.
    ///
    /// # Arguments:
    /// * `method_name` - The name of the method to be registered. This name will be used by actor clients to invoke the method.
    /// * `handler` - The handler function to be invoked when the method is called.  
    ///   Can be any valid [Axum handler](https://docs.rs/axum/latest/axum/handler/index.html),
    ///   use [Axum extractors](https://docs.rs/axum/latest/axum/extract/index.html) to access the incoming request and return an [`impl IntoResponse`](https://docs.rs/axum/latest/axum/response/trait.IntoResponse.html).
    ///   Use the `DaprJson` extractor to deserialize the request from Json coming from a Dapr sidecar.
    /// # Example:
    /// ```ignore
    /// # use std::sync::Arc;
    /// # use dapr::server::actor::{context_client::ActorContextClient, Actor, ActorError, ActorFactory, runtime::ActorTypeRegistration};
    /// # use dapr::server::utils::DaprJson;
    /// # use dapr::actor;
    /// # use axum::{Json, Router};
    /// # use serde::{Deserialize, Serialize};
    /// # #[dapr::actor]
    /// # struct MyActor {
    /// #     id: String,
    /// #     client: ActorContextClient,
    /// # }
    /// #
    /// # #[async_trait::async_trait]
    /// # impl Actor for MyActor {
    /// #    async fn on_activate(&self) -> Result<(), ActorError> {
    /// #        todo!()
    /// #    }
    /// #    async fn on_deactivate(&self) -> Result<(), ActorError> {
    /// #         todo!()
    /// #    }
    /// #    async fn on_reminder(&self, reminder_name: &str, data: Vec<u8>) -> Result<(), ActorError> {
    /// #         todo!()
    /// #    }
    /// #    async fn on_timer(&self, timer_name: &str, data: Vec<u8>) -> Result<(), ActorError> {
    /// #         todo!()
    /// #    }
    /// # }
    /// ##[derive(Serialize, Deserialize)]
    /// pub struct MyRequest {
    /// pub name: String,
    /// }
    ///
    ///##[derive(Serialize, Deserialize)]
    ///pub struct MyResponse {
    ///    pub available: bool,
    ///}   
    ///
    ///impl MyActor {
    ///    fn do_stuff(&self, DaprJson(data): DaprJson<MyRequest>) -> Json<MyResponse> {        
    ///        println!("doing stuff with {}", data.name);        
    ///        Json(MyResponse {
    ///            available: true
    ///        })
    ///    }    
    ///}
    ///
    /// # async fn main_async() {
    /// let mut dapr_server = dapr::server::DaprHttpServer::new().await;
    ///
    /// dapr_server.register_actor(ActorTypeRegistration::new::<MyActor>("MyActor", Box::new(|_actor_type, actor_id, context| {
    ///    Arc::new(MyActor {
    ///        id: actor_id.to_string(),
    ///        client: context,
    ///    })}))
    ///    .register_method("do_stuff", MyActor::do_stuff))
    /// .await;
    /// # }
    /// ```
    pub fn register_method<T>(
        mut self,
        method_name: &str,
        handler: impl Handler<T, ActorState> + Sync,
    ) -> Self
    where
        T: 'static,
    {
        let actor_type = self.name.clone();
        let method_path = format!("/actors/{actor_type}/:actor_id/method/{method_name}");

        let reg_func = move |router: Router, runtime: Arc<ActorRuntime>| {
            router.route(
                &method_path,
                put(handler).with_state(ActorState {
                    actor_type,
                    runtime,
                }),
            )
        };

        self.method_registrations
            .insert(method_name.to_string(), Box::new(reg_func));
        self
    }

    fn create_actor(&self, actor_id: &str, client: TonicClient) -> Arc<dyn Actor> {
        let client = ActorContextClient::new(client, &self.name, actor_id);

        (self.factory)(&self.name, actor_id, client) as _
    }
}

type ActiveActorMap = Arc<RwLock<HashMap<(String, String), Arc<dyn Actor>>>>;
type ActorRegistrationMap = Arc<RwLock<HashMap<String, ActorTypeRegistration>>>;

pub struct ActorRuntime {
    dapr_client: TonicClient,

    registered_actors_types: ActorRegistrationMap,
    active_actors: ActiveActorMap,
}

impl ActorRuntime {
    pub fn new(dapr_client: TonicClient) -> Self {
        ActorRuntime {
            dapr_client,
            registered_actors_types: Arc::new(RwLock::new(HashMap::new())),
            active_actors: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Registers an actor type to be exposed to actor clients.
    /// # Arguments:
    /// * `registration` - The [ActorTypeRegistration] that describes the actor implementation.
    pub async fn register_actor(&self, registration: ActorTypeRegistration) {
        let name = registration.name.clone();
        let mut g = self.registered_actors_types.write().await;
        g.insert(name.clone(), registration);
        log::info!("registered actor {name}");
    }

    pub async fn configure_method_routes(
        &self,
        router: Router,
        runtime: Arc<ActorRuntime>,
    ) -> Router {
        let mut router = router;
        let mut types = self.registered_actors_types.write().await;

        for (_, registration) in types.iter_mut() {
            for (_, reg_func) in registration.method_registrations.drain() {
                router = reg_func(router, runtime.clone());
            }
        }
        router
    }

    pub async fn deactivate_actor(&self, name: &str, id: &str) -> Result<(), ActorError> {
        let mut actors = self.active_actors.write().await;

        let actor = match actors.remove(&(name.to_string(), id.to_string())) {
            Some(actor_ref) => actor_ref,
            None => return Err(ActorError::ActorNotFound),
        };
        drop(actors);
        actor.on_deactivate().await?;
        drop(actor);
        Ok(())
    }

    pub async fn deactivate_all(&self) {
        let mut actors = self.active_actors.write().await;

        for actor in actors.values() {
            _ = actor.on_deactivate().await;
        }
        actors.clear();
    }

    pub async fn invoke_reminder(
        &self,
        name: &str,
        id: &str,
        reminder_name: &str,
        data: Vec<u8>,
    ) -> Result<(), ActorError> {
        let actor = self.get_or_create_actor(name, id).await?;
        actor.on_reminder(reminder_name, data).await?;
        Ok(())
    }

    pub async fn invoke_timer(
        &self,
        name: &str,
        id: &str,
        timer_name: &str,
        data: Vec<u8>,
    ) -> Result<(), ActorError> {
        let actor = self.get_or_create_actor(name, id).await?;
        actor.on_timer(timer_name, data).await?;
        Ok(())
    }

    pub async fn list_registered_actors(&self) -> Vec<String> {
        let types = self.registered_actors_types.read().await;

        types.keys().map(|k| k.to_string()).collect()
    }

    pub async fn get_or_create_actor(
        &self,
        actor_type: &str,
        id: &str,
    ) -> Result<Arc<dyn Actor>, ActorError> {
        let actors = self.active_actors.read().await;
        match actors.get(&(actor_type.to_string(), id.to_string())) {
            Some(actor_ref) => Ok(actor_ref.clone()),
            None => {
                drop(actors);
                self.activate_actor(actor_type, id).await
            }
        }
    }

    async fn activate_actor(
        &self,
        actor_type: &str,
        id: &str,
    ) -> Result<Arc<dyn Actor>, ActorError> {
        let types = self.registered_actors_types.read().await;
        let actor = match types.get(actor_type) {
            Some(f) => f.create_actor(id, self.dapr_client.clone()),
            None => Err(ActorError::NotRegistered)?,
        };

        actor.on_activate().await?;

        let actor_key = (actor_type.to_string(), id.to_string());
        let mut actors = self.active_actors.write().await;
        actors.insert(actor_key, actor.clone());

        Ok(actor)
    }
}