📰 Move metrics and scheduling events out of SnippetsBridge

chrome/browser/android/ntp/suggestions_event_reporter_bridge.cc

+// 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/ntp/suggestions_event_reporter_bridge.h"
+
+#include <jni.h>
+#include <vector>
+
+#include "base/android/jni_android.h"
+#include "base/android/jni_array.h"
+#include "base/android/jni_string.h"
+#include "base/time/time.h"
+#include "chrome/browser/ntp_snippets/content_suggestions_service_factory.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/profiles/profile_manager.h"
+#include "components/ntp_snippets/content_suggestions_metrics.h"
+#include "components/ntp_snippets/content_suggestions_service.h"
+#include "components/ntp_snippets/remote/remote_suggestions_scheduler.h"
+#include "components/ntp_snippets/user_classifier.h"
+#include "jni/SuggestionsEventReporterBridge_jni.h"
+#include "ui/base/window_open_disposition.h"
+
+using base::android::AttachCurrentThread;
+using base::android::JavaParamRef;
+using ntp_snippets::Category;
+using ntp_snippets::UserClassifier;
+
+namespace {
+
+ntp_snippets::RemoteSuggestionsScheduler* GetRemoteSuggestionsScheduler() {
+  ntp_snippets::ContentSuggestionsService* content_suggestions_service =
+      ContentSuggestionsServiceFactory::GetForProfile(
+          ProfileManager::GetLastUsedProfile());
+  // Can maybe be null in some cases? (Incognito profile?) crbug.com/647920
+  if (!content_suggestions_service) {
+    return nullptr;
+  }
+  return content_suggestions_service->remote_suggestions_scheduler();
+}
+
+UserClassifier* GetUserClassifier() {
+  ntp_snippets::ContentSuggestionsService* content_suggestions_service =
+      ContentSuggestionsServiceFactory::GetForProfile(
+          ProfileManager::GetLastUsedProfile());
+  DCHECK(content_suggestions_service);  // TODO(dgn): remove
+
+  // Can maybe be null in some cases? (Incognito profile?) crbug.com/647920
+  if (!content_suggestions_service) {
+    return nullptr;
+  }
+  return content_suggestions_service->user_classifier();
+}
+
+}  // namespace
+
+static void OnSuggestionTargetVisited(JNIEnv* env,
+                                      const JavaParamRef<jclass>& caller,
+                                      jint j_category_id,
+                                      jlong visit_time_ms) {
+  ntp_snippets::metrics::OnSuggestionTargetVisited(
+      Category::FromIDValue(j_category_id),
+      base::TimeDelta::FromMilliseconds(visit_time_ms));
+}
+
+static void OnPageShown(
+    JNIEnv* env,
+    const JavaParamRef<jclass>& caller,
+    const JavaParamRef<jintArray>& jcategories,
+    const JavaParamRef<jintArray>& jsuggestions_per_category) {
+  std::vector<int> categories_int;
+  JavaIntArrayToIntVector(env, jcategories, &categories_int);
+  std::vector<int> suggestions_per_category_int;
+  JavaIntArrayToIntVector(env, jsuggestions_per_category,
+                          &suggestions_per_category_int);
+  DCHECK_EQ(categories_int.size(), suggestions_per_category_int.size());
+  std::vector<std::pair<Category, int>> suggestions_per_category;
+  for (size_t i = 0; i < categories_int.size(); i++) {
+    suggestions_per_category.push_back(
+        std::make_pair(Category::FromIDValue(categories_int[i]),
+                       suggestions_per_category_int[i]));
+  }
+  ntp_snippets::metrics::OnPageShown(suggestions_per_category);
+  GetUserClassifier()->OnEvent(UserClassifier::Metric::NTP_OPENED);
+}
+
+static void OnSuggestionShown(JNIEnv* env,
+                              const JavaParamRef<jclass>& caller,
+                              jint global_position,
+                              jint j_category_id,
+                              jint position_in_category,
+                              jlong publish_timestamp_ms,
+                              jfloat score,
+                              jlong fetch_timestamp_ms) {
+  ntp_snippets::metrics::OnSuggestionShown(
+      global_position, Category::FromIDValue(j_category_id),
+      position_in_category, base::Time::FromJavaTime(publish_timestamp_ms),
+      score, base::Time::FromJavaTime(fetch_timestamp_ms));
+  if (global_position == 0) {
+    GetUserClassifier()->OnEvent(UserClassifier::Metric::SUGGESTIONS_SHOWN);
+  }
+}
+
+static void OnSuggestionOpened(JNIEnv* env,
+                               const JavaParamRef<jclass>& caller,
+                               jint global_position,
+                               jint j_category_id,
+                               jint category_index,
+                               jint position_in_category,
+                               jlong publish_timestamp_ms,
+                               jfloat score,
+                               int windowOpenDisposition) {
+  const Category category = Category::FromIDValue(j_category_id);
+  ntp_snippets::metrics::OnSuggestionOpened(
+      global_position, category, category_index, position_in_category,
+      base::Time::FromJavaTime(publish_timestamp_ms), score,
+      static_cast<WindowOpenDisposition>(windowOpenDisposition));
+  ntp_snippets::ContentSuggestionsService* content_suggestions_service =
+      ContentSuggestionsServiceFactory::GetForProfile(
+          ProfileManager::GetLastUsedProfile());
+  // TODO(vitaliii): Add ContentSuggestionsService::OnSuggestionOpened and
+  // notify the ranker and the classifier there instead. Do not expose both of
+  // them at all. See crbug.com/674080.
+  content_suggestions_service->category_ranker()->OnSuggestionOpened(category);
+  content_suggestions_service->user_classifier()->OnEvent(
+      UserClassifier::Metric::SUGGESTIONS_USED);
+}
+
+static void OnSuggestionMenuOpened(JNIEnv* env,
+                                   const JavaParamRef<jclass>& caller,
+                                   jint global_position,
+                                   jint j_category_id,
+                                   jint position_in_category,
+                                   jlong publish_timestamp_ms,
+                                   jfloat score) {
+  ntp_snippets::metrics::OnSuggestionMenuOpened(
+      global_position, Category::FromIDValue(j_category_id),
+      position_in_category, base::Time::FromJavaTime(publish_timestamp_ms),
+      score);
+}
+
+static void OnMoreButtonShown(JNIEnv* env,
+                              const JavaParamRef<jclass>& caller,
+                              jint j_category_id,
+                              jint position) {
+  ntp_snippets::metrics::OnMoreButtonShown(Category::FromIDValue(j_category_id),
+                                           position);
+}
+
+static void OnMoreButtonClicked(JNIEnv* env,
+                                const JavaParamRef<jclass>& caller,
+                                jint j_category_id,
+                                jint position) {
+  ntp_snippets::metrics::OnMoreButtonClicked(
+      Category::FromIDValue(j_category_id), position);
+  GetUserClassifier()->OnEvent(UserClassifier::Metric::SUGGESTIONS_USED);
+}
+
+static void OnSurfaceOpened(JNIEnv* env, const JavaParamRef<jclass>& caller) {
+  ntp_snippets::RemoteSuggestionsScheduler* scheduler =
+      GetRemoteSuggestionsScheduler();
+  // Can be null if the feature has been disabled but the scheduler has not been
+  // unregistered yet. The next start should unregister it.
+  if (!scheduler) {
+    return;
+  }
+
+  scheduler->OnNTPOpened();
+}
+
+static void OnColdStart(JNIEnv* env, const JavaParamRef<jclass>& caller) {
+  ntp_snippets::RemoteSuggestionsScheduler* scheduler =
+      GetRemoteSuggestionsScheduler();
+  // TODO(fhorschig): Remove guard when https://crbug.com/678556 is resolved.
+  if (!scheduler) {
+    return;
+  }
+  scheduler->OnBrowserColdStart();
+}
+
+static void OnActivityWarmResumed(JNIEnv* env,
+                                  const JavaParamRef<jclass>& caller) {
+  ntp_snippets::RemoteSuggestionsScheduler* scheduler =
+      GetRemoteSuggestionsScheduler();
+  // TODO(fhorschig): Remove guard when https://crbug.com/678556 is resolved.
+  if (!scheduler) {
+    return;
+  }
+  scheduler->OnBrowserForegrounded();
+}
+
+bool RegisterSuggestionsEventReporterBridge(JNIEnv* env) {
+  return RegisterNativesImpl(env);
+}