refactor: reduce CPU usage with Event Loop Proxy events

This commit is contained in:
Timofey Gelazoniya 2024-09-14 22:08:52 +03:00
parent 65429b01f5
commit 2c0e62016b
Signed by: zeldon
GPG Key ID: 047886915281DD2A
2 changed files with 78 additions and 67 deletions

View File

@ -43,7 +43,7 @@ To build, you must have [Rust](https://www.rust-lang.org/) and
- [ ] Force update devices button in tray menu - [ ] Force update devices button in tray menu
- [ ] Colored tray icons for different battery levels - [ ] Colored tray icons for different battery levels
- [x] Show log window button in tray menu - [x] Show log window button in tray menu
- [ ] Further reduce CPU usage by using Event Loop Proxy events (more info [here](https://github.com/tauri-apps/tray-icon/issues/83#issuecomment-1697773065)) - [x] Further reduce CPU usage by using Event Loop Proxy events (more info [here](https://github.com/tauri-apps/tray-icon/issues/83#issuecomment-1697773065))
- [ ] Prebuilt Binary - [ ] Prebuilt Binary
- [ ] Command Line Arguments for update frequency - [ ] Command Line Arguments for update frequency
- [ ] Support for other Razer Devices (I only have DeathAdder V3 Pro, so I won't be able to test it with other devices) - [ ] Support for other Razer Devices (I only have DeathAdder V3 Pro, so I won't be able to test it with other devices)

View File

@ -1,21 +1,20 @@
use std::{ use std::{
collections::HashMap, collections::{HashMap, HashSet},
rc::Rc, sync::Arc,
sync::{mpsc, Arc},
thread, thread,
time::{Duration, Instant}, time::Duration,
}; };
use crate::{console::DebugConsole, manager::DeviceManager}; use crate::{console::DebugConsole, manager::DeviceManager};
use log::{error, info, trace}; use log::{error, info, trace};
use parking_lot::Mutex; use parking_lot::Mutex;
use tao::event_loop::EventLoopBuilder; use tao::event_loop::{EventLoopBuilder, EventLoopProxy};
use tray_icon::{ use tray_icon::{
menu::{Menu, MenuEvent, MenuItem}, menu::{IsMenuItem, Menu, MenuEvent, MenuItem},
TrayIcon, TrayIconBuilder, TrayIcon, TrayIconBuilder,
}; };
const BATTERY_UPDATE_INTERVAL: Duration = Duration::from_secs(60); const BATTERY_UPDATE_INTERVAL: Duration = Duration::from_secs(300); // 5 min
const DEVICE_FETCH_INTERVAL: Duration = Duration::from_secs(5); const DEVICE_FETCH_INTERVAL: Duration = Duration::from_secs(5);
#[derive(Debug)] #[derive(Debug)]
@ -41,7 +40,7 @@ impl MemoryDevice {
} }
pub struct TrayInner { pub struct TrayInner {
tray_icon: Rc<Mutex<Option<TrayIcon>>>, tray_icon: Arc<Mutex<Option<TrayIcon>>>,
menu_items: Arc<Mutex<Vec<MenuItem>>>, menu_items: Arc<Mutex<Vec<MenuItem>>>,
debug_console: Arc<DebugConsole>, debug_console: Arc<DebugConsole>,
} }
@ -49,7 +48,7 @@ pub struct TrayInner {
impl TrayInner { impl TrayInner {
fn new(debug_console: Arc<DebugConsole>) -> Self { fn new(debug_console: Arc<DebugConsole>) -> Self {
Self { Self {
tray_icon: Rc::new(Mutex::new(None)), tray_icon: Arc::new(Mutex::new(None)),
menu_items: Arc::new(Mutex::new(Vec::new())), menu_items: Arc::new(Mutex::new(Vec::new())),
debug_console, debug_console,
} }
@ -65,14 +64,19 @@ impl TrayInner {
menu_items.push(show_console_item); menu_items.push(show_console_item);
menu_items.push(quit_item); menu_items.push(quit_item);
let item_refs: Vec<&dyn IsMenuItem> = menu_items
.iter()
.map(|item| item as &dyn IsMenuItem)
.collect();
tray_menu tray_menu
.append_items(&[&menu_items[0], &menu_items[1]]) .append_items(&item_refs)
.unwrap(); .expect("Failed to append menu items");
tray_menu tray_menu
} }
fn build_tray( fn build_tray(
tray_icon: &Rc<Mutex<Option<TrayIcon>>>, tray_icon: &Arc<Mutex<Option<TrayIcon>>>,
tray_menu: &Menu, tray_menu: &Menu,
icon: tray_icon::Icon, icon: tray_icon::Icon,
) { ) {
@ -95,6 +99,12 @@ pub struct TrayApp {
tray_inner: TrayInner, tray_inner: TrayInner,
} }
#[derive(Debug)]
enum TrayEvent {
DeviceUpdate(Vec<u32>),
MenuEvent(MenuEvent),
}
impl TrayApp { impl TrayApp {
pub fn new(debug_console: DebugConsole) -> Self { pub fn new(debug_console: DebugConsole) -> Self {
Self { Self {
@ -106,15 +116,15 @@ impl TrayApp {
pub fn run(&self) { pub fn run(&self) {
let icon = Self::create_icon(); let icon = Self::create_icon();
let event_loop = EventLoopBuilder::new().build(); let event_loop = EventLoopBuilder::with_user_event().build();
let tray_menu = self.tray_inner.create_menu(); let tray_menu = self.tray_inner.create_menu();
let (sender, receiver) = mpsc::channel(); let proxy = event_loop.create_proxy();
self.spawn_device_fetch_thread(sender.clone()); self.spawn_device_fetch_thread(proxy.clone());
self.spawn_battery_check_thread(sender); self.spawn_battery_check_thread(proxy.clone());
self.run_event_loop(event_loop, icon, tray_menu, receiver); self.run_event_loop(event_loop, icon, tray_menu, proxy);
} }
fn create_icon() -> tray_icon::Icon { fn create_icon() -> tray_icon::Icon {
@ -128,17 +138,18 @@ impl TrayApp {
tray_icon::Icon::from_rgba(rgba, width, height).expect("Failed to create icon") tray_icon::Icon::from_rgba(rgba, width, height).expect("Failed to create icon")
} }
fn spawn_device_fetch_thread(&self, tx: mpsc::Sender<Vec<u32>>) { fn spawn_device_fetch_thread(&self, proxy: EventLoopProxy<TrayEvent>) {
let devices = Arc::clone(&self.devices); let devices = Arc::clone(&self.devices);
let device_manager = Arc::clone(&self.device_manager); let device_manager = Arc::clone(&self.device_manager);
thread::spawn(move || loop { thread::spawn(move || {
let mut last_devices = HashSet::new();
loop {
let (removed_devices, connected_devices) = { let (removed_devices, connected_devices) = {
let mut manager = device_manager.lock(); let mut manager = device_manager.lock();
manager.fetch_devices() manager.fetch_devices()
}; };
{
let mut devices = devices.lock(); let mut devices = devices.lock();
for id in removed_devices { for id in removed_devices {
if let Some(device) = devices.remove(&id) { if let Some(device) = devices.remove(&id) {
@ -147,75 +158,69 @@ impl TrayApp {
} }
for &id in &connected_devices { for &id in &connected_devices {
if let std::collections::hash_map::Entry::Vacant(e) = devices.entry(id) { if !devices.contains_key(&id) {
if let Some(name) = device_manager.lock().get_device_name(id) { if let Some(name) = device_manager.lock().get_device_name(id) {
e.insert(MemoryDevice::new(name.clone(), id)); devices.insert(id, MemoryDevice::new(name.clone(), id));
info!("New device: {}", name); info!("New device: {}", name);
} else { } else {
error!("Failed to get device name for id: {}", id); error!("Failed to get device name for id: {}", id);
} }
} }
} }
}
if !connected_devices.is_empty() { let current_devices: HashSet<_> = connected_devices.iter().cloned().collect();
tx.send(connected_devices).unwrap(); if current_devices != last_devices {
let _ = proxy.send_event(TrayEvent::DeviceUpdate(connected_devices));
last_devices = current_devices;
} }
thread::sleep(DEVICE_FETCH_INTERVAL); thread::sleep(DEVICE_FETCH_INTERVAL);
}
}); });
} }
fn spawn_battery_check_thread(&self, tx: mpsc::Sender<Vec<u32>>) { fn spawn_battery_check_thread(&self, proxy: EventLoopProxy<TrayEvent>) {
let devices = Arc::clone(&self.devices); let devices = Arc::clone(&self.devices);
thread::spawn(move || loop { thread::spawn(move || loop {
let device_ids: Vec<u32> = devices.lock().keys().cloned().collect(); let device_ids: Vec<u32> = devices.lock().keys().cloned().collect();
tx.send(device_ids).unwrap(); let _ = proxy.send_event(TrayEvent::DeviceUpdate(device_ids));
thread::sleep(BATTERY_UPDATE_INTERVAL); thread::sleep(BATTERY_UPDATE_INTERVAL);
}); });
} }
fn run_event_loop( fn run_event_loop(
&self, &self,
event_loop: tao::event_loop::EventLoop<()>, event_loop: tao::event_loop::EventLoop<TrayEvent>,
icon: tray_icon::Icon, icon: tray_icon::Icon,
tray_menu: Menu, tray_menu: Menu,
rx: mpsc::Receiver<Vec<u32>>, proxy: EventLoopProxy<TrayEvent>,
) { ) {
let devices = Arc::clone(&self.devices); let devices = Arc::clone(&self.devices);
let device_manager = Arc::clone(&self.device_manager); let device_manager = Arc::clone(&self.device_manager);
let tray_icon = Rc::clone(&self.tray_inner.tray_icon); let tray_icon = Arc::clone(&self.tray_inner.tray_icon);
let debug_console = Arc::clone(&self.tray_inner.debug_console); let debug_console = Arc::clone(&self.tray_inner.debug_console);
let menu_items = Arc::clone(&self.tray_inner.menu_items); let menu_items = Arc::clone(&self.tray_inner.menu_items);
let menu_channel = MenuEvent::receiver(); let menu_channel = MenuEvent::receiver();
event_loop.run(move |event, _, control_flow| { event_loop.run(move |event, _, control_flow| {
*control_flow = tao::event_loop::ControlFlow::WaitUntil( *control_flow = tao::event_loop::ControlFlow::Wait;
Instant::now() + Duration::from_millis(100),
);
if let Ok(device_ids) = rx.try_recv() { match event {
Self::update(&devices, &device_manager, &device_ids, &tray_icon); tao::event::Event::NewEvents(tao::event::StartCause::Init) => {
}
if let tao::event::Event::NewEvents(tao::event::StartCause::Init) = event {
// We create the icon once the event loop is actually running
// to prevent issues like https://github.com/tauri-apps/tray-icon/issues/90
TrayInner::build_tray(&tray_icon, &tray_menu, icon.clone()); TrayInner::build_tray(&tray_icon, &tray_menu, icon.clone());
} }
tao::event::Event::UserEvent(TrayEvent::DeviceUpdate(device_ids)) => {
if let Ok(event) = menu_channel.try_recv() { Self::update(&devices, &device_manager, &device_ids, &tray_icon);
}
tao::event::Event::UserEvent(TrayEvent::MenuEvent(event)) => {
let menu_items = menu_items.lock(); let menu_items = menu_items.lock();
let show_console_item = &menu_items[0]; if event.id == menu_items[0].id() {
let quit_item = &menu_items[1];
if event.id == show_console_item.id() {
debug_console.toggle_visibility(); debug_console.toggle_visibility();
let visible = debug_console.is_visible(); let visible = debug_console.is_visible();
show_console_item.set_text(if visible { menu_items[0].set_text(if visible {
"Hide Log Window" "Hide Log Window"
} else { } else {
"Show Log Window" "Show Log Window"
@ -223,10 +228,16 @@ impl TrayApp {
trace!("{} log window", if visible { "showing" } else { "hiding" }); trace!("{} log window", if visible { "showing" } else { "hiding" });
} }
if event.id == quit_item.id() { if event.id == menu_items[1].id() {
*control_flow = tao::event_loop::ControlFlow::Exit; *control_flow = tao::event_loop::ControlFlow::Exit;
} }
} }
_ => (),
}
if let Ok(event) = menu_channel.try_recv() {
let _ = proxy.send_event(TrayEvent::MenuEvent(event));
}
}); });
} }
@ -234,7 +245,7 @@ impl TrayApp {
devices: &Arc<Mutex<HashMap<u32, MemoryDevice>>>, devices: &Arc<Mutex<HashMap<u32, MemoryDevice>>>,
manager: &Arc<Mutex<DeviceManager>>, manager: &Arc<Mutex<DeviceManager>>,
device_ids: &[u32], device_ids: &[u32],
tray_icon: &Rc<Mutex<Option<TrayIcon>>>, tray_icon: &Arc<Mutex<Option<TrayIcon>>>,
) { ) {
let mut devices = devices.lock(); let mut devices = devices.lock();
let manager = manager.lock(); let manager = manager.lock();