[TTS] Write initial Tap-features to Ranker.

chrome/browser/android/contextualsearch/contextual_search_ranker_logger_impl.cc

Index: chrome/browser/android/contextualsearch/contextual_search_ranker_logger_impl.cc
diff --git a/chrome/browser/android/contextualsearch/contextual_search_ranker_logger_impl.cc b/chrome/browser/android/contextualsearch/contextual_search_ranker_logger_impl.cc
new file mode 100644
index 0000000000000000000000000000000000000000..7d99e6fed156157059d2932c5d076e68e16bc6eb
--- /dev/null
+++ b/chrome/browser/android/contextualsearch/contextual_search_ranker_logger_impl.cc
@@ -0,0 +1,96 @@
+// Copyright 2017 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/android/contextualsearch/contextual_search_ranker_logger_impl.h>
+
+#include "base/android/jni_string.h"
+#include "base/android/scoped_java_ref.h"
+#include "base/metrics/metrics_hashes.h"
+#include "chrome/browser/browser_process.h"
+#include "components/keyed_service/core/keyed_service.h"
+#include "components/ukm/ukm_entry_builder.h"
+#include "components/ukm/ukm_service.h"
+#include "jni/ContextualSearchRankerLoggerImpl_jni.h"
+
+ContextualSearchRankerLoggerImpl::ContextualSearchRankerLoggerImpl(

[rkaplow, 2017/05/11 19:46:49]

to verify - when void destroy() is called from the Java, that will destruct this
object instance, correct?

[Donn Denman, 2017/05/11 23:34:39]

That's correct. The java nativeDestroy method calls the native Destroy method in
this class, which calls the destructor explicitly.

+    JNIEnv* env,
+    jobject obj) {
+  java_object_.Reset(env, obj);
+}
+
+ContextualSearchRankerLoggerImpl::~ContextualSearchRankerLoggerImpl() {
+  java_object_ = nullptr;
+}
+
+void ContextualSearchRankerLoggerImpl::SetUkmServiceAndUrls(
+    JNIEnv* env,
+    jobject obj,
+    const base::android::JavaParamRef<jstring>& j_base_page_url,
+    const base::android::JavaParamRef<jstring>& j_model_url) {
+  GURL page_url =
+      GURL(base::android::ConvertJavaStringToUTF8(env, j_base_page_url));
+  std::string model_url =
+      base::android::ConvertJavaStringToUTF8(env, j_model_url);
+  ukm::UkmService* ukm_service = g_browser_process->ukm_service();

[rkaplow, 2017/05/11 19:46:49]

where is g_browser_process from?

[Donn Denman, 2017/05/11 23:34:40]

Evidently this is a Chrome global, included by browser_process.h
(https://cs.chromium.org/search/?q=g_browser_process&sq=package:chromium&type=cs).

I cribbed this from the translate UKM code.

+  SetUkmService(ukm_service, page_url);
+  // TODO(donnd): what to do with the model URL?

[rkaplow, 2017/05/11 19:46:49]

I'm actually not sure the difference between the model URL and the base URL -
can you document this somewhere

[Donn Denman, 2017/05/11 23:34:40]

Done by adding param descriptions to this header file for SetUkmServiceAndUrls.

+  DVLOG(3) << "ctxs model URL is " << model_url;
+}
+
+void ContextualSearchRankerLoggerImpl::SetUkmService(
+    ukm::UkmService* ukm_service,
+    const GURL& page_url) {
+  ukm_service_ = ukm_service;
+  DVLOG(3) << "ctxs Setting up UKM for url: " << page_url.spec();
+  int32_t source_id_ = ukm_service_->GetNewSourceID();

[rkaplow, 2017/05/11 19:46:49]

can remove type

[Donn Denman, 2017/05/11 23:34:40]

Nice catch, thanks!  Done.

+  ukm_service_->UpdateSourceURL(source_id_, page_url);
+  builder_ = ukm_service_->GetEntryBuilder(source_id_, "ContextualSearch");
+}
+
+void ContextualSearchRankerLoggerImpl::LogLong(
+    JNIEnv* env,
+    jobject obj,
+    const base::android::JavaParamRef<jstring>& j_feature,
+    jlong j_long) {
+  std::string feature = base::android::ConvertJavaStringToUTF8(env, j_feature);
+  DVLOG(3) << "ctxs logging feature " << feature << " value " << j_long;
+  builder_->AddMetric(feature.c_str(), j_long);
+}
+
+void ContextualSearchRankerLoggerImpl::LogString(
+    JNIEnv* env,
+    jobject obj,
+    const base::android::JavaParamRef<jstring>& j_feature,
+    const base::android::JavaParamRef<jstring>& j_string) {
+  std::string feature = base::android::ConvertJavaStringToUTF8(env, j_feature);
+  std::string string = base::android::ConvertJavaStringToUTF8(env, j_string);
+  DVLOG(3) << "ctxs logging feature " << feature << " value " << string;
+  builder_->AddMetric(feature.c_str(), base::HashMetricName(string));
+}
+
+void ContextualSearchRankerLoggerImpl::WriteLogAndReset(JNIEnv* env,
+                                                        jobject obj) {
+  ukm_service_->Flush();

[rkaplow, 2017/05/11 19:46:49]

I wouldn't use Flush - i think we actually want to make this private to UKM
actually.

[Donn Denman, 2017/05/11 23:34:39]

OK, I'm not sure I understand the nuances of this, but removed the Flush() call.

+  // Set up another builder for the next record (in case it's needed).
+  builder_ = ukm_service_->GetEntryBuilder(source_id_, "ContextualSearch");

[rkaplow, 2017/05/11 19:46:49]

this is fine to use when the interaction with CS is complete and you want to
start a new Entry. Note we want the abstraction that an Entry should coorespond
to a collection of related information - in your case, probably a single CS
interaction.

In this case, this is a new set of information, but it is against the same
source_. WHen do we want this to be triggered, when CS is re-opened for example?

[Donn Denman, 2017/05/11 23:34:40]

That's right, this method should be called each time the overlay panel goes away
and we've collected a full record of that single user-interaction.

I'm not clear if we should ever switch to a different source, except as we do
now when we exit/restart Chrome. 

+  DVLOG(3) << "ctxs Flushing and creating a new builder";
+}
+
+// Java wrapper boilerplate
+
+void ContextualSearchRankerLoggerImpl::Destroy(
+    JNIEnv* env,
+    const base::android::JavaParamRef<jobject>& obj) {
+  delete this;
+}
+
+bool RegisterContextualSearchRankerLoggerImpl(JNIEnv* env) {
+  return RegisterNativesImpl(env);
+}
+
+jlong Init(JNIEnv* env, const base::android::JavaParamRef<jobject>& obj) {
+  ContextualSearchRankerLoggerImpl* ranker_logger_impl =
+      new ContextualSearchRankerLoggerImpl(env, obj);
+  return reinterpret_cast<intptr_t>(ranker_logger_impl);
+}