XMPP implementation in JavaScript.

remoting/webapp/xmpp_connection.js

+// Copyright 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+'use strict';
+
+/** @suppress {duplicate} */
+var remoting = remoting || {};
+
+/**
+ * Object used to connect to XMPP server.
+ *
+ * TODO(sergeyu): Chrome provides two APIs for TCP sockets: chrome.socket and
+ * chrome.sockets.tcp . chrome.socket is deprecated but it's still used here
+ * because TLS support in chrome.sockets.tcp is currently broken, see
+ * crbug.com/403076 .
+ *
+ * @param {function(remoting.XmppConnection.State):void} onStateChangedCallback
+ *   Callback to call on state change.
+ * @param {function(Element):void} onIncomingStanzaCallback Callback to call to
+ *   handle incoming messages.
+ * @constructor
+ */
+remoting.XmppConnection =
+    function(onStateChangedCallback, onIncomingStanzaCallback) {
+  this.server_ = '';

[kelvinp, 2014/08/29 01:37:09]

@private.  Same for other private members and functions

[Sergey Ulanov, 2014/08/29 23:40:30]

Done.

+  this.port_ = 0;
+  this.onStateChangedCallback_ = onStateChangedCallback;
+  this.onIncomingStanzaCallback_ = onIncomingStanzaCallback;
+  this.socketId_ = -1;
+  this.state_ = remoting.XmppConnection.State.NOT_CONNECTED;
+  this.readPending_ = false;
+  this.sendPending_ = false;
+  this.starttlsPending_ = false;
+  /** @type {Array.<ArrayBuffer>} */
+  this.sendQueue_ = [];
+  this.jid_ = '';
+  this.error_ = remoting.Error.NONE;
+}
+
+/**
+ * @enum {number} XmppConnection states. Possible state transitions:
+ *    NOT_CONNECTED -> CONNECTING (connect() called).
+ *    CONNECTING -> HANDSHAKE (connected successfully).
+ *    HANDSHAKE -> CONNECTED (connected successfully).

[kelvinp, 2014/08/29 01:37:09]

Nit: HANDSHAKE -> CONNECTED (Authenticated successfully).?

[Sergey Ulanov, 2014/08/29 23:40:29]

Done.

+ *    CONNECTING -> FAILED (connection failed).
+ *    HANDSHAKE -> FAILED (authentication failed).
+ *    * -> CLOSED (dispose() called).
+ */
+remoting.XmppConnection.State = {
+  NOT_CONNECTED: 0,
+  CONNECTING: 1,
+  HANDSHAKE: 2,
+  CONNECTED: 3,
+  FAILED: 4,
+  CLOSED: 5
+};
+
+/**
+ * @param {string} server
+ * @param {string} username
+ * @param {string} authToken
+ */
+remoting.XmppConnection.prototype.connect =
+    function(server, username, authToken) {
+  if (this.state_ != remoting.XmppConnection.State.NOT_CONNECTED) {
+    console.error(
+        'remoting.XmppConnection.prototype.connect() can only be called once.');
+    return;
+  }
+
+  this.error_ = remoting.Error.NONE;
+  var hostnameAndPort = server.split(':', 2);
+  this.server_ = hostnameAndPort[0];
+  this.port_ =
+      (hostnameAndPort.length == 2) ? parseInt(hostnameAndPort[1], 10) : 5222;
+
+  // The server name is passed as to attribute in the <stream>. When connecting
+  // to talk.google.com it affects the certificate the server will use for TLS:
+  // talk.google.com uses gmail certificate when specified server is gmail.com
+  // or googlemail.com and google.com cert otherwise. In the same time it
+  // doesn't accept talk.google.com as target server. Here we use google.com
+  // server name when authenticating to talk.google.com. This ensures that the
+  // server will use google.com cert which will be accepted by the TLS
+  // implementation in Chrome (TLS API doesn't allow specifying domain other
+  // than the one that was passed to connect()).
+  var xmppServer = this.server_;
+  if (xmppServer == 'talk.google.com')
+    xmppServer = 'google.com';
+
+  /** @type {remoting.XmppLoginHandler} */
+  this.loginHandler_ =
+      new remoting.XmppLoginHandler(xmppServer, username, authToken,

[kelvinp, 2014/08/29 01:37:10]

Instead of binding private functions and handing them off to XmppLoginHandler as
callbacks, may be it is cleaner to pass a reference to XmppLoginHandler and make
those functions public.

[Sergey Ulanov, 2014/08/29 23:40:30]

This would create circular dependency between XmppConnection and
XmppLoginHandler, which is wrong and would make it harder to test
XmppLoginHandler. It would also require exposing internal details of
XmppConnection as public.

+                                    this.sendInternal_.bind(this),
+                                    this.startTls_.bind(this),
+                                    this.onHandshakeDone_.bind(this),
+                                    this.onIncomingStanzaCallback_,
+                                    this.onError_.bind(this));
+  chrome.socket.create("tcp", {}, this.onSocketCreated_.bind(this));
+  this.setState_(remoting.XmppConnection.State.CONNECTING);
+}
+
+/** @param {string} message */
+remoting.XmppConnection.prototype.sendMessage = function(message) {
+  if (this.state_ != remoting.XmppConnection.State.CONNECTED) {
+    console.error(
+        'remoting.XmppConnection.prototype.sendMessage() is called when not ' +
+        'connected.');
+    return;
+  }
+
+  this.sendInternal_(message);
+}
+
+/** @return {remoting.XmppConnection.State} Current state */
+remoting.XmppConnection.prototype.getState = function() {
+  return this.state_;
+}
+
+/** @return {remoting.Error} Error when in FAILED state. */
+remoting.XmppConnection.prototype.getError = function() {
+  return this.error_;
+}
+
+/** @return {string} Current JID when in CONNECTED state. */
+remoting.XmppConnection.prototype.getJid = function() {
+  return this.jid_;
+}
+
+remoting.XmppConnection.prototype.dispose = function() {
+  this.closeSocket_();
+  this.setState_(remoting.XmppConnection.State.CLOSED);
+}
+
+/** @param {chrome.socket.CreateInfo} createInfo */
+remoting.XmppConnection.prototype.onSocketCreated_ = function(createInfo) {
+  // Check if connection was terminated.
+  if (this.state_ != remoting.XmppConnection.State.CONNECTING) {
+    chrome.socket.destroy(createInfo.socketId);
+    return;
+  }
+
+  this.socketId_ = createInfo.socketId;
+
+  chrome.socket.connect(this.socketId_,
+                        this.server_,
+                        this.port_,
+                        this.onSocketConnected_.bind(this));
+}
+
+/** @param {number} result */
+remoting.XmppConnection.prototype.onSocketConnected_ = function(result) {
+  // Check if connection was terminated.
+  if (this.state_ != remoting.XmppConnection.State.CONNECTING)
+    return;
+
+  if (result != 0) {
+    this.onError_(remoting.Error.NETWORK_FAILURE,
+                  'Failed to connect to ' + this.server_ + ': ' +  result);
+    return;
+  }
+
+  this.setState_(remoting.XmppConnection.State.HANDSHAKE);
+
+  this.tryRead_();
+  this.loginHandler_.start();
+}
+
+remoting.XmppConnection.prototype.tryRead_ = function() {

[kelvinp, 2014/08/29 01:37:10]

tryRead will cause onRead to call, which will call tryRead again.  Is there
anyway to guarantee that it will terminate?

[Sergey Ulanov, 2014/08/29 23:40:30]

chrome.socket.read() never calls the callback synchronously.

+  base.debug.assert(!this.readPending_);
+  if ((this.state_ != remoting.XmppConnection.State.HANDSHAKE &&
+       this.state_ != remoting.XmppConnection.State.CONNECTED) ||
+      this.starttlsPending_) {
+    return;
+  }
+
+  this.readPending_ = true;
+  chrome.socket.read(this.socketId_, this.onRead_.bind(this));
+}
+
+/** @param {chrome.socket.ReadInfo} readInfo */
+remoting.XmppConnection.prototype.onRead_ = function(readInfo) {
+  base.debug.assert(this.readPending_);
+  this.readPending_ = false;
+
+  if (readInfo.resultCode < 0) {
+    this.onError_(remoting.Error.NETWORK_FAILURE,
+                  'Failed to receive from XMPP socket: ' + readInfo.resultCode);
+    return;
+  }
+
+  this.loginHandler_.onDataReceived(readInfo.data);
+  this.tryRead_();
+}
+
+/** @param {string} text */
+remoting.XmppConnection.prototype.sendInternal_ = function(text) {
+  this.sendQueue_.push(base.encodeUtf8(text));
+  this.doSend_();
+}
+
+remoting.XmppConnection.prototype.doSend_ = function() {
+  if (this.sendPending_)
+    return;
+  if (this.sendQueue_.length == 0)
+    return;
+
+  var data = this.sendQueue_[0]
+  this.sendPending_ = true;
+  chrome.socket.write(this.socketId_, data, this.onWrite_.bind(this));
+}
+
+/** @param {chrome.socket.WriteInfo} writeInfo */
+remoting.XmppConnection.prototype.onWrite_ = function(writeInfo) {
+  base.debug.assert(this.sendPending_);
+  this.sendPending_ = false;
+
+  if (writeInfo.bytesWritten < 0) {
+    console.error('TCP write failed with error ' + writeInfo.bytesWritten);
+    this.setState_(remoting.XmppConnection.State.FAILED);
+    return;
+  }
+
+  base.debug.assert(this.sendQueue_.length > 0);
+
+  var data = this.sendQueue_[0]
+  base.debug.assert(writeInfo.bytesWritten <= data.byteLength);

[kelvinp, 2014/08/29 01:37:10]

It is strange that we assert that bytesWritten <= data.byteLength, but then
handle the cases when it is not.
If it is possible for bytesWritten to be larger than data.byteLength, the assert
should be removed.

[Sergey Ulanov, 2014/08/29 23:40:29]

replaced >= with == in the line below.

+  if (writeInfo.bytesWritten >= data.byteLength) {
+    this.sendQueue_.shift();
+  } else {
+    this.sendQueue_[0] = data.slice(data.byteLength - writeInfo.bytesWritten);
+  }
+
+  this.doSend_();
+}
+
+remoting.XmppConnection.prototype.startTls_ = function() {

[kelvinp, 2014/08/29 01:37:10]

This function is marked as private but it is not called within this class but
only called by XMPPLoginHandler.  Can we mark it as public?

[Sergey Ulanov, 2014/08/29 23:40:30]

No. It's internal detail of XmppConnection() and is not supposed to be called by
the client of this class.

+  base.debug.assert(!this.readPending_);
+  base.debug.assert(!this.starttlsPending_);
+
+  this.starttlsPending_ = true;
+  chrome.socket.secure(
+      this.socketId_, {}, this.onTlsStarted_.bind(this));
+}
+
+/** @param {number} resultCode */
+remoting.XmppConnection.prototype.onTlsStarted_ = function(resultCode) {
+  base.debug.assert(this.starttlsPending_);
+  this.starttlsPending_ = false;
+
+  if (resultCode < 0) {
+    this.onError_(remoting.Error.NETWORK_FAILURE,
+                  'Failed to start TLS: ' + resultCode);
+    return;
+  }
+
+  this.tryRead_();
+  this.loginHandler_.onTlsStarted();
+}
+
+/** @param {string} jid */
+remoting.XmppConnection.prototype.onHandshakeDone_ = function(jid) {
+  this.jid_ = jid;
+  this.setState_(remoting.XmppConnection.State.CONNECTED);
+}
+
+/**
+ * @param {remoting.Error} error
+ * @param {string} text
+ */
+remoting.XmppConnection.prototype.onError_ = function(error, text) {
+  console.error(text);
+  this.error_ = error;
+  this.closeSocket_();
+  this.setState_(remoting.XmppConnection.State.FAILED);
+}
+
+remoting.XmppConnection.prototype.closeSocket_ = function() {
+  if (this.socketId_ != -1) {
+    chrome.socket.destroy(this.socketId_);
+    this.socketId_ = -1;
+  }
+}
+
+/** @param {remoting.XmppConnection.State} newState */
+remoting.XmppConnection.prototype.setState_ = function(newState) {
+  if (this.state_ != newState) {
+    this.state_ = newState;
+    this.onStateChangedCallback_(this.state_);
+  }
+}