fix(core): fix TrayIcon.getById returning new resource IDs (#13307)

* fix(core): fix TrayIcon.getById returning new resource IDs

this prevents the close() from working properly if you somehow lose the new() resource ID (for instance when the app reloads) and need to pick it up again and close it.

* cleanup on close

Author: lucasfernog

.changes/fix-tray-get-by-id.md

@@ -0,0 +1,5 @@
+---
+"tauri": patch:bug
+---
+
+Fix `TrayIcon.getById` returning a new resource ID instead of reusing a previously created id from `TrayIcon.new`.

crates/tauri/src/tray/mod.rs

@@ -598,6 +598,13 @@ impl<R: Runtime> TrayIcon<R> {
 
 impl<R: Runtime> Resource for TrayIcon<R> {
   fn close(self: std::sync::Arc<Self>) {
+    self
+      .app_handle
+      .state::<plugin::TrayIcons>()
+      .icons
+      .lock()
+      .unwrap()
+      .remove(&self.id.0);
     self.app_handle.remove_tray_by_id(&self.id);
   }
 }

crates/tauri/src/tray/plugin.rs

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-use std::path::PathBuf;
+use std::{collections::HashMap, path::PathBuf, sync::Mutex};
 
 use serde::Deserialize;
 
@@ -14,11 +14,15 @@ use crate::{
   plugin::{Builder, TauriPlugin},
   resources::ResourceId,
   tray::TrayIconBuilder,
-  AppHandle, Manager, Runtime, Webview,
+  AppHandle, Manager, Runtime, State, Webview,
 };
 
 use super::{TrayIcon, TrayIconEvent};
 
+pub(crate) struct TrayIcons {
+  pub(crate) icons: Mutex<HashMap<String, ResourceId>>,
+}
+
 #[derive(Deserialize)]
 #[serde(rename_all = "camelCase")]
 struct TrayIconOptions {
@@ -36,6 +40,7 @@ struct TrayIconOptions {
 #[command(root = "crate")]
 fn new<R: Runtime>(
   webview: Webview<R>,
+  icons: State<'_, TrayIcons>,
   options: TrayIconOptions,
   handler: Channel<TrayIconEvent>,
 ) -> crate::Result<(ResourceId, String)> {
@@ -91,20 +96,35 @@ fn new<R: Runtime>(
   let id = tray.id().as_ref().to_string();
   let rid = resources_table.add(tray);
 
+  icons.icons.lock().unwrap().insert(id.clone(), rid);
+
   Ok((rid, id))
 }
 
 #[command(root = "crate")]
 fn get_by_id<R: Runtime>(
   app: AppHandle<R>,
   webview: Webview<R>,
+  icons: State<'_, TrayIcons>,
   id: &str,
 ) -> crate::Result<Option<ResourceId>> {
+  // if the icon was created by this plugin, return the resource id
+  // this lets a getById call match the rid of a TrayIcon.new call
+  // which allows it to close a previously created icon
+  if let Some(rid) = icons.icons.lock().unwrap().get(id) {
+    return Ok(Some(*rid));
+  }
+
   let tray = app.tray_by_id(id);
   let maybe_rid = tray.map(|tray| {
     let mut resources_table = webview.resources_table();
     resources_table.add(tray)
   });
+
+  if let Some(rid) = maybe_rid {
+    icons.icons.lock().unwrap().insert(id.to_string(), rid);
+  }
+
   Ok(maybe_rid)
 }
 
@@ -226,6 +246,12 @@ fn set_show_menu_on_left_click<R: Runtime>(
 
 pub(crate) fn init<R: Runtime>() -> TauriPlugin<R> {
   Builder::new("tray")
+    .setup(|app, _api| {
+      app.manage(TrayIcons {
+        icons: Default::default(),
+      });
+      Ok(())
+    })
     .invoke_handler(crate::generate_handler![
       #![plugin(tray)]
       new,