Bug 1914027 - Add more ping types in Glean Debug Tools r=android-reviewers,boek

Differential Revision: https://phabricator.services.mozilla.com/D234395

Author: nicholaspoon03

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/debugsettings/gleandebugtools/GleanDebugToolsMiddleware.kt

@@ -7,7 +7,6 @@ package org.mozilla.fenix.debugsettings.gleandebugtools
 import mozilla.components.lib.state.Middleware
 import mozilla.components.lib.state.MiddlewareContext
 import mozilla.components.support.ktx.kotlin.urlEncode
-import org.mozilla.fenix.R
 import org.mozilla.fenix.utils.ClipboardHandler
 
 internal const val PING_PREVIEW_URL = "https://debug-ping-preview.firebaseapp.com/"
@@ -24,7 +23,7 @@ class GleanDebugToolsMiddleware(
     private val gleanDebugToolsStorage: GleanDebugToolsStorage,
     private val clipboardHandler: ClipboardHandler,
     private val openDebugView: (String) -> Unit,
-    private val showToast: (Int) -> Unit,
+    private val showToast: (String) -> Unit,
 ) : Middleware<GleanDebugToolsState, GleanDebugToolsAction> {
     override fun invoke(
         context: MiddlewareContext<GleanDebugToolsState, GleanDebugToolsAction>,
@@ -51,24 +50,14 @@ class GleanDebugToolsMiddleware(
                 clipboardHandler.text = debugViewLink
             }
             is GleanDebugToolsAction.DebugViewTagChanged -> {} // No-op
-            is GleanDebugToolsAction.SendBaselinePing -> {
-                gleanDebugToolsStorage.sendBaselinePing(
+            is GleanDebugToolsAction.SendPing -> {
+                gleanDebugToolsStorage.sendPing(
+                    pingType = context.state.pingType,
                     debugViewTag = context.state.debugViewTag,
                 )
-                showToast(R.string.glean_debug_tools_send_baseline_ping_toast_message)
-            }
-            is GleanDebugToolsAction.SendMetricsPing -> {
-                gleanDebugToolsStorage.sendMetricsPing(
-                    debugViewTag = context.state.debugViewTag,
-                )
-                showToast(R.string.glean_debug_tools_send_metrics_ping_toast_message)
-            }
-            is GleanDebugToolsAction.SendPendingEventPing -> {
-                gleanDebugToolsStorage.sendPendingEventPing(
-                    debugViewTag = context.state.debugViewTag,
-                )
-                showToast(R.string.glean_debug_tools_send_pending_event_ping_toast_message)
+                showToast(context.state.pingType)
             }
+            is GleanDebugToolsAction.ChangePingType -> {} // No-op
         }
     }
 

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/debugsettings/gleandebugtools/GleanDebugToolsStorage.kt

@@ -17,19 +17,12 @@ interface GleanDebugToolsStorage {
     fun setLogPings(enabled: Boolean)
 
     /**
-     * Send a baseline ping.
+     * Send a ping.
+     *
+     * @param pingType The type of ping to submit.
+     * @param debugViewTag The debug tag to use for the ping.
      */
-    fun sendBaselinePing(debugViewTag: String)
-
-    /**
-     * Send a metrics ping.
-     */
-    fun sendMetricsPing(debugViewTag: String)
-
-    /**
-     * Send a pending event ping.
-     */
-    fun sendPendingEventPing(debugViewTag: String)
+    fun sendPing(pingType: String, debugViewTag: String)
 }
 
 /**
@@ -40,18 +33,21 @@ class DefaultGleanDebugToolsStorage : GleanDebugToolsStorage {
         Glean.setLogPings(enabled)
     }
 
-    override fun sendBaselinePing(debugViewTag: String) {
+    override fun sendPing(pingType: String, debugViewTag: String) {
         Glean.setDebugViewTag(debugViewTag)
-        Glean.submitPingByName("baseline")
+        Glean.submitPingByName(pingType)
     }
 
-    override fun sendMetricsPing(debugViewTag: String) {
-        Glean.setDebugViewTag(debugViewTag)
-        Glean.submitPingByName("metrics")
-    }
-
-    override fun sendPendingEventPing(debugViewTag: String) {
-        Glean.setDebugViewTag(debugViewTag)
-        Glean.submitPingByName("events")
+    /**
+     * @see [DefaultGleanDebugToolsStorage].
+     */
+    companion object {
+
+        /**
+         * Get all the types of pings that can be submitted.
+         */
+        fun getPingTypes(): Set<String> {
+            return Glean.getRegisteredPingNames()
+        }
     }
 }

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/debugsettings/gleandebugtools/GleanDebugToolsStore.kt

@@ -14,10 +14,14 @@ import mozilla.components.lib.state.UiStore
  *
  * @property logPingsToConsoleEnabled Whether logging pings to console is enabled.
  * @property debugViewTag The debug view tag of the ping.
+ * @property pingType The selected ping to be submitted.
+ * @property pingTypes The types of pings that can be submitted.
  */
 data class GleanDebugToolsState(
     val logPingsToConsoleEnabled: Boolean,
     val debugViewTag: String,
+    val pingType: String = "metrics",
+    val pingTypes: List<String> = DefaultGleanDebugToolsStorage.getPingTypes().sorted(),
 ) : State {
 
     /**
@@ -51,19 +55,14 @@ sealed class GleanDebugToolsAction : Action {
     data class DebugViewTagChanged(val newTag: String) : GleanDebugToolsAction()
 
     /**
-     * Send a pending event ping.
+     * Change the type of ping to submit to [newPing].
      */
-    data object SendPendingEventPing : GleanDebugToolsAction()
+    data class ChangePingType(val newPing: String) : GleanDebugToolsAction()
 
     /**
-     * Send a baseline ping.
+     * Send the ping.
      */
-    data object SendBaselinePing : GleanDebugToolsAction()
-
-    /**
-     * Send a metrics ping.
-     */
-    data object SendMetricsPing : GleanDebugToolsAction()
+    data object SendPing : GleanDebugToolsAction()
 
     /**
      * Open the relevant debug view.
@@ -93,11 +92,10 @@ internal object GleanDebugToolsReducer {
                     debugViewTag = action.newTag,
                 )
             }
-            is GleanDebugToolsAction.SendBaselinePing -> state
-            is GleanDebugToolsAction.SendMetricsPing -> state
-            is GleanDebugToolsAction.SendPendingEventPing -> state
             is GleanDebugToolsAction.OpenDebugView -> state
             is GleanDebugToolsAction.CopyDebugViewLink -> state
+            is GleanDebugToolsAction.SendPing -> state
+            is GleanDebugToolsAction.ChangePingType -> state.copy(pingType = action.newPing)
         }
     }
 }

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/debugsettings/gleandebugtools/ui/GleanDebugToolsScreen.kt

@@ -25,6 +25,8 @@ import androidx.compose.ui.text.input.KeyboardType
 import mozilla.components.compose.base.annotation.FlexibleWindowLightDarkPreview
 import mozilla.components.lib.state.ext.observeAsState
 import org.mozilla.fenix.R
+import org.mozilla.fenix.compose.Dropdown
+import org.mozilla.fenix.compose.MenuItem
 import org.mozilla.fenix.compose.SwitchWithLabel
 import org.mozilla.fenix.compose.TextField
 import org.mozilla.fenix.compose.button.PrimaryButton
@@ -83,9 +85,10 @@ fun GleanDebugToolsScreen(
 
         GleanDebugSendPingsSection(
             isButtonEnabled = gleanDebugToolsState.isDebugTagButtonEnabled,
-            onSendPendingEventPing = { gleanDebugToolsStore.dispatch(GleanDebugToolsAction.SendPendingEventPing) },
-            onSendBaselinePing = { gleanDebugToolsStore.dispatch(GleanDebugToolsAction.SendBaselinePing) },
-            onSendMetricsPing = { gleanDebugToolsStore.dispatch(GleanDebugToolsAction.SendMetricsPing) },
+            curPing = gleanDebugToolsState.pingType,
+            pingTypes = gleanDebugToolsState.pingTypes,
+            onPingItemClicked = { gleanDebugToolsStore.dispatch(GleanDebugToolsAction.ChangePingType(it)) },
+            onSendPing = { gleanDebugToolsStore.dispatch(GleanDebugToolsAction.SendPing) },
         )
     }
 }
@@ -178,29 +181,33 @@ private fun GleanDebugViewSection(
 @Composable
 private fun GleanDebugSendPingsSection(
     isButtonEnabled: Boolean,
-    onSendPendingEventPing: () -> Unit,
-    onSendBaselinePing: () -> Unit,
-    onSendMetricsPing: () -> Unit,
+    curPing: String,
+    pingTypes: List<String>,
+    onPingItemClicked: (String) -> Unit,
+    onSendPing: () -> Unit,
 ) {
     Column(
         modifier = Modifier.padding(horizontal = FirefoxTheme.space.small),
     ) {
-        GleanTestPingButton(
-            text = stringResource(R.string.glean_debug_tools_send_pending_event_pings_button_text),
-            enabled = isButtonEnabled,
-            onClick = onSendPendingEventPing,
+        Dropdown(
+            label = "Ping Type",
+            placeholder = "",
+            dropdownItems = getPingDropdownMenu(
+                curPing = curPing,
+                pings = pingTypes,
+                onClickItem = onPingItemClicked,
+            ),
         )
 
-        GleanTestPingButton(
-            text = stringResource(R.string.glean_debug_tools_send_baseline_pings_button_text),
-            enabled = isButtonEnabled,
-            onClick = onSendBaselinePing,
-        )
+        Spacer(modifier = Modifier.height(FirefoxTheme.space.small))
 
-        GleanTestPingButton(
-            text = stringResource(R.string.glean_debug_tools_send_metrics_pings_button_text),
+        PrimaryButton(
+            text = stringResource(R.string.glean_debug_tools_send_ping_button_text),
+            modifier = Modifier
+                .fillMaxWidth()
+                .padding(horizontal = FirefoxTheme.space.xxSmall),
             enabled = isButtonEnabled,
-            onClick = onSendMetricsPing,
+            onClick = onSendPing,
         )
     }
 }
@@ -241,28 +248,15 @@ private fun GleanDebugButton(
     )
 }
 
-/**
- * The UI for a send test ping button on the Glean Debug Tools page.
- *
- * @param text The text on the button.
- * @param enabled Controls the enabled state of the list item. When `false`, the list item will not
- * be clickable.
- * @param onClick Called when the user clicks on the button.
- */
-@Composable
-private fun GleanTestPingButton(
-    text: String,
-    enabled: Boolean,
-    onClick: () -> Unit,
-) {
-    PrimaryButton(
-        text = text,
-        modifier = Modifier
-            .fillMaxWidth()
-            .padding(horizontal = FirefoxTheme.space.xxSmall),
-        enabled = enabled,
-        onClick = onClick,
-    )
+private fun getPingDropdownMenu(
+    curPing: String,
+    pings: List<String>,
+    onClickItem: (String) -> Unit,
+) = pings.map {
+    MenuItem(
+        title = it,
+        isChecked = it == curPing,
+    ) { onClickItem(it) }
 }
 
 @Composable

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/debugsettings/ui/FenixOverlay.kt

@@ -23,6 +23,7 @@ import mozilla.components.compose.base.annotation.LightDarkPreview
 import mozilla.components.concept.storage.LoginsStorage
 import mozilla.components.lib.state.ext.observeAsState
 import mozilla.telemetry.glean.Glean
+import org.mozilla.fenix.R
 import org.mozilla.fenix.debugsettings.addresses.AddressesDebugLocalesRepository
 import org.mozilla.fenix.debugsettings.addresses.AddressesTools
 import org.mozilla.fenix.debugsettings.addresses.FakeAddressesDebugLocalesRepository
@@ -90,10 +91,13 @@ fun FenixOverlay(
                         intent.data = Uri.parse(debugViewLink)
                         context.startActivity(intent)
                     },
-                    showToast = { resId ->
+                    showToast = { pingType ->
                         val toast = Toast.makeText(
                             context,
-                            context.getString(resId),
+                            context.getString(
+                                R.string.glean_debug_tools_send_ping_toast_message,
+                                pingType,
+                            ),
                             Toast.LENGTH_LONG,
                         )
                         toast.show()

mobile/android/fenix/app/src/main/res/values/static_strings.xml

@@ -213,16 +213,8 @@
     <string name="glean_debug_tools_open_debug_view">Open debug view (in default browser)</string>
     <!-- The copy debug view link button text in Glean debug tools -->
     <string name="glean_debug_tools_copy_debug_view_link">Copy debug view link</string>
-    <!-- The send pending event pings button text in Glean debug tools -->
-    <string name="glean_debug_tools_send_pending_event_pings_button_text">Send pending event pings</string>
-    <!-- The send baseline event pings button text in Glean debug tools -->
-    <string name="glean_debug_tools_send_baseline_pings_button_text">Send baseline pings</string>
-    <!-- The send metrics event pings button text in Glean debug tools -->
-    <string name="glean_debug_tools_send_metrics_pings_button_text">Send metrics pings</string>
-    <!-- The send pending event pings toast message -->
-    <string name="glean_debug_tools_send_pending_event_ping_toast_message">Sent pending event ping</string>
-    <!-- The send baseline pings toast message -->
-    <string name="glean_debug_tools_send_baseline_ping_toast_message">Sent baseline ping</string>
-    <!-- The send metrics pings toast message -->
-    <string name="glean_debug_tools_send_metrics_ping_toast_message">Sent metrics ping</string>
+    <!-- The send ping button text in Glean debug tools -->
+    <string name="glean_debug_tools_send_ping_button_text">Send Ping</string>
+    <!-- The send pings toast message. The first parameter is the type of ping -->
+    <string name="glean_debug_tools_send_ping_toast_message">Sent %1$s ping</string>
 </resources>