android-emulator-webrtc 1.0.16 → 1.0.18

package/dist/components/emulator/net/jsep_protocol_driver.js

@@ -1,30 +1,17 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _events = require("events");
-
 var _empty_pb = require("google-protobuf/google/protobuf/empty_pb");
-
-var _core = require("@material-ui/core");
-
-var _buffer = require("buffer");
-
 /*
  * Copyright 2019 The Android Open Source Project
  *
@@ -40,7 +27,6 @@ var _buffer = require("buffer");
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 /**
  * This drives the jsep protocol with the emulator, and can be used to
  * send key/mouse/touch events to the emulator. Events will be send
@@ -78,21 +64,22 @@ var JsepProtocol = /*#__PURE__*/function () {
    */
   function JsepProtocol(emulator, rtc, poll, onConnect, onDisconnect) {
     var _this = this;
-
     (0, _classCallCheck2["default"])(this, JsepProtocol);
     (0, _defineProperty2["default"])(this, "on", function (name, fn) {
       _this.events.on(name, fn);
     });
+    /**
+     * Disconnects the stream. This will stop the message pump as well.
+     *
+     * @memberof JsepProtocol
+     */
     (0, _defineProperty2["default"])(this, "disconnect", function () {
       _this.connected = false;
       if (_this.peerConnection) _this.peerConnection.close();
-
       if (_this.stream) {
         _this.stream.cancel();
-
         _this.stream = null;
       }
-
       _this.active = false;
       _this.old_emu_patch = {
         candidates: [],
@@ -100,9 +87,13 @@ var JsepProtocol = /*#__PURE__*/function () {
         haveOffer: false,
         answer: false
       };
-
       _this.events.emit("disconnected", _this);
     });
+    /**
+     * Initiates the JSEP protocol.
+     *
+     * @memberof JsepProtocol
+     */
     (0, _defineProperty2["default"])(this, "startStream", function () {
       var self = _this;
       _this.connected = false;
@@ -115,42 +106,33 @@ var JsepProtocol = /*#__PURE__*/function () {
         answer: false
       };
       var request = new _empty_pb.Empty();
-
       _this.rtc.requestRtcStream(request, {}, function (err, response) {
         if (err) {
           console.error("Failed to configure rtc stream: " + JSON.stringify(err));
-
           _this.disconnect();
-
           return;
-        } // Configure
-
+        }
 
+        // Configure
         self.guid = response;
         self.connected = true;
-
         if (!_this.poll) {
           // Streaming envoy based.
           self._streamJsepMessage();
         } else {
           // Poll pump messages, go/envoy based proxy.
           console.debug("Polling jsep messages.");
-
           self._receiveJsepMessage();
         }
       });
     });
     (0, _defineProperty2["default"])(this, "cleanup", function () {
       _this.disconnect();
-
       if (_this.peerConnection) {
         _this.peerConnection.removeEventListener("track", _this._handlePeerConnectionTrack);
-
         _this.peerConnection.removeEventListener("icecandidate", _this._handlePeerIceCandidate);
-
         _this.peerConnection = null;
       }
-
       _this.event_forwarders = {};
     });
     (0, _defineProperty2["default"])(this, "_handlePeerConnectionTrack", function (e) {
@@ -158,21 +140,19 @@ var JsepProtocol = /*#__PURE__*/function () {
     });
     (0, _defineProperty2["default"])(this, "_handlePeerConnectionStateChange", function (e) {
       switch (_this.peerConnection.connectionState) {
-        case "disconnected": // At least one of the ICE transports for the connection is in the "disconnected" state
+        case "disconnected":
+        // At least one of the ICE transports for the connection is in the "disconnected" state
         // and none of the other transports are in the state "failed", "connecting",
         // or "checking".
-
-        case "failed": // One or more of the ICE transports on the connection is in the "failed" state.
-
+        case "failed":
+        // One or more of the ICE transports on the connection is in the "failed" state.
         case "closed":
           //The RTCPeerConnection is closed.
           _this.disconnect();
-
       }
     });
     (0, _defineProperty2["default"])(this, "_handlePeerIceCandidate", function (e) {
       if (e.candidate === null) return;
-
       _this._sendJsep({
         candidate: e.candidate
       });
@@ -193,15 +173,12 @@ var JsepProtocol = /*#__PURE__*/function () {
       if (!_this.peerConnection) {
         console.log("Peerconnection no longer available, ignoring signal state.");
       }
-
       switch (_this.peerConnection.signalingState) {
         case "have-remote-offer":
           _this.old_emu_patch.haveOffer = true;
-
           while (_this.old_emu_patch.candidates.length > 0) {
             _this._handleCandidate(_this.old_emu_patch.candidates.shift());
           }
-
           break;
       }
     });
@@ -209,44 +186,34 @@ var JsepProtocol = /*#__PURE__*/function () {
       var _ref = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(signal) {
         var answer;
         return _regenerator["default"].wrap(function _callee$(_context) {
-          while (1) {
-            switch (_context.prev = _context.next) {
-              case 0:
-                // We should not call this more than once..
-                _this.old_emu_patch.sdp = null;
-
-                _this.peerConnection.setRemoteDescription(new RTCSessionDescription(signal));
-
-                _context.next = 4;
-                return _this.peerConnection.createAnswer();
-
-              case 4:
-                answer = _context.sent;
-
-                if (answer) {
-                  // Older emulators cannot handle multiple answers, so make sure we do not send one
-                  // again.
-                  if (!_this.old_emu_patch.answer) {
-                    _this.old_emu_patch.answer = true;
-
-                    _this.peerConnection.setLocalDescription(answer);
-
-                    _this._sendJsep({
-                      sdp: answer
-                    });
-                  }
-                } else {
-                  _this.disconnect();
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              // We should not call this more than once..
+              _this.old_emu_patch.sdp = null;
+              _this.peerConnection.setRemoteDescription(new RTCSessionDescription(signal));
+              _context.next = 4;
+              return _this.peerConnection.createAnswer();
+            case 4:
+              answer = _context.sent;
+              if (answer) {
+                // Older emulators cannot handle multiple answers, so make sure we do not send one
+                // again.
+                if (!_this.old_emu_patch.answer) {
+                  _this.old_emu_patch.answer = true;
+                  _this.peerConnection.setLocalDescription(answer);
+                  _this._sendJsep({
+                    sdp: answer
+                  });
                 }
-
-              case 6:
-              case "end":
-                return _context.stop();
-            }
+              } else {
+                _this.disconnect();
+              }
+            case 6:
+            case "end":
+              return _context.stop();
           }
         }, _callee);
       }));
-
       return function (_x) {
         return _ref.apply(this, arguments);
       };
@@ -258,25 +225,20 @@ var JsepProtocol = /*#__PURE__*/function () {
       if (signal.start) {
         _this._handleStart(signal);
       }
-
       if (signal.bye) {
         _this._handleBye();
       }
-
       if (signal.sdp && !_this.old_emu_patch.sdp) {
         _this.old_emu_patch.sdp = signal;
       }
-
       if (signal.candidate) {
         _this.old_emu_patch.candidates.push(signal);
       }
-
       if (!!_this.peerConnection) {
         // We have created a peer connection..
         if (_this.old_emu_patch.sdp) {
           _this._handleSDP(_this.old_emu_patch.sdp);
         }
-
         if (_this.old_emu_patch.haveOffer) {
           // We have a remote peer, add the candidates in.
           while (_this.old_emu_patch.candidates.length > 0) {
@@ -288,7 +250,6 @@ var JsepProtocol = /*#__PURE__*/function () {
     (0, _defineProperty2["default"])(this, "_handleJsepMessage", function (message) {
       try {
         var signal = JSON.parse(message);
-
         _this._handleSignal(signal);
       } catch (e) {
         console.error("Failed to handle message: [" + message + "], due to: " + JSON.stringify(e));
@@ -304,60 +265,52 @@ var JsepProtocol = /*#__PURE__*/function () {
       var request = new proto.android.emulation.control.JsepMsg();
       request.setId(_this.guid);
       request.setMessage(JSON.stringify(jsonObject));
-
       _this.rtc.sendJsepMessage(request);
     });
     (0, _defineProperty2["default"])(this, "_streamJsepMessage", function () {
       if (!_this.connected) return;
       var self = _this;
       _this.stream = _this.rtc.receiveJsepMessages(_this.guid, {});
-
       _this.stream.on("data", function (response) {
         var msg = response.getMessage();
-
         self._handleJsepMessage(msg);
       });
-
       _this.stream.on("error", function (e) {
         console.log("Jsep message stream error:", e);
-
         if (self.connected) {
           console.log("Attempting to reconnect to jsep message stream.");
-
           self._streamJsepMessage();
         }
       });
-
       _this.stream.on("end", function (e) {
         if (self.connected) {
           console.log("Stream end while still connected.. Reconnecting");
-
           self._streamJsepMessage();
         }
       });
     });
+    // This function is a fallback for v1 (go based proxy), that does not support streaming.
     (0, _defineProperty2["default"])(this, "_receiveJsepMessage", function () {
       if (!_this.connected) return;
-      var self = _this; // This is a blocking call, that will return as soon as a series
-      // of messages have been made available, or if we reach a timeout
+      var self = _this;
 
+      // This is a blocking call, that will return as soon as a series
+      // of messages have been made available, or if we reach a timeout
       _this.rtc.receiveJsepMessage(_this.guid, {}, function (err, response) {
         if (err) {
           console.error("Failed to receive jsep message, disconnecting: " + JSON.stringify(err));
-
           _this.disconnect();
         }
-
-        var msg = response.getMessage(); // Handle only if we received a useful message.
+        var msg = response.getMessage();
+        // Handle only if we received a useful message.
         // it is possible to get nothing if the server decides
         // to kick us out.
-
         if (msg) {
           self._handleJsepMessage(response.getMessage());
-        } // And pump messages. Note we must continue the message pump as we
-        // can receive new ICE candidates at any point in time.
-
+        }
 
+        // And pump messages. Note we must continue the message pump as we
+        // can receive new ICE candidates at any point in time.
         if (self.active) {
           self._receiveJsepMessage();
         }
@@ -365,9 +318,10 @@ var JsepProtocol = /*#__PURE__*/function () {
     });
     this.emulator = emulator;
     this.rtc = rtc;
-    this.events = new _events.EventEmitter(); // Workaround for older emulators that send messages out of order
-    // and do not handle all answers properly.
+    this.events = new _events.EventEmitter();
 
+    // Workaround for older emulators that send messages out of order
+    // and do not handle all answers properly.
     this.old_emu_patch = {
       candidates: [],
       sdp: null,
@@ -381,14 +335,13 @@ var JsepProtocol = /*#__PURE__*/function () {
     if (onConnect) this.events.on("connected", onConnect);
     if (onDisconnect) this.events.on("disconnected", onDisconnect);
   }
-
   (0, _createClass2["default"])(JsepProtocol, [{
     key: "send",
     value: function send(label, msg) {
       var bytes = msg.serializeBinary();
       var forwarder = this.event_forwarders[label];
-      console.log("Send " + label + " " + JSON.stringify(msg.toObject())); // Send via data channel/gRPC bridge.
-
+      console.log("Send " + label + " " + JSON.stringify(msg.toObject()));
+      // Send via data channel/gRPC bridge.
       if (this.connected && forwarder && forwarder.readyState == "open") {
         this.event_forwarders[label].send(bytes);
       } else {
@@ -397,11 +350,9 @@ var JsepProtocol = /*#__PURE__*/function () {
           case "mouse":
             this.emulator.sendMouse(msg);
             break;
-
           case "keyboard":
             this.emulator.sendKey(msg);
             break;
-
           case "touch":
             this.emulator.sendTouch(msg);
             break;
@@ -411,5 +362,4 @@ var JsepProtocol = /*#__PURE__*/function () {
   }]);
   return JsepProtocol;
 }();
-
 exports["default"] = JsepProtocol;

package/dist/components/emulator/net/logcat.js

@@ -1,22 +1,16 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _events = require("events");
-
 require("../../../proto/emulator_controller_pb");
-
 var _emulator_web_client = require("../../../proto/emulator_web_client");
-
 /*
  * Copyright 2019 The Android Open Source Project
  *
@@ -32,7 +26,6 @@ var _emulator_web_client = require("../../../proto/emulator_web_client");
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 /**
  * Observe the logcat stream from the emulator.
  *
@@ -44,7 +37,7 @@ var _emulator_web_client = require("../../../proto/emulator_web_client");
  * - `data` whenever new data became available.
  * - `end` whenever the stream is finished, either because it was stopped, or due to an error.
  */
-var Logcat =
+var Logcat = /*#__PURE__*/(0, _createClass2["default"])(
 /**
  * Creates a logcat stream.
  *
@@ -58,41 +51,53 @@ var Logcat =
  */
 function Logcat(uriOrEmulator, auth) {
   var _this = this;
-
   (0, _classCallCheck2["default"])(this, Logcat);
+  /**
+   * Register a listener.
+   *
+   * @param {string} name Name of the event.
+   * @param  {Callback} fn Function to notify on the given event.
+   * @memberof Logcat
+   */
   (0, _defineProperty2["default"])(this, "on", function (name, fn) {
     _this.events.on(name, fn);
   });
+  /**
+   * Removes a listener.
+   *
+   * @param {string} name Name of the event.
+   * @param  {Callback} fn Function to notify on the given event.
+   * @memberof Logcat
+   */
   (0, _defineProperty2["default"])(this, "off", function (name, fn) {
     _this.events.off(name, fn);
   });
+  /**
+   * Cancel the currently active logcat stream.
+   *
+   * @memberof Logcat
+   */
   (0, _defineProperty2["default"])(this, "stop", function () {
     if (_this.stream) {
       _this.stream.cancel();
     }
-
     if (_this.timerID) {
       clearInterval(_this.timerID);
       _this.timerID = null;
     }
-
     _this.events.emit("end");
   });
   (0, _defineProperty2["default"])(this, "pollStream", function () {
     var self = _this;
     /* eslint-disable */
-
     var request = new proto.android.emulation.control.LogMessage();
     request.setStart(_this.offset);
-
     _this.emulator.getLogcat(request, {}, function (err, response) {
       if (err) {
         _this.stop();
       }
-
       if (response) {
         var nextOffset = response.getNext();
-
         if (nextOffset > self.offset) {
           self.offset = response.getNext();
           self.events.emit("data", response.getContents());
@@ -100,30 +105,37 @@ function Logcat(uriOrEmulator, auth) {
       }
     });
   });
+  // Uses streaming, this really locks up the ui, so best not to use for now.
   (0, _defineProperty2["default"])(this, "stream", function () {
     var self = _this;
     /* eslint-disable */
-
     var request = new proto.android.emulation.control.LogMessage();
     request.setStart(_this.offset);
     _this.stream = _this.emulator.streamLogcat(request);
-
     _this.stream.on("data", function (response) {
       self.offset = response.getNext();
       var contents = response.getContents();
       self.events.emit("data", contents);
     });
-
     _this.stream.on("error", function (error) {
-      if (error.code = 1) {// Ignore we got cancelled.
+      if (error.code = 1) {
+        // Ignore we got cancelled.
       }
     });
   });
+  /**
+   * Requests the logcat stream, invoking the callback when a log line arrives.
+   *
+   * *Note:* Streaming can cause serious UI delays, so best not to use it.
+   *
+   * @param  {Callback} fnNotify when a new log line arrives.
+   * @param  {number} refreshRate polling interval, or 0 if you wish to use streaming.
+   * @memberof Logcat
+   */
   (0, _defineProperty2["default"])(this, "start", function (fnNotify) {
     var refreshRate = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1000;
     if (fnNotify) _this.on("data", fnNotify);
     _this.refreshRate = refreshRate;
-
     if (_this.refreshRate > 0) {
       _this.timerID = setInterval(function () {
         return _this.pollStream();
@@ -131,31 +143,19 @@ function Logcat(uriOrEmulator, auth) {
     } else {
       _this.stream();
     }
-
     _this.events.emit("start");
   });
-
   if (uriOrEmulator instanceof _emulator_web_client.EmulatorControllerService) {
     this.emulator = uriOrEmulator;
   } else {
     this.emulator = new _emulator_web_client.EmulatorControllerService(uriOrEmulator, auth);
   }
-
   this.offset = 0;
   this.lastline = "";
   this.stream = null;
   this.events = new _events.EventEmitter();
   this.refreshRate = 1000;
   this.timerID = null;
-}
-/**
- * Register a listener.
- *
- * @param {string} name Name of the event.
- * @param  {Callback} fn Function to notify on the given event.
- * @memberof Logcat
- */
-;
-
+});
 var _default = Logcat;
 exports["default"] = _default;