Add UMA for the content suggestions settings

chrome/android/java/src/org/chromium/chrome/browser/ntp/ContentSuggestionsNotificationHelper.java

 // 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.
 
 package org.chromium.chrome.browser.ntp;
 
 import android.app.AlarmManager;
 import android.app.Notification;
 import android.app.NotificationManager;
 import android.app.PendingIntent;
@@ skipping 12 matching lines @@
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeFeatureList;
 import org.chromium.chrome.browser.IntentHandler;
 import org.chromium.chrome.browser.ShortcutHelper;
 import org.chromium.chrome.browser.document.ChromeLauncherActivity;
 import org.chromium.chrome.browser.notifications.ChromeNotificationBuilder;
 import org.chromium.chrome.browser.notifications.NotificationBuilderFactory;
 import org.chromium.chrome.browser.notifications.NotificationConstants;
 import org.chromium.chrome.browser.notifications.NotificationUmaTracker;
 import org.chromium.chrome.browser.ntp.snippets.ContentSuggestionsNotificationAction;
+import org.chromium.chrome.browser.ntp.snippets.ContentSuggestionsNotificationAction.ContentSuggestionsNotificationActionEnum;
+import org.chromium.chrome.browser.ntp.snippets.ContentSuggestionsNotificationOptOut.ContentSuggestionsNotificationOptOutEnum;
 import org.chromium.chrome.browser.preferences.ContentSuggestionsPreferences;
-import org.chromium.chrome.browser.preferences.PreferencesLauncher;
 
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
 
 /**
  * Provides functionality needed for content suggestion notifications.
  *
  * Exposes helper functions to native C++ code.
@@ skipping 21 matching lines @@
             "ntp.content_suggestions.notification.cached_action_hide_shutdown";
     private static final String PREF_CACHED_CONSECUTIVE_IGNORED =
             "ntp.content_suggestions.notification.cached_consecutive_ignored";
 
     // Tracks which URIs there is an active notification for.
     private static final String PREF_ACTIVE_NOTIFICATIONS =
             "ntp.content_suggestions.notification.active";
 
     private ContentSuggestionsNotificationHelper() {} // Prevent instantiation
 
+    public static void recordNotificationOptOut(
+            @ContentSuggestionsNotificationOptOutEnum int reason) {
+        nativeRecordNotificationOptOut(reason);
+    }
+    public static void recordNotificationAction(

[Michael van Ouwerkerk, 2017/04/05 15:47:31]

nit: empty line between methods, and docs for public methods

[dgn, 2017/04/05 16:53:54]

Done.

+            @ContentSuggestionsNotificationActionEnum int action) {
+        nativeRecordNotificationAction(action);
+    }
+
     /**
      * Opens the content suggestion when notification is tapped.
      */
     public static final class OpenUrlReceiver extends BroadcastReceiver {
         @Override
         public void onReceive(Context context, Intent intent) {
             int category = intent.getIntExtra(NOTIFICATION_CATEGORY_EXTRA, -1);
             String idWithinCategory = intent.getStringExtra(NOTIFICATION_ID_WITHIN_CATEGORY_EXTRA);
             openUrl(intent.getData());
-            recordCachedActionMetric(ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_TAP);
+            recordCachedActionMetric(ContentSuggestionsNotificationAction.TAP);
             removeActiveNotification(category, idWithinCategory);
         }
     }
 
     /**
      * Records dismissal when notification is swiped away.
      */
     public static final class DeleteReceiver extends BroadcastReceiver {
         @Override
         public void onReceive(Context context, Intent intent) {
             int category = intent.getIntExtra(NOTIFICATION_CATEGORY_EXTRA, -1);
             String idWithinCategory = intent.getStringExtra(NOTIFICATION_ID_WITHIN_CATEGORY_EXTRA);
-            recordCachedActionMetric(
-                    ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_DISMISSAL);
+            recordCachedActionMetric(ContentSuggestionsNotificationAction.DISMISSAL);
             removeActiveNotification(category, idWithinCategory);
         }
     }
 
     /**
      * Removes the notification after a timeout period.
      */
     public static final class TimeoutReceiver extends BroadcastReceiver {
         @Override
         public void onReceive(Context context, Intent intent) {
             int category = intent.getIntExtra(NOTIFICATION_CATEGORY_EXTRA, -1);
             String idWithinCategory = intent.getStringExtra(NOTIFICATION_ID_WITHIN_CATEGORY_EXTRA);
             if (findActiveNotification(category, idWithinCategory) == null) {
                 return; // tapped or swiped
             }
 
-            hideNotification(category, idWithinCategory,
-                    ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_DEADLINE);
+            hideNotification(
+                    category, idWithinCategory, ContentSuggestionsNotificationAction.HIDE_DEADLINE);
         }
     }
 
     private static void openUrl(Uri uri) {
         Context context = ContextUtils.getApplicationContext();
         Intent intent = new Intent()
                                 .setAction(Intent.ACTION_VIEW)
                                 .setData(uri)
                                 .setClass(context, ChromeLauncherActivity.class)
                                 .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
@@ skipping 38 matching lines @@
                         .setContentIntent(contentIntent)
                         .setDeleteIntent(deleteIntent)
                         .setContentTitle(title)
                         .setContentText(text)
                         .setGroup(NOTIFICATION_TAG)
                         .setPriority(priority)
                         .setLargeIcon(image)
                         .setSmallIcon(R.drawable.ic_chrome);
         if (ChromeFeatureList.isEnabled(ChromeFeatureList.CONTENT_SUGGESTIONS_SETTINGS)) {
             PendingIntent settingsIntent = PendingIntent.getActivity(context, 0,
-                    PreferencesLauncher.createIntentForSettingsPage(
-                            context, ContentSuggestionsPreferences.class.getName()),
+                    ContentSuggestionsPreferences.createLaunchIntent(
+                            context, ContentSuggestionsPreferences.LAUNCH_SOURCE_NOTIFICATION),
                     0);
             builder.addAction(R.drawable.settings_cog, context.getString(R.string.preferences),
                     settingsIntent);
         }
         if (priority >= 0) {
             builder.setDefaults(Notification.DEFAULT_ALL);
         }
         manager.notify(NOTIFICATION_TAG, nextId, builder.build());
         NotificationUmaTracker.getInstance().onNotificationShown(
                 NotificationUmaTracker.CONTENT_SUGGESTION);
@@ skipping 154 matching lines @@
             Uri notificationUri = Uri.parse(serialized);
             ActiveNotification activeNotification = ActiveNotification.fromUri(notificationUri);
             if ((activeNotification != null) && (activeNotification.mId >= nextId)) {
                 nextId = activeNotification.mId + 1;
             }
         }
         return nextId;
     }
 
     private static String cachedMetricNameForAction(
-            @ContentSuggestionsNotificationAction.ContentSuggestionsNotificationActionEnum
-            int action) {
+            @ContentSuggestionsNotificationActionEnum int action) {
         switch (action) {
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_TAP:
+            case ContentSuggestionsNotificationAction.TAP:
                 return PREF_CACHED_ACTION_TAP;
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_DISMISSAL:
+            case ContentSuggestionsNotificationAction.DISMISSAL:
                 return PREF_CACHED_ACTION_DISMISSAL;
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_DEADLINE:
+            case ContentSuggestionsNotificationAction.HIDE_DEADLINE:
                 return PREF_CACHED_ACTION_HIDE_DEADLINE;
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_EXPIRY:
+            case ContentSuggestionsNotificationAction.HIDE_EXPIRY:
                 return PREF_CACHED_ACTION_HIDE_EXPIRY;
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_FRONTMOST:
+            case ContentSuggestionsNotificationAction.HIDE_FRONTMOST:
                 return PREF_CACHED_ACTION_HIDE_FRONTMOST;
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_DISABLED:
+            case ContentSuggestionsNotificationAction.HIDE_DISABLED:
                 return PREF_CACHED_ACTION_HIDE_DISABLED;
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_SHUTDOWN:
+            case ContentSuggestionsNotificationAction.HIDE_SHUTDOWN:
                 return PREF_CACHED_ACTION_HIDE_SHUTDOWN;
         }
         return "";
     }
 
     /**
      * Records that an action was performed on a notification.
      *
      * Also tracks the number of consecutively-ignored notifications, resetting it on a tap or
      * otherwise incrementing it.
      *
      * This method may be called when the native library is not loaded. If it is loaded, the metrics
      * will immediately be sent to C++. If not, it will cache them for a later call to
      * flushCachedMetrics().
      *
      * @param action The action to update the pref for.
      */
     private static void recordCachedActionMetric(
-            @ContentSuggestionsNotificationAction.ContentSuggestionsNotificationActionEnum
-            int action) {
+            @ContentSuggestionsNotificationActionEnum int action) {
         String prefName = cachedMetricNameForAction(action);
         assert !prefName.isEmpty();
 
         SharedPreferences prefs = ContextUtils.getAppSharedPreferences();
         int currentValue = prefs.getInt(prefName, 0);
 
         int consecutiveIgnored = prefs.getInt(PREF_CACHED_CONSECUTIVE_IGNORED, 0);
         switch (action) {
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_TAP:
+            case ContentSuggestionsNotificationAction.TAP:
                 consecutiveIgnored = 0;
                 break;
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_DISMISSAL:
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_DEADLINE:
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_EXPIRY:
+            case ContentSuggestionsNotificationAction.DISMISSAL:
+            case ContentSuggestionsNotificationAction.HIDE_DEADLINE:
+            case ContentSuggestionsNotificationAction.HIDE_EXPIRY:
                 ++consecutiveIgnored;
                 break;
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_FRONTMOST:
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_DISABLED:
-            case ContentSuggestionsNotificationAction.CONTENT_SUGGESTIONS_HIDE_SHUTDOWN:
+            case ContentSuggestionsNotificationAction.HIDE_FRONTMOST:
+            case ContentSuggestionsNotificationAction.HIDE_DISABLED:
+            case ContentSuggestionsNotificationAction.HIDE_SHUTDOWN:
                 break; // no change
         }
 
         prefs.edit()
                 .putInt(prefName, currentValue + 1)
                 .putInt(PREF_CACHED_CONSECUTIVE_IGNORED, consecutiveIgnored)
                 .apply();
 
         if (LibraryLoader.isInitialized()) {
             flushCachedMetrics();
@@ skipping 33 matching lines @@
                     .remove(PREF_CACHED_ACTION_HIDE_DISABLED)
                     .remove(PREF_CACHED_ACTION_HIDE_SHUTDOWN)
                     .remove(PREF_CACHED_CONSECUTIVE_IGNORED)
                     .apply();
         }
     }
 
     private static native void nativeReceiveFlushedMetrics(int tapCount, int dismissalCount,
             int hideDeadlineCount, int hideExpiryCount, int hideFrontmostCount,
             int hideDisabledCount, int hideShutdownCount, int consecutiveIgnored);
+    private static native void nativeRecordNotificationOptOut(
+            @ContentSuggestionsNotificationOptOutEnum int reason);
+    private static native void nativeRecordNotificationAction(
+            @ContentSuggestionsNotificationActionEnum int action);
 }