unity-cli@v1.0.13 (#14)

- add a timeout to unity-hub process that force kills it if its still alive after 5s when tasks are completed

Author: StephenHodgson

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@rage-against-the-pixel/unity-cli",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "A command line utility for the Unity Game Engine.",
   "author": "RageAgainstThePixel",
   "license": "MIT",

package.json

@@ -5,7 +5,6 @@ import {
     GetArgumentValueAsString,
     KillChildProcesses,
     ProcInfo,
-    ReadPidFile,
     TryKillProcess
 } from './utilities';
 import {

src/unity-editor.ts

@@ -105,11 +105,17 @@ export class UnityHub {
                 const tasksCompleteMessage = 'All Tasks Completed Successfully.';
                 const child = spawn(executable, execArgs, {
                     stdio: ['ignore', 'pipe', 'pipe'],
+                    detached: process.platform !== 'win32'
                 });
                 const sigintHandler = () => child.kill('SIGINT');
                 const sigtermHandler = () => child.kill('SIGTERM');
                 process.once('SIGINT', sigintHandler);
                 process.once('SIGTERM', sigtermHandler);
+                function removeListeners() {
+                    process.removeListener('SIGINT', sigintHandler);
+                    process.removeListener('SIGTERM', sigtermHandler);
+                }
+                let forceCloseTimeout: NodeJS.Timeout | undefined;
                 function processOutput(data: Buffer) {
                     try {
                         const chunk = data.toString();
@@ -138,8 +144,21 @@ export class UnityHub {
                             if (child?.pid) {
                                 Logger.instance.debug(`Unity Hub reported all tasks completed, terminating process...`);
                                 const childProcInfo = { pid: child.pid, name: child.spawnfile, ppid: process.pid };
-                                KillChildProcesses(childProcInfo);
-                                TryKillProcess(childProcInfo);
+                                KillChildProcesses(childProcInfo).then(async () => {
+                                    const killedPid = await TryKillProcess(childProcInfo, 'SIGTERM');
+
+                                    if (!killedPid) {
+                                        Logger.instance.error(`Failed to terminate Unity Hub process!`);
+                                    }
+
+                                    // In case the process doesn't close itself, force kill after 5 seconds
+                                    forceCloseTimeout = setTimeout(() => {
+                                        Logger.instance.info(`Force closing Unity Hub process after timeout...`);
+                                        TryKillProcess(childProcInfo, 'SIGKILL');
+                                        removeListeners();
+                                        resolve(0);
+                                    }, 5000);
+                                });
                             }
                         }
                     } catch (error: any) {
@@ -151,13 +170,19 @@ export class UnityHub {
                 child.stdout.on('data', processOutput);
                 child.stderr.on('data', processOutput);
                 child.on('error', (error) => {
-                    process.removeListener('SIGINT', sigintHandler);
-                    process.removeListener('SIGTERM', sigtermHandler);
+                    if (forceCloseTimeout) {
+                        clearTimeout(forceCloseTimeout);
+                    }
+
+                    removeListeners();
                     reject(error);
                 });
                 child.on('close', (code) => {
-                    process.removeListener('SIGINT', sigintHandler);
-                    process.removeListener('SIGTERM', sigtermHandler);
+                    if (forceCloseTimeout) {
+                        clearTimeout(forceCloseTimeout);
+                    }
+
+                    removeListeners();
 
                     if (tasksComplete) {
                         resolve(0);

src/unity-hub.ts

@@ -233,15 +233,16 @@ export interface ProcInfo {
 /**
  * Attempts to kill a process with the given ProcInfo.
  * @param procInfo The process information containing the PID.
+ * @param signal The signal to use for killing the process. Defaults to 'SIGTERM'.
  * @returns The PID of the killed process, or undefined if no process was killed.
  */
-export async function TryKillProcess(procInfo: ProcInfo): Promise<number | undefined> {
+export async function TryKillProcess(procInfo: ProcInfo, signal: NodeJS.Signals = 'SIGTERM'): Promise<number | undefined> {
     let pid: number | undefined;
 
     try {
+        logger.ci(`Killing process "${procInfo.name}" with pid: ${procInfo.pid}`);
+        process.kill(procInfo.pid, signal);
         pid = procInfo.pid;
-        logger.ci(`Killing process "${procInfo.name}" with pid: ${pid}`);
-        process.kill(pid, 'SIGTERM');
     } catch (error) {
         const nodeJsException = error as NodeJS.ErrnoException;
         const errorCode = nodeJsException?.code;