unity-cli@v1.1.1 (#17)

- update unity-hub task complete impl to try to resolve macOS editor install hanging

Author: StephenHodgson

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@rage-against-the-pixel/unity-cli",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A command line utility for the Unity Game Engine.",
   "author": "RageAgainstThePixel",
   "license": "MIT",
@@ -57,7 +57,7 @@
     "yaml": "2.8.1"
   },
   "devDependencies": {
-    "@types/commander": "2.12.0",
+    "@types/commander": "2.12.5",
     "@types/jest": "30.0.0",
     "@types/node": "24.6.2",
     "@types/semver": "7.7.1",

package.json

@@ -132,8 +132,10 @@ export class UnityEditor {
      */
     public async Run(command: EditorCommand): Promise<void> {
         let isCancelled = false;
+        let exitCode: number = 1;
         let procInfo: ProcInfo | null = null;
         let logTail: LogTailResult | null = null;
+        let unityProcess: ChildProcessByStdio<null, null, null>;
 
         async function tryKillEditorProcesses(): Promise<void> {
             try {
@@ -151,8 +153,6 @@ export class UnityEditor {
             void tryKillEditorProcesses();
         }
 
-        let exitCode: number = 1;
-
         try {
             if (!command.args || command.args.length === 0) {
                 throw Error('No command arguments provided for Unity execution');
@@ -179,7 +179,6 @@ export class UnityEditor {
             const logPath: string = GetArgumentValueAsString('-logFile', command.args);
             const commandStr = `\x1b[34m${this.editorPath} ${command.args.join(' ')}\x1b[0m`;
             this.logger.startGroup(commandStr);
-            let unityProcess: ChildProcessByStdio<null, null, null>;
 
             if (process.platform === 'linux' && !command.args.includes('-nographics')) {
                 unityProcess = spawn(

src/unity-editor.ts

@@ -19,7 +19,6 @@ import {
     ExecOptions,
     ReadFileContents,
     GetTempDir,
-    KillProcess,
 } from './utilities';
 import {
     UnityReleasesClient,
@@ -100,27 +99,27 @@ export class UnityHub {
 
         try {
             exitCode = await new Promise<number>((resolve, reject) => {
-                let tasksComplete: boolean = false;
+                let isSettled: boolean = false; // Has the promise been settled (resolved or rejected)?
+                let isHubTaskComplete: boolean = false; // Has the Unity Hub tasks completed successfully?
+                let lineBuffer = ''; // Buffer for incomplete lines
                 const tasksCompleteMessage = 'All Tasks Completed Successfully.';
                 const child = spawn(executable, execArgs, {
-                    stdio: ['ignore', 'pipe', 'pipe'],
-                    detached: process.platform !== 'win32'
+                    stdio: ['ignore', 'pipe', 'pipe']
                 });
                 const sigintHandler = () => child.kill('SIGINT');
                 const sigtermHandler = () => child.kill('SIGTERM');
                 process.once('SIGINT', sigintHandler);
                 process.once('SIGTERM', sigtermHandler);
 
                 let hasCleanedUpListeners = false;
-                function removeListeners() {
+                function removeListeners(): void {
                     if (hasCleanedUpListeners) { return; }
                     hasCleanedUpListeners = true;
                     process.removeListener('SIGINT', sigintHandler);
                     process.removeListener('SIGTERM', sigtermHandler);
                 }
 
-                let lineBuffer = ''; // Buffer for incomplete lines
-                function processOutput(data: Buffer) {
+                function processOutput(data: Buffer): void {
                     try {
                         const chunk = data.toString();
                         const fullChunk = lineBuffer + chunk;
@@ -137,10 +136,26 @@ export class UnityHub {
                         const outputLines = lines.filter(line => !ignoredLines.some(ignored => line.includes(ignored)));
 
                         if (outputLines.includes(tasksCompleteMessage)) {
-                            tasksComplete = true;
+                            isHubTaskComplete = true;
 
                             if (child?.pid) {
-                                void KillProcess({ pid: child.pid, name: child.spawnfile, ppid: process.pid });
+                                try {
+                                    child.kill('SIGTERM');
+
+                                    setTimeout(() => {
+                                        try {
+                                            if (child?.pid && !child.killed) {
+                                                child.kill('SIGKILL');
+                                            }
+                                        } catch {
+                                            // Ignore, process may have already exited
+                                        }
+                                    }, 1000);
+                                } catch {
+                                    // Ignore, process may have already exited
+                                } finally {
+                                    settle(0);
+                                }
                             }
                         }
 
@@ -157,41 +172,57 @@ export class UnityHub {
                         }
                     }
                 }
-                child.stdout.on('data', processOutput);
-                child.stderr.on('data', processOutput);
-                child.on('error', (error) => {
-                    removeListeners();
-                    reject(error);
-                });
-                child.on('close', (code) => {
-                    removeListeners();
 
-                    // Flush any remaining buffered content
-                    if (lineBuffer.length > 0) {
-                        const lines = lineBuffer.split('\n') // split by newline
-                            .map(line => line.replace(/\r$/, '')) // remove trailing carriage return
-                            .filter(line => line.length > 0); // filter out empty lines
-                        const outputLines = lines.filter(line => !ignoredLines.some(ignored => line.includes(ignored)));
+                function flushOutput(): void {
+                    try {
+                        if (lineBuffer.length > 0) {
+                            const lines = lineBuffer.split('\n') // split by newline
+                                .map(line => line.replace(/\r$/, '')) // remove trailing carriage return
+                                .filter(line => line.length > 0); // filter out empty lines
+                            lineBuffer = '';
+                            const outputLines = lines.filter(line => !ignoredLines.some(ignored => line.includes(ignored)));
 
-                        if (outputLines.includes(tasksCompleteMessage)) {
-                            tasksComplete = true;
-                        }
+                            if (outputLines.includes(tasksCompleteMessage)) {
+                                isHubTaskComplete = true;
+                            }
 
-                        for (const line of outputLines) {
-                            output += `${line}\n`;
+                            for (const line of outputLines) {
+                                output += `${line}\n`;
 
-                            if (!options.silent) {
-                                process.stdout.write(`${line}\n`);
+                                if (!options.silent) {
+                                    process.stdout.write(`${line}\n`);
+                                }
                             }
                         }
+                    } catch (error: any) {
+                        if (error.code !== 'EPIPE') {
+                            Logger.instance.error(`Failed to process buffered output: ${error}`);
+                        }
                     }
+                }
 
-                    if (tasksComplete) {
+                function settle(code: number | null): void {
+                    if (isSettled) { return; }
+                    isSettled = true;
+                    removeListeners();
+                    flushOutput();
+
+                    if (isHubTaskComplete) {
                         resolve(0);
                     } else {
                         resolve(code === null ? 0 : code);
                     }
+                }
+
+                child.stdout.on('data', processOutput);
+                child.stderr.on('data', processOutput);
+                child.on('error', (error) => {
+                    isSettled = true;
+                    removeListeners();
+                    flushOutput();
+                    reject(error);
                 });
+                child.on('close', settle);
             });
         } finally {
             this.logger.endGroup();