fix: update codeflare attach to use logdir created by the guidebook

Also updates the related dashboard commands to improve handling of filepaths with spaces.

Author: starpit

package-lock.json

@@ -14,40 +14,28 @@
  * limitations under the License.
  */
 
-import { dir } from "tmp"
 import { cli } from "madwizard/dist/fe/cli"
 import { MadWizardOptions } from "madwizard"
-import { Arguments, KResponse } from "@kui-shell/core"
+import { Arguments, encodeComponent } from "@kui-shell/core"
 
 export default async function attach(args: Arguments) {
-  return new Promise<KResponse>((resolve, reject) => {
-    dir({ prefix: "logdir-stage" }, async (err, logdir) => {
-      if (err) {
-        reject(err)
-      }
+  const options: MadWizardOptions = { store: process.env.GUIDEBOOK_STORE, clean: false }
 
-      try {
-        const options: MadWizardOptions = { store: process.env.GUIDEBOOK_STORE, clean: false }
+  // TODO: update madwizard to accept env in the options
+  process.env.NO_WAIT = "true" // don't wait for job termination
+  process.env.QUIET_CONSOLE = "true" // don't tee logs to the console
 
-        // 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 resp = await cli(["codeflare", "guide", "ml/ray/aggregator"], undefined, options)
 
-        /* const cleanup = */ await cli(["codeflare", "guide", "ml/ray/aggregator"], undefined, options)
-        /* if (typeof cleanup === 'function') {
-          onQuit(cleanup)
-        } */
+  const logdir = resp && resp.env ? resp.env.LOGDIR_STAGE : undefined
 
-        await args.REPL.qexec(`codeflare dashboardui -f ${logdir}`)
+  if (logdir) {
+    process.env.LOGDIR = logdir
+    await args.REPL.qexec(`codeflare dashboardui -f ${encodeComponent(logdir)}`)
+  } else {
+    throw new Error("Could not attach, due to missing logging directory")
+  }
 
-        // TODO: when job completes, auto-exit
-
-        resolve(true)
-      } catch (err) {
-        console.error(err)
-        reject(err)
-      }
-    })
-  })
+  // TODO: when job completes, auto-exit
+  return true
 }

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

@@ -15,7 +15,7 @@
  */
 
 import { join } from "path"
-import { Arguments, Registrar } from "@kui-shell/core"
+import { Arguments, Registrar, encodeComponent } from "@kui-shell/core"
 import { expand } from "../lib/util"
 
 type Item = { label: string; value: string }
@@ -45,7 +45,7 @@ export type SummaryResponse = {
 
 /** Given the location of the staging directory, return the location of the ray job definition */
 function jobDefinition(filepath: string) {
-  return expand(join(filepath.replace(/'/g, ""), "ray-job-definition.json"))
+  return encodeComponent(expand(join(filepath.replace(/'/g, ""), "ray-job-definition.json")))
 }
 
 async function app(args: Arguments) {

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

@@ -23,6 +23,6 @@
     "access": "public"
   },
   "dependencies": {
-    "madwizard": "^0.15.0"
+    "madwizard": "^0.15.3"
   }
 }