[TTS] Move Ranker logging to inference time.

chrome/android/java/src/org/chromium/chrome/browser/compositor/bottombar/contextualsearch/ContextualSearchPanelMetrics.java

 // Copyright 2015 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.compositor.bottombar.contextualsearch;
 
 import org.chromium.chrome.browser.compositor.bottombar.OverlayPanel.PanelState;
 import org.chromium.chrome.browser.compositor.bottombar.OverlayPanel.StateChangeReason;
 import org.chromium.chrome.browser.contextualsearch.ContextualSearchHeuristics;
 import org.chromium.chrome.browser.contextualsearch.ContextualSearchRankerLogger;
-import org.chromium.chrome.browser.contextualsearch.ContextualSearchRankerLoggerImpl;
 import org.chromium.chrome.browser.contextualsearch.ContextualSearchUma;
 import org.chromium.chrome.browser.contextualsearch.QuickActionCategory;
 
-import java.net.URL;
-
 /**
  * This class is responsible for all the logging related to Contextual Search.
  */
 public class ContextualSearchPanelMetrics {
     private static final int MILLISECONDS_TO_NANOSECONDS = 1000000;
 
-    // The Ranker logger to use to write Tap Suppression Ranker logs to UMA.
-    private final ContextualSearchRankerLogger mTapSuppressionRankerLogger;
-
     // Flags for logging.
     private boolean mDidSearchInvolvePromo;
     private boolean mWasSearchContentViewSeen;
     private boolean mIsPromoActive;
     private boolean mHasExpanded;
     private boolean mHasMaximized;
     private boolean mHasExitedPeeking;
     private boolean mHasExitedExpanded;
     private boolean mHasExitedMaximized;
     private boolean mIsSerpNavigation;
@@ skipping 15 matching lines @@
     // Time when a search request was started. Reset by chained searches.
     // Used to log the time it takes for a Search Result to become available.
     private long mSearchRequestStartTimeNs;
     // Time when the panel was opened beyond peeked. Reset when the panel is closed.
     // Used to log how long the panel was open.
     private long mPanelOpenedBeyondPeekTimeNs;
     // The current set of heuristics that should be logged with results seen when the panel closes.
     private ContextualSearchHeuristics mResultsSeenExperiments;
     // The current set of heuristics to be logged through ranker with results seen when the panel
     // closes.
-    private ContextualSearchHeuristics mRankerLogExperiments;
-
-    /**
-     * Constructs an object to track metrics for the Contextual Search Overlay Panel.
-     */
-    ContextualSearchPanelMetrics() {
-        mTapSuppressionRankerLogger = new ContextualSearchRankerLoggerImpl();
-    }
+    private ContextualSearchRankerLogger mRankerLogger;
 
     /**
      * Log information when the panel's state has changed.
      * @param fromState The state the panel is transitioning from.
      * @param toState The state that the panel is transitioning to.
      * @param reason The reason for the state change.
      */
     public void onPanelStateChanged(PanelState fromState, PanelState toState,
             StateChangeReason reason) {
         // Note: the logging within this function includes the promo, unless specifically
@@ skipping 11 matching lines @@
         boolean isContentVisible =
                 toState == PanelState.MAXIMIZED || toState == PanelState.EXPANDED;
         boolean isExitingPanelOpenedBeyondPeeked = mWasPanelOpenedBeyondPeek && !isContentVisible;
 
         if (toState == PanelState.CLOSED && mPanelTriggerTimeFromTapNs != 0
                 && reason == StateChangeReason.BASE_PAGE_SCROLL) {
             long durationMs =
                     (System.nanoTime() - mPanelTriggerTimeFromTapNs) / MILLISECONDS_TO_NANOSECONDS;
             ContextualSearchUma.logDurationBetweenTriggerAndScroll(
                     durationMs, mWasSearchContentViewSeen);
-            mTapSuppressionRankerLogger.log(
-                    ContextualSearchRankerLogger.Feature.DURATION_BEFORE_SCROLL_MS, durationMs);
         }
 
         if (isEndingSearch) {
             long durationMs = (System.nanoTime() - mFirstPeekTimeNs) / MILLISECONDS_TO_NANOSECONDS;
             ContextualSearchUma.logPanelViewDurationAction(durationMs);
             if (!mDidSearchInvolvePromo) {
                 // Measure duration only when the promo is not involved.
                 ContextualSearchUma.logDuration(mWasSearchContentViewSeen, isChained, durationMs);
             }
             if (mIsPromoActive) {
                 // The user is exiting still in the promo, without choosing an option.
                 ContextualSearchUma.logPromoSeen(mWasSearchContentViewSeen, mWasActivatedByTap);
             } else {
                 ContextualSearchUma.logResultsSeen(mWasSearchContentViewSeen, mWasActivatedByTap);
             }
 
             if (mWasContextualCardsDataShown) {
                 ContextualSearchUma.logContextualCardsResultsSeen(mWasSearchContentViewSeen);
             }
             if (mWasQuickActionShown) {
                 ContextualSearchUma.logQuickActionResultsSeen(mWasSearchContentViewSeen,
                         mQuickActionCategory);
                 ContextualSearchUma.logQuickActionClicked(mWasQuickActionClicked,
                         mQuickActionCategory);
-                mTapSuppressionRankerLogger.logOutcome(
-                        ContextualSearchRankerLogger.Feature.OUTCOME_WAS_QUICK_ACTION_CLICKED,
-                        mWasQuickActionClicked);
+                if (mRankerLogger != null) {
+                    mRankerLogger.logOutcome(
+                            ContextualSearchRankerLogger.Feature.OUTCOME_WAS_QUICK_ACTION_CLICKED,
+                            mWasQuickActionClicked);
+                }
             }
 
             if (mResultsSeenExperiments != null) {
                 mResultsSeenExperiments.logResultsSeen(
                         mWasSearchContentViewSeen, mWasActivatedByTap);
+                if (mRankerLogger != null) {
+                    mResultsSeenExperiments.logRankerTapSuppressionOutcome(mRankerLogger);
+                }
                 mResultsSeenExperiments = null;
             }
 
             if (mWasActivatedByTap) {
                 boolean wasAnySuppressionHeuristicSatisfied = mWasAnyHeuristicSatisfiedOnPanelShow;
                 ContextualSearchUma.logAnyTapSuppressionHeuristicSatisfied(
                         mWasSearchContentViewSeen, wasAnySuppressionHeuristicSatisfied);
-                // Log all the experiments to the Ranker logger.
-                if (mRankerLogExperiments != null) {
-                    mTapSuppressionRankerLogger.logOutcome(
+                // Update The Ranker logger.
+                if (mRankerLogger != null) {
+                    // Tell Ranker about the primary outcome.
+                    mRankerLogger.logOutcome(
                             ContextualSearchRankerLogger.Feature.OUTCOME_WAS_PANEL_OPENED,
                             mWasSearchContentViewSeen);
-                    mRankerLogExperiments.logRankerTapSuppression(mTapSuppressionRankerLogger);
-                    mRankerLogExperiments = null;
+                    // TODO(donnd): UMA-Log the Ranker inference signal once we're running a model.
                 }
-                // Reset writing to Ranker so whatever interactions occurred are recorded as a
-                // complete record.
-                mTapSuppressionRankerLogger.writeLogAndReset();
-
                 ContextualSearchUma.logSelectionLengthResultsSeen(
                         mWasSearchContentViewSeen, mSelectionLength);
             }
+
+            // Reset writing to Ranker so whatever interactions occurred are recorded as a
+            // complete record.
+            if (mRankerLogger != null) mRankerLogger.writeLogAndReset();
+            mRankerLogger = null;
         }
 
         if (isExitingPanelOpenedBeyondPeeked) {
             assert mPanelOpenedBeyondPeekTimeNs != 0;
             long durationPanelOpen = (System.nanoTime() - mPanelOpenedBeyondPeekTimeNs)
                     / MILLISECONDS_TO_NANOSECONDS;
             ContextualSearchUma.logPanelOpenDuration(durationPanelOpen);
             mPanelOpenedBeyondPeekTimeNs = 0;
             mWasPanelOpenedBeyondPeek = false;
         }
@@ skipping 156 matching lines @@
 
     /**
      * Sets the experiments to log with results seen.
      * @param resultsSeenExperiments The experiments to log when the panel results are known.
      */
     public void setResultsSeenExperiments(ContextualSearchHeuristics resultsSeenExperiments) {
         mResultsSeenExperiments = resultsSeenExperiments;
     }
 
     /**
-     * Sets the experiments to log through Ranker with results seen.
-     * @param rankerLogExperiments The experiments to log through Ranker when the panel results
-     *        are known.
-     * @param basePageUrl The URL of the base page to log along with Ranker data.
+     * Sets up logging through Ranker for outcomes.
+     * @param rankerLogger The {@link ContextualSearchRankerLogger} currently being used to measure
+     *                     or suppress the UI by Ranker.
      */
-    public void setRankerLogExperiments(
-            ContextualSearchHeuristics rankerLogExperiments, URL basePageUrl) {
-        mRankerLogExperiments = rankerLogExperiments;
-        mTapSuppressionRankerLogger.setupLoggingForPage(basePageUrl);
+    public void setRankerLogger(ContextualSearchRankerLogger rankerLogger) {
+        mRankerLogger = rankerLogger;
     }
 
     /**
      * Determine whether a new contextual search is starting.
      * @param toState The contextual search state that will be transitioned to.
      * @param reason The reason for the search state transition.
      * @return Whether a new contextual search is starting.
      */
     private boolean isStartingNewContextualSearch(PanelState toState, StateChangeReason reason) {
         return toState == PanelState.PEEKED
@@ skipping 16 matching lines @@
 
     /**
      * @param fromState The state the panel is transitioning from.
      * @return Whether there is an ongoing contextual search.
      */
     private boolean isOngoingContextualSearch(PanelState fromState) {
         return fromState != PanelState.UNDEFINED && fromState != PanelState.CLOSED;
     }
 }