Add pretty-printing for SETTINGS messages.

blimp/common/logging.cc

 // Copyright 2016 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/common/logging.h"
 
 #include <iostream>
 #include <string>
 #include <vector>
 
@@ skipping 48 matching lines @@
 // Conversion function for all other types.
 // Uses std::to_string() to serialize |value|.
 template <typename T>
 void AddField(const std::string& key, const T& value, LogFields* output) {
   output->push_back(std::make_pair(key, std::to_string(value)));
 }
 
 // The following LogExtractor subclasses contain logic for extracting loggable
 // fields from BlimpMessages.
 
-// Logs fields from TAB_CONTROL messages.
-class TabControlLogExtractor : public LogExtractor {
+// Logs fields from COMPOSITOR messages.
+class CompositorLogExtractor : public LogExtractor {
   void ExtractFields(const BlimpMessage& message,
                      LogFields* output) const override {
-    switch (message.tab_control().type()) {
-      case TabControlMessage::CREATE_TAB:
-        AddField("subtype", "CREATE_TAB", output);
+    AddField("render_widget_id", message.compositor().render_widget_id(),
+             output);
+  }
+};
+
+// Logs fields from INPUT messages.
+class InputLogExtractor : public LogExtractor {
+  void ExtractFields(const BlimpMessage& message,
+                     LogFields* output) const override {
+    AddField("render_widget_id", message.input().render_widget_id(), output);
+    AddField("timestamp_seconds", message.input().timestamp_seconds(), output);
+    switch (message.input().type()) {
+      case InputMessage::Type_GestureScrollBegin:
+        AddField("subtype", "GestureScrollBegin", output);
         break;
-      case TabControlMessage::CLOSE_TAB:
-        AddField("subtype", "CLOSE_TAB", output);
+      case InputMessage::Type_GestureScrollEnd:
+        AddField("subtype", "GestureScrollEnd", output);
         break;
-      case TabControlMessage::SIZE:
-        AddField("subtype", "SIZE", output);
-        AddField("size", message.tab_control().size(), output);
+      case InputMessage::Type_GestureScrollUpdate:
+        AddField("subtype", "GestureScrollUpdate", output);
+        break;
+      case InputMessage::Type_GestureFlingStart:
+        AddField("subtype", "GestureFlingStart", output);
+        break;
+      case InputMessage::Type_GestureFlingCancel:
+        AddField("subtype", "GestureFlingCancel", output);
+        AddField("prevent_boosting",
+                 message.input().gesture_fling_cancel().prevent_boosting(),
+                 output);
+        break;
+      case InputMessage::Type_GestureTap:
+        AddField("subtype", "GestureTap", output);
+        break;
+      case InputMessage::Type_GesturePinchBegin:
+        AddField("subtype", "GesturePinchBegin", output);
+        break;
+      case InputMessage::Type_GesturePinchEnd:
+        AddField("subtype", "GesturePinchEnd", output);
+        break;
+      case InputMessage::Type_GesturePinchUpdate:
+        AddField("subtype", "GesturePinchUpdate", output);
         break;
       default:  // unknown
         break;
     }
   }
 };
 
 // Logs fields from NAVIGATION messages.
 class NavigationLogExtractor : public LogExtractor {
   void ExtractFields(const BlimpMessage& message,
@@ skipping 34 matching lines @@
         break;
       case NavigationMessage::RELOAD:
         AddField("subtype", "RELOAD", output);
         break;
       default:
         break;
     }
   }
 };
 
-// Logs fields from COMPOSITOR messages.
-class CompositorLogExtractor : public LogExtractor {
+// Logs fields from PROTOCOL_CONTROL messages.
+class ProtocolControlLogExtractor : public LogExtractor {
   void ExtractFields(const BlimpMessage& message,
                      LogFields* output) const override {
-    AddField("render_widget_id", message.compositor().render_widget_id(),
-             output);
-  }
-};
-
-// Logs fields from INPUT messages.
-class InputLogExtractor : public LogExtractor {
-  void ExtractFields(const BlimpMessage& message,
-                     LogFields* output) const override {
-    AddField("render_widget_id", message.input().render_widget_id(), output);
-    AddField("timestamp_seconds", message.input().timestamp_seconds(), output);
-    switch (message.input().type()) {
-      case InputMessage::Type_GestureScrollBegin:
-        AddField("subtype", "GestureScrollBegin", output);
+    switch (message.protocol_control().type()) {
+      case ProtocolControlMessage::START_CONNECTION:
+        AddField("subtype", "START_CONNECTION", output);
+        AddField("client_token",
+                 message.protocol_control().start_connection().client_token(),
+                 output);
+        AddField(
+            "protocol_version",
+            message.protocol_control().start_connection().protocol_version(),
+            output);
         break;
-      case InputMessage::Type_GestureScrollEnd:
-        AddField("subtype", "GestureScrollEnd", output);
-        break;
-      case InputMessage::Type_GestureScrollUpdate:
-        AddField("subtype", "GestureScrollUpdate", output);
-        break;
-      case InputMessage::Type_GestureFlingStart:
-        AddField("subtype", "GestureFlingStart", output);
-        break;
-      case InputMessage::Type_GestureFlingCancel:
-        AddField("subtype", "GestureFlingCancel", output);
-        AddField("prevent_boosting",
-                 message.input().gesture_fling_cancel().prevent_boosting(),
+      case ProtocolControlMessage::CHECKPOINT_ACK:
+        AddField("subtype", "CHECKPOINT_ACK", output);
+        AddField("checkpoint_id",
+                 message.protocol_control().checkpoint_ack().checkpoint_id(),
                  output);
         break;
-      case InputMessage::Type_GestureTap:
-        AddField("subtype", "GestureTap", output);
-        break;
-      case InputMessage::Type_GesturePinchBegin:
-        AddField("subtype", "GesturePinchBegin", output);
-        break;
-      case InputMessage::Type_GesturePinchEnd:
-        AddField("subtype", "GesturePinchEnd", output);
-        break;
-      case InputMessage::Type_GesturePinchUpdate:
-        AddField("subtype", "GesturePinchUpdate", output);
-        break;
-      default:  // unknown
+      default:
         break;
     }
   }
 };
 
 // Logs fields from RENDER_WIDGET messages.
 class RenderWidgetLogExtractor : public LogExtractor {
   void ExtractFields(const BlimpMessage& message,
                      LogFields* output) const override {
     switch (message.render_widget().type()) {
       case RenderWidgetMessage::INITIALIZE:
         AddField("subtype", "INITIALIZE", output);
         break;
       case RenderWidgetMessage::CREATED:
         AddField("subtype", "CREATED", output);
         break;
       case RenderWidgetMessage::DELETED:
         AddField("subtype", "DELETED", output);
         break;
     }
     AddField("render_widget_id", message.render_widget().render_widget_id(),
              output);
   }
 };
 
-// Logs fields from PROTOCOL_CONTROL messages.
-class ProtocolControlLogExtractor : public LogExtractor {
+// Logs fields from SETTINGS messages.
+class SettingsLogExtractor : public LogExtractor {
   void ExtractFields(const BlimpMessage& message,
                      LogFields* output) const override {
-    switch (message.protocol_control().type()) {
-      case ProtocolControlMessage::START_CONNECTION:
-        AddField("subtype", "START_CONNECTION", output);
-        AddField("client_token",
-                 message.protocol_control().start_connection().client_token(),
-                 output);
-        AddField(
-            "protocol_version",
-            message.protocol_control().start_connection().protocol_version(),
-            output);
+    if (message.settings().has_engine_settings()) {
+      const EngineSettingsMessage& engine_settings =
+          message.settings().engine_settings();
+      AddField("subtype", "ENGINE_SETTINGS", output);
+      AddField("record_whole_document", engine_settings.record_whole_document(),
+               output);
+      AddField("client_os_info", engine_settings.client_os_info(), output);
+    }
+  }
+};
+
+// Logs fields from TAB_CONTROL messages.
+class TabControlLogExtractor : public LogExtractor {
+  void ExtractFields(const BlimpMessage& message,
+                     LogFields* output) const override {
+    switch (message.tab_control().type()) {
+      case TabControlMessage::CREATE_TAB:
+        AddField("subtype", "CREATE_TAB", output);
         break;
-      case ProtocolControlMessage::CHECKPOINT_ACK:
-        AddField("subtype", "CHECKPOINT_ACK", output);
-        AddField("checkpoint_id",
-                 message.protocol_control().checkpoint_ack().checkpoint_id(),
-                 output);
+      case TabControlMessage::CLOSE_TAB:
+        AddField("subtype", "CLOSE_TAB", output);
         break;
-      default:
+      case TabControlMessage::SIZE:
+        AddField("subtype", "SIZE", output);
+        AddField("size", message.tab_control().size(), output);
+        break;
+      default:  // unknown
         break;
     }
   }
 };
 
 // No fields are extracted from |message|.
 class NullLogExtractor : public LogExtractor {
   void ExtractFields(const BlimpMessage& message,
                      LogFields* output) const override {}
 };
 
 }  // namespace
 
 BlimpMessageLogger::BlimpMessageLogger() {
   AddHandler("COMPOSITOR", BlimpMessage::COMPOSITOR,
              base::WrapUnique(new CompositorLogExtractor));
   AddHandler("INPUT", BlimpMessage::INPUT,
              base::WrapUnique(new InputLogExtractor));
   AddHandler("NAVIGATION", BlimpMessage::NAVIGATION,
              base::WrapUnique(new NavigationLogExtractor));
   AddHandler("PROTOCOL_CONTROL", BlimpMessage::PROTOCOL_CONTROL,
              base::WrapUnique(new ProtocolControlLogExtractor));
   AddHandler("RENDER_WIDGET", BlimpMessage::RENDER_WIDGET,
              base::WrapUnique(new RenderWidgetLogExtractor));
+  AddHandler("SETTINGS", BlimpMessage::SETTINGS,
+             base::WrapUnique(new SettingsLogExtractor));
   AddHandler("TAB_CONTROL", BlimpMessage::TAB_CONTROL,
              base::WrapUnique(new TabControlLogExtractor));
 }
 
 BlimpMessageLogger::~BlimpMessageLogger() {}
 
 void BlimpMessageLogger::AddHandler(const std::string& type_name,
                                     BlimpMessage::Type type,
                                     std::unique_ptr<LogExtractor> extractor) {
   DCHECK(extractors_.find(type) == extractors_.end());
@@ skipping 32 matching lines @@
   }
   *out << ">";
 }
 
 std::ostream& operator<<(std::ostream& out, const BlimpMessage& message) {
   g_logger.Get().LogMessageToStream(message, &out);
   return out;
 }
 
 }  // namespace blimp