nodejs spawn 实时输出unity日志

原先unity项目的CI构建脚本是用python写的，一直觉得python类型检查推断方面很不方便，后来便用nodejs重新写了一个构建程序（传送门），但囿于时间所限，一直没有很好的处理unity日志实时输出的问题。今天有空就顺手解决一下。
众所周知，unity默认不会将日志输出到标准输出流（stdout），而是输出到日志文件中。参见：https://docs.unity3d.com/cn/2021.1/Manual/LogFiles.html

image.png

官方已经把解决方案给出，可以指定-将unity输出发送到stdout。网上有关于python版本的解决方案，见https://zhuanlan.zhihu.com/p/26071703，这里说说nodejs中如何实现。

将unity日志输出到stdout

在unity2019.1及其后续版本，需要在调用unity的命令行中，增加参数-logfile -。

注：在更早的版本，网上有人说直接使用参数-logfile（即不指定特定日志文件），我没有测试过。

nodejs获取子线程输出

这里使用spawn来实现异步子线程，有两种方式，其一是创建子线程时，指定stdio为inherit，即链接到主线程的标准输出流。

let proc = spawn('D:/where_unity_installed/unity.exe', 
    ['-batchmode', '-projectPath', 'D:/project_path', '-quit', '-logfile', '-'], { stdio: 'inherit' });

其二是指定stdio为pipe，和inherit原封不动输出不同，这种方式可以对输出进行二次加工。

let proc = spawn('D:/where_unity_installed/unity.exe', 
    ['-batchmode', '-projectPath', 'D:/project_path', '-quit', '-logfile', '-'], { stdio: 'pipe' });

proc.stdout!.on('data', (data) => {
    let dataStr = String(data);
    process.stdout.write(moment().format('HH:mm:ss:SSS ') + dataStr);
});

proc.stderr!.on('data', (data) => {
    let dataStr = String(data);
    process.stderr.write(moment().format('HH:mm:ss:SSS ') + dataStr);
});

下面是一个通用的子线程类的完整例子

import os from 'os';
import { spawn, SpawnOptions } from "child_process";
import moment from 'moment';

interface CmdOption extends SpawnOptions {
    silent?: boolean;
    logPrefix?: string;
}

export class Cmd {
    private text: string = '';

    runNodeModule(moduleName: string, params?: string[], options?: CmdOption): Promise {
        if(os.type() == 'Windows_NT' && !moduleName.match(/\.cmd$/)) {
            moduleName += '.cmd';
        }
        return this.run(moduleName, params, options);
    }

    run(command: string, params?: string[], options?: CmdOption): Promise {
        this.text = '';
        // options = Object.assign(options || {}, { cwd: this.cfg.cwd });
        return new Promise((resolve: (data: string) => void, reject: (error: Error) => void) => {
            console.log(`run command: ${command}, params:`, params, options);
    
            if(!options) {
                options = {};
            }
            if(!params) params = [];
            options.stdio = 'pipe';
            let proc = spawn(command, params, options);
    
            proc.stdout!.on('data', (data) => {
                let dataStr = String(data);
                if(options?.logPrefix) {
                    dataStr = options.logPrefix + dataStr;
                }
                this.text += dataStr;
                if(!options?.silent) process.stdout.write(moment().format('HH:mm:ss:SSS ') + dataStr);
            });
    
            proc.stderr!.on('data', (data) => {
                // 不一定代表进程exitcode != 0，可能只是进程调用了console.error
                let dataStr = String(data);
                if(options?.logPrefix) {
                    dataStr = options.logPrefix + dataStr;
                }
                if(!options?.silent) process.stderr.write(moment().format('HH:mm:ss:SSS ') + dataStr);
            });
    
            // 进程错误
            proc.on('error', (error: Error) => {
                if(!options?.silent) console.error(error);
                reject(error);
            });
    
            // 进程关闭
            proc.on('close', (code: number) => {
                console.log(`process closed with exit code: ${code}`);
                if(code == 0) {
                    resolve(this.text || '');
                } else {
                    let errMsg = `process closed with exit code: ${code}`;
                    if(options?.logPrefix) {
                        errMsg = options.logPrefix + errMsg;
                    }
                    reject(new Error(errMsg));
                }
            });

            proc.on('exit', (code: number | null, signal: NodeJS.Signals | null) => {
                console.log(`process exits`);
            });
        });
    }
}