Skip to content

Commit

Permalink
remove hibernation logic
Browse files Browse the repository at this point in the history 
The reconnect after hibernation does not fix the root cause of errors
originating from lost grpc connections after hibernation. When the app
comes back from hibernation, any already outgoing grpc request will fail
with a transport error. The only way to get around that is by retrying
the request. Also, grpc connections are automatically reestablished
after such a failure occurs. If the grpc client gets a timeout or broken
connection failure on one request, the next request will succeed with a
fresh underlying connection.
  • Loading branch information
@JssDWt
JssDWt committed Dec 2, 2024
1 parent ec42478 commit f7518ea
Show file tree
Hide file tree
Showing 5 changed files with 0 additions and 117 deletions.
7 changes: 0 additions & 7 deletions libs/sdk-common/src/breez_server.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,16 @@ pub static STAGING_BREEZSERVER_URL: &str = "https://bs1-st.breez.technology:443"
pub struct BreezServer {
grpc_channel: Mutex<Channel>,
api_key: Option<String>,
server_url: String,
}

impl BreezServer {
pub fn new(server_url: String, api_key: Option<String>) -> Result<Self> {
Ok(Self {
grpc_channel: Mutex::new(Self::create_endpoint(&server_url)?.connect_lazy()),
api_key,
server_url,
})
}

pub async fn reconnect(&self) -> Result<()> {
*self.grpc_channel.lock().await = Self::create_endpoint(&self.server_url)?.connect_lazy();
Ok(())
}

fn create_endpoint(server_url: &str) -> Result<Endpoint> {
Ok(Endpoint::from_shared(server_url.to_string())?
.http2_keep_alive_interval(Duration::new(5, 0))
Expand Down
80 changes: 0 additions & 80 deletions libs/sdk-core/src/breez_services.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,6 @@ use crate::swap_out::boltzswap::BoltzApi;
use crate::swap_out::reverseswap::BTCSendSwap;
use crate::*;

const DETECT_HIBERNATE_SLEEP_DURATION: Duration = Duration::from_secs(1);
const DETECT_HIBERNATE_MAX_OFFSET: Duration = Duration::from_secs(2);
pub type BreezServicesResult<T, E = ConnectError> = Result<T, E>;

/// Trait that can be used to react to various [BreezEvent]s emitted by the SDK.
Expand Down Expand Up @@ -170,8 +168,6 @@ pub struct BreezServices {
backup_watcher: Arc<BackupWatcher>,
shutdown_sender: watch::Sender<()>,
shutdown_receiver: watch::Receiver<()>,
reconnect_sender: watch::Sender<()>,
reconnect_receiver: watch::Receiver<()>,
}

impl BreezServices {
Expand Down Expand Up @@ -1437,9 +1433,6 @@ impl BreezServices {
///
/// Internal method. Should only be used as part of [BreezServices::start]
async fn start_background_tasks(self: &Arc<BreezServices>) -> SdkResult<()> {
// Detect hibernation
self.detect_hibernation();

// start the signer
let (shutdown_signer_sender, signer_signer_receiver) = watch::channel(());
self.start_signer(signer_signer_receiver).await;
Expand Down Expand Up @@ -1491,45 +1484,7 @@ impl BreezServices {
Ok(())
}

async fn reconnect(self: &Arc<BreezServices>) {
// Reconnect node api before notifying anything else, to
// ensure there are no races reconnecting dependant
// services.
debug!("Reconnecting node api.");
self.node_api.reconnect().await;

// Now notify dependant services.
debug!("Notifying services about reconnect.");
let _ = self.reconnect_sender.send(());
}

fn detect_hibernation(self: &Arc<BreezServices>) {
let cloned = Arc::clone(self);
tokio::spawn(async move {
loop {
let now = SystemTime::now();
tokio::time::sleep(DETECT_HIBERNATE_SLEEP_DURATION).await;
let elapsed = match now.elapsed() {
Ok(elapsed) => elapsed,
Err(e) => {
error!("track_hibernation failed with: {:?}", e);
continue;
}
};

if elapsed
.saturating_sub(DETECT_HIBERNATE_SLEEP_DURATION)
.ge(&DETECT_HIBERNATE_MAX_OFFSET)
{
debug!("Hibernation detected, time diff {}s", elapsed.as_secs_f32());
cloned.reconnect().await;
}
}
});
}

async fn start_signer(self: &Arc<BreezServices>, mut shutdown_receiver: watch::Receiver<()>) {
let mut reconnect_receiver = self.reconnect_receiver.clone();
let node_api = self.node_api.clone();

tokio::spawn(async move {
Expand All @@ -1544,12 +1499,6 @@ impl BreezServices {
_ = shutdown_receiver.changed() => {
true
}

_ = reconnect_receiver.changed() => {
// NOTE: The node api is reconnected already inside the
// reconnect function, to avoid races.
false
}
};

debug!("shutting down signer");
Expand Down Expand Up @@ -1650,7 +1599,6 @@ impl BreezServices {
let cloned = self.clone();
tokio::spawn(async move {
let mut shutdown_receiver = cloned.shutdown_receiver.clone();
let mut reconnect_receiver = cloned.reconnect_receiver.clone();
loop {
if shutdown_receiver.has_changed().unwrap_or(true) {
return;
Expand All @@ -1674,11 +1622,6 @@ impl BreezServices {
debug!("Invoice tracking task has completed");
return;
}

_ = reconnect_receiver.changed() => {
debug!("Reconnect: track invoices");
break;
}
};

let i = match paid_invoice_res {
Expand Down Expand Up @@ -1735,7 +1678,6 @@ impl BreezServices {
let cloned = self.clone();
tokio::spawn(async move {
let mut shutdown_receiver = cloned.shutdown_receiver.clone();
let mut reconnect_receiver = cloned.reconnect_receiver.clone();
loop {
if shutdown_receiver.has_changed().unwrap_or(true) {
return;
Expand All @@ -1759,11 +1701,6 @@ impl BreezServices {
debug!("Track logs task has completed");
return;
}

_ = reconnect_receiver.changed() => {
debug!("Reconnect: track logs");
break;
}
};

match log_message_res {
Expand Down Expand Up @@ -2396,7 +2333,6 @@ impl BreezServicesBuilder {
});
}

let (reconnect_sender, reconnect_receiver) = watch::channel(());
// The storage is implemented via sqlite.
let persister = self
.persister
Expand Down Expand Up @@ -2470,20 +2406,6 @@ impl BreezServicesBuilder {
}
});

// Reconnect breez server on when requested.
let cloned_breez_server = breez_server.clone();
let mut cloned_reconnect_receiver = reconnect_receiver.clone();
tokio::spawn(async move {
loop {
if cloned_reconnect_receiver.changed().await.is_err() {
return;
}

debug!("Reconnect: reconnecting breez server");
let _ = cloned_breez_server.reconnect().await;
}
});

let current_lsp_id = persister.get_lsp_id()?;
if current_lsp_id.is_none() && self.config.default_lsp_id.is_some() {
persister.set_lsp(self.config.default_lsp_id.clone().unwrap(), None)?;
Expand Down Expand Up @@ -2574,8 +2496,6 @@ impl BreezServicesBuilder {
backup_watcher: Arc::new(backup_watcher),
shutdown_sender,
shutdown_receiver,
reconnect_sender,
reconnect_receiver,
});

Ok(breez_services)
Expand Down
28 changes: 0 additions & 28 deletions libs/sdk-core/src/greenlight/node_api.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ pub(crate) struct Greenlight {
sdk_config: Config,
signer: Mutex<Arc<Signer>>,
device: Device,
seed: Vec<u8>,
gl_client: Mutex<Option<node::Client>>,
node_client: Mutex<Option<ClnClient>>,
persister: Arc<SqliteStorage>,
Expand Down Expand Up @@ -182,7 +181,6 @@ impl Greenlight {
sdk_config,
signer: Mutex::new(Arc::new(signer)),
device,
seed,
gl_client: Mutex::new(None),
node_client: Mutex::new(None),
persister,
Expand Down Expand Up @@ -1002,32 +1000,6 @@ struct SyncState {

#[tonic::async_trait]
impl NodeAPI for Greenlight {
async fn reconnect(&self) {
debug!("Reconnect: request received");

// Force refresh existing grpc clients
*self.gl_client.lock().await = None;
*self.node_client.lock().await = None;

// Create a new signer
debug!("Reconnect: creating new signer");
let new_signer = match Signer::new(
self.seed.clone(),
self.sdk_config.network.into(),
self.device.clone(),
) {
Ok(new_signer) => new_signer,
Err(e) => {
error!(
"Reconnect: failed to create new signer after reconnect request: {:?}",
e
);
return;
}
};
*self.signer.lock().await = Arc::new(new_signer);
}

async fn node_credentials(&self) -> NodeResult<Option<NodeCredentials>> {
Ok(Self::get_node_credentials(
self.sdk_config.network,
Expand Down
1 change: 0 additions & 1 deletion libs/sdk-core/src/node_api.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@ pub struct FetchBolt11Result {
/// Trait covering functions affecting the LN node
#[tonic::async_trait]
pub trait NodeAPI: Send + Sync {
async fn reconnect(&self);
async fn node_credentials(&self) -> NodeResult<Option<NodeCredentials>>;
async fn configure_node(&self, close_to_address: Option<String>) -> NodeResult<()>;
async fn create_invoice(&self, request: CreateInvoiceRequest) -> NodeResult<String>;
Expand Down
1 change: 0 additions & 1 deletion libs/sdk-core/src/test_utils.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,6 @@ pub struct MockNodeAPI {

#[tonic::async_trait]
impl NodeAPI for MockNodeAPI {
async fn reconnect(&self) {}
async fn node_credentials(&self) -> NodeResult<Option<NodeCredentials>> {
Err(NodeError::Generic("Not implemented".to_string()))
}
Expand Down

0 comments on commit f7518ea

Please sign in to comment.