Implementation of translation event logging.

chrome/browser/translate/chrome_translate_client.cc

 // 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.
 
 #include "chrome/browser/translate/chrome_translate_client.h"
 
 #include <memory>
 #include <vector>
 
 #include "base/logging.h"
@@ skipping 32 matching lines @@
 #include "components/translate/core/browser/translate_prefs.h"
 #include "components/translate/core/common/language_detection_details.h"
 #include "components/variations/service/variations_service.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/web_contents.h"
 #include "url/gurl.h"
 
 namespace {
+using metrics::TranslateEventProto;
 
-metrics::TranslateEventProto::EventType BubbleResultToTranslateEvent(
+TranslateEventProto::EventType BubbleResultToTranslateEvent(
     ShowTranslateBubbleResult result) {
   switch (result) {
     case ShowTranslateBubbleResult::BROWSER_WINDOW_NOT_VALID:
-      return metrics::TranslateEventProto::BROWSER_WINDOW_IS_INVALID;
+      return TranslateEventProto::BROWSER_WINDOW_IS_INVALID;
     case ShowTranslateBubbleResult::BROWSER_WINDOW_MINIMIZED:
-      return metrics::TranslateEventProto::BROWSER_WINDOW_IS_MINIMIZED;
+      return TranslateEventProto::BROWSER_WINDOW_IS_MINIMIZED;
     case ShowTranslateBubbleResult::BROWSER_WINDOW_NOT_ACTIVE:
-      return metrics::TranslateEventProto::BROWSER_WINDOW_NOT_ACTIVE;
+      return TranslateEventProto::BROWSER_WINDOW_NOT_ACTIVE;
     case ShowTranslateBubbleResult::WEB_CONTENTS_NOT_ACTIVE:
-      return metrics::TranslateEventProto::WEB_CONTENTS_NOT_ACTIVE;
+      return TranslateEventProto::WEB_CONTENTS_NOT_ACTIVE;
     case ShowTranslateBubbleResult::EDITABLE_FIELD_IS_ACTIVE:
-      return metrics::TranslateEventProto::EDITABLE_FIELD_IS_ACTIVE;
+      return TranslateEventProto::EDITABLE_FIELD_IS_ACTIVE;
     default:
       NOTREACHED();
       return metrics::TranslateEventProto::UNKNOWN;
   }
 }
 
+// ========== LOG LANGUAGE DETECTION EVENT ==============
+
 std::unique_ptr<sync_pb::UserEventSpecifics> ConstructLanguageDetectionEvent(
     const int entry_id,
     const translate::LanguageDetectionDetails& details) {
   auto specifics = base::MakeUnique<sync_pb::UserEventSpecifics>();
   specifics->set_event_time_usec(base::Time::Now().ToInternalValue());
 
   // TODO(renjieliu): Revisit this field when the best way to identify
   // navigations is determined.
   specifics->set_navigation_id(base::Time::Now().ToInternalValue());
 
@@ skipping 23 matching lines @@
 
   // If entry is null, we don't record the page.
   // The navigation entry can be null in situations like download or initial
   // blank page.
   if (entry != nullptr) {
     user_event_service->RecordUserEvent(
         ConstructLanguageDetectionEvent(entry->GetUniqueID(), details));
   }
 }
 
+// ========== LOG TRANSLATE EVENT ==============
+
+bool ConstructTranslateEvent(const int entry_id,

[amoylan, 2017/05/30 03:10:56]

Can we add a comment atop this function? particularly, what does it return.

[renjieliu1, 2017/05/30 03:33:24]

Done.

+                             const TranslateEventProto& translate_event,
+                             sync_pb::UserEventSpecifics* const specifics) {
+  specifics->set_event_time_usec(base::Time::Now().ToInternalValue());
+
+  // TODO(renjieliu): Revisit this field when the best way to identify
+  // navigations is determined.
+  specifics->set_navigation_id(base::Time::Now().ToInternalValue());
+  auto* const translation = specifics->mutable_translation();
+  translation->set_from_language_code(translate_event.source_language());
+  translation->set_to_language_code(translate_event.target_language());
+  switch (translate_event.event_type()) {
+    case TranslateEventProto::UNKNOWN:
+      translation->set_interaction(sync_pb::Translation::UNKNOWN);
+      break;
+    case TranslateEventProto::USER_ACCEPT:
+      if (translate_event.has_modified_source_language() ||
+          translate_event.has_modified_target_language()) {
+        // Special case, since we don't have event enum telling us it's actually
+        // modified by user, we do this by check whether this event has modified
+        // source or target language.
+        translation->set_from_language_code(
+            translate_event.modified_source_language());
+        translation->set_to_language_code(
+            translate_event.modified_target_language());
+        translation->set_interaction(sync_pb::Translation::MANUAL);
+      } else {
+        translation->set_interaction(sync_pb::Translation::ACCEPTED);
+      }
+      break;
+    case TranslateEventProto::USER_DECLINE:

[napper, 2017/05/30 02:56:26]

I think we should keep the naming consistent (i.e. change REJECTED to DECLINE).

[renjieliu1, 2017/05/30 03:33:24]

Done. Changed the proto as well.

+      translation->set_interaction(sync_pb::Translation::REJECTED);
+      break;
+    case TranslateEventProto::USER_IGNORE:
+      translation->set_interaction(sync_pb::Translation::IGNORED);
+      break;
+    case TranslateEventProto::USER_DISMISS:
+      translation->set_interaction(sync_pb::Translation::DISMISSED);
+      break;
+    case TranslateEventProto::USER_REVERT:
+      translation->set_interaction(sync_pb::Translation::TRANSLATION_REVERTED);
+      break;
+    case TranslateEventProto::AUTOMATICALLY_TRANSLATED:
+      translation->set_interaction(sync_pb::Translation::AUTOMATIC_TRANSLATION);
+      break;
+    default:  // We don't care about other events.
+      return false;
+  }
+  return true;
+}
+
+void LogTranslateEvent(const content::WebContents* const web_contents,
+                       const metrics::TranslateEventProto& translate_event) {
+  auto* const profile =

[amoylan, 2017/05/30 03:10:56]

Do you want to DCHECK web_contents != nullptr?
Actually it seems like this could take a const WebContents& instead of a pointer
if you like.

[renjieliu1, 2017/05/30 03:33:24]

Done.

+      Profile::FromBrowserContext(web_contents->GetBrowserContext());
+
+  syncer::UserEventService* const user_event_service =
+      browser_sync::UserEventServiceFactory::GetForProfile(profile);
+
+  const auto* const entry =
+      web_contents->GetController().GetLastCommittedEntry();
+
+  // If entry is null, we don't record the page.
+  // The navigation entry can be null in situations like download or initial
+  // blank page.
+  if (entry == nullptr)
+    return;
+
+  auto specifics = base::MakeUnique<sync_pb::UserEventSpecifics>();
+  // We only log the event we care about.
+  const bool needs_logging = ConstructTranslateEvent(
+      entry->GetUniqueID(), translate_event, specifics.get());
+  if (needs_logging) {
+    user_event_service->RecordUserEvent(std::move(specifics));
+  }
+}
+
 }  // namespace
 
 DEFINE_WEB_CONTENTS_USER_DATA_KEY(ChromeTranslateClient);
 
 ChromeTranslateClient::ChromeTranslateClient(content::WebContents* web_contents)
     : content::WebContentsObserver(web_contents),
       translate_driver_(&web_contents->GetController()),
       translate_manager_(new translate::TranslateManager(
           this,
           translate::TranslateRankerFactory::GetForBrowserContext(
@@ skipping 84 matching lines @@
     if (!auto_translate_language.empty()) {
       *target = auto_translate_language;
       return;
     }
   }
 
   *target =
       translate::TranslateManager::GetTargetLanguage(translate_prefs.get());
 }
 
+void ChromeTranslateClient::RecordTranslateEvent(
+    const TranslateEventProto& translate_event) {
+  LogTranslateEvent(web_contents(), translate_event);
+}
+
 // static
 void ChromeTranslateClient::BindContentTranslateDriver(
     content::RenderFrameHost* render_frame_host,
     const service_manager::BindSourceInfo& source_info,
     translate::mojom::ContentTranslateDriverRequest request) {
   content::WebContents* web_contents =
       content::WebContents::FromRenderFrameHost(render_frame_host);
   if (!web_contents)
     return;
 
@@ skipping 183 matching lines @@
       return ShowTranslateBubbleResult::SUCCESS;
   }
 
   return TranslateBubbleFactory::Show(browser->window(), web_contents(), step,
                                       error_type);
 #else
   NOTREACHED();
   return ShowTranslateBubbleResult::SUCCESS;
 #endif
 }