[TTS] Write initial Tap-features to Ranker.

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.
@@ skipping 108 matching lines @@
             }
 
             if (mWasActivatedByTap) {
                 boolean wasAnySuppressionHeuristicSatisfied = mWasAnyHeuristicSatisfiedOnPanelShow;
                 ContextualSearchUma.logAnyTapSuppressionHeuristicSatisfied(
                         mWasSearchContentViewSeen, wasAnySuppressionHeuristicSatisfied);
                 // Log all the experiments to the Ranker logger.
                 if (mRankerLogExperiments != null) {
                     mTapSuppressionRankerLogger.logOutcome(mWasSearchContentViewSeen);
                     mRankerLogExperiments.logRankerTapSuppression(mTapSuppressionRankerLogger);
-                    mTapSuppressionRankerLogger.writeLogAndReset();
                     mRankerLogExperiments = null;
                 }
+                mTapSuppressionRankerLogger.writeLogAndReset();

[Theresa, 2017/05/12 01:02:25]

Why was just this line pulled out of the if (mRankerLogExperiments != null)
block?

[Donn Denman, 2017/05/12 23:08:55]

I noticed that we log to Ranker in multiple places in this method, including
line 126 above, and so it might be possible to not complete a record if there
are no mRankerLoggerExperiments set but we did have mWasQuickActionClicked.  

Switched to a model where we must always call writeLogAndReset when ending
search, and have the RankerLogger keep track internally of whether anything was
written and and in this case start a new record.

[Theresa, 2017/05/18 15:35:11]

Will you please add a code comment with some of these details?

[Donn Denman, 2017/05/18 18:06:07]

Done.

 
                 ContextualSearchUma.logSelectionLengthResultsSeen(
                         mWasSearchContentViewSeen, mSelectionLength);
             }
         }
 
         if (isExitingPanelOpenedBeyondPeeked) {
             assert mPanelOpenedBeyondPeekTimeNs != 0;
             long durationPanelOpen = (System.nanoTime() - mPanelOpenedBeyondPeekTimeNs)
                     / MILLISECONDS_TO_NANOSECONDS;
@@ skipping 161 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
+     * @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.
      */
-    public void setRankerLogExperiments(ContextualSearchHeuristics rankerLogExperiments) {
+    public void setRankerLogExperiments(
+            ContextualSearchHeuristics rankerLogExperiments, URL basePageUrl) {
         mRankerLogExperiments = rankerLogExperiments;
+        mTapSuppressionRankerLogger.setBasePageUrl(basePageUrl);
     }
 
     /**
      * 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;
     }
 }