feat: update tray menu to watch for new/deleted/renamed runs

Author: starpit

plugins/plugin-codeflare/src/tray/menus/profiles/dashboards/codeflare.ts

@@ -22,6 +22,7 @@ import { CreateWindowFunction } from "@kui-shell/core"
 import runs from "../runs"
 import section from "../../section"
 import windowOptions from "../../../window"
+import UpdateFunction from "../../../update"
 
 /** @return a new Window with a dashboard of the selected job run */
 function openRunInCodeflareDashboard(createWindow: CreateWindowFunction, profile: string, runId: string) {
@@ -36,7 +37,8 @@ function openRunInCodeflareDashboard(createWindow: CreateWindowFunction, profile
 
 export default async function codeflareDashboards(
   profile: string,
-  createWindow: CreateWindowFunction
+  createWindow: CreateWindowFunction,
+  updateFn: UpdateFunction
 ): Promise<MenuItemConstructorOptions[]> {
   return [
     {
@@ -46,6 +48,6 @@ export default async function codeflareDashboards(
           title: "Codeflare Run Summary - " + profile,
         }),
     },
-    ...section("Recent Runs", await runs(profile, openRunInCodeflareDashboard.bind(undefined, createWindow))),
+    ...section("Recent Runs", await runs(profile, openRunInCodeflareDashboard.bind(undefined, createWindow), updateFn)),
   ]
 }

plugins/plugin-codeflare/src/tray/menus/profiles/dashboards/index.ts

@@ -18,17 +18,19 @@ import { MenuItemConstructorOptions } from "electron"
 import { CreateWindowFunction } from "@kui-shell/core"
 
 import codeflare from "./codeflare"
+import UpdateFunction from "../../../update"
 
 /** @return menu items that open dashboards for the given `profile` */
 export default async function dashboards(
   profile: string,
-  createWindow: CreateWindowFunction
+  createWindow: CreateWindowFunction,
+  updateFn: UpdateFunction
 ): Promise<MenuItemConstructorOptions[]> {
   const mlflow = { name: "MLFlow", portEnv: "MLFLOW_PORT" }
   const tensorboard = { name: "Tensorboard", portEnv: "TENSORBOARD_PORT" }
 
   return [
-    { label: "CodeFlare", submenu: await codeflare(profile, createWindow) },
+    { label: "CodeFlare", submenu: await codeflare(profile, createWindow, updateFn) },
     { label: "MLFlow", click: () => import("./open").then((_) => _.default(mlflow, profile, createWindow)) },
     { label: "Tensorboard", click: () => import("./open").then((_) => _.default(tensorboard, profile, createWindow)) },
   ]

plugins/plugin-codeflare/src/tray/menus/profiles/index.ts

@@ -30,7 +30,7 @@ import ProfileWatcher from "../../watchers/profile/list"
 /** @return a menu for the given `profile` */
 async function profileMenu(
   createWindow: CreateWindowFunction,
-  updateFunction: UpdateFunction,
+  updateFn: UpdateFunction,
   profileObj: Profiles.Profile
 ): Promise<MenuItemConstructorOptions> {
   const profile = profileObj.name
@@ -39,8 +39,8 @@ async function profileMenu(
     label: profile,
     icon: profileIcon,
     submenu: [
-      ...section("Status", status(profile, updateFunction)),
-      ...section("Dashboards", await dashboards(profile, createWindow)),
+      ...section("Status", status(profile, updateFn)),
+      ...section("Dashboards", await dashboards(profile, createWindow, updateFn)),
       ...section("Tasks", tasks(profile, createWindow)),
     ],
   }
@@ -58,6 +58,9 @@ export default async function profilesMenu(
     watcher = new ProfileWatcher(updateFn, await Profiles.profilesPath({}, true))
   }
 
+  // one-time initialization of the watcher, if needed; we need to do
+  // this after having assigned to our `watcher` variable, to avoid an
+  // infinite loop
   await watcher.init()
 
   // this will be a list of menu items, one per profile, and sorted by

plugins/plugin-codeflare/src/tray/menus/profiles/runs.ts

@@ -16,6 +16,7 @@
 
 import { MenuItemConstructorOptions } from "electron"
 
+import UpdateFunction from "../../update"
 import ProfileRunWatcher, { RUNS_ERROR } from "../../watchers/profile/run"
 
 /** Handler for "opening" the selected `runId` in the given `profile` */
@@ -34,11 +35,22 @@ export function runMenuItems(profile: string, open: RunOpener, runs: string[]):
 const watchers: Record<string, ProfileRunWatcher> = {}
 
 /** @return menu items for the runs of the given profile */
-export default async function submenuForRuns(profile: string, open: RunOpener): Promise<MenuItemConstructorOptions[]> {
+export default async function submenuForRuns(
+  profile: string,
+  open: RunOpener,
+  updateFn: UpdateFunction
+): Promise<MenuItemConstructorOptions[]> {
   if (!watchers[profile]) {
-    watchers[profile] = await new ProfileRunWatcher(profile).init()
+    watchers[profile] = await new ProfileRunWatcher(updateFn, profile)
   }
 
+  // one-time initialization of the watcher, if needed; we need to do
+  // this after having assigned to our `watcher` variable, to avoid an
+  // infinite loop
+  await watchers[profile].init()
+
   const { runs } = watchers[profile]
-  return runs.length && runs[0] !== RUNS_ERROR ? runMenuItems(profile, open, runs) : [{ label: RUNS_ERROR }]
+  return runs.length && runs[0] !== RUNS_ERROR
+    ? runMenuItems(profile, open, runs)
+    : [{ label: RUNS_ERROR, enabled: false }]
 }

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

@@ -22,8 +22,10 @@ import UpdateFunction from "../../update"
 
 /** Watch for new, removed, and renamed profiles */
 export default class ProfileWatcher {
+  /** Our model */
   private _profiles: Profiles.Profile[] = []
 
+  /** Have we already performed the on-time init? */
   private _initDone = false
 
   public constructor(

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

@@ -14,9 +14,14 @@
  * limitations under the License.
  */
 
+import chokidar from "chokidar"
+import { basename } from "path"
+
 import { readdir } from "fs/promises"
 import { Profiles } from "madwizard"
 
+import UpdateFunction from "../../update"
+
 export const RUNS_ERROR = "No runs found"
 
 /**
@@ -25,16 +30,53 @@ export const RUNS_ERROR = "No runs found"
  * TODO make this actually watch
  */
 export default class ProfileRunWatcher {
+  /** Our model */
   private _runs: string[] = []
 
-  public constructor(private readonly profile: string) {}
+  /** Have we already performed the on-time init? */
+  private _initDone = false
+
+  public constructor(
+    private readonly updateFn: UpdateFunction,
+    private readonly profile: string,
+    private readonly watcher = chokidar.watch(ProfileRunWatcher.path(profile))
+  ) {}
+
+  private static path(profile: string) {
+    return Profiles.guidebookJobDataPath({ profile })
+  }
 
   /** Initialize `this._runs` model */
   public async init(): Promise<ProfileRunWatcher> {
-    await this.readRunsDir()
+    if (!this._initDone) {
+      await this.readOnce()
+      this.initWatcher()
+      this._initDone = true
+    }
     return this
   }
 
+  /** Initialize the filesystem watcher to notify us of new or removed profiles */
+  private initWatcher() {
+    this.watcher.on("add", async (path) => {
+      const runId = basename(path)
+      const idx = this.runs.findIndex((_) => _ === runId)
+      if (idx < 0) {
+        this._runs.push(runId)
+        this.updateFn()
+      }
+    })
+
+    this.watcher.on("unlink", (path) => {
+      const runId = basename(path)
+      const idx = this.runs.findIndex((_) => _ === runId)
+      if (idx >= 0) {
+        this._runs.push(runId)
+        this.updateFn()
+      }
+    })
+  }
+
   /** @return the current runs model */
   public get runs() {
     return this._runs
@@ -46,12 +88,12 @@ export default class ProfileRunWatcher {
   }
 
   /** @return files of the directory of job runs for a given profile */
-  private async readRunsDir() {
+  private async readOnce() {
     try {
       // TODO do a "full" read with Dirents, so that we have filesystem
       // timestamps, and sort, so that the `.slice(0, 10)` below pulls
       // out the most recent runs
-      this.runs = await readdir(Profiles.guidebookJobDataPath({ profile: this.profile }))
+      this.runs = await readdir(ProfileRunWatcher.path(this.profile))
     } catch (err) {
       this.runs = [RUNS_ERROR]
     }