@aiot-toolkit/emulator 2.0.2-dev.8 → 2.0.3-beta.1

package/lib/instance/index.d.ts

@@ -1,7 +1,15 @@
 import { INewGoldfishInstanceParams } from '../typing/Instance';
 import CommonInstance from './common';
 import GoldfishInstance from './dev';
-import MiwearInstance from "./miwear";
+import MiwearInstance from './miwear';
 import OldGoldfishInstance from './preDev';
+import PreInstance from './pre';
+/**
+ * 根据镜像决定使用哪个instance
+ * Vela正式版(4.0) -> MiwearInstance
+ * Vela正式版(不带 miwear 版本) -> PreInstance
+ * 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 };
+export { CommonInstance, GoldfishInstance, MiwearInstance, OldGoldfishInstance, PreInstance, findInstance };

package/lib/instance/index.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findInstance = exports.OldGoldfishInstance = exports.MiwearInstance = exports.GoldfishInstance = exports.CommonInstance = void 0;
+exports.PreInstance = exports.OldGoldfishInstance = exports.MiwearInstance = exports.GoldfishInstance = exports.CommonInstance = void 0;
+exports.findInstance = findInstance;
 const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
 const avd_1 = __importDefault(require("../avd"));
 const common_1 = __importDefault(require("./common"));
@@ -14,6 +15,15 @@ const miwear_1 = __importDefault(require("./miwear"));
 exports.MiwearInstance = miwear_1.default;
 const preDev_1 = __importDefault(require("./preDev"));
 exports.OldGoldfishInstance = preDev_1.default;
+const pre_1 = __importDefault(require("./pre"));
+exports.PreInstance = pre_1.default;
+/**
+ * 根据镜像决定使用哪个instance
+ * Vela正式版(4.0) -> MiwearInstance
+ * Vela正式版(不带 miwear 版本) -> PreInstance
+ * 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);
@@ -21,6 +31,9 @@ function findInstance(avdName, params) {
         ColorConsole_1.default.throw(`### Emulator ### Unable to find vela image via avd`);
         return;
     }
+    if (avdImagePath.includes('vela-pre-4.0')) {
+        return new pre_1.default(params);
+    }
     if (avdImagePath.includes('release')) {
         return new miwear_1.default(params);
     }
@@ -29,4 +42,3 @@ function findInstance(avdName, params) {
     }
     return new dev_1.default(params);
 }
-exports.findInstance = findInstance;

package/lib/instance/miwear.d.ts

@@ -1,28 +1,82 @@
+import readline from 'readline';
 import { INewGoldfishInstanceParams, IStartOptions } from '../typing/Instance';
 import CommonInstance from './common';
 /**
  * MiwearInstance
- * 针对 vela4.0 的镜像
+ * 针对 Vela正式版（4.0）的镜像
  */
 declare class MiwearInstance extends CommonInstance {
-    private appPathInEmulator;
+    private params;
+    private appDir;
     private debugSocket?;
     private reconnectCount;
+    stdoutReadline: readline.Interface;
+    stderrReadline: readline.Interface;
     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中启动快应用 */
+    /**
+     * 在模拟器中启动快应用
+     * 1. 检查release目录是否有打包好的rpk
+     * 2. 检查当前是否为调试模式.
+     *    若是，将debugger_ip.cfg推到模拟器的/data/目录下
+     *    若否，则要删除模拟器中已有的data/debugger_ip.cfg
+     * 3. 调用installRpkToAppList将当前快应用安装到模拟器的应用列表中
+     * @param options
+     */
     startupQuickApp(options: IStartOptions): Promise<void>;
-    /** 将快应用安装到应用列表 */
-    installRpkToAppList(rpkPath: string, targetDir: string): Promise<void>;
-    initDebugSocket(): Promise<void> | undefined;
-    /** 通知模拟器更新 */
+    /**
+     * 将快应用安装到模拟器的应用列表
+     * 1. 使用adb push将打包好的rpk推到模拟器的/data/quickapp/app/
+     * 2. nsh中调用pm install命令安装应用
+     * @param rpkPath rpk的绝对目录
+     * @param targetDir 要将rpk放到模拟器的哪个目录下
+     */
+    pushAndInstall(rpkPath: string, targetDir: string): Promise<void>;
+    /** 使用am start启动快应用 */
+    launchQuickapp(): 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>;
+    /** 通过命令行启动时，在watich模式下监听websocket消息，
+     * 在文件发生变动时，重新启动应用
+     */
+    restart(): Promise<void>;
+    /** 在模拟器中重启快应用（基于am命令，需要保证镜像中已经有am功能）
+     * 1. 使用adb push将build文件下的内容推到/data/quickapp/app/${packageName}
+     * 2. nsh中执行am stop命令退出快应用
+     * 3. nsh中执行am start命令启动快应用
+     */
+    pushAndReloadApp(): Promise<void>;
+    reloadApp(): Promise<void>;
+    /**
+     * 创建server端，监听打包过程中client端发来的消息
+     */
     createWebsockeServer(): Promise<void>;
 }
 export default MiwearInstance;