@aiot-toolkit/emulator 2.0.2-beta.4 → 2.0.2-beta.6

package/lib/instance/miwear.js

@@ -41,7 +41,6 @@ const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
-const portfinder_1 = __importDefault(require("portfinder"));
 const ws_1 = __importStar(require("ws"));
 const constants_1 = require("../static/constants");
 const utils_1 = require("../utils");
@@ -49,7 +48,7 @@ const common_1 = __importDefault(require("./common"));
 const MAX_RECONNECT_COUNT = 8;
 /**
  * MiwearInstance
- * 针对 vela4.0 的镜像
+ * 针对 Vela正式版（4.0）的镜像
  */
 class MiwearInstance extends common_1.default {
     constructor(params) {
@@ -58,19 +57,26 @@ class MiwearInstance extends common_1.default {
         this.appPathInEmulator = '/data/quickapp/app';
         this.reconnectCount = 0;
     }
-    /** 在goldfish模拟器中运行快应用 */
+    /**
+     * 1. 启动模拟器
+     * 2. 启动成功后，adb连接模拟器
+     * 3. 连接成功后，在模拟器中启动快应用
+     */
     start(options) {
         return __awaiter(this, void 0, void 0, function* () {
             this.startOptions = options;
+            this.sn = `127.0.0.1:${this.startOptions.adbPort}`;
             // 启动模拟器
             yield this.startGoldfish(options);
             // adb连接模拟器
             const connected = yield this.connectGoldfish();
             if (connected) {
                 ColorConsole_1.default.info('### Emulator ### Goldfish emulator connected successfully');
+                // 如果是首次启动，创建server端监听事件
                 if (this.isFirstStart && this.startOptions.serverPort) {
                     yield this.createWebsockeServer();
                 }
+                // 在模拟器中启动快应用
                 this.startupQuickApp(options);
                 this.isFirstStart = false;
             }
@@ -79,31 +85,40 @@ class MiwearInstance extends common_1.default {
             }
         });
     }
-    /** 启动goldfish模拟器 */
+    /**
+     * 启动模拟器
+     * 1. 通过options生成模拟器的启动命令
+     * 2. 执行启动命令
+     * 3. 判断模拟器是否启动成功
+     *    3.1 若disableNSH=true，输出流中匹配到/quickapp_rpk_installer_init|rpk installer init done/，认为模拟器启动成功了
+     *    3.2 若disableNSH=false，认为8s过后模拟器启动成功了
+     * @param options
+     * @returns
+     */
     startGoldfish(options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { avdName, devtool } = options;
+            // 获取emulator bin的绝对路径
             const emulatorBin = this.getEmulatorBinPath();
             ColorConsole_1.default.log(`### Emulator ### emulator path: ${emulatorBin}`);
+            // 获取vela镜像的绝对路径
             const avdInfo = this.velaAvdCls.getVelaAvdInfo(avdName);
             const { avdArch, avdImagePath } = avdInfo;
-            this.adbPort = yield portfinder_1.default.getPortPromise({ port: this.adbPort });
-            ColorConsole_1.default.log(`### Emulator ### adb port: ${this.adbPort}`);
+            ColorConsole_1.default.log(`### Emulator ### adb port: ${options.adbPort}`);
             if (!avdImagePath) {
                 return ColorConsole_1.default.throw(`### Emulator ### Unable to find vela image via avd`);
             }
             const nuttxBinPath = path_1.default.resolve(avdImagePath, 'nuttx');
             ColorConsole_1.default.log(`### Emulator ### nuttx path: ${nuttxBinPath}`);
-            // 端口映射
-            let portMappingStr = `-network-user-mode-options hostfwd=tcp:127.0.0.1:${this.adbPort}-10.0.2.15:5555`;
+            // 端口映射，adb端口和debug端口
+            let portMappingStr = `-network-user-mode-options hostfwd=tcp:127.0.0.1:${options.adbPort}-10.0.2.15:5555`;
             if (devtool) {
-                this.debugPort = yield portfinder_1.default.getPortPromise({ port: this.debugPort });
-                portMappingStr += `,hostfwd=tcp:127.0.0.1:${this.debugPort}-10.0.2.15:101`;
+                portMappingStr += `,hostfwd=tcp:127.0.0.1:${options.debugPort}-10.0.2.15:101`;
             }
             // 文件系统配置，第一次使用fatfs镜像挂载，后续使用adb push更新应用
-            const systemImageBin = path_1.default.resolve(avdImagePath, 'vela_resource.img');
-            const dataImageBin = path_1.default.resolve(avdImagePath, 'data.img');
+            const systemImageBin = path_1.default.resolve(avdImagePath, 'vela_resource.bin');
+            const dataImageBin = path_1.default.resolve(avdImagePath, 'vela_data.bin');
             const coreBin = path_1.default.resolve(avdImagePath, 'coredump.core');
             const imageMountStr = `-drive index=0,id=system,if=none,format=raw,file=${systemImageBin} \
 -device virtio-blk-device,bus=virtio-mmio-bus.0,drive=system \
@@ -120,8 +135,9 @@ class MiwearInstance extends common_1.default {
                 const portSuffix = this.startOptions.vncPort - constants_1.defaultVncPort;
                 vncStr = `-vnc :${portSuffix}`;
             }
+            // 根据disableNSH参数配置stdio
             const stdioType = options.disableNSH ? 'pipe' : 'inherit';
-            // 启动goldfish的命令和参数
+            // 启动模拟器的命令和参数
             const cmd = `${emulatorBin} -nuttx -avd ${avdName} -avd-arch ${avdArch} -show-kernel -kernel ${nuttxBinPath} ${portMappingStr} ${windowStr} -qemu ${vncStr} ${imageMountStr}`;
             const spawnArgs = cmd.split(' ');
             const spawnBin = spawnArgs.shift();
@@ -129,16 +145,19 @@ class MiwearInstance extends common_1.default {
             return new Promise((resolve) => {
                 var _a, _b, _c;
                 this.goldfishProcess = (0, child_process_1.spawn)(spawnBin, spawnArgs, { stdio: stdioType, shell: true, cwd: this.sdkHome });
+                // 监听错误流
                 (_a = this.goldfishProcess.stderr) === null || _a === void 0 ? void 0 : _a.on('data', (data) => {
                     const stderrCb = options.stderrCallback || console.log;
                     stderrCb(data.toString());
                 });
+                // 监听模拟器的退出事件
                 this.goldfishProcess.on('exit', (code) => {
                     ColorConsole_1.default.error(`### Emulator ### Goldfish emulator exited with code ${code}`);
                     if (options.exitCallback) {
                         options.exitCallback(code);
                     }
                 });
+                // disableNSH=false时，输出流会直接定向到终端，可在终端输入「回车」进入模拟器的终端，这种情况下无法拿到stdout中的数据
                 if (options.disableNSH) {
                     (_c = (_b = this.goldfishProcess) === null || _b === void 0 ? void 0 : _b.stdout) === null || _c === void 0 ? void 0 : _c.on('data', (data) => {
                         const msg = data.toString();
@@ -151,6 +170,7 @@ class MiwearInstance extends common_1.default {
                     });
                 }
                 else {
+                    // disableNSH=true时，默认8s后模拟器启动成功
                     setTimeout(() => {
                         ColorConsole_1.default.info(`### Emulator ### Goldfish emulator starts successfully`);
                         resolve();
@@ -159,37 +179,56 @@ class MiwearInstance extends common_1.default {
             });
         });
     }
-    /** 通过adb连接模拟器 */
+    /**
+     * 通过adb连接模拟器。
+     * 时间限制为2分钟，超时则表示连接失败
+     * 注意：两次connect之间不能等待，否则在disableNSH=true且有vncPort的模式下，模拟器启动成功了，但是vnc可能还没连接上
+     *      时间限制不能太短，否则模拟器里面的adbd进程还没初始化成功
+     * @returns
+     */
     connectGoldfish() {
         return __awaiter(this, void 0, void 0, function* () {
-            let adbConnected = false;
+            let adbConnected = false; // adb是否连接成功
+            let enableLoop = true; // 是否允许循环，用于终止adb的连接
             const connectFn = () => __awaiter(this, void 0, void 0, function* () {
-                const sn = `127.0.0.1:${this.adbPort}`;
-                while (!adbConnected) {
+                while (enableLoop && !adbConnected) {
                     const adbKillCmd = `adb kill-server`;
                     ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${adbKillCmd}`);
                     yield adbMiwt.execAdbCmdAsync(adbKillCmd);
-                    const adbConnectCmd = `adb connect ${sn}`;
+                    const adbConnectCmd = `adb connect ${this.sn}`;
                     ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${adbConnectCmd}`);
                     const str = yield adbMiwt.execAdbCmdAsync(adbConnectCmd);
                     ColorConsole_1.default.log(`### Emulator ### ${str}`);
+                    // 查询模拟器的状态是否为“device”
                     const devices = yield adbMiwt.getAdbDevices();
                     ColorConsole_1.default.log(`### Emulator ### adb devices: ${JSON.stringify(devices)}`);
                     adbConnected =
-                        devices.filter((item) => item.sn === sn && item.status === 'device').length > 0;
+                        devices.filter((item) => item.sn === this.sn && item.status === 'device').length > 0;
                 }
-                Promise.resolve(adbConnected);
+                return Promise.resolve(adbConnected);
             });
-            yield Promise.race([
+            const res = yield Promise.race([
                 connectFn(),
                 new Promise((resolve) => {
-                    setTimeout(() => resolve(false), 600 * 1000);
+                    setTimeout(() => {
+                        enableLoop = false;
+                        // 超时则认为adb没有连接成功
+                        resolve(false);
+                    }, 120 * 1000);
                 })
             ]);
-            return adbConnected;
+            return res;
         });
     }
-    /** 在goldfish中启动快应用 */
+    /**
+     * 在模拟器中启动快应用
+     * 1. 检查release目录是否有打包好的rpk
+     * 2. 检查当前是否为调试模式.
+     *    若是，将debugger_ip.cfg推到模拟器的/data/目录下
+     *    若否，则要删除模拟器中已有的data/debugger_ip.cfg
+     * 3. 调用installRpkToAppList将当前快应用安装到模拟器的应用列表中
+     * @param options
+     */
     startupQuickApp(options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -205,41 +244,35 @@ class MiwearInstance extends common_1.default {
             }
             const rpkPath = path_1.default.resolve(releaseDir, files[0]);
             // 调试模式需要push一个文件至miwear中
-            const sn = `127.0.0.1:${this.adbPort}`;
             if (options.devtool) {
                 const debuggerCfgFile = path_1.default.join(__dirname, '../static/debugger_ip.cfg');
-                yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} push ${debuggerCfgFile} /data/debugger_ip.cfg`);
+                yield adbMiwt.execAdbCmdAsync(`adb -s ${this.sn} push ${debuggerCfgFile} /data/debugger_ip.cfg`);
             }
             else {
-                adbMiwt.execAdbCmdAsync(`adb -s ${sn} shell rm /data/debugger_ip.cfg`);
+                adbMiwt.execAdbCmdAsync(`adb -s ${this.sn} shell rm /data/debugger_ip.cfg`);
             }
             this.installRpkToAppList(rpkPath, this.appPathInEmulator);
         });
     }
-    /** 将快应用安装到应用列表 */
+    /**
+     * 将快应用安装到模拟器的应用列表
+     * 1. 使用adb push将打包好的rpk推到模拟器的/data/quickapp/app/
+     * 2. nsh中调用pm install命令安装应用
+     * @param rpkPath rpk的绝对目录
+     * @param targetDir 要将rpk放到模拟器的哪个目录下
+     */
     installRpkToAppList(rpkPath, targetDir) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const sn = `127.0.0.1:${this.adbPort}`;
                 const { package: packageName } = this.projectInfo;
-                // 1. 查询应用是否已经安装，如果安装了，则先卸载
-                const lsCmd = `adb -s ${sn} shell ls ${this.appPathInEmulator}`;
-                const res = yield adbMiwt.execAdbCmdAsync(lsCmd);
-                if (res.includes(packageName)) {
-                    const uninstallCmd = `adb -s ${sn} shell pm uninstall ${packageName}`;
-                    ColorConsole_1.default.info(`### Emulator ### Excuting cmd: ${uninstallCmd}`);
-                    adbMiwt.execAdbCmdAsync(uninstallCmd);
-                    // 这里等待2s的作用是等qemu执行完uninstall操作的一系列工作
-                    yield (0, utils_1.sleep)(2000);
-                }
-                // 2. adb push应用的rpk
+                // 1. adb push应用的rpk
                 const targetPath = `${targetDir}/${packageName}.rpk`;
-                const pushCmd = `adb -s ${sn} push "${rpkPath}" ${targetPath}`;
+                const pushCmd = `adb -s ${this.sn} push "${rpkPath}" ${targetPath}`;
                 ColorConsole_1.default.info(`### Emulator ### Excuting cmd: ${pushCmd}`);
                 yield adbMiwt.execAdbCmdAsync(pushCmd);
-                yield (0, utils_1.sleep)(100);
-                // 3. 安装应用
-                const installCmd = `adb -s ${sn} shell pm install ${targetPath}`;
+                yield (0, utils_1.sleep)(1000);
+                // 2. 安装应用(pm install时如何应用重名会覆盖)
+                const installCmd = `adb -s ${this.sn} shell pm install ${targetPath}`;
                 ColorConsole_1.default.info(`### Emulator ### Excuting cmd: ${installCmd}`);
                 adbMiwt.execAdbCmdAsync(installCmd);
             }
@@ -248,12 +281,17 @@ class MiwearInstance extends common_1.default {
             }
         });
     }
+    /** 连接模拟器中的调试服务，创建debugSocket
+     * 主要用于热更新时，通过debugSocket通知调试服务更新页面
+     * 设置了重连机制，会重复连接8次
+     */
     initDebugSocket() {
         return new Promise((resolve, reject) => {
+            var _a;
             if (this.debugSocket && this.debugSocket.OPEN) {
                 return resolve();
             }
-            this.debugSocket = new ws_1.default(`ws://localhost:${this.debugPort}`);
+            this.debugSocket = new ws_1.default(`ws://localhost:${(_a = this.startOptions) === null || _a === void 0 ? void 0 : _a.debugPort}`);
             this.debugSocket.onopen = () => {
                 ColorConsole_1.default.info(`### Emulator debugSocket connect success`);
                 return resolve();
@@ -280,7 +318,11 @@ class MiwearInstance extends common_1.default {
             };
         });
     }
-    /** 通知模拟器更新 */
+    /** 通知模拟器更新
+     * 1. 确保已经成功连接模拟器中的调试服务
+     * 2. 使用adb push将build文件下的内容推到/data/quickapp/app/${packageName}
+     * 3. 发送Page.reload命令给调试服务，通知更新
+    */
     handleUpdate() {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
@@ -288,22 +330,7 @@ class MiwearInstance extends common_1.default {
                 this.reconnectCount = 0;
                 yield this.initDebugSocket();
                 // 1. 将整包重新推到miwear中（TODO：增量更新）
-                const sn = `127.0.0.1:${this.adbPort}`;
-                const { package: appPackageName } = this.projectInfo;
-                // windows平台adb push时无法使用通配符，需另外处理; 
-                // 项目路径包含空格时，无法通过加引号来使用 * 通配符
-                if (os_1.default.platform() === 'win32' || this.projectPath.indexOf(' ') > 0) {
-                    const rmCmd = `adb -s ${sn} shell rm -r ${this.appPathInEmulator}/${appPackageName}`;
-                    yield adbMiwt.execAdbCmdAsync(rmCmd);
-                    const sourcePath = path_1.default.resolve(this.projectPath, './build');
-                    const pushCmd = `adb -s ${sn} push "${sourcePath}" ${this.appPathInEmulator}/${appPackageName}`;
-                    yield adbMiwt.execAdbCmdAsync(pushCmd);
-                }
-                else {
-                    const sourcePath = path_1.default.resolve(this.projectPath, './build/*');
-                    yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} push ${sourcePath} ${this.appPathInEmulator}/${appPackageName}`);
-                }
-                ColorConsole_1.default.info(`### Emulator push to ${this.appPathInEmulator}/${appPackageName} successfully`);
+                yield this.pushBuild();
                 // 2. 下发CDP命令给调试服务告知刷新
                 if (((_a = this.debugSocket) === null || _a === void 0 ? void 0 : _a.readyState) === ws_1.default.OPEN) {
                     (_b = this.debugSocket) === null || _b === void 0 ? void 0 : _b.send(JSON.stringify({ id: 10000, method: 'Page.reload', params: {} }));
@@ -314,7 +341,55 @@ class MiwearInstance extends common_1.default {
             }
         });
     }
-    /** 创建server */
+    /** 热更新时push目录 */
+    pushBuild() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { package: appPackageName } = this.projectInfo;
+            // windows平台adb push时无法使用通配符，需另外处理; 
+            // 项目路径包含空格时，无法通过加引号来使用 * 通配符
+            if (os_1.default.platform() === 'win32' || this.projectPath.indexOf(' ') > 0) {
+                const rmCmd = `adb -s ${this.sn} shell rm -r ${this.appPathInEmulator}/${appPackageName}`;
+                yield adbMiwt.execAdbCmdAsync(rmCmd);
+                const sourcePath = path_1.default.resolve(this.projectPath, './build');
+                const pushCmd = `adb -s ${this.sn} push "${sourcePath}" ${this.appPathInEmulator}/${appPackageName}`;
+                yield adbMiwt.execAdbCmdAsync(pushCmd);
+            }
+            else {
+                const sourcePath = path_1.default.resolve(this.projectPath, './build/*');
+                yield adbMiwt.execAdbCmdAsync(`adb -s ${this.sn} push ${sourcePath} ${this.appPathInEmulator}/${appPackageName}`);
+            }
+            ColorConsole_1.default.info(`### Emulator push to ${this.appPathInEmulator}/${appPackageName} successfully`);
+        });
+    }
+    /** 在模拟器中重启快应用（基于am命令，需要保证镜像中已经有am功能）
+     * 1. 使用adb push将build文件下的内容推到/data/quickapp/app/${packageName}
+     * 2. nsh中执行am stop命令退出快应用
+     * 3. nsh中执行am start命令启动快应用
+    */
+    reloadApp() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                // 1. 将整包重新推到miwear中（TODO：增量更新）
+                const { package: appPackageName } = this.projectInfo;
+                yield this.pushBuild();
+                // 2. 执行am stop和am start命令
+                const stopCmd = `adb -s ${this.sn} shell am stop ${appPackageName}`;
+                yield adbMiwt.execAdbCmdAsync(stopCmd);
+                ColorConsole_1.default.info(`### Emulator stop ${appPackageName} successfully`);
+                // 这里是为了等am stop命令清除资源等
+                yield (0, utils_1.sleep)(500);
+                const startCmd = `adb -s ${this.sn} shell am start ${appPackageName}`;
+                yield adbMiwt.execAdbCmdAsync(startCmd);
+                ColorConsole_1.default.info(`### Emulator start ${appPackageName} successfully`);
+            }
+            catch (e) {
+                ColorConsole_1.default.error(`${e}`);
+            }
+        });
+    }
+    /**
+     * 创建server端，监听打包过程中client端发来的消息
+     */
     createWebsockeServer() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -326,6 +401,7 @@ class MiwearInstance extends common_1.default {
                 socket.on('error', err => {
                     ColorConsole_1.default.error(`### App Socket server ### Websocket server error: ${err.message}`);
                 });
+                // data的格式：{ type: string, data: any }
                 socket.on('message', (data) => __awaiter(this, void 0, void 0, function* () {
                     var _a;
                     const message = JSON.parse(data.toString());

package/lib/instance/preDev.d.ts

@@ -2,20 +2,48 @@
 import { ChildProcess } from 'child_process';
 import { INewGoldfishInstanceParams, IStartOptions } from '../typing/Instance';
 import CommonInstance from './common';
+/**
+ * OldGoldfishInstance
+ * 针对 Vela开发版（dev, 0.0.2）的镜像
+ */
 declare class OldGoldfishInstance extends CommonInstance {
     private host9pPort;
     v9fsProcess: ChildProcess | undefined;
     constructor(params: INewGoldfishInstanceParams);
-    /** 在goldfish模拟器中运行快应用 */
+    /**
+     * 1. 启动9p server
+     * 2. 将打包好的rpk推到host的挂载目录
+     * 3. 启动模拟器
+     * 4. 模拟器启动成功后，adb连接模拟器
+     * 5. 连接成功后，在模拟器中启动快应用
+     */
     start(options: IStartOptions): Promise<void>;
-    /** 在goldfish中启动快应用 */
+    /**
+     * 在模拟器中启动快应用（快应用都在模拟器的/data/app目录下）
+     * 1. 是否为调试模式
+     *    若是，在模拟器终端执行vapp app/${packageName} &
+     *    若否，在模拟器终端执行vapp --jsdebugger=10.0.2.15:101 app/${packageName} &
+     */
     startupQuickApp(options: IStartOptions): void;
-    /** host启动9pServer */
+    /** host启动9pServer
+     * 作用是将本地的quickappMountDir目录挂载到模拟器的/data目录
+    */
     ensure9pServerRunnning(): Promise<void>;
-    /** 启动goldfish模拟器 */
+    /**
+     * 启动模拟器
+     * 1. 通过options生成模拟器的启动命令
+     * 2. 执行启动命令
+     * 3. 判断模拟器是否启动成功
+     *    3.1 若disableNSH=true，输出流中匹配到/quickapp_rpk_installer_init|rpk installer init done/，认为模拟器启动成功了
+     *    3.2 若disableNSH=false，认为8s过后模拟器启动成功了
+     * @param options
+     * @returns
+     */
     startGoldfish(options: IStartOptions): Promise<void>;
-    /** 通过adb连接模拟器 */
-    connectGoldfish(): Promise<boolean>;
+    /**
+     * 推送文件到本地的${sdkHome}/qa/app/${packageName}目录
+     * @param sourceRoot 源目录
+     */
     pushRpk(sourceRoot: string): Promise<void>;
     /** 停止模拟器并释放相关资源 */
     stop(): Promise<void>;

package/lib/instance/preDev.js

@@ -46,25 +46,38 @@ const path_1 = __importDefault(require("path"));
 const portfinder_1 = __importDefault(require("portfinder"));
 const constants_1 = require("../static/constants");
 const common_1 = __importDefault(require("./common"));
+/**
+ * OldGoldfishInstance
+ * 针对 Vela开发版（dev, 0.0.2）的镜像
+ */
 class OldGoldfishInstance extends common_1.default {
     constructor(params) {
         super(params);
         this.host9pPort = 7878;
     }
-    /** 在goldfish模拟器中运行快应用 */
+    /**
+     * 1. 启动9p server
+     * 2. 将打包好的rpk推到host的挂载目录
+     * 3. 启动模拟器
+     * 4. 模拟器启动成功后，adb连接模拟器
+     * 5. 连接成功后，在模拟器中启动快应用
+     */
     start(options) {
         return __awaiter(this, void 0, void 0, function* () {
+            this.startOptions = options;
+            this.sn = `127.0.0.1:${this.startOptions.adbPort}`;
             // host启动9p server
             yield this.ensure9pServerRunnning();
-            this.startOptions = options;
             // 将rpk推到host的./export/qa/app目录
             const buildedFilesPath = this.isRpk ? this.projectPath : path_1.default.resolve(this.projectPath, './build');
             this.pushRpk(buildedFilesPath);
             // 启动模拟器
             yield this.startGoldfish(options);
+            // adb连接快应用
             const connected = yield this.connectGoldfish();
             if (connected) {
                 ColorConsole_1.default.log('### Emulator ### Goldfish emulator connected successfully');
+                // 如果是首次启动，创建server端监听事件
                 if (this.isFirstStart && this.startOptions.serverPort) {
                     yield this.createWebsockeServer();
                 }
@@ -77,17 +90,23 @@ class OldGoldfishInstance extends common_1.default {
             }
         });
     }
-    /** 在goldfish中启动快应用 */
+    /**
+     * 在模拟器中启动快应用（快应用都在模拟器的/data/app目录下）
+     * 1. 是否为调试模式
+     *    若是，在模拟器终端执行vapp app/${packageName} &
+     *    若否，在模拟器终端执行vapp --jsdebugger=10.0.2.15:101 app/${packageName} &
+     */
     startupQuickApp(options) {
         try {
             const { package: packageName } = this.projectInfo;
             const appMountDir = path_1.default.resolve(this.sdkHome, 'qa');
-            const mountCmd = `adb -s 127.0.0.1:${this.adbPort} shell mount -t v9fs -o tag=10.0.2.2,port=${this.host9pPort},aname=${appMountDir} /data`;
+            const mountCmd = `adb -s 127.0.0.1:${options.adbPort} shell mount -t v9fs -o tag=10.0.2.2,port=${this.host9pPort},aname=${appMountDir} /data`;
             ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${mountCmd}`);
             adbMiwt.execAdbCmdSync(mountCmd);
-            let vappCmd = `adb -s 127.0.0.1:${this.adbPort} shell vapp app/${packageName} &`;
+            let vappCmd = `adb -s 127.0.0.1:${options.adbPort} shell vapp app/${packageName} &`;
+            // 调试情况下，需要加--jsdebugger=10.0.2.15:101
             if (options.devtool) {
-                vappCmd = `adb -s 127.0.0.1:${this.adbPort} shell vapp --jsdebugger=10.0.2.15:101 app/${packageName} &`;
+                vappCmd = `adb -s 127.0.0.1:${options.adbPort} shell vapp --jsdebugger=10.0.2.15:101 app/${packageName} &`;
             }
             ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${vappCmd}`);
             // vapp进程会一直pending，不会退出。这里必须加stdio: 'ignore'，否则快应用无法运行成功
@@ -97,7 +116,9 @@ class OldGoldfishInstance extends common_1.default {
             ColorConsole_1.default.error(`### Emulator ### Failed to startup quickapp: ${e.message}`);
         }
     }
-    /** host启动9pServer */
+    /** host启动9pServer
+     * 作用是将本地的quickappMountDir目录挂载到模拟器的/data目录
+    */
     ensure9pServerRunnning() {
         return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -121,6 +142,7 @@ class OldGoldfishInstance extends common_1.default {
                 address,
                 '--debug'
             ]);
+            // 监听stderr，判断9p server是否启动成功了
             (_a = this.v9fsProcess.stderr) === null || _a === void 0 ? void 0 : _a.on('data', (data) => {
                 const output = data.toString();
                 if (output.match(/Server started, listening on: 127.0.0.1:(\d+)/)) {
@@ -129,35 +151,45 @@ class OldGoldfishInstance extends common_1.default {
                     return resolve();
                 }
             });
+            // 监听exit事件，判断9p server是否退出了
             this.v9fsProcess.on('exit', (code) => {
                 ColorConsole_1.default.error(`### Emulator ### ya-vm-file-server exited with code ${code}`);
                 return reject();
             });
         }));
     }
-    /** 启动goldfish模拟器 */
+    /**
+     * 启动模拟器
+     * 1. 通过options生成模拟器的启动命令
+     * 2. 执行启动命令
+     * 3. 判断模拟器是否启动成功
+     *    3.1 若disableNSH=true，输出流中匹配到/quickapp_rpk_installer_init|rpk installer init done/，认为模拟器启动成功了
+     *    3.2 若disableNSH=false，认为8s过后模拟器启动成功了
+     * @param options
+     * @returns
+     */
     startGoldfish(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const { avdName, devtool } = options;
+            // 获取emulator bin的绝对路径
             const emulatorBin = this.getEmulatorBinPath();
             ColorConsole_1.default.log(`### Emulator ### emulator path: ${emulatorBin}`);
+            // 获取vela镜像的绝对路径
             const avdInfo = this.velaAvdCls.getVelaAvdInfo(avdName);
             const { avdArch, avdImagePath } = avdInfo;
-            this.adbPort = yield portfinder_1.default.getPortPromise({ port: this.adbPort });
-            ColorConsole_1.default.log(`### Emulator ### adb port: ${this.adbPort}`);
+            ColorConsole_1.default.log(`### Emulator ### adb port: ${options.adbPort}`);
             if (!avdImagePath) {
                 return ColorConsole_1.default.throw(`### Emulator ### Unable to find vela image via avd`);
             }
             const nuttxBinPath = path_1.default.resolve(avdImagePath, 'nuttx');
             ColorConsole_1.default.log(`### Emulator ### nuttx path: ${nuttxBinPath}`);
-            let portMappingStr = `user,id=u1,hostfwd=tcp:127.0.0.1:${this.adbPort}-10.0.2.15:5555`;
+            // 端口映射，adb端口和debug端口
+            let portMappingStr = `user,id=u1,hostfwd=tcp:127.0.0.1:${options.adbPort}-10.0.2.15:5555`;
             if (devtool) {
-                this.debugPort = yield portfinder_1.default.getPortPromise({ port: this.debugPort });
-                ColorConsole_1.default.log(`### Emulator ### debug port: ${this.debugPort}`);
-                portMappingStr += `,hostfwd=tcp:127.0.0.1:${this.debugPort}-10.0.2.15:101`;
+                ColorConsole_1.default.log(`### Emulator ### debug port: ${options.debugPort}`);
+                portMappingStr += `,hostfwd=tcp:127.0.0.1:${options.debugPort}-10.0.2.15:101`;
             }
             ColorConsole_1.default.log(`### Emulator ### Start qemu with TCP: ${portMappingStr}`);
-            const stdioType = options.disableNSH ? 'pipe' : 'inherit';
             // vnc配置
             let noWindow = false;
             let vncStr = '';
@@ -166,6 +198,8 @@ class OldGoldfishInstance extends common_1.default {
                 const portSuffix = options.vncPort - constants_1.defaultVncPort;
                 vncStr = `-vnc :${portSuffix}`;
             }
+            // 根据disableNSH参数配置stdio
+            const stdioType = options.disableNSH ? 'pipe' : 'inherit';
             // 启动goldfish的命令和参数
             const spawnBin = emulatorBin;
             const spawnArgs = [
@@ -189,16 +223,19 @@ class OldGoldfishInstance extends common_1.default {
             return new Promise((resolve) => {
                 var _a;
                 this.goldfishProcess = (0, child_process_1.spawn)(spawnBin, spawnArgs, { stdio: stdioType, shell: true });
+                // 监听错误流
                 (_a = this.goldfishProcess.stderr) === null || _a === void 0 ? void 0 : _a.on('data', (data) => {
                     const stderrCb = options.stderrCallback || console.log;
                     stderrCb(data.toString());
                 });
+                // 监听模拟器的退出事件
                 this.goldfishProcess.on('exit', (code) => {
                     ColorConsole_1.default.error(`### Emulator ### Goldfish emulator exited with code ${code}`);
                     if (options.exitCallback) {
                         options.exitCallback(code);
                     }
                 });
+                // 监听输出流。输出了'(NSH)'标识或者2s后则认为模拟器启动成功
                 const p1 = new Promise((resolve) => {
                     var _a, _b;
                     (_b = (_a = this.goldfishProcess) === null || _a === void 0 ? void 0 : _a.stdout) === null || _b === void 0 ? void 0 : _b.on('data', (data) => {
@@ -218,36 +255,10 @@ class OldGoldfishInstance extends common_1.default {
             });
         });
     }
-    /** 通过adb连接模拟器 */
-    connectGoldfish() {
-        return __awaiter(this, void 0, void 0, function* () {
-            let adbConnected = false;
-            const connectFn = () => __awaiter(this, void 0, void 0, function* () {
-                const sn = `127.0.0.1:${this.adbPort}`;
-                while (!adbConnected) {
-                    const adbKillCmd = `adb kill-server`;
-                    ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${adbKillCmd}`);
-                    adbMiwt.execAdbCmdSync(adbKillCmd);
-                    const adbConnectCmd = `adb connect ${sn}`;
-                    ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${adbConnectCmd}`);
-                    const str = adbMiwt.execAdbCmdSync(adbConnectCmd);
-                    ColorConsole_1.default.log(`### Emulator ### ${str}`);
-                    const devices = yield adbMiwt.getAdbDevices();
-                    ColorConsole_1.default.log(`### Emulator ### adb devices: ${JSON.stringify(devices)}`);
-                    adbConnected =
-                        devices.filter((item) => item.sn === sn && item.status === 'device').length > 0;
-                }
-                Promise.resolve(adbConnected);
-            });
-            yield Promise.race([
-                connectFn(),
-                new Promise((resolve) => {
-                    setTimeout(() => resolve(false), 600 * 1000);
-                })
-            ]);
-            return adbConnected;
-        });
-    }
+    /**
+     * 推送文件到本地的${sdkHome}/qa/app/${packageName}目录
+     * @param sourceRoot 源目录
+     */
     pushRpk(sourceRoot) {
         return __awaiter(this, void 0, void 0, function* () {
             const { package: appPackageName } = this.projectInfo;

package/lib/static/constants.d.ts

@@ -6,6 +6,8 @@ export declare const defaultSkinHome: string;
 export declare const defaultQuickappHome: string;
 export declare const defaultToolsHome: string;
 export declare const defaultVncPort = 5900;
+export declare const defaultAdbPort = 5555;
+export declare const defaultDebugPort = 10055;
 export declare const VelaImageVersionList: {
     label: string;
     value: string;