Introduce InterfaceEndpointClient(IEC), InterfaceEndpointHandle and

mojo/public/js/router.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.
 
 define("mojo/public/js/router", [
-  "console",
-  "mojo/public/js/codec",
+  "mojo/public/js/connector",
   "mojo/public/js/core",
-  "mojo/public/js/connector",
-  "mojo/public/js/lib/control_message_handler",
+  "mojo/public/js/interface_types",
+  "mojo/public/js/lib/interface_endpoint_handle",
+  "mojo/public/js/lib/pipe_control_message_handler",
+  "mojo/public/js/lib/pipe_control_message_proxy",
   "mojo/public/js/validator",
-], function(console, codec, core, connector, controlMessageHandler, validator) {
+  "timer",
+], function(connector, core, types, interfaceEndpointHandle,
+      controlMessageHandler, controlMessageProxy, validator, timer) {
 
   var Connector = connector.Connector;
-  var MessageReader = codec.MessageReader;
+  var PipeControlMessageHandler =
+      controlMessageHandler.PipeControlMessageHandler;
+  var PipeControlMessageProxy = controlMessageProxy.PipeControlMessageProxy;
   var Validator = validator.Validator;
-  var ControlMessageHandler = controlMessageHandler.ControlMessageHandler;
-
-  function Router(handle, interface_version, connectorFactory) {
+  var InterfaceEndpointHandle = interfaceEndpointHandle.InterfaceEndpointHandle;
+
+  /**
+   * The state of |endpoint|. If both the endpoint and its peer have been
+   * closed, removes it from |endpoints_|.
+   * @enum {string}
+   */
+  var EndpointStateUpdateType = {
+    ENDPOINT_CLOSED: 'endpoint_closed',
+    PEER_ENDPOINT_CLOSED: 'peer_endpoint_closed'
+  };
+
+  function InterfaceEndpoint(router, interfaceId) {
+    this.router_ = router;
+    this.id = interfaceId;
+    this.closed = false;
+    this.peerClosed = false;
+    this.handleCreated = false;
+    this.disconnectReason = null;
+    this.client = null;
+    this.eventSignalled = false;

[yzshen1, 2017/03/28 00:46:00]

This is not needed.

[wangjimmy, 2017/03/29 17:01:18]

Done.

+  }
+
+  InterfaceEndpoint.prototype.sendMessage = function(message) {
+    message.setInterfaceId(this.id);
+    return this.router_.connector_.accept(message);
+  };
+
+  function AssociatedGroupController() {

[yzshen1, 2017/03/28 00:46:00]

Because we don't have multiple implementation of AssociatedGroupController, we
could merge it with Router.

WDYT?

[wangjimmy, 2017/03/29 17:01:18]

Done. Merged it with Router.

+  }
+
+  AssociatedGroupController.prototype.attachEndpointClient = function(
+      interfaceEndpointHandle, interfaceEndpointClient) {
+    var endpoint = this.endpoints_.get(interfaceEndpointHandle.id());
+    if (!endpoint) return;
+
+    endpoint.client = interfaceEndpointClient;
+
+    if (endpoint.peerClosed) {
+      timer.createOneShot(0,
+          endpoint.client.notifyError.bind(endpoint.client));
+    }
+
+    return endpoint;
+  };
+
+  AssociatedGroupController.prototype.detachEndpointClient = function(
+      interfaceEndpointHandle) {
+    var endpoint = this.endpoints_.get(interfaceEndpointHandle.id());
+    endpoint.client = null;
+  };
+
+  AssociatedGroupController.prototype.createLocalEndpointHandle = function(
+      interfaceId) {
+    if (!types.isValidInterfaceId(interfaceId)) {
+      return new InterfaceEndpointHandle();
+    }
+
+    var endpoint = this.endpoints_.get(interfaceId);
+
+    if (!endpoint) {
+      endpoint = new InterfaceEndpoint(this, interfaceId);
+      this.endpoints_.set(interfaceId, endpoint);
+
+      if (this.encounteredError_) {
+        this.updateEndpointStateMayRemove(endpoint,
+            EndpointStateUpdateType.PEER_ENDPOINT_CLOSED);
+      }
+    } else {

[yzshen1, 2017/03/28 00:46:00]

Thinking about it some more, I think maybe it makes sense to add those
CHECK/DCHECK from the C++ code using a home-made check function:

function check(condition, output) {
  if (!condition)
    throw new Error(output);
}

This code is pretty complex so it would be much easier to debug if we have these
checks to ensure state consistency.

WDYT?

[wangjimmy, 2017/03/29 17:01:18]

Done. I agree, it would help with debugging. Added check for every relevant
DCHECK/CHECK from multiplex_router.cc

+      // If the endpoint already exist, it is because we have received a
+      // notification that the peer endpoint has closed.
+      if (endpoint.handleCreated) {
+        return new InterfaceEndpointHandle();
+      }
+    }
+
+    endpoint.handleCreated = true;
+    return new InterfaceEndpointHandle(interfaceId, this);
+  };
+
+  function Router(handle, setInterfaceIdNamespaceBit,connectorFactory) {

[yzshen1, 2017/03/28 00:46:00]

Do we still need this "connectorFactory" param? (If yes, please add one space
between "," and "connectorFactory")

[wangjimmy, 2017/03/29 17:01:18]

Done. Removed it. We don't use this anywhere. It was used for a TestRouter, but
that was removed in
https://chromium.googlesource.com/chromium/src/+/4cbc282a724bad6fb6dec8b3ed0f...

     if (!core.isHandle(handle))
       throw new Error("Router constructor: Not a handle");
     if (connectorFactory === undefined)
       connectorFactory = Connector;
     this.connector_ = new connectorFactory(handle);
-    this.incomingReceiver_ = null;
-    this.errorHandler_ = null;
-    this.nextRequestID_ = 0;
-    this.completers_ = new Map();
-    this.payloadValidators_ = [];
-    this.testingController_ = null;
-
-    if (interface_version !== undefined) {
-      this.controlMessageHandler_ = new
-          ControlMessageHandler(interface_version);
-    }
 
     this.connector_.setIncomingReceiver({
-        accept: this.handleIncomingMessage_.bind(this),
+        accept: this.accept.bind(this),
     });
     this.connector_.setErrorHandler({
-        onError: this.handleConnectionError_.bind(this),
+        onError: this.onPipeConnectionError.bind(this),
     });
+
+    if (setInterfaceIdNamespaceBit === undefined) {
+      setInterfaceIdNamespaceBit = false;
+    }
+    this.setInterfaceIdNamespaceBit_ = setInterfaceIdNamespaceBit;
+    this.controlMessageHandler_ = new PipeControlMessageHandler(this);
+    this.controlMessageProxy_ = new PipeControlMessageProxy(this.connector_);
+    this.nextInterfaceIdValue = 1;
+    this.encounteredError_ = false;
+    this.endpoints_ = new Map();
   }
 
-  Router.prototype.close = function() {
-    this.completers_.clear();  // Drop any responders.
-    this.connector_.close();
-    this.testingController_ = null;
-  };
+  Router.prototype = Object.create(AssociatedGroupController.prototype);
 
   Router.prototype.accept = function(message) {
-    this.connector_.accept(message);
-  };
-
-  Router.prototype.reject = function(message) {
-    // TODO(mpcomplete): no way to trasmit errors over a Connection.
-  };
-
-  Router.prototype.acceptAndExpectResponse = function(message) {
-    // Reserve 0 in case we want it to convey special meaning in the future.
-    var requestID = this.nextRequestID_++;
-    if (requestID == 0)
-      requestID = this.nextRequestID_++;
-
-    message.setRequestID(requestID);
-    var result = this.connector_.accept(message);
-    if (!result)
-      return Promise.reject(Error("Connection error"));
-
-    var completer = {};
-    this.completers_.set(requestID, completer);
-    return new Promise(function(resolve, reject) {
-      completer.resolve = resolve;
-      completer.reject = reject;
-    });
-  };
-
-  Router.prototype.setIncomingReceiver = function(receiver) {
-    this.incomingReceiver_ = receiver;
-  };
-
-  Router.prototype.setPayloadValidators = function(payloadValidators) {
-    this.payloadValidators_ = payloadValidators;
-  };
-
-  Router.prototype.setErrorHandler = function(handler) {
-    this.errorHandler_ = handler;
-  };
-
-  Router.prototype.encounteredError = function() {
-    return this.connector_.encounteredError();
-  };
-
-  Router.prototype.enableTestingMode = function() {
-    this.testingController_ = new RouterTestingController(this.connector_);
-    return this.testingController_;
-  };
-
-  Router.prototype.handleIncomingMessage_ = function(message) {
-    var noError = validator.validationError.NONE;
     var messageValidator = new Validator(message);
     var err = messageValidator.validateMessageHeader();
-    for (var i = 0; err === noError && i < this.payloadValidators_.length; ++i)
-      err = this.payloadValidators_[i](messageValidator);
-
-    if (err == noError)
-      this.handleValidIncomingMessage_(message);
-    else
-      this.handleInvalidIncomingMessage_(message, err);
-  };
-
-  Router.prototype.handleValidIncomingMessage_ = function(message) {
-    if (this.testingController_)
-      return;
-
-    if (message.expectsResponse()) {
-      if (controlMessageHandler.isControlMessage(message)) {
-        if (this.controlMessageHandler_) {
-          this.controlMessageHandler_.acceptWithResponder(message, this);
-        } else {
-          this.close();
-        }
-      } else if (this.incomingReceiver_) {
-        this.incomingReceiver_.acceptWithResponder(message, this);
-      } else {
-        // If we receive a request expecting a response when the client is not
-        // listening, then we have no choice but to tear down the pipe.
-        this.close();
-      }
-    } else if (message.isResponse()) {
-      var reader = new MessageReader(message);
-      var requestID = reader.requestID;
-      var completer = this.completers_.get(requestID);
-      if (completer) {
-        this.completers_.delete(requestID);
-        completer.resolve(message);
-      } else {
-        console.log("Unexpected response with request ID: " + requestID);
-      }
+
+    var ok = false;
+    if (err !== validator.validationError.NONE) {
+      validator.reportValidationError(err);
+    } else if (controlMessageHandler.isPipeControlMessage(message)) {
+      ok = this.controlMessageHandler_.accept(message);
     } else {
-      if (controlMessageHandler.isControlMessage(message)) {
-        if (this.controlMessageHandler_) {
-          var ok = this.controlMessageHandler_.accept(message);
-          if (ok) return;
-        }
-        this.close();
-      } else if (this.incomingReceiver_) {
-        this.incomingReceiver_.accept(message);
-      }
-    }
-  };
-
-  Router.prototype.handleInvalidIncomingMessage_ = function(message, error) {
-    if (!this.testingController_) {
+      var interfaceId = message.getInterfaceId();
+      var endpoint = this.endpoints_.get(interfaceId);
+      if (!endpoint || endpoint.closed) {
+        return true;
+      }
+
+      if (!endpoint.client) {
+        // We need to wait until a client is attached in order to dispatch
+        // further messages.
+        return false;
+      }
+      ok = endpoint.client.handleIncomingMessage_(message);
+    }
+
+    if (!ok) {
+      this.handleInvalidIncomingMessage_();
+    }
+    return ok;
+  };
+
+  Router.prototype.close = function() {
+    this.connector_.close();
+    // Closing the message pipe won't trigger connection error handler.
+    // Explicitly call onPipeConnectionError() so that associated endpoints
+    // will get notified.
+    this.onPipeConnectionError();
+  };
+
+  Router.prototype.waitForNextMessageForTesting = function() {
+    this.connector_.waitForNextMessageForTesting();
+  };
+
+  Router.prototype.handleInvalidIncomingMessage_ = function(message) {
+    if (!validator.isTestingMode()) {
       // TODO(yzshen): Consider notifying the embedder.
       // TODO(yzshen): This should also trigger connection error handler.
       // Consider making accept() return a boolean and let the connector deal
       // with this, as the C++ code does.
-      console.log("Invalid message: " + validator.validationError[error]);
-
       this.close();
       return;
     }
-
-    this.testingController_.onInvalidIncomingMessage(error);
-  };
-
-  Router.prototype.handleConnectionError_ = function(result) {
-    this.completers_.forEach(function(value) {
-      value.reject(result);
-    });
-    if (this.errorHandler_)
-      this.errorHandler_();
-    this.close();
-  };
-
-  // The RouterTestingController is used in unit tests. It defeats valid message
-  // handling and delgates invalid message handling.
-
-  function RouterTestingController(connector) {
-    this.connector_ = connector;
-    this.invalidMessageHandler_ = null;
-  }
-
-  RouterTestingController.prototype.waitForNextMessage = function() {
-    this.connector_.waitForNextMessageForTesting();
-  };
-
-  RouterTestingController.prototype.setInvalidIncomingMessageHandler =
-      function(callback) {
-    this.invalidMessageHandler_ = callback;
-  };
-
-  RouterTestingController.prototype.onInvalidIncomingMessage =
-      function(error) {
-    if (this.invalidMessageHandler_)
-      this.invalidMessageHandler_(error);
+  };
+
+  Router.prototype.onPeerAssociatedEndpointClosed = function(interfaceId,
+      reason) {
+    var endpoint = this.endpoints_.get(interfaceId);

[yzshen1, 2017/03/28 00:46:00]

If the endpoint doesn't exist, we need to insert it. That could happen if the
remote side sends us this control message before sending the corresponding
associated endpoint handle.

[wangjimmy, 2017/03/29 17:01:18]

Done.

+    if (reason && endpoint) {
+      endpoint.disconnectReason = reason;
+    }
+
+    if (!endpoint.peerClosed && endpoint.client) {

[yzshen1, 2017/03/28 00:46:00]

This is incorrect, even if endpoint.client is not currently set, we still need
to do updateEndpointStateMayRemove

[wangjimmy, 2017/03/29 17:01:18]

Done.

+      timer.createOneShot(0,
+          endpoint.client.notifyError.bind(endpoint.client, reason));
+      this.updateEndpointStateMayRemove(endpoint,
+          EndpointStateUpdateType.PEER_ENDPOINT_CLOSED);
+    }
+    return true;
+  };
+
+  Router.prototype.onPipeConnectionError = function() {
+    this.encounteredError_ = true;
+
+    for (var endpoint of this.endpoints_.values()) {
+      if (endpoint.client) {
+        timer.createOneShot(0,
+            endpoint.client.notifyError.bind(endpoint.client,
+              endpoint.disconnectReason));
+      }
+      this.updateEndpointStateMayRemove(endpoint,
+          EndpointStateUpdateType.PEER_ENDPOINT_CLOSED);
+    }
+  };
+
+  Router.prototype.closeEndpointHandle = function(interfaceId, reason) {
+    if (!types.isValidInterfaceId(interfaceId)) {
+      return;
+    }
+    var endpoint = this.endpoints_.get(interfaceId);
+    this.updateEndpointStateMayRemove(endpoint,
+        EndpointStateUpdateType.ENDPOINT_CLOSED);
+
+    if (!types.isMasterInterfaceId(interfaceId) || reason) {
+      this.controlMessageProxy_.notifyPeerEndpointClosed(interfaceId, reason);
+    }
+  };
+
+  Router.prototype.updateEndpointStateMayRemove = function(endpoint,
+      endpointStateUpdateType) {
+    if (endpointStateUpdateType === EndpointStateUpdateType.ENDPOINT_CLOSED) {
+      endpoint.closed = true;
+    } else {
+      endpoint.peerClosed = true;
+    }
+    if (endpoint.closed && endpoint.peerClosed) {
+      this.endpoints_.delete(endpoint.id);
+    }
   };
 
   var exports = {};
   exports.Router = Router;
   return exports;
 });