Allow a max number of retries after a block fails

if `max_retries` is not set then no limit is used (same as previous
behavior).

Fixes #2152

Author: bim9262

src/blocks.rs

@@ -12,6 +12,7 @@
 //! `error_format` | Overrides global `error_format` | None
 //! `error_fullscreen_format` | Overrides global `error_fullscreen_format` | None
 //! `error_interval` | How long to wait until restarting the block after an error occurred. | `5`
+//! `max_retries` | How many times should a block be restarted the block after an error occurred. If no limit is specified none will be enforced. | `None`
 //! `[block.theme_overrides]` | Same as the top-level config option, but for this block only. Refer to `Themes and Icons` below. | None
 //! `[block.icons_overrides]` | Same as the top-level config option, but for this block only. Refer to `Themes and Icons` below. | None
 //! `[[block.click]]` | Set or override click action for the block. See below for details. | Block default / None
@@ -87,14 +88,25 @@ macro_rules! define_blocks {
                         $(#[cfg(feature = $feat)])?
                         #[allow(deprecated)]
                         Self::$block(config) => futures.push(async move {
-                            while let Err(err) = $block::run(&config, &api).await {
+                            let mut error_count: u8 = 0;
+                            while let Err(mut err) = $block::run(&config, &api).await {
+                                let should_retry = api
+                                    .max_retries
+                                    .map_or(true, |max_retries| error_count < max_retries);
+                                if !should_retry {
+                                    err = Error {
+                                        message: Some("Block failed too many times, giving up".into()),
+                                        cause: Some(Arc::new(err)),
+                                    };
+                                }
                                 if api.set_error(err).is_err() {
                                     return;
                                 }
                                 tokio::select! {
-                                    _ = tokio::time::sleep(api.error_interval) => (),
+                                    _ = tokio::time::sleep(api.error_interval), if should_retry => (),
                                     _ = api.wait_for_update_request() => (),
                                 }
+                                error_count = error_count.saturating_add(1);
                             }
                         }.boxed_local()),
                     )*
@@ -210,6 +222,7 @@ pub struct CommonApi {
     pub(crate) request_sender: mpsc::UnboundedSender<Request>,
     pub(crate) error_interval: Duration,
     pub(crate) geolocator: Arc<Geolocator>,
+    pub(crate) max_retries: Option<u8>,
 }
 
 impl CommonApi {

src/blocks/packages.rs

@@ -82,6 +82,8 @@
 //! [[block]]
 //! block = "packages"
 //! interval = 1800
+//! error_interval = 300
+//! max_retries = 5
 //! package_manager = ["apt"]
 //! format = " $icon $apt updates available"
 //! format_singular = " $icon One update available "
@@ -103,6 +105,8 @@
 //! block = "packages"
 //! package_manager = ["pacman"]
 //! interval = 600
+//! error_interval = 300
+//! max_retries = 5
 //! format = " $icon $pacman updates available "
 //! format_singular = " $icon $pacman update available "
 //! format_up_to_date = " $icon system up to date "
@@ -124,6 +128,7 @@
 //! package_manager = ["pacman", "aur"]
 //! interval = 600
 //! error_interval = 300
+//! max_retries = 5
 //! format = " $icon $pacman + $aur = $total updates available "
 //! format_singular = " $icon $total update available "
 //! format_up_to_date = " $icon system up to date "
@@ -139,6 +144,8 @@
 //! block = "packages"
 //! package_manager = ["dnf"]
 //! interval = 1800
+//! error_interval = 300
+//! max_retries = 5
 //! format = " $icon $dnf.eng(w:1) updates available "
 //! format_singular = " $icon One update available "
 //! format_up_to_date = " $icon system up to date "
@@ -156,6 +163,8 @@
 //! block = "packages"
 //! package_manager = ["xbps"]
 //! interval = 1800
+//! error_interval = 300
+//! max_retries = 5
 //! format = " $icon $xbps.eng(w:1) updates available "
 //! format_singular = " $icon One update available "
 //! format_up_to_date = " $icon system up to date "
@@ -174,6 +183,8 @@
 //! block = "packages"
 //! package_manager = ["apt", "pacman", "aur", "dnf", "xbps"]
 //! interval = 1800
+//! error_interval = 300
+//! max_retries = 5
 //! format = " $icon $apt + $pacman + $aur + $dnf + $xbps = $total updates available "
 //! format_singular = " $icon One update available "
 //! format_up_to_date = " $icon system up to date "

src/config.rs

@@ -108,6 +108,7 @@ pub struct CommonBlockConfig {
     pub error_interval: u64,
     pub error_format: FormatConfig,
     pub error_fullscreen_format: FormatConfig,
+    pub max_retries: Option<u8>,
 
     pub if_command: Option<String>,
 }

src/geolocator.rs

@@ -158,7 +158,7 @@ impl GeolocatorBackend {
             GeolocatorBackend::Ipapi(_) => ipapi::Ipapi.get_info(client).await,
             GeolocatorBackend::Ip2Location(config) => {
                 ip2location::Ip2Location
-                    .get_info(client, &config.api_key)
+                    .get_info(client, config.api_key.as_ref())
                     .await
             }
         }

src/geolocator/ip2location.rs

@@ -204,7 +204,7 @@ impl Ip2Location {
     pub async fn get_info(
         &self,
         client: &reqwest::Client,
-        api_key: &Option<String>,
+        api_key: Option<&String>,
     ) -> Result<IPAddressInfo> {
         let mut request_builder = client.get(IP_API_URL);
 

src/lib.rs

@@ -270,6 +270,7 @@ impl BarState {
             request_sender: self.request_sender.clone(),
             error_interval: Duration::from_secs(block_config.common.error_interval),
             geolocator: self.config.geolocator.clone(),
+            max_retries: block_config.common.max_retries,
         };
 
         let error_format = block_config