Add notification icon logging

Author: raksooo

gui/src/main/index.ts

@@ -1036,7 +1036,8 @@ class ApplicationMain
       return shell.openExternal(url);
     }
   };
-  public showNotificationIcon = (value: boolean) => this.userInterface?.showNotificationIcon(value);
+  public showNotificationIcon = (value: boolean, reason?: string) =>
+    this.userInterface?.showNotificationIcon(value, reason);
 
   // NotificationSender
   public notify = (notification: SystemNotification) => {

gui/src/main/notification-controller.ts

@@ -34,7 +34,14 @@ export interface NotificationSender {
 export interface NotificationControllerDelegate {
   openApp(): void;
   openLink(url: string, withAuth?: boolean): Promise<void>;
-  showNotificationIcon(value: boolean): void;
+  /**
+   * We have experienced issues where the
+   * notification dot wasn't removed and logging the reason for it to be showing we can narrow the
+   * causes down.
+   *
+   * @param reason Used for debug purposes, it is currently all relevant notification messages..
+   */
+  showNotificationIcon(value: boolean, reason?: string): void;
 }
 
 enum NotificationSuppressReason {
@@ -278,21 +285,19 @@ export default class NotificationController {
   }
 
   private updateNotificationIcon() {
-    for (const notification of this.activeNotifications) {
-      if (notification.specification.severity >= SystemNotificationSeverityType.medium) {
-        this.notificationControllerDelegate.showNotificationIcon(true);
-        return;
-      }
-    }
+    const activeNotifications = [...this.activeNotifications].map(
+      (notification) => notification.specification,
+    );
+    const notifications = [...activeNotifications, ...this.dismissedNotifications].filter(
+      (notification) => notification.severity >= SystemNotificationSeverityType.medium,
+    );
 
-    for (const notification of this.dismissedNotifications) {
-      if (notification.severity >= SystemNotificationSeverityType.medium) {
-        this.notificationControllerDelegate.showNotificationIcon(true);
-        return;
-      }
+    if (notifications.length > 0) {
+      const reason = notifications.map((notification) => `"${notification.message}"`).join(',');
+      this.notificationControllerDelegate.showNotificationIcon(true, reason);
+    } else {
+      this.notificationControllerDelegate.showNotificationIcon(false);
     }
-
-    this.notificationControllerDelegate.showNotificationIcon(false);
   }
 
   private evaluateNotification(

gui/src/main/tray-icon-controller.ts

@@ -19,6 +19,8 @@ export default class TrayIconController {
 
   private updateThrottlePromise?: Promise<void>;
 
+  private previousNotificationIconReason?: string;
+
   constructor(
     private tray: Tray,
     private iconTypeValue: TrayIconType,
@@ -57,7 +59,16 @@ export default class TrayIconController {
     void this.updateIconParameters({ monochromatic: monochromaticIcon });
   }
 
-  public showNotificationIcon(notificationIcon: boolean) {
+  public showNotificationIcon(notificationIcon: boolean, reason?: string) {
+    if (reason !== this.previousNotificationIconReason) {
+      this.previousNotificationIconReason = reason;
+      if (notificationIcon) {
+        log.info('Showing notification icon:', reason);
+      } else {
+        log.info('Hiding notification icon');
+      }
+    }
+
     void this.updateIconParameters({ notification: notificationIcon });
   }
 

gui/src/main/user-interface.ts

@@ -189,8 +189,8 @@ export default class UserInterface implements WindowControllerDelegate {
   public updateTrayTheme = () => this.trayIconController?.updateTheme() ?? Promise.resolve();
   public setMonochromaticIcon = (value: boolean) =>
     this.trayIconController?.setMonochromaticIcon(value);
-  public showNotificationIcon = (value: boolean) =>
-    this.trayIconController?.showNotificationIcon(value);
+  public showNotificationIcon = (value: boolean, reason?: string) =>
+    this.trayIconController?.showNotificationIcon(value, reason);
   public setWindowIcon = (icon: string) => this.windowController.window?.setIcon(icon);
 
   public updateTrayIcon(tunnelState: TunnelState, blockWhenDisconnected: boolean) {