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

package/README.md

@@ -1,2 +1,15 @@
+## emulator
 
-emulator tool
+QEMU模拟器
+
+模拟器的介绍可参考[开发帮助文档](https://xiaomi.f.mioffice.cn/docx/doxk4Rk6x67GanHlzQ8bEOrxtEe)里的「模拟器」章节
+
+## 目录结构
+
+| 目录     | 描述                                                                            |
+| -------- | ------------------------------------------------------------------------------- |
+| avd   |   模拟器的AVD，配置统一放置$HOME/.android/avd目录下         |
+| instance | 模拟器实例，不同的Vela镜像版本会使用不同的instance，通过findInstance确定                 |
+| static   | 创建AVD时需要用到的静态资源，常量配置文件                                           |
+| typing    | 接口定义                                                       |
+| utils   | 工具函数                                                       |

package/lib/avd/index.d.ts

@@ -3,10 +3,22 @@ declare class VelaAvdCls {
     private avdHome;
     private sdkHome;
     constructor(avdResourcePaths: IAvdResourcePaths);
+    /**
+     * 创建Vela端的AVD，统一保存在.android目录下
+     * 1. 创建.android/advancedFeatures.ini文件
+     * 2. 创建.android/${avdName}.ini文件
+     * 3. 创建.android/${avdName}.avd/config.ini文件
+     * @param avdParams AVD参数，宽高、绑定的镜像路径等
+     * @returns
+     */
     createVelaAvd(avdParams: IAvdParams): boolean;
+    /** 根据AVD名字获取模拟器的详细信息 */
     getVelaAvdInfo(avdName: string): IAvdParams;
+    /** 根据名字删除AVD */
     deleteVelaAvd(avdName: string): boolean;
+    /** 获取已经创建的模拟器列表 */
     getVelaAvdList(): IAvdParams[];
+    /** 获取模拟器皮肤列表 */
     getVelaSkinList(): string[];
 }
 export default VelaAvdCls;

package/lib/avd/index.js

@@ -26,6 +26,14 @@ class VelaAvdCls {
             fs_1.default.mkdirSync(this.avdHome, { recursive: true });
         }
     }
+    /**
+     * 创建Vela端的AVD，统一保存在.android目录下
+     * 1. 创建.android/advancedFeatures.ini文件
+     * 2. 创建.android/${avdName}.ini文件
+     * 3. 创建.android/${avdName}.avd/config.ini文件
+     * @param avdParams AVD参数，宽高、绑定的镜像路径等
+     * @returns
+     */
     createVelaAvd(avdParams) {
         // 在.android下创建advancedFeatures.ini文件
         const advancedFeaturesIni = path_1.default.resolve(os_1.default.homedir(), '.android/advancedFeatures.ini');
@@ -76,6 +84,7 @@ class VelaAvdCls {
             throw (`createVelaAvd: ${e.message}`);
         }
     }
+    /** 根据AVD名字获取模拟器的详细信息 */
     getVelaAvdInfo(avdName) {
         const avdInfo = {
             avdName,
@@ -112,6 +121,7 @@ class VelaAvdCls {
             return avdInfo;
         }
     }
+    /** 根据名字删除AVD */
     deleteVelaAvd(avdName) {
         const avdDir = path_1.default.resolve(this.avdHome, `${avdName}.avd`);
         const avdIni = path_1.default.resolve(this.avdHome, `${avdName}.ini`);
@@ -124,6 +134,7 @@ class VelaAvdCls {
             return false;
         }
     }
+    /** 获取已经创建的模拟器列表 */
     getVelaAvdList() {
         const avdList = [];
         const files = fs_1.default.readdirSync(this.avdHome);
@@ -138,6 +149,7 @@ class VelaAvdCls {
         }
         return avdList;
     }
+    /** 获取模拟器皮肤列表 */
     getVelaSkinList() {
         try {
             const skinList = [];

package/lib/instance/common.d.ts

@@ -10,33 +10,30 @@ declare class CommonInstance {
     projectPath: string;
     sdkHome: string;
     avdHome: string;
-    adbPort: number;
-    debugPort: number;
     velaAvdCls: VelaAvdCls;
     goldfishProcess: ChildProcess | undefined;
     isFirstStart: boolean;
     startOptions: IStartOptions | undefined;
     projectInfo: IManifest;
     isRpk: boolean;
+    sn?: string;
     constructor(params: INewGoldfishInstanceParams);
     /** 获取模拟器二进制文件所在位置 */
     getEmulatorBinPath(): string;
     /** 在goldfish模拟器中运行快应用 */
     start(options: IStartOptions): Promise<void>;
-    /** 在goldfish中启动快应用 */
-    startupQuickApp(options: IStartOptions): void;
-    /** 启动goldfish模拟器 */
-    startGoldfish(options: IStartOptions): Promise<void>;
-    /** 通过adb连接模拟器 */
-    connectGoldfish(): Promise<boolean>;
-    /** 将打包后的文件推到挂载的快应用目录 */
-    pushRpk(sourceRoot: string): Promise<void>;
+    /**
+     * 通过adb连接模拟器。
+     * 时间限制为10s，超时则表示连接失败
+     * @returns
+     */
+    connectGoldfish(): Promise<unknown>;
     /** 杀死进程 */
     killProcess(currProcess?: ChildProcess): void;
     /** 停止模拟器并释放相关资源 */
     stop(): Promise<void>;
     /** 重启模拟器 */
-    restart(): void;
+    restart(): Promise<void>;
     /** 创建server */
     createWebsockeServer(): Promise<void>;
 }

package/lib/instance/common.js

@@ -41,7 +41,6 @@ const adbMiwt = __importStar(require("@miwt/adb"));
 const child_process_1 = require("child_process");
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
-const portfinder_1 = __importDefault(require("portfinder"));
 const ws_1 = require("ws");
 const avd_1 = __importDefault(require("../avd"));
 const constants_1 = require("../static/constants");
@@ -51,8 +50,6 @@ const utils_1 = require("../utils");
  */
 class CommonInstance {
     constructor(params) {
-        this.adbPort = 5555;
-        this.debugPort = 10055;
         this.isFirstStart = true;
         this.projectPath = params.projectPath;
         this.sdkHome = params.sdkHome || constants_1.defaultSDKHome;
@@ -74,154 +71,44 @@ class CommonInstance {
     }
     /** 在goldfish模拟器中运行快应用 */
     start(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.startOptions = options;
-            // 启动模拟器
-            yield this.startGoldfish(options);
-            const connected = yield this.connectGoldfish();
-            if (connected) {
-                ColorConsole_1.default.log('### Emulator ### Goldfish emulator connected successfully');
-                if (this.isFirstStart && this.startOptions.serverPort) {
-                    yield this.createWebsockeServer();
-                }
-                // adb push快应用到模拟器的/data/app目录
-                const buildedFilesPath = this.isRpk ? this.projectPath : path_1.default.resolve(this.projectPath, './build');
-                this.pushRpk(buildedFilesPath);
-                // 在模拟器中启动快应用
-                this.startupQuickApp(options);
-                this.isFirstStart = false;
-            }
-            else {
-                ColorConsole_1.default.throw('### Emulator ### Failed to connect emulator, please check whether the adb is normal');
-            }
-        });
-    }
-    /** 在goldfish中启动快应用 */
-    startupQuickApp(options) {
-        try {
-            let vappCmd = `adb -s 127.0.0.1:${this.adbPort} shell vapp app/${this.projectInfo.package} &`;
-            if (options.devtool) {
-                vappCmd = `adb -s 127.0.0.1:${this.adbPort} shell vapp --jsdebugger=10.0.2.15:101 app/${this.projectInfo.package} &`;
-            }
-            ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${vappCmd}`);
-            // vapp进程会一直pending，不会退出。这里必须加stdio: 'ignore'，否则快应用无法运行成功
-            adbMiwt.execAdbCmdAsync(vappCmd, { stdio: 'ignore', encoding: 'utf-8' });
-        }
-        catch (e) {
-            ColorConsole_1.default.error(`### Emulator ### Failed to startup quickapp: ${e.message}`);
-        }
-    }
-    /** 启动goldfish模拟器 */
-    startGoldfish(options) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const { avdName, devtool } = options;
-            const emulatorBin = this.getEmulatorBinPath();
-            ColorConsole_1.default.log(`### Emulator ### emulator path: ${emulatorBin}`);
-            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}`);
-            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}`);
-            // 端口映射
-            const adbPortMappingStr = `-network-user-mode-options hostfwd=tcp:127.0.0.1:${this.adbPort}-10.0.2.15:5555`;
-            let debugPortMappingStr = '';
-            if (devtool) {
-                debugPortMappingStr = `-network-user-mode-options hostfwd=tcp:127.0.0.1:${this.debugPort}-10.0.2.15:101`;
-            }
-            // 文件系统配置，第一次使用fatfs镜像挂载，后续使用adb push更新应用
-            const systemImageBin = path_1.default.resolve(this.sdkHome, 'tools/image/system.img');
-            const dataImageBin = path_1.default.resolve(this.sdkHome, 'tools/image/data.img');
-            const imageMountStr = `-drive index=0,id=system,if=none,format=raw,file=${systemImageBin} \
--device virtio-blk-device,bus=virtio-mmio-bus.0,drive=system \
--drive index=1,id=userdata,if=none,format=raw,file=${dataImageBin} \
--device virtio-blk-device,bus=virtio-mmio-bus.1,drive=userdata \
--device virtio-snd,bus=virtio-mmio-bus.2 -allow-host-audio -semihosting`;
-            // vnc配置
-            let windowStr = '';
-            let vncStr = '';
-            if ((_a = this.startOptions) === null || _a === void 0 ? void 0 : _a.vncPort) {
-                windowStr = '-no-window';
-                const portSuffix = this.startOptions.vncPort - constants_1.defaultVncPort;
-                vncStr = `-vnc :${portSuffix}`;
-            }
-            const stdioType = options.disableNSH ? 'pipe' : 'inherit';
-            // 启动goldfish的命令和参数
-            const cmd = `${emulatorBin} -nuttx -avd ${avdName} -avd-arch ${avdArch} -show-kernel -kernel ${nuttxBinPath} ${adbPortMappingStr} ${debugPortMappingStr} -qemu ${windowStr} ${vncStr} ${imageMountStr}`;
-            const spawnArgs = cmd.split(' ');
-            const spawnBin = spawnArgs.shift();
-            ColorConsole_1.default.log(`### Emulator ### Start CMD: ${cmd}`);
-            return new Promise((resolve) => {
-                var _a, _b;
-                this.goldfishProcess = (0, child_process_1.spawn)(spawnBin, spawnArgs, { stdio: stdioType, shell: true });
-                if (options.disableNSH) {
-                    (_a = this.goldfishProcess.stdout) === null || _a === void 0 ? void 0 : _a.on('data', (data) => {
-                        console.log(data.toString());
-                        if (data.toString().includes('(NSH)')) {
-                            ColorConsole_1.default.log(`### Emulator ### Goldfish emulator starts successfully`);
-                            resolve();
-                        }
-                    });
-                    (_b = this.goldfishProcess.stderr) === null || _b === void 0 ? void 0 : _b.on('data', (data) => {
-                        console.log(data.toString());
-                    });
-                }
-                else {
-                    setTimeout(() => {
-                        ColorConsole_1.default.log(`### Emulator ### Goldfish emulator starts successfully`);
-                        resolve();
-                    }, 2000);
-                }
-                this.goldfishProcess.on('exit', (code) => {
-                    ColorConsole_1.default.error(`### Emulator ### Goldfish emulator exited with code ${code}`);
-                });
-            });
-        });
+        return __awaiter(this, void 0, void 0, function* () { });
     }
-    /** 通过adb连接模拟器 */
+    /**
+     * 通过adb连接模拟器。
+     * 时间限制为10s，超时则表示连接失败
+     * @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}`);
                     adbMiwt.execAdbCmdSync(adbKillCmd);
-                    const adbConnectCmd = `adb connect ${sn}`;
+                    const adbConnectCmd = `adb connect ${this.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;
+                        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);
+                    }, 10 * 1000);
                 })
             ]);
-            return adbConnected;
-        });
-    }
-    /** 将打包后的文件推到挂载的快应用目录 */
-    pushRpk(sourceRoot) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const sn = `127.0.0.1:${this.adbPort}`;
-            const { package: appPackageName } = UxFileUtils_1.default.getMainfestInfo(this.projectPath);
-            const appRunDir = '/data/app';
-            ColorConsole_1.default.log(`### Emulator ### Pushing ${appPackageName} to ${appRunDir}`);
-            (0, child_process_1.execSync)(`adb -s ${sn} shell mkdir ${appRunDir}/${appPackageName}`, { stdio: 'ignore' });
-            yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} push ${sourceRoot}/* ${appRunDir}/${appPackageName}`);
-            ColorConsole_1.default.log(`### Emulator ### Push ${appPackageName} to ${appRunDir} successfully`);
+            return res;
         });
     }
     /** 杀死进程 */
@@ -262,8 +149,10 @@ class CommonInstance {
     }
     /** 重启模拟器 */
     restart() {
-        this.stop();
-        this.start(this.startOptions);
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.stop();
+            this.start(this.startOptions);
+        });
     }
     /** 创建server */
     createWebsockeServer() {

package/lib/instance/dev.d.ts

@@ -3,13 +3,33 @@ import CommonInstance from './common';
 declare class GoldfishInstance extends CommonInstance {
     private appRunDir;
     constructor(params: INewGoldfishInstanceParams);
-    /** 在goldfish模拟器中运行快应用 */
+    /**
+     * 1. 启动模拟器
+     * 2. 启动成功后，adb连接模拟器
+     * 3. 连接成功后，在模拟器中启动快应用
+     */
     start(options: IStartOptions): Promise<void>;
-    /** 在goldfish中启动快应用 */
+    /**
+     * 在模拟器中启动快应用
+     * 通过vapp命令启动，调试时需额外配置--jsdebugger参数
+     * @param options
+     */
     startupQuickApp(options: IStartOptions): Promise<void>;
-    /** 启动goldfish模拟器 */
+    /**
+     * 启动模拟器
+     * 1. 通过options生成模拟器的启动命令
+     * 2. 执行启动命令
+     * 3. 判断模拟器是否启动成功
+     *    3.1 若disableNSH=true，输出流中匹配到(NSH)，认为模拟器启动成功了
+     *    3.2 若disableNSH=false，认为2s过后模拟器启动成功了
+     * @param options
+     * @returns
+     */
     startGoldfish(options: IStartOptions): Promise<void>;
-    /** 将打包后的文件推到挂载的快应用目录 */
+    /**
+     * 将目录通过adb push到模拟器中
+     * @param sourceRoot
+     */
     pushRpk(sourceRoot: string): Promise<void>;
 }
 export default GoldfishInstance;

package/lib/instance/dev.js

@@ -39,18 +39,23 @@ const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/C
 const adbMiwt = __importStar(require("@miwt/adb"));
 const child_process_1 = require("child_process");
 const path_1 = __importDefault(require("path"));
-const portfinder_1 = __importDefault(require("portfinder"));
 const constants_1 = require("../static/constants");
 const common_1 = __importDefault(require("./common"));
+const os_1 = __importDefault(require("os"));
 class GoldfishInstance extends common_1.default {
     constructor(params) {
         super(params);
         this.appRunDir = '/data/app';
     }
-    /** 在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);
             const connected = yield this.connectGoldfish();
@@ -71,14 +76,18 @@ class GoldfishInstance extends common_1.default {
             }
         });
     }
-    /** 在goldfish中启动快应用 */
+    /**
+     * 在模拟器中启动快应用
+     * 通过vapp命令启动，调试时需额外配置--jsdebugger参数
+     * @param options
+     */
     startupQuickApp(options) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const { package: packageName } = this.projectInfo;
-                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} &`;
                 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'，否则快应用无法运行成功
@@ -89,7 +98,16 @@ class GoldfishInstance extends common_1.default {
             }
         });
     }
-    /** 启动goldfish模拟器 */
+    /**
+     * 启动模拟器
+     * 1. 通过options生成模拟器的启动命令
+     * 2. 执行启动命令
+     * 3. 判断模拟器是否启动成功
+     *    3.1 若disableNSH=true，输出流中匹配到(NSH)，认为模拟器启动成功了
+     *    3.2 若disableNSH=false，认为2s过后模拟器启动成功了
+     * @param options
+     * @returns
+     */
     startGoldfish(options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -98,21 +116,20 @@ class GoldfishInstance extends common_1.default {
             ColorConsole_1.default.log(`### Emulator ### emulator path: ${emulatorBin}`);
             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`;
+            let portMappingStr = `-network-user-mode-options hostfwd=tcp:127.0.0.1:${options.adbPort}-10.0.2.15:5555`;
             if (devtool) {
-                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(this.sdkHome, 'tools/image/system.img');
-            const dataImageBin = path_1.default.resolve(this.sdkHome, 'tools/image/data.img');
+            const systemImageBin = path_1.default.resolve(avdImagePath, 'system.img');
+            const dataImageBin = path_1.default.resolve(avdImagePath, 'data.img');
             const imageMountStr = `-drive index=0,id=system,if=none,format=raw,file=${systemImageBin} \
 -device virtio-blk-device,bus=virtio-mmio-bus.0,drive=system \
 -drive index=1,id=userdata,if=none,format=raw,file=${dataImageBin} \
@@ -135,23 +152,26 @@ class GoldfishInstance extends common_1.default {
             return new Promise((resolve) => {
                 var _a, _b;
                 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);
+                    }
+                });
                 if (options.disableNSH) {
-                    (_a = this.goldfishProcess.stdout) === null || _a === void 0 ? void 0 : _a.on('data', (data) => {
-                        if (options.stdoutCallback) {
-                            options.stdoutCallback(data);
-                        }
-                        else {
-                            console.log(data.toString());
-                        }
+                    (_b = this.goldfishProcess.stdout) === null || _b === void 0 ? void 0 : _b.on('data', (data) => {
+                        const msg = data.toString();
+                        const stdoutCb = options.stdoutCallback || console.log;
+                        stdoutCb(msg);
                         if (data.toString().includes('(NSH)')) {
                             ColorConsole_1.default.log(`### Emulator ### Goldfish emulator starts successfully`);
                             resolve();
                         }
                     });
-                    (_b = this.goldfishProcess.stderr) === null || _b === void 0 ? void 0 : _b.on('data', (data) => {
-                        const stderrCb = options.stderrCallback || console.log;
-                        stderrCb(data.toString());
-                    });
                 }
                 else {
                     setTimeout(() => {
@@ -159,25 +179,31 @@ class GoldfishInstance extends common_1.default {
                         resolve();
                     }, 2000);
                 }
-                this.goldfishProcess.on('exit', (code) => {
-                    ColorConsole_1.default.error(`### Emulator ### Goldfish emulator exited with code ${code}`);
-                    if (options.exitCallback) {
-                        options.exitCallback(code);
-                    }
-                });
             });
         });
     }
-    /** 将打包后的文件推到挂载的快应用目录 */
+    /**
+     * 将目录通过adb push到模拟器中
+     * @param sourceRoot
+     */
     pushRpk(sourceRoot) {
         return __awaiter(this, void 0, void 0, function* () {
-            const sn = `127.0.0.1:${this.adbPort}`;
+            const sn = `127.0.0.1:${this.startOptions.adbPort}`;
             const { package: appPackageName } = this.projectInfo;
-            const sourcePath = path_1.default.resolve(sourceRoot, './*');
-            ColorConsole_1.default.log(`### Emulator ### Pushing ${appPackageName} to ${this.appRunDir}`);
-            yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} shell mkdir ${this.appRunDir}/${appPackageName}`);
-            yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} push ${sourcePath} ${this.appRunDir}/${appPackageName}`);
-            ColorConsole_1.default.log(`### Emulator ### Push ${appPackageName} to ${this.appRunDir} successfully`);
+            // 获取最后一层目录，比如build
+            const basename = path_1.default.basename(sourceRoot);
+            if (os_1.default.platform() === 'win32' || this.projectPath.indexOf(' ') > 0) {
+                // windows系统或者项目路径有空格：1. adb push目录；2. 在模拟器中使用mv命令重命名
+                yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} push ${sourceRoot} ${this.appRunDir}`);
+                yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} shell  mv ${this.appRunDir}/${basename} ${this.appRunDir}/${appPackageName}`);
+            }
+            else {
+                // 支持通配符处理: 1. 模拟器中mkdir创建目录 2. adb push ./XXXXX/* /XXX
+                const sourcePath = path_1.default.resolve(sourceRoot, './*');
+                yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} shell mkdir ${this.appRunDir}/${appPackageName}`);
+                yield adbMiwt.execAdbCmdAsync(`adb -s ${sn} push "${sourcePath}" ${this.appRunDir}/${appPackageName}`);
+            }
+            ColorConsole_1.default.info(`### Emulator push to ${this.appRunDir}/${appPackageName} successfully`);
         });
     }
 }

package/lib/instance/index.d.ts

@@ -3,5 +3,11 @@ import CommonInstance from './common';
 import GoldfishInstance from './dev';
 import MiwearInstance from "./miwear";
 import OldGoldfishInstance from './preDev';
+/**
+ * 根据镜像决定使用哪个instance
+ * Vela正式版(4.0) -> MiwearInstance
+ * Vela开发版（dev, 0.0.2) -> OldGoldfishInstance
+ * Vela开发版（dev)，除0.0.2的其他版本 -> GoldfishInstance
+ */
 declare function findInstance(avdName: string, params: INewGoldfishInstanceParams): GoldfishInstance | MiwearInstance | OldGoldfishInstance | undefined;
 export { CommonInstance, GoldfishInstance, MiwearInstance, OldGoldfishInstance, findInstance };

package/lib/instance/index.js

@@ -14,6 +14,12 @@ const miwear_1 = __importDefault(require("./miwear"));
 exports.MiwearInstance = miwear_1.default;
 const preDev_1 = __importDefault(require("./preDev"));
 exports.OldGoldfishInstance = preDev_1.default;
+/**
+ * 根据镜像决定使用哪个instance
+ * Vela正式版(4.0) -> MiwearInstance
+ * Vela开发版（dev, 0.0.2) -> OldGoldfishInstance
+ * Vela开发版（dev)，除0.0.2的其他版本 -> GoldfishInstance
+ */
 function findInstance(avdName, params) {
     const { sdkHome, avdHome } = params;
     const { avdImagePath } = new avd_1.default({ sdkHome, avdHome }).getVelaAvdInfo(avdName);

package/lib/instance/miwear.d.ts

@@ -2,7 +2,7 @@ import { INewGoldfishInstanceParams, IStartOptions } from '../typing/Instance';
 import CommonInstance from './common';
 /**
  * MiwearInstance
- * 针对 vela4.0 的镜像
+ * 针对 Vela正式版（4.0）的镜像
  */
 declare class MiwearInstance extends CommonInstance {
     private params;
@@ -10,20 +10,71 @@ declare class MiwearInstance extends CommonInstance {
     private debugSocket?;
     private reconnectCount;
     constructor(params: INewGoldfishInstanceParams);
-    /** 在goldfish模拟器中运行快应用 */
+    /**
+     * 1. 启动模拟器
+     * 2. 启动成功后，adb连接模拟器
+     * 3. 连接成功后，在模拟器中启动快应用
+     */
     start(options: IStartOptions): 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>;
-    /** 在goldfish中启动快应用 */
+    /**
+     * 通过adb连接模拟器。
+     * 时间限制为2分钟，超时则表示连接失败
+     * 注意：两次connect之间不能等待，否则在disableNSH=true且有vncPort的模式下，模拟器启动成功了，但是vnc可能还没连接上
+     *      时间限制不能太短，否则模拟器里面的adbd进程还没初始化成功
+     * @returns
+     */
+    connectGoldfish(): Promise<unknown>;
+    /**
+     * 在模拟器中启动快应用
+     * 1. 检查release目录是否有打包好的rpk
+     * 2. 检查当前是否为调试模式.
+     *    若是，将debugger_ip.cfg推到模拟器的/data/目录下
+     *    若否，则要删除模拟器中已有的data/debugger_ip.cfg
+     * 3. 调用installRpkToAppList将当前快应用安装到模拟器的应用列表中
+     * @param options
+     */
     startupQuickApp(options: IStartOptions): Promise<void>;
-    /** 将快应用安装到应用列表 */
+    /**
+     * 将快应用安装到模拟器的应用列表
+     * 1. 使用adb push将打包好的rpk推到模拟器的/data/quickapp/app/
+     * 2. nsh中调用pm install命令安装应用
+     * @param rpkPath rpk的绝对目录
+     * @param targetDir 要将rpk放到模拟器的哪个目录下
+     */
     installRpkToAppList(rpkPath: string, targetDir: string): Promise<void>;
+    /** 连接模拟器中的调试服务，创建debugSocket
+     * 主要用于热更新时，通过debugSocket通知调试服务更新页面
+     * 设置了重连机制，会重复连接8次
+     */
     initDebugSocket(): Promise<void>;
-    /** 通知模拟器更新 */
+    /** 通知模拟器更新
+     * 1. 确保已经成功连接模拟器中的调试服务
+     * 2. 使用adb push将build文件下的内容推到/data/quickapp/app/${packageName}
+     * 3. 发送Page.reload命令给调试服务，通知更新
+    */
     handleUpdate(): Promise<void>;
-    /** 创建server */
+    /** 热更新时push目录 */
+    pushBuild(): Promise<void>;
+    /** 在模拟器中重启快应用（基于am命令，需要保证镜像中已经有am功能）
+     * 1. 使用adb push将build文件下的内容推到/data/quickapp/app/${packageName}
+     * 2. nsh中执行am stop命令退出快应用
+     * 3. nsh中执行am start命令启动快应用
+    */
+    reloadApp(): Promise<void>;
+    /**
+     * 创建server端，监听打包过程中client端发来的消息
+     */
     createWebsockeServer(): Promise<void>;
 }
 export default MiwearInstance;