@aiot-toolkit/emulator 2.0.5-beta.11 → 2.0.5-beta.12

package/lib/static/proto/rtc_service.proto

@@ -0,0 +1,117 @@
+// Copyright (C) 2018 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Note that if you add/remove methods in this file you must update
+// the metrics sql as well by running ./android/scripts/gen-grpc-sql.py
+//
+// Please group deleted methods in a block including the date (MM/DD/YY)
+// it was removed. This enables us to easily keep metrics around after removal
+//
+// List of deleted methods
+// rpc iWasDeleted (03/12/12)
+// ...
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_package = "com.android.emulator.control";
+option objc_class_prefix = "AEC";
+
+package android.emulation.control;
+import "google/protobuf/empty.proto";
+
+// An RTC service lets you interact with the emulator through WebRTC
+// Note that this is currently an experimental feature, and that the
+// service definition might change without notice. Use at your own risk!
+//
+// The following endpoints are needed to establish the webrtc protocol
+// Due to limitiations in Javascript we cannot make use of bidirectional
+// endpoints See this [blog](https://grpc.io/blog/state-of-grpc-web) for
+// details.
+service Rtc {
+  // This function will generate a new identifier that the client
+  // should use for further interaction. It will initiate the
+  // JSEP protocol on the server side.
+  rpc requestRtcStream(google.protobuf.Empty) returns (RtcId) {}
+
+  // Sends the given JsepMsg to the server. The RtcId in the
+  // message should point to an active stream negotiation in
+  // progress, otherwise the message will be ignored.
+  rpc sendJsepMessage(JsepMsg) returns (google.protobuf.Empty) {}
+
+  // Reads an available jsep messages for the given client id,
+  // blocking until one becomes available. Do not use the polling version
+  // above if you opt for this one.
+  //
+  // The ice candidates for example will trickle in on this callback,
+  // as will the SDP negotation.
+  rpc receiveJsepMessages(RtcId) returns (stream JsepMsg) {}
+
+
+  // [DEPRECATED] This is only here as the go grpc webproxy used
+  // by fuchsia does not support server side streaming. This method
+  // will be removed in the future and should not be relied upon.
+  //
+  // Reads an available jsep messages for the given client id,
+  // blocking until one becomes available. Do not use the polling version
+  // above if you opt for this one.
+  //
+  // The ice candidates for example will trickle in on this callback,
+  // as will the SDP negotation.
+  rpc receiveJsepMessage(RtcId) returns (JsepMsg) {}
+}
+
+message RtcId {
+  // The unique identifier of this connection. You will have to use the
+  // same identifier when sending/receiving messages. The server will
+  // generate a guid when receiving the start message.
+  string guid = 1;
+}
+
+message JsepMsg {
+  // The unique identifier of this connection. You will have to use the
+  // same identifier when sending/receiving messages. The server will
+  // generate a guid when receiving the start message.
+  RtcId id = 1;
+  // The JSON payload. This usually can be directly handled by the
+  // Javascript library.
+  //
+  // The dictionary can contain the following properties
+  //
+  // - bye:
+  //        You can hang up now. No new message expected for you.
+  //        The server has stopped the RTC stream.
+  //
+  // - start:
+  //        An RTCConfiguration dictionary providing options to
+  //        configure the new connection. This can include the
+  //        turn configuration the serve is using. This dictionary can be
+  //        passed in directly to the
+  //        [RTCPeerConnection](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)
+  //        object.
+  //
+  // - candidate:
+  //        The WebRTC API's RTCIceCandidateInit dictionary, which
+  //        contains the information needed to fundamentally describe an
+  //        RTCIceCandidate. See
+  //        [RTCIceCandidate](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate)
+  //        and [Session
+  //        Lifetime](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Session_lifetime)
+  //        for more details.
+  //
+  // - sdp:
+  //        RTCSessionDescriptionInit dictionary containing the values
+  //        to that can be assigned to a
+  //        [RTCSessionDescription](https://developer.mozilla.org/en-US/docs/Web/API/RTCSessionDescription)
+  string message = 2;
+}

package/lib/vvd/grpc/grpcError.d.ts

@@ -0,0 +1 @@
+export declare function handleGrpcErrorMsg(err: Error | string): void;

package/lib/vvd/grpc/grpcError.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.handleGrpcErrorMsg = handleGrpcErrorMsg;
+function handleGrpcErrorMsg(err) {
+  if (typeof err === 'string') err = new Error(err);
+  console.error(err);
+}

package/lib/vvd/grpc/index.d.ts

@@ -0,0 +1,27 @@
+import { Readable } from 'stream';
+import { MouseEvent } from './types/MouseEvent';
+import { GrpcKeyboardEvent } from './types/KeyEvent';
+import { GrpcClient } from './types/GrpcClient';
+import { EmulatorConfig } from '../../emulatorutil/running';
+import { Metadata } from '@grpc/grpc-js';
+export default class GrpcEmulator {
+    eConf: EmulatorConfig;
+    protoPath: string;
+    client: GrpcClient;
+    connected: boolean;
+    token: string;
+    authMate: Metadata;
+    deadline: Date;
+    controller: any;
+    screenshotStream?: Readable;
+    constructor(eConf: EmulatorConfig, protoPath: string);
+    close(): void;
+    getAuthMeta(): Metadata;
+    waitForReady(): Promise<boolean>;
+    startStream(onStreamScreenshot: (buffer: Buffer) => void): Promise<void>;
+    getScreenshot(): Promise<Buffer>;
+    getStatus(): Promise<unknown>;
+    sendMouse(message: MouseEvent): void;
+    sendKey(data: GrpcKeyboardEvent): void;
+}
+export declare function createGrpcClient(eConf: EmulatorConfig): GrpcEmulator;

package/lib/vvd/grpc/index.js

@@ -0,0 +1,117 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createGrpcClient = createGrpcClient;
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _protoLoader = require("@grpc/proto-loader");
+var _grpcError = require("./grpcError");
+var _grpcJs = require("@grpc/grpc-js");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class GrpcEmulator {
+  connected = false;
+  constructor(eConf, protoPath) {
+    this.eConf = eConf;
+    this.protoPath = protoPath;
+    this.token = eConf['grpc.token'];
+    const packageDefinition = (0, _protoLoader.loadSync)(this.protoPath, {
+      keepCase: true,
+      longs: String,
+      enums: String,
+      defaults: true,
+      oneofs: true
+    });
+    this.deadline = new Date();
+    this.deadline.setMinutes(this.deadline.getMinutes() + 2);
+    this.controller = (0, _grpcJs.loadPackageDefinition)(packageDefinition).android.emulation.control;
+    const mateInfo = new _grpcJs.Metadata();
+    mateInfo.set('Authorization', `Bearer ${this.token}`);
+    this.authMate = mateInfo;
+    this.client = new this.controller.EmulatorController(`127.0.0.1:${eConf['grpc.port']}`, _grpcJs.credentials.createInsecure());
+  }
+  close() {
+    this.client.close();
+  }
+  getAuthMeta() {
+    const token = this.eConf['grpc.token'];
+    const mateInfo = new _grpcJs.Metadata();
+    mateInfo.set('Authorization', `Bearer ${token}`);
+    return mateInfo;
+  }
+  waitForReady() {
+    if (this.connected) {
+      return Promise.resolve(true);
+    }
+    return new Promise((resolve, reject) => {
+      this.client.waitForReady(this.deadline, err => {
+        if (err) {
+          this.connected = false;
+          console.error(err);
+          return reject(err);
+        }
+        this.connected = true;
+        resolve(true);
+      });
+    });
+  }
+  async startStream(onStreamScreenshot) {
+    await this.waitForReady();
+    if (this.screenshotStream) {
+      this.screenshotStream.destroy();
+    }
+    this.screenshotStream = this.client.streamScreenshot(this.controller.Image, this.authMate);
+    this.screenshotStream.on('data', response => {
+      onStreamScreenshot(response.image);
+    });
+    this.screenshotStream.on('error', err => {
+      console.error(err.message);
+    });
+  }
+  getScreenshot() {
+    return new Promise((resolve, reject) => {
+      this.client.getScreenshot(this.controller.Image, this.authMate, (err, response) => {
+        if (err) {
+          reject(err);
+        }
+        resolve(response.image);
+      });
+    });
+  }
+  getStatus() {
+    return new Promise((resolve, reject) => {
+      this.client.getStatus(this.controller.EmulatorStatus, this.authMate, (err, response) => {
+        if (err) {
+          console.error(err);
+          (0, _grpcError.handleGrpcErrorMsg)(err);
+          return reject(err);
+        }
+        response.hardwareConfig = Object.fromEntries(response.hardwareConfig.entry.map(t => [t.key, t.value]));
+        return resolve(response);
+      });
+    });
+  }
+  sendMouse(message) {
+    if (!this.connected) return;
+    const e = {
+      x: message.x,
+      y: message.y,
+      buttons: message.buttons
+    };
+    this.client.sendMouse(e, this.authMate, err => {
+      if (err) console.error(err);
+    });
+  }
+  sendKey(data) {
+    if (!this.connected) return;
+    this.client.sendKey(data, this.authMate, err => {
+      if (err) console.error(err);
+    });
+  }
+}
+exports.default = GrpcEmulator;
+function createGrpcClient(eConf) {
+  const protoPath = _path.default.join(__dirname, '../../static/proto/emulator_controller.proto');
+  return new GrpcEmulator(eConf, protoPath);
+}

package/lib/vvd/grpc/types/GrpcClient.d.ts

@@ -0,0 +1,4 @@
+import { Client } from '@grpc/grpc-js';
+export interface GrpcClient extends Client {
+    [i: string]: any;
+}

package/lib/vvd/grpc/types/GrpcClient.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/lib/vvd/grpc/types/KeyEvent.d.ts

@@ -0,0 +1,19 @@
+export declare enum KeyEventType {
+    KEYDOWN = 0,
+    KEYUP = 1,
+    KEYPRESS = 2
+}
+export declare enum KeyCodeType {
+    USB = 0,
+    EVDEV = 1,
+    XKB = 2,
+    WIN = 3,
+    MAC = 4
+}
+export interface GrpcKeyboardEvent {
+    codeType?: KeyCodeType;
+    eventType?: KeyEventType;
+    keyCode?: number | string;
+    key?: string;
+    text?: string;
+}

package/lib/vvd/grpc/types/KeyEvent.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.KeyEventType = exports.KeyCodeType = void 0;
+let KeyEventType = exports.KeyEventType = /*#__PURE__*/function (KeyEventType) {
+  KeyEventType[KeyEventType["KEYDOWN"] = 0] = "KEYDOWN";
+  KeyEventType[KeyEventType["KEYUP"] = 1] = "KEYUP";
+  KeyEventType[KeyEventType["KEYPRESS"] = 2] = "KEYPRESS";
+  return KeyEventType;
+}({});
+let KeyCodeType = exports.KeyCodeType = /*#__PURE__*/function (KeyCodeType) {
+  KeyCodeType[KeyCodeType["USB"] = 0] = "USB";
+  KeyCodeType[KeyCodeType["EVDEV"] = 1] = "EVDEV";
+  KeyCodeType[KeyCodeType["XKB"] = 2] = "XKB";
+  KeyCodeType[KeyCodeType["WIN"] = 3] = "WIN";
+  KeyCodeType[KeyCodeType["MAC"] = 4] = "MAC";
+  return KeyCodeType;
+}({});

package/lib/vvd/grpc/types/MouseEvent.d.ts

@@ -0,0 +1,30 @@
+export interface MouseEvent {
+    /**
+     * The horizontal coordinate. This is the physical location on the
+     * screen For example 0 indicates the leftmost coordinate.
+     */
+    x?: number;
+    /**
+     * The vertical coordinate. This is the physical location on the screen
+     * For example 0 indicates the top left coordinate.
+     */
+    y?: number;
+    /**
+     * Indicates which buttons are pressed.
+     * 0: No button was pressed
+     * 1: Primary button (left)
+     * 2: Secondary button (right)
+     */
+    buttons?: number;
+    /**
+     * The display device where the mouse event occurred.
+     * Omitting or using the value 0 indicates the main display.
+     */
+    display?: number;
+}
+export interface MouseEventOutput {
+    x: number;
+    y: number;
+    buttons: number;
+    display: number;
+}

package/lib/vvd/grpc/types/MouseEvent.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/lib/vvd/index.d.ts

@@ -2,6 +2,7 @@ import { IVvdParams, IVvdResourcePaths, SDKParts, SDKDownloadOpt, SkinInfo, Vela
 import { IStartOptions, IStartWithSerialPort } from '../typing/Instance';
 import { findInstance } from '../instance';
 import type { DownloadFileOptions } from 'ipull';
+import GrpcEmulator from './grpc';
 export declare class VvdManager {
     private vvdHome;
     private sdkHome;
@@ -52,6 +53,7 @@ export declare class VvdManager {
     startVvd(options: IStartOptions | IStartWithSerialPort): Promise<{
         coldBoot: boolean;
         emulatorInstance: ReturnType<typeof findInstance>;
+        getAgent: () => GrpcEmulator;
     }>;
     stopVvd(name: string, timeout?: number): Promise<void>;
     /** 获取模拟器平台的名称，darwin-aarch64 linux-aarch64 windows-x86_64等 */

package/lib/vvd/index.js

@@ -25,6 +25,7 @@ var _instance = require("../instance");
 var _logcat = require("./logcat");
 var _sharedUtils = require("@aiot-toolkit/shared-utils");
 var _ILog = require("@aiot-toolkit/shared-utils/lib/interface/ILog");
+var _grpc = require("./grpc");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // TODO: 升级构建工具支持 esm @xujunjie
 const getPort = (async () => {
@@ -446,7 +447,8 @@ class VvdManager {
       });
       return {
         coldBoot: false,
-        emulatorInstance
+        emulatorInstance,
+        getAgent: () => (0, _grpc.createGrpcClient)(e)
       };
     }
 
@@ -488,7 +490,8 @@ class VvdManager {
             readlines.stdoutReadline.off('line', emulatorStartedHandler);
             resolve({
               coldBoot: true,
-              emulatorInstance
+              emulatorInstance,
+              getAgent: () => (0, _grpc.createGrpcClient)(e)
             });
           } else {
             reject('get emulator running config failed');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiot-toolkit/emulator",
-  "version": "2.0.5-beta.11",
+  "version": "2.0.5-beta.12",
   "description": "vela emulator tool.",
   "homepage": "",
   "license": "ISC",
@@ -36,7 +36,9 @@
     "emulator"
   ],
   "dependencies": {
-    "@aiot-toolkit/shared-utils": "2.0.5-beta.11",
+    "@aiot-toolkit/shared-utils": "2.0.5-beta.12",
+    "@grpc/grpc-js": "^1.13.3",
+    "@grpc/proto-loader": "^0.7.13",
     "@miwt/adb": "^0.9.0",
     "adm-zip": "^0.5.16",
     "dayjs": "^1.11.12",
@@ -51,5 +53,5 @@
     "@types/adm-zip": "^0.5.5",
     "@types/ini": "^4.1.1"
   },
-  "gitHead": "3572914b1508d19f4a7c566cec23f0be70273e59"
+  "gitHead": "c6fd4b0687293c2d4ebcff3452df9003c56bf455"
 }