tari_service_framework 5.6.0

The Tari communication stack service framework
Documentation
// Copyright 2020. The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use async_trait::async_trait;
use futures::{StreamExt, pin_mut};
use tari_service_framework::{
    ServiceInitializationError,
    ServiceInitializer,
    ServiceInitializerContext,
    reply_channel,
    reply_channel::SenderService,
};
use tari_shutdown::ShutdownSignal;
use tower::Service;

use crate::services::ServiceBHandle;

pub struct ServiceA {
    response_msg: String,
    request_stream: Option<reply_channel::Receiver<String, String>>,
    service_b_handle: ServiceBHandle,
    shutdown_signal: Option<ShutdownSignal>,
}

impl ServiceA {
    pub fn new(
        response_msg: String,
        request_stream: reply_channel::Receiver<String, String>,
        service_b_handle: ServiceBHandle,
        shutdown_signal: ShutdownSignal,
    ) -> Self {
        Self {
            response_msg,
            request_stream: Some(request_stream),
            service_b_handle,
            shutdown_signal: Some(shutdown_signal),
        }
    }

    pub async fn run(mut self) {
        println!("Starting Service A");
        let mut shutdown_signal = self
            .shutdown_signal
            .take()
            .expect("Service A initialized without shutdown signal");
        let request_stream = self
            .request_stream
            .take()
            .expect("Service A initialized without request_stream")
            .fuse();
        pin_mut!(request_stream);

        loop {
            tokio::select! {
                //Incoming request
                request_context = request_stream.select_next_some() => {
                    println!("Handling Service A API Request");
                    let (request, reply_tx) = request_context.split();

                    let service_b_response = self.service_b_handle.send_msg(request.clone()).await;
                    println!("Service A got a response from service B: {service_b_response}");

                    let mut response = self.response_msg.clone();
                    response.push_str(request.clone().as_str());
                    let _resp = reply_tx.send(response);
                },
                _ = shutdown_signal.wait() => {
                    println!("Service A shutting down because the shutdown signal was received");
                    break;
                }
            }
        }

        println!("Service A is shutdown");
    }
}

#[derive(Clone)]
pub struct ServiceAHandle {
    request_tx: SenderService<String, String>,
}

impl ServiceAHandle {
    pub fn new(request_tx: SenderService<String, String>) -> Self {
        Self { request_tx }
    }

    pub async fn send_msg(&mut self, msg: String) -> String {
        self.request_tx.call(msg).await.unwrap()
    }
}

pub struct ServiceAInitializer {
    response_msg: String,
}

impl ServiceAInitializer {
    pub fn new(response_msg: String) -> Self {
        Self { response_msg }
    }
}

#[async_trait]
#[allow(clippy::similar_names)]
impl ServiceInitializer for ServiceAInitializer {
    async fn initialize(&mut self, context: ServiceInitializerContext) -> Result<(), ServiceInitializationError> {
        let (sender, receiver) = reply_channel::unbounded();

        let service_a_handle = ServiceAHandle::new(sender);

        context.register_handle(service_a_handle);

        let response_msg = self.response_msg.clone();

        println!("Service A initialized waiting on Handles Future to complete");
        context.spawn_when_ready(move |handles| async move {
            println!("Service A got the handles");

            let service_b_handle = handles.expect_handle::<ServiceBHandle>();

            let service = ServiceA::new(response_msg, receiver, service_b_handle, handles.get_shutdown_signal());

            service.run().await;
            println!("Service A has shutdown and initializer spawned task is now ending");
        });
        Ok(())
    }
}