unity-cli@v1.0.8 (#9)

- fix intermittent hanging from hub install commands

Author: StephenHodgson

.github/workflows/unity-build.yml

@@ -21,6 +21,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     permissions:
       contents: read
+    timeout-minutes: 25
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4

package-lock.json

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

package.json

@@ -65,15 +65,6 @@ export class UnityHub {
         let output: string = '';
         let exitCode: number = 0;
 
-        function processOutput(data: Buffer) {
-            const chunk = data.toString();
-            output += chunk;
-
-            if (!options.silent) {
-                process.stdout.write(chunk);
-            }
-        }
-
         const filteredArgs = args.filter(arg => arg !== '--headless' && arg !== '--');
         const executable = process.platform === 'linux' ? 'unity-hub' : this.executable;
         const execArgs = process.platform === 'linux' ? ['--headless', ...filteredArgs] : ['--', '--headless', ...filteredArgs];
@@ -86,16 +77,57 @@ export class UnityHub {
             fs.accessSync(this.executable, fs.constants.R_OK | fs.constants.X_OK);
         }
 
+        const ignoredLines = [
+            `This error originated either by throwing inside of an async function without a catch block`,
+            `Unexpected error attempting to determine if executable file exists`,
+            `dri3 extension not supported`,
+            `Failed to connect to the bus:`,
+            `Checking for beta autoupdate feature for deb/rpm distributions`,
+            `Found package-type: deb`,
+            `XPC error for connection com.apple.backupd.sandbox.xpc: Connection invalid`
+        ];
+
         try {
             exitCode = await new Promise<number>((resolve, reject) => {
+                const tasksComplete = 'All Tasks Completed Successfully.';
                 const child = spawn(executable, execArgs, {
                     stdio: ['ignore', 'pipe', 'pipe'],
                 });
-
                 const sigintHandler = () => child.kill('SIGINT');
                 const sigtermHandler = () => child.kill('SIGTERM');
                 process.once('SIGINT', sigintHandler);
                 process.once('SIGTERM', sigtermHandler);
+                function processOutput(data: Buffer) {
+                    try {
+                        const chunk = data.toString();
+                        let outputLines: string[] = [];
+                        const lines = chunk.split('\n');
+
+                        for (const line of lines) {
+                            if (line.trim().length === 0 ||
+                                ignoredLines.some(ignored => line.includes(ignored))) {
+                                continue;
+                            }
+
+                            outputLines.push(line);
+                        }
+
+                        const outputLine = outputLines.join('\n');
+                        output += `${outputLine}\n`;
+
+                        if (!options.silent) {
+                            process.stdout.write(`${outputLine}\n`);
+                        }
+
+                        if (output.includes(tasksComplete)) {
+                            child.kill('SIGTERM');
+                        }
+                    } catch (error: any) {
+                        if (error.code !== 'EPIPE') {
+                            throw error;
+                        }
+                    }
+                }
                 child.stdout.on('data', processOutput);
                 child.stderr.on('data', processOutput);
                 child.on('error', (error) => {
@@ -130,16 +162,6 @@ export class UnityHub {
                         throw new Error(`Failed to execute Unity Hub: [${exitCode}] ${errorMessage}`);
                 }
             }
-
-            const ignoredLines = [
-                `This error originated either by throwing inside of an async function without a catch block`,
-                `Unexpected error attempting to determine if executable file exists`,
-                `dri3 extension not supported`,
-                `Failed to connect to the bus:`,
-                `Checking for beta autoupdate feature for deb/rpm distributions`,
-                `Found package-type: deb`,
-                `XPC error for connection com.apple.backupd.sandbox.xpc: Connection invalid`
-            ];
             output = output.split('\n')
                 .filter(line => line.trim().length > 0)
                 .filter(line => !ignoredLines.some(ignored => line.includes(ignored)))

src/unity-hub.ts

@@ -69,11 +69,17 @@ export async function Exec(command: string, args: string[], options: ExecOptions
     const mustShowCommand = isDebug ? true : options.showCommand ? options.showCommand : false;
 
     function processOutput(data: Buffer) {
-        const chunk = data.toString();
-        output += chunk;
+        try {
+            const chunk = data.toString();
+            output += chunk;
 
-        if (!isSilent) {
-            process.stdout.write(chunk);
+            if (!isSilent && chunk.trim().length > 0) {
+                process.stdout.write(chunk);
+            }
+        } catch (error: any) {
+            if (error.code !== 'EPIPE') {
+                throw error;
+            }
         }
     }
 
@@ -235,7 +241,7 @@ export async function TryKillProcess(procInfo: ProcInfo): Promise<number | undef
     try {
         pid = procInfo.pid;
         logger.ci(`Killing process "${procInfo.name}" with pid: ${pid}`);
-        process.kill(pid);
+        process.kill(pid, 'SIGTERM');
     } catch (error) {
         const nodeJsException = error as NodeJS.ErrnoException;
         const errorCode = nodeJsException?.code;