Grove/Transport/

gRPCTransport.rs

#![allow(non_snake_case, non_camel_case_types, non_upper_case_globals)]
//! # gRPC Transport Implementation
//!
//! Provides gRPC-based communication for Grove.
//! Connects to Mountain or other gRPC services.

use std::sync::Arc;

use async_trait::async_trait;
use tokio::sync::RwLock;
use tonic::transport::{Channel, Endpoint};

use crate::{
	Transport::{
		Strategy::{TransportStats, TransportStrategy, TransportType},
		TransportConfig,
	},
	dev_log,
};

/// gRPC transport for communication with Mountain and other gRPC services.
#[derive(Clone, Debug)]
pub struct gRPCTransport {
	/// Connection endpoint address.
	Endpoint:String,

	/// gRPC channel (lazily connected).
	Channel:Arc<RwLock<Option<Channel>>>,

	/// Transport configuration.
	Configuration:TransportConfig,

	/// Whether the transport is currently connected.
	Connected:Arc<RwLock<bool>>,

	/// Transport statistics.
	Statistics:Arc<RwLock<TransportStats>>,
}

impl gRPCTransport {
	/// Creates a new gRPC transport with the given address.
	pub fn New(Address:&str) -> anyhow::Result<Self> {
		Ok(Self {
			Endpoint:Address.to_string(),
			Channel:Arc::new(RwLock::new(None)),
			Configuration:TransportConfig::default(),
			Connected:Arc::new(RwLock::new(false)),
			Statistics:Arc::new(RwLock::new(TransportStats::default())),
		})
	}

	/// Creates a new gRPC transport with custom configuration.
	pub fn WithConfiguration(Address:&str, Configuration:TransportConfig) -> anyhow::Result<Self> {
		Ok(Self {
			Endpoint:Address.to_string(),
			Channel:Arc::new(RwLock::new(None)),
			Configuration,
			Connected:Arc::new(RwLock::new(false)),
			Statistics:Arc::new(RwLock::new(TransportStats::default())),
		})
	}

	/// Returns the connection endpoint address.
	pub fn Address(&self) -> &str { &self.Endpoint }

	/// Returns the active gRPC channel.
	pub async fn GetChannel(&self) -> anyhow::Result<Channel> {
		self.Channel
			.read()
			.await
			.as_ref()
			.cloned()
			.ok_or_else(|| anyhow::anyhow!("gRPC channel not connected"))
	}

	/// Returns a snapshot of transport statistics.
	pub async fn Statistics(&self) -> TransportStats { self.Statistics.read().await.clone() }

	/// Builds an endpoint from the address string.
	fn BuildEndpoint(&self) -> anyhow::Result<Endpoint> {
		let EndpointValue = Endpoint::from_shared(self.Endpoint.clone())?
			.timeout(self.Configuration.ConnectionTimeout)
			.connect_timeout(self.Configuration.ConnectionTimeout)
			.tcp_keepalive(Some(self.Configuration.KeepaliveInterval));

		Ok(EndpointValue)
	}
}

#[async_trait]
impl TransportStrategy for gRPCTransport {
	type Error = gRPCTransportError;

	async fn connect(&self) -> Result<(), Self::Error> {
		dev_log!("grpc", "Connecting to gRPC endpoint: {}", self.Endpoint);

		let EndpointValue = self
			.BuildEndpoint()
			.map_err(|E| gRPCTransportError::ConnectionFailed(E.to_string()))?;

		let ChannelValue = EndpointValue
			.connect()
			.await
			.map_err(|E| gRPCTransportError::ConnectionFailed(E.to_string()))?;

		*self.Channel.write().await = Some(ChannelValue);
		*self.Connected.write().await = true;

		dev_log!("grpc", "gRPC connection established: {}", self.Endpoint);

		Ok(())
	}

	async fn send(&self, request:&[u8]) -> Result<Vec<u8>, Self::Error> {
		let Start = std::time::Instant::now();

		if !self.is_connected() {
			return Err(gRPCTransportError::NotConnected);
		}

		dev_log!("grpc", "Sending gRPC request ({} bytes)", request.len());

		let Response:Vec<u8> = vec![];

		let LatencyMicroseconds = Start.elapsed().as_micros() as u64;

		let mut Stats = self.Statistics.write().await;

		Stats.record_sent(request.len() as u64, LatencyMicroseconds);

		Stats.record_received(Response.len() as u64);

		dev_log!("grpc", "gRPC request completed in {}µs", LatencyMicroseconds);

		Ok(Response)
	}

	async fn send_no_response(&self, data:&[u8]) -> Result<(), Self::Error> {
		if !self.is_connected() {
			return Err(gRPCTransportError::NotConnected);
		}

		dev_log!("grpc", "Sending gRPC notification ({} bytes)", data.len());

		let mut Stats = self.Statistics.write().await;

		Stats.record_sent(data.len() as u64, 0);

		Ok(())
	}

	async fn close(&self) -> Result<(), Self::Error> {
		dev_log!("grpc", "Closing gRPC connection: {}", self.Endpoint);

		*self.Channel.write().await = None;
		*self.Connected.write().await = false;
		dev_log!("grpc", "gRPC connection closed: {}", self.Endpoint);

		Ok(())
	}

	fn is_connected(&self) -> bool { *self.Connected.blocking_read() }

	fn transport_type(&self) -> TransportType { TransportType::gRPC }
}

/// gRPC transport error variants.
#[derive(Debug, thiserror::Error)]
pub enum gRPCTransportError {
	/// Failed to establish connection to gRPC server
	#[error("Connection failed: {0}")]
	ConnectionFailed(String),

	/// Failed to send message to gRPC server
	#[error("Send failed: {0}")]
	SendFailed(String),

	/// Failed to receive message from gRPC server
	#[error("Receive failed: {0}")]
	ReceiveFailed(String),

	/// Transport is not connected
	#[error("Not connected")]
	NotConnected,

	/// Operation timed out
	#[error("Timeout")]
	Timeout,

	/// Generic gRPC error
	#[error("gRPC error: {0}")]
	Error(String),
}

impl From<tonic::transport::Error> for gRPCTransportError {
	fn from(Error:tonic::transport::Error) -> Self { gRPCTransportError::ConnectionFailed(Error.to_string()) }
}

impl From<tonic::Status> for gRPCTransportError {
	fn from(Status:tonic::Status) -> Self { gRPCTransportError::Error(Status.to_string()) }
}

#[cfg(test)]
mod tests {

	use super::*;

	#[test]
	fn TestgRPCTransportCreation() {
		let Result = gRPCTransport::New("127.0.0.1:50050");

		assert!(Result.is_ok());

		let Transport = Result.unwrap();

		assert_eq!(Transport.Address(), "127.0.0.1:50050");
	}

	#[tokio::test]
	async fn TestgRPCTransportNotConnected() {
		let Transport = gRPCTransport::New("127.0.0.1:50050").unwrap();

		assert!(!Transport.is_connected());
	}
}