Added a debug info UI for Blimp

blimp/client/session/blimp_client_session.cc

 // Copyright 2015 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 "blimp/client/session/blimp_client_session.h"
 
 #include <vector>
 
 #include "base/command_line.h"
 #include "base/memory/ptr_util.h"
@@ skipping 55 matching lines @@
 
 }  // namespace
 
 // This class's functions and destruction are all invoked on the IO thread by
 // the BlimpClientSession.
 class ClientNetworkComponents : public ConnectionHandler,
                                 public ConnectionErrorObserver {
  public:
   // Can be created on any thread.
   explicit ClientNetworkComponents(
-      std::unique_ptr<NetworkEventObserver> observer);
+      std::unique_ptr<NetworkEventObserver> observer,
+      BlimpConnectionDetails* blimp_connection_details);

[Kevin M, 2016/05/10 23:54:24]

This is racy. |blimp_connection_details| can be destroyed on the UI thread while
it's still being used on the IO thread. You'll need to code a solution that
ensures the object is always accessed and destroyed on the same thread. Weak
pointers w/PostTask or threadsafe refcounted pointers might work here.

[shaktisahu, 2016/05/16 05:41:38]

Okay. I have redesigned now. |blimp_connection_details| will be created on UI
thread and destroyed on IO thread. The methods will be called from UI thread
(commit count) and IO thread (bytes received/sent) which will be passed to UI
thread through PostTask. Let me know if this is okay.

   ~ClientNetworkComponents() override;
 
   // Sets up network components.
   void Initialize();
 
   // Starts the connection to the engine using the given |assignment|.
   // It is required to first call Initialize.
   void ConnectWithAssignment(const Assignment& assignment);
 
   BrowserConnectionHandler* GetBrowserConnectionHandler();
 
  private:
   // ConnectionHandler implementation.
   void HandleConnection(std::unique_ptr<BlimpConnection> connection) override;
 
   // ConnectionErrorObserver implementation.
   void OnConnectionError(int error) override;
 
   std::unique_ptr<BrowserConnectionHandler> connection_handler_;
   std::unique_ptr<ClientConnectionManager> connection_manager_;
   std::unique_ptr<NetworkEventObserver> network_observer_;
 
+  BlimpConnectionDetails* connection_details_;
+
   DISALLOW_COPY_AND_ASSIGN(ClientNetworkComponents);
 };
 
 ClientNetworkComponents::ClientNetworkComponents(
-    std::unique_ptr<NetworkEventObserver> network_observer)
+    std::unique_ptr<NetworkEventObserver> network_observer,
+    BlimpConnectionDetails* details)
     : connection_handler_(new BrowserConnectionHandler),
-      network_observer_(std::move(network_observer)) {}
+      network_observer_(std::move(network_observer)),
+      connection_details_(details) {}
 
 ClientNetworkComponents::~ClientNetworkComponents() {}
 
 void ClientNetworkComponents::Initialize() {
   DCHECK(!connection_manager_);
   connection_manager_ = base::WrapUnique(new ClientConnectionManager(this));
 }
 
 void ClientNetworkComponents::ConnectWithAssignment(
     const Assignment& assignment) {
@@ skipping 27 matching lines @@
 BrowserConnectionHandler*
 ClientNetworkComponents::GetBrowserConnectionHandler() {
   return connection_handler_.get();
 }
 
 void ClientNetworkComponents::HandleConnection(
     std::unique_ptr<BlimpConnection> connection) {
   VLOG(1) << "Connection established.";
   connection->AddConnectionErrorObserver(this);
   network_observer_->OnConnected();
+  connection->SetBlimpConnectionDetails(connection_details_);
   connection_handler_->HandleConnection(std::move(connection));
 }
 
 void ClientNetworkComponents::OnConnectionError(int result) {
   VLOG(1) << "Connection error: " << net::ErrorToString(result);
   network_observer_->OnDisconnected(result);
 }
 
 BlimpClientSession::BlimpClientSession(const GURL& assigner_endpoint)
     : io_thread_("BlimpIOThread"),
+      blimp_connection_details_(new BlimpConnectionDetails(this)),
       tab_control_feature_(new TabControlFeature),
-      navigation_feature_(new NavigationFeature),
+      navigation_feature_(
+          new NavigationFeature(blimp_connection_details_.get())),
       ime_feature_(new ImeFeature),
       render_widget_feature_(new RenderWidgetFeature),
       settings_feature_(new SettingsFeature),
       weak_factory_(this) {
   net_components_.reset(new ClientNetworkComponents(
       base::WrapUnique(new CrossThreadNetworkEventObserver(
-          weak_factory_.GetWeakPtr(),
-          base::SequencedTaskRunnerHandle::Get()))));
+          weak_factory_.GetWeakPtr(), base::SequencedTaskRunnerHandle::Get())),
+      blimp_connection_details_.get()));
+
   base::Thread::Options options;
   options.message_loop_type = base::MessageLoop::TYPE_IO;
   io_thread_.StartWithOptions(options);
 
   assignment_source_.reset(new AssignmentSource(
       assigner_endpoint, io_thread_.task_runner(), io_thread_.task_runner()));
 
   RegisterFeatures();
 
   // Initialize must only be posted after the RegisterFeature calls have
@@ skipping 61 matching lines @@
   // Client will not send send any RenderWidget messages, so don't save the
   // outgoing BlimpMessageProcessor in the RenderWidgetFeature.
   thread_pipe_manager_->RegisterFeature(BlimpMessage::RENDER_WIDGET,
                                         render_widget_feature_.get());
 
   ime_feature_->set_outgoing_message_processor(
       thread_pipe_manager_->RegisterFeature(BlimpMessage::IME,
                                             ime_feature_.get()));
 }
 
+void BlimpClientSession::OnPacketReceived(int bytes) {}

[Kevin M, 2016/05/10 23:54:24]

nit: the name says OnPacketReceived, but the parameter is bytes, not packet
count? Should it be OnDataReceived?

nit: shouldn't we encapsulate these telemetry events in a class instead of
adding to the public interface?

major issue: Pushing statistics to Java for every packet sent or received is
really wasteful, since it'll introduce a whole lot of JNI overhead. We should
have Java pull the data instead, e.g. only when the info UI is pulled up.

[shaktisahu, 2016/05/16 05:41:38]

Method dropped. Now I have only one method called UpdateDebugInfo.
Also I am sending the data only when debug is enabled from the UI.

+
+void BlimpClientSession::OnPacketSent(int bytes) {}
+
 void BlimpClientSession::OnConnected() {}
 
 void BlimpClientSession::OnDisconnected(int result) {}
 
 TabControlFeature* BlimpClientSession::GetTabControlFeature() const {
   return tab_control_feature_.get();
 }
 
 NavigationFeature* BlimpClientSession::GetNavigationFeature() const {
   return navigation_feature_.get();
 }
 
 ImeFeature* BlimpClientSession::GetImeFeature() const {
   return ime_feature_.get();
 }
 
 RenderWidgetFeature* BlimpClientSession::GetRenderWidgetFeature() const {
   return render_widget_feature_.get();
 }
 
 SettingsFeature* BlimpClientSession::GetSettingsFeature() const {
   return settings_feature_.get();
 }
 
 }  // namespace client
 }  // namespace blimp