feat: change codeflare attach to codeflare dashboard --attach/-a

Also add `codeflare db` as a synonym for `codeflare dashboard`.
Also adds `codeflare -q` to start a run in quiet mode -- no logs tee'd to the console.

Author: starpit

bin/codeflare

@@ -111,7 +111,7 @@ fi
 # indicated by the -u option)
 do_cli=1
 use_docker=0
-while getopts "dnVus:" opt
+while getopts "qadnVus:" opt
 do
     case $opt in
         d) use_docker=1; continue;;

package-lock.json

@@ -16,18 +16,38 @@
 
 import { dir } from "tmp"
 import { cli } from "madwizard/dist/fe/cli"
+import { MadWizardOptions } from "madwizard"
 import { Arguments, KResponse } from "@kui-shell/core"
 
 export default async function attach(args: Arguments) {
   return new Promise<KResponse>((resolve, reject) => {
-    dir(async (err, logdir) => {
+    dir({ prefix: "logdir-stage" }, async (err, logdir) => {
       if (err) {
         reject(err)
       }
 
-      process.env.LOGDIR_STAGE = logdir
-      await cli(["codeflare", "guide", "ml/ray/aggregator"], undefined, { store: process.env.GUIDEBOOK_STORE })
-      resolve(args.REPL.qexec(`codeflare dashboard ${logdir}`))
+      try {
+        const options: MadWizardOptions = { store: process.env.GUIDEBOOK_STORE, clean: false }
+
+        // TODO: update madwizard to accept env in the options
+        process.env.LOGDIR_STAGE = logdir // stage log files here
+        process.env.NO_WAIT = "true" // don't wait for job termination
+        process.env.QUIET_CONSOLE = "true" // don't tee logs to the console
+
+        /* const cleanup = */ await cli(["codeflare", "guide", "ml/ray/aggregator"], undefined, options)
+        /* if (typeof cleanup === 'function') {
+          onQuit(cleanup)
+        } */
+
+        await args.REPL.qexec(`codeflare dashboardui -f ${logdir}`)
+
+        // TODO: when job completes, auto-exit
+
+        resolve(true)
+      } catch (err) {
+        console.error(err)
+        reject(err)
+      }
     })
   })
 }

plugins/plugin-codeflare/src/controller/attach.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Arguments, CommandOptions, Registrar } from "@kui-shell/core"
+import { Arguments, CommandOptions, Registrar, encodeComponent, unparse } from "@kui-shell/core"
 
 import "../../web/scss/components/Dashboard/_index.scss"
 
@@ -23,22 +23,31 @@ export interface FollowOptions {
   follow: boolean
 }
 
+type DashboardOptions = FollowOptions & {
+  a: boolean
+  attach: boolean
+}
+
 export const followFlags: CommandOptions["flags"] = {
-  boolean: ["f", "follow"],
-  alias: { follow: ["f"] },
+  boolean: ["f", "follow", "a", "attach"],
+  alias: { follow: ["f"], attach: ["a"] },
 }
 
-function dashboardcli(args: Arguments) {
+function dashboardcli(args: Arguments<DashboardOptions>) {
+  if (args.parsedOptions.attach) {
+    // attach to a running job
+    return import("./attach").then((_) => _.default(args))
+  }
+
   const filepath = args.argvNoOptions[1]
   if (!filepath) {
     throw new Error("Usage: codeflare dashboard <filepath>")
   }
 
-  const restIdx = args.command.indexOf("dashboard") + "dashboard".length
-  return args.REPL.qexec(`codeflare dashboardui ${args.command.slice(restIdx)}`)
+  return args.REPL.qexec(`codeflare dashboardui ${encodeComponent(filepath)} ${unparse(args.parsedOptions)}`)
 }
 
-async function dashboardui(args: Arguments<FollowOptions>) {
+async function dashboardui(args: Arguments<DashboardOptions>) {
   const { setTabReadonly } = await import("@kui-shell/plugin-madwizard")
   setTabReadonly(args)
 
@@ -52,8 +61,10 @@ async function dashboardui(args: Arguments<FollowOptions>) {
 export default function registerDashboardCommands(registrar: Registrar) {
   const flags = followFlags
 
-  registrar.listen("/dashboard", dashboardcli, { flags, outputOnly: true })
+  ;["dashboard", "db"].forEach((db) => registrar.listen(`/${db}`, dashboardcli, { flags, outputOnly: true }))
+
   registrar.listen("/codeflare/dashboardui", dashboardui, {
+    hidden: true,
     needsUI: true,
     outputOnly: true,
     flags,

plugins/plugin-codeflare/src/controller/dashboard.ts

@@ -26,15 +26,13 @@ import description from "./description"
 function help() {
   return `Usage:
 codeflare [run] [<task>] [-s /path/to/store] [-u]
-codeflare attach
 codeflare dashboard /path/to/logdir
 codeflare chart gpu /path/to/logdir`
 }
 
 /** Register Kui Commands */
 export default function registerCodeflareCommands(registrar: Registrar) {
   tailf(registrar)
-  registrar.listen("/attach", (args) => import("./attach").then((_) => _.default(args)))
   browse(registrar)
   charts(registrar)
   events(registrar)

plugins/plugin-codeflare/src/controller/index.ts

@@ -23,6 +23,6 @@
     "access": "public"
   },
   "dependencies": {
-    "madwizard": "^0.11.0"
+    "madwizard": "^0.12.0"
   }
 }

plugins/plugin-madwizard/package.json

@@ -25,6 +25,10 @@ interface Options extends ParsedOptions {
 
   /** do not load prior choices (the default "profile") */
   n: boolean
+
+  /** Do not tee logs to the console */
+  q: boolean
+  quiet: boolean
 }
 
 // TODO export this from madwizard
@@ -43,6 +47,12 @@ function withFilepath(
     if (!parsedOptions.u) {
       // CLI path
       const { cli } = await import("madwizard/dist/fe/cli/index.js")
+
+      if (parsedOptions.q) {
+        // TODO add this to madwizard?
+        process.env.QUIET_CONSOLE = "true"
+      }
+
       await cli(
         ["madwizard", task, ...argvNoOptions.slice(1), ...(parsedOptions.n ? ["--no-profile"] : [])],
         undefined,
@@ -65,7 +75,8 @@ function withFilepath(
 /** Register Kui Commands */
 export default function registerMadwizardCommands(registrar: Registrar) {
   const flags = {
-    boolean: ["u", "V", "n"],
+    boolean: ["u", "V", "n", "q"],
+    alias: { quiet: ["q"] },
   }
 
   registrar.listen(