Added support for a telemetry enabled/disabled ping (#1936)

* Added support for a telemetry enabled/disabled ping


Changed the telemetry status key name


Revert "Changed the telemetry status key name"

This reverts commit 6a632dc542ce40b6890e4b6c50c1c33a648d813c.

* Send the telemetry status ping if it's an update and telemetry was off

* Shorten the telemetry status string length

Author: keianhzo

app/src/common/shared/org/mozilla/vrbrowser/browser/SettingsStore.java

@@ -74,6 +74,7 @@ SettingsStore getInstance(final @NonNull Context aContext) {
     public final static boolean AUTOPLAY_ENABLED = false;
     public final static boolean DEBUG_LOGGING_DEFAULT = false;
     public final static boolean POP_UPS_BLOCKING_DEFAULT = true;
+    public final static boolean TELEMETRY_STATUS_UPDATE_SENT_DEFAULT = false;
 
     // Enable telemetry by default (opt-out).
     public final static boolean CRASH_REPORTING_DEFAULT = false;
@@ -112,6 +113,11 @@ public void setTelemetryEnabled(boolean isEnabled) {
         editor.putBoolean(mContext.getString(R.string.settings_key_telemetry), isEnabled);
         editor.commit();
 
+        // We send before disabling in case of opting-out
+        if (!isEnabled) {
+            TelemetryWrapper.telemetryStatus(false);
+        }
+
         // If the state of Telemetry is not the same, we reinitialize it.
         final boolean hasEnabled = isTelemetryEnabled();
         if (hasEnabled != isEnabled) {
@@ -120,6 +126,28 @@ public void setTelemetryEnabled(boolean isEnabled) {
 
         TelemetryHolder.get().getConfiguration().setUploadEnabled(isEnabled);
         TelemetryHolder.get().getConfiguration().setCollectionEnabled(isEnabled);
+
+        // We send after enabling in case of opting-in
+        if (isEnabled) {
+            TelemetryWrapper.telemetryStatus(true);
+        }
+
+        // Update the status sent flag
+        setTelemetryPingUpdateSent(true);
+    }
+
+    public boolean telemetryStatusSaved() {
+        return mPrefs.contains(mContext.getString(R.string.settings_key_telemetry));
+    }
+
+    public boolean isTelemetryPingUpdateSent() {
+        return mPrefs.getBoolean(mContext.getString(R.string.settings_key_telemetry_status_update_sent), TELEMETRY_STATUS_UPDATE_SENT_DEFAULT);
+    }
+
+    public void setTelemetryPingUpdateSent(boolean isSent) {
+        SharedPreferences.Editor editor = mPrefs.edit();
+        editor.putBoolean(mContext.getString(R.string.settings_key_telemetry_status_update_sent), isSent);
+        editor.commit();
     }
 
     public void setGeolocationData(String aGeolocationData) {

app/src/common/shared/org/mozilla/vrbrowser/telemetry/TelemetryWrapper.java

@@ -6,7 +6,9 @@
 import android.os.SystemClock;
 import android.util.Log;
 
-import mozilla.components.lib.fetch.httpurlconnection.HttpURLConnectionClient;
+import androidx.annotation.NonNull;
+import androidx.annotation.UiThread;
+
 import org.mozilla.telemetry.Telemetry;
 import org.mozilla.telemetry.TelemetryHolder;
 import org.mozilla.telemetry.config.TelemetryConfiguration;
@@ -32,11 +34,11 @@
 import java.util.HashSet;
 import java.util.Map;
 
-import androidx.annotation.NonNull;
-import androidx.annotation.UiThread;
+import mozilla.components.lib.fetch.httpurlconnection.HttpURLConnectionClient;
 
 import static java.lang.Math.toIntExact;
-import static org.mozilla.vrbrowser.ui.widgets.Windows.*;
+import static org.mozilla.vrbrowser.ui.widgets.Windows.MAX_WINDOWS;
+import static org.mozilla.vrbrowser.ui.widgets.Windows.WindowPlacement;
 
 
 public class TelemetryWrapper {
@@ -87,6 +89,7 @@ private class Method {
         // TODO: Support "select_query" after providing search suggestion.
         private static final String VOICE_QUERY = "voice_query";
         private static final String IMMERSIVE_MODE = "immersive_mode";
+        private static final String TELEMETRY_STATUS = "status";
 
         // How many max-windows dialogs happen / what percentage
         private static final String MAX_WINDOWS_DIALOG = "max_windows_dialog";
@@ -132,6 +135,7 @@ private class Extra {
         private static final String THREE_OPEN_WINDOWS_TIME_PCT = "three_windows_open_time_pct";
         private static final String WINDOWS_OPEN_W_MEAN = "window_open_w_mean";
         private static final String WINDOWS_PRIVATE_OPEN_W_MEAN = "window_open_private_w_mean";
+        private static final String TELEMETRY_STATUS = "telemetry_status";
     }
 
     // We should call this at the application initial stage. Instead,
@@ -151,6 +155,8 @@ public static void init(Context aContext) {
                     .setPreferencesImportantForTelemetry(resources.getString(R.string.settings_key_locale))
                     .setCollectionEnabled(telemetryEnabled)
                     .setUploadEnabled(telemetryEnabled)
+                    // We need to set this to 1 as we want the telemetry opt-in/out ping always to be sent and the minimum is 3 by default.
+                    .setMinimumEventsForUpload(1)
                     .setBuildId(String.valueOf(BuildConfig.VERSION_CODE));
 
             final JSONPingSerializer serializer = new JSONPingSerializer();
@@ -166,6 +172,19 @@ public static void init(Context aContext) {
             TelemetryHolder.set(new Telemetry(configuration, storage, client, scheduler)
                     .addPingBuilder(new TelemetryCorePingBuilder(configuration))
                     .addPingBuilder(new TelemetryMobileEventPingBuilder(configuration)));
+
+            // Check if the Telemetry status has ever been saved (enabled/disabled)
+            boolean saved = SettingsStore.getInstance(aContext).telemetryStatusSaved();
+            // Check if we have already sent the previous status event
+            boolean sent = SettingsStore.getInstance(aContext).isTelemetryPingUpdateSent();
+            // If the Telemetry status has been changed but that ping has not been sent, we send it now
+            // This should only been true for versions of the app prior to implementing the Telemetry status ping
+            // We only send the status ping if it was disabled
+            if (saved && !sent && !telemetryEnabled) {
+                telemetryStatus(false);
+                SettingsStore.getInstance(aContext).setTelemetryPingUpdateSent(true);
+            }
+
         } finally {
             StrictMode.setThreadPolicy(threadPolicy);
         }
@@ -656,4 +675,17 @@ private static void queueOpenWindowsPctEvent() {
         }
     }
 
+    public static void telemetryStatus(boolean status) {
+        TelemetryEvent event = TelemetryEvent.create(Category.ACTION, Method.TELEMETRY_STATUS, Object.APP);
+        event.extra(Extra.TELEMETRY_STATUS, String.valueOf(status));
+        event.queue();
+
+        // We flush immediately as the Telemetry is going to be turned off in case of opting-out
+        // and we want to make sure that this ping is delivered.
+        TelemetryHolder.get()
+                .queuePing(TelemetryCorePingBuilder.TYPE)
+                .queuePing(TelemetryMobileEventPingBuilder.TYPE)
+                .scheduleUpload();
+    }
+
 }

app/src/main/res/values/non_L10n.xml

@@ -44,6 +44,7 @@
     <string name="settings_key_autoplay" translatable="false">settings_key_autoplay</string>
     <string name="settings_key_pid" translatable="false">settings_key_pid</string>
     <string name="settings_key_pop_up_blocking" translatable="false">settings_key_pop_up_blocking</string>
+    <string name="settings_key_telemetry_status_update_sent" translatable="false">settings_key_telemetry_status_update_sent</string>
     <string name="environment_override_help_url" translatable="false">https://github.com/MozillaReality/FirefoxReality/wiki/Environments</string>
     <string name="private_policy_url" translatable="false">https://www.mozilla.org/privacy/firefox/</string>
     <string name="private_report_url" translatable="false">https://mixedreality.mozilla.org/fxr/report?src=browser-fxr&amp;label=browser-firefox-reality&amp;url=%1$s</string>