Child processes (#115)

* wip

* build fixes

* bump deps

* cleanup

* fix Native helper

* fix

* fix stdin

* Strip websockets integration

* Remove superfluous routes file

* Build without websockets

* Remove native module for now

* code style

* bump deps

* Don't close stdin

* updates

- allow for persistent (self-restarting) processes
- improve data stored in state (keep settings and pid in there too)
- add get, all, and restart

* code style

* Pass pid back in spawn event

Author: simonhamp

resources/js/electron-plugin/dist/index.js

@@ -11,7 +11,7 @@ import { app } from "electron";
 import { autoUpdater } from "electron-updater";
 import state from "./server/state";
 import { electronApp, optimizer } from "@electron-toolkit/utils";
-import { retrieveNativePHPConfig, retrievePhpIniSettings, runScheduler, startAPI, startPhpApp, startQueue, startWebsockets, } from "./server";
+import { retrieveNativePHPConfig, retrievePhpIniSettings, runScheduler, startAPI, startPhpApp, startQueue, } from "./server";
 import { notifyLaravel } from "./server/utils";
 import { resolve } from "path";
 import ps from "ps-node";
@@ -74,7 +74,6 @@ class NativePHP {
             state.phpIni = yield this.loadPhpIni();
             yield this.startPhpApp();
             yield this.startQueueWorker();
-            yield this.startWebsockets();
             this.startScheduler();
             yield notifyLaravel("booted");
         });
@@ -152,11 +151,6 @@ class NativePHP {
             this.processes.push(yield startQueue());
         });
     }
-    startWebsockets() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.processes.push(yield startWebsockets());
-        });
-    }
     startScheduler() {
         const now = new Date();
         const delay = (60 - now.getSeconds()) * 1000 + (1000 - now.getMilliseconds());

resources/js/electron-plugin/dist/preload/index.js

@@ -1,6 +1,16 @@
-import { ipcRenderer } from 'electron';
-import * as remote from '@electron/remote';
-import Native from './native';
+const { contextBridge, ipcRenderer } = require('electron');
+const remote = require('@electron/remote');
+const Native = {
+    on: (event, callback) => {
+        ipcRenderer.on('native-event', (_, data) => {
+            event = event.replace(/^(\\)+/, '');
+            data.event = data.event.replace(/^(\\)+/, '');
+            if (event === data.event) {
+                return callback(data.payload, event);
+            }
+        });
+    }
+};
 window.Native = Native;
 window.remote = remote;
 ipcRenderer.on('log', (event, { level, message, context }) => {

resources/js/electron-plugin/dist/server/api.js

@@ -30,6 +30,7 @@ import settingsRoutes from "./api/settings";
 import shellRoutes from "./api/shell";
 import progressBarRoutes from "./api/progressBar";
 import powerMonitorRoutes from "./api/powerMonitor";
+import childProcessRoutes from "./api/childProcess";
 function startAPIServer(randomSecret) {
     return __awaiter(this, void 0, void 0, function* () {
         const port = yield getPort({
@@ -56,6 +57,7 @@ function startAPIServer(randomSecret) {
             httpServer.use("/api/menu-bar", menuBarRoutes);
             httpServer.use("/api/progress-bar", progressBarRoutes);
             httpServer.use("/api/power-monitor", powerMonitorRoutes);
+            httpServer.use("/api/child-process", childProcessRoutes);
             httpServer.use("/api/broadcast", broadcastingRoutes);
             if (process.env.NODE_ENV === "development") {
                 httpServer.use("/api/debug", debugRoutes);

resources/js/electron-plugin/dist/server/api/childProcess.js

@@ -0,0 +1,128 @@
+import express from 'express';
+import { utilityProcess } from 'electron';
+import state from '../state';
+import { notifyLaravel } from "../utils";
+import { join } from 'path';
+const router = express.Router();
+function startProcess(settings) {
+    const { alias, cmd, cwd, env, persistent } = settings;
+    if (getProcess(alias) !== undefined) {
+        return state.processes[alias];
+    }
+    const proc = utilityProcess.fork(join(__dirname, '../../electron-plugin/dist/server/childProcess.js'), cmd, {
+        cwd,
+        serviceName: alias,
+        stdio: 'pipe',
+        env: Object.assign(Object.assign({}, process.env), env)
+    });
+    proc.stdout.on('data', (data) => {
+        notifyLaravel('events', {
+            event: 'Native\\Laravel\\Events\\ChildProcess\\MessageReceived',
+            payload: {
+                alias,
+                data: data.toString(),
+            }
+        });
+    });
+    proc.stderr.on('data', (data) => {
+        console.error('Error received from process [' + alias + ']:', data.toString());
+        notifyLaravel('events', {
+            event: 'Native\\Laravel\\Events\\ChildProcess\\ErrorReceived',
+            payload: {
+                alias,
+                data: data.toString(),
+            }
+        });
+    });
+    proc.on('spawn', () => {
+        console.log('Process [' + alias + '] spawned!');
+        state.processes[alias] = {
+            pid: proc.pid,
+            proc,
+            settings
+        };
+        notifyLaravel('events', {
+            event: 'Native\\Laravel\\Events\\ChildProcess\\ProcessSpawned',
+            payload: [alias, proc.pid]
+        });
+    });
+    proc.on('exit', (code) => {
+        console.log(`Process [${alias}] exited with code [${code}].`);
+        notifyLaravel('events', {
+            event: 'Native\\Laravel\\Events\\ChildProcess\\ProcessExited',
+            payload: {
+                alias,
+                code,
+            }
+        });
+        delete state.processes[alias];
+        if (persistent) {
+            startProcess(settings);
+        }
+    });
+    return {
+        pid: null,
+        proc,
+        settings
+    };
+}
+function stopProcess(alias) {
+    const proc = getProcess(alias);
+    if (proc === undefined) {
+        return;
+    }
+    if (proc.kill()) {
+        delete state.processes[alias];
+    }
+}
+function getProcess(alias) {
+    var _a;
+    return (_a = state.processes[alias]) === null || _a === void 0 ? void 0 : _a.proc;
+}
+function getSettings(alias) {
+    var _a;
+    return (_a = state.processes[alias]) === null || _a === void 0 ? void 0 : _a.settings;
+}
+router.post('/start', (req, res) => {
+    const proc = startProcess(req.body);
+    res.json(proc);
+});
+router.post('/stop', (req, res) => {
+    const { alias } = req.body;
+    stopProcess(alias);
+    res.sendStatus(200);
+});
+router.post('/restart', (req, res) => {
+    const { alias } = req.body;
+    const settings = getSettings(alias);
+    stopProcess(alias);
+    if (settings === undefined) {
+        res.sendStatus(410);
+        return;
+    }
+    const proc = startProcess(settings);
+    res.json(proc);
+});
+router.get('/get/:alias', (req, res) => {
+    const { alias } = req.params;
+    const proc = state.processes[alias];
+    if (proc === undefined) {
+        res.sendStatus(410);
+        return;
+    }
+    res.json(proc);
+});
+router.get('/', (req, res) => {
+    res.json(state.processes);
+});
+router.post('/message', (req, res) => {
+    const { alias, message } = req.body;
+    const proc = getProcess(alias);
+    if (proc === undefined) {
+        res.sendStatus(200);
+        return;
+    }
+    proc.postMessage(message);
+    res.sendStatus(200);
+});
+export default router;

resources/js/electron-plugin/dist/server/api/screen.js

@@ -14,4 +14,8 @@ router.get('/primary-display', (req, res) => {
 router.get('/cursor-position', (req, res) => {
     res.json(screen.getCursorScreenPoint());
 });
+router.get('/active', (req, res) => {
+    const cursor = screen.getCursorScreenPoint();
+    res.json(screen.getDisplayNearestPoint(cursor));
+});
 export default router;

resources/js/electron-plugin/dist/server/api/window.js

@@ -76,7 +76,7 @@ router.post('/open', (req, res) => {
         state.windows[id].focus();
         return res.sendStatus(200);
     }
-    let preloadPath = join(__dirname, '../../preload/index.js');
+    let preloadPath = join(__dirname, '../../electron-plugin/dist/preload/index.js');
     let windowState = undefined;
     if (req.body.rememberState === true) {
         windowState = windowStateKeeper({

resources/js/electron-plugin/dist/server/childProcess.js

@@ -0,0 +1,14 @@
+const { spawn } = require('child_process');
+const proc = spawn(process.argv[2], process.argv.slice(3), {});
+process.parentPort.on('message', (message) => {
+    proc.stdin.write(message.data);
+});
+proc.stdout.on('data', (data) => {
+    console.log(data.toString());
+});
+proc.stderr.on('data', (data) => {
+    console.error(data.toString());
+});
+proc.on('close', (code) => {
+    process.exit(code);
+});

resources/js/electron-plugin/dist/server/index.js

@@ -7,7 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import startWebsockets from "./websockets";
 import startAPIServer from "./api";
 import { retrieveNativePHPConfig, retrievePhpIniSettings, serveApp, startQueueWorker, startScheduler, } from "./php";
 import { appendCookie } from "./utils";
@@ -34,4 +33,4 @@ export function runScheduler() {
 export function startAPI() {
     return startAPIServer(state.randomSecret);
 }
-export { startWebsockets, retrieveNativePHPConfig, retrievePhpIniSettings };
+export { retrieveNativePHPConfig, retrievePhpIniSettings };

resources/js/electron-plugin/dist/server/php.js

@@ -82,7 +82,7 @@ function getArgumentEnv() {
     return env;
 }
 function getAppPath() {
-    let appPath = join(__dirname, '../../resources/app/').replace('app.asar', 'app.asar.unpacked');
+    let appPath = join(__dirname, '../../../../../resources/app/').replace('app.asar', 'app.asar.unpacked');
     if (process.env.NODE_ENV === 'development' || argumentEnv.TESTING == 1) {
         appPath = process.env.APP_PATH || argumentEnv.APP_PATH;
     }

resources/js/electron-plugin/dist/server/state.js

@@ -32,6 +32,7 @@ export default {
     icon: null,
     store: settingsStore,
     randomSecret: generateRandomString(32),
+    processes: {},
     windows: {},
     findWindow(id) {
         return this.windows[id] || null;

resources/js/electron-plugin/src/index.ts

@@ -10,7 +10,6 @@ import {
   startAPI,
   startPhpApp,
   startQueue,
-  startWebsockets,
 } from "./server";
 import { notifyLaravel } from "./server/utils";
 import { resolve } from "path";
@@ -99,7 +98,6 @@ class NativePHP {
 
     await this.startPhpApp();
     await this.startQueueWorker();
-    await this.startWebsockets();
     this.startScheduler();
 
     await notifyLaravel("booted");
@@ -186,10 +184,6 @@ class NativePHP {
     this.processes.push(await startQueue());
   }
 
-  private async startWebsockets() {
-    this.processes.push(await startWebsockets());
-  }
-
   private startScheduler() {
     const now = new Date();
     const delay =

resources/js/electron-plugin/src/preload/index.ts

@@ -1,7 +1,18 @@
-import { contextBridge, ipcRenderer } from 'electron'
-import * as remote from '@electron/remote'
+const { contextBridge, ipcRenderer } = require('electron')
+const remote = require('@electron/remote')
+const Native = {
+    on: (event, callback) => {
+        ipcRenderer.on('native-event', (_, data) => {
+            // Strip leading slashes
+            event = event.replace(/^(\\)+/, '');
+            data.event = data.event.replace(/^(\\)+/, '');
 
-import Native from './native';
+            if (event === data.event) {
+                return callback(data.payload, event);
+            }
+        })
+    }
+};
 
 // @ts-ignore
 window.Native = Native;

resources/js/electron-plugin/src/preload/native.ts

@@ -22,6 +22,7 @@ import settingsRoutes from "./api/settings";
 import shellRoutes from "./api/shell";
 import progressBarRoutes from "./api/progressBar";
 import powerMonitorRoutes from "./api/powerMonitor";
+import childProcessRoutes from "./api/childProcess";
 import { Server } from "net";
 
 export interface APIProcess {
@@ -55,6 +56,7 @@ async function startAPIServer(randomSecret: string): Promise<APIProcess> {
     httpServer.use("/api/menu-bar", menuBarRoutes);
     httpServer.use("/api/progress-bar", progressBarRoutes);
     httpServer.use("/api/power-monitor", powerMonitorRoutes);
+    httpServer.use("/api/child-process", childProcessRoutes);
     httpServer.use("/api/broadcast", broadcastingRoutes);
 
     if (process.env.NODE_ENV === "development") {