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

package/lib/instance/preDev.js

@@ -46,25 +46,40 @@ 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');
+            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 +92,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 +118,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 +144,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 +153,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;
+            const { avdName, devtool, origin = 'terminal' } = 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 = '';
@@ -187,67 +221,43 @@ class OldGoldfishInstance extends common_1.default {
             ];
             ColorConsole_1.default.log(`### Emulator ### Start CMD: ${spawnBin} ${spawnArgs.join(' ')}`);
             return new Promise((resolve) => {
-                var _a;
-                this.goldfishProcess = (0, child_process_1.spawn)(spawnBin, spawnArgs, { stdio: stdioType, shell: true });
+                var _a, _b, _c, _d;
+                this.goldfishProcess = (0, child_process_1.spawn)(spawnBin, spawnArgs, { stdio: 'pipe', 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());
                 });
+                if (origin === 'terminal') {
+                    process.stdout.pipe(this.goldfishProcess.stdin);
+                    (_b = this.goldfishProcess.stdout) === null || _b === void 0 ? void 0 : _b.pipe(process.stdout);
+                }
+                // 监听模拟器的退出事件
                 this.goldfishProcess.on('exit', (code) => {
                     ColorConsole_1.default.error(`### Emulator ### Goldfish emulator exited with code ${code}`);
                     if (options.exitCallback) {
                         options.exitCallback(code);
                     }
                 });
-                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) => {
+                // 监听输出流。输出了'(NSH)'标识后则认为模拟器启动成功
+                (_d = (_c = this.goldfishProcess) === null || _c === void 0 ? void 0 : _c.stdout) === null || _d === void 0 ? void 0 : _d.on('data', (data) => {
+                    const msg = data.toString();
+                    if (origin === 'ide') {
                         const stdoutCb = options.stdoutCallback || console.log;
-                        stdoutCb(data.toString());
-                        if (data.toString().includes('(NSH)')) {
-                            ColorConsole_1.default.log(`### Emulator ### Goldfish emulator starts successfully`);
-                            resolve();
-                        }
-                    });
+                        stdoutCb(msg);
+                    }
+                    if (msg.includes('(NSH)')) {
+                        ColorConsole_1.default.log(`### Emulator ### Goldfish emulator starts successfully`);
+                        resolve();
+                    }
                 });
-                const p2 = setTimeout(() => {
-                    ColorConsole_1.default.log(`### Emulator ### Goldfish emulator starts successfully`);
-                    resolve();
-                }, 2000);
-                return Promise.race([p1, p2]);
             });
         });
     }
-    /** 通过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/advancedFeatures.ini

@@ -0,0 +1 @@
+ModemSimulator = on

package/lib/static/constants.d.ts

@@ -6,14 +6,19 @@ export declare const defaultSkinHome: string;
 export declare const defaultQuickappHome: string;
 export declare const defaultToolsHome: string;
 export declare const defaultVncPort = 5900;
-export declare const emulatorEnvVersion: {
+export declare const defaultAdbPort = 5555;
+export declare const defaultDebugPort = 10055;
+export declare const VelaImageVersionList: {
+    label: string;
+    value: string;
+    time: string;
+}[];
+export declare const EmulatorEnvVersion: {
     name: string;
     emulator: string;
     qa: string;
     skins: string;
-    'system-images': {
-        release: string;
-        dev: string;
-    };
+    'system-images': string;
     tools: string;
+    modem_simulator: string;
 };

package/lib/static/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.emulatorEnvVersion = exports.defaultVncPort = exports.defaultToolsHome = exports.defaultQuickappHome = exports.defaultSkinHome = exports.defaultEmulatorHome = exports.defaultImageHome = exports.defaultAvdHome = exports.defaultSDKHome = void 0;
+exports.EmulatorEnvVersion = exports.VelaImageVersionList = exports.defaultDebugPort = exports.defaultAdbPort = exports.defaultVncPort = exports.defaultToolsHome = exports.defaultQuickappHome = exports.defaultSkinHome = exports.defaultEmulatorHome = exports.defaultImageHome = exports.defaultAvdHome = exports.defaultSDKHome = void 0;
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 exports.defaultSDKHome = path_1.default.resolve(os_1.default.homedir(), '.export');
@@ -14,14 +14,26 @@ exports.defaultSkinHome = path_1.default.resolve(exports.defaultSDKHome, 'skins'
 exports.defaultQuickappHome = path_1.default.resolve(exports.defaultSDKHome, 'qa');
 exports.defaultToolsHome = path_1.default.resolve(exports.defaultSDKHome, 'tools');
 exports.defaultVncPort = 5900;
-exports.emulatorEnvVersion = {
+exports.defaultAdbPort = 5555;
+exports.defaultDebugPort = 10055;
+exports.VelaImageVersionList = [
+    {
+        label: 'vela正式版（4.0）',
+        value: 'vela-release-4.0',
+        time: '2024-04-10T04:10:00'
+    },
+    {
+        label: 'vela开发版（dev, 0.0.2）',
+        value: 'vela-dev-0.0.2',
+        time: '2023-12-04T16:31:00',
+    },
+];
+exports.EmulatorEnvVersion = {
     name: '模拟器资源版本管理',
-    emulator: '0.0.1',
+    emulator: '0.0.3',
     qa: '0.0.1',
     skins: '0.0.1',
-    'system-images': {
-        release: '4.0',
-        dev: '0.0.2'
-    },
-    tools: '0.0.2'
+    'system-images': exports.VelaImageVersionList[0].value,
+    tools: '0.0.2',
+    modem_simulator: '0.0.1'
 };

package/lib/typing/Instance.d.ts

@@ -1,16 +1,26 @@
 /// <reference types="node" />
-import { IAvdResourcePaths } from "./Avd";
+import IJavascriptCompileOption from '@aiot-toolkit/aiotpack/lib/compiler/javascript/interface/IJavascriptCompileOption';
+import { IAvdResourcePaths } from './Avd';
 export interface INewGoldfishInstanceParams extends IAvdResourcePaths {
     projectPath: string;
     sourceRoot?: string;
+    compilerOption?: Partial<IJavascriptCompileOption>;
 }
 export interface IStartOptions {
     avdName: string;
     devtool?: string;
+    /** @deprecated */
     disableNSH?: boolean;
+    origin?: 'ide' | 'terminal';
     serverPort?: number;
     vncPort?: number;
+    adbPort: number;
+    debugPort?: number;
     stdoutCallback?: (buffer: Buffer) => void;
     stderrCallback?: (buffer: Buffer) => void;
     exitCallback?: (code: number | null) => void;
+    /** 要推送的目录路径 */
+    dist?: string;
+    /** 要推送到的目的路径 */
+    tar?: string;
 }

package/lib/utils/index.d.ts

@@ -9,4 +9,5 @@ export declare function killProcessByPid(pid: string): void;
  * 根据命令杀死进程
  */
 export declare function killProcessByCmd(cmd: string): Promise<void>;
+/** 延迟函数 */
 export declare function sleep(time: number): Promise<void>;

package/lib/utils/index.js

@@ -79,6 +79,7 @@ function killProcessByCmd(cmd) {
     });
 }
 exports.killProcessByCmd = killProcessByCmd;
+/** 延迟函数 */
 function sleep(time) {
     return __awaiter(this, void 0, void 0, function* () {
         return new Promise(resolve => setTimeout(resolve, time));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiot-toolkit/emulator",
-  "version": "2.0.2-beta.1",
+  "version": "2.0.2-beta.10",
   "description": "vela emulator tool.",
   "homepage": "",
   "license": "ISC",
@@ -35,10 +35,14 @@
     "emulator"
   ],
   "dependencies": {
-    "@aiot-toolkit/aiotpack": "2.0.2-beta.1",
-    "@aiot-toolkit/shared-utils": "2.0.2-beta.1",
+    "@aiot-toolkit/aiotpack": "2.0.2-beta.10",
+    "@aiot-toolkit/shared-utils": "2.0.2-beta.10",
     "find-process": "^1.4.7",
     "portfinder": "^1.0.32"
   },
-  "gitHead": "9244af36e617295ea4ff11a2f4f07f0e4f9f5f59"
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "fs-extra": "^11.2.0"
+  },
+  "gitHead": "00d23c1ad1306a6c72bb007685de9fd4a6ee61af"
 }