fix: avoid tray menu "blinking" on linux

Author: starpit

plugins/plugin-codeflare/src/tray/main.ts

@@ -31,6 +31,9 @@ import icon2x from "@kui-shell/client/icons/png/codeflareTemplate@2x.png"
 let tray: null | InstanceType<typeof import("electron").Tray> = null
 
 class LiveMenu {
+  // serialized form, to avoid unnecessary repaints
+  private currentContextMenu = ""
+
   public constructor(
     private readonly tray: import("electron").Tray,
     private readonly createWindow: CreateWindowFunction,
@@ -47,8 +50,19 @@ class LiveMenu {
       clearTimeout(this.debounce)
     }
     this.debounce = setTimeout(async () => {
-      this.tray.setToolTip(productName)
-      this.tray.setContextMenu(await buildContextMenu(this.createWindow, this.render.bind(this)))
+      // avoid blinking on linux by constantly repainting: only update
+      // the tray if the model has changed
+      const newContextMenu = await buildContextMenu(this.createWindow, this.render.bind(this))
+      const newContextMenuSerialized = JSON.stringify(
+        newContextMenu,
+        (key, value) => (key === "menu" || key === "commandsMap" || key === "commandId" ? undefined : value),
+        2
+      )
+      if (this.currentContextMenu !== newContextMenuSerialized) {
+        this.currentContextMenu = newContextMenuSerialized
+        this.tray.setToolTip(productName)
+        this.tray.setContextMenu(newContextMenu)
+      }
     }, 200)
   }
 }

plugins/plugin-codeflare/src/tray/watchers/profile/status.ts

@@ -16,7 +16,6 @@
 
 import Debug from "debug"
 import { spawn } from "child_process"
-import { encodeComponent } from "@kui-shell/core"
 
 import UpdateFunction from "../../update"
 import respawnCommand from "../../../controller/respawn"
@@ -54,15 +53,15 @@ export default class ProfileStatusWatcher {
   }
 
   private initJob(profile: string) {
-    console.error("Watcher start", profile)
     const { argv, env } = respawnCommand([
       "guide",
       "-q",
       "-y",
       "--profile",
-      encodeComponent(profile),
+      profile,
       "ml/ray/cluster/kubernetes/is-ready",
     ])
+    Debug("codeflare")("Watcher start", profile, argv)
     const job = spawn(argv[0], argv.slice(1), { env, stdio: ["pipe", "pipe", "inherit"], detached: true })
 
     // make sure to kill that watcher subprocess when we exit
@@ -97,6 +96,7 @@ export default class ProfileStatusWatcher {
         .toString()
         .split(/\n/)
         .forEach((line: string) => {
+          Debug("codeflare")("profile status watcher line", line)
           const match = line.match(/^(head|workers)\s+(\S+)$/)
           if (!match) {
             // console.error('Bogus line emitted by ray cluster readiness probe', line)