fix: terminal fails to launch for electron production builds

Author: starpit

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

@@ -14,14 +14,63 @@
  * limitations under the License.
  */
 
+import { join } from "path"
 import { encodeComponent } from "@kui-shell/core"
 
+/**
+ * In electron production builds, if the user launches by double
+ * clicking, or via spotlight (macos), then the CODEFLARE_HEADLESS and
+ * GUIDEBOOK_STORE env vars are not defined. However, we can still
+ * find these relative to the electron appPath. Note: here, we take a
+ * shortcut, and extract the appPath from the `argv`. The proper way
+ * to do this would be to invoke
+ * `import('electron').app.getAppPath()`. Doing so would require
+ * communicating with the electron main process, since this API is not
+ * available in the renderer processes. See src/tray/renderer.ts for
+ * how this is done; except that we would need to consume a return
+ * value from the main process.
+ *
+ * @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 "."
+  }
+}
+
+/**
+ * @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 ""
+  }
+}
+
+/** @return the absolute path to the directory that contains the headless bundle.js */
+function headlessRoot() {
+  return process.env.CODEFLARE_HEADLESS || electronProductionBuildHeadlessRoot()
+}
+
+/** @return the absolute path to the directory that contains the guidebook store for this build */
+function guidebookStore() {
+  return process.env.GUIDEBOOK_STORE || electronProductionBuildGuidebookStore()
+}
+
 /** Fill in the given command line to spawn ourselves as a subprocess */
 export default function respawnCommand(cmdline: string | string[]) {
   return {
     argv: [
       encodeComponent(process.argv[0]),
-      encodeComponent(process.env.CODEFLARE_HEADLESS + "/codeflare.min.js"),
+      encodeComponent(headlessRoot() + "/codeflare.min.js"),
       "--",
       ...(typeof cmdline === "string" ? [cmdline] : cmdline),
     ],
@@ -30,7 +79,7 @@ export default function respawnCommand(cmdline: string | string[]) {
       KUI_HEADLESS: "true",
       KUI_HEADLESS_WEBPACK: "true",
       ELECTRON_RUN_AS_NODE: "true",
-      GUIDEBOOK_STORE: process.env.GUIDEBOOK_STORE || "",
+      GUIDEBOOK_STORE: guidebookStore(),
       DEBUG: process.env.DEBUG || "",
       HOME: process.env.HOME || "",
       PATH: process.env.PATH || "",