add a notification in the tray icon that an update is available

Author: unsecretised

Cargo.lock

@@ -18,6 +18,7 @@ icns = "0.3.1"
 image = "0.25.9"
 libc = "0.2.180"
 log = "0.4.29"
+minreq = { version = "2.14.1", features = ["https"] }
 objc2 = "0.6.3"
 objc2-app-kit = { version = "0.3.2", features = ["NSImage"] }
 objc2-application-services = { version = "0.3.2", default-features = false, features = [
@@ -30,6 +31,7 @@ once_cell = "1.21.3"
 rand = "0.9.2"
 rayon = "1.11.0"
 serde = { version = "1.0.228", features = ["derive"] }
+serde_json = "1.0.149"
 tokio = { version = "1.48.0", features = ["full"] }
 toml = "0.9.8"
 tracing-subscriber = { version = "0.3.22", features = ["env-filter"] }

Cargo.toml

@@ -49,6 +49,7 @@ pub enum Move {
 /// The message type that iced uses for actions that can do something
 #[derive(Debug, Clone)]
 pub enum Message {
+    UpdateAvailable,
     ResizeWindow(Id, f32),
     OpenWindow,
     SearchQueryChanged(String, Id),

src/app.rs

@@ -26,7 +26,7 @@ use tokio::runtime::Runtime;
 /// This create a new menubar icon for the app
 pub fn menu_icon(config: Config, sender: ExtSender) -> TrayIcon {
     let builder = TrayIconBuilder::new();
-    let menu = menu_builder(config, sender);
+    let menu = menu_builder(config, sender, false);
 
     let image = get_image();
     let icon = Icon::from_rgba(image.as_bytes().to_vec(), image.width(), image.height()).unwrap();
@@ -38,7 +38,7 @@ pub fn menu_icon(config: Config, sender: ExtSender) -> TrayIcon {
         .unwrap()
 }
 
-pub fn menu_builder(config: Config, sender: ExtSender) -> Menu {
+pub fn menu_builder(config: Config, sender: ExtSender, update_item: bool) -> Menu {
     let hotkey = config.toggle_hotkey.parse::<HotKey>().unwrap();
 
     let mut modes = config.modes;
@@ -49,6 +49,16 @@ pub fn menu_builder(config: Config, sender: ExtSender) -> Menu {
     init_event_handler(sender, hotkey.id());
 
     Menu::with_items(&[
+        &MenuItem::with_id(
+            "update",
+            if update_item {
+                "Update available"
+            } else {
+                "Up to date"
+            },
+            update_item,
+            None,
+        ),
         &version_item(),
         &about_item(get_image()),
         &open_github_item(),
@@ -104,6 +114,9 @@ fn init_event_handler(sender: ExtSender, hotkey_id: u32) {
                         .unwrap();
                 });
             }
+            "update" => {
+                open_url("https://github.com/unsecretised/rustcast/releases/latest");
+            }
             "open_discord" => {
                 open_url(DISCORD_LINK);
             }

src/app/menubar.rs

@@ -22,7 +22,7 @@ use iced::{
 };
 use iced::{event, window};
 
-use log::info;
+use log::{info, warn};
 use objc2::rc::Retained;
 use objc2_app_kit::NSRunningApplication;
 use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
@@ -31,6 +31,7 @@ use tray_icon::TrayIcon;
 use std::fmt::Debug;
 use std::fs;
 use std::ops::Bound;
+use std::str::FromStr;
 use std::time::Duration;
 use std::{collections::BTreeMap, path::Path};
 
@@ -109,6 +110,7 @@ pub struct Tile {
     pub focus_id: u32,
     pub query: String,
     pub current_mode: String,
+    pub update_available: bool,
     query_lc: String,
     results: Vec<App>,
     options: AppIndex,
@@ -171,6 +173,7 @@ impl Tile {
             Subscription::run(handle_hotkeys),
             keyboard,
             Subscription::run(handle_recipient),
+            Subscription::run(check_version),
             Subscription::run(handle_hot_reloading),
             Subscription::run(handle_clipboard_history),
             window::close_events().map(Message::HideWindow),
@@ -393,3 +396,51 @@ fn handle_recipient() -> impl futures::Stream<Item = Message> {
         }
     })
 }
+
+fn check_version() -> impl futures::Stream<Item = Message> {
+    stream::channel(100, async |mut output| {
+        let current_version = format!("\"{}\"", option_env!("APP_VERSION").unwrap_or(""));
+
+        if current_version.is_empty() {
+            println!("empty version");
+            return;
+        }
+
+        let req = minreq::Request::new(
+            minreq::Method::Get,
+            "https://api.github.com/repos/unsecretised/rustcast/releases/latest",
+        )
+        .with_header("User-Agent", "rustcast-update-checker")
+        .with_header("Accept", "application/vnd.github+json")
+        .with_header("X-GitHub-Api-Version", "2022-11-28");
+
+        loop {
+            let resp = req
+                .clone()
+                .send()
+                .and_then(|x| x.as_str().map(serde_json::Value::from_str));
+
+            info!("Made a req for latest version");
+
+            if let Ok(Ok(val)) = resp {
+                let new_ver = val
+                    .get("name")
+                    .map(|x| x.to_string())
+                    .unwrap_or("".to_string());
+
+                // new_ver is in the format "\"v0.0.0\""
+                // note that it is encapsulated in double quotes
+                if new_ver.trim() != current_version
+                    && !new_ver.is_empty()
+                    && new_ver.starts_with("\"v")
+                {
+                    info!("new version available: {new_ver}");
+                    output.send(Message::UpdateAvailable).await.ok();
+                }
+            } else {
+                warn!("Error getting resp");
+            }
+            tokio::time::sleep(Duration::from_secs(60)).await;
+        }
+    })
+}

src/app/tile.rs

@@ -62,6 +62,7 @@ pub fn new(hotkey: HotKey, config: &Config) -> (Tile, Task<Message>) {
 
     (
         Tile {
+            update_available: false,
             current_mode: "Default".to_string(),
             query: String::new(),
             query_lc: String::new(),

src/app/tile/elm.rs

@@ -45,6 +45,11 @@ pub fn handle_update(tile: &mut Tile, message: Message) -> Task<Message> {
             Task::none()
         }
 
+        Message::UpdateAvailable => {
+            tile.update_available = true;
+            Task::done(Message::ReloadConfig)
+        }
+
         Message::SwitchMode(mode) => {
             if let Some(command) = tile.config.modes.get(mode.trim()) {
                 tile.current_mode = mode.clone();
@@ -245,9 +250,15 @@ pub fn handle_update(tile: &mut Tile, message: Message) -> Task<Message> {
                 icon.set_menu(Some(Box::new(menu_builder(
                     new_config.clone(),
                     tile.sender.clone().unwrap(),
+                    tile.update_available,
                 ))));
             } else {
                 tile.tray_icon = Some(menu_icon(new_config.clone(), tile.sender.clone().unwrap()));
+                tile.tray_icon
+                    .as_mut()
+                    .unwrap()
+                    .set_visible(tile.config.show_trayicon)
+                    .ok();
             }
 
             let mut new_options = get_installed_apps(new_config.theme.show_icons);
@@ -542,7 +553,7 @@ pub fn handle_update(tile: &mut Tile, message: Message) -> Task<Message> {
                     .map(|conversion| conversion.to_app())
                     .collect();
                 return single_item_resize_task(id);
-            } else if let Some(res) = Expr::from_str(&tile.query).ok() {
+            } else if let Ok(res) = Expr::from_str(&tile.query) {
                 tile.results.push(App {
                     ranking: 0,
                     open_command: AppCommand::Function(Function::Calculate(res.clone())),