chore: code cleanup to avoid too much magic in the bin/codeflare shell script

Push this complexity to a kui catchall command registration. We want `codeflare ml/codeflare` to open in guide mode. We do this, in this PR, by using a Kui catchall, catching all unknown command lines that start with `codeflare ...`. With this in place, we can remove some of the junk in the bin/codeflare shell script.

This PR also fixes a number of bugs with handling of spaces in filepaths. Why add this to this PR? Because we need to update bin/codeflare to use "$@" to fix spaces... This requires us to add `codeflare ` as a prefix, which leads to the catchall ...

Author: starpit

bin/codeflare

@@ -116,38 +116,24 @@ do
     case $opt in
         d) use_docker=1; continue;;
         u) do_cli=0; continue;;
-        s) GUIDEBOOK_STORE=$OPTARG; continue;;
-        *) EXTRAPREFIX="$EXTRAPREFIX -$opt"; continue;;
+        s) export GUIDEBOOK_STORE=$OPTARG; continue;;
+        *) continue;;
     esac
 done
-shift $((OPTIND-1))
+# shift $((OPTIND-1))
 
 if [ $use_docker = 1 ]; then
     # launch inside a docker container
     exec docker run -it --entrypoint ${ENTRYPOINT-codeflare} --rm -v /tmp:/tmp -v ~/.aws:/home/codeflare/.aws -v ~/.bluemix:/home/codeflare/.bluemix -v ~/.kube:/home/codeflare/.kube -e KUBECONFIG=$(echo $KUBECONFIG | sed "s/$USER/codeflare/g" | sed 's/Users/home/g') ghcr.io/project-codeflare/codeflare-cli -- $*
 fi
 
-if  ([ $do_cli = 1 ] && [ $# = 0 ]) || ([ $# = 1 ] && [ "$1" != "version" ] && [ "$1" != "attach" ]); then
-    # TODO make this a kui command catchall
-    # use the "guide" command if none was given
-    EXTRAPREFIX="$EXTRAPREFIX guide"
-fi
-
 if [ "$do_cli" = "1" ]; then
     # launch headless version; here, we use madwizard directly, but
     # using electron as the nodejs binary (this is what
     # ELECTRON_RUN_AS_NODE does for us)
     export KUI_HEADLESS=true
     export KUI_S3=false # we don't need plugin-s3 capabilities when in headless mode
     export ELECTRON_RUN_AS_NODE=true
-#    export MWSTORE="$GUIDEBOOK_STORE"
-#    exec "$NODE" \
-#         --experimental-specifier-resolution=node --no-warnings --experimental-import-meta-resolve \
-#         "$HEADLESS"/../../node_modules/madwizard/bin/madwizard.js \
-#         $*
-elif [ $# -gt 0 ]; then
-    # tell the command handlers to run in UI mode
-    EXTRAPREFIX="$EXTRAPREFIX -u"
 fi
 
 # Linux may not have the prereqs needed to run Electron
@@ -176,4 +162,4 @@ fi
 trap 'pkill -P $$; exit 1;' TERM INT
 
 # otherwise, we launch the UI version
-"$NODE" "$HEADLESS"/codeflare.min.js -- $EXTRAPREFIX $*
+"$NODE" "$HEADLESS"/codeflare.min.js -- codeflare $EXTRAPREFIX "$@"

package.json

@@ -39,7 +39,7 @@
     "postinstall": "npm run compile",
     "format": "prettier --write '**/*.{scss,css,html,js,json,md,ts,tsx}'",
     "lint": "eslint . --ext '**/*.{js,ts,tsx}'",
-    "open": "./bin/codeflare -u",
+    "open": "./bin/codeflare hello",
     "start": "WATCH_ARGS='-open' npm run watch",
     "mirror": "cross-env rm -rf tmp && cross-env git clone --depth=1 https://github.com/guidebooks/store.git $PWD/tmp/store && cross-env madwizard mirror $PWD/tmp/store/guidebooks $PWD/store && rm -rf tmp",
     "mirror-if-needed": "if [ ! -d ./store ]; then npm run mirror; fi",

plugins/plugin-client-default/notebooks/dashboard-summary.md

@@ -5,5 +5,5 @@
     execute: now
     outputOnly: true
     ---
-    description $LOGDIR/job.json
+    codeflare description $LOGDIR/job.json
     ```

plugins/plugin-client-default/notebooks/dashboard.md

@@ -24,7 +24,7 @@ layout:
     execute: now
     outputOnly: true
     ---
-    description application "$LOGDIR"
+    codeflare description application "$LOGDIR"
     ```
 
 === "Workers"
@@ -34,7 +34,7 @@ layout:
     execute: now
     outputOnly: true
     ---
-    description workers "$LOGDIR"
+    codeflare description workers "$LOGDIR"
     ```
 
 ---
@@ -87,7 +87,7 @@ layout:
     maximize: true
     outputOnly: true
     ---
-    chart all "${LOGDIR}"
+    codeflare chart all "${LOGDIR}"
     ```
 
 ---
@@ -98,5 +98,5 @@ layout:
     execute: now
     outputOnly: true
     ---
-    chart events "${LOGDIR}"
+    codeflare chart events "${LOGDIR}"
     ```

plugins/plugin-client-default/src/index.tsx

@@ -59,11 +59,7 @@ export default function renderMain(props: KuiProps) {
       initialTabTitle="Welcome"
       isPopup={false}
       quietExecCommand={false}
-      commandLine={
-        process.env.RUNNING_KUI_TEST
-          ? undefined
-          : props.commandLine || ["commentary", "--readonly", "-f", "/kui/client/welcome.md"]
-      }
+      commandLine={process.env.RUNNING_KUI_TEST ? undefined : props.commandLine || ["codeflare", "hello"]}
     >
       <ContextWidgets>
         <GitHubIcon />

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

@@ -0,0 +1,19 @@
+/*
+ * 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 { doMadwizard } from "@kui-shell/plugin-madwizard"
+
+export default doMadwizard(true, "guide", true)

plugins/plugin-codeflare/src/controller/charts/all.tsx

@@ -86,7 +86,7 @@ async function offline(filepath: string, REPL: Arguments["REPL"]): Promise<React
  *
  */
 export default async function all(args: Arguments) {
-  const filepath = args.argvNoOptions[2]
+  const filepath = args.argvNoOptions[3]
   if (!filepath) {
     throw new Error(`Usage chart all ${filepath}`)
   }

plugins/plugin-codeflare/src/controller/charts/gpu.tsx

@@ -82,7 +82,7 @@ function chart(logs: Awaited<ReturnType<typeof parse>>): ReactResponse {
 }
 
 export default async function chartCmd(args: Arguments) {
-  const filepath = args.argvNoOptions[2]
+  const filepath = args.argvNoOptions[3]
   if (!filepath) {
     throw new Error(`Usage chart vmstat ${filepath}`)
   }

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

@@ -18,7 +18,9 @@ import { Registrar } from "@kui-shell/core"
 
 /** Register Kui Commands */
 export default function registerCodeflareCommands(registrar: Registrar) {
-  registrar.listen("/chart/gpu", (args) => import("./gpu").then((_) => _.default(args)), { needsUI: true })
-  registrar.listen("/chart/vmstat", (args) => import("./vmstat").then((_) => _.default(args)), { needsUI: true })
-  registrar.listen("/chart/all", (args) => import("./all").then((_) => _.default(args)), { needsUI: true })
+  registrar.listen("/codeflare/chart/gpu", (args) => import("./gpu").then((_) => _.default(args)), { needsUI: true })
+  registrar.listen("/codeflare/chart/vmstat", (args) => import("./vmstat").then((_) => _.default(args)), {
+    needsUI: true,
+  })
+  registrar.listen("/codeflare/chart/all", (args) => import("./all").then((_) => _.default(args)), { needsUI: true })
 }

plugins/plugin-codeflare/src/controller/charts/vmstat.tsx

@@ -81,7 +81,7 @@ function chart(logs: Awaited<ReturnType<typeof parse>>): ReactResponse {
 }
 
 export default async function chartCmd(args: Arguments) {
-  const filepath = args.argvNoOptions[2]
+  const filepath = args.argvNoOptions[3]
   if (!filepath) {
     throw new Error(`Usage chart vmstat ${filepath}`)
   }