Bug 1871156 - Report impressions and clicks for Firefox Suggestions in the events ping.

Fenix currently reports AMP and Wikipedia impressions and clicks in the
`fx-suggest` ping, which intentionally omits the `client_id`. This
complicates experiment analysis, because our tooling relies on the
`client_id`.

This commit adds separate events for impressions and clicks on
sponsored and non-sponsored suggestions to the `events` ping.

* The new `awesomebar.{non_}sponsored_suggestion_clicked` events are
  collected the same way as the existing `fx-suggest` ping, and in line
  with the other `awesomebar.*_suggestion_clicked` events.
* The new `awesomebar.{non_}sponsored_suggestion_impressed` events are
  collected for engaged and abandoned search sessions. In constrast,
  the `fx-suggest` ping is only sent for engaged search sessions.

Author: linabutler

android-components/components/feature/fxsuggest/README.md

@@ -18,12 +18,12 @@ implementation "org.mozilla.components:feature-fxsuggest:{latest-version}"
 
 This component emits the following [Facts](../../support/base/README.md#Facts):
 
-| Action        | Item                             | Extras                        | Description                                                                                         |
-|---------------|----------------------------------|-------------------------------|-----------------------------------------------------------------------------------------------------|
-| `INTERACTION` | `amp_suggestion_clicked`         | `suggestion_clicked_extras`   | The user clicked on a Firefox Suggestion from adMarketplace.                                        |
-| `DISPLAY`     | `amp_suggestion_impressed`       | `suggestion_impressed_extras` | The user saw a Firefox Suggestion from adMarketplace just before they navigated to a destination.   |
-| `INTERACTION` | `wikipedia_suggestion_clicked`   | `suggestion_clicked_extras`   | The user clicked on a Firefox Suggestion for a Wikipedia page.                                      |
-| `DISPLAY`     | `wikipedia_suggestion_impressed` | `suggestion_impressed_extras` | The user saw a Firefox Suggestion for a Wikipedia page just before they navigated to a destination. |
+| Action        | Item                             | Extras                        | Description                                                                                                   |
+|---------------|----------------------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------|
+| `INTERACTION` | `amp_suggestion_clicked`         | `suggestion_clicked_extras`   | The user clicked on a Firefox Suggestion from adMarketplace.                                                  |
+| `DISPLAY`     | `amp_suggestion_impressed`       | `suggestion_impressed_extras` | A Firefox Suggestion from adMarketplace was visible when the user finished interacting with the awesomebar.   |
+| `INTERACTION` | `wikipedia_suggestion_clicked`   | `suggestion_clicked_extras`   | The user clicked on a Firefox Suggestion for a Wikipedia page.                                                |
+| `DISPLAY`     | `wikipedia_suggestion_impressed` | `suggestion_impressed_extras` | A Firefox Suggestion for a Wikipedia page was visible when the user finished interacting with the awesomebar. |
 
 #### `suggestion_clicked_extras`
 
@@ -35,11 +35,12 @@ This component emits the following [Facts](../../support/base/README.md#Facts):
 
 #### `suggestion_impressed_extras`
 
-| Key                | Type                       | Value                                                      |
-|--------------------|----------------------------|------------------------------------------------------------|
-| `interaction_info` | `FxSuggestInteractionInfo` | Type-specific information to record for this suggestion.   |
-| `position`         | `Long`                     | The 1-based position of this suggestion in the awesomebar. |
-| `is_clicked`       | `Boolean`                  | Whether the user clicked on this suggestion.               |
+| Key                    | Type                       | Value                                                                                                          |
+|------------------------|----------------------------|----------------------------------------------------------------------------------------------------------------|
+| `interaction_info`     | `FxSuggestInteractionInfo` | Type-specific information to record for this suggestion.                                                       |
+| `position`             | `Long`                     | The 1-based position of this suggestion in the awesomebar.                                                     |
+| `is_clicked`           | `Boolean`                  | Whether the user clicked on this suggestion after it was shown.                                                |
+| `engagement_abandoned` | `Boolean`                  | Whether the user dismissed the awesomebar without navigating to a destination after this suggestion was shown. |
 
 ## License
 

android-components/components/feature/fxsuggest/src/main/java/mozilla/components/feature/fxsuggest/facts/FxSuggestFacts.kt

@@ -31,6 +31,7 @@ class FxSuggestFacts {
         const val INTERACTION_INFO = "interaction_info"
         const val POSITION = "position"
         const val IS_CLICKED = "is_clicked"
+        const val ENGAGEMENT_ABANDONED = "engagement_abandoned"
     }
 }
 
@@ -70,6 +71,7 @@ internal fun emitSuggestionImpressedFact(
     interactionInfo: FxSuggestInteractionInfo,
     positionInAwesomeBar: Long,
     isClicked: Boolean,
+    engagementAbandoned: Boolean,
 ) {
     emitFxSuggestFact(
         Action.DISPLAY,
@@ -81,6 +83,7 @@ internal fun emitSuggestionImpressedFact(
             FxSuggestFacts.MetadataKeys.INTERACTION_INFO to interactionInfo,
             FxSuggestFacts.MetadataKeys.POSITION to positionInAwesomeBar,
             FxSuggestFacts.MetadataKeys.IS_CLICKED to isClicked,
+            FxSuggestFacts.MetadataKeys.ENGAGEMENT_ABANDONED to engagementAbandoned,
         ),
     )
 }

android-components/components/feature/fxsuggest/src/main/java/mozilla/components/feature/fxsuggest/facts/FxSuggestFactsMiddleware.kt

@@ -19,12 +19,14 @@ import mozilla.components.support.base.facts.Fact
  * Reports [Fact]s for interactions with Firefox Suggest [AwesomeBar.Suggestion]s.
  *
  * We report two kinds of interactions: impressions and clicks. We report impressions for any Firefox Suggest
- * search suggestions that are still visible just before the user navigates to a destination: either a URL, a
- * search results page, or a suggestion. If the user navigates to one of those Firefox Suggest suggestions,
- * we also report a click.
+ * search suggestions that are visible when the user finishes interacting with the [AwesomeBar].
+ * If the user taps on one of those visible Firefox Suggest suggestions, we'll also report a click for that suggestion.
  *
- * We _don't_ report impressions for any suggestions that the user sees as they're still typing, or
- * if they dismiss the [AwesomeBar] without navigating to a destination.
+ * Each impression's [Fact.metadata] contains a [FxSuggestFacts.MetadataKeys.ENGAGEMENT_ABANDONED] key, whose value is
+ * `false` if the user navigated to a destination (like a URL, a search results page, or a suggestion), or
+ * `true` if the user dismissed the [AwesomeBar] without navigating to a destination.
+ *
+ * We _don't_ report impressions for any suggestions that the user sees as they're still typing.
  */
 class FxSuggestFactsMiddleware : Middleware<BrowserState, BrowserAction> {
     override fun invoke(
@@ -40,12 +42,14 @@ class FxSuggestFactsMiddleware : Middleware<BrowserState, BrowserAction> {
         context: MiddlewareContext<BrowserState, BrowserAction>,
         action: BrowserAction,
     ) = when (action) {
-        is AwesomeBarAction.EngagementFinished ->
-            if (action.abandoned) Unit else emitSuggestionFacts(context.state.awesomeBarState)
+        is AwesomeBarAction.EngagementFinished -> emitSuggestionFacts(
+            awesomeBarState = context.state.awesomeBarState,
+            engagementAbandoned = action.abandoned,
+        )
         else -> Unit
     }
 
-    private fun emitSuggestionFacts(awesomeBarState: AwesomeBarState) {
+    private fun emitSuggestionFacts(awesomeBarState: AwesomeBarState, engagementAbandoned: Boolean) {
         val visibilityState = awesomeBarState.visibilityState
         val clickedSuggestion = awesomeBarState.clickedSuggestion
         visibilityState.visibleProviderGroups.entries.forEachIndexed { groupIndex, (_, suggestions) ->
@@ -58,7 +62,12 @@ class FxSuggestFactsMiddleware : Middleware<BrowserState, BrowserAction> {
                     FxSuggestSuggestionProvider.MetadataKeys.IMPRESSION_INFO,
                 ) as? FxSuggestInteractionInfo
                 impressionInfo?.let {
-                    emitSuggestionImpressedFact(it, positionInGroup, isClicked = isClicked)
+                    emitSuggestionImpressedFact(
+                        interactionInfo = it,
+                        positionInAwesomeBar = positionInAwesomeBar,
+                        isClicked = isClicked,
+                        engagementAbandoned = engagementAbandoned,
+                    )
                 }
 
                 if (isClicked) {