[page_load_metrics] User Initiated Abort Tracking (Observer version)

components/page_load_metrics/browser/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 COMPONENTS_PAGE_LOAD_METRICS_BROWSER_PAGE_LOAD_METRICS_UTIL_H_
 #define COMPONENTS_PAGE_LOAD_METRICS_BROWSER_PAGE_LOAD_METRICS_UTIL_H_
 
 #include "base/metrics/histogram_macros.h"
 #include "base/time/time.h"
+#include "components/page_load_metrics/browser/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)
 
 namespace page_load_metrics {
 
 struct PageLoadExtraInfo;
 struct PageLoadTiming;
 
 // Get the time of the first 'contentful' paint. A contentful paint is a paint
 // that includes content of some kind (for example, text or image content).
 // Painting of a background color is not considered 'contentful'.
 base::TimeDelta GetFirstContentfulPaint(const PageLoadTiming& timing);
 
-// Returns false for events for which we have no timing information, and events
-// that happened on a page that had been in 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.
-bool EventOccurredInForeground(const base::TimeDelta& event,
-                               const PageLoadExtraInfo& info);
+// Input is a TimeDelta assumed to be baselined at navigation start. Returns
+// false for zero durations, and durations that happened on a page that had been
+// in 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.
+bool DurationOccurredInForeground(const base::TimeDelta& event,

[kinuko, 2015/12/11 12:24:27]

I have a feeling that this change is not really relevant in this cl, could we do
this in a separate patch?

[kinuko, 2015/12/11 13:16:45]

Some more nit comments in case you want to land this patch as quickly as
possible: 'Input' in the comment is a bit unclear, if it's about input event can
we clearly refer to the param name |event|?  Also calling a TimeDelta value
'Duration' gives me a bit of uneasy feeling, though I can't think of a better
name either...  Among the candidates I think I prefer
InForegroundFromNavigationToEvent slightly better than others.

[Charlie Harrison, 2015/12/11 14:12:20]

I'm fine doing this in another patch. We can figure out the best name there.

[Bryan McQuade, 2015/12/11 14:13:42]

Yeah - doing this in a separate change sounds fine to me. Sorry Charles for
asking to tack this on to the current change. To simplify merging to 48, let's
land the rename in a patch after this one (that way we don't have to merge the
rename). Charles, is that ok with you?

[Charlie Harrison, 2015/12/11 14:49:11]

Yep, my most recent patch set does not include this.

+                                  const PageLoadExtraInfo& info);
 
 }  // namespace page_load_metrics
 
 #endif  // COMPONENTS_PAGE_LOAD_METRICS_BROWSER_PAGE_LOAD_METRICS_UTIL_H_