Snackbar for promoting Data Saver to existing users

chrome/android/java/src/org/chromium/chrome/browser/preferences/datareduction/DataReductionPromoUtils.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.preferences.datareduction;
 
 import org.chromium.base.ContextUtils;
 import org.chromium.chrome.browser.net.spdyproxy.DataReductionProxySettings;
 import org.chromium.chrome.browser.preferences.PrefServiceBridge;
 import org.chromium.chrome.browser.preferences.PrefServiceBridge.AboutVersionStrings;
 
 /**
  * Helper functions for displaying the various data reduction proxy promos. The promo screens
  * inform users of the benefits of Data Saver.
  */
 public class DataReductionPromoUtils {
     /**
-     * Keys used to save whether the first run experience or second run promo screen has been shown,
-     * the time in milliseconds since epoch it was shown, the Chrome version it was shown in, and
-     * whether the user opted out of the data reduction proxy in the FRE promo.
+     * Key used to save whether the first run experience or second run promo screen has been shown.
      */
     private static final String SHARED_PREF_DISPLAYED_FRE_OR_SECOND_RUN_PROMO =
             "displayed_data_reduction_promo";
+    /**
+     * Key used to save the time in milliseconds since epoch that the first run experience or second
+     * run promo was shown.
+     */
     private static final String SHARED_PREF_DISPLAYED_FRE_OR_SECOND_PROMO_TIME_MS =
             "displayed_data_reduction_promo_time_ms";
+    /**
+     * Key used to save the Chrome version the first run experience or second run promo was shown
+     * in.
+     */
     private static final String SHARED_PREF_DISPLAYED_FRE_OR_SECOND_PROMO_VERSION =
             "displayed_data_reduction_promo_version";
+    /**
+     * Key used to save whether the user opted out of the data reduction proxy in the FRE promo.
+     */
     private static final String SHARED_PREF_FRE_PROMO_OPT_OUT = "fre_promo_opt_out";
-
     /**
-     * Keys used to save whether the infobar promo is shown and the Chrome version it was shown in.
+     * Key used to save whether the infobar promo has been shown.
      */
     private static final String SHARED_PREF_DISPLAYED_INFOBAR_PROMO =
             "displayed_data_reduction_infobar_promo";
+    /**
+     * Key used to save the Chrome version the infobar promo was shown in.
+     */
     private static final String SHARED_PREF_DISPLAYED_INFOBAR_PROMO_VERSION =
             "displayed_data_reduction_infobar_promo_version";
+    /**
+     * Key used to save the saved bytes when the snackbar promo was last shown.

[tbansal1, 2016/10/26 18:36:23]

One last nit: Can you update the comment to say that this pref also contains the
bytes saved for data saver users that had data saver turned on when this pref
was added. And, that doing that prevents us from showing promo to existing
users.

[megjablon, 2016/10/26 18:50:08]

Done.

+     */
+    private static final String SHARED_PREF_DISPLAYED_SNACKBAR_PROMO_SAVED_BYTES =
+            "displayed_data_reduction_snackbar_promo_saved_bytes";
 
     /**
      * Returns whether any of the data reduction proxy promotions can be displayed. Checks if the
      * proxy is allowed by the DataReductionProxyConfig, already on, or if the user is managed. If
      * the data reduction proxy is managed by an administrator's policy, the user should not be
      * given a promotion to enable it.
      *
      * @return Whether the any data reduction proxy promotion has been displayed.
      */
     public static boolean canShowPromos() {
@@ skipping 85 matching lines @@
 
     /**
      * Returns whether the data reduction proxy infobar promo has been displayed before.
      *
      * @return Whether the data reduction proxy infobar promo has been displayed.
      */
     public static boolean getDisplayedInfoBarPromo() {
         return ContextUtils.getAppSharedPreferences().getBoolean(
                 SHARED_PREF_DISPLAYED_INFOBAR_PROMO, false);
     }
+
+    /** See {@link #SHARED_PREF_DISPLAYED_SNACKBAR_PROMO_SAVED_BYTES}. */
+    public static void saveSnackbarPromoDisplayed(long dataSavingInBytes) {
+        ContextUtils.getAppSharedPreferences()
+                .edit()
+                .putLong(SHARED_PREF_DISPLAYED_SNACKBAR_PROMO_SAVED_BYTES, dataSavingInBytes)
+                .apply();
+    }
+
+    /**
+     * Returns the data saving in bytes from when the promo snackbar was last displayed.
+     *
+     * @return The data saving in bytes, or -1 if the promo has not been displayed before.
+     */
+    public static long getDisplayedSnackbarPromoSavedBytes() {
+        return ContextUtils.getAppSharedPreferences().getLong(
+                SHARED_PREF_DISPLAYED_SNACKBAR_PROMO_SAVED_BYTES, -1);
+    }
+
+    /**
+     * Saves a shared pref indicating the data saving in bytes on the first upgrade to the version
+     * that shows the snackbar.
+     */
+    public static void saveSnackbarPromoInitWithStartingSavedBytes(long dataSavingInBytes) {
+        ContextUtils.getAppSharedPreferences()
+                .edit()
+                .putLong(SHARED_PREF_DISPLAYED_SNACKBAR_PROMO_SAVED_BYTES, dataSavingInBytes)
+                .apply();
+    }
+
+    /**
+     * Returns a boolean indicating that the data savings in bytes on the first upgrade to the
+     * version that shows the snackbar has been initialized.
+     *
+     * @return Whether that the starting saved bytes have been initialized.
+     */
+    public static boolean hasSnackbarPromoBeenInitWithStartingSavedBytes() {
+        return ContextUtils.getAppSharedPreferences()
+                .contains(SHARED_PREF_DISPLAYED_SNACKBAR_PROMO_SAVED_BYTES);
+    }
 }