fix(packages/core): second windows should not be stuck with env vars from initial window

Electron finally has support, via the `additionalData` protocol, for us to fix this.

Author: starpit

packages/core/src/main/main.ts

@@ -42,7 +42,9 @@ export const main = async (argv: string[], env = process.env, execOptions?: Exec
     // then spawn the electron graphics
     debug('shortcut to graphics', argv)
     const { getCommand, initElectron } = await import(/* webpackChunkName: "electron-main" */ './spawn-electron')
-    const { argv: strippedArgv, subwindowPlease, subwindowPrefs } = getCommand(argv, async () => import('electron'))
+    const { argv: strippedArgv, subwindowPlease, subwindowPrefs } = getCommand(argv, process.cwd(), env, async () =>
+      import('electron')
+    )
     initElectron(
       strippedArgv,
       { isRunningHeadless },

packages/core/src/main/spawn-electron.ts

@@ -53,7 +53,7 @@ interface App extends EventEmitter {
   hide(): void
   quit(): void
   exit(exitCode?: number): void
-  requestSingleInstanceLock(): boolean
+  requestSingleInstanceLock(additionalData?: Record<any, any>): boolean
 }
 
 /**
@@ -500,7 +500,12 @@ interface Command {
   subwindowPlease: boolean
   subwindowPrefs: ISubwindowPrefs
 }
-export const getCommand = (argv: string[], screen: () => Promise<{ screen: Screen; BrowserWindow: BW }>): Command => {
+export const getCommand = (
+  argv: string[],
+  cwd: string,
+  env: Record<any, any>,
+  screen: () => Promise<{ screen: Screen; BrowserWindow: BW }>
+): Command => {
   debug('getCommand', argv)
   const dashDash = argv.lastIndexOf('--')
   argv = dashDash === -1 ? argv.slice(1) : argv.slice(dashDash + 1)
@@ -528,6 +533,8 @@ export const getCommand = (argv: string[], screen: () => Promise<{ screen: Scree
 
   let subwindowPlease = true
   let subwindowPrefs: ISubwindowPrefs = {
+    cwd,
+    env,
     fullscreen: true,
     width: windowDefaults.width,
     height: windowDefaults.height
@@ -537,13 +544,16 @@ export const getCommand = (argv: string[], screen: () => Promise<{ screen: Scree
     // use a full window for 'shell'
     argv = ['shell']
     subwindowPlease = false
-    subwindowPrefs = {}
+    subwindowPrefs = { cwd, env }
   } else if (process.env.KUI_POPUP) {
     argv = JSON.parse(process.env.KUI_POPUP)
+    subwindowPrefs = { cwd, env }
   }
 
   if (process.env.KUI_POPUP_WINDOW_RESIZE) {
     subwindowPrefs = {
+      cwd,
+      env,
       fullscreen: true,
       position: async () => getPositionForPopup(await screen()),
       width: popupWindowDefaults.width,
@@ -628,23 +638,31 @@ export async function initElectron(
     const widthFromCaller = subwindowPrefs && subwindowPrefs.width
     const heightFromCaller = subwindowPrefs && subwindowPrefs.height
 
-    app.on('second-instance', (event: Electron.Event, commandLine: string[]) => {
-      // Someone tried to run a second instance, open a new window
-      // to handle it
-
-      const { argv, subwindowPlease, subwindowPrefs } = getCommand(commandLine, async () => import('electron'))
+    app.on(
+      'second-instance',
+      (event: Electron.Event, commandLine: string[], cwd: string, additionalData: { env: string }) => {
+        // Someone tried to run a second instance, open a new window
+        // to handle it
+
+        const { argv, subwindowPlease, subwindowPrefs } = getCommand(
+          commandLine,
+          cwd,
+          JSON.parse(additionalData.env),
+          async () => import('electron')
+        )
+
+        if (widthFromCaller) {
+          subwindowPrefs.width = widthFromCaller
+        }
+        if (heightFromCaller) {
+          subwindowPrefs.height = heightFromCaller
+        }
 
-      if (widthFromCaller) {
-        subwindowPrefs.width = widthFromCaller
-      }
-      if (heightFromCaller) {
-        subwindowPrefs.height = heightFromCaller
+        debug('opening window for second instance', commandLine, subwindowPlease, subwindowPrefs)
+        createWindow(true, argv, subwindowPlease, subwindowPrefs)
       }
-
-      debug('opening window for second instance', commandLine, subwindowPlease, subwindowPrefs)
-      createWindow(true, argv, subwindowPlease, subwindowPrefs)
-    })
-    if (!app.requestSingleInstanceLock()) {
+    )
+    if (!app.requestSingleInstanceLock({ env: JSON.stringify(process.env) })) {
       // The primary instance of app failed to optain the lock, which means another instance of app is already running with the lock
       debug('exiting, since we are not the first instance')
       return app.exit(0)

packages/core/src/models/SubwindowPrefs.ts

@@ -15,6 +15,8 @@
  */
 
 interface SubwindowPrefs {
+  cwd?: string
+  env?: Record<any, any>
   fullscreen?: boolean
   useContentSize?: boolean
   synonymFor?: object

packages/core/src/webapp/bootstrap/init-electron.ts

@@ -19,6 +19,8 @@ import { BrowserWindow } from 'electron'
 
 interface KuiWindow extends BrowserWindow {
   subwindow?: {
+    cwd?: string
+    env?: Record<any, any>
     fullscreen?: boolean
     viewName?: string
     title?: string
@@ -58,6 +60,13 @@ export async function preinit() {
     const remote = await import('@electron/remote')
     const window = remote && (remote.getCurrentWindow() as KuiWindow)
     const subwindow = window.subwindow
+
+    // so that electron's "second window" protocol can pass through
+    // the environment variables from second+ windows
+    if (subwindow && subwindow.env) {
+      process.env = subwindow.env
+    }
+
     if (subwindow && subwindow.fullscreen === true) {
       const titleOverride = typeof subwindow === 'string' ? subwindow : subwindow.title
       if (titleOverride && typeof titleOverride === 'string') {