Move SharedPrefs from ChromeSurveyController to ChromePreferenceKeys

Register them in ChromePreferenceKeys and use SharedPreferencesManager
consistently instead of SharedPreferences directly.

Bug: 1022108
Change-Id: I3dcf06de160044cc0abd423ede2738ef212b21de
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2005368
Commit-Queue: Henrique Nakashima <hnakashima@chromium.org>
Reviewed-by: Theresa  <twellington@chromium.org>
Cr-Commit-Position: refs/heads/master@{#733403}

chrome/android/java/src/org/chromium/chrome/browser/survey/ChromeSurveyController.java

@@ -5,7 +5,6 @@
 package org.chromium.chrome.browser.survey;
 
 import android.content.Context;
-import android.content.SharedPreferences;
 import android.os.Handler;
 import android.text.TextUtils;
 
@@ -27,6 +26,8 @@ import org.chromium.chrome.browser.infobar.InfoBarContainerLayout.Item;
 import org.chromium.chrome.browser.infobar.InfoBarIdentifier;
 import org.chromium.chrome.browser.infobar.SurveyInfoBar;
 import org.chromium.chrome.browser.infobar.SurveyInfoBarDelegate;
+import org.chromium.chrome.browser.preferences.ChromePreferenceKeys;
+import org.chromium.chrome.browser.preferences.SharedPreferencesManager;
 import org.chromium.chrome.browser.settings.privacy.PrivacyPreferencesManager;
 import org.chromium.chrome.browser.tab.EmptyTabObserver;
 import org.chromium.chrome.browser.tab.Tab;
@@ -46,13 +47,6 @@ import java.util.Random;
  * Class that controls if and when to show surveys related to the Chrome Home experiment.
  */
 public class ChromeSurveyController implements InfoBarContainer.InfoBarAnimationListener {
-    /**
-     *  The survey questions for this survey are the same as those in the survey used for Chrome
-     *  Home, so we reuse the old infobar key to prevent the users from seeing the same survey more
-     *  than once.
-     */
-    static final String SURVEY_INFO_BAR_DISPLAYED_KEY = "chrome_home_survey_info_bar_displayed";
-    static final String DATE_LAST_ROLLED_KEY = "last_rolled_for_chrome_survey_key";
 
     private static final String CHROME_SURVEY_TRIAL_NAME = "ChromeSurvey";
     private static final String MAX_NUMBER = "max-number";
@@ -269,8 +263,8 @@ public class ChromeSurveyController implements InfoBarContainer.InfoBarAnimation
     /** @return If the survey info bar for this survey was logged as seen before. */
     @VisibleForTesting
     boolean hasInfoBarBeenDisplayed() {
-        SharedPreferences sharedPreferences = ContextUtils.getAppSharedPreferences();
-        if (sharedPreferences.getLong(SURVEY_INFO_BAR_DISPLAYED_KEY, -1L) != -1L) {
+        SharedPreferencesManager preferences = SharedPreferencesManager.getInstance();
+        if (preferences.readLong(ChromePreferenceKeys.SURVEY_INFO_BAR_DISPLAYED, -1L) != -1L) {
             recordSurveyFilteringResult(FilteringResult.SURVEY_INFOBAR_ALREADY_DISPLAYED);
             return true;
         }
@@ -317,8 +311,8 @@ public class ChromeSurveyController implements InfoBarContainer.InfoBarAnimation
      */
     @VisibleForTesting
     boolean isRandomlySelectedForSurvey() {
-        SharedPreferences preferences = ContextUtils.getAppSharedPreferences();
-        int lastDate = preferences.getInt(DATE_LAST_ROLLED_KEY, -1);
+        SharedPreferencesManager preferences = SharedPreferencesManager.getInstance();
+        int lastDate = preferences.readInt(ChromePreferenceKeys.SURVEY_DATE_LAST_ROLLED, -1);
         int today = getDayOfYear();
         if (lastDate == today) {
             recordSurveyFilteringResult(FilteringResult.USER_ALREADY_SAMPLED_TODAY);
@@ -345,7 +339,7 @@ public class ChromeSurveyController implements InfoBarContainer.InfoBarAnimation
             return false;
         }
 
-        preferences.edit().putInt(DATE_LAST_ROLLED_KEY, today).apply();
+        preferences.writeInt(ChromePreferenceKeys.SURVEY_DATE_LAST_ROLLED, today);
         if (getRandomNumberUpTo(maxNumber) == 0) {
             recordSurveyFilteringResult(FilteringResult.USER_SELECTED_FOR_SURVEY);
             return true;
@@ -436,7 +430,7 @@ public class ChromeSurveyController implements InfoBarContainer.InfoBarAnimation
         };
     }
 
-    /** Logs in {@link SharedPreferences} that the info bar was displayed. */
+    /** Logs in SharedPreferences that the info bar was displayed. */
     private void recordInfoBarDisplayed() {
         // This can be called multiple times e.g. by mLoggingHandler & onSurveyInfoBarClosed().
         // Return early to allow only one call to this method (http://crbug.com/791076).
@@ -447,10 +441,9 @@ public class ChromeSurveyController implements InfoBarContainer.InfoBarAnimation
 
         mLoggingHandler.removeCallbacksAndMessages(null);
 
-        SharedPreferences sharedPreferences = ContextUtils.getAppSharedPreferences();
-        sharedPreferences.edit()
-                .putLong(SURVEY_INFO_BAR_DISPLAYED_KEY, System.currentTimeMillis())
-                .apply();
+        SharedPreferencesManager preferences = SharedPreferencesManager.getInstance();
+        preferences.writeLong(
+                ChromePreferenceKeys.SURVEY_INFO_BAR_DISPLAYED, System.currentTimeMillis());
         mSurveyInfoBarTab = null;
     }
 
@@ -518,7 +511,7 @@ public class ChromeSurveyController implements InfoBarContainer.InfoBarAnimation
 
     @VisibleForTesting
     public static String getChromeSurveyInfoBarDisplayedKey() {
-        return SURVEY_INFO_BAR_DISPLAYED_KEY;
+        return ChromePreferenceKeys.SURVEY_INFO_BAR_DISPLAYED;
     }
 
     @VisibleForTesting

chrome/android/junit/src/org/chromium/chrome/browser/survey/ChromeSurveyControllerTest.java

@@ -10,7 +10,6 @@ import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.verify;
 
-import android.content.SharedPreferences;
 import android.util.ArrayMap;
 
 import org.junit.After;
@@ -22,10 +21,11 @@ import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
 import org.robolectric.annotation.Config;
 
-import org.chromium.base.ContextUtils;
 import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.base.test.BaseRobolectricTestRunner;
 import org.chromium.chrome.browser.flags.ChromeFeatureList;
+import org.chromium.chrome.browser.preferences.ChromePreferenceKeys;
+import org.chromium.chrome.browser.preferences.SharedPreferencesManager;
 import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.tabmodel.TabModelSelector;
 import org.chromium.content_public.browser.WebContents;
@@ -43,7 +43,7 @@ public class ChromeSurveyControllerTest {
 
     private TestChromeSurveyController mTestController;
     private RiggedSurveyController mRiggedController;
-    private SharedPreferences mSharedPreferences;
+    private SharedPreferencesManager mSharedPreferences;
 
     @Mock
     Tab mTab;
@@ -61,7 +61,7 @@ public class ChromeSurveyControllerTest {
 
         mTestController = new TestChromeSurveyController();
         mTestController.setTabModelSelector(mSelector);
-        mSharedPreferences = ContextUtils.getAppSharedPreferences();
+        mSharedPreferences = SharedPreferencesManager.getInstance();
         Assert.assertNull("Tab should be null", mTestController.getLastTabInfobarShown());
         Map<String, Boolean> featureMap = new ArrayMap<>();
         featureMap.put(ChromeFeatureList.HORIZONTAL_TAB_SWITCHER_ANDROID, true);
@@ -76,12 +76,10 @@ public class ChromeSurveyControllerTest {
     @Test
     public void testInfoBarDisplayedBefore() {
         Assert.assertFalse(
-                mSharedPreferences.contains(ChromeSurveyController.SURVEY_INFO_BAR_DISPLAYED_KEY));
+                mSharedPreferences.contains(ChromePreferenceKeys.SURVEY_INFO_BAR_DISPLAYED));
         Assert.assertFalse(mTestController.hasInfoBarBeenDisplayed());
-        mSharedPreferences.edit()
-                .putLong(ChromeSurveyController.SURVEY_INFO_BAR_DISPLAYED_KEY,
-                        System.currentTimeMillis())
-                .apply();
+        mSharedPreferences.writeLong(
+                ChromePreferenceKeys.SURVEY_INFO_BAR_DISPLAYED, System.currentTimeMillis());
         Assert.assertTrue(mTestController.hasInfoBarBeenDisplayed());
     }
 
@@ -171,7 +169,7 @@ public class ChromeSurveyControllerTest {
     @Test
     public void testEligibilityRolledYesterday() {
         mRiggedController = new RiggedSurveyController(0, 5, 10);
-        mSharedPreferences.edit().putInt(ChromeSurveyController.DATE_LAST_ROLLED_KEY, 4);
+        mSharedPreferences.writeInt(ChromePreferenceKeys.SURVEY_DATE_LAST_ROLLED, 4);
         Assert.assertTrue(
                 "Random selection should be true", mRiggedController.isRandomlySelectedForSurvey());
     }
@@ -179,7 +177,7 @@ public class ChromeSurveyControllerTest {
     @Test
     public void testEligibilityRollingTwiceSameDay() {
         mRiggedController = new RiggedSurveyController(0, 5, 10);
-        mSharedPreferences.edit().putInt(ChromeSurveyController.DATE_LAST_ROLLED_KEY, 5).apply();
+        mSharedPreferences.writeInt(ChromePreferenceKeys.SURVEY_DATE_LAST_ROLLED, 5);
         Assert.assertFalse("Random selection should be false",
                 mRiggedController.isRandomlySelectedForSurvey());
     }
@@ -188,22 +186,22 @@ public class ChromeSurveyControllerTest {
     public void testEligibilityFirstTimeRollingQualifies() {
         mRiggedController = new RiggedSurveyController(0, 5, 10);
         Assert.assertFalse(
-                mSharedPreferences.contains(ChromeSurveyController.DATE_LAST_ROLLED_KEY));
+                mSharedPreferences.contains(ChromePreferenceKeys.SURVEY_DATE_LAST_ROLLED));
         Assert.assertTrue(
                 "Random selection should be true", mRiggedController.isRandomlySelectedForSurvey());
         Assert.assertEquals("Numbers should match", 5,
-                mSharedPreferences.getInt(ChromeSurveyController.DATE_LAST_ROLLED_KEY, -1));
+                mSharedPreferences.readInt(ChromePreferenceKeys.SURVEY_DATE_LAST_ROLLED, -1));
     }
 
     @Test
     public void testEligibilityFirstTimeRollingDoesNotQualify() {
         mRiggedController = new RiggedSurveyController(5, 1, 10);
         Assert.assertFalse(
-                mSharedPreferences.contains(ChromeSurveyController.DATE_LAST_ROLLED_KEY));
+                mSharedPreferences.contains(ChromePreferenceKeys.SURVEY_DATE_LAST_ROLLED));
         Assert.assertFalse(
                 "Random selection should be true", mRiggedController.isRandomlySelectedForSurvey());
         Assert.assertEquals("Numbers should match", 1,
-                mSharedPreferences.getInt(ChromeSurveyController.DATE_LAST_ROLLED_KEY, -1));
+                mSharedPreferences.readInt(ChromePreferenceKeys.SURVEY_DATE_LAST_ROLLED, -1));
     }
 
     class RiggedSurveyController extends ChromeSurveyController {

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

@@ -530,6 +530,14 @@ public final class ChromePreferenceKeys {
 
     public static final String SNAPSHOT_DATABASE_REMOVED = "snapshot_database_removed";
 
+    public static final String SURVEY_DATE_LAST_ROLLED = "last_rolled_for_chrome_survey_key";
+    /**
+     *  The survey questions for this survey are the same as those in the survey used for Chrome
+     *  Home, so we reuse the old infobar key to prevent the users from seeing the same survey more
+     *  than once.
+     */
+    public static final String SURVEY_INFO_BAR_DISPLAYED = "chrome_home_survey_info_bar_displayed";
+
     public static final String SYNC_SESSIONS_UUID = "chromium.sync.sessions.id";
 
     public static final String TABBED_ACTIVITY_LAST_BACKGROUNDED_TIME_MS_PREF =
@@ -806,6 +814,8 @@ public final class ChromePreferenceKeys {
                 SIGNIN_PROMO_SETTINGS_PERSONALIZED_DISMISSED,
                 SNAPSHOT_DATABASE_REMOVED,
                 START_SURFACE_SINGLE_PANE_ENABLED_KEY,
+                SURVEY_DATE_LAST_ROLLED,
+                SURVEY_INFO_BAR_DISPLAYED,
                 SYNC_SESSIONS_UUID,
                 TABBED_ACTIVITY_LAST_BACKGROUNDED_TIME_MS_PREF,
                 TAB_ID_MANAGER_NEXT_ID,