@aiot-toolkit/emulator 2.0.2-beta.1 → 2.0.2-beta.10

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

@@ -8,6 +8,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const constants_1 = require("../static/constants");
 const Avd_1 = require("../typing/Avd");
+const os_1 = __importDefault(require("os"));
 const EAvdParamsToIni = {
     'arm': {
         abiType: 'armeabi-v7a',
@@ -25,7 +26,21 @@ 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');
+        if (!fs_1.default.existsSync(advancedFeaturesIni)) {
+            const iniSourcePath = path_1.default.join(__dirname, '../static/advancedFeatures.ini');
+            fs_1.default.copyFileSync(iniSourcePath, advancedFeaturesIni);
+        }
         const { avdName, avdArch, avdWidth, avdHeight, avdSkin, avdImagePath = constants_1.defaultImageHome } = avdParams;
         const avdDir = path_1.default.resolve(this.avdHome, `${avdName}.avd`);
         const avdIni = path_1.default.resolve(this.avdHome, `${avdName}.ini`);
@@ -69,6 +84,7 @@ class VelaAvdCls {
             throw (`createVelaAvd: ${e.message}`);
         }
     }
+    /** 根据AVD名字获取模拟器的详细信息 */
     getVelaAvdInfo(avdName) {
         const avdInfo = {
             avdName,
@@ -105,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`);
@@ -117,6 +134,7 @@ class VelaAvdCls {
             return false;
         }
     }
+    /** 获取已经创建的模拟器列表 */
     getVelaAvdList() {
         const avdList = [];
         const files = fs_1.default.readdirSync(this.avdHome);
@@ -131,6 +149,7 @@ class VelaAvdCls {
         }
         return avdList;
     }
+    /** 获取模拟器皮肤列表 */
     getVelaSkinList() {
         try {
             const skinList = [];

package/lib/instance/common.d.ts

@@ -10,34 +10,33 @@ 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;
+    isDistributedApp: 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连接模拟器。
+     * 时间限制为 @param timeout 秒，超时则表示连接失败
+     * @returns
+     */
+    connectGoldfish(timeout?: number): Promise<unknown>;
     /** 杀死进程 */
     killProcess(currProcess?: ChildProcess): void;
     /** 停止模拟器并释放相关资源 */
     stop(): Promise<void>;
     /** 重启模拟器 */
-    restart(): void;
+    restart(): Promise<void>;
     /** 创建server */
     createWebsockeServer(): Promise<void>;
+    connectDevice(): Promise<string | void>;
 }
 export default CommonInstance;

package/lib/instance/common.js

@@ -41,23 +41,28 @@ 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");
 const utils_1 = require("../utils");
+const fs_extra_1 = __importDefault(require("fs-extra"));
 /**
  * CommonInstance
  */
 class CommonInstance {
     constructor(params) {
-        this.adbPort = 5555;
-        this.debugPort = 10055;
         this.isFirstStart = true;
+        this.isDistributedApp = false;
         this.projectPath = params.projectPath;
         this.sdkHome = params.sdkHome || constants_1.defaultSDKHome;
         this.avdHome = params.avdHome || constants_1.defaultAvdHome;
         this.isRpk = params.sourceRoot === './';
+        const projectJsonFile = path_1.default.resolve(this.projectPath, '.project.json');
+        const projectJsonExist = fs_extra_1.default.existsSync(projectJsonFile);
+        if (projectJsonExist) {
+            const projectJsonInfo = fs_extra_1.default.readJSONSync(projectJsonFile);
+            this.isDistributedApp = projectJsonInfo.projectType === 'distributed';
+        }
         this.velaAvdCls = new avd_1.default({
             sdkHome: this.sdkHome,
             avdHome: this.avdHome
@@ -74,154 +79,50 @@ 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连接模拟器 */
-    connectGoldfish() {
+    /**
+     * 通过adb连接模拟器。
+     * 时间限制为 @param timeout 秒，超时则表示连接失败
+     * @returns
+     */
+    connectGoldfish(timeout = 10) {
         return __awaiter(this, void 0, void 0, function* () {
-            let adbConnected = false;
+            let adbConnected = false; // adb是否连接成功
+            let enableLoop = true; // 是否允许循环，用于终止adb的连接
+            let needKill = 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);
+                while (enableLoop && !adbConnected) {
+                    if (needKill) {
+                        const adbKillCmd = `adb kill-server`;
+                        ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${adbKillCmd}`);
+                        yield adbMiwt.execAdbCmdAsync(adbKillCmd);
+                    }
+                    const str = yield this.connectDevice();
                     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;
+                    const curDev = devices.find((t) => t.sn === this.sn);
+                    if ((curDev === null || curDev === void 0 ? void 0 : curDev.status) === 'offline')
+                        needKill = true;
+                    adbConnected = devices.some((item) => item.sn === this.sn && item.status === 'device');
                 }
-                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(() => {
+                        if (!adbConnected) {
+                            enableLoop = false;
+                        }
+                        // 超时则认为adb没有连接成功
+                        resolve(false);
+                    }, timeout * 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;
         });
     }
     /** 杀死进程 */
@@ -246,7 +147,7 @@ class CommonInstance {
     }
     /** 停止模拟器并释放相关资源 */
     stop() {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             if (this.goldfishProcess) {
                 // Linux删除goldfishProcess后，子进程仍存在，导致模拟器窗口未关闭
@@ -255,29 +156,34 @@ class CommonInstance {
                 //   process.kill(this.goldfishProcess.pid + 1)
                 // }
                 this.killProcess(this.goldfishProcess);
-                yield (0, utils_1.killProcessByCmd)((_a = this.startOptions) === null || _a === void 0 ? void 0 : _a.avdName);
+                if ((_a = this.startOptions) === null || _a === void 0 ? void 0 : _a.avdName) {
+                    const emulatorProcessFlag = `-avd ${(_b = this.startOptions) === null || _b === void 0 ? void 0 : _b.avdName} -avd-arch`;
+                    yield (0, utils_1.killProcessByCmd)(emulatorProcessFlag);
+                }
                 this.goldfishProcess = undefined;
             }
         });
     }
     /** 重启模拟器 */
     restart() {
-        this.stop();
-        this.start(this.startOptions);
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.stop();
+            this.start(this.startOptions);
+        });
     }
     /** 创建server */
     createWebsockeServer() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const wsServer = new ws_1.WebSocketServer({
-                port: (_a = this.startOptions) === null || _a === void 0 ? void 0 : _a.serverPort,
+                port: (_a = this.startOptions) === null || _a === void 0 ? void 0 : _a.serverPort
             });
-            wsServer.on('connection', socket => {
+            wsServer.on('connection', (socket) => {
                 ColorConsole_1.default.success(`### App Socket server ### Websocket connects to websocket server`);
-                socket.on('error', err => {
+                socket.on('error', (err) => {
                     ColorConsole_1.default.error(`### App Socket server ### Websocket server error: ${err.message}`);
                 });
-                socket.on('message', data => {
+                socket.on('message', (data) => {
                     const message = JSON.parse(data.toString());
                     ColorConsole_1.default.log(`### App Socket server ### Websocket server get data: ${data}`);
                     if (message.type === 'restart') {
@@ -290,5 +196,32 @@ class CommonInstance {
             });
         });
     }
+    connectDevice() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const adbConnectCmd = `adb connect ${this.sn}`;
+            ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${adbConnectCmd}`);
+            let pending = true;
+            const p1 = adbMiwt.execAdbCmdAsync(adbConnectCmd);
+            let timer;
+            // 超过一定时间还没有连接成功，则 kill-server 后再试
+            // 用于处理 adb connect 一直 pending 的情况
+            const p2 = new Promise((resolve, reject) => {
+                timer = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+                    if (pending) {
+                        const adbKillCmd = `adb kill-server`;
+                        ColorConsole_1.default.log(`### Emulator ### Excuting adb cmd: ${adbKillCmd}`);
+                        yield adbMiwt.execAdbCmdAsync(adbKillCmd);
+                    }
+                    resolve();
+                }), 10 * 1000);
+            });
+            p1.then((r) => {
+                pending = false;
+                clearTimeout(timer);
+                console.log(r);
+            });
+            return Promise.race([p1, p2]);
+        });
+    }
 }
 exports.default = CommonInstance;

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;