fix: some variants of launching production builds can result in infinite loops and bad spawn paths

Our logic for finding the "app path" was incomplete.

Author: starpit

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

@@ -27,10 +27,10 @@ import respawnCommand from "./respawn"
  *
  * see bin/codeflare; we are mostly copying bits from there
  */
-export default function guide(args: Arguments) {
+export default async function guide(args: Arguments) {
   setTabReadonly(args)
 
-  const { argv, env } = respawnCommand(
+  const { argv, env } = await respawnCommand(
     args.command.replace(/--type=renderer/, "").replace(/^codeflare\s+gui\s+guide/, "codeflare")
   )
 

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

@@ -17,6 +17,27 @@
 import { join } from "path"
 import { encodeComponent } from "@kui-shell/core"
 
+async function getAppPath() {
+  try {
+    const { app } = await import("electron")
+    if (app) {
+      const appPath = app.getAppPath()
+      if (appPath) {
+        return appPath
+      }
+    }
+  } catch (err) {
+    console.error("Error fetching app path", err)
+  }
+
+  const appPath = process.argv.find((_) => /app-path/.test(_))
+  if (appPath) {
+    return appPath.replace(/^--app-path=/, "")
+  } else {
+    return "."
+  }
+}
+
 /**
  * In electron production builds, if the user launches by double
  * clicking, or via spotlight (macos), then the CODEFLARE_HEADLESS and
@@ -33,44 +54,34 @@ import { encodeComponent } from "@kui-shell/core"
  * @return the absolute path to the directory that includes the
  * headless bundle.js.
  */
-function electronProductionBuildHeadlessRoot() {
-  const appPath = process.argv.find((_) => /app-path/.test(_))
-  if (appPath) {
-    return join(appPath.replace(/^--app-path=/, ""), "dist/headless")
-  } else {
-    return "."
-  }
+async function electronProductionBuildHeadlessRoot() {
+  return join(await getAppPath(), "dist/headless")
 }
 
 /**
  * @return same as with `electronProductionBuildHeadlessRoot()`, except
  * returning the guidebook store absolute path
  */
-function electronProductionBuildGuidebookStore() {
-  const appPath = process.argv.find((_) => /app-path/.test(_))
-  if (appPath) {
-    return join(appPath.replace(/^--app-path=/, ""), "store")
-  } else {
-    return ""
-  }
+async function electronProductionBuildGuidebookStore() {
+  return join(await getAppPath(), "store")
 }
 
 /** @return the absolute path to the directory that contains the headless bundle.js */
-function headlessRoot() {
-  return process.env.CODEFLARE_HEADLESS || electronProductionBuildHeadlessRoot()
+async function headlessRoot() {
+  return process.env.CODEFLARE_HEADLESS || (await electronProductionBuildHeadlessRoot())
 }
 
 /** @return the absolute path to the directory that contains the guidebook store for this build */
-function guidebookStore() {
-  return process.env.GUIDEBOOK_STORE || electronProductionBuildGuidebookStore()
+async function guidebookStore() {
+  return process.env.GUIDEBOOK_STORE || (await electronProductionBuildGuidebookStore())
 }
 
 /** Fill in the given command line to spawn ourselves as a subprocess */
-export default function respawnCommand(cmdline: string | string[]) {
+export default async function respawnCommand(cmdline: string | string[]) {
   return {
     argv: [
       encodeComponent(process.argv[0]),
-      encodeComponent(headlessRoot() + "/codeflare.min.js"),
+      encodeComponent((await headlessRoot()) + "/codeflare.min.js"),
       "--",
       ...(typeof cmdline === "string" ? [cmdline] : cmdline),
     ],
@@ -79,7 +90,7 @@ export default function respawnCommand(cmdline: string | string[]) {
       KUI_HEADLESS: "true",
       KUI_HEADLESS_WEBPACK: "true",
       ELECTRON_RUN_AS_NODE: "true",
-      GUIDEBOOK_STORE: guidebookStore(),
+      GUIDEBOOK_STORE: await guidebookStore(),
       DEBUG: process.env.DEBUG || "",
       HOME: process.env.HOME || "",
       PATH: process.env.PATH || "",

plugins/plugin-codeflare/src/controller/terminal.tsx

@@ -32,9 +32,9 @@ import "allotment/dist/style.css"
 /**
  * This is a command handler that opens up a plain terminal that shows a login session using the user's $SHELL.
  */
-export function shell(args: Arguments) {
+export async function shell(args: Arguments) {
   // respawn, meaning launch it with codeflare
-  const { argv, env } = respawn(["$SHELL", "-l"])
+  const { argv, env } = await respawn(["$SHELL", "-l"])
   const cmdline = argv.map((_) => encodeComponent(_)).join(" ")
 
   return {
@@ -43,7 +43,7 @@ export function shell(args: Arguments) {
 }
 
 type Props = Pick<BaseProps, "tab" | "repl">
-type State = Pick<BaseProps, "cmdline" | "env"> & { error?: boolean; selectedProfile?: string }
+type State = Partial<Pick<BaseProps, "cmdline" | "env">> & { error?: boolean; selectedProfile?: string }
 class TaskTerminal extends React.PureComponent<Props, State> {
   /** Allotment initial split sizes */
   private readonly sizes = [35, 65]
@@ -53,13 +53,25 @@ class TaskTerminal extends React.PureComponent<Props, State> {
   public constructor(props: Props) {
     super(props)
 
-    // respawn, meaning launch it with codeflare
-    const { argv, env } = respawn(this.tasks[0].argv)
-    const cmdline = argv.map((_) => encodeComponent(_)).join(" ")
+    this.init()
+    this.state = {}
+  }
 
-    this.state = {
-      cmdline,
-      env,
+  private async init() {
+    try {
+      // respawn, meaning launch it with codeflare
+      const { argv, env } = await respawn(this.tasks[0].argv)
+      const cmdline = argv.map((_) => encodeComponent(_)).join(" ")
+
+      this.setState({
+        cmdline,
+        env,
+      })
+    } catch (error) {
+      console.error("Error initializing command line", error)
+      this.state = {
+        error: true,
+      }
     }
   }
 
@@ -75,7 +87,10 @@ class TaskTerminal extends React.PureComponent<Props, State> {
   public render() {
     if (this.state.error) {
       return "Internal Error"
+    } else if (!this.state.cmdline || !this.state.env) {
+      return <Loading />
     }
+
     return (
       <Allotment defaultSizes={this.sizes} snap>
         <Allotment.Pane className="flex-fill flex-layout flex-align-stretch" minSize={400}>

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

@@ -24,7 +24,7 @@ import respawnCommand from "../../../controller/respawn"
 export default class ProfileStatusWatcher {
   private headReadiness = "pending"
   private workerReadiness = "pending"
-  private readonly _job: ReturnType<typeof spawn>
+  // private readonly _job: ReturnType<typeof spawn>
 
   public constructor(
     /** The profile to watch */
@@ -33,7 +33,7 @@ export default class ProfileStatusWatcher {
     /** How to update the Tray menu with changes*/
     private readonly updateFunction: UpdateFunction
   ) {
-    this._job = this.initJob(profile)
+    /* this._job = */ this.initJob(profile)
   }
 
   public get head() {
@@ -52,8 +52,8 @@ export default class ProfileStatusWatcher {
     return this.initJob(profile)
   }
 
-  private initJob(profile: string) {
-    const { argv, env } = respawnCommand([
+  private async initJob(profile: string) {
+    const { argv, env } = await respawnCommand([
       "guide",
       "-q",
       "-y",