feat: update tray menu to watch for new, deleted, and renamed profiles

Author: starpit

package-lock.json

@@ -86,10 +86,10 @@
     "printWidth": 120
   },
   "devDependencies": {
-    "@kui-shell/builder": "11.5.0-dev-20220722-172700",
-    "@kui-shell/proxy": "11.5.0-dev-20220722-172700",
-    "@kui-shell/react": "11.5.0-dev-20220722-172700",
-    "@kui-shell/webpack": "11.5.0-dev-20220722-172700",
+    "@kui-shell/builder": "11.5.0-dev-20220725-153832",
+    "@kui-shell/proxy": "11.5.0-dev-20220725-153832",
+    "@kui-shell/react": "11.5.0-dev-20220725-153832",
+    "@kui-shell/webpack": "11.5.0-dev-20220725-153832",
     "@playwright/test": "^1.23.2",
     "@types/debug": "^4.1.7",
     "@types/node": "14.11.8",
@@ -113,16 +113,16 @@
   },
   "dependencies": {
     "@kui-shell/client": "file:./plugins/plugin-client-default",
-    "@kui-shell/core": "11.5.0-dev-20220722-172700",
-    "@kui-shell/plugin-bash-like": "11.5.0-dev-20220722-172700",
-    "@kui-shell/plugin-client-common": "11.5.0-dev-20220722-172700",
+    "@kui-shell/core": "11.5.0-dev-20220725-153832",
+    "@kui-shell/plugin-bash-like": "11.5.0-dev-20220725-153832",
+    "@kui-shell/plugin-client-common": "11.5.0-dev-20220725-153832",
     "@kui-shell/plugin-codeflare": "file:./plugins/plugin-codeflare",
-    "@kui-shell/plugin-core-support": "11.5.0-dev-20220722-172700",
-    "@kui-shell/plugin-electron-components": "11.5.0-dev-20220722-172700",
-    "@kui-shell/plugin-kubectl": "11.5.0-dev-20220722-172700",
+    "@kui-shell/plugin-core-support": "11.5.0-dev-20220725-153832",
+    "@kui-shell/plugin-electron-components": "11.5.0-dev-20220725-153832",
+    "@kui-shell/plugin-kubectl": "11.5.0-dev-20220725-153832",
     "@kui-shell/plugin-madwizard": "file:./plugins/plugin-madwizard",
-    "@kui-shell/plugin-patternfly4-themes": "11.5.0-dev-20220722-172700",
-    "@kui-shell/plugin-proxy-support": "11.5.0-dev-20220722-172700",
-    "@kui-shell/plugin-s3": "11.5.0-dev-20220722-172700"
+    "@kui-shell/plugin-patternfly4-themes": "11.5.0-dev-20220725-153832",
+    "@kui-shell/plugin-proxy-support": "11.5.0-dev-20220725-153832",
+    "@kui-shell/plugin-s3": "11.5.0-dev-20220725-153832"
   }
 }

package.json

@@ -26,6 +26,7 @@
     "@logdna/tail-file": "^3.0.0",
     "@patternfly/react-charts": "^6.77.1",
     "@patternfly/react-core": "^4.224.1",
+    "chokidar": "^3.5.3",
     "open": "^8.4.0",
     "pretty-bytes": "^6.0.0",
     "pretty-ms": "8.0.0",

plugins/plugin-codeflare/package.json

@@ -25,12 +25,13 @@ import dashboards from "./dashboards"
 import section from "../section"
 import UpdateFunction from "../../update"
 import { profileIcon } from "../../icons"
+import ProfileWatcher from "../../watchers/profile/list"
 
 /** @return a menu for the given `profile` */
 async function profileMenu(
-  profileObj: Profiles.Profile,
   createWindow: CreateWindowFunction,
-  updateFunction: UpdateFunction
+  updateFunction: UpdateFunction,
+  profileObj: Profiles.Profile
 ): Promise<MenuItemConstructorOptions> {
   const profile = profileObj.name
 
@@ -45,17 +46,26 @@ async function profileMenu(
   }
 }
 
+/** Memo of `ProfileWatcher`, which will watch for new/removed/renamed profiles */
+let watcher: null | ProfileWatcher = null
+
 /** @return a menu for all profiles */
 export default async function profilesMenu(
   createWindow: CreateWindowFunction,
   updateFn: UpdateFunction
 ): Promise<MenuItemConstructorOptions[]> {
+  if (!watcher) {
+    watcher = new ProfileWatcher(updateFn, await Profiles.profilesPath({}, true))
+  }
+
+  await watcher.init()
+
   // this will be a list of menu items, one per profile, and sorted by
   // profile name
   const profiles = await Promise.all(
-    (await Profiles.list({}))
-      .sort((a, b) => a.profile.name.localeCompare(b.profile.name))
-      .map((_) => profileMenu(_.profile, createWindow, updateFn))
+    watcher.profiles // current list of profiles
+      .sort((a, b) => a.name.localeCompare(b.name))
+      .map(profileMenu.bind(undefined, createWindow, updateFn))
   )
 
   return section("Profiles", profiles, false)

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

@@ -0,0 +1,100 @@
+/*
+ * Copyright 2022 The Kubernetes Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import chokidar from "chokidar"
+import { basename } from "path"
+import { Profiles } from "madwizard"
+
+import UpdateFunction from "../../update"
+
+/** Watch for new, removed, and renamed profiles */
+export default class ProfileWatcher {
+  private _profiles: Profiles.Profile[] = []
+
+  private _initDone = false
+
+  public constructor(
+    private readonly updateFn: UpdateFunction,
+    private readonly profilesPath: string,
+    private readonly watcher = chokidar.watch(profilesPath)
+  ) {}
+
+  /** Initialize `this._profiles` model */
+  public async init(): Promise<ProfileWatcher> {
+    if (!this._initDone) {
+      await this.readOnce()
+      this.initWatcher()
+      this._initDone = true
+    }
+
+    return this
+  }
+
+  /** Options we will pass to the madwizard API */
+  private get madwizardOptions() {
+    return { profilesPath: this.profilesPath }
+  }
+
+  /** Initialize the filesystem watcher to notify us of new or removed profiles */
+  private initWatcher() {
+    this.watcher.on("add", async (path) => {
+      try {
+        const profile = basename(path)
+        if (Profiles.isTemporary(profile)) {
+          // skip any write-file-atomic temps
+          return
+        }
+
+        const idx = this.profiles.findIndex((_) => _.name === profile)
+        if (idx < 0) {
+          this._profiles.push(await Profiles.restore(this.madwizardOptions, basename(path)).then((_) => _.profile))
+          this.updateFn()
+        }
+      } catch (err) {
+        console.error("Error loading new profile", path, err)
+      }
+    })
+
+    this.watcher.on("unlink", (path) => {
+      const profile = basename(path)
+      if (Profiles.isTemporary(profile)) {
+        // skip any write-file-atomic temps
+        return
+      }
+
+      const idx = this.profiles.findIndex((_) => _.name === profile)
+      if (idx >= 0) {
+        this._profiles.splice(idx, 1)
+        this.updateFn()
+      }
+    })
+  }
+
+  /** @return the current profiles model */
+  public get profiles() {
+    return this._profiles
+  }
+
+  /** Update the profiles model */
+  private set profiles(profiles: Profiles.Profile[]) {
+    this._profiles = profiles
+  }
+
+  /** Read the full list of profiles */
+  private async readOnce() {
+    this.profiles = (await Profiles.list(this.madwizardOptions)).map((_) => _.profile)
+  }
+}

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

@@ -30,7 +30,7 @@ export default class ProfileRunWatcher {
   public constructor(private readonly profile: string) {}
 
   /** Initialize `this._runs` model */
-  public async init() {
+  public async init(): Promise<ProfileRunWatcher> {
     await this.readRunsDir()
     return this
   }

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

@@ -23,6 +23,6 @@
     "access": "public"
   },
   "dependencies": {
-    "madwizard": "^0.15.10"
+    "madwizard": "^0.15.11"
   }
 }