Introduce webkit_glue bridges for the new WebSocket Implementation.

content/child/websocket_dispatcher.cc

+// Copyright (c) 2013 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.
+
+#include "content/child/websocket_dispatcher.h"
+
+#include <string>
+#include <vector>
+
+#include "base/id_map.h"
+#include "base/lazy_instance.h"
+#include "base/logging.h"
+#include "base/memory/ref_counted.h"
+#include "base/strings/string_util.h"
+#include "content/child/child_thread.h"
+#include "content/common/websocket_messages.h"
+#include "ipc/ipc_message.h"
+#include "ipc/ipc_message_macros.h"
+#include "url/gurl.h"
+#include "webkit/child/websocket_handle_bridge.h"
+#include "webkit/child/websocket_handle_delegate.h"
+
+using webkit_glue::WebSocketHandleBridge;
+using webkit_glue::WebSocketHandleDelegate;
+
+namespace content {
+
+class IPCWebSocketHandleBridge : public WebSocketHandleBridge {
+ public:
+  explicit IPCWebSocketHandleBridge(WebSocketHandleDelegate* delegate);
+
+  // Methods called by WebSocketDispatcher.
+  void DidConnect(bool fail,
+                  const std::string& selected_protocol,
+                  const std::string& extensions);
+  void DidReceiveData(bool fin,
+                      WebSocketHandleBridge::MessageType type,
+                      const char* data,
+                      size_t size);
+  void DidReceiveFlowControl(int64_t quota);
+  void DidClose(unsigned short code, const std::string& reason);
+
+  // WebSocketHandleBridge functions.
+  virtual void Connect(const GURL& url,
+                       const std::vector<std::string>& protocols,
+                       const GURL& origin,
+                       WebSocketHandleDelegate* delegate) OVERRIDE;
+  virtual void Send(bool fin,
+                    WebSocketHandleBridge::MessageType type,
+                    const char* data,
+                    size_t size) OVERRIDE;
+  virtual void FlowControl(int64_t quota) OVERRIDE;
+  virtual void Close(unsigned short code, const std::string& reason) OVERRIDE;
+  virtual void Disconnect() OVERRIDE;
+
+  static IPCWebSocketHandleBridge* Get(int channel_id);
+
+ private:
+  virtual ~IPCWebSocketHandleBridge();
+  int channel_id_;
+  WebSocketHandleDelegate* delegate_;
+
+  // Map from ID to bridge instance.
+  static base::LazyInstance<IDMap<IPCWebSocketHandleBridge> >::Leaky bridges_;
+  const int kInvalidChannelId = -1;
+};
+
+base::LazyInstance<IDMap<IPCWebSocketHandleBridge> >::Leaky
+IPCWebSocketHandleBridge::bridges_ = LAZY_INSTANCE_INITIALIZER;;
+
+IPCWebSocketHandleBridge::IPCWebSocketHandleBridge(
+    WebSocketHandleDelegate* delegate)
+    : channel_id_(kInvalidChannelId),
+      delegate_(delegate) {
+  channel_id_ = bridges_.Get().Add(this);
+  DCHECK(delegate_);
+  DCHECK_NE(kInvalidChannelId, channel_id_);
+
+  // To be released in Disconnect().
+  AddRef();

[piman, 2013/09/12 07:30:21]

The delegate already keeps a ref (through a scoped_refptr) and calls Disconnect
before clearing that ref (at worst, in its destructor). So this manual refcount
is redundant.

[yhirano, 2013/09/13 12:32:29]

Done.

+}
+
+IPCWebSocketHandleBridge::~IPCWebSocketHandleBridge() {
+  DCHECK_EQ(kInvalidChannelId, channel_id_);
+  DCHECK(!delegate_);
+}
+
+void IPCWebSocketHandleBridge::DidConnect(bool fail,
+                                          const std::string& selected_protocol,
+                                          const std::string& extensions) {
+  if (delegate_)
+    delegate_->DidConnect(fail, selected_protocol, extensions);
+}
+
+void IPCWebSocketHandleBridge::DidReceiveData(
+    bool fin,
+    WebSocketHandleBridge::MessageType type,
+    const char* data,
+    size_t size) {
+  if (delegate_)
+    delegate_->DidReceiveData(fin, type, data, size);
+}
+
+void IPCWebSocketHandleBridge::DidReceiveFlowControl(int64_t quota) {
+  if (delegate_)
+    delegate_->DidReceiveFlowControl(quota);
+}
+
+void IPCWebSocketHandleBridge::DidClose(unsigned short code,
+                                        const std::string& reason) {
+  if (delegate_)
+    delegate_->DidClose(code, reason);
+  Disconnect();
+  // Disconnect() may delete this object.
+}
+
+void IPCWebSocketHandleBridge::Connect(
+    const GURL& url,
+    const std::vector<std::string>& protocols,
+    const GURL& origin,
+    WebSocketHandleDelegate* delegate) {
+  if (channel_id_ == kInvalidChannelId)
+    return;
+
+  DVLOG(1) << "Bridge#" << channel_id_ << " Connect("
+           << url << ", (" << JoinString(protocols, ", ") << "), "
+           << origin << ")";
+
+  ChildThread::current()->Send(
+      new WebSocketHostMsg_AddChannelRequest(channel_id_,
+                                             url,
+                                             protocols,
+                                             origin));
+}
+
+void IPCWebSocketHandleBridge::Send(bool fin,
+                                    WebSocketHandleBridge::MessageType type,
+                                    const char* data,
+                                    size_t size) {
+  if (channel_id_ == kInvalidChannelId)
+    return;
+
+  WebSocketMessageType type_to_pass;
+  switch (type) {
+    case WebSocketHandleBridge::MESSAGE_TYPE_CONTINUATION:
+      type_to_pass = WEB_SOCKET_MESSAGE_TYPE_CONTINUATION;
+      break;
+    case WebSocketHandleBridge::MESSAGE_TYPE_TEXT:
+      type_to_pass = WEB_SOCKET_MESSAGE_TYPE_TEXT;
+      break;
+    case WebSocketHandleBridge::MESSAGE_TYPE_BINARY:
+      type_to_pass = WEB_SOCKET_MESSAGE_TYPE_BINARY;
+      break;
+    default:

[piman, 2013/09/12 07:30:21]

nit: we don't use default clauses for enums, so that the compiler warns if a
value is added but this code isn't updated.

[yhirano, 2013/09/13 12:32:29]

Done.

+      NOTREACHED();
+      break;
+  }
+
+  DVLOG(1) << "Bridge #" << channel_id_ << " Send("
+           << fin << ", " << type_to_pass << ", "
+           << "(data size = "  << size << "))";
+
+  ChildThread::current()->Send(
+      new WebSocketMsg_SendFrame(channel_id_,
+                                 fin,
+                                 type_to_pass,
+                                 std::vector<char>(&data[0], &data[size])));
+}
+
+void IPCWebSocketHandleBridge::FlowControl(int64_t quota) {
+  if (channel_id_ == kInvalidChannelId)
+    return;
+
+  DVLOG(1) << "Bridge #" << channel_id_ << " FlowControl(" << quota << ")";
+
+  ChildThread::current()->Send(
+      new WebSocketMsg_FlowControl(channel_id_, quota));
+}
+
+void IPCWebSocketHandleBridge::Close(unsigned short code,
+                                     const std::string& reason) {
+  if (channel_id_ == kInvalidChannelId)
+    return;
+
+  DVLOG(1) << "Bridge #" << channel_id_ << " Close("
+           << code << ", " << reason << ")";
+  ChildThread::current()->Send(
+      new WebSocketMsg_DropChannel(channel_id_, code, reason));
+}
+
+void IPCWebSocketHandleBridge::Disconnect() {
+  if (channel_id_ == kInvalidChannelId)
+    return;
+  DCHECK(Get(channel_id_));
+  bridges_.Get().Remove(channel_id_);
+  channel_id_ = kInvalidChannelId;
+  delegate_ = NULL;
+  Release();
+  // Release() may delete this object.
+}
+
+// static
+IPCWebSocketHandleBridge* IPCWebSocketHandleBridge::Get(int channel_id) {
+  return bridges_.Get().Lookup(channel_id);
+}
+
+WebSocketDispatcher::WebSocketDispatcher() {}
+
+WebSocketHandleBridge* WebSocketDispatcher::CreateBridge(
+    WebSocketHandleDelegate* delegate) {
+  return new IPCWebSocketHandleBridge(delegate);
+}
+
+bool WebSocketDispatcher::OnMessageReceived(const IPC::Message& msg) {

[piman, 2013/09/12 07:30:21]

This class is a IPC::Listener, but it doesn't set itself as a listener of
anything. What calls this method?

[yhirano, 2013/09/13 12:32:29]

Thank you, done.

+  bool handled = true;
+  IPC_BEGIN_MESSAGE_MAP(WebSocketDispatcher, msg)
+    IPC_MESSAGE_HANDLER(WebSocketMsg_AddChannelResponse, OnConnected)
+    IPC_MESSAGE_HANDLER(WebSocketMsg_SendFrame, OnReceivedData)
+    IPC_MESSAGE_HANDLER(WebSocketMsg_FlowControl, OnReceivedFlowControl)
+    IPC_MESSAGE_HANDLER(WebSocketMsg_DropChannel, OnClosed)
+    IPC_MESSAGE_UNHANDLED(handled = false)
+  IPC_END_MESSAGE_MAP()
+  return handled;
+}
+
+void WebSocketDispatcher::OnConnected(int channel_id,
+                                      bool fail,
+                                      std::string selected_protocol,

[piman, 2013/09/12 07:30:21]

nit: const string& to avoid copies. Same below.

[yhirano, 2013/09/13 12:32:29]

Done.

+                                      std::string extensions) {
+  DVLOG(1) << "WebSocketDispathcer::OnConnected("
+           << channel_id << ", "
+           << fail << ", "
+           << selected_protocol << ", "
+           << extensions << ")";
+  IPCWebSocketHandleBridge* bridge = IPCWebSocketHandleBridge::Get(channel_id);

[piman, 2013/09/12 07:30:21]

In your messages, because the channel_id is a parameter, you end up with a lot
of duplicated code and complexity. Instead, you could make the messages be
ROUTED, so that you can pick up the routing ID directly from the message before
unpacking, so that you can make WebSocketDispatcher::OnMessageReceived directly
find the right IPCWebSocketHandleBridge and send the message to it. Then in the
IPCWebSocketHandleBridge, you can have the message map. It would avoid most of
the code in WebSocketDispatcher.
You can even use a MessageRouter to do the map maintenance and the routing for
you.

[yhirano, 2013/09/13 12:32:29]

Since WebSocket should work on worker threads and WorkerThread does not have
GenerateRoutingID, I would like to use CONTROL messages.

+  if (!bridge) {
+    DVLOG(1) << "No bridge for channel_id=" << channel_id;
+    return;
+  }
+  bridge->DidConnect(fail, selected_protocol, extensions);
+}
+
+void WebSocketDispatcher::OnReceivedData(int channel_id,
+                                         bool fin,
+                                         WebSocketMessageType type,
+                                         std::vector<char> data) {

[piman, 2013/09/12 07:30:21]

nit: const std::vector<char> & to avoid copies

[yhirano, 2013/09/13 12:32:29]

Done.

+  DVLOG(1) << "WebSocketDispathcer::OnReceivedData("
+           << channel_id << ", "
+           << fin << ", "
+           << type << ", "
+           << "(data size = " << data.size() << "))";
+  IPCWebSocketHandleBridge* bridge = IPCWebSocketHandleBridge::Get(channel_id);
+  if (!bridge) {
+    DVLOG(1) << "No bridge for channel_id=" << channel_id;
+    return;
+  }
+  WebSocketHandleBridge::MessageType type_to_pass;
+  switch (type) {
+    case WEB_SOCKET_MESSAGE_TYPE_CONTINUATION:
+      type_to_pass = WebSocketHandleBridge::MESSAGE_TYPE_CONTINUATION;
+      break;
+    case WEB_SOCKET_MESSAGE_TYPE_TEXT:
+      type_to_pass = WebSocketHandleBridge::MESSAGE_TYPE_TEXT;
+      break;
+    case WEB_SOCKET_MESSAGE_TYPE_BINARY:
+      type_to_pass = WebSocketHandleBridge::MESSAGE_TYPE_BINARY;
+      break;
+    default:
+      NOTREACHED();
+      break;
+  }
+  bridge->DidReceiveData(fin, type_to_pass, data.data(), data.size());
+}
+
+void WebSocketDispatcher::OnReceivedFlowControl(int channel_id, int64 quota) {
+  DVLOG(1) << "WebSocketDispathcer::OnReceivedFlowControl("
+           << channel_id << ", "
+           << quota << ")";
+  IPCWebSocketHandleBridge* bridge = IPCWebSocketHandleBridge::Get(channel_id);
+  if (!bridge) {
+    DVLOG(1) << "No bridge for channel_id=" << channel_id;
+    return;
+  }
+  bridge->DidReceiveFlowControl(quota);
+}
+
+void WebSocketDispatcher::OnClosed(int channel_id,
+                                   unsigned short code,
+                                   std::string reason) {

[piman, 2013/09/12 07:30:21]

nit: const std::string&

[yhirano, 2013/09/13 12:32:29]

Done.

+  DVLOG(1) << "WebSocketDispathcer::OnClosed("
+           << channel_id << ", "
+           << code << ", "
+           << reason << ")";
+  IPCWebSocketHandleBridge* bridge = IPCWebSocketHandleBridge::Get(channel_id);
+  if (!bridge) {
+    DVLOG(1) << "No bridge for channel_id=" << channel_id;
+    return;
+  }
+  bridge->DidClose(code, reason);
+}
+
+}  // namespace content