Add retry button that can be used to restart block

After a block fails, the user can click the retry button to restart the block.
This is nicer than having to restart the whole status bar, or sending a signal.

Author: bim9262

files/icons/awesome4.toml

@@ -58,6 +58,7 @@ pomodoro_break = "\uf0f4" # fa-coffee
 pomodoro_paused = "\uf04c" # fa-pause
 pomodoro_started = "\uf04b" # fa-play
 pomodoro_stopped = "\uf04d" # fa-stop
+refresh = "\uf021" # fa-refresh
 resolution = "\uf096" # fa-square-o
 scratchpad = "\uf2d2" # fa-window-restore
 tasks = "\uf0ae" # fa-tasks

files/icons/awesome5.toml

@@ -58,6 +58,7 @@ pomodoro_break = "\uf0f4"         # fa-coffee
 pomodoro_paused = "\uf04c"        # fa-pause
 pomodoro_started = "\uf04b"       # fa-play
 pomodoro_stopped = "\uf04d"       # fa-stop
+refresh = "\uf021" 				  # fa-sync
 resolution = "\uf096"             # fa-square-o
 scratchpad = "\uf2d2" # fa-window-restore
 tasks = "\uf0ae"

files/icons/awesome6.toml

@@ -62,6 +62,7 @@ pomodoro_break = "\uf0f4"         # fa-coffee
 pomodoro_paused = "\uf04c"        # fa-pause
 pomodoro_started = "\uf04b"       # fa-play
 pomodoro_stopped = "\uf04d"       # fa-stop
+refresh = "\uf021"                # fa-arrows-rotate
 resolution = "\uf096"             # fa-square-o
 scratchpad = "\uf2d2" # fa-window-restore
 tasks = "\uf0ae"

files/icons/emoji.toml

@@ -54,6 +54,7 @@ pomodoro_break = "☕"
 pomodoro_paused = "⏸️"
 pomodoro_started = "▶️"
 pomodoro_stopped = "⏹️"
+refresh = "🔄"
 resolution = "🔳"
 scratchpad = "🗔"
 tasks = "✅"

files/icons/material-nf.toml

@@ -91,6 +91,7 @@ pomodoro_break = "\U000f0176" # nf-md-coffee
 pomodoro_paused = "\U000f03e4" # nf-md-pause
 pomodoro_started = "\U000f040a" # nf-md-play
 pomodoro_stopped = "\U000f04db" # nf-md-stop
+refresh = "\U000f0450" # nf-md-refresh
 resolution = "\U000f0293" # nf-md-fullscreen
 scratchpad = "\U000f05b2" # nf-md-window_restore
 tasks = "\U000f05c7" # nf-md-playlist_check

files/icons/material.toml

@@ -75,6 +75,7 @@ pomodoro_break = "\uefef" # coffee | TODO: broken?
 pomodoro_paused = "\ue034" # pause
 pomodoro_started = "\ue037" # play_arrow
 pomodoro_stopped = "\uef6a" # play_disabled ef6a | TODO: broken?
+refresh = "\ue5d5" # refresh
 resolution = "\uf152" # crop-square-rounded
 scratchpad = "\ue883" # flip_to_front
 tasks = "\ue8f9" # work

src/blocks.rs

@@ -45,6 +45,8 @@ use crate::geolocator::{Geolocator, IPAddressInfo};
 use crate::widget::Widget;
 use crate::{BoxedFuture, Request, RequestCmd};
 
+pub(super) const RESTART_BLOCK_BTN: &str = "restart_block_btn";
+
 macro_rules! define_blocks {
     {
         $(
@@ -90,20 +92,32 @@ macro_rules! define_blocks {
                         Self::$block(config) => futures.push(async move {
                             let mut error_count: u8 = 0;
                             while let Err(mut err) = $block::run(&config, &api).await {
+                                let Ok(mut actions) = api.get_actions() else { return };
+                                if api.set_default_actions(&[
+                                    (MouseButton::Left, Some(RESTART_BLOCK_BTN), "error_count_reset"),
+                                ]).is_err() {
+                                    return;
+                                }
                                 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()),
+                                        message: Some("Block stopped, left click refresh icon to restart block".into()),
                                         cause: Some(Arc::new(err)),
                                     };
                                 }
-                                if api.set_error(err).is_err() {
+                                if api.set_error_with_restartable(err, !should_retry).is_err() {
                                     return;
                                 }
                                 tokio::select! {
                                     _ = tokio::time::sleep(api.error_interval), if should_retry => (),
+                                    Some(action) = actions.recv(), if !should_retry  => match action.as_ref(){
+                                        "error_count_reset" => {
+                                            error_count = 0;
+                                        },
+                                        _ => (),
+                                    },
                                     _ = api.wait_for_update_request() => (),
                                 }
                                 error_count = error_count.saturating_add(1);
@@ -246,12 +260,17 @@ impl CommonApi {
             .error("Failed to send Request")
     }
 
-    /// Sends the error to be displayed.
+    /// Sends the error to be displayed, no restart button will be shown.
     pub fn set_error(&self, error: Error) -> Result<()> {
+        self.set_error_with_restartable(error, false)
+    }
+
+    /// Sends the error to be displayed.
+    pub fn set_error_with_restartable(&self, error: Error, restartable: bool) -> Result<()> {
         self.request_sender
             .send(Request {
                 block_id: self.id,
-                cmd: RequestCmd::SetError(error),
+                cmd: RequestCmd::SetError { error, restartable },
             })
             .error("Failed to send Request")
     }

src/config.rs

@@ -60,11 +60,15 @@ impl Default for SharedConfig {
 }
 
 fn default_error_format() -> FormatConfig {
-    " {$short_error_message|X} ".parse().unwrap()
+    " {$restart_block_icon |}{$short_error_message|X} "
+        .parse()
+        .unwrap()
 }
 
 fn default_error_fullscreen() -> FormatConfig {
-    " $full_error_message ".parse().unwrap()
+    " {$restart_block_icon |}$full_error_message "
+        .parse()
+        .unwrap()
 }
 
 fn default_icons_format() -> Arc<String> {

src/icons.rs

@@ -84,6 +84,7 @@ impl Default for Icons {
             "pomodoro_paused" => "PAUSED",
             "pomodoro_started" => "STARTED",
             "pomodoro_stopped" => "STOPPED",
+            "refresh" => "REFRESH",
             "resolution" => "RES",
             "scratchpad" => "[]",
             "tasks" => "TSK",

src/lib.rs

@@ -37,7 +37,7 @@ use futures::stream::{FuturesUnordered, StreamExt as _};
 use tokio::process::Command;
 use tokio::sync::{Notify, mpsc};
 
-use crate::blocks::{BlockAction, BlockError, CommonApi};
+use crate::blocks::{BlockAction, BlockError, CommonApi, RESTART_BLOCK_BTN};
 use crate::click::{ClickHandler, MouseButton};
 use crate::config::{BlockConfigEntry, Config, SharedConfig};
 use crate::errors::*;
@@ -131,7 +131,7 @@ struct Request {
 enum RequestCmd {
     SetWidget(Widget),
     UnsetWidget,
-    SetError(Error),
+    SetError { error: Error, restartable: bool },
     SetDefaultActions(&'static [(MouseButton, Option<&'static str>, &'static str)]),
     SubscribeToActions(mpsc::UnboundedSender<BlockAction>),
 }
@@ -186,6 +186,10 @@ impl Block {
     }
 
     fn set_error(&mut self, fullscreen: bool, error: Error) {
+        self.set_error_with_restartable(fullscreen, false, error);
+    }
+
+    fn set_error_with_restartable(&mut self, fullscreen: bool, restartable: bool, error: Error) {
         let error = BlockError {
             block_id: self.id,
             block_name: self.name,
@@ -202,6 +206,7 @@ impl Block {
         widget.set_values(map! {
             "full_error_message" => Value::text(error.to_string()),
             [if let Some(v) = &error.error.message] "short_error_message" => Value::text(v.to_string()),
+            [if restartable] "restart_block_icon" => Value::icon("refresh").with_instance(RESTART_BLOCK_BTN),
         });
         self.state = BlockState::Error { widget };
     }
@@ -326,8 +331,12 @@ impl BarState {
                     self.fullscreen_block = None;
                 }
             }
-            RequestCmd::SetError(error) => {
-                block.set_error(self.fullscreen_block == Some(request.block_id), error);
+            RequestCmd::SetError { error, restartable } => {
+                block.set_error_with_restartable(
+                    self.fullscreen_block == Some(request.block_id),
+                    restartable,
+                    error,
+                );
             }
             RequestCmd::SetDefaultActions(actions) => {
                 block.default_actions = actions;
@@ -415,16 +424,22 @@ impl BarState {
                         }
                     }
                     BlockState::Error { widget } => {
-                        if self.fullscreen_block == Some(event.id) {
-                            self.fullscreen_block = None;
-                            widget.set_format(block.error_format.clone());
+                        if let Some((_, _, action)) = block.default_actions
+                            .iter()
+                            .find(|(btn, widget, _)| *btn == event.button && *widget == event.instance.as_deref()) {
+                            block.send_action(Cow::Borrowed(action));
                         } else {
-                            self.fullscreen_block = Some(event.id);
-                            widget.set_format(block.error_fullscreen_format.clone());
+                            if self.fullscreen_block == Some(event.id) {
+                                self.fullscreen_block = None;
+                                widget.set_format(block.error_format.clone());
+                            } else {
+                                self.fullscreen_block = Some(event.id);
+                                widget.set_format(block.error_fullscreen_format.clone());
+                            }
+                            block.notify_intervals(&self.widget_updates_sender);
+                            self.render_block(event.id)?;
+                            self.render();
                         }
-                        block.notify_intervals(&self.widget_updates_sender);
-                        self.render_block(event.id)?;
-                        self.render();
                     }
                 }
             }