[EoC] Record metric when toolbar button is shown

BUG=859563

Cq-Include-Trybots: luci.chromium.try:closure_compilation
Change-Id: Ibc3cefb18aa81a7a9c1a1a2bf25e6c533b527389
Reviewed-on: https://chromium-review.googlesource.com/1123057Reviewed-by: Tommy Nyquist <nyquist@chromium.org>
Reviewed-by: Emily Stark <estark@chromium.org>
Reviewed-by: Filip Gorski <fgorski@chromium.org>
Commit-Queue: Theresa <twellington@chromium.org>
Cr-Commit-Position: refs/heads/master@{#572227}

chrome/android/java/src/org/chromium/chrome/browser/contextual_suggestions/ContextualSuggestionsMediator.java

@@ -73,6 +73,7 @@ class ContextualSuggestionsMediator
 
     private boolean mDidSuggestionsShowForTab;
     private boolean mHasRecordedPeekEventForTab;
+    private boolean mHasRecordedButtonShownForTab;
 
     private boolean mHasReachedTargetScrollPercentage;
     private boolean mHasPeekDelayPassed;
@@ -140,24 +141,28 @@ class ContextualSuggestionsMediator
                     }
                 }
             };
+        }
 
-            fullscreenManager.addListener(new FullscreenListener() {
-                @Override
-                public void onContentOffsetChanged(float offset) {}
+        fullscreenManager.addListener(new FullscreenListener() {
+            @Override
+            public void onContentOffsetChanged(float offset) {}
 
-                @Override
-                public void onControlsOffsetChanged(
-                        float topOffset, float bottomOffset, boolean needsAnimate) {
+            @Override
+            public void onControlsOffsetChanged(
+                    float topOffset, float bottomOffset, boolean needsAnimate) {
+                if (!mToolbarButtonEnabled) {
                     maybeShowContentInSheet();
+                } else {
+                    reportToolbarButtonShown();
                 }
+            }
 
-                @Override
-                public void onToggleOverlayVideoMode(boolean enabled) {}
+            @Override
+            public void onToggleOverlayVideoMode(boolean enabled) {}
 
-                @Override
-                public void onBottomControlsHeightChanged(int bottomControlsHeight) {}
-            });
-        }
+            @Override
+            public void onBottomControlsHeightChanged(int bottomControlsHeight) {}
+        });
     }
 
     /** Destroys the mediator. */
@@ -261,6 +266,7 @@ class ContextualSuggestionsMediator
                     mCoordinator.showSuggestions(mSuggestionsSource);
                     mCoordinator.expandBottomSheet();
                 }, R.drawable.btn_star_filled, R.string.contextual_suggestions_button_description);
+                reportToolbarButtonShown();
             } else {
                 setPeekConditions(suggestionsResult);
                 // If the controls are already off-screen, show the suggestions immediately so they
@@ -301,6 +307,20 @@ class ContextualSuggestionsMediator
         }
     }
 
+    private void reportToolbarButtonShown() {
+        assert mToolbarButtonEnabled;
+
+        if (mHasRecordedButtonShownForTab || areBrowserControlsHidden()
+                || mSuggestionsSource == null || !mModel.hasSuggestions()) {
+            return;
+        }
+
+        mHasRecordedButtonShownForTab = true;
+        reportEvent(ContextualSuggestionsEvent.UI_BUTTON_SHOWN);
+        TrackerFactory.getTrackerForProfile(mProfile).notifyEvent(
+                EventConstants.CONTEXTUAL_SUGGESTIONS_BUTTON_SHOWN);
+    }
+
     @Override
     public void clearState() {
         clearSuggestions();
@@ -356,6 +376,7 @@ class ContextualSuggestionsMediator
 
         mDidSuggestionsShowForTab = false;
         mHasRecordedPeekEventForTab = false;
+        mHasRecordedButtonShownForTab = false;
         mHasSheetBeenOpened = false;
         mHandler.removeCallbacksAndMessages(null);
         mHasReachedTargetScrollPercentage = false;

chrome/browser/resources/eoc_internals/eoc_internals.html

@@ -55,6 +55,10 @@ found in the LICENSE file.
             <td>Was sheet peeked</td>
             <td id="sheet-peeked"></td>
           </tr>
+          <tr>
+            <td>Was button shown</td>
+            <td id="button-shown"></td>
+          </tr>
           <tr>
             <td>Was sheet opened</td>
             <td id="sheet-opened"></td>

chrome/browser/resources/eoc_internals/eoc_internals.js

@@ -49,6 +49,8 @@ function addCachedMetricEventsToPage(metrics) {
     metricEventClone.querySelector('#url').textContent = metricEvent.url;
     metricEventClone.querySelector('#sheet-peeked').textContent =
         metricEvent.sheetPeeked;
+    metricEventClone.querySelector('#button-shown').textContent =
+        metricEvent.buttonShown;
     metricEventClone.querySelector('#sheet-opened').textContent =
         metricEvent.sheetOpened;
     metricEventClone.querySelector('#sheet-closed').textContent =

chrome/browser/ui/webui/eoc_internals/eoc_internals.mojom

@@ -63,6 +63,9 @@ struct MetricEvent {
   // Did the sheet peek show.
   bool sheet_peeked;
 
+  // Was the toolbar button shown.
+  bool button_shown;
+
   // If the peek was closed without being opened.
   bool sheet_opened;
 

chrome/browser/ui/webui/eoc_internals/eoc_internals_page_handler.cc

@@ -77,6 +77,7 @@ void EocInternalsPageHandler::GetCachedMetricEvents(
     auto metric_event = eoc_internals::mojom::MetricEvent::New();
     metric_event->url = debug_event.url;
     metric_event->sheet_peeked = debug_event.sheet_peeked;
+    metric_event->button_shown = debug_event.button_shown;
     metric_event->sheet_opened = debug_event.sheet_opened;
     metric_event->sheet_closed = debug_event.sheet_closed;
     metric_event->any_suggestion_taken = debug_event.any_suggestion_taken;

components/feature_engagement/public/android/java/src/org/chromium/components/feature_engagement/EventConstants.java

@@ -34,6 +34,10 @@ public final class EventConstants {
      */
     public static final String PULL_TO_REFRESH = "pull_to_refresh";
 
+    /** The contextual suggestions button was shown to the user. */
+    public static final String CONTEXTUAL_SUGGESTIONS_BUTTON_SHOWN =
+            "contextual_suggestions_button_shown";
+
     /**
      * The contextual suggestions bottom sheet was explicitly dismissed via a tap on its close
      * button.

components/ntp_snippets/contextual/contextual_suggestions_debugging_reporter.cc

@@ -48,6 +48,9 @@ void ContextualSuggestionsDebuggingReporter::RecordEvent(
     case UI_PEEK_REVERSE_SCROLL:
       current_event_.sheet_peeked = true;
       return;
+    case UI_BUTTON_SHOWN:
+      current_event_.button_shown = true;
+      return;
     case UI_OPENED:
       current_event_.sheet_opened = true;
       return;

components/ntp_snippets/contextual/contextual_suggestions_debugging_reporter.h

@@ -35,6 +35,9 @@ struct ContextualSuggestionsDebuggingEvent {
 
   // Whether the sheet ever peeked.
   bool sheet_peeked = false;
+
+  // Whether the button has even been shown.
+  bool button_shown = false;
 };
 
 // Reporter specialized for caching information for debugging purposes.

components/ntp_snippets/contextual/contextual_suggestions_metrics_reporter.cc

@@ -14,6 +14,7 @@ namespace contextual_suggestions {
 
 ContextualSuggestionsMetricsReporter::ContextualSuggestionsMetricsReporter()
     : sheet_peeked_(false),
+      button_shown_(false),
       sheet_opened_(false),
       sheet_closed_(false),
       any_suggestion_downloaded_(false),
@@ -64,6 +65,11 @@ void ContextualSuggestionsMetricsReporter::RecordUmaMetrics(
         return;
       sheet_peeked_ = true;
       break;
+    case UI_BUTTON_SHOWN:
+      if (button_shown_)
+        return;
+      button_shown_ = true;
+      break;
     case UI_OPENED:
       if (sheet_opened_)
         return;
@@ -97,6 +103,7 @@ void ContextualSuggestionsMetricsReporter::RecordUmaMetrics(
 
 void ContextualSuggestionsMetricsReporter::ResetUma() {
   sheet_peeked_ = false;
+  button_shown_ = false;
   sheet_opened_ = false;
   sheet_closed_ = false;
   any_suggestion_downloaded_ = false;

components/ntp_snippets/contextual/contextual_suggestions_metrics_reporter.h

@@ -43,6 +43,8 @@ class ContextualSuggestionsMetricsReporter
   // Internal UMA state data.
   // Whether the sheet ever peeked.
   bool sheet_peeked_;
+  // Whether the button was ever shown.
+  bool button_shown_;
   // Whether the sheet was ever opened.
   bool sheet_opened_;
   // Whether the sheet was closed.

components/ntp_snippets/contextual/contextual_suggestions_metrics_reporter_unittest.cc

@@ -36,6 +36,7 @@ const int kSuggestionDownloaded = 11;
 const int kSuggestionClicked = 12;
 const int kUiDismissedWithoutOpen = 13;
 const int kUiDismissedAfterOpen = 14;
+const int kUiButtonShown = 15;
 }  // namespace
 
 class ContextualSuggestionsMetricsReporterTest : public ::testing::Test {
@@ -197,4 +198,51 @@ TEST_F(ContextualSuggestionsMetricsReporterTest, EnumNotReorderedTest) {
   GetReporter().Flush();
 }
 
+TEST_F(ContextualSuggestionsMetricsReporterTest, ButtonTest) {
+  base::HistogramTester histogram_tester;
+  GetReporter().SetupForPage(kTestNavigationUrl, GetSourceId());
+  GetReporter().RecordEvent(FETCH_REQUESTED);
+  GetReporter().RecordEvent(FETCH_COMPLETED);
+  GetReporter().RecordEvent(UI_BUTTON_SHOWN);
+  GetReporter().RecordEvent(UI_OPENED);
+  GetReporter().RecordEvent(SUGGESTION_DOWNLOADED);
+  GetReporter().RecordEvent(SUGGESTION_CLICKED);
+  // Flush data to write to UKM.
+  GetReporter().Flush();
+  // Check that we wrote something to UKM.  Details of UKM reporting are tested
+  // in a different test suite.
+  TestUkmRecorder* test_ukm_recorder = GetTestUkmRecorder();
+  std::vector<const ukm::mojom::UkmEntry*> entry_vector =
+      test_ukm_recorder->GetEntriesByName(ContextualSuggestions::kEntryName);
+  EXPECT_EQ(1U, entry_vector.size());
+  const ukm::mojom::UkmEntry* first_entry = entry_vector[0];
+  EXPECT_TRUE(test_ukm_recorder->EntryHasMetric(
+      first_entry, ContextualSuggestions::kFetchStateName));
+  EXPECT_EQ(static_cast<int64_t>(FetchState::COMPLETED),
+            *(test_ukm_recorder->GetEntryMetric(
+                first_entry, ContextualSuggestions::kFetchStateName)));
+  // Test that the expected histogram events were written.
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kUninitialized, 0);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kFetchDelayed, 0);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kFetchRequested, 1);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kFetchError, 0);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kFetchServerBusy, 0);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kFetchBelowThreshold,
+                                     0);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kFetchEmpty, 0);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kFetchCompleted, 1);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kUiButtonShown, 1);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kUiOpened, 1);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kUiClosedObsolete,
+                                     0);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName,
+                                     kSuggestionDownloaded, 1);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName, kSuggestionClicked,
+                                     1);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName,
+                                     kUiDismissedWithoutOpen, 0);
+  histogram_tester.ExpectBucketCount(kEventsHistogramName,
+                                     kUiDismissedAfterOpen, 0);
+}
+
 }  // namespace contextual_suggestions

components/ntp_snippets/contextual/contextual_suggestions_reporter.h

@@ -86,9 +86,11 @@ enum ContextualSuggestionsEvent {
   // The UI was dismissed after having been opened. This means the sheet was
   // closed from any position after it was expanded at least once.
   UI_DISMISSED_AFTER_OPEN = 14,
+  // The UI button was shown to the user.
+  UI_BUTTON_SHOWN = 15,
   // Special name that marks the maximum value in an Enum used for UMA.
   // https://cs.chromium.org/chromium/src/tools/metrics/histograms/README.md.
-  kMaxValue = UI_DISMISSED_AFTER_OPEN,
+  kMaxValue = UI_BUTTON_SHOWN,
 };
 
 // Tracks various metrics based on reports of events that take place

components/ntp_snippets/contextual/contextual_suggestions_ukm_entry.cc

@@ -66,6 +66,10 @@ void ContextualSuggestionsUkmEntry::RecordEventMetrics(
       trigger_event_ = TriggerEvent::REVERSE_SCROLL;
       StartTimerIfNeeded();
       break;
+    case UI_BUTTON_SHOWN:
+      trigger_event_ = TriggerEvent::TOOLBAR_BUTTON;
+      StartTimerIfNeeded();
+      break;
     case UI_OPENED:
       was_sheet_opened_ = true;
       StartTimerIfNeeded();

components/ntp_snippets/contextual/contextual_suggestions_ukm_entry.h

@@ -35,6 +35,7 @@ enum class FetchState {
 enum class TriggerEvent {
   NEVER_SHOWN,
   REVERSE_SCROLL,
+  TOOLBAR_BUTTON,
 };
 
 // Writes a single UKM entry that describes the latest state of the event stream

components/ntp_snippets/contextual/contextual_suggestions_ukm_entry_unittest.cc

@@ -104,4 +104,25 @@ TEST_F(ContextualSuggestionsUkmEntryTest, ExpectedOperationTest) {
   EXPECT_EQ(1, GetEntryMetric(ContextualSuggestions::kTriggerEventName));
 }
 
+TEST_F(ContextualSuggestionsUkmEntryTest, ExpectedOperationButtonTest) {
+  ukm_entry_->RecordEventMetrics(FETCH_DELAYED);
+  ukm_entry_->RecordEventMetrics(FETCH_REQUESTED);
+  ukm_entry_->RecordEventMetrics(FETCH_COMPLETED);
+  ukm_entry_->RecordEventMetrics(UI_BUTTON_SHOWN);
+  ukm_entry_->RecordEventMetrics(UI_OPENED);
+  ukm_entry_->RecordEventMetrics(SUGGESTION_DOWNLOADED);
+  ukm_entry_->RecordEventMetrics(SUGGESTION_DOWNLOADED);
+  ukm_entry_->RecordEventMetrics(SUGGESTION_CLICKED);
+  ukm_entry_->Flush();
+  EXPECT_EQ(1, GetEntryMetric(ContextualSuggestions::kAnyDownloadedName));
+  EXPECT_EQ(1, GetEntryMetric(ContextualSuggestions::kAnySuggestionTakenName));
+  EXPECT_EQ(0, GetEntryMetric(ContextualSuggestions::kClosedFromPeekName));
+  EXPECT_EQ(1, GetEntryMetric(ContextualSuggestions::kEverOpenedName));
+  EXPECT_EQ(static_cast<int64_t>(FetchState::COMPLETED),
+            GetEntryMetric(ContextualSuggestions::kFetchStateName));
+  EXPECT_LT(0,
+            GetEntryMetric(ContextualSuggestions::kShowDurationBucketMinName));
+  EXPECT_EQ(2, GetEntryMetric(ContextualSuggestions::kTriggerEventName));
+}
+
 }  // namespace contextual_suggestions

tools/metrics/histograms/enums.xml

@@ -7642,6 +7642,7 @@ Called by update_net_error_codes.py.-->
   <int value="12" label="Suggestion clicked"/>
   <int value="13" label="UI dismissed without open"/>
   <int value="14" label="UI dismissed after open"/>
+  <int value="15" label="UI button shown"/>
 </enum>
 
 <enum name="CookieCommitProblem">