mirror of
https://github.com/EasyTier/EasyTier.git
synced 2026-05-07 02:09:06 +00:00
refactor(rpc): Centralize RPC service and unify API (#1427)
This change introduces a major refactoring of the RPC service layer to improve modularity, unify the API, and simplify the overall architecture. Key changes: - Replaced per-network-instance RPC services with a single global RPC server, reducing resource usage and simplifying management. - All clients (CLI, Web UI, etc.) now interact with EasyTier core through a unified RPC entrypoint, enabling consistent authentication and control. - RPC implementation logic has been moved to `easytier/src/rpc_service/` and organized by functionality (e.g., `instance_manage.rs`, `peer_manage.rs`, `config.rs`) for better maintainability. - Standardized Protobuf API definitions under `easytier/src/proto/` with an `api_` prefix (e.g., `cli.proto` → `api_instance.proto`) to provide a consistent interface. - CLI commands now require explicit `--instance-id` or `--instance-name` when multiple network instances are running; the parameter is optional when only one instance exists. BREAKING CHANGE: RPC portal configuration (`rpc_portal` and `rpc_portal_whitelist`) has been removed from per-instance configs and the Web UI. The RPC listen address must now be specified globally via the `--rpc-portal` command-line flag or the `ET_RPC_PORTAL` environment variable, as there is only one RPC service for the entire application.
This commit is contained in:
@@ -32,7 +32,7 @@ use crate::{
|
||||
peer_center::instance::{PeerCenterInstance, PeerMapWithPeerRpcManager},
|
||||
peers::route_trait::{Route, RouteInterface},
|
||||
proto::{
|
||||
cli::{ForeignNetworkEntryPb, ListForeignNetworkResponse, PeerInfo},
|
||||
api::instance::{ForeignNetworkEntryPb, ListForeignNetworkResponse, PeerInfo},
|
||||
common::LimiterConfig,
|
||||
peer_rpc::DirectConnectorRpcServer,
|
||||
},
|
||||
|
||||
@@ -11,7 +11,7 @@ use super::{
|
||||
peer_conn::{PeerConn, PeerConnId},
|
||||
PacketRecvChan,
|
||||
};
|
||||
use crate::{common::scoped_task::ScopedTask, proto::cli::PeerConnInfo};
|
||||
use crate::{common::scoped_task::ScopedTask, proto::api::instance::PeerConnInfo};
|
||||
use crate::{
|
||||
common::{
|
||||
error::Error,
|
||||
|
||||
@@ -32,7 +32,7 @@ use crate::{
|
||||
PeerId,
|
||||
},
|
||||
proto::{
|
||||
cli::{PeerConnInfo, PeerConnStats},
|
||||
api::instance::{PeerConnInfo, PeerConnStats},
|
||||
common::TunnelInfo,
|
||||
peer_rpc::HandshakeRequest,
|
||||
},
|
||||
|
||||
@@ -36,7 +36,7 @@ use crate::{
|
||||
PeerPacketFilter,
|
||||
},
|
||||
proto::{
|
||||
cli::{
|
||||
api::instance::{
|
||||
self, list_global_foreign_network_response::OneForeignNetwork,
|
||||
ListGlobalForeignNetworkResponse,
|
||||
},
|
||||
@@ -920,7 +920,7 @@ impl PeerManager {
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn list_routes(&self) -> Vec<cli::Route> {
|
||||
pub async fn list_routes(&self) -> Vec<instance::Route> {
|
||||
self.get_route().list_routes().await
|
||||
}
|
||||
|
||||
@@ -1305,8 +1305,8 @@ impl PeerManager {
|
||||
self.foreign_network_client.clone()
|
||||
}
|
||||
|
||||
pub async fn get_my_info(&self) -> cli::NodeInfo {
|
||||
cli::NodeInfo {
|
||||
pub async fn get_my_info(&self) -> instance::NodeInfo {
|
||||
instance::NodeInfo {
|
||||
peer_id: self.my_peer_id,
|
||||
ipv4_addr: self
|
||||
.global_ctx
|
||||
|
||||
@@ -14,7 +14,7 @@ use crate::{
|
||||
PeerId,
|
||||
},
|
||||
proto::{
|
||||
cli::{self, PeerConnInfo},
|
||||
api::instance::{self, PeerConnInfo},
|
||||
peer_rpc::RoutePeerInfo,
|
||||
},
|
||||
tunnel::{packet_def::ZCPacket, TunnelError},
|
||||
@@ -336,7 +336,7 @@ impl PeerMap {
|
||||
route_map
|
||||
}
|
||||
|
||||
pub async fn list_route_infos(&self) -> Vec<cli::Route> {
|
||||
pub async fn list_route_infos(&self) -> Vec<instance::Route> {
|
||||
if let Some(route) = self.routes.read().await.iter().next() {
|
||||
return route.list_routes().await;
|
||||
}
|
||||
|
||||
@@ -193,7 +193,7 @@ impl RoutePeerInfo {
|
||||
}
|
||||
}
|
||||
|
||||
impl From<RoutePeerInfo> for crate::proto::cli::Route {
|
||||
impl From<RoutePeerInfo> for crate::proto::api::instance::Route {
|
||||
fn from(val: RoutePeerInfo) -> Self {
|
||||
let network_length = if val.network_length == 0 {
|
||||
24
|
||||
@@ -201,7 +201,7 @@ impl From<RoutePeerInfo> for crate::proto::cli::Route {
|
||||
val.network_length
|
||||
};
|
||||
|
||||
crate::proto::cli::Route {
|
||||
crate::proto::api::instance::Route {
|
||||
peer_id: val.peer_id,
|
||||
ipv4_addr: val.ipv4_addr.map(|ipv4_addr| Ipv4Inet {
|
||||
address: Some(ipv4_addr),
|
||||
@@ -2361,7 +2361,7 @@ impl Route for PeerRoute {
|
||||
.map(|x| x.next_hop_peer_id)
|
||||
}
|
||||
|
||||
async fn list_routes(&self) -> Vec<crate::proto::cli::Route> {
|
||||
async fn list_routes(&self) -> Vec<crate::proto::api::instance::Route> {
|
||||
let route_table = &self.service_impl.route_table;
|
||||
let route_table_with_cost = &self.service_impl.route_table_with_cost;
|
||||
let mut routes = Vec::new();
|
||||
@@ -2373,7 +2373,7 @@ impl Route for PeerRoute {
|
||||
continue;
|
||||
};
|
||||
let next_hop_peer_latency_first = route_table_with_cost.get_next_hop(*item.key());
|
||||
let mut route: crate::proto::cli::Route = item.value().clone().into();
|
||||
let mut route: crate::proto::api::instance::Route = item.value().clone().into();
|
||||
route.next_hop_peer_id = next_hop_peer.next_hop_peer_id;
|
||||
route.cost = next_hop_peer.path_len as i32;
|
||||
route.path_latency = next_hop_peer.path_latency;
|
||||
|
||||
@@ -74,7 +74,7 @@ pub trait Route {
|
||||
self.get_next_hop(peer_id).await
|
||||
}
|
||||
|
||||
async fn list_routes(&self) -> Vec<crate::proto::cli::Route>;
|
||||
async fn list_routes(&self) -> Vec<crate::proto::api::instance::Route>;
|
||||
|
||||
async fn get_peer_id_by_ipv4(&self, _ipv4: &Ipv4Addr) -> Option<PeerId> {
|
||||
None
|
||||
@@ -161,7 +161,7 @@ impl Route for MockRoute {
|
||||
panic!("mock route")
|
||||
}
|
||||
|
||||
async fn list_routes(&self) -> Vec<crate::proto::cli::Route> {
|
||||
async fn list_routes(&self) -> Vec<crate::proto::api::instance::Route> {
|
||||
panic!("mock route")
|
||||
}
|
||||
|
||||
|
||||
@@ -1,26 +1,34 @@
|
||||
use std::sync::Arc;
|
||||
use std::{
|
||||
ops::Deref,
|
||||
sync::{Arc, Weak},
|
||||
};
|
||||
|
||||
use crate::proto::{
|
||||
cli::{
|
||||
AclManageRpc, DumpRouteRequest, DumpRouteResponse, GetAclStatsRequest, GetAclStatsResponse,
|
||||
GetWhitelistRequest, GetWhitelistResponse, ListForeignNetworkRequest,
|
||||
ListForeignNetworkResponse, ListGlobalForeignNetworkRequest,
|
||||
ListGlobalForeignNetworkResponse, ListPeerRequest, ListPeerResponse, ListRouteRequest,
|
||||
ListRouteResponse, PeerInfo, PeerManageRpc, ShowNodeInfoRequest, ShowNodeInfoResponse,
|
||||
use crate::{
|
||||
proto::{
|
||||
api::instance::{
|
||||
AclManageRpc, DumpRouteRequest, DumpRouteResponse, GetAclStatsRequest,
|
||||
GetAclStatsResponse, GetWhitelistRequest, GetWhitelistResponse,
|
||||
ListForeignNetworkRequest, ListForeignNetworkResponse, ListGlobalForeignNetworkRequest,
|
||||
ListGlobalForeignNetworkResponse, ListPeerRequest, ListPeerResponse, ListRouteRequest,
|
||||
ListRouteResponse, PeerInfo, PeerManageRpc, ShowNodeInfoRequest, ShowNodeInfoResponse,
|
||||
},
|
||||
rpc_types::{self, controller::BaseController},
|
||||
},
|
||||
rpc_types::{self, controller::BaseController},
|
||||
utils::weak_upgrade,
|
||||
};
|
||||
|
||||
use super::peer_manager::PeerManager;
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct PeerManagerRpcService {
|
||||
peer_manager: Arc<PeerManager>,
|
||||
peer_manager: Weak<PeerManager>,
|
||||
}
|
||||
|
||||
impl PeerManagerRpcService {
|
||||
pub fn new(peer_manager: Arc<PeerManager>) -> Self {
|
||||
PeerManagerRpcService { peer_manager }
|
||||
PeerManagerRpcService {
|
||||
peer_manager: Arc::downgrade(&peer_manager),
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn list_peers(peer_manager: &PeerManager) -> Vec<PeerInfo> {
|
||||
@@ -78,7 +86,8 @@ impl PeerManageRpc for PeerManagerRpcService {
|
||||
) -> Result<ListPeerResponse, rpc_types::error::Error> {
|
||||
let mut reply = ListPeerResponse::default();
|
||||
|
||||
let peers = PeerManagerRpcService::list_peers(&self.peer_manager).await;
|
||||
let peers =
|
||||
PeerManagerRpcService::list_peers(weak_upgrade(&self.peer_manager)?.deref()).await;
|
||||
for peer in peers {
|
||||
reply.peer_infos.push(peer);
|
||||
}
|
||||
@@ -92,7 +101,7 @@ impl PeerManageRpc for PeerManagerRpcService {
|
||||
_request: ListRouteRequest, // Accept request of type HelloRequest
|
||||
) -> Result<ListRouteResponse, rpc_types::error::Error> {
|
||||
let reply = ListRouteResponse {
|
||||
routes: self.peer_manager.list_routes().await,
|
||||
routes: weak_upgrade(&self.peer_manager)?.list_routes().await,
|
||||
};
|
||||
Ok(reply)
|
||||
}
|
||||
@@ -103,7 +112,7 @@ impl PeerManageRpc for PeerManagerRpcService {
|
||||
_request: DumpRouteRequest, // Accept request of type HelloRequest
|
||||
) -> Result<DumpRouteResponse, rpc_types::error::Error> {
|
||||
let reply = DumpRouteResponse {
|
||||
result: self.peer_manager.dump_route().await,
|
||||
result: weak_upgrade(&self.peer_manager)?.dump_route().await,
|
||||
};
|
||||
Ok(reply)
|
||||
}
|
||||
@@ -113,8 +122,7 @@ impl PeerManageRpc for PeerManagerRpcService {
|
||||
_: BaseController,
|
||||
_request: ListForeignNetworkRequest, // Accept request of type HelloRequest
|
||||
) -> Result<ListForeignNetworkResponse, rpc_types::error::Error> {
|
||||
let reply = self
|
||||
.peer_manager
|
||||
let reply = weak_upgrade(&self.peer_manager)?
|
||||
.get_foreign_network_manager()
|
||||
.list_foreign_networks()
|
||||
.await;
|
||||
@@ -126,7 +134,9 @@ impl PeerManageRpc for PeerManagerRpcService {
|
||||
_: BaseController,
|
||||
_request: ListGlobalForeignNetworkRequest,
|
||||
) -> Result<ListGlobalForeignNetworkResponse, rpc_types::error::Error> {
|
||||
Ok(self.peer_manager.list_global_foreign_network().await)
|
||||
Ok(weak_upgrade(&self.peer_manager)?
|
||||
.list_global_foreign_network()
|
||||
.await)
|
||||
}
|
||||
|
||||
async fn show_node_info(
|
||||
@@ -135,7 +145,7 @@ impl PeerManageRpc for PeerManagerRpcService {
|
||||
_request: ShowNodeInfoRequest, // Accept request of type HelloRequest
|
||||
) -> Result<ShowNodeInfoResponse, rpc_types::error::Error> {
|
||||
Ok(ShowNodeInfoResponse {
|
||||
node_info: Some(self.peer_manager.get_my_info().await),
|
||||
node_info: Some(weak_upgrade(&self.peer_manager)?.get_my_info().await),
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -149,8 +159,7 @@ impl AclManageRpc for PeerManagerRpcService {
|
||||
_: BaseController,
|
||||
_request: GetAclStatsRequest,
|
||||
) -> Result<GetAclStatsResponse, rpc_types::error::Error> {
|
||||
let acl_stats = self
|
||||
.peer_manager
|
||||
let acl_stats = weak_upgrade(&self.peer_manager)?
|
||||
.get_global_ctx()
|
||||
.get_acl_filter()
|
||||
.get_stats();
|
||||
@@ -164,7 +173,7 @@ impl AclManageRpc for PeerManagerRpcService {
|
||||
_: BaseController,
|
||||
_request: GetWhitelistRequest,
|
||||
) -> Result<GetWhitelistResponse, rpc_types::error::Error> {
|
||||
let global_ctx = self.peer_manager.get_global_ctx();
|
||||
let global_ctx = weak_upgrade(&self.peer_manager)?.get_global_ctx();
|
||||
let tcp_ports = global_ctx.config.get_tcp_whitelist();
|
||||
let udp_ports = global_ctx.config.get_udp_whitelist();
|
||||
tracing::info!(
|
||||
|
||||
Reference in New Issue
Block a user