// Copyright 2024 RustFS Team // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Used by test_distributed_lock_4_nodes_grpc in lock.rs #![allow(dead_code)] use async_trait::async_trait; use rustfs_ecstore::rpc::node_service_time_out_client_no_auth; use rustfs_lock::{ LockClient, LockError, LockId, LockInfo, LockRequest, LockResponse, LockStats, LockStatus, LockType, Result, types::{LockMetadata, LockPriority}, }; use rustfs_protos::proto_gen::node_service::{BatchGenerallyLockRequest, GenerallyLockRequest, PingRequest}; use tonic::Request; use tracing::{info, warn}; /// gRPC lock client without authentication for testing /// Similar to RemoteClient but uses no_auth client #[derive(Debug, Clone)] pub struct GrpcLockClient { addr: String, } impl GrpcLockClient { pub fn new(endpoint: String) -> Self { Self { addr: endpoint } } async fn get_client( &self, ) -> Result< rustfs_protos::proto_gen::node_service::node_service_client::NodeServiceClient< tonic::service::interceptor::InterceptedService, >, > { node_service_time_out_client_no_auth(&self.addr) .await .map_err(|err| LockError::internal(format!("can not get client, err: {err}"))) } /// Create a minimal LockRequest for unlock operations using only lock_id fn create_unlock_request(lock_id: &LockId) -> LockRequest { LockRequest { lock_id: lock_id.clone(), resource: lock_id.resource.clone(), lock_type: LockType::Exclusive, // Type doesn't matter for unlock owner: String::new(), // Owner not needed, server uses lock_id acquire_timeout: std::time::Duration::from_secs(30), ttl: std::time::Duration::from_secs(300), metadata: LockMetadata::default(), priority: LockPriority::Normal, deadlock_detection: false, suppress_contention_logs: false, } } fn build_lock_info(request: &LockRequest, lock_info_json: Option) -> LockInfo { if let Some(lock_info_json) = lock_info_json { match serde_json::from_str::(&lock_info_json) { Ok(info) => info, Err(e) => { warn!("Failed to deserialize lock_info from response: {}, using request data", e); LockInfo { id: request.lock_id.clone(), resource: request.resource.clone(), lock_type: request.lock_type, status: LockStatus::Acquired, owner: request.owner.clone(), acquired_at: std::time::SystemTime::now(), expires_at: std::time::SystemTime::now() + request.ttl, last_refreshed: std::time::SystemTime::now(), metadata: request.metadata.clone(), priority: request.priority, wait_start_time: None, } } } } else { LockInfo { id: request.lock_id.clone(), resource: request.resource.clone(), lock_type: request.lock_type, status: LockStatus::Acquired, owner: request.owner.clone(), acquired_at: std::time::SystemTime::now(), expires_at: std::time::SystemTime::now() + request.ttl, last_refreshed: std::time::SystemTime::now(), metadata: request.metadata.clone(), priority: request.priority, wait_start_time: None, } } } } #[async_trait] impl LockClient for GrpcLockClient { async fn acquire_lock(&self, request: &LockRequest) -> Result { info!("grpc acquire_lock for {}", request.resource); let mut client = self.get_client().await?; let req = Request::new(GenerallyLockRequest { args: serde_json::to_string(&request) .map_err(|e| LockError::internal(format!("Failed to serialize request: {e}")))?, }); let resp = client .lock(req) .await .map_err(|e| LockError::internal(e.to_string()))? .into_inner(); // Check for explicit error first if let Some(error_info) = resp.error_info { return Err(LockError::internal(error_info)); } // Check if the lock acquisition was successful if resp.success { Ok(LockResponse::success( Self::build_lock_info(request, resp.lock_info), std::time::Duration::ZERO, )) } else { // Lock acquisition failed Ok(LockResponse::failure( "Lock acquisition failed on remote server".to_string(), std::time::Duration::ZERO, )) } } async fn acquire_locks_batch(&self, requests: &[LockRequest]) -> Result> { let mut client = self.get_client().await?; let req = Request::new(BatchGenerallyLockRequest { args: requests .iter() .map(|request| { serde_json::to_string(request).map_err(|e| LockError::internal(format!("Failed to serialize request: {e}"))) }) .collect::>>()?, }); let resp = client .lock_batch(req) .await .map_err(|e| LockError::internal(e.to_string()))? .into_inner(); Ok(requests .iter() .enumerate() .map(|(idx, request)| match resp.results.get(idx) { Some(result) if result.success => { LockResponse::success(Self::build_lock_info(request, result.lock_info.clone()), std::time::Duration::ZERO) } Some(result) => LockResponse::failure( result .error_info .clone() .unwrap_or_else(|| "Lock acquisition failed on remote server".to_string()), std::time::Duration::ZERO, ), None => LockResponse::failure( format!("Lock batch response missing entry for request index {idx}"), std::time::Duration::ZERO, ), }) .collect()) } async fn release(&self, lock_id: &LockId) -> Result { info!("grpc release for {}", lock_id); let unlock_request = Self::create_unlock_request(lock_id); let request_string = serde_json::to_string(&unlock_request) .map_err(|e| LockError::internal(format!("Failed to serialize request: {e}")))?; let mut client = self.get_client().await?; let req = Request::new(GenerallyLockRequest { args: request_string.clone(), }); let resp = client .un_lock(req) .await .map_err(|e| LockError::internal(e.to_string()))? .into_inner(); if let Some(error_info) = resp.error_info { return Err(LockError::internal(error_info)); } Ok(resp.success) } async fn release_locks_batch(&self, lock_ids: &[LockId]) -> Result> { let mut client = self.get_client().await?; let req = Request::new(BatchGenerallyLockRequest { args: lock_ids .iter() .map(|lock_id| { serde_json::to_string(&Self::create_unlock_request(lock_id)) .map_err(|e| LockError::internal(format!("Failed to serialize request: {e}"))) }) .collect::>>()?, }); let resp = client .un_lock_batch(req) .await .map_err(|e| LockError::internal(e.to_string()))? .into_inner(); Ok(lock_ids .iter() .enumerate() .map(|(idx, _)| resp.results.get(idx).map(|result| result.success).unwrap_or(false)) .collect()) } async fn refresh(&self, lock_id: &LockId) -> Result { info!("grpc refresh for {}", lock_id); let refresh_request = Self::create_unlock_request(lock_id); let mut client = self.get_client().await?; let req = Request::new(GenerallyLockRequest { args: serde_json::to_string(&refresh_request) .map_err(|e| LockError::internal(format!("Failed to serialize request: {e}")))?, }); let resp = client .refresh(req) .await .map_err(|e| LockError::internal(e.to_string()))? .into_inner(); if let Some(error_info) = resp.error_info { return Err(LockError::internal(error_info)); } Ok(resp.success) } async fn force_release(&self, lock_id: &LockId) -> Result { info!("grpc force_release for {}", lock_id); let force_request = Self::create_unlock_request(lock_id); let mut client = self.get_client().await?; let req = Request::new(GenerallyLockRequest { args: serde_json::to_string(&force_request) .map_err(|e| LockError::internal(format!("Failed to serialize request: {e}")))?, }); let resp = client .force_un_lock(req) .await .map_err(|e| LockError::internal(e.to_string()))? .into_inner(); if let Some(error_info) = resp.error_info { return Err(LockError::internal(error_info)); } Ok(resp.success) } async fn check_status(&self, lock_id: &LockId) -> Result> { info!("grpc check_status for {}", lock_id); // Since there's no direct status query in the gRPC service, // we attempt a non-blocking lock acquisition to check if the resource is available let status_request = Self::create_unlock_request(lock_id); let mut client = self.get_client().await?; // Try to acquire a very short-lived lock to test availability let req = Request::new(GenerallyLockRequest { args: serde_json::to_string(&status_request) .map_err(|e| LockError::internal(format!("Failed to serialize request: {e}")))?, }); // Try exclusive lock first with very short timeout let resp = client.lock(req).await; match resp { Ok(response) => { let resp = response.into_inner(); if resp.success { // If we successfully acquired the lock, the resource was free // Immediately release it let release_req = Request::new(GenerallyLockRequest { args: serde_json::to_string(&status_request) .map_err(|e| LockError::internal(format!("Failed to serialize request: {e}")))?, }); let _ = client.un_lock(release_req).await; // Best effort release // Return None since no one was holding the lock Ok(None) } else { // Lock acquisition failed, meaning someone is holding it // We can't determine the exact details remotely, so return a generic status Ok(Some(LockInfo { id: lock_id.clone(), resource: lock_id.resource.clone(), lock_type: LockType::Exclusive, // We can't know the exact type status: LockStatus::Acquired, owner: "unknown".to_string(), // Remote client can't determine owner acquired_at: std::time::SystemTime::now(), expires_at: std::time::SystemTime::now() + std::time::Duration::from_secs(3600), last_refreshed: std::time::SystemTime::now(), metadata: LockMetadata::default(), priority: LockPriority::Normal, wait_start_time: None, })) } } Err(_) => { // Communication error or lock is held Ok(Some(LockInfo { id: lock_id.clone(), resource: lock_id.resource.clone(), lock_type: LockType::Exclusive, status: LockStatus::Acquired, owner: "unknown".to_string(), acquired_at: std::time::SystemTime::now(), expires_at: std::time::SystemTime::now() + std::time::Duration::from_secs(3600), last_refreshed: std::time::SystemTime::now(), metadata: LockMetadata::default(), priority: LockPriority::Normal, wait_start_time: None, })) } } } async fn get_stats(&self) -> Result { info!("grpc get_stats from {}", self.addr); // Since there's no direct statistics endpoint in the gRPC service, // we return basic stats indicating this is a remote client let stats = LockStats { last_updated: std::time::SystemTime::now(), ..Default::default() }; Ok(stats) } async fn close(&self) -> Result<()> { Ok(()) } async fn is_online(&self) -> bool { // Use Ping interface to test if remote service is online let mut client = match self.get_client().await { Ok(client) => client, Err(_) => { info!("grpc client {} connection failed", self.addr); return false; } }; let ping_req = Request::new(PingRequest { version: 1, body: bytes::Bytes::new(), }); match client.ping(ping_req).await { Ok(_) => { info!("grpc client {} is online", self.addr); true } Err(_) => { info!("grpc client {} ping failed", self.addr); false } } } async fn is_local(&self) -> bool { false } }