Add UMA for the content suggestions settings

chrome/android/java/src/org/chromium/chrome/browser/preferences/ContentSuggestionsPreferences.java

 // 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.
 
 package org.chromium.chrome.browser.preferences;
 
+import android.content.Context;
+import android.content.Intent;
 import android.os.Bundle;
 import android.preference.Preference;
 import android.preference.Preference.OnPreferenceChangeListener;
 import android.preference.PreferenceFragment;
+import android.support.annotation.IntDef;
 import android.view.Menu;
 import android.view.MenuInflater;
 import android.view.MenuItem;
 
+import org.chromium.base.metrics.RecordUserAction;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeFeatureList;
 import org.chromium.chrome.browser.help.HelpAndFeedback;
 import org.chromium.chrome.browser.ntp.snippets.SnippetsBridge;
 import org.chromium.chrome.browser.profiles.Profile;
 
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
 /**
  * Settings fragment that allows the user to configure content suggestions.
  */
 public class ContentSuggestionsPreferences extends PreferenceFragment {
     private static final String PREF_MAIN_SWITCH = "suggestions_switch";
     private static final String PREF_NOTIFICATIONS_SWITCH = "suggestions_notifications_switch";
     private static final String PREF_CAVEATS = "suggestions_caveats";
     private static final String PREF_LEARN_MORE = "suggestions_learn_more";
 
+    private static final String LAUNCH_SOURCE_EXTRA = "source";
+
+    @IntDef({LAUNCH_SOURCE_SETTINGS, LAUNCH_SOURCE_NOTIFICATION})
+    @Retention(RetentionPolicy.SOURCE)
+    public @interface LaunchSource {}
+    public static final int LAUNCH_SOURCE_SETTINGS = 0;
+    public static final int LAUNCH_SOURCE_NOTIFICATION = 1;
+
     private boolean mIsEnabled;
 
     // Preferences, modified as the state of the screen changes.
     private ChromeSwitchPreference mFeatureSwitch;
     private ChromeSwitchPreference mNotificationsSwitch;
     private Preference mCaveatsDescription;
     private Preference mLearnMoreButton;
 
+    public static Intent getIntent(Context context, @LaunchSource int source) {

[Michael van Ouwerkerk, 2017/04/05 10:27:41]

This creates a new intent using createIntentForSettingsPage so let's rename this
to createIntent for consistency and clarity.

[Michael van Ouwerkerk, 2017/04/05 10:27:42]

Please add JavaDoc for this public method, probably a bit similar as for
createIntentForSettingsPage.

[dgn, 2017/04/05 13:54:07]

Done.

[dgn, 2017/04/05 13:54:07]

Done.

+        Intent intent = PreferencesLauncher.createIntentForSettingsPage(
+                context, ContentSuggestionsPreferences.class.getName());
+        intent.putExtra(LAUNCH_SOURCE_EXTRA, source);
+        return intent;
+    }
+
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
 
         addPreferencesFromResource(R.xml.suggestions_preferences);
         setHasOptionsMenu(true);
         finishSwitchInitialisation();
 
         boolean isEnabled = SnippetsBridge.isRemoteSuggestionsServiceEnabled();
         mIsEnabled = !isEnabled; // Opposite so that we trigger side effects below.
         updatePreferences(isEnabled);
+
+        @LaunchSource
+        int launchSource =
+                getActivity().getIntent().getIntExtra(LAUNCH_SOURCE_EXTRA, LAUNCH_SOURCE_SETTINGS);
+        if (launchSource == LAUNCH_SOURCE_NOTIFICATION) {
+            RecordUserAction.record("ContentSuggestions.NotificationsAction.Settings");

[Michael van Ouwerkerk, 2017/04/05 10:27:41]

Should we also record an action for LAUNCH_SOURCE_SETTINGS?

[dgn, 2017/04/05 13:54:07]

In that case I would prefer if it was in the context of the chrome settings in
general. I'll email tedchoc@ about this and add in a separate CL.

+        }
     }
 
     @Override
     public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
         menu.clear();
         MenuItem help =
                 menu.add(Menu.NONE, R.id.menu_id_targeted_help, Menu.NONE, R.string.menu_help);
         help.setIcon(R.drawable.ic_help_and_feedback);
     }
 
@@ skipping 36 matching lines @@
         if (!ChromeFeatureList.isEnabled(ChromeFeatureList.CONTENT_SUGGESTIONS_NOTIFICATIONS)) {
             return false;
         }
         return mIsEnabled;
     }
 
     private void setNotificationsPrefState(boolean visible) {
         if (visible) {
             if (findPreference(PREF_NOTIFICATIONS_SWITCH) != null) return;
             getPreferenceScreen().addPreference(mNotificationsSwitch);
-
         } else {
             getPreferenceScreen().removePreference(mNotificationsSwitch);
         }
     }
 
     private void setCaveatsPrefState(boolean visible) {
         if (visible) {
             if (findPreference(PREF_CAVEATS) != null) return;
             getPreferenceScreen().addPreference(mCaveatsDescription);
             getPreferenceScreen().addPreference(mLearnMoreButton);
         } else {
             getPreferenceScreen().removePreference(mCaveatsDescription);
             getPreferenceScreen().removePreference(mLearnMoreButton);
         }
     }
 
     private void finishSwitchInitialisation() {
         mFeatureSwitch = (ChromeSwitchPreference) findPreference(PREF_MAIN_SWITCH);
         mNotificationsSwitch = (ChromeSwitchPreference) findPreference(PREF_NOTIFICATIONS_SWITCH);
         mCaveatsDescription = findPreference(PREF_CAVEATS);
         mLearnMoreButton = findPreference(PREF_LEARN_MORE);
 
         mFeatureSwitch.setOnPreferenceChangeListener(new OnPreferenceChangeListener() {
             @Override
             public boolean onPreferenceChange(Preference preference, Object newValue) {
-                SnippetsBridge.setRemoteSuggestionsServiceEnabled((boolean) newValue);
+                boolean isEnabled = (boolean) newValue;
+                SnippetsBridge.setRemoteSuggestionsServiceEnabled(isEnabled);
                 // TODO(dgn): Is there a way to have a visual feedback of when the remote
                 // suggestions service has completed being turned on or off?
-                ContentSuggestionsPreferences.this.updatePreferences((boolean) newValue);
+                ContentSuggestionsPreferences.this.updatePreferences(isEnabled);

[Michael van Ouwerkerk, 2017/04/05 10:27:42]

Do you need to specify "ContentSuggestionsPreferences.this." or can you just
call updatePreferences directly?

[dgn, 2017/04/05 13:54:07]

Done.

+
+                if (isEnabled) {
+                    RecordUserAction.record("ContentSuggestions.RemoteSuggestionsPreferenceOn");
+                } else {
+                    RecordUserAction.record("ContentSuggestions.RemoteSuggestionsPreferenceOff");
+                }
+
                 return true;
             }
         });
         mFeatureSwitch.setManagedPreferenceDelegate(new ManagedPreferenceDelegate() {
             @Override
             public boolean isPreferenceControlledByPolicy(Preference preference) {
                 return SnippetsBridge.isRemoteSuggestionsServiceManaged();
             }
 
             @Override
             public boolean isPreferenceControlledByCustodian(Preference preference) {
                 return SnippetsBridge.isRemoteSuggestionsServiceManagedByCustodian();
             }
         });
 
         mNotificationsSwitch.setOnPreferenceChangeListener(new OnPreferenceChangeListener() {
             @Override
             public boolean onPreferenceChange(Preference preference, Object newValue) {
-                SnippetsBridge.setContentSuggestionsNotificationsEnabled((boolean) newValue);
+                boolean isEnabled = (boolean) newValue;
+                SnippetsBridge.setContentSuggestionsNotificationsEnabled(isEnabled);
+
+                if (isEnabled) {
+                    RecordUserAction.record("ContentSuggestions.NotificationsPreferenceOn");
+                } else {
+                    RecordUserAction.record("ContentSuggestions.NotificationsPreferenceOff");
+                }
+
                 return true;
             }
         });
     }
 }