Additional heuristic user interaction attribution for page load metrics

chrome/browser/page_load_metrics/page_load_tracker.h

 // Copyright 2016 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.
 
 #ifndef CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_TRACKER_H_
 #define CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_TRACKER_H_
 
 #include <memory>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/time/time.h"
 #include "chrome/browser/page_load_metrics/page_load_metrics_observer.h"
+#include "chrome/browser/page_load_metrics/user_input_tracker.h"
 #include "chrome/common/page_load_metrics/page_load_timing.h"
 #include "ui/base/page_transition_types.h"
 
 class GURL;
 
 namespace blink {
 class WebInputEvent;
 }  // namespace blink
 
 namespace content {
@@ skipping 96 matching lines @@
 class PageLoadTracker {
  public:
   // Caller must guarantee that the embedder_interface pointer outlives this
   // class. The PageLoadTracker must not hold on to
   // currently_committed_load_or_null or navigation_handle beyond the scope of
   // the constructor.
   PageLoadTracker(bool in_foreground,
                   PageLoadMetricsEmbedderInterface* embedder_interface,
                   const GURL& currently_committed_url,
                   content::NavigationHandle* navigation_handle,
+                  UserInitiatedInfo user_initiated_info,
                   int aborted_chain_size,
                   int aborted_chain_size_same_url);
   ~PageLoadTracker();
   void Redirect(content::NavigationHandle* navigation_handle);
   void Commit(content::NavigationHandle* navigation_handle);
   void FailedProvisionalLoad(content::NavigationHandle* navigation_handle);
   void WebContentsHidden();
   void WebContentsShown();
 
   void OnInputEvent(const blink::WebInputEvent& event);
@@ skipping 28 matching lines @@
   void AddObserver(std::unique_ptr<PageLoadMetricsObserver> observer);
 
   // If the user performs some abort-like action while we are tracking this page
   // load, notify the tracker. Note that we may not classify this as an abort if
   // we've already performed a first paint.
   // is_certainly_browser_timestamp signifies if the timestamp passed is taken
   // in the
   // browser process or not. We need this to possibly clamp browser timestamp on
   // a machine with inter process time tick skew.
   void NotifyAbort(UserAbortType abort_type,
-                   bool user_initiated,
+                   UserInitiatedInfo user_initiated_info,
                    base::TimeTicks timestamp,
                    bool is_certainly_browser_timestamp);
   void UpdateAbort(UserAbortType abort_type,
-                   bool user_initiated,
+                   UserInitiatedInfo user_initiated_info,
                    base::TimeTicks timestamp,
                    bool is_certainly_browser_timestamp);
 
   // This method returns true if this page load has been aborted with type of
   // ABORT_OTHER, and the |abort_cause_time| is within a sufficiently close
   // delta to when it was aborted. Note that only provisional loads can be
   // aborted with ABORT_OTHER. While this heuristic is coarse, it works better
   // and is simpler than other feasible methods. See https://goo.gl/WKRG98.
   bool IsLikelyProvisionalAbort(base::TimeTicks abort_cause_time) const;
 
   bool MatchesOriginalNavigation(content::NavigationHandle* navigation_handle);
 
   // Only valid to call post-commit.
   const GURL& committed_url() const {
     DCHECK(!committed_url_.is_empty());
     return committed_url_;
   }
 
   base::TimeTicks navigation_start() const { return navigation_start_; }
 
   PageLoadExtraInfo ComputePageLoadExtraInfo();
 
   ui::PageTransition page_transition() const { return page_transition_; }
 
+  UserInitiatedInfo user_initiated_info() const { return user_initiated_info_; }
+
+  UserInputTracker* input_tracker() { return &input_tracker_; }
+
  private:
   // This function converts a TimeTicks value taken in the browser process
   // to navigation_start_ if:
   // - base::TimeTicks is not comparable across processes because the clock
   // is not system wide monotonic.
   // - *event_time < navigation_start_
   void ClampBrowserTimestampIfInterProcessTimeTickSkew(
       base::TimeTicks* event_time);
 
   void UpdateAbortInternal(UserAbortType abort_type,
-                           bool user_initiated,
+                           UserInitiatedInfo user_initiated_info,
                            base::TimeTicks timestamp,
                            bool is_certainly_browser_timestamp);
 
   // If |final_navigation| is null, then this is an "unparented" abort chain,
   // and represents a sequence of provisional aborts that never ends with a
   // committed load.
   void LogAbortChainHistograms(content::NavigationHandle* final_navigation);
 
+  UserInputTracker input_tracker_;
+
   // Whether we stopped tracking this navigation after it was initiated. We may
   // stop tracking a navigation if it doesn't meet the criteria for tracking
   // metrics in DidFinishNavigation.
   bool did_stop_tracking_;
 
   // Whether the application went into the background when this PageLoadTracker
   // was active. This is a temporary boolean for UMA tracking.
   bool app_entered_background_;
 
   // The navigation start in TimeTicks, not the wall time reported by Blink.
@@ skipping 12 matching lines @@
   UserAbortType abort_type_;
 
   // Whether the abort for this page load was user initiated. For example, if
   // this page load was aborted by a new navigation, this field tracks whether
   // that new navigation was user-initiated. This field is only useful if this
   // page load's abort type is a value other than ABORT_NONE. Note that this
   // value is currently experimental, and is subject to change. In particular,
   // this field is never set to true for some abort types, such as stop and
   // close, since we don't yet have sufficient instrumentation to know if a stop
   // or close was caused by a user action.
-  bool abort_user_initiated_;
+  UserInitiatedInfo abort_user_initiated_info_;
 
   base::TimeTicks abort_time_;
 
   // We record separate metrics for events that occur after a background,
   // because metrics like layout/paint are delayed artificially
   // when they occur in the background.
   base::TimeTicks background_time_;
   base::TimeTicks foreground_time_;
   bool started_in_foreground_;
 
   PageLoadTiming timing_;
   PageLoadMetadata metadata_;
 
   ui::PageTransition page_transition_;
 
   // Note: these are only approximations, based on WebContents attribution from
   // ResourceRequestInfo objects while this is the currently committed load in
   // the WebContents.
   int num_cache_requests_;
   int num_network_requests_;
 
-  // This is derived from the user gesture bit in the renderer. For browser
-  // initiated navigations this will always be true.
-  bool user_initiated_;
+  // Whether this page load was user initiated.
+  UserInitiatedInfo user_initiated_info_;
 
   // This is a subtle member. If a provisional load A gets aborted by
   // provisional load B, which gets aborted by C that eventually commits, then
   // there exists an abort chain of length 2, starting at A's navigation_start.
   // This is useful because it allows histograming abort chain lengths based on
   // what the last load's transition type is. i.e. holding down F-5 to spam
   // reload will produce a long chain with the RELOAD transition.
   const int aborted_chain_size_;
 
   // This member counts consecutive provisional aborts that share a url. It will
   // always be less than or equal to |aborted_chain_size_|.
   const int aborted_chain_size_same_url_;
 
   // Interface to chrome features. Must outlive the class.
   PageLoadMetricsEmbedderInterface* const embedder_interface_;
 
   std::vector<std::unique_ptr<PageLoadMetricsObserver>> observers_;
 
   DISALLOW_COPY_AND_ASSIGN(PageLoadTracker);
 };
 
 }  // namespace page_load_metrics
 
 #endif  // CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_TRACKER_H_