Navigation Timing Level 2

third_party/WebKit/Source/core/timing/PerformanceNavigationTiming.cpp

+// 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.
+
+#include "core/timing/PerformanceNavigationTiming.h"
+
+#include "bindings/core/v8/V8ObjectBuilder.h"
+#include "core/dom/DocumentTiming.h"
+#include "core/loader/DocumentLoadTiming.h"
+#include "core/loader/DocumentLoader.h"

[Yoav Weiss, 2016/11/12 17:13:47]

Are these h file declarations needed here?

[sunjian, 2016/11/14 22:12:28]

Done.

+#include "core/timing/PerformanceBase.h"
+
+namespace blink {
+
+// TODO(sunjian): Move this logic into PerformanceBase
+static double monotonicTimeToDOMHighResTimeStamp(double timeOrigin,
+                                                 double seconds) {
+  DCHECK(seconds >= 0.0);
+  if (!seconds || !timeOrigin)
+    return 0.0;
+  return PerformanceBase::clampTimeResolution(seconds - timeOrigin) * 1000.0;

[Yoav Weiss, 2016/11/13 13:48:02]

Should we make sure here that the result is never negative?

[sunjian, 2016/11/14 22:12:28]

Done.

+}
+
+PerformanceNavigationTiming::PerformanceNavigationTiming(
+    double timeOrigin,
+    double unloadEventStart,
+    double unloadEventEnd,
+    double loadEventStart,
+    double loadEventEnd,
+    unsigned short redirectCount,
+    double domInteractive,
+    double domContentLoadedEventStart,
+    double domContentLoadedEventEnd,
+    double domComplete,
+    NavigationType type,
+    double redirectStart,
+    double redirectEnd,
+    double fetchStart,
+    double responseEnd,
+    bool hasCrossOriginRedirect,
+    bool hasSameOriginAsPreviousDocument,
+    ResourceLoadTiming* timing,
+    double lastRedirectEndTime,
+    double finishTime,
+    unsigned long long transferSize,
+    unsigned long long encodedBodyLength,
+    unsigned long long decodedBodyLength,
+    bool didReuseConnection)
+    : PerformanceResourceTiming("",
+                                timeOrigin,
+                                timing,

[Yoav Weiss, 2016/11/12 17:13:47]

We can DCHECK that timing is not null here, to make that fact explicit. Looking
at PerformanceResourceTiming and
https://bugs.chromium.org/p/chromium/issues/detail?id=251100 looks like m_timing
can be null inside PerformanceResourceTiming when AppCache is involved, but we
should make it explicit that we're not adding a new case here.

[sunjian, 2016/11/14 22:12:28]

But timing could possibly be nullptr, right? And PerformanceResourceTiming
doesn't take timing as nullptr.

[Yoav Weiss, 2016/11/14 23:02:52]

Is there a scenario where the document's ResourceResponse has a nullptr
m_resourceLoadTiming upon the document's onload? (when this is called)
I don't think that's the case, but if it is, we should somehow address it, as
this will expose that state to the Web.

+                                lastRedirectEndTime,
+                                finishTime,
+                                transferSize,
+                                encodedBodyLength,
+                                decodedBodyLength,
+                                didReuseConnection,
+                                true /*allowTimingDetails*/,

[Yoav Weiss, 2016/11/12 17:13:47]

This should be an enum

[panicker, 2016/11/14 17:38:52]

What are the values of the enum? Let's move improvements to the existing code to
separate CLs.

[Yoav Weiss, 2016/11/14 20:59:50]

I think this enum should be defined as part of the new constructor we defined in
PerformanceResourceTiming.
With that said, I'm fine with putting this off to a followup CL.

[sunjian, 2016/11/14 22:12:28]

Added a TODO and will come back to make the improvements later.

+                                !hasCrossOriginRedirect,
+                                "document",
+                                "navigation",
+                                timeOrigin),
+      m_timeOrigin(timeOrigin),
+      m_unloadEventStart(unloadEventStart),
+      m_unloadEventEnd(unloadEventEnd),
+      m_loadEventStart(loadEventStart),
+      m_loadEventEnd(loadEventEnd),
+      m_redirectCount(redirectCount),
+      m_domInteractive(domInteractive),
+      m_domContentLoadedEventStart(domContentLoadedEventStart),
+      m_domContentLoadedEventEnd(domContentLoadedEventEnd),
+      m_domComplete(domComplete),
+      m_type(type),
+      m_redirectStart(redirectStart),
+      m_redirectEnd(redirectEnd),
+      m_fetchStart(fetchStart),
+      m_responseEnd(responseEnd),
+      m_hasCrossOriginRedirect(hasCrossOriginRedirect),
+      m_hasSameOriginAsPreviousDocument(hasSameOriginAsPreviousDocument) {}
+
+PerformanceNavigationTiming::~PerformanceNavigationTiming() {}
+
+double PerformanceNavigationTiming::unloadEventStart() const {
+  if (m_hasCrossOriginRedirect || !m_hasSameOriginAsPreviousDocument)
+    return 0;
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_unloadEventStart);
+}
+
+double PerformanceNavigationTiming::unloadEventEnd() const {
+  if (m_hasCrossOriginRedirect || !m_hasSameOriginAsPreviousDocument)
+    return 0;
+
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_unloadEventEnd);
+}
+
+double PerformanceNavigationTiming::domInteractive() const {
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_domInteractive);
+}
+
+double PerformanceNavigationTiming::domContentLoadedEventStart() const {
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin,
+                                            m_domContentLoadedEventStart);
+}
+
+double PerformanceNavigationTiming::domContentLoadedEventEnd() const {
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin,
+                                            m_domContentLoadedEventEnd);
+}
+
+double PerformanceNavigationTiming::domComplete() const {
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_domComplete);
+}
+
+double PerformanceNavigationTiming::loadEventStart() const {
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_loadEventStart);
+}
+
+double PerformanceNavigationTiming::loadEventEnd() const {
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_loadEventEnd);
+}
+
+AtomicString PerformanceNavigationTiming::type() const {
+  // TODO(sunjian) Right now NavigationType doesn't seem to have a Prerender
+  // type yet, need to look into this crbug/663217
+  switch (m_type) {
+    case NavigationTypeReload:
+      return "reload";
+    case NavigationTypeBackForward:
+      return "back_forward";
+    default:
+      return "navigate";
+  }
+}
+
+unsigned short PerformanceNavigationTiming::redirectCount() const {
+  if (m_hasCrossOriginRedirect)
+    return 0;
+  return m_redirectCount;
+}
+
+double PerformanceNavigationTiming::fetchStart() const {
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_fetchStart);
+}
+
+double PerformanceNavigationTiming::redirectStart() const {
+  if (m_hasCrossOriginRedirect)

[panicker, 2016/11/14 19:31:47]

Add a TODO & bug to follow up on whether this should be non-zero with opt-in.

[sunjian, 2016/11/14 22:12:28]

Done.

+    return 0;
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_redirectStart);
+}
+
+double PerformanceNavigationTiming::redirectEnd() const {
+  if (m_hasCrossOriginRedirect)
+    return 0;
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_redirectEnd);
+}
+
+double PerformanceNavigationTiming::responseEnd() const {
+  return monotonicTimeToDOMHighResTimeStamp(m_timeOrigin, m_responseEnd);
+}
+
+void PerformanceNavigationTiming::buildJSONValue(
+    V8ObjectBuilder& builder) const {
+  PerformanceResourceTiming::buildJSONValue(builder);
+  builder.addNumber("unloadEventStart", unloadEventStart());
+  builder.addNumber("unloadEventEnd", unloadEventEnd());
+  builder.addNumber("domInteractive", domInteractive());
+  builder.addNumber("domContentLoadedEventStart", domContentLoadedEventStart());
+  builder.addNumber("domContentLoadedEventEnd", domContentLoadedEventEnd());
+  builder.addNumber("domComplete", domComplete());
+  builder.addNumber("loadEventStart", loadEventStart());
+  builder.addNumber("loadEventEnd", loadEventEnd());
+  builder.addString("type", type());
+  builder.addNumber("redirectCount", redirectCount());
+}
+}