Generalize abort tracking to page end state tracking

chrome/browser/page_load_metrics/page_load_metrics_util.h

 // 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.
 
 #ifndef CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_METRICS_UTIL_H_
 #define CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_METRICS_UTIL_H_
 
 #include "base/metrics/histogram_macros.h"
 #include "base/optional.h"
 #include "base/time/time.h"
+#include "chrome/browser/page_load_metrics/page_load_metrics_observer.h"
 
 #define PAGE_LOAD_HISTOGRAM(name, sample)                           \
   UMA_HISTOGRAM_CUSTOM_TIMES(name, sample,                          \
                              base::TimeDelta::FromMilliseconds(10), \
                              base::TimeDelta::FromMinutes(10), 100)
 
 // Records |bytes| to |histogram_name| in kilobytes (i.e., bytes / 1024).
 #define PAGE_BYTES_HISTOGRAM(histogram_name, bytes) \
   UMA_HISTOGRAM_CUSTOM_COUNTS(                      \
       histogram_name, static_cast<int>((bytes) / 1024), 1, 500 * 1024, 50)
 
 #define PAGE_RESOURCE_COUNT_HISTOGRAM UMA_HISTOGRAM_COUNTS_10000
 
 namespace page_load_metrics {
 
 struct PageLoadExtraInfo;
 
+// Reasons a page load can be aborted.
+enum PageAbortReason {
+  // Represents no abort.
+  ABORT_NONE,
+
+  // The page was reloaded, possibly by the user.
+  ABORT_RELOAD,
+
+  // The page was navigated away from, via a back or forward navigation.
+  ABORT_FORWARD_BACK,
+
+  // If the page load is replaced by a new navigation. This includes link
+  // clicks, typing in the omnibox (not a reload), and form submissions.
+  ABORT_NEW_NAVIGATION,
+
+  // The page load was stopped (e.g. the user presses the stop X button).
+  ABORT_STOP,
+
+  // Page load ended due to closing the tab or browser.
+  ABORT_CLOSE,
+
+  // The page load was backgrounded, e.g. the browser was minimized or the user
+  // switched tabs. Note that the same page may be foregrounded in the future,
+  // so this is not a 'terminal' abort type.
+  ABORT_BACKGROUND,
+
+  // We don't know why the page load ended. This is the value we assign to a
+  // terminated provisional load if the only signal we get is the load finished
+  // without committing, either without error or with net::ERR_ABORTED.
+  ABORT_OTHER
+};
+
+// Information related to a page load abort.
+struct PageAbortInfo {
+  PageAbortInfo()
+      : reason(ABORT_NONE),
+        user_initiated_info(UserInitiatedInfo::NotUserInitiated()) {}
+  PageAbortInfo(PageAbortReason reason,
+                UserInitiatedInfo user_initiated_info,
+                base::TimeDelta time_to_abort)
+      : reason(reason),
+        user_initiated_info(user_initiated_info),
+        time_to_abort(time_to_abort) {}
+
+  // The reason / cause for the abort.
+  const PageAbortReason reason;
+
+  // The fields below are only valid if reason != ABORT_NONE.
+
+  // Information about whether the abort was initiated by a user.
+  const UserInitiatedInfo user_initiated_info;
+
+  // The time from navigation start to the time the page load was aborted.
+  const base::TimeDelta time_to_abort;
+};
+
 // Returns true if:
 // - We have timing information for the event.
 // - The page load started while the page was in the foreground.
 // - The event occurred prior to the page being moved to the background.
 // When a page is backgrounded, some events (e.g. paint) are delayed. Since
 // these data points can skew the mean, they should not be mixed with timing
 // events that occurred in the foreground.
 // If the event time delta and background time delta are equal, we still
 // consider the event to be logged in the foreground histogram since any
 // background specific handling would not yet have been applied to that event.
 bool WasStartedInForegroundOptionalEventInForeground(
     const base::Optional<base::TimeDelta>& event,
     const PageLoadExtraInfo& info);
 
+PageAbortInfo GetPageAbortInfo(const PageLoadExtraInfo& info);
+
 }  // namespace page_load_metrics
 
 #endif  // CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_METRICS_UTIL_H_